blob: b398d64cc5a22750802442c07a02c8c1d45542c7 [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 Doerferta7920982016-02-25 14:08:48 +0000205 if (NewElementSize == OldElementSize || NewElementSize == 0)
Johannes Doerfert3ff22212016-02-14 22:31:39 +0000206 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);
Johannes Doerfert066dbf32016-03-01 13:06:28 +0000612 auto &Loc = getAccessInstruction() ? getAccessInstruction()->getDebugLoc()
613 : DebugLoc();
614 Statement->getParent()->addAssumption(INBOUNDS, Outside, Loc, AS_ASSUMPTION);
Tobias Grosser5e6813d2014-07-02 17:47:48 +0000615 isl_space_free(Space);
616}
617
Johannes Doerfertcea61932016-02-21 19:13:19 +0000618void MemoryAccess::buildMemIntrinsicAccessRelation() {
Hongbin Zheng8efb22e2016-02-27 01:49:58 +0000619 assert(isa<MemIntrinsic>(getAccessInstruction()));
Johannes Doerfertcea61932016-02-21 19:13:19 +0000620 assert(Subscripts.size() == 2 && Sizes.size() == 0);
621
Johannes Doerfertcea61932016-02-21 19:13:19 +0000622 auto *SubscriptPWA = Statement->getPwAff(Subscripts[0]);
623 auto *SubscriptMap = isl_map_from_pw_aff(SubscriptPWA);
Johannes Doerferta7920982016-02-25 14:08:48 +0000624
625 isl_map *LengthMap;
626 if (Subscripts[1] == nullptr) {
627 LengthMap = isl_map_universe(isl_map_get_space(SubscriptMap));
628 } else {
629 auto *LengthPWA = Statement->getPwAff(Subscripts[1]);
630 LengthMap = isl_map_from_pw_aff(LengthPWA);
631 auto *RangeSpace = isl_space_range(isl_map_get_space(LengthMap));
632 LengthMap = isl_map_apply_range(LengthMap, isl_map_lex_gt(RangeSpace));
633 }
634 LengthMap = isl_map_lower_bound_si(LengthMap, isl_dim_out, 0, 0);
635 LengthMap = isl_map_align_params(LengthMap, isl_map_get_space(SubscriptMap));
Johannes Doerfertcea61932016-02-21 19:13:19 +0000636 SubscriptMap =
637 isl_map_align_params(SubscriptMap, isl_map_get_space(LengthMap));
Johannes Doerfertcea61932016-02-21 19:13:19 +0000638 LengthMap = isl_map_sum(LengthMap, SubscriptMap);
639 AccessRelation = isl_map_set_tuple_id(LengthMap, isl_dim_in,
640 getStatement()->getDomainId());
641}
642
Johannes Doerferte7044942015-02-24 11:58:30 +0000643void MemoryAccess::computeBoundsOnAccessRelation(unsigned ElementSize) {
644 ScalarEvolution *SE = Statement->getParent()->getSE();
645
Johannes Doerfertcea61932016-02-21 19:13:19 +0000646 auto MAI = MemAccInst(getAccessInstruction());
Hongbin Zheng8efb22e2016-02-27 01:49:58 +0000647 if (isa<MemIntrinsic>(MAI))
Johannes Doerfertcea61932016-02-21 19:13:19 +0000648 return;
649
650 Value *Ptr = MAI.getPointerOperand();
Johannes Doerferte7044942015-02-24 11:58:30 +0000651 if (!Ptr || !SE->isSCEVable(Ptr->getType()))
652 return;
653
654 auto *PtrSCEV = SE->getSCEV(Ptr);
655 if (isa<SCEVCouldNotCompute>(PtrSCEV))
656 return;
657
658 auto *BasePtrSCEV = SE->getPointerBase(PtrSCEV);
659 if (BasePtrSCEV && !isa<SCEVCouldNotCompute>(BasePtrSCEV))
660 PtrSCEV = SE->getMinusSCEV(PtrSCEV, BasePtrSCEV);
661
662 const ConstantRange &Range = SE->getSignedRange(PtrSCEV);
663 if (Range.isFullSet())
664 return;
665
Johannes Doerferte4bd53b2015-03-08 19:49:50 +0000666 bool isWrapping = Range.isSignWrappedSet();
Johannes Doerferte7044942015-02-24 11:58:30 +0000667 unsigned BW = Range.getBitWidth();
Johannes Doerferte7087902016-02-07 13:59:03 +0000668 const auto One = APInt(BW, 1);
Johannes Doerferte4bd53b2015-03-08 19:49:50 +0000669 const auto LB = isWrapping ? Range.getLower() : Range.getSignedMin();
Johannes Doerferte7087902016-02-07 13:59:03 +0000670 const auto UB = isWrapping ? (Range.getUpper() - One) : Range.getSignedMax();
Johannes Doerferte4bd53b2015-03-08 19:49:50 +0000671
672 auto Min = LB.sdiv(APInt(BW, ElementSize));
Johannes Doerferte7087902016-02-07 13:59:03 +0000673 auto Max = UB.sdiv(APInt(BW, ElementSize)) + One;
Johannes Doerferte7044942015-02-24 11:58:30 +0000674
675 isl_set *AccessRange = isl_map_range(isl_map_copy(AccessRelation));
676 AccessRange =
677 addRangeBoundsToSet(AccessRange, ConstantRange(Min, Max), 0, isl_dim_set);
678 AccessRelation = isl_map_intersect_range(AccessRelation, AccessRange);
679}
680
Michael Krusee2bccbb2015-09-18 19:59:43 +0000681__isl_give isl_map *MemoryAccess::foldAccess(__isl_take isl_map *AccessRelation,
Tobias Grosser619190d2015-03-30 17:22:28 +0000682 ScopStmt *Statement) {
Michael Krusee2bccbb2015-09-18 19:59:43 +0000683 int Size = Subscripts.size();
Tobias Grosser619190d2015-03-30 17:22:28 +0000684
685 for (int i = Size - 2; i >= 0; --i) {
686 isl_space *Space;
687 isl_map *MapOne, *MapTwo;
Michael Krusee2bccbb2015-09-18 19:59:43 +0000688 isl_pw_aff *DimSize = Statement->getPwAff(Sizes[i]);
Tobias Grosser619190d2015-03-30 17:22:28 +0000689
690 isl_space *SpaceSize = isl_pw_aff_get_space(DimSize);
691 isl_pw_aff_free(DimSize);
692 isl_id *ParamId = isl_space_get_dim_id(SpaceSize, isl_dim_param, 0);
693
694 Space = isl_map_get_space(AccessRelation);
695 Space = isl_space_map_from_set(isl_space_range(Space));
696 Space = isl_space_align_params(Space, SpaceSize);
697
698 int ParamLocation = isl_space_find_dim_by_id(Space, isl_dim_param, ParamId);
699 isl_id_free(ParamId);
700
701 MapOne = isl_map_universe(isl_space_copy(Space));
702 for (int j = 0; j < Size; ++j)
703 MapOne = isl_map_equate(MapOne, isl_dim_in, j, isl_dim_out, j);
704 MapOne = isl_map_lower_bound_si(MapOne, isl_dim_in, i + 1, 0);
705
706 MapTwo = isl_map_universe(isl_space_copy(Space));
707 for (int j = 0; j < Size; ++j)
708 if (j < i || j > i + 1)
709 MapTwo = isl_map_equate(MapTwo, isl_dim_in, j, isl_dim_out, j);
710
711 isl_local_space *LS = isl_local_space_from_space(Space);
712 isl_constraint *C;
713 C = isl_equality_alloc(isl_local_space_copy(LS));
714 C = isl_constraint_set_constant_si(C, -1);
715 C = isl_constraint_set_coefficient_si(C, isl_dim_in, i, 1);
716 C = isl_constraint_set_coefficient_si(C, isl_dim_out, i, -1);
717 MapTwo = isl_map_add_constraint(MapTwo, C);
718 C = isl_equality_alloc(LS);
719 C = isl_constraint_set_coefficient_si(C, isl_dim_in, i + 1, 1);
720 C = isl_constraint_set_coefficient_si(C, isl_dim_out, i + 1, -1);
721 C = isl_constraint_set_coefficient_si(C, isl_dim_param, ParamLocation, 1);
722 MapTwo = isl_map_add_constraint(MapTwo, C);
723 MapTwo = isl_map_upper_bound_si(MapTwo, isl_dim_in, i + 1, -1);
724
725 MapOne = isl_map_union(MapOne, MapTwo);
726 AccessRelation = isl_map_apply_range(AccessRelation, MapOne);
727 }
728 return AccessRelation;
729}
730
Johannes Doerferta4b77c02015-11-12 20:15:32 +0000731/// @brief Check if @p Expr is divisible by @p Size.
732static bool isDivisible(const SCEV *Expr, unsigned Size, ScalarEvolution &SE) {
Johannes Doerferta7920982016-02-25 14:08:48 +0000733 assert(Size != 0);
Johannes Doerfert4d9bb8d2016-02-18 16:50:12 +0000734 if (Size == 1)
735 return true;
Johannes Doerferta4b77c02015-11-12 20:15:32 +0000736
737 // Only one factor needs to be divisible.
738 if (auto *MulExpr = dyn_cast<SCEVMulExpr>(Expr)) {
739 for (auto *FactorExpr : MulExpr->operands())
740 if (isDivisible(FactorExpr, Size, SE))
741 return true;
742 return false;
743 }
744
745 // For other n-ary expressions (Add, AddRec, Max,...) all operands need
746 // to be divisble.
747 if (auto *NAryExpr = dyn_cast<SCEVNAryExpr>(Expr)) {
748 for (auto *OpExpr : NAryExpr->operands())
749 if (!isDivisible(OpExpr, Size, SE))
750 return false;
751 return true;
752 }
753
754 auto *SizeSCEV = SE.getConstant(Expr->getType(), Size);
755 auto *UDivSCEV = SE.getUDivExpr(Expr, SizeSCEV);
756 auto *MulSCEV = SE.getMulExpr(UDivSCEV, SizeSCEV);
757 return MulSCEV == Expr;
758}
759
Michael Krusee2bccbb2015-09-18 19:59:43 +0000760void MemoryAccess::buildAccessRelation(const ScopArrayInfo *SAI) {
761 assert(!AccessRelation && "AccessReltation already built");
Tobias Grosser75805372011-04-29 06:27:02 +0000762
Michael Krusee2bccbb2015-09-18 19:59:43 +0000763 isl_ctx *Ctx = isl_id_get_ctx(Id);
Johannes Doerfert1a28a892014-10-05 11:32:18 +0000764 isl_id *BaseAddrId = SAI->getBasePtrId();
Tobias Grosser5683df42011-11-09 22:34:34 +0000765
Michael Krusee2bccbb2015-09-18 19:59:43 +0000766 if (!isAffine()) {
Johannes Doerfertcea61932016-02-21 19:13:19 +0000767 if (isa<MemIntrinsic>(getAccessInstruction()))
768 buildMemIntrinsicAccessRelation();
769
Tobias Grosser4f967492013-06-23 05:21:18 +0000770 // We overapproximate non-affine accesses with a possible access to the
771 // whole array. For read accesses it does not make a difference, if an
772 // access must or may happen. However, for write accesses it is important to
773 // differentiate between writes that must happen and writes that may happen.
Johannes Doerfertcea61932016-02-21 19:13:19 +0000774 if (!AccessRelation)
775 AccessRelation = isl_map_from_basic_map(createBasicAccessMap(Statement));
776
Johannes Doerfert5d83f092014-07-29 08:37:55 +0000777 AccessRelation =
778 isl_map_set_tuple_id(AccessRelation, isl_dim_out, BaseAddrId);
Tobias Grossera1879642011-12-20 10:43:14 +0000779 return;
780 }
781
Johannes Doerfert5d83f092014-07-29 08:37:55 +0000782 isl_space *Space = isl_space_alloc(Ctx, 0, Statement->getNumIterators(), 0);
Tobias Grosser79baa212014-04-10 08:38:02 +0000783 AccessRelation = isl_map_universe(Space);
Tobias Grossera1879642011-12-20 10:43:14 +0000784
Michael Krusee2bccbb2015-09-18 19:59:43 +0000785 for (int i = 0, Size = Subscripts.size(); i < Size; ++i) {
786 isl_pw_aff *Affine = Statement->getPwAff(Subscripts[i]);
Sebastian Pop18016682014-04-08 21:20:44 +0000787 isl_map *SubscriptMap = isl_map_from_pw_aff(Affine);
Tobias Grosser79baa212014-04-10 08:38:02 +0000788 AccessRelation = isl_map_flat_range_product(AccessRelation, SubscriptMap);
Sebastian Pop18016682014-04-08 21:20:44 +0000789 }
790
Tobias Grosser5d51afe2016-02-02 16:46:45 +0000791 if (Sizes.size() >= 1 && !isa<SCEVConstant>(Sizes[0]))
Michael Krusee2bccbb2015-09-18 19:59:43 +0000792 AccessRelation = foldAccess(AccessRelation, Statement);
Tobias Grosser619190d2015-03-30 17:22:28 +0000793
Tobias Grosser79baa212014-04-10 08:38:02 +0000794 Space = Statement->getDomainSpace();
Tobias Grosserabfbe632013-02-05 12:09:06 +0000795 AccessRelation = isl_map_set_tuple_id(
796 AccessRelation, isl_dim_in, isl_space_get_tuple_id(Space, isl_dim_set));
Johannes Doerfert5d83f092014-07-29 08:37:55 +0000797 AccessRelation =
798 isl_map_set_tuple_id(AccessRelation, isl_dim_out, BaseAddrId);
799
Tobias Grosseraa660a92015-03-30 00:07:50 +0000800 AccessRelation = isl_map_gist_domain(AccessRelation, Statement->getDomain());
Johannes Doerfert5d83f092014-07-29 08:37:55 +0000801 isl_space_free(Space);
Tobias Grosser8cae72f2011-11-08 15:41:08 +0000802}
Tobias Grosser30b8a092011-08-18 07:51:37 +0000803
Michael Krusecac948e2015-10-02 13:53:07 +0000804MemoryAccess::MemoryAccess(ScopStmt *Stmt, Instruction *AccessInst,
Johannes Doerfertcea61932016-02-21 19:13:19 +0000805 AccessType AccType, Value *BaseAddress,
806 Type *ElementType, bool Affine,
Michael Krusee2bccbb2015-09-18 19:59:43 +0000807 ArrayRef<const SCEV *> Subscripts,
808 ArrayRef<const SCEV *> Sizes, Value *AccessValue,
Tobias Grossera535dff2015-12-13 19:59:01 +0000809 ScopArrayInfo::MemoryKind Kind, StringRef BaseName)
Johannes Doerfertcea61932016-02-21 19:13:19 +0000810 : Kind(Kind), AccType(AccType), RedType(RT_NONE), Statement(Stmt),
811 BaseAddr(BaseAddress), BaseName(BaseName), ElementType(ElementType),
Michael Krusecac948e2015-10-02 13:53:07 +0000812 Sizes(Sizes.begin(), Sizes.end()), AccessInstruction(AccessInst),
813 AccessValue(AccessValue), IsAffine(Affine),
Michael Krusee2bccbb2015-09-18 19:59:43 +0000814 Subscripts(Subscripts.begin(), Subscripts.end()), AccessRelation(nullptr),
Tobias Grosserf1bfd752015-11-05 20:15:37 +0000815 NewAccessRelation(nullptr) {
Hongbin Zheng86f43ea2016-02-20 03:40:15 +0000816 static const std::string TypeStrings[] = {"", "_Read", "_Write", "_MayWrite"};
Johannes Doerfertcea61932016-02-21 19:13:19 +0000817 const std::string Access = TypeStrings[AccType] + utostr(Stmt->size()) + "_";
Tobias Grosserf1bfd752015-11-05 20:15:37 +0000818
Hongbin Zheng86f43ea2016-02-20 03:40:15 +0000819 std::string IdName =
820 getIslCompatibleName(Stmt->getBaseName(), Access, BaseName);
Tobias Grosserf1bfd752015-11-05 20:15:37 +0000821 Id = isl_id_alloc(Stmt->getParent()->getIslCtx(), IdName.c_str(), this);
822}
Michael Krusee2bccbb2015-09-18 19:59:43 +0000823
Tobias Grosser8cae72f2011-11-08 15:41:08 +0000824void MemoryAccess::realignParams() {
Tobias Grosser6defb5b2014-04-10 08:37:44 +0000825 isl_space *ParamSpace = Statement->getParent()->getParamSpace();
Tobias Grosser37487052011-10-06 00:03:42 +0000826 AccessRelation = isl_map_align_params(AccessRelation, ParamSpace);
Tobias Grosser75805372011-04-29 06:27:02 +0000827}
828
Johannes Doerfert32868bf2014-08-01 08:13:25 +0000829const std::string MemoryAccess::getReductionOperatorStr() const {
830 return MemoryAccess::getReductionOperatorStr(getReductionType());
831}
832
Tobias Grosser6f48e0f2015-05-15 09:58:32 +0000833__isl_give isl_id *MemoryAccess::getId() const { return isl_id_copy(Id); }
834
Johannes Doerfertf6183392014-07-01 20:52:51 +0000835raw_ostream &polly::operator<<(raw_ostream &OS,
836 MemoryAccess::ReductionType RT) {
Johannes Doerfert32868bf2014-08-01 08:13:25 +0000837 if (RT == MemoryAccess::RT_NONE)
Johannes Doerfertf6183392014-07-01 20:52:51 +0000838 OS << "NONE";
Johannes Doerfert32868bf2014-08-01 08:13:25 +0000839 else
840 OS << MemoryAccess::getReductionOperatorStr(RT);
Johannes Doerfertf6183392014-07-01 20:52:51 +0000841 return OS;
842}
843
Tobias Grosser75805372011-04-29 06:27:02 +0000844void MemoryAccess::print(raw_ostream &OS) const {
Johannes Doerfert4c7ce472014-10-08 10:11:33 +0000845 switch (AccType) {
Tobias Grosserb58f6a42013-07-13 20:41:24 +0000846 case READ:
Johannes Doerfert6780bc32014-06-26 18:47:03 +0000847 OS.indent(12) << "ReadAccess :=\t";
Tobias Grosser4f967492013-06-23 05:21:18 +0000848 break;
Tobias Grosserb58f6a42013-07-13 20:41:24 +0000849 case MUST_WRITE:
Johannes Doerfert6780bc32014-06-26 18:47:03 +0000850 OS.indent(12) << "MustWriteAccess :=\t";
Tobias Grosser4f967492013-06-23 05:21:18 +0000851 break;
Tobias Grosserb58f6a42013-07-13 20:41:24 +0000852 case MAY_WRITE:
Johannes Doerfert6780bc32014-06-26 18:47:03 +0000853 OS.indent(12) << "MayWriteAccess :=\t";
Tobias Grosser4f967492013-06-23 05:21:18 +0000854 break;
855 }
Johannes Doerfert0ff23ec2015-02-06 20:13:15 +0000856 OS << "[Reduction Type: " << getReductionType() << "] ";
Tobias Grossera535dff2015-12-13 19:59:01 +0000857 OS << "[Scalar: " << isScalarKind() << "]\n";
Michael Kruseb8d26442015-12-13 19:35:26 +0000858 OS.indent(16) << getOriginalAccessRelationStr() << ";\n";
Tobias Grosser6f730082015-09-05 07:46:47 +0000859 if (hasNewAccessRelation())
860 OS.indent(11) << "new: " << getNewAccessRelationStr() << ";\n";
Tobias Grosser75805372011-04-29 06:27:02 +0000861}
862
Tobias Grosser74394f02013-01-14 22:40:23 +0000863void MemoryAccess::dump() const { print(errs()); }
Tobias Grosser75805372011-04-29 06:27:02 +0000864
865// Create a map in the size of the provided set domain, that maps from the
866// one element of the provided set domain to another element of the provided
867// set domain.
868// The mapping is limited to all points that are equal in all but the last
869// dimension and for which the last dimension of the input is strict smaller
870// than the last dimension of the output.
871//
872// getEqualAndLarger(set[i0, i1, ..., iX]):
873//
874// set[i0, i1, ..., iX] -> set[o0, o1, ..., oX]
875// : i0 = o0, i1 = o1, ..., i(X-1) = o(X-1), iX < oX
876//
Tobias Grosserf5338802011-10-06 00:03:35 +0000877static isl_map *getEqualAndLarger(isl_space *setDomain) {
Tobias Grosserc327932c2012-02-01 14:23:36 +0000878 isl_space *Space = isl_space_map_from_set(setDomain);
Tobias Grosser1b6ea572015-05-21 19:02:44 +0000879 isl_map *Map = isl_map_universe(Space);
Sebastian Pop40408762013-10-04 17:14:53 +0000880 unsigned lastDimension = isl_map_dim(Map, isl_dim_in) - 1;
Tobias Grosser75805372011-04-29 06:27:02 +0000881
882 // Set all but the last dimension to be equal for the input and output
883 //
884 // input[i0, i1, ..., iX] -> output[o0, o1, ..., oX]
885 // : i0 = o0, i1 = o1, ..., i(X-1) = o(X-1)
Sebastian Pop40408762013-10-04 17:14:53 +0000886 for (unsigned i = 0; i < lastDimension; ++i)
Tobias Grosserc327932c2012-02-01 14:23:36 +0000887 Map = isl_map_equate(Map, isl_dim_in, i, isl_dim_out, i);
Tobias Grosser75805372011-04-29 06:27:02 +0000888
889 // Set the last dimension of the input to be strict smaller than the
890 // last dimension of the output.
891 //
892 // input[?,?,?,...,iX] -> output[?,?,?,...,oX] : iX < oX
Tobias Grosser1b6ea572015-05-21 19:02:44 +0000893 Map = isl_map_order_lt(Map, isl_dim_in, lastDimension, isl_dim_out,
894 lastDimension);
Tobias Grosserc327932c2012-02-01 14:23:36 +0000895 return Map;
Tobias Grosser75805372011-04-29 06:27:02 +0000896}
897
Tobias Grosser4f663aa2015-03-30 11:52:59 +0000898__isl_give isl_set *
899MemoryAccess::getStride(__isl_take const isl_map *Schedule) const {
Tobias Grosserabfbe632013-02-05 12:09:06 +0000900 isl_map *S = const_cast<isl_map *>(Schedule);
Johannes Doerferta99130f2014-10-13 12:58:03 +0000901 isl_map *AccessRelation = getAccessRelation();
Sebastian Popa00a0292012-12-18 07:46:06 +0000902 isl_space *Space = isl_space_range(isl_map_get_space(S));
903 isl_map *NextScatt = getEqualAndLarger(Space);
Tobias Grosser75805372011-04-29 06:27:02 +0000904
Sebastian Popa00a0292012-12-18 07:46:06 +0000905 S = isl_map_reverse(S);
906 NextScatt = isl_map_lexmin(NextScatt);
Tobias Grosser75805372011-04-29 06:27:02 +0000907
Sebastian Popa00a0292012-12-18 07:46:06 +0000908 NextScatt = isl_map_apply_range(NextScatt, isl_map_copy(S));
909 NextScatt = isl_map_apply_range(NextScatt, isl_map_copy(AccessRelation));
910 NextScatt = isl_map_apply_domain(NextScatt, S);
911 NextScatt = isl_map_apply_domain(NextScatt, AccessRelation);
Tobias Grosser75805372011-04-29 06:27:02 +0000912
Sebastian Popa00a0292012-12-18 07:46:06 +0000913 isl_set *Deltas = isl_map_deltas(NextScatt);
914 return Deltas;
Tobias Grosser75805372011-04-29 06:27:02 +0000915}
916
Sebastian Popa00a0292012-12-18 07:46:06 +0000917bool MemoryAccess::isStrideX(__isl_take const isl_map *Schedule,
Tobias Grosser28dd4862012-01-24 16:42:16 +0000918 int StrideWidth) const {
919 isl_set *Stride, *StrideX;
920 bool IsStrideX;
Tobias Grosser75805372011-04-29 06:27:02 +0000921
Sebastian Popa00a0292012-12-18 07:46:06 +0000922 Stride = getStride(Schedule);
Tobias Grosser28dd4862012-01-24 16:42:16 +0000923 StrideX = isl_set_universe(isl_set_get_space(Stride));
Tobias Grosser01c8f5f2015-08-24 22:20:46 +0000924 for (unsigned i = 0; i < isl_set_dim(StrideX, isl_dim_set) - 1; i++)
925 StrideX = isl_set_fix_si(StrideX, isl_dim_set, i, 0);
926 StrideX = isl_set_fix_si(StrideX, isl_dim_set,
927 isl_set_dim(StrideX, isl_dim_set) - 1, StrideWidth);
Roman Gareevf2bd72e2015-08-18 16:12:05 +0000928 IsStrideX = isl_set_is_subset(Stride, StrideX);
Tobias Grosser75805372011-04-29 06:27:02 +0000929
Tobias Grosser28dd4862012-01-24 16:42:16 +0000930 isl_set_free(StrideX);
Tobias Grosserdea98232012-01-17 20:34:27 +0000931 isl_set_free(Stride);
Tobias Grosserb76f38532011-08-20 11:11:25 +0000932
Tobias Grosser28dd4862012-01-24 16:42:16 +0000933 return IsStrideX;
934}
935
Sebastian Popa00a0292012-12-18 07:46:06 +0000936bool MemoryAccess::isStrideZero(const isl_map *Schedule) const {
937 return isStrideX(Schedule, 0);
Tobias Grosser75805372011-04-29 06:27:02 +0000938}
939
Sebastian Popa00a0292012-12-18 07:46:06 +0000940bool MemoryAccess::isStrideOne(const isl_map *Schedule) const {
941 return isStrideX(Schedule, 1);
Tobias Grosser75805372011-04-29 06:27:02 +0000942}
943
Tobias Grosser166c4222015-09-05 07:46:40 +0000944void MemoryAccess::setNewAccessRelation(isl_map *NewAccess) {
945 isl_map_free(NewAccessRelation);
946 NewAccessRelation = NewAccess;
Raghesh Aloor3cb66282011-07-12 17:14:03 +0000947}
Tobias Grosser75805372011-04-29 06:27:02 +0000948
949//===----------------------------------------------------------------------===//
Tobias Grossercf3942d2011-10-06 00:04:05 +0000950
Tobias Grosser808cd692015-07-14 09:33:13 +0000951isl_map *ScopStmt::getSchedule() const {
952 isl_set *Domain = getDomain();
953 if (isl_set_is_empty(Domain)) {
954 isl_set_free(Domain);
955 return isl_map_from_aff(
956 isl_aff_zero_on_domain(isl_local_space_from_space(getDomainSpace())));
957 }
958 auto *Schedule = getParent()->getSchedule();
959 Schedule = isl_union_map_intersect_domain(
960 Schedule, isl_union_set_from_set(isl_set_copy(Domain)));
961 if (isl_union_map_is_empty(Schedule)) {
962 isl_set_free(Domain);
963 isl_union_map_free(Schedule);
964 return isl_map_from_aff(
965 isl_aff_zero_on_domain(isl_local_space_from_space(getDomainSpace())));
966 }
967 auto *M = isl_map_from_union_map(Schedule);
968 M = isl_map_coalesce(M);
969 M = isl_map_gist_domain(M, Domain);
970 M = isl_map_coalesce(M);
971 return M;
972}
Tobias Grossercf3942d2011-10-06 00:04:05 +0000973
Johannes Doerfert574182d2015-08-12 10:19:50 +0000974__isl_give isl_pw_aff *ScopStmt::getPwAff(const SCEV *E) {
Michael Kruse375cb5f2016-02-24 22:08:24 +0000975 return getParent()->getPwAff(E, getEntryBlock());
Johannes Doerfert574182d2015-08-12 10:19:50 +0000976}
977
Tobias Grosser37eb4222014-02-20 21:43:54 +0000978void ScopStmt::restrictDomain(__isl_take isl_set *NewDomain) {
979 assert(isl_set_is_subset(NewDomain, Domain) &&
980 "New domain is not a subset of old domain!");
981 isl_set_free(Domain);
982 Domain = NewDomain;
Tobias Grosser75805372011-04-29 06:27:02 +0000983}
984
Michael Krusecac948e2015-10-02 13:53:07 +0000985void ScopStmt::buildAccessRelations() {
Johannes Doerfertadeab372016-02-07 13:57:32 +0000986 Scop &S = *getParent();
Michael Krusecac948e2015-10-02 13:53:07 +0000987 for (MemoryAccess *Access : MemAccs) {
Johannes Doerfertcea61932016-02-21 19:13:19 +0000988 Type *ElementType = Access->getElementType();
Johannes Doerfert1a28a892014-10-05 11:32:18 +0000989
Tobias Grossera535dff2015-12-13 19:59:01 +0000990 ScopArrayInfo::MemoryKind Ty;
991 if (Access->isPHIKind())
992 Ty = ScopArrayInfo::MK_PHI;
993 else if (Access->isExitPHIKind())
994 Ty = ScopArrayInfo::MK_ExitPHI;
995 else if (Access->isValueKind())
996 Ty = ScopArrayInfo::MK_Value;
Tobias Grosser6abc75a2015-11-10 17:31:31 +0000997 else
Tobias Grossera535dff2015-12-13 19:59:01 +0000998 Ty = ScopArrayInfo::MK_Array;
Tobias Grosser6abc75a2015-11-10 17:31:31 +0000999
Johannes Doerfertadeab372016-02-07 13:57:32 +00001000 auto *SAI = S.getOrCreateScopArrayInfo(Access->getBaseAddr(), ElementType,
1001 Access->Sizes, Ty);
Michael Krusecac948e2015-10-02 13:53:07 +00001002 Access->buildAccessRelation(SAI);
Tobias Grosser75805372011-04-29 06:27:02 +00001003 }
1004}
1005
Michael Krusecac948e2015-10-02 13:53:07 +00001006void ScopStmt::addAccess(MemoryAccess *Access) {
1007 Instruction *AccessInst = Access->getAccessInstruction();
1008
Michael Kruse58fa3bb2015-12-22 23:25:11 +00001009 if (Access->isArrayKind()) {
1010 MemoryAccessList &MAL = InstructionToAccess[AccessInst];
1011 MAL.emplace_front(Access);
Michael Kruse436db622016-01-26 13:33:10 +00001012 } else if (Access->isValueKind() && Access->isWrite()) {
1013 Instruction *AccessVal = cast<Instruction>(Access->getAccessValue());
Michael Kruse6f7721f2016-02-24 22:08:19 +00001014 assert(Parent.getStmtFor(AccessVal) == this);
Michael Kruse436db622016-01-26 13:33:10 +00001015 assert(!ValueWrites.lookup(AccessVal));
1016
1017 ValueWrites[AccessVal] = Access;
Michael Krusead28e5a2016-01-26 13:33:15 +00001018 } else if (Access->isValueKind() && Access->isRead()) {
1019 Value *AccessVal = Access->getAccessValue();
1020 assert(!ValueReads.lookup(AccessVal));
1021
1022 ValueReads[AccessVal] = Access;
Michael Kruseee6a4fc2016-01-26 13:33:27 +00001023 } else if (Access->isAnyPHIKind() && Access->isWrite()) {
1024 PHINode *PHI = cast<PHINode>(Access->getBaseAddr());
1025 assert(!PHIWrites.lookup(PHI));
1026
1027 PHIWrites[PHI] = Access;
Michael Kruse58fa3bb2015-12-22 23:25:11 +00001028 }
1029
1030 MemAccs.push_back(Access);
Michael Krusecac948e2015-10-02 13:53:07 +00001031}
1032
Tobias Grosser8cae72f2011-11-08 15:41:08 +00001033void ScopStmt::realignParams() {
Johannes Doerfertf6752892014-06-13 18:01:45 +00001034 for (MemoryAccess *MA : *this)
1035 MA->realignParams();
Tobias Grosser8cae72f2011-11-08 15:41:08 +00001036
1037 Domain = isl_set_align_params(Domain, Parent.getParamSpace());
Tobias Grosser8cae72f2011-11-08 15:41:08 +00001038}
1039
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00001040/// @brief Add @p BSet to the set @p User if @p BSet is bounded.
1041static isl_stat collectBoundedParts(__isl_take isl_basic_set *BSet,
1042 void *User) {
1043 isl_set **BoundedParts = static_cast<isl_set **>(User);
1044 if (isl_basic_set_is_bounded(BSet))
1045 *BoundedParts = isl_set_union(*BoundedParts, isl_set_from_basic_set(BSet));
1046 else
1047 isl_basic_set_free(BSet);
1048 return isl_stat_ok;
1049}
1050
1051/// @brief Return the bounded parts of @p S.
1052static __isl_give isl_set *collectBoundedParts(__isl_take isl_set *S) {
1053 isl_set *BoundedParts = isl_set_empty(isl_set_get_space(S));
1054 isl_set_foreach_basic_set(S, collectBoundedParts, &BoundedParts);
1055 isl_set_free(S);
1056 return BoundedParts;
1057}
1058
1059/// @brief Compute the (un)bounded parts of @p S wrt. to dimension @p Dim.
1060///
1061/// @returns A separation of @p S into first an unbounded then a bounded subset,
1062/// both with regards to the dimension @p Dim.
1063static std::pair<__isl_give isl_set *, __isl_give isl_set *>
1064partitionSetParts(__isl_take isl_set *S, unsigned Dim) {
1065
1066 for (unsigned u = 0, e = isl_set_n_dim(S); u < e; u++)
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00001067 S = isl_set_lower_bound_si(S, isl_dim_set, u, 0);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00001068
1069 unsigned NumDimsS = isl_set_n_dim(S);
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00001070 isl_set *OnlyDimS = isl_set_copy(S);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00001071
1072 // Remove dimensions that are greater than Dim as they are not interesting.
1073 assert(NumDimsS >= Dim + 1);
1074 OnlyDimS =
1075 isl_set_project_out(OnlyDimS, isl_dim_set, Dim + 1, NumDimsS - Dim - 1);
1076
1077 // Create artificial parametric upper bounds for dimensions smaller than Dim
1078 // as we are not interested in them.
1079 OnlyDimS = isl_set_insert_dims(OnlyDimS, isl_dim_param, 0, Dim);
1080 for (unsigned u = 0; u < Dim; u++) {
1081 isl_constraint *C = isl_inequality_alloc(
1082 isl_local_space_from_space(isl_set_get_space(OnlyDimS)));
1083 C = isl_constraint_set_coefficient_si(C, isl_dim_param, u, 1);
1084 C = isl_constraint_set_coefficient_si(C, isl_dim_set, u, -1);
1085 OnlyDimS = isl_set_add_constraint(OnlyDimS, C);
1086 }
1087
1088 // Collect all bounded parts of OnlyDimS.
1089 isl_set *BoundedParts = collectBoundedParts(OnlyDimS);
1090
1091 // Create the dimensions greater than Dim again.
1092 BoundedParts = isl_set_insert_dims(BoundedParts, isl_dim_set, Dim + 1,
1093 NumDimsS - Dim - 1);
1094
1095 // Remove the artificial upper bound parameters again.
1096 BoundedParts = isl_set_remove_dims(BoundedParts, isl_dim_param, 0, Dim);
1097
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00001098 isl_set *UnboundedParts = isl_set_subtract(S, isl_set_copy(BoundedParts));
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00001099 return std::make_pair(UnboundedParts, BoundedParts);
1100}
1101
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001102/// @brief Set the dimension Ids from @p From in @p To.
1103static __isl_give isl_set *setDimensionIds(__isl_keep isl_set *From,
1104 __isl_take isl_set *To) {
1105 for (unsigned u = 0, e = isl_set_n_dim(From); u < e; u++) {
1106 isl_id *DimId = isl_set_get_dim_id(From, isl_dim_set, u);
1107 To = isl_set_set_dim_id(To, isl_dim_set, u, DimId);
1108 }
1109 return To;
1110}
1111
1112/// @brief Create the conditions under which @p L @p Pred @p R is true.
Johannes Doerfert96425c22015-08-30 21:13:53 +00001113static __isl_give isl_set *buildConditionSet(ICmpInst::Predicate Pred,
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001114 __isl_take isl_pw_aff *L,
1115 __isl_take isl_pw_aff *R) {
Johannes Doerfert96425c22015-08-30 21:13:53 +00001116 switch (Pred) {
1117 case ICmpInst::ICMP_EQ:
1118 return isl_pw_aff_eq_set(L, R);
1119 case ICmpInst::ICMP_NE:
1120 return isl_pw_aff_ne_set(L, R);
1121 case ICmpInst::ICMP_SLT:
1122 return isl_pw_aff_lt_set(L, R);
1123 case ICmpInst::ICMP_SLE:
1124 return isl_pw_aff_le_set(L, R);
1125 case ICmpInst::ICMP_SGT:
1126 return isl_pw_aff_gt_set(L, R);
1127 case ICmpInst::ICMP_SGE:
1128 return isl_pw_aff_ge_set(L, R);
1129 case ICmpInst::ICMP_ULT:
1130 return isl_pw_aff_lt_set(L, R);
1131 case ICmpInst::ICMP_UGT:
1132 return isl_pw_aff_gt_set(L, R);
1133 case ICmpInst::ICMP_ULE:
1134 return isl_pw_aff_le_set(L, R);
1135 case ICmpInst::ICMP_UGE:
1136 return isl_pw_aff_ge_set(L, R);
1137 default:
1138 llvm_unreachable("Non integer predicate not supported");
1139 }
1140}
1141
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001142/// @brief Create the conditions under which @p L @p Pred @p R is true.
1143///
1144/// Helper function that will make sure the dimensions of the result have the
1145/// same isl_id's as the @p Domain.
1146static __isl_give isl_set *buildConditionSet(ICmpInst::Predicate Pred,
1147 __isl_take isl_pw_aff *L,
1148 __isl_take isl_pw_aff *R,
1149 __isl_keep isl_set *Domain) {
1150 isl_set *ConsequenceCondSet = buildConditionSet(Pred, L, R);
1151 return setDimensionIds(Domain, ConsequenceCondSet);
1152}
1153
1154/// @brief Build the conditions sets for the switch @p SI in the @p Domain.
Johannes Doerfert96425c22015-08-30 21:13:53 +00001155///
1156/// This will fill @p ConditionSets with the conditions under which control
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001157/// will be moved from @p SI to its successors. Hence, @p ConditionSets will
1158/// have as many elements as @p SI has successors.
Johannes Doerfert96425c22015-08-30 21:13:53 +00001159static void
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001160buildConditionSets(Scop &S, SwitchInst *SI, Loop *L, __isl_keep isl_set *Domain,
Johannes Doerfert96425c22015-08-30 21:13:53 +00001161 SmallVectorImpl<__isl_give isl_set *> &ConditionSets) {
1162
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001163 Value *Condition = getConditionFromTerminator(SI);
1164 assert(Condition && "No condition for switch");
1165
1166 ScalarEvolution &SE = *S.getSE();
1167 BasicBlock *BB = SI->getParent();
1168 isl_pw_aff *LHS, *RHS;
1169 LHS = S.getPwAff(SE.getSCEVAtScope(Condition, L), BB);
1170
1171 unsigned NumSuccessors = SI->getNumSuccessors();
1172 ConditionSets.resize(NumSuccessors);
1173 for (auto &Case : SI->cases()) {
1174 unsigned Idx = Case.getSuccessorIndex();
1175 ConstantInt *CaseValue = Case.getCaseValue();
1176
1177 RHS = S.getPwAff(SE.getSCEV(CaseValue), BB);
1178 isl_set *CaseConditionSet =
1179 buildConditionSet(ICmpInst::ICMP_EQ, isl_pw_aff_copy(LHS), RHS, Domain);
1180 ConditionSets[Idx] = isl_set_coalesce(
1181 isl_set_intersect(CaseConditionSet, isl_set_copy(Domain)));
1182 }
1183
1184 assert(ConditionSets[0] == nullptr && "Default condition set was set");
1185 isl_set *ConditionSetUnion = isl_set_copy(ConditionSets[1]);
1186 for (unsigned u = 2; u < NumSuccessors; u++)
1187 ConditionSetUnion =
1188 isl_set_union(ConditionSetUnion, isl_set_copy(ConditionSets[u]));
1189 ConditionSets[0] = setDimensionIds(
1190 Domain, isl_set_subtract(isl_set_copy(Domain), ConditionSetUnion));
1191
1192 S.markAsOptimized();
1193 isl_pw_aff_free(LHS);
1194}
1195
Johannes Doerfert9b1f9c82015-10-11 13:21:03 +00001196/// @brief Build the conditions sets for the branch condition @p Condition in
1197/// the @p Domain.
1198///
1199/// This will fill @p ConditionSets with the conditions under which control
1200/// will be moved from @p TI to its successors. Hence, @p ConditionSets will
Johannes Doerfert2af10e22015-11-12 03:25:01 +00001201/// have as many elements as @p TI has successors. If @p TI is nullptr the
1202/// context under which @p Condition is true/false will be returned as the
1203/// new elements of @p ConditionSets.
Johannes Doerfert9b1f9c82015-10-11 13:21:03 +00001204static void
1205buildConditionSets(Scop &S, Value *Condition, TerminatorInst *TI, Loop *L,
1206 __isl_keep isl_set *Domain,
1207 SmallVectorImpl<__isl_give isl_set *> &ConditionSets) {
1208
1209 isl_set *ConsequenceCondSet = nullptr;
1210 if (auto *CCond = dyn_cast<ConstantInt>(Condition)) {
1211 if (CCond->isZero())
1212 ConsequenceCondSet = isl_set_empty(isl_set_get_space(Domain));
1213 else
1214 ConsequenceCondSet = isl_set_universe(isl_set_get_space(Domain));
1215 } else if (BinaryOperator *BinOp = dyn_cast<BinaryOperator>(Condition)) {
1216 auto Opcode = BinOp->getOpcode();
1217 assert(Opcode == Instruction::And || Opcode == Instruction::Or);
1218
1219 buildConditionSets(S, BinOp->getOperand(0), TI, L, Domain, ConditionSets);
1220 buildConditionSets(S, BinOp->getOperand(1), TI, L, Domain, ConditionSets);
1221
1222 isl_set_free(ConditionSets.pop_back_val());
1223 isl_set *ConsCondPart0 = ConditionSets.pop_back_val();
1224 isl_set_free(ConditionSets.pop_back_val());
1225 isl_set *ConsCondPart1 = ConditionSets.pop_back_val();
1226
1227 if (Opcode == Instruction::And)
1228 ConsequenceCondSet = isl_set_intersect(ConsCondPart0, ConsCondPart1);
1229 else
1230 ConsequenceCondSet = isl_set_union(ConsCondPart0, ConsCondPart1);
1231 } else {
1232 auto *ICond = dyn_cast<ICmpInst>(Condition);
1233 assert(ICond &&
1234 "Condition of exiting branch was neither constant nor ICmp!");
1235
1236 ScalarEvolution &SE = *S.getSE();
Johannes Doerfert2af10e22015-11-12 03:25:01 +00001237 BasicBlock *BB = TI ? TI->getParent() : nullptr;
Johannes Doerfert9b1f9c82015-10-11 13:21:03 +00001238 isl_pw_aff *LHS, *RHS;
1239 LHS = S.getPwAff(SE.getSCEVAtScope(ICond->getOperand(0), L), BB);
1240 RHS = S.getPwAff(SE.getSCEVAtScope(ICond->getOperand(1), L), BB);
1241 ConsequenceCondSet =
1242 buildConditionSet(ICond->getPredicate(), LHS, RHS, Domain);
1243 }
1244
Johannes Doerfert2af10e22015-11-12 03:25:01 +00001245 // If no terminator was given we are only looking for parameter constraints
1246 // under which @p Condition is true/false.
1247 if (!TI)
1248 ConsequenceCondSet = isl_set_params(ConsequenceCondSet);
1249
Johannes Doerfert9b1f9c82015-10-11 13:21:03 +00001250 assert(ConsequenceCondSet);
1251 isl_set *AlternativeCondSet =
1252 isl_set_complement(isl_set_copy(ConsequenceCondSet));
1253
1254 ConditionSets.push_back(isl_set_coalesce(
1255 isl_set_intersect(ConsequenceCondSet, isl_set_copy(Domain))));
1256 ConditionSets.push_back(isl_set_coalesce(
1257 isl_set_intersect(AlternativeCondSet, isl_set_copy(Domain))));
1258}
1259
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001260/// @brief Build the conditions sets for the terminator @p TI in the @p Domain.
1261///
1262/// This will fill @p ConditionSets with the conditions under which control
1263/// will be moved from @p TI to its successors. Hence, @p ConditionSets will
1264/// have as many elements as @p TI has successors.
1265static void
1266buildConditionSets(Scop &S, TerminatorInst *TI, Loop *L,
1267 __isl_keep isl_set *Domain,
1268 SmallVectorImpl<__isl_give isl_set *> &ConditionSets) {
1269
1270 if (SwitchInst *SI = dyn_cast<SwitchInst>(TI))
1271 return buildConditionSets(S, SI, L, Domain, ConditionSets);
1272
1273 assert(isa<BranchInst>(TI) && "Terminator was neither branch nor switch.");
1274
1275 if (TI->getNumSuccessors() == 1) {
Johannes Doerfert96425c22015-08-30 21:13:53 +00001276 ConditionSets.push_back(isl_set_copy(Domain));
1277 return;
1278 }
1279
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001280 Value *Condition = getConditionFromTerminator(TI);
1281 assert(Condition && "No condition for Terminator");
Johannes Doerfert96425c22015-08-30 21:13:53 +00001282
Johannes Doerfert9b1f9c82015-10-11 13:21:03 +00001283 return buildConditionSets(S, Condition, TI, L, Domain, ConditionSets);
Johannes Doerfert96425c22015-08-30 21:13:53 +00001284}
1285
Johannes Doerfert32ae76e2015-09-10 13:12:02 +00001286void ScopStmt::buildDomain() {
Michael Kruse526fcf52016-02-24 22:08:08 +00001287 isl_id *Id = isl_id_alloc(getIslCtx(), getBaseName(), this);
Tobias Grosser084d8f72012-05-29 09:29:44 +00001288
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00001289 Domain = getParent()->getDomainConditions(this);
Tobias Grosser084d8f72012-05-29 09:29:44 +00001290 Domain = isl_set_set_tuple_id(Domain, Id);
Tobias Grosser75805372011-04-29 06:27:02 +00001291}
1292
Hongbin Zheng7dddfba2016-02-13 15:12:47 +00001293void ScopStmt::deriveAssumptionsFromGEP(GetElementPtrInst *GEP,
1294 ScopDetection &SD) {
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001295 isl_ctx *Ctx = Parent.getIslCtx();
1296 isl_local_space *LSpace = isl_local_space_from_space(getDomainSpace());
1297 Type *Ty = GEP->getPointerOperandType();
1298 ScalarEvolution &SE = *Parent.getSE();
Johannes Doerfert09e36972015-10-07 20:17:36 +00001299
1300 // The set of loads that are required to be invariant.
1301 auto &ScopRIL = *SD.getRequiredInvariantLoads(&Parent.getRegion());
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001302
Tobias Grosserfaf8f6f2015-09-17 15:47:52 +00001303 std::vector<const SCEV *> Subscripts;
1304 std::vector<int> Sizes;
1305
Tobias Grosser5fd8c092015-09-17 17:28:15 +00001306 std::tie(Subscripts, Sizes) = getIndexExpressionsFromGEP(GEP, SE);
Tobias Grosserfaf8f6f2015-09-17 15:47:52 +00001307
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001308 if (auto *PtrTy = dyn_cast<PointerType>(Ty)) {
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001309 Ty = PtrTy->getElementType();
1310 }
1311
Tobias Grosserfaf8f6f2015-09-17 15:47:52 +00001312 int IndexOffset = Subscripts.size() - Sizes.size();
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001313
Tobias Grosserfaf8f6f2015-09-17 15:47:52 +00001314 assert(IndexOffset <= 1 && "Unexpected large index offset");
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001315
Johannes Doerfert066dbf32016-03-01 13:06:28 +00001316 auto *NotExecuted = isl_set_complement(isl_set_params(getDomain()));
Tobias Grosserfaf8f6f2015-09-17 15:47:52 +00001317 for (size_t i = 0; i < Sizes.size(); i++) {
Johannes Doerferta90943d2016-02-21 16:37:25 +00001318 auto *Expr = Subscripts[i + IndexOffset];
Tobias Grosserfaf8f6f2015-09-17 15:47:52 +00001319 auto Size = Sizes[i];
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001320
Michael Kruse09eb4452016-03-03 22:10:47 +00001321 auto *Scope = SD.getLI()->getLoopFor(getEntryBlock());
Johannes Doerfert09e36972015-10-07 20:17:36 +00001322 InvariantLoadsSetTy AccessILS;
Michael Kruse09eb4452016-03-03 22:10:47 +00001323 if (!isAffineExpr(&Parent.getRegion(), Scope, Expr, SE, nullptr,
1324 &AccessILS))
Johannes Doerfert09e36972015-10-07 20:17:36 +00001325 continue;
1326
1327 bool NonAffine = false;
1328 for (LoadInst *LInst : AccessILS)
1329 if (!ScopRIL.count(LInst))
1330 NonAffine = true;
1331
1332 if (NonAffine)
Tobias Grosserfaf8f6f2015-09-17 15:47:52 +00001333 continue;
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001334
Tobias Grosserfaf8f6f2015-09-17 15:47:52 +00001335 isl_pw_aff *AccessOffset = getPwAff(Expr);
1336 AccessOffset =
1337 isl_pw_aff_set_tuple_id(AccessOffset, isl_dim_in, getDomainId());
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001338
Tobias Grosserfaf8f6f2015-09-17 15:47:52 +00001339 isl_pw_aff *DimSize = isl_pw_aff_from_aff(isl_aff_val_on_domain(
1340 isl_local_space_copy(LSpace), isl_val_int_from_si(Ctx, Size)));
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001341
Tobias Grosserfaf8f6f2015-09-17 15:47:52 +00001342 isl_set *OutOfBound = isl_pw_aff_ge_set(AccessOffset, DimSize);
1343 OutOfBound = isl_set_intersect(getDomain(), OutOfBound);
1344 OutOfBound = isl_set_params(OutOfBound);
1345 isl_set *InBound = isl_set_complement(OutOfBound);
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001346
Tobias Grosserfaf8f6f2015-09-17 15:47:52 +00001347 // A => B == !A or B
1348 isl_set *InBoundIfExecuted =
Johannes Doerfert066dbf32016-03-01 13:06:28 +00001349 isl_set_union(isl_set_copy(NotExecuted), InBound);
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001350
Roman Gareev10595a12016-01-08 14:01:59 +00001351 InBoundIfExecuted = isl_set_coalesce(InBoundIfExecuted);
Johannes Doerfert066dbf32016-03-01 13:06:28 +00001352 Parent.addAssumption(INBOUNDS, InBoundIfExecuted, GEP->getDebugLoc(),
1353 AS_ASSUMPTION);
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001354 }
1355
1356 isl_local_space_free(LSpace);
Johannes Doerfert066dbf32016-03-01 13:06:28 +00001357 isl_set_free(NotExecuted);
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001358}
1359
Hongbin Zheng7dddfba2016-02-13 15:12:47 +00001360void ScopStmt::deriveAssumptions(BasicBlock *Block, ScopDetection &SD) {
Johannes Doerfertff9d1982015-02-24 12:00:50 +00001361 for (Instruction &Inst : *Block)
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001362 if (auto *GEP = dyn_cast<GetElementPtrInst>(&Inst))
Hongbin Zheng7dddfba2016-02-13 15:12:47 +00001363 deriveAssumptionsFromGEP(GEP, SD);
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001364}
1365
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00001366void ScopStmt::collectSurroundingLoops() {
1367 for (unsigned u = 0, e = isl_set_n_dim(Domain); u < e; u++) {
1368 isl_id *DimId = isl_set_get_dim_id(Domain, isl_dim_set, u);
1369 NestLoops.push_back(static_cast<Loop *>(isl_id_get_user(DimId)));
1370 isl_id_free(DimId);
1371 }
1372}
1373
Michael Kruse9d080092015-09-11 21:41:48 +00001374ScopStmt::ScopStmt(Scop &parent, Region &R)
Michael Krusecac948e2015-10-02 13:53:07 +00001375 : Parent(parent), Domain(nullptr), BB(nullptr), R(&R), Build(nullptr) {
Johannes Doerfertff9d1982015-02-24 12:00:50 +00001376
Tobias Grosser16c44032015-07-09 07:31:45 +00001377 BaseName = getIslCompatibleName("Stmt_", R.getNameStr(), "");
Johannes Doerfertff9d1982015-02-24 12:00:50 +00001378}
1379
Michael Kruse9d080092015-09-11 21:41:48 +00001380ScopStmt::ScopStmt(Scop &parent, BasicBlock &bb)
Michael Krusecac948e2015-10-02 13:53:07 +00001381 : Parent(parent), Domain(nullptr), BB(&bb), R(nullptr), Build(nullptr) {
Tobias Grosser75805372011-04-29 06:27:02 +00001382
Johannes Doerfert79fc23f2014-07-24 23:48:02 +00001383 BaseName = getIslCompatibleName("Stmt_", &bb, "");
Michael Krusecac948e2015-10-02 13:53:07 +00001384}
1385
Hongbin Zheng7dddfba2016-02-13 15:12:47 +00001386void ScopStmt::init(ScopDetection &SD) {
Michael Krusecac948e2015-10-02 13:53:07 +00001387 assert(!Domain && "init must be called only once");
Tobias Grosser75805372011-04-29 06:27:02 +00001388
Johannes Doerfert32ae76e2015-09-10 13:12:02 +00001389 buildDomain();
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00001390 collectSurroundingLoops();
Michael Krusecac948e2015-10-02 13:53:07 +00001391 buildAccessRelations();
1392
1393 if (BB) {
Hongbin Zheng7dddfba2016-02-13 15:12:47 +00001394 deriveAssumptions(BB, SD);
Michael Krusecac948e2015-10-02 13:53:07 +00001395 } else {
1396 for (BasicBlock *Block : R->blocks()) {
Hongbin Zheng7dddfba2016-02-13 15:12:47 +00001397 deriveAssumptions(Block, SD);
Michael Krusecac948e2015-10-02 13:53:07 +00001398 }
1399 }
1400
Tobias Grosserd83b8a82015-08-20 19:08:11 +00001401 if (DetectReductions)
1402 checkForReductions();
Johannes Doerfert0ee1f212014-06-17 17:31:36 +00001403}
1404
Johannes Doerferte58a0122014-06-27 20:31:28 +00001405/// @brief Collect loads which might form a reduction chain with @p StoreMA
1406///
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00001407/// Check if the stored value for @p StoreMA is a binary operator with one or
1408/// two loads as operands. If the binary operand is commutative & associative,
Johannes Doerferte58a0122014-06-27 20:31:28 +00001409/// used only once (by @p StoreMA) and its load operands are also used only
1410/// once, we have found a possible reduction chain. It starts at an operand
1411/// load and includes the binary operator and @p StoreMA.
1412///
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00001413/// Note: We allow only one use to ensure the load and binary operator cannot
Johannes Doerferte58a0122014-06-27 20:31:28 +00001414/// escape this block or into any other store except @p StoreMA.
1415void ScopStmt::collectCandiateReductionLoads(
1416 MemoryAccess *StoreMA, SmallVectorImpl<MemoryAccess *> &Loads) {
1417 auto *Store = dyn_cast<StoreInst>(StoreMA->getAccessInstruction());
1418 if (!Store)
Johannes Doerfert0ee1f212014-06-17 17:31:36 +00001419 return;
1420
1421 // Skip if there is not one binary operator between the load and the store
1422 auto *BinOp = dyn_cast<BinaryOperator>(Store->getValueOperand());
Johannes Doerferte58a0122014-06-27 20:31:28 +00001423 if (!BinOp)
1424 return;
1425
1426 // Skip if the binary operators has multiple uses
1427 if (BinOp->getNumUses() != 1)
Johannes Doerfert0ee1f212014-06-17 17:31:36 +00001428 return;
1429
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00001430 // Skip if the opcode of the binary operator is not commutative/associative
Johannes Doerfert0ee1f212014-06-17 17:31:36 +00001431 if (!BinOp->isCommutative() || !BinOp->isAssociative())
1432 return;
1433
Johannes Doerfert9890a052014-07-01 00:32:29 +00001434 // Skip if the binary operator is outside the current SCoP
1435 if (BinOp->getParent() != Store->getParent())
1436 return;
1437
Johannes Doerfert0ee1f212014-06-17 17:31:36 +00001438 // Skip if it is a multiplicative reduction and we disabled them
1439 if (DisableMultiplicativeReductions &&
1440 (BinOp->getOpcode() == Instruction::Mul ||
1441 BinOp->getOpcode() == Instruction::FMul))
1442 return;
1443
Johannes Doerferte58a0122014-06-27 20:31:28 +00001444 // Check the binary operator operands for a candidate load
1445 auto *PossibleLoad0 = dyn_cast<LoadInst>(BinOp->getOperand(0));
1446 auto *PossibleLoad1 = dyn_cast<LoadInst>(BinOp->getOperand(1));
1447 if (!PossibleLoad0 && !PossibleLoad1)
1448 return;
1449
1450 // A load is only a candidate if it cannot escape (thus has only this use)
1451 if (PossibleLoad0 && PossibleLoad0->getNumUses() == 1)
Johannes Doerfert9890a052014-07-01 00:32:29 +00001452 if (PossibleLoad0->getParent() == Store->getParent())
Tobias Grosser35ec5fb2015-12-15 23:50:04 +00001453 Loads.push_back(&getArrayAccessFor(PossibleLoad0));
Johannes Doerferte58a0122014-06-27 20:31:28 +00001454 if (PossibleLoad1 && PossibleLoad1->getNumUses() == 1)
Johannes Doerfert9890a052014-07-01 00:32:29 +00001455 if (PossibleLoad1->getParent() == Store->getParent())
Tobias Grosser35ec5fb2015-12-15 23:50:04 +00001456 Loads.push_back(&getArrayAccessFor(PossibleLoad1));
Johannes Doerferte58a0122014-06-27 20:31:28 +00001457}
1458
1459/// @brief Check for reductions in this ScopStmt
1460///
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00001461/// Iterate over all store memory accesses and check for valid binary reduction
1462/// like chains. For all candidates we check if they have the same base address
1463/// and there are no other accesses which overlap with them. The base address
1464/// check rules out impossible reductions candidates early. The overlap check,
1465/// together with the "only one user" check in collectCandiateReductionLoads,
Johannes Doerferte58a0122014-06-27 20:31:28 +00001466/// guarantees that none of the intermediate results will escape during
1467/// execution of the loop nest. We basically check here that no other memory
1468/// access can access the same memory as the potential reduction.
1469void ScopStmt::checkForReductions() {
1470 SmallVector<MemoryAccess *, 2> Loads;
1471 SmallVector<std::pair<MemoryAccess *, MemoryAccess *>, 4> Candidates;
1472
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00001473 // First collect candidate load-store reduction chains by iterating over all
Johannes Doerferte58a0122014-06-27 20:31:28 +00001474 // stores and collecting possible reduction loads.
1475 for (MemoryAccess *StoreMA : MemAccs) {
1476 if (StoreMA->isRead())
1477 continue;
1478
1479 Loads.clear();
1480 collectCandiateReductionLoads(StoreMA, Loads);
1481 for (MemoryAccess *LoadMA : Loads)
1482 Candidates.push_back(std::make_pair(LoadMA, StoreMA));
1483 }
1484
1485 // Then check each possible candidate pair.
1486 for (const auto &CandidatePair : Candidates) {
1487 bool Valid = true;
1488 isl_map *LoadAccs = CandidatePair.first->getAccessRelation();
1489 isl_map *StoreAccs = CandidatePair.second->getAccessRelation();
1490
1491 // Skip those with obviously unequal base addresses.
1492 if (!isl_map_has_equal_space(LoadAccs, StoreAccs)) {
1493 isl_map_free(LoadAccs);
1494 isl_map_free(StoreAccs);
1495 continue;
1496 }
1497
1498 // And check if the remaining for overlap with other memory accesses.
1499 isl_map *AllAccsRel = isl_map_union(LoadAccs, StoreAccs);
1500 AllAccsRel = isl_map_intersect_domain(AllAccsRel, getDomain());
1501 isl_set *AllAccs = isl_map_range(AllAccsRel);
1502
1503 for (MemoryAccess *MA : MemAccs) {
1504 if (MA == CandidatePair.first || MA == CandidatePair.second)
1505 continue;
1506
1507 isl_map *AccRel =
1508 isl_map_intersect_domain(MA->getAccessRelation(), getDomain());
1509 isl_set *Accs = isl_map_range(AccRel);
1510
1511 if (isl_set_has_equal_space(AllAccs, Accs) || isl_set_free(Accs)) {
1512 isl_set *OverlapAccs = isl_set_intersect(Accs, isl_set_copy(AllAccs));
1513 Valid = Valid && isl_set_is_empty(OverlapAccs);
1514 isl_set_free(OverlapAccs);
1515 }
1516 }
1517
1518 isl_set_free(AllAccs);
1519 if (!Valid)
1520 continue;
1521
Johannes Doerfertf6183392014-07-01 20:52:51 +00001522 const LoadInst *Load =
1523 dyn_cast<const LoadInst>(CandidatePair.first->getAccessInstruction());
1524 MemoryAccess::ReductionType RT =
1525 getReductionType(dyn_cast<BinaryOperator>(Load->user_back()), Load);
1526
Johannes Doerferte58a0122014-06-27 20:31:28 +00001527 // If no overlapping access was found we mark the load and store as
1528 // reduction like.
Johannes Doerfertf6183392014-07-01 20:52:51 +00001529 CandidatePair.first->markAsReductionLike(RT);
1530 CandidatePair.second->markAsReductionLike(RT);
Johannes Doerferte58a0122014-06-27 20:31:28 +00001531 }
Tobias Grosser75805372011-04-29 06:27:02 +00001532}
1533
Tobias Grosser74394f02013-01-14 22:40:23 +00001534std::string ScopStmt::getDomainStr() const { return stringFromIslObj(Domain); }
Tobias Grosser75805372011-04-29 06:27:02 +00001535
Tobias Grosser54839312015-04-21 11:37:25 +00001536std::string ScopStmt::getScheduleStr() const {
Tobias Grosser808cd692015-07-14 09:33:13 +00001537 auto *S = getSchedule();
1538 auto Str = stringFromIslObj(S);
1539 isl_map_free(S);
1540 return Str;
Tobias Grosser75805372011-04-29 06:27:02 +00001541}
1542
Michael Kruse375cb5f2016-02-24 22:08:24 +00001543BasicBlock *ScopStmt::getEntryBlock() const {
1544 if (isBlockStmt())
1545 return getBasicBlock();
1546 return getRegion()->getEntry();
1547}
1548
Michael Kruse7b5caa42016-02-24 22:08:28 +00001549RegionNode *ScopStmt::getRegionNode() const {
1550 if (isRegionStmt())
1551 return getRegion()->getNode();
1552 return getParent()->getRegion().getBBNode(getBasicBlock());
1553}
1554
Tobias Grosser74394f02013-01-14 22:40:23 +00001555unsigned ScopStmt::getNumParams() const { return Parent.getNumParams(); }
Tobias Grosser75805372011-04-29 06:27:02 +00001556
Tobias Grosserf567e1a2015-02-19 22:16:12 +00001557unsigned ScopStmt::getNumIterators() const { return NestLoops.size(); }
Tobias Grosser75805372011-04-29 06:27:02 +00001558
Tobias Grosser75805372011-04-29 06:27:02 +00001559const char *ScopStmt::getBaseName() const { return BaseName.c_str(); }
1560
Hongbin Zheng27f3afb2011-04-30 03:26:51 +00001561const Loop *ScopStmt::getLoopForDimension(unsigned Dimension) const {
Sebastian Pop860e0212013-02-15 21:26:44 +00001562 return NestLoops[Dimension];
Tobias Grosser75805372011-04-29 06:27:02 +00001563}
1564
Tobias Grosser74394f02013-01-14 22:40:23 +00001565isl_ctx *ScopStmt::getIslCtx() const { return Parent.getIslCtx(); }
Tobias Grosser75805372011-04-29 06:27:02 +00001566
Tobias Grosser4f663aa2015-03-30 11:52:59 +00001567__isl_give isl_set *ScopStmt::getDomain() const { return isl_set_copy(Domain); }
Tobias Grosserd5a7bfc2011-05-06 19:52:19 +00001568
Tobias Grosser6e6c7e02015-03-30 12:22:39 +00001569__isl_give isl_space *ScopStmt::getDomainSpace() const {
Tobias Grosser78d8a3d2012-01-17 20:34:23 +00001570 return isl_set_get_space(Domain);
1571}
1572
Tobias Grosser4f663aa2015-03-30 11:52:59 +00001573__isl_give isl_id *ScopStmt::getDomainId() const {
1574 return isl_set_get_tuple_id(Domain);
1575}
Tobias Grossercd95b772012-08-30 11:49:38 +00001576
Tobias Grosser10120182015-12-16 16:14:03 +00001577ScopStmt::~ScopStmt() { isl_set_free(Domain); }
Tobias Grosser75805372011-04-29 06:27:02 +00001578
1579void ScopStmt::print(raw_ostream &OS) const {
1580 OS << "\t" << getBaseName() << "\n";
Tobias Grosser75805372011-04-29 06:27:02 +00001581 OS.indent(12) << "Domain :=\n";
1582
1583 if (Domain) {
1584 OS.indent(16) << getDomainStr() << ";\n";
1585 } else
1586 OS.indent(16) << "n/a\n";
1587
Tobias Grosser54839312015-04-21 11:37:25 +00001588 OS.indent(12) << "Schedule :=\n";
Tobias Grosser75805372011-04-29 06:27:02 +00001589
1590 if (Domain) {
Tobias Grosser54839312015-04-21 11:37:25 +00001591 OS.indent(16) << getScheduleStr() << ";\n";
Tobias Grosser75805372011-04-29 06:27:02 +00001592 } else
1593 OS.indent(16) << "n/a\n";
1594
Tobias Grosser083d3d32014-06-28 08:59:45 +00001595 for (MemoryAccess *Access : MemAccs)
1596 Access->print(OS);
Tobias Grosser75805372011-04-29 06:27:02 +00001597}
1598
1599void ScopStmt::dump() const { print(dbgs()); }
1600
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00001601void ScopStmt::removeMemoryAccesses(MemoryAccessList &InvMAs) {
Tobias Grosseref9ca5d2015-11-30 17:20:40 +00001602 // Remove all memory accesses in @p InvMAs from this statement
1603 // together with all scalar accesses that were caused by them.
Michael Krusead28e5a2016-01-26 13:33:15 +00001604 // MK_Value READs have no access instruction, hence would not be removed by
1605 // this function. However, it is only used for invariant LoadInst accesses,
1606 // its arguments are always affine, hence synthesizable, and therefore there
1607 // are no MK_Value READ accesses to be removed.
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00001608 for (MemoryAccess *MA : InvMAs) {
Tobias Grosseref9ca5d2015-11-30 17:20:40 +00001609 auto Predicate = [&](MemoryAccess *Acc) {
Tobias Grosser3a6ac9f2015-11-30 21:13:43 +00001610 return Acc->getAccessInstruction() == MA->getAccessInstruction();
Tobias Grosseref9ca5d2015-11-30 17:20:40 +00001611 };
1612 MemAccs.erase(std::remove_if(MemAccs.begin(), MemAccs.end(), Predicate),
1613 MemAccs.end());
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00001614 InstructionToAccess.erase(MA->getAccessInstruction());
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00001615 }
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00001616}
1617
Tobias Grosser75805372011-04-29 06:27:02 +00001618//===----------------------------------------------------------------------===//
1619/// Scop class implement
Tobias Grosser60b54f12011-11-08 15:41:28 +00001620
Tobias Grosser7ffe4e82011-11-17 12:56:10 +00001621void Scop::setContext(__isl_take isl_set *NewContext) {
Tobias Grosserff9b54d2011-11-15 11:38:44 +00001622 NewContext = isl_set_align_params(NewContext, isl_set_get_space(Context));
1623 isl_set_free(Context);
1624 Context = NewContext;
1625}
1626
Johannes Doerfertd6fc0702015-11-03 16:47:58 +00001627/// @brief Remap parameter values but keep AddRecs valid wrt. invariant loads.
1628struct SCEVSensitiveParameterRewriter
1629 : public SCEVVisitor<SCEVSensitiveParameterRewriter, const SCEV *> {
1630 ValueToValueMap &VMap;
1631 ScalarEvolution &SE;
1632
1633public:
1634 SCEVSensitiveParameterRewriter(ValueToValueMap &VMap, ScalarEvolution &SE)
1635 : VMap(VMap), SE(SE) {}
1636
1637 static const SCEV *rewrite(const SCEV *E, ScalarEvolution &SE,
1638 ValueToValueMap &VMap) {
1639 SCEVSensitiveParameterRewriter SSPR(VMap, SE);
1640 return SSPR.visit(E);
1641 }
1642
1643 const SCEV *visit(const SCEV *E) {
1644 return SCEVVisitor<SCEVSensitiveParameterRewriter, const SCEV *>::visit(E);
1645 }
1646
1647 const SCEV *visitConstant(const SCEVConstant *E) { return E; }
1648
1649 const SCEV *visitTruncateExpr(const SCEVTruncateExpr *E) {
1650 return SE.getTruncateExpr(visit(E->getOperand()), E->getType());
1651 }
1652
1653 const SCEV *visitZeroExtendExpr(const SCEVZeroExtendExpr *E) {
1654 return SE.getZeroExtendExpr(visit(E->getOperand()), E->getType());
1655 }
1656
1657 const SCEV *visitSignExtendExpr(const SCEVSignExtendExpr *E) {
1658 return SE.getSignExtendExpr(visit(E->getOperand()), E->getType());
1659 }
1660
1661 const SCEV *visitAddExpr(const SCEVAddExpr *E) {
1662 SmallVector<const SCEV *, 4> Operands;
1663 for (int i = 0, e = E->getNumOperands(); i < e; ++i)
1664 Operands.push_back(visit(E->getOperand(i)));
1665 return SE.getAddExpr(Operands);
1666 }
1667
1668 const SCEV *visitMulExpr(const SCEVMulExpr *E) {
1669 SmallVector<const SCEV *, 4> Operands;
1670 for (int i = 0, e = E->getNumOperands(); i < e; ++i)
1671 Operands.push_back(visit(E->getOperand(i)));
1672 return SE.getMulExpr(Operands);
1673 }
1674
1675 const SCEV *visitSMaxExpr(const SCEVSMaxExpr *E) {
1676 SmallVector<const SCEV *, 4> Operands;
1677 for (int i = 0, e = E->getNumOperands(); i < e; ++i)
1678 Operands.push_back(visit(E->getOperand(i)));
1679 return SE.getSMaxExpr(Operands);
1680 }
1681
1682 const SCEV *visitUMaxExpr(const SCEVUMaxExpr *E) {
1683 SmallVector<const SCEV *, 4> Operands;
1684 for (int i = 0, e = E->getNumOperands(); i < e; ++i)
1685 Operands.push_back(visit(E->getOperand(i)));
1686 return SE.getUMaxExpr(Operands);
1687 }
1688
1689 const SCEV *visitUDivExpr(const SCEVUDivExpr *E) {
1690 return SE.getUDivExpr(visit(E->getLHS()), visit(E->getRHS()));
1691 }
1692
1693 const SCEV *visitAddRecExpr(const SCEVAddRecExpr *E) {
1694 auto *Start = visit(E->getStart());
1695 auto *AddRec = SE.getAddRecExpr(SE.getConstant(E->getType(), 0),
1696 visit(E->getStepRecurrence(SE)),
1697 E->getLoop(), SCEV::FlagAnyWrap);
1698 return SE.getAddExpr(Start, AddRec);
1699 }
1700
1701 const SCEV *visitUnknown(const SCEVUnknown *E) {
1702 if (auto *NewValue = VMap.lookup(E->getValue()))
1703 return SE.getUnknown(NewValue);
1704 return E;
1705 }
1706};
1707
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00001708const SCEV *Scop::getRepresentingInvariantLoadSCEV(const SCEV *S) {
Johannes Doerfertd6fc0702015-11-03 16:47:58 +00001709 return SCEVSensitiveParameterRewriter::rewrite(S, *SE, InvEquivClassVMap);
Johannes Doerfert697fdf82015-10-09 17:12:26 +00001710}
1711
Tobias Grosserabfbe632013-02-05 12:09:06 +00001712void Scop::addParams(std::vector<const SCEV *> NewParameters) {
Tobias Grosser083d3d32014-06-28 08:59:45 +00001713 for (const SCEV *Parameter : NewParameters) {
Johannes Doerfertbe409962015-03-29 20:45:09 +00001714 Parameter = extractConstantFactor(Parameter, *SE).second;
Johannes Doerfert697fdf82015-10-09 17:12:26 +00001715
1716 // Normalize the SCEV to get the representing element for an invariant load.
1717 Parameter = getRepresentingInvariantLoadSCEV(Parameter);
1718
Tobias Grosser60b54f12011-11-08 15:41:28 +00001719 if (ParameterIds.find(Parameter) != ParameterIds.end())
1720 continue;
1721
1722 int dimension = Parameters.size();
1723
1724 Parameters.push_back(Parameter);
1725 ParameterIds[Parameter] = dimension;
1726 }
1727}
1728
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00001729__isl_give isl_id *Scop::getIdForParam(const SCEV *Parameter) {
Johannes Doerfert697fdf82015-10-09 17:12:26 +00001730 // Normalize the SCEV to get the representing element for an invariant load.
1731 Parameter = getRepresentingInvariantLoadSCEV(Parameter);
1732
Tobias Grosser9a38ab82011-11-08 15:41:03 +00001733 ParamIdType::const_iterator IdIter = ParameterIds.find(Parameter);
Tobias Grosser76c2e322011-11-07 12:58:59 +00001734
Tobias Grosser9a38ab82011-11-08 15:41:03 +00001735 if (IdIter == ParameterIds.end())
Tobias Grosser5a56cbf2014-04-16 07:33:47 +00001736 return nullptr;
Tobias Grosser76c2e322011-11-07 12:58:59 +00001737
Tobias Grosser8f99c162011-11-15 11:38:55 +00001738 std::string ParameterName;
1739
Craig Topper7fb6e472016-01-31 20:36:20 +00001740 ParameterName = "p_" + utostr(IdIter->second);
Tobias Grosserb39c96a2015-11-17 11:54:51 +00001741
Tobias Grosser8f99c162011-11-15 11:38:55 +00001742 if (const SCEVUnknown *ValueParameter = dyn_cast<SCEVUnknown>(Parameter)) {
1743 Value *Val = ValueParameter->getValue();
Tobias Grosser8f99c162011-11-15 11:38:55 +00001744
Tobias Grosserb39c96a2015-11-17 11:54:51 +00001745 // If this parameter references a specific Value and this value has a name
1746 // we use this name as it is likely to be unique and more useful than just
1747 // a number.
1748 if (Val->hasName())
1749 ParameterName = Val->getName();
1750 else if (LoadInst *LI = dyn_cast<LoadInst>(Val)) {
Johannes Doerferta90943d2016-02-21 16:37:25 +00001751 auto *LoadOrigin = LI->getPointerOperand()->stripInBoundsOffsets();
Tobias Grosserb39c96a2015-11-17 11:54:51 +00001752 if (LoadOrigin->hasName()) {
1753 ParameterName += "_loaded_from_";
1754 ParameterName +=
1755 LI->getPointerOperand()->stripInBoundsOffsets()->getName();
1756 }
1757 }
1758 }
Tobias Grosser8f99c162011-11-15 11:38:55 +00001759
Tobias Grosser20532b82014-04-11 17:56:49 +00001760 return isl_id_alloc(getIslCtx(), ParameterName.c_str(),
1761 const_cast<void *>((const void *)Parameter));
Tobias Grosser76c2e322011-11-07 12:58:59 +00001762}
Tobias Grosser75805372011-04-29 06:27:02 +00001763
Johannes Doerfert5d5b3062015-08-20 18:06:30 +00001764isl_set *Scop::addNonEmptyDomainConstraints(isl_set *C) const {
1765 isl_set *DomainContext = isl_union_set_params(getDomains());
1766 return isl_set_intersect_params(C, DomainContext);
1767}
1768
Johannes Doerfert066dbf32016-03-01 13:06:28 +00001769void Scop::addWrappingContext() {
1770 if (IgnoreIntegerWrapping)
Tobias Grosser4927c8e2015-11-24 12:50:02 +00001771 return;
Tobias Grosser4927c8e2015-11-24 12:50:02 +00001772
Johannes Doerfert066dbf32016-03-01 13:06:28 +00001773 auto *WrappingContext = Affinator.getWrappingContext();
1774 addAssumption(WRAPPING, WrappingContext, DebugLoc(), AS_RESTRICTION);
Johannes Doerfert883f8c12015-09-15 22:52:53 +00001775}
1776
Hongbin Zheng192f69a2016-02-13 15:12:54 +00001777void Scop::addUserAssumptions(AssumptionCache &AC, DominatorTree &DT,
1778 LoopInfo &LI) {
Johannes Doerfert2af10e22015-11-12 03:25:01 +00001779 auto *R = &getRegion();
1780 auto &F = *R->getEntry()->getParent();
1781 for (auto &Assumption : AC.assumptions()) {
1782 auto *CI = dyn_cast_or_null<CallInst>(Assumption);
1783 if (!CI || CI->getNumArgOperands() != 1)
1784 continue;
1785 if (!DT.dominates(CI->getParent(), R->getEntry()))
1786 continue;
1787
Michael Kruse09eb4452016-03-03 22:10:47 +00001788 auto *L = LI.getLoopFor(CI->getParent());
Johannes Doerfert2af10e22015-11-12 03:25:01 +00001789 auto *Val = CI->getArgOperand(0);
1790 std::vector<const SCEV *> Params;
Michael Kruse09eb4452016-03-03 22:10:47 +00001791 if (!isAffineParamConstraint(Val, R, L, *SE, Params)) {
Johannes Doerfert2af10e22015-11-12 03:25:01 +00001792 emitOptimizationRemarkAnalysis(F.getContext(), DEBUG_TYPE, F,
1793 CI->getDebugLoc(),
1794 "Non-affine user assumption ignored.");
1795 continue;
1796 }
1797
1798 addParams(Params);
1799
Johannes Doerfert2af10e22015-11-12 03:25:01 +00001800 SmallVector<isl_set *, 2> ConditionSets;
1801 buildConditionSets(*this, Val, nullptr, L, Context, ConditionSets);
1802 assert(ConditionSets.size() == 2);
1803 isl_set_free(ConditionSets[1]);
1804
1805 auto *AssumptionCtx = ConditionSets[0];
1806 emitOptimizationRemarkAnalysis(
1807 F.getContext(), DEBUG_TYPE, F, CI->getDebugLoc(),
1808 "Use user assumption: " + stringFromIslObj(AssumptionCtx));
1809 Context = isl_set_intersect(Context, AssumptionCtx);
1810 }
1811}
1812
Tobias Grosser8a9c2352015-08-16 10:19:29 +00001813void Scop::addUserContext() {
1814 if (UserContextStr.empty())
1815 return;
1816
Hongbin Zheng8831eb72016-02-17 15:49:21 +00001817 isl_set *UserContext =
1818 isl_set_read_from_str(getIslCtx(), UserContextStr.c_str());
Tobias Grosser8a9c2352015-08-16 10:19:29 +00001819 isl_space *Space = getParamSpace();
1820 if (isl_space_dim(Space, isl_dim_param) !=
1821 isl_set_dim(UserContext, isl_dim_param)) {
1822 auto SpaceStr = isl_space_to_str(Space);
1823 errs() << "Error: the context provided in -polly-context has not the same "
1824 << "number of dimensions than the computed context. Due to this "
1825 << "mismatch, the -polly-context option is ignored. Please provide "
1826 << "the context in the parameter space: " << SpaceStr << ".\n";
1827 free(SpaceStr);
1828 isl_set_free(UserContext);
1829 isl_space_free(Space);
1830 return;
1831 }
1832
1833 for (unsigned i = 0; i < isl_space_dim(Space, isl_dim_param); i++) {
Johannes Doerferta90943d2016-02-21 16:37:25 +00001834 auto *NameContext = isl_set_get_dim_name(Context, isl_dim_param, i);
1835 auto *NameUserContext = isl_set_get_dim_name(UserContext, isl_dim_param, i);
Tobias Grosser8a9c2352015-08-16 10:19:29 +00001836
1837 if (strcmp(NameContext, NameUserContext) != 0) {
1838 auto SpaceStr = isl_space_to_str(Space);
1839 errs() << "Error: the name of dimension " << i
1840 << " provided in -polly-context "
1841 << "is '" << NameUserContext << "', but the name in the computed "
1842 << "context is '" << NameContext
1843 << "'. Due to this name mismatch, "
1844 << "the -polly-context option is ignored. Please provide "
1845 << "the context in the parameter space: " << SpaceStr << ".\n";
1846 free(SpaceStr);
1847 isl_set_free(UserContext);
1848 isl_space_free(Space);
1849 return;
1850 }
1851
1852 UserContext =
1853 isl_set_set_dim_id(UserContext, isl_dim_param, i,
1854 isl_space_get_dim_id(Space, isl_dim_param, i));
1855 }
1856
1857 Context = isl_set_intersect(Context, UserContext);
1858 isl_space_free(Space);
1859}
1860
Hongbin Zheng7dddfba2016-02-13 15:12:47 +00001861void Scop::buildInvariantEquivalenceClasses(ScopDetection &SD) {
Johannes Doerfert96e54712016-02-07 17:30:13 +00001862 DenseMap<std::pair<const SCEV *, Type *>, LoadInst *> EquivClasses;
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00001863
Johannes Doerfert697fdf82015-10-09 17:12:26 +00001864 const InvariantLoadsSetTy &RIL = *SD.getRequiredInvariantLoads(&getRegion());
Johannes Doerfert697fdf82015-10-09 17:12:26 +00001865 for (LoadInst *LInst : RIL) {
1866 const SCEV *PointerSCEV = SE->getSCEV(LInst->getPointerOperand());
1867
Johannes Doerfert96e54712016-02-07 17:30:13 +00001868 Type *Ty = LInst->getType();
1869 LoadInst *&ClassRep = EquivClasses[std::make_pair(PointerSCEV, Ty)];
Johannes Doerfertfc4bfc42015-11-11 04:30:07 +00001870 if (ClassRep) {
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00001871 InvEquivClassVMap[LInst] = ClassRep;
Johannes Doerfertfc4bfc42015-11-11 04:30:07 +00001872 continue;
1873 }
1874
1875 ClassRep = LInst;
Johannes Doerfert96e54712016-02-07 17:30:13 +00001876 InvariantEquivClasses.emplace_back(PointerSCEV, MemoryAccessList(), nullptr,
1877 Ty);
Johannes Doerfert697fdf82015-10-09 17:12:26 +00001878 }
1879}
1880
Tobias Grosser6be480c2011-11-08 15:41:13 +00001881void Scop::buildContext() {
Hongbin Zheng8831eb72016-02-17 15:49:21 +00001882 isl_space *Space = isl_space_params_alloc(getIslCtx(), 0);
Tobias Grossere86109f2013-10-29 21:05:49 +00001883 Context = isl_set_universe(isl_space_copy(Space));
Johannes Doerfert066dbf32016-03-01 13:06:28 +00001884 InvalidContext = isl_set_empty(isl_space_copy(Space));
Tobias Grossere86109f2013-10-29 21:05:49 +00001885 AssumedContext = isl_set_universe(Space);
Tobias Grosser0e27e242011-10-06 00:03:48 +00001886}
1887
Tobias Grosser18daaca2012-05-22 10:47:27 +00001888void Scop::addParameterBounds() {
Johannes Doerfert4f8ac3d2015-02-23 16:15:51 +00001889 for (const auto &ParamID : ParameterIds) {
Johannes Doerfert4f8ac3d2015-02-23 16:15:51 +00001890 int dim = ParamID.second;
Tobias Grosser18daaca2012-05-22 10:47:27 +00001891
Johannes Doerfert4f8ac3d2015-02-23 16:15:51 +00001892 ConstantRange SRange = SE->getSignedRange(ParamID.first);
Tobias Grosser18daaca2012-05-22 10:47:27 +00001893
Johannes Doerferte7044942015-02-24 11:58:30 +00001894 Context = addRangeBoundsToSet(Context, SRange, dim, isl_dim_param);
Tobias Grosser18daaca2012-05-22 10:47:27 +00001895 }
1896}
1897
Tobias Grosser8cae72f2011-11-08 15:41:08 +00001898void Scop::realignParams() {
Tobias Grosser6be480c2011-11-08 15:41:13 +00001899 // Add all parameters into a common model.
Hongbin Zheng8831eb72016-02-17 15:49:21 +00001900 isl_space *Space = isl_space_params_alloc(getIslCtx(), ParameterIds.size());
Tobias Grosser6be480c2011-11-08 15:41:13 +00001901
Tobias Grosser083d3d32014-06-28 08:59:45 +00001902 for (const auto &ParamID : ParameterIds) {
1903 const SCEV *Parameter = ParamID.first;
Tobias Grosser6be480c2011-11-08 15:41:13 +00001904 isl_id *id = getIdForParam(Parameter);
Tobias Grosser083d3d32014-06-28 08:59:45 +00001905 Space = isl_space_set_dim_id(Space, isl_dim_param, ParamID.second, id);
Tobias Grosser6be480c2011-11-08 15:41:13 +00001906 }
1907
1908 // Align the parameters of all data structures to the model.
1909 Context = isl_set_align_params(Context, Space);
1910
Tobias Grosser7c3bad52015-05-27 05:16:57 +00001911 for (ScopStmt &Stmt : *this)
1912 Stmt.realignParams();
Tobias Grosser8cae72f2011-11-08 15:41:08 +00001913}
1914
Johannes Doerfert883f8c12015-09-15 22:52:53 +00001915static __isl_give isl_set *
1916simplifyAssumptionContext(__isl_take isl_set *AssumptionContext,
1917 const Scop &S) {
Johannes Doerfertf85ad042015-11-08 20:16:39 +00001918 // If we modelt all blocks in the SCoP that have side effects we can simplify
1919 // the context with the constraints that are needed for anything to be
1920 // executed at all. However, if we have error blocks in the SCoP we already
1921 // assumed some parameter combinations cannot occure and removed them from the
1922 // domains, thus we cannot use the remaining domain to simplify the
1923 // assumptions.
1924 if (!S.hasErrorBlock()) {
1925 isl_set *DomainParameters = isl_union_set_params(S.getDomains());
1926 AssumptionContext =
1927 isl_set_gist_params(AssumptionContext, DomainParameters);
1928 }
1929
Johannes Doerfert883f8c12015-09-15 22:52:53 +00001930 AssumptionContext = isl_set_gist_params(AssumptionContext, S.getContext());
1931 return AssumptionContext;
1932}
1933
1934void Scop::simplifyContexts() {
Tobias Grosser5e6813d2014-07-02 17:47:48 +00001935 // The parameter constraints of the iteration domains give us a set of
1936 // constraints that need to hold for all cases where at least a single
1937 // statement iteration is executed in the whole scop. We now simplify the
1938 // assumed context under the assumption that such constraints hold and at
1939 // least a single statement iteration is executed. For cases where no
1940 // statement instances are executed, the assumptions we have taken about
1941 // the executed code do not matter and can be changed.
1942 //
1943 // WARNING: This only holds if the assumptions we have taken do not reduce
1944 // the set of statement instances that are executed. Otherwise we
1945 // may run into a case where the iteration domains suggest that
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00001946 // for a certain set of parameter constraints no code is executed,
Tobias Grosser5e6813d2014-07-02 17:47:48 +00001947 // but in the original program some computation would have been
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00001948 // performed. In such a case, modifying the run-time conditions and
1949 // possibly influencing the run-time check may cause certain scops
Tobias Grosser5e6813d2014-07-02 17:47:48 +00001950 // to not be executed.
1951 //
1952 // Example:
1953 //
1954 // When delinearizing the following code:
1955 //
1956 // for (long i = 0; i < 100; i++)
1957 // for (long j = 0; j < m; j++)
1958 // A[i+p][j] = 1.0;
1959 //
1960 // we assume that the condition m <= 0 or (m >= 1 and p >= 0) holds as
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00001961 // otherwise we would access out of bound data. Now, knowing that code is
Tobias Grosser5e6813d2014-07-02 17:47:48 +00001962 // only executed for the case m >= 0, it is sufficient to assume p >= 0.
Johannes Doerfert883f8c12015-09-15 22:52:53 +00001963 AssumedContext = simplifyAssumptionContext(AssumedContext, *this);
Johannes Doerfert066dbf32016-03-01 13:06:28 +00001964 InvalidContext = isl_set_align_params(InvalidContext, getParamSpace());
Tobias Grosser5e6813d2014-07-02 17:47:48 +00001965}
1966
Johannes Doerfertb164c792014-09-18 11:17:17 +00001967/// @brief Add the minimal/maximal access in @p Set to @p User.
Tobias Grosserb2f39922015-05-28 13:32:11 +00001968static isl_stat buildMinMaxAccess(__isl_take isl_set *Set, void *User) {
Johannes Doerfertb164c792014-09-18 11:17:17 +00001969 Scop::MinMaxVectorTy *MinMaxAccesses = (Scop::MinMaxVectorTy *)User;
1970 isl_pw_multi_aff *MinPMA, *MaxPMA;
1971 isl_pw_aff *LastDimAff;
1972 isl_aff *OneAff;
1973 unsigned Pos;
1974
Johannes Doerfert9143d672014-09-27 11:02:39 +00001975 // Restrict the number of parameters involved in the access as the lexmin/
1976 // lexmax computation will take too long if this number is high.
1977 //
1978 // Experiments with a simple test case using an i7 4800MQ:
1979 //
1980 // #Parameters involved | Time (in sec)
1981 // 6 | 0.01
1982 // 7 | 0.04
1983 // 8 | 0.12
1984 // 9 | 0.40
1985 // 10 | 1.54
1986 // 11 | 6.78
1987 // 12 | 30.38
1988 //
1989 if (isl_set_n_param(Set) > RunTimeChecksMaxParameters) {
1990 unsigned InvolvedParams = 0;
1991 for (unsigned u = 0, e = isl_set_n_param(Set); u < e; u++)
1992 if (isl_set_involves_dims(Set, isl_dim_param, u, 1))
1993 InvolvedParams++;
1994
1995 if (InvolvedParams > RunTimeChecksMaxParameters) {
1996 isl_set_free(Set);
Tobias Grosserb2f39922015-05-28 13:32:11 +00001997 return isl_stat_error;
Johannes Doerfert9143d672014-09-27 11:02:39 +00001998 }
1999 }
2000
Johannes Doerfertb6755bb2015-02-14 12:00:06 +00002001 Set = isl_set_remove_divs(Set);
2002
Johannes Doerfertb164c792014-09-18 11:17:17 +00002003 MinPMA = isl_set_lexmin_pw_multi_aff(isl_set_copy(Set));
2004 MaxPMA = isl_set_lexmax_pw_multi_aff(isl_set_copy(Set));
2005
Johannes Doerfert219b20e2014-10-07 14:37:59 +00002006 MinPMA = isl_pw_multi_aff_coalesce(MinPMA);
2007 MaxPMA = isl_pw_multi_aff_coalesce(MaxPMA);
2008
Johannes Doerfertb164c792014-09-18 11:17:17 +00002009 // Adjust the last dimension of the maximal access by one as we want to
2010 // enclose the accessed memory region by MinPMA and MaxPMA. The pointer
2011 // we test during code generation might now point after the end of the
2012 // allocated array but we will never dereference it anyway.
2013 assert(isl_pw_multi_aff_dim(MaxPMA, isl_dim_out) &&
2014 "Assumed at least one output dimension");
2015 Pos = isl_pw_multi_aff_dim(MaxPMA, isl_dim_out) - 1;
2016 LastDimAff = isl_pw_multi_aff_get_pw_aff(MaxPMA, Pos);
2017 OneAff = isl_aff_zero_on_domain(
2018 isl_local_space_from_space(isl_pw_aff_get_domain_space(LastDimAff)));
2019 OneAff = isl_aff_add_constant_si(OneAff, 1);
2020 LastDimAff = isl_pw_aff_add(LastDimAff, isl_pw_aff_from_aff(OneAff));
2021 MaxPMA = isl_pw_multi_aff_set_pw_aff(MaxPMA, Pos, LastDimAff);
2022
2023 MinMaxAccesses->push_back(std::make_pair(MinPMA, MaxPMA));
2024
2025 isl_set_free(Set);
Tobias Grosserb2f39922015-05-28 13:32:11 +00002026 return isl_stat_ok;
Johannes Doerfertb164c792014-09-18 11:17:17 +00002027}
2028
Johannes Doerferteeab05a2014-10-01 12:42:37 +00002029static __isl_give isl_set *getAccessDomain(MemoryAccess *MA) {
2030 isl_set *Domain = MA->getStatement()->getDomain();
2031 Domain = isl_set_project_out(Domain, isl_dim_set, 0, isl_set_n_dim(Domain));
2032 return isl_set_reset_tuple_id(Domain);
2033}
2034
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002035/// @brief Wrapper function to calculate minimal/maximal accesses to each array.
2036static bool calculateMinMaxAccess(__isl_take isl_union_map *Accesses,
Tobias Grosserbb853c22015-07-25 12:31:03 +00002037 __isl_take isl_union_set *Domains,
Johannes Doerfert210b09a2015-07-26 13:14:38 +00002038 Scop::MinMaxVectorTy &MinMaxAccesses) {
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002039
2040 Accesses = isl_union_map_intersect_domain(Accesses, Domains);
2041 isl_union_set *Locations = isl_union_map_range(Accesses);
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002042 Locations = isl_union_set_coalesce(Locations);
2043 Locations = isl_union_set_detect_equalities(Locations);
2044 bool Valid = (0 == isl_union_set_foreach_set(Locations, buildMinMaxAccess,
Johannes Doerfert210b09a2015-07-26 13:14:38 +00002045 &MinMaxAccesses));
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002046 isl_union_set_free(Locations);
2047 return Valid;
2048}
2049
Johannes Doerfert96425c22015-08-30 21:13:53 +00002050/// @brief Helper to treat non-affine regions and basic blocks the same.
2051///
2052///{
2053
2054/// @brief Return the block that is the representing block for @p RN.
2055static inline BasicBlock *getRegionNodeBasicBlock(RegionNode *RN) {
2056 return RN->isSubRegion() ? RN->getNodeAs<Region>()->getEntry()
2057 : RN->getNodeAs<BasicBlock>();
2058}
2059
2060/// @brief Return the @p idx'th block that is executed after @p RN.
Johannes Doerfert9a132f32015-09-28 09:33:22 +00002061static inline BasicBlock *
2062getRegionNodeSuccessor(RegionNode *RN, TerminatorInst *TI, unsigned idx) {
Johannes Doerfert96425c22015-08-30 21:13:53 +00002063 if (RN->isSubRegion()) {
2064 assert(idx == 0);
2065 return RN->getNodeAs<Region>()->getExit();
2066 }
Johannes Doerfert9a132f32015-09-28 09:33:22 +00002067 return TI->getSuccessor(idx);
Johannes Doerfert96425c22015-08-30 21:13:53 +00002068}
2069
2070/// @brief Return the smallest loop surrounding @p RN.
2071static inline Loop *getRegionNodeLoop(RegionNode *RN, LoopInfo &LI) {
2072 if (!RN->isSubRegion())
2073 return LI.getLoopFor(RN->getNodeAs<BasicBlock>());
2074
2075 Region *NonAffineSubRegion = RN->getNodeAs<Region>();
2076 Loop *L = LI.getLoopFor(NonAffineSubRegion->getEntry());
2077 while (L && NonAffineSubRegion->contains(L))
2078 L = L->getParentLoop();
2079 return L;
2080}
2081
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002082static inline unsigned getNumBlocksInRegionNode(RegionNode *RN) {
2083 if (!RN->isSubRegion())
2084 return 1;
2085
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002086 Region *R = RN->getNodeAs<Region>();
Tobias Grosser0dd4a9a2016-02-01 01:55:08 +00002087 return std::distance(R->block_begin(), R->block_end());
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002088}
2089
Johannes Doerfert08d90a32015-10-07 20:32:43 +00002090static bool containsErrorBlock(RegionNode *RN, const Region &R, LoopInfo &LI,
2091 const DominatorTree &DT) {
Johannes Doerfertf5673802015-10-01 23:48:18 +00002092 if (!RN->isSubRegion())
Johannes Doerfert08d90a32015-10-07 20:32:43 +00002093 return isErrorBlock(*RN->getNodeAs<BasicBlock>(), R, LI, DT);
Johannes Doerfertf5673802015-10-01 23:48:18 +00002094 for (BasicBlock *BB : RN->getNodeAs<Region>()->blocks())
Johannes Doerfert08d90a32015-10-07 20:32:43 +00002095 if (isErrorBlock(*BB, R, LI, DT))
Johannes Doerfertf5673802015-10-01 23:48:18 +00002096 return true;
2097 return false;
2098}
2099
Johannes Doerfert96425c22015-08-30 21:13:53 +00002100///}
2101
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002102static inline __isl_give isl_set *addDomainDimId(__isl_take isl_set *Domain,
2103 unsigned Dim, Loop *L) {
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002104 Domain = isl_set_lower_bound_si(Domain, isl_dim_set, Dim, -1);
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002105 isl_id *DimId =
2106 isl_id_alloc(isl_set_get_ctx(Domain), nullptr, static_cast<void *>(L));
2107 return isl_set_set_dim_id(Domain, isl_dim_set, Dim, DimId);
2108}
2109
Johannes Doerfert96425c22015-08-30 21:13:53 +00002110isl_set *Scop::getDomainConditions(ScopStmt *Stmt) {
Michael Kruse375cb5f2016-02-24 22:08:24 +00002111 return getDomainConditions(Stmt->getEntryBlock());
Johannes Doerfertcef616f2015-09-15 22:49:04 +00002112}
2113
2114isl_set *Scop::getDomainConditions(BasicBlock *BB) {
2115 assert(DomainMap.count(BB) && "Requested BB did not have a domain");
Johannes Doerfertf08bd002015-08-31 13:56:32 +00002116 return isl_set_copy(DomainMap[BB]);
Johannes Doerfert96425c22015-08-30 21:13:53 +00002117}
2118
Hongbin Zheng192f69a2016-02-13 15:12:54 +00002119void Scop::removeErrorBlockDomains(ScopDetection &SD, DominatorTree &DT,
2120 LoopInfo &LI) {
Hongbin Zhengf53ffa62016-02-13 15:12:51 +00002121 auto removeDomains = [this, &DT](BasicBlock *Start) {
Johannes Doerferta90943d2016-02-21 16:37:25 +00002122 auto *BBNode = DT.getNode(Start);
2123 for (auto *ErrorChild : depth_first(BBNode)) {
2124 auto *ErrorChildBlock = ErrorChild->getBlock();
2125 auto *CurrentDomain = DomainMap[ErrorChildBlock];
2126 auto *Empty = isl_set_empty(isl_set_get_space(CurrentDomain));
Tobias Grosser9737c7b2015-11-22 11:06:51 +00002127 DomainMap[ErrorChildBlock] = Empty;
2128 isl_set_free(CurrentDomain);
2129 }
2130 };
2131
Tobias Grosser5ef2bc32015-11-23 10:18:23 +00002132 SmallVector<Region *, 4> Todo = {&R};
Tobias Grosser9737c7b2015-11-22 11:06:51 +00002133
2134 while (!Todo.empty()) {
Johannes Doerferta90943d2016-02-21 16:37:25 +00002135 auto *SubRegion = Todo.back();
Tobias Grosser9737c7b2015-11-22 11:06:51 +00002136 Todo.pop_back();
2137
2138 if (!SD.isNonAffineSubRegion(SubRegion, &getRegion())) {
2139 for (auto &Child : *SubRegion)
2140 Todo.push_back(Child.get());
2141 continue;
2142 }
2143 if (containsErrorBlock(SubRegion->getNode(), getRegion(), LI, DT))
2144 removeDomains(SubRegion->getEntry());
2145 }
2146
Johannes Doerferta90943d2016-02-21 16:37:25 +00002147 for (auto *BB : R.blocks())
Tobias Grosser9737c7b2015-11-22 11:06:51 +00002148 if (isErrorBlock(*BB, R, LI, DT))
2149 removeDomains(BB);
2150}
2151
Hongbin Zheng192f69a2016-02-13 15:12:54 +00002152void Scop::buildDomains(Region *R, ScopDetection &SD, DominatorTree &DT,
2153 LoopInfo &LI) {
Johannes Doerfert96425c22015-08-30 21:13:53 +00002154
Johannes Doerfert432658d2016-01-26 11:01:41 +00002155 bool IsOnlyNonAffineRegion = SD.isNonAffineSubRegion(R, R);
Johannes Doerfertf08bd002015-08-31 13:56:32 +00002156 auto *EntryBB = R->getEntry();
Johannes Doerfert432658d2016-01-26 11:01:41 +00002157 auto *L = IsOnlyNonAffineRegion ? nullptr : LI.getLoopFor(EntryBB);
2158 int LD = getRelativeLoopDepth(L);
Johannes Doerfertf08bd002015-08-31 13:56:32 +00002159 auto *S = isl_set_universe(isl_space_set_alloc(getIslCtx(), 0, LD + 1));
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002160
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002161 while (LD-- >= 0) {
2162 S = addDomainDimId(S, LD + 1, L);
2163 L = L->getParentLoop();
2164 }
2165
Johannes Doerfertf08bd002015-08-31 13:56:32 +00002166 DomainMap[EntryBB] = S;
Johannes Doerfert96425c22015-08-30 21:13:53 +00002167
Johannes Doerfert432658d2016-01-26 11:01:41 +00002168 if (IsOnlyNonAffineRegion)
Johannes Doerfert40fa56f2015-09-14 11:15:07 +00002169 return;
2170
Hongbin Zheng192f69a2016-02-13 15:12:54 +00002171 buildDomainsWithBranchConstraints(R, SD, DT, LI);
2172 propagateDomainConstraints(R, SD, DT, LI);
Tobias Grosser9737c7b2015-11-22 11:06:51 +00002173
2174 // Error blocks and blocks dominated by them have been assumed to never be
2175 // executed. Representing them in the Scop does not add any value. In fact,
2176 // it is likely to cause issues during construction of the ScopStmts. The
2177 // contents of error blocks have not been verfied to be expressible and
2178 // will cause problems when building up a ScopStmt for them.
2179 // Furthermore, basic blocks dominated by error blocks may reference
2180 // instructions in the error block which, if the error block is not modeled,
2181 // can themselves not be constructed properly.
Hongbin Zheng192f69a2016-02-13 15:12:54 +00002182 removeErrorBlockDomains(SD, DT, LI);
Johannes Doerfert96425c22015-08-30 21:13:53 +00002183}
2184
Hongbin Zhengf53ffa62016-02-13 15:12:51 +00002185void Scop::buildDomainsWithBranchConstraints(Region *R, ScopDetection &SD,
Hongbin Zheng192f69a2016-02-13 15:12:54 +00002186 DominatorTree &DT, LoopInfo &LI) {
Johannes Doerfert6f50c292016-01-26 11:03:25 +00002187 auto &BoxedLoops = *SD.getBoxedLoops(&getRegion());
Johannes Doerfert96425c22015-08-30 21:13:53 +00002188
2189 // To create the domain for each block in R we iterate over all blocks and
2190 // subregions in R and propagate the conditions under which the current region
2191 // element is executed. To this end we iterate in reverse post order over R as
2192 // it ensures that we first visit all predecessors of a region node (either a
2193 // basic block or a subregion) before we visit the region node itself.
2194 // Initially, only the domain for the SCoP region entry block is set and from
2195 // there we propagate the current domain to all successors, however we add the
2196 // condition that the successor is actually executed next.
2197 // As we are only interested in non-loop carried constraints here we can
2198 // simply skip loop back edges.
2199
2200 ReversePostOrderTraversal<Region *> RTraversal(R);
2201 for (auto *RN : RTraversal) {
2202
2203 // Recurse for affine subregions but go on for basic blocks and non-affine
2204 // subregions.
2205 if (RN->isSubRegion()) {
2206 Region *SubRegion = RN->getNodeAs<Region>();
2207 if (!SD.isNonAffineSubRegion(SubRegion, &getRegion())) {
Hongbin Zheng192f69a2016-02-13 15:12:54 +00002208 buildDomainsWithBranchConstraints(SubRegion, SD, DT, LI);
Johannes Doerfert96425c22015-08-30 21:13:53 +00002209 continue;
2210 }
2211 }
2212
Tobias Grosserb76cd3c2015-11-11 08:42:20 +00002213 if (containsErrorBlock(RN, getRegion(), LI, DT))
Johannes Doerfertf85ad042015-11-08 20:16:39 +00002214 HasErrorBlock = true;
Johannes Doerfertf5673802015-10-01 23:48:18 +00002215
Johannes Doerfert96425c22015-08-30 21:13:53 +00002216 BasicBlock *BB = getRegionNodeBasicBlock(RN);
Johannes Doerfert90db75e2015-09-10 17:51:27 +00002217 TerminatorInst *TI = BB->getTerminator();
2218
Tobias Grosserb76cd3c2015-11-11 08:42:20 +00002219 if (isa<UnreachableInst>(TI))
2220 continue;
2221
Johannes Doerfertf5673802015-10-01 23:48:18 +00002222 isl_set *Domain = DomainMap.lookup(BB);
Tobias Grosser4fb9e512016-02-27 06:59:30 +00002223 if (!Domain)
Johannes Doerfert90db75e2015-09-10 17:51:27 +00002224 continue;
Johannes Doerfert96425c22015-08-30 21:13:53 +00002225
2226 Loop *BBLoop = getRegionNodeLoop(RN, LI);
2227 int BBLoopDepth = getRelativeLoopDepth(BBLoop);
2228
2229 // Build the condition sets for the successor nodes of the current region
2230 // node. If it is a non-affine subregion we will always execute the single
2231 // exit node, hence the single entry node domain is the condition set. For
2232 // basic blocks we use the helper function buildConditionSets.
Johannes Doerfert9a132f32015-09-28 09:33:22 +00002233 SmallVector<isl_set *, 8> ConditionSets;
Johannes Doerfert96425c22015-08-30 21:13:53 +00002234 if (RN->isSubRegion())
2235 ConditionSets.push_back(isl_set_copy(Domain));
2236 else
Johannes Doerfert9a132f32015-09-28 09:33:22 +00002237 buildConditionSets(*this, TI, BBLoop, Domain, ConditionSets);
Johannes Doerfert96425c22015-08-30 21:13:53 +00002238
2239 // Now iterate over the successors and set their initial domain based on
2240 // their condition set. We skip back edges here and have to be careful when
2241 // we leave a loop not to keep constraints over a dimension that doesn't
2242 // exist anymore.
Johannes Doerfert9a132f32015-09-28 09:33:22 +00002243 assert(RN->isSubRegion() || TI->getNumSuccessors() == ConditionSets.size());
Johannes Doerfert96425c22015-08-30 21:13:53 +00002244 for (unsigned u = 0, e = ConditionSets.size(); u < e; u++) {
Johannes Doerfert96425c22015-08-30 21:13:53 +00002245 isl_set *CondSet = ConditionSets[u];
Johannes Doerfert9a132f32015-09-28 09:33:22 +00002246 BasicBlock *SuccBB = getRegionNodeSuccessor(RN, TI, u);
Johannes Doerfert96425c22015-08-30 21:13:53 +00002247
2248 // Skip back edges.
2249 if (DT.dominates(SuccBB, BB)) {
2250 isl_set_free(CondSet);
2251 continue;
2252 }
2253
Johannes Doerfertf08bd002015-08-31 13:56:32 +00002254 // Do not adjust the number of dimensions if we enter a boxed loop or are
2255 // in a non-affine subregion or if the surrounding loop stays the same.
Johannes Doerfert96425c22015-08-30 21:13:53 +00002256 Loop *SuccBBLoop = LI.getLoopFor(SuccBB);
Johannes Doerfert6f50c292016-01-26 11:03:25 +00002257 while (BoxedLoops.count(SuccBBLoop))
2258 SuccBBLoop = SuccBBLoop->getParentLoop();
Johannes Doerfert634909c2015-10-04 14:57:41 +00002259
2260 if (BBLoop != SuccBBLoop) {
Johannes Doerfertf08bd002015-08-31 13:56:32 +00002261
2262 // Check if the edge to SuccBB is a loop entry or exit edge. If so
2263 // adjust the dimensionality accordingly. Lastly, if we leave a loop
2264 // and enter a new one we need to drop the old constraints.
2265 int SuccBBLoopDepth = getRelativeLoopDepth(SuccBBLoop);
Johannes Doerfertf4fa9872015-09-10 15:53:59 +00002266 unsigned LoopDepthDiff = std::abs(BBLoopDepth - SuccBBLoopDepth);
Tobias Grosser2df884f2015-09-01 18:17:41 +00002267 if (BBLoopDepth > SuccBBLoopDepth) {
Johannes Doerfertf4fa9872015-09-10 15:53:59 +00002268 CondSet = isl_set_project_out(CondSet, isl_dim_set,
2269 isl_set_n_dim(CondSet) - LoopDepthDiff,
2270 LoopDepthDiff);
Tobias Grosser2df884f2015-09-01 18:17:41 +00002271 } else if (SuccBBLoopDepth > BBLoopDepth) {
Johannes Doerfertf4fa9872015-09-10 15:53:59 +00002272 assert(LoopDepthDiff == 1);
Johannes Doerfertf08bd002015-08-31 13:56:32 +00002273 CondSet = isl_set_add_dims(CondSet, isl_dim_set, 1);
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002274 CondSet = addDomainDimId(CondSet, SuccBBLoopDepth, SuccBBLoop);
Tobias Grosser2df884f2015-09-01 18:17:41 +00002275 } else if (BBLoopDepth >= 0) {
Johannes Doerfertf4fa9872015-09-10 15:53:59 +00002276 assert(LoopDepthDiff <= 1);
Tobias Grosser2df884f2015-09-01 18:17:41 +00002277 CondSet = isl_set_project_out(CondSet, isl_dim_set, BBLoopDepth, 1);
2278 CondSet = isl_set_add_dims(CondSet, isl_dim_set, 1);
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002279 CondSet = addDomainDimId(CondSet, SuccBBLoopDepth, SuccBBLoop);
Tobias Grosser2df884f2015-09-01 18:17:41 +00002280 }
Johannes Doerfert96425c22015-08-30 21:13:53 +00002281 }
2282
2283 // Set the domain for the successor or merge it with an existing domain in
2284 // case there are multiple paths (without loop back edges) to the
2285 // successor block.
2286 isl_set *&SuccDomain = DomainMap[SuccBB];
2287 if (!SuccDomain)
2288 SuccDomain = CondSet;
2289 else
2290 SuccDomain = isl_set_union(SuccDomain, CondSet);
2291
2292 SuccDomain = isl_set_coalesce(SuccDomain);
Tobias Grosser75dc40c2015-12-20 13:31:48 +00002293 if (isl_set_n_basic_set(SuccDomain) > MaxConjunctsInDomain) {
2294 auto *Empty = isl_set_empty(isl_set_get_space(SuccDomain));
2295 isl_set_free(SuccDomain);
2296 SuccDomain = Empty;
2297 invalidate(ERROR_DOMAINCONJUNCTS, DebugLoc());
2298 }
Johannes Doerfert96425c22015-08-30 21:13:53 +00002299 }
2300 }
2301}
2302
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002303/// @brief Return the domain for @p BB wrt @p DomainMap.
2304///
2305/// This helper function will lookup @p BB in @p DomainMap but also handle the
2306/// case where @p BB is contained in a non-affine subregion using the region
2307/// tree obtained by @p RI.
2308static __isl_give isl_set *
2309getDomainForBlock(BasicBlock *BB, DenseMap<BasicBlock *, isl_set *> &DomainMap,
2310 RegionInfo &RI) {
2311 auto DIt = DomainMap.find(BB);
2312 if (DIt != DomainMap.end())
2313 return isl_set_copy(DIt->getSecond());
2314
2315 Region *R = RI.getRegionFor(BB);
2316 while (R->getEntry() == BB)
2317 R = R->getParent();
2318 return getDomainForBlock(R->getEntry(), DomainMap, RI);
2319}
2320
Hongbin Zhengf53ffa62016-02-13 15:12:51 +00002321void Scop::propagateDomainConstraints(Region *R, ScopDetection &SD,
Hongbin Zheng192f69a2016-02-13 15:12:54 +00002322 DominatorTree &DT, LoopInfo &LI) {
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002323 // Iterate over the region R and propagate the domain constrains from the
2324 // predecessors to the current node. In contrast to the
2325 // buildDomainsWithBranchConstraints function, this one will pull the domain
2326 // information from the predecessors instead of pushing it to the successors.
2327 // Additionally, we assume the domains to be already present in the domain
2328 // map here. However, we iterate again in reverse post order so we know all
2329 // predecessors have been visited before a block or non-affine subregion is
2330 // visited.
2331
2332 // The set of boxed loops (loops in non-affine subregions) for this SCoP.
2333 auto &BoxedLoops = *SD.getBoxedLoops(&getRegion());
2334
2335 ReversePostOrderTraversal<Region *> RTraversal(R);
2336 for (auto *RN : RTraversal) {
2337
2338 // Recurse for affine subregions but go on for basic blocks and non-affine
2339 // subregions.
2340 if (RN->isSubRegion()) {
2341 Region *SubRegion = RN->getNodeAs<Region>();
2342 if (!SD.isNonAffineSubRegion(SubRegion, &getRegion())) {
Hongbin Zheng192f69a2016-02-13 15:12:54 +00002343 propagateDomainConstraints(SubRegion, SD, DT, LI);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002344 continue;
2345 }
2346 }
2347
Johannes Doerfertf5673802015-10-01 23:48:18 +00002348 // Get the domain for the current block and check if it was initialized or
2349 // not. The only way it was not is if this block is only reachable via error
2350 // blocks, thus will not be executed under the assumptions we make. Such
2351 // blocks have to be skipped as their predecessors might not have domains
2352 // either. It would not benefit us to compute the domain anyway, only the
2353 // domains of the error blocks that are reachable from non-error blocks
2354 // are needed to generate assumptions.
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002355 BasicBlock *BB = getRegionNodeBasicBlock(RN);
Johannes Doerfertf5673802015-10-01 23:48:18 +00002356 isl_set *&Domain = DomainMap[BB];
2357 if (!Domain) {
Johannes Doerfertf5673802015-10-01 23:48:18 +00002358 DomainMap.erase(BB);
2359 continue;
2360 }
Johannes Doerfertf5673802015-10-01 23:48:18 +00002361
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002362 Loop *BBLoop = getRegionNodeLoop(RN, LI);
2363 int BBLoopDepth = getRelativeLoopDepth(BBLoop);
2364
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002365 isl_set *PredDom = isl_set_empty(isl_set_get_space(Domain));
2366 for (auto *PredBB : predecessors(BB)) {
2367
2368 // Skip backedges
2369 if (DT.dominates(BB, PredBB))
2370 continue;
2371
2372 isl_set *PredBBDom = nullptr;
2373
2374 // Handle the SCoP entry block with its outside predecessors.
2375 if (!getRegion().contains(PredBB))
2376 PredBBDom = isl_set_universe(isl_set_get_space(PredDom));
2377
2378 if (!PredBBDom) {
2379 // Determine the loop depth of the predecessor and adjust its domain to
2380 // the domain of the current block. This can mean we have to:
2381 // o) Drop a dimension if this block is the exit of a loop, not the
2382 // header of a new loop and the predecessor was part of the loop.
2383 // o) Add an unconstrainted new dimension if this block is the header
2384 // of a loop and the predecessor is not part of it.
2385 // o) Drop the information about the innermost loop dimension when the
2386 // predecessor and the current block are surrounded by different
2387 // loops in the same depth.
2388 PredBBDom = getDomainForBlock(PredBB, DomainMap, *R->getRegionInfo());
2389 Loop *PredBBLoop = LI.getLoopFor(PredBB);
2390 while (BoxedLoops.count(PredBBLoop))
2391 PredBBLoop = PredBBLoop->getParentLoop();
2392
2393 int PredBBLoopDepth = getRelativeLoopDepth(PredBBLoop);
Johannes Doerfertf4fa9872015-09-10 15:53:59 +00002394 unsigned LoopDepthDiff = std::abs(BBLoopDepth - PredBBLoopDepth);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002395 if (BBLoopDepth < PredBBLoopDepth)
Johannes Doerfertf4fa9872015-09-10 15:53:59 +00002396 PredBBDom = isl_set_project_out(
2397 PredBBDom, isl_dim_set, isl_set_n_dim(PredBBDom) - LoopDepthDiff,
2398 LoopDepthDiff);
2399 else if (PredBBLoopDepth < BBLoopDepth) {
2400 assert(LoopDepthDiff == 1);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002401 PredBBDom = isl_set_add_dims(PredBBDom, isl_dim_set, 1);
Johannes Doerfertf4fa9872015-09-10 15:53:59 +00002402 } else if (BBLoop != PredBBLoop && BBLoopDepth >= 0) {
2403 assert(LoopDepthDiff <= 1);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002404 PredBBDom = isl_set_drop_constraints_involving_dims(
2405 PredBBDom, isl_dim_set, BBLoopDepth, 1);
Johannes Doerfertf4fa9872015-09-10 15:53:59 +00002406 }
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002407 }
2408
2409 PredDom = isl_set_union(PredDom, PredBBDom);
2410 }
2411
2412 // Under the union of all predecessor conditions we can reach this block.
Johannes Doerfertb20f1512015-09-15 22:11:49 +00002413 Domain = isl_set_coalesce(isl_set_intersect(Domain, PredDom));
Johannes Doerfert90db75e2015-09-10 17:51:27 +00002414
Johannes Doerfertf32f5f22015-09-28 01:30:37 +00002415 if (BBLoop && BBLoop->getHeader() == BB && getRegion().contains(BBLoop))
Hongbin Zheng192f69a2016-02-13 15:12:54 +00002416 addLoopBoundsToHeaderDomain(BBLoop, LI);
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002417
Johannes Doerfert90db75e2015-09-10 17:51:27 +00002418 // Add assumptions for error blocks.
Johannes Doerfert08d90a32015-10-07 20:32:43 +00002419 if (containsErrorBlock(RN, getRegion(), LI, DT)) {
Johannes Doerfert90db75e2015-09-10 17:51:27 +00002420 IsOptimized = true;
2421 isl_set *DomPar = isl_set_params(isl_set_copy(Domain));
Johannes Doerfert066dbf32016-03-01 13:06:28 +00002422 addAssumption(ERRORBLOCK, DomPar, BB->getTerminator()->getDebugLoc(),
2423 AS_RESTRICTION);
Johannes Doerfert90db75e2015-09-10 17:51:27 +00002424 }
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002425 }
2426}
2427
2428/// @brief Create a map from SetSpace -> SetSpace where the dimensions @p Dim
2429/// is incremented by one and all other dimensions are equal, e.g.,
2430/// [i0, i1, i2, i3] -> [i0, i1, i2 + 1, i3]
2431/// if @p Dim is 2 and @p SetSpace has 4 dimensions.
2432static __isl_give isl_map *
2433createNextIterationMap(__isl_take isl_space *SetSpace, unsigned Dim) {
2434 auto *MapSpace = isl_space_map_from_set(SetSpace);
2435 auto *NextIterationMap = isl_map_universe(isl_space_copy(MapSpace));
2436 for (unsigned u = 0; u < isl_map_n_in(NextIterationMap); u++)
2437 if (u != Dim)
2438 NextIterationMap =
2439 isl_map_equate(NextIterationMap, isl_dim_in, u, isl_dim_out, u);
2440 auto *C = isl_constraint_alloc_equality(isl_local_space_from_space(MapSpace));
2441 C = isl_constraint_set_constant_si(C, 1);
2442 C = isl_constraint_set_coefficient_si(C, isl_dim_in, Dim, 1);
2443 C = isl_constraint_set_coefficient_si(C, isl_dim_out, Dim, -1);
2444 NextIterationMap = isl_map_add_constraint(NextIterationMap, C);
2445 return NextIterationMap;
2446}
2447
Hongbin Zheng192f69a2016-02-13 15:12:54 +00002448void Scop::addLoopBoundsToHeaderDomain(Loop *L, LoopInfo &LI) {
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002449 int LoopDepth = getRelativeLoopDepth(L);
2450 assert(LoopDepth >= 0 && "Loop in region should have at least depth one");
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002451
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002452 BasicBlock *HeaderBB = L->getHeader();
2453 assert(DomainMap.count(HeaderBB));
2454 isl_set *&HeaderBBDom = DomainMap[HeaderBB];
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002455
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002456 isl_map *NextIterationMap =
2457 createNextIterationMap(isl_set_get_space(HeaderBBDom), LoopDepth);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002458
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002459 isl_set *UnionBackedgeCondition =
2460 isl_set_empty(isl_set_get_space(HeaderBBDom));
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002461
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002462 SmallVector<llvm::BasicBlock *, 4> LatchBlocks;
2463 L->getLoopLatches(LatchBlocks);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002464
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002465 for (BasicBlock *LatchBB : LatchBlocks) {
Johannes Doerfertf5673802015-10-01 23:48:18 +00002466
2467 // If the latch is only reachable via error statements we skip it.
2468 isl_set *LatchBBDom = DomainMap.lookup(LatchBB);
2469 if (!LatchBBDom)
2470 continue;
2471
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002472 isl_set *BackedgeCondition = nullptr;
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002473
Johannes Doerfert9a132f32015-09-28 09:33:22 +00002474 TerminatorInst *TI = LatchBB->getTerminator();
2475 BranchInst *BI = dyn_cast<BranchInst>(TI);
2476 if (BI && BI->isUnconditional())
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002477 BackedgeCondition = isl_set_copy(LatchBBDom);
2478 else {
Johannes Doerfert9a132f32015-09-28 09:33:22 +00002479 SmallVector<isl_set *, 8> ConditionSets;
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002480 int idx = BI->getSuccessor(0) != HeaderBB;
Johannes Doerfert9a132f32015-09-28 09:33:22 +00002481 buildConditionSets(*this, TI, L, LatchBBDom, ConditionSets);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002482
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002483 // Free the non back edge condition set as we do not need it.
2484 isl_set_free(ConditionSets[1 - idx]);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002485
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002486 BackedgeCondition = ConditionSets[idx];
Johannes Doerfert06c57b52015-09-20 15:00:20 +00002487 }
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002488
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002489 int LatchLoopDepth = getRelativeLoopDepth(LI.getLoopFor(LatchBB));
2490 assert(LatchLoopDepth >= LoopDepth);
2491 BackedgeCondition =
2492 isl_set_project_out(BackedgeCondition, isl_dim_set, LoopDepth + 1,
2493 LatchLoopDepth - LoopDepth);
2494 UnionBackedgeCondition =
2495 isl_set_union(UnionBackedgeCondition, BackedgeCondition);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002496 }
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002497
2498 isl_map *ForwardMap = isl_map_lex_le(isl_set_get_space(HeaderBBDom));
2499 for (int i = 0; i < LoopDepth; i++)
2500 ForwardMap = isl_map_equate(ForwardMap, isl_dim_in, i, isl_dim_out, i);
2501
2502 isl_set *UnionBackedgeConditionComplement =
2503 isl_set_complement(UnionBackedgeCondition);
2504 UnionBackedgeConditionComplement = isl_set_lower_bound_si(
2505 UnionBackedgeConditionComplement, isl_dim_set, LoopDepth, 0);
2506 UnionBackedgeConditionComplement =
2507 isl_set_apply(UnionBackedgeConditionComplement, ForwardMap);
2508 HeaderBBDom = isl_set_subtract(HeaderBBDom, UnionBackedgeConditionComplement);
2509 HeaderBBDom = isl_set_apply(HeaderBBDom, NextIterationMap);
2510
2511 auto Parts = partitionSetParts(HeaderBBDom, LoopDepth);
2512 HeaderBBDom = Parts.second;
2513
Johannes Doerfert6a72a2a2015-09-20 16:59:23 +00002514 // Check if there is a <nsw> tagged AddRec for this loop and if so do not add
2515 // the bounded assumptions to the context as they are already implied by the
2516 // <nsw> tag.
2517 if (Affinator.hasNSWAddRecForLoop(L)) {
2518 isl_set_free(Parts.first);
2519 return;
2520 }
2521
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002522 isl_set *UnboundedCtx = isl_set_params(Parts.first);
Johannes Doerfert066dbf32016-03-01 13:06:28 +00002523 addAssumption(INFINITELOOP, UnboundedCtx,
2524 HeaderBB->getTerminator()->getDebugLoc(), AS_RESTRICTION);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002525}
2526
Johannes Doerfert120de4b2015-08-20 18:30:08 +00002527void Scop::buildAliasChecks(AliasAnalysis &AA) {
2528 if (!PollyUseRuntimeAliasChecks)
2529 return;
2530
2531 if (buildAliasGroups(AA))
2532 return;
2533
2534 // If a problem occurs while building the alias groups we need to delete
2535 // this SCoP and pretend it wasn't valid in the first place. To this end
2536 // we make the assumed context infeasible.
Tobias Grosser8d4f6262015-12-12 09:52:26 +00002537 invalidate(ALIASING, DebugLoc());
Johannes Doerfert120de4b2015-08-20 18:30:08 +00002538
2539 DEBUG(dbgs() << "\n\nNOTE: Run time checks for " << getNameStr()
2540 << " could not be created as the number of parameters involved "
2541 "is too high. The SCoP will be "
2542 "dismissed.\nUse:\n\t--polly-rtc-max-parameters=X\nto adjust "
2543 "the maximal number of parameters but be advised that the "
2544 "compile time might increase exponentially.\n\n");
2545}
2546
Johannes Doerfert9143d672014-09-27 11:02:39 +00002547bool Scop::buildAliasGroups(AliasAnalysis &AA) {
Johannes Doerfertb164c792014-09-18 11:17:17 +00002548 // To create sound alias checks we perform the following steps:
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00002549 // o) Use the alias analysis and an alias set tracker to build alias sets
Johannes Doerfertb164c792014-09-18 11:17:17 +00002550 // for all memory accesses inside the SCoP.
2551 // o) For each alias set we then map the aliasing pointers back to the
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00002552 // memory accesses we know, thus obtain groups of memory accesses which
Johannes Doerfertb164c792014-09-18 11:17:17 +00002553 // might alias.
Johannes Doerferteeab05a2014-10-01 12:42:37 +00002554 // o) We divide each group based on the domains of the minimal/maximal
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00002555 // accesses. That means two minimal/maximal accesses are only in a group
Johannes Doerferteeab05a2014-10-01 12:42:37 +00002556 // if their access domains intersect, otherwise they are in different
2557 // ones.
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002558 // o) We partition each group into read only and non read only accesses.
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00002559 // o) For each group with more than one base pointer we then compute minimal
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002560 // and maximal accesses to each array of a group in read only and non
2561 // read only partitions separately.
Johannes Doerfertb164c792014-09-18 11:17:17 +00002562 using AliasGroupTy = SmallVector<MemoryAccess *, 4>;
2563
2564 AliasSetTracker AST(AA);
2565
2566 DenseMap<Value *, MemoryAccess *> PtrToAcc;
Johannes Doerfert13771732014-10-01 12:40:46 +00002567 DenseSet<Value *> HasWriteAccess;
Tobias Grosser7c3bad52015-05-27 05:16:57 +00002568 for (ScopStmt &Stmt : *this) {
Johannes Doerfertf1ee2622014-10-06 17:43:00 +00002569
2570 // Skip statements with an empty domain as they will never be executed.
Tobias Grosser7c3bad52015-05-27 05:16:57 +00002571 isl_set *StmtDomain = Stmt.getDomain();
Johannes Doerfertf1ee2622014-10-06 17:43:00 +00002572 bool StmtDomainEmpty = isl_set_is_empty(StmtDomain);
2573 isl_set_free(StmtDomain);
2574 if (StmtDomainEmpty)
2575 continue;
2576
Tobias Grosser7c3bad52015-05-27 05:16:57 +00002577 for (MemoryAccess *MA : Stmt) {
Tobias Grossera535dff2015-12-13 19:59:01 +00002578 if (MA->isScalarKind())
Johannes Doerfertb164c792014-09-18 11:17:17 +00002579 continue;
Johannes Doerfert13771732014-10-01 12:40:46 +00002580 if (!MA->isRead())
2581 HasWriteAccess.insert(MA->getBaseAddr());
Michael Kruse70131d32016-01-27 17:09:17 +00002582 MemAccInst Acc(MA->getAccessInstruction());
Hongbin Zheng8efb22e2016-02-27 01:49:58 +00002583 if (MA->isRead() && isa<MemTransferInst>(Acc))
2584 PtrToAcc[cast<MemTransferInst>(Acc)->getSource()] = MA;
Johannes Doerfertcea61932016-02-21 19:13:19 +00002585 else
2586 PtrToAcc[Acc.getPointerOperand()] = MA;
Johannes Doerfertb164c792014-09-18 11:17:17 +00002587 AST.add(Acc);
2588 }
2589 }
2590
2591 SmallVector<AliasGroupTy, 4> AliasGroups;
2592 for (AliasSet &AS : AST) {
Johannes Doerfert74f68692014-10-08 02:23:48 +00002593 if (AS.isMustAlias() || AS.isForwardingAliasSet())
Johannes Doerfertb164c792014-09-18 11:17:17 +00002594 continue;
2595 AliasGroupTy AG;
Johannes Doerferta90943d2016-02-21 16:37:25 +00002596 for (auto &PR : AS)
Johannes Doerfertb164c792014-09-18 11:17:17 +00002597 AG.push_back(PtrToAcc[PR.getValue()]);
Johannes Doerfertcea61932016-02-21 19:13:19 +00002598 if (AG.size() < 2)
2599 continue;
Johannes Doerfertb164c792014-09-18 11:17:17 +00002600 AliasGroups.push_back(std::move(AG));
2601 }
2602
Johannes Doerferteeab05a2014-10-01 12:42:37 +00002603 // Split the alias groups based on their domain.
2604 for (unsigned u = 0; u < AliasGroups.size(); u++) {
2605 AliasGroupTy NewAG;
2606 AliasGroupTy &AG = AliasGroups[u];
2607 AliasGroupTy::iterator AGI = AG.begin();
2608 isl_set *AGDomain = getAccessDomain(*AGI);
2609 while (AGI != AG.end()) {
2610 MemoryAccess *MA = *AGI;
2611 isl_set *MADomain = getAccessDomain(MA);
2612 if (isl_set_is_disjoint(AGDomain, MADomain)) {
2613 NewAG.push_back(MA);
2614 AGI = AG.erase(AGI);
2615 isl_set_free(MADomain);
2616 } else {
2617 AGDomain = isl_set_union(AGDomain, MADomain);
2618 AGI++;
2619 }
2620 }
2621 if (NewAG.size() > 1)
2622 AliasGroups.push_back(std::move(NewAG));
2623 isl_set_free(AGDomain);
2624 }
2625
Johannes Doerfert0cf4e0a2015-11-12 02:32:51 +00002626 auto &F = *getRegion().getEntry()->getParent();
Tobias Grosserf4c24b22015-04-05 13:11:54 +00002627 MapVector<const Value *, SmallPtrSet<MemoryAccess *, 8>> ReadOnlyPairs;
Johannes Doerfert13771732014-10-01 12:40:46 +00002628 SmallPtrSet<const Value *, 4> NonReadOnlyBaseValues;
2629 for (AliasGroupTy &AG : AliasGroups) {
2630 NonReadOnlyBaseValues.clear();
2631 ReadOnlyPairs.clear();
2632
Johannes Doerferteeab05a2014-10-01 12:42:37 +00002633 if (AG.size() < 2) {
2634 AG.clear();
2635 continue;
2636 }
2637
Johannes Doerfert13771732014-10-01 12:40:46 +00002638 for (auto II = AG.begin(); II != AG.end();) {
Johannes Doerfert0cf4e0a2015-11-12 02:32:51 +00002639 emitOptimizationRemarkAnalysis(
2640 F.getContext(), DEBUG_TYPE, F,
2641 (*II)->getAccessInstruction()->getDebugLoc(),
2642 "Possibly aliasing pointer, use restrict keyword.");
2643
Johannes Doerfert13771732014-10-01 12:40:46 +00002644 Value *BaseAddr = (*II)->getBaseAddr();
2645 if (HasWriteAccess.count(BaseAddr)) {
2646 NonReadOnlyBaseValues.insert(BaseAddr);
2647 II++;
2648 } else {
2649 ReadOnlyPairs[BaseAddr].insert(*II);
2650 II = AG.erase(II);
2651 }
2652 }
2653
2654 // If we don't have read only pointers check if there are at least two
2655 // non read only pointers, otherwise clear the alias group.
Tobias Grosserbb853c22015-07-25 12:31:03 +00002656 if (ReadOnlyPairs.empty() && NonReadOnlyBaseValues.size() <= 1) {
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002657 AG.clear();
Johannes Doerfert13771732014-10-01 12:40:46 +00002658 continue;
2659 }
2660
2661 // If we don't have non read only pointers clear the alias group.
2662 if (NonReadOnlyBaseValues.empty()) {
2663 AG.clear();
2664 continue;
2665 }
2666
Johannes Doerfert9dd42ee2016-02-25 14:06:11 +00002667 // Check if we have non-affine accesses left, if so bail out as we cannot
2668 // generate a good access range yet.
2669 for (auto *MA : AG)
2670 if (!MA->isAffine()) {
2671 invalidate(ALIASING, MA->getAccessInstruction()->getDebugLoc());
2672 return false;
2673 }
2674 for (auto &ReadOnlyPair : ReadOnlyPairs)
2675 for (auto *MA : ReadOnlyPair.second)
2676 if (!MA->isAffine()) {
2677 invalidate(ALIASING, MA->getAccessInstruction()->getDebugLoc());
2678 return false;
2679 }
2680
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002681 // Calculate minimal and maximal accesses for non read only accesses.
Johannes Doerfert210b09a2015-07-26 13:14:38 +00002682 MinMaxAliasGroups.emplace_back();
2683 MinMaxVectorPairTy &pair = MinMaxAliasGroups.back();
2684 MinMaxVectorTy &MinMaxAccessesNonReadOnly = pair.first;
2685 MinMaxVectorTy &MinMaxAccessesReadOnly = pair.second;
2686 MinMaxAccessesNonReadOnly.reserve(AG.size());
Johannes Doerfertb164c792014-09-18 11:17:17 +00002687
2688 isl_union_map *Accesses = isl_union_map_empty(getParamSpace());
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002689
2690 // AG contains only non read only accesses.
Johannes Doerfertb164c792014-09-18 11:17:17 +00002691 for (MemoryAccess *MA : AG)
2692 Accesses = isl_union_map_add_map(Accesses, MA->getAccessRelation());
Johannes Doerfertb164c792014-09-18 11:17:17 +00002693
Tobias Grosserdaaed0e2015-08-20 21:29:26 +00002694 bool Valid = calculateMinMaxAccess(Accesses, getDomains(),
2695 MinMaxAccessesNonReadOnly);
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002696
2697 // Bail out if the number of values we need to compare is too large.
2698 // This is important as the number of comparisions grows quadratically with
2699 // the number of values we need to compare.
Johannes Doerfert210b09a2015-07-26 13:14:38 +00002700 if (!Valid || (MinMaxAccessesNonReadOnly.size() + !ReadOnlyPairs.empty() >
2701 RunTimeChecksMaxArraysPerGroup))
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002702 return false;
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002703
2704 // Calculate minimal and maximal accesses for read only accesses.
Johannes Doerfert210b09a2015-07-26 13:14:38 +00002705 MinMaxAccessesReadOnly.reserve(ReadOnlyPairs.size());
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002706 Accesses = isl_union_map_empty(getParamSpace());
2707
2708 for (const auto &ReadOnlyPair : ReadOnlyPairs)
2709 for (MemoryAccess *MA : ReadOnlyPair.second)
2710 Accesses = isl_union_map_add_map(Accesses, MA->getAccessRelation());
2711
Tobias Grosserdaaed0e2015-08-20 21:29:26 +00002712 Valid =
2713 calculateMinMaxAccess(Accesses, getDomains(), MinMaxAccessesReadOnly);
Johannes Doerfert9143d672014-09-27 11:02:39 +00002714
2715 if (!Valid)
Tobias Grosser50d4e2e2015-03-28 14:50:32 +00002716 return false;
Johannes Doerfertb164c792014-09-18 11:17:17 +00002717 }
Johannes Doerfert9143d672014-09-27 11:02:39 +00002718
Tobias Grosser50d4e2e2015-03-28 14:50:32 +00002719 return true;
Johannes Doerfertb164c792014-09-18 11:17:17 +00002720}
2721
Johannes Doerfertdec27df2015-11-21 16:56:13 +00002722/// @brief Get the smallest loop that contains @p R but is not in @p R.
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002723static Loop *getLoopSurroundingRegion(Region &R, LoopInfo &LI) {
Johannes Doerfertdec27df2015-11-21 16:56:13 +00002724 // Start with the smallest loop containing the entry and expand that
2725 // loop until it contains all blocks in the region. If there is a loop
2726 // containing all blocks in the region check if it is itself contained
2727 // and if so take the parent loop as it will be the smallest containing
2728 // the region but not contained by it.
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002729 Loop *L = LI.getLoopFor(R.getEntry());
Johannes Doerfertdec27df2015-11-21 16:56:13 +00002730 while (L) {
2731 bool AllContained = true;
2732 for (auto *BB : R.blocks())
2733 AllContained &= L->contains(BB);
2734 if (AllContained)
2735 break;
2736 L = L->getParentLoop();
2737 }
2738
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002739 return L ? (R.contains(L) ? L->getParentLoop() : L) : nullptr;
2740}
2741
Johannes Doerfertf8206cf2015-04-12 22:58:40 +00002742static unsigned getMaxLoopDepthInRegion(const Region &R, LoopInfo &LI,
2743 ScopDetection &SD) {
2744
2745 const ScopDetection::BoxedLoopsSetTy *BoxedLoops = SD.getBoxedLoops(&R);
2746
Johannes Doerferte3da05a2014-11-01 00:12:13 +00002747 unsigned MinLD = INT_MAX, MaxLD = 0;
2748 for (BasicBlock *BB : R.blocks()) {
2749 if (Loop *L = LI.getLoopFor(BB)) {
David Peixottodc0a11c2015-01-13 18:31:55 +00002750 if (!R.contains(L))
2751 continue;
Johannes Doerfertf8206cf2015-04-12 22:58:40 +00002752 if (BoxedLoops && BoxedLoops->count(L))
2753 continue;
Johannes Doerferte3da05a2014-11-01 00:12:13 +00002754 unsigned LD = L->getLoopDepth();
2755 MinLD = std::min(MinLD, LD);
2756 MaxLD = std::max(MaxLD, LD);
2757 }
2758 }
2759
2760 // Handle the case that there is no loop in the SCoP first.
2761 if (MaxLD == 0)
2762 return 1;
2763
2764 assert(MinLD >= 1 && "Minimal loop depth should be at least one");
2765 assert(MaxLD >= MinLD &&
2766 "Maximal loop depth was smaller than mininaml loop depth?");
2767 return MaxLD - MinLD + 1;
2768}
2769
Michael Kruse09eb4452016-03-03 22:10:47 +00002770Scop::Scop(Region &R, ScalarEvolution &ScalarEvolution, LoopInfo &LI,
2771 unsigned MaxLoopDepth)
Hongbin Zheng660f3cc2016-02-13 15:12:58 +00002772 : SE(&ScalarEvolution), R(R), IsOptimized(false),
Hongbin Zheng192f69a2016-02-13 15:12:54 +00002773 HasSingleExitEdge(R.getExitingBlock()), HasErrorBlock(false),
Hongbin Zheng8831eb72016-02-17 15:49:21 +00002774 MaxLoopDepth(MaxLoopDepth), IslCtx(isl_ctx_alloc(), isl_ctx_free),
Michael Kruse09eb4452016-03-03 22:10:47 +00002775 Context(nullptr), Affinator(this, LI), AssumedContext(nullptr),
Johannes Doerfert066dbf32016-03-01 13:06:28 +00002776 InvalidContext(nullptr), Schedule(nullptr) {
Hongbin Zheng8831eb72016-02-17 15:49:21 +00002777 isl_options_set_on_error(getIslCtx(), ISL_ON_ERROR_ABORT);
Tobias Grosserd840fc72016-02-04 13:18:42 +00002778 buildContext();
2779}
Johannes Doerfertff9d1982015-02-24 12:00:50 +00002780
Hongbin Zhengf53ffa62016-02-13 15:12:51 +00002781void Scop::init(AliasAnalysis &AA, AssumptionCache &AC, ScopDetection &SD,
Hongbin Zheng192f69a2016-02-13 15:12:54 +00002782 DominatorTree &DT, LoopInfo &LI) {
2783 addUserAssumptions(AC, DT, LI);
Hongbin Zheng7dddfba2016-02-13 15:12:47 +00002784 buildInvariantEquivalenceClasses(SD);
Johannes Doerfert697fdf82015-10-09 17:12:26 +00002785
Hongbin Zheng192f69a2016-02-13 15:12:54 +00002786 buildDomains(&R, SD, DT, LI);
Johannes Doerfert96425c22015-08-30 21:13:53 +00002787
Michael Krusecac948e2015-10-02 13:53:07 +00002788 // Remove empty and ignored statements.
Michael Kruseafe06702015-10-02 16:33:27 +00002789 // Exit early in case there are no executable statements left in this scop.
Hongbin Zheng192f69a2016-02-13 15:12:54 +00002790 simplifySCoP(true, DT, LI);
Michael Kruseafe06702015-10-02 16:33:27 +00002791 if (Stmts.empty())
2792 return;
Tobias Grosser75805372011-04-29 06:27:02 +00002793
Michael Krusecac948e2015-10-02 13:53:07 +00002794 // The ScopStmts now have enough information to initialize themselves.
2795 for (ScopStmt &Stmt : Stmts)
Hongbin Zheng7dddfba2016-02-13 15:12:47 +00002796 Stmt.init(SD);
Michael Krusecac948e2015-10-02 13:53:07 +00002797
Hongbin Zheng192f69a2016-02-13 15:12:54 +00002798 buildSchedule(SD, LI);
Tobias Grosser75805372011-04-29 06:27:02 +00002799
Johannes Doerfert066dbf32016-03-01 13:06:28 +00002800 if (!hasFeasibleRuntimeContext())
Tobias Grosser8286b832015-11-02 11:29:32 +00002801 return;
2802
2803 updateAccessDimensionality();
Tobias Grosser8cae72f2011-11-08 15:41:08 +00002804 realignParams();
Tobias Grosser18daaca2012-05-22 10:47:27 +00002805 addParameterBounds();
Tobias Grosser8a9c2352015-08-16 10:19:29 +00002806 addUserContext();
Johannes Doerfert066dbf32016-03-01 13:06:28 +00002807 addWrappingContext();
Johannes Doerfert883f8c12015-09-15 22:52:53 +00002808 simplifyContexts();
Johannes Doerfert120de4b2015-08-20 18:30:08 +00002809 buildAliasChecks(AA);
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00002810
Hongbin Zheng7dddfba2016-02-13 15:12:47 +00002811 hoistInvariantLoads(SD);
Tobias Grosser0865e7752016-02-29 07:29:42 +00002812 verifyInvariantLoads(SD);
Hongbin Zheng192f69a2016-02-13 15:12:54 +00002813 simplifySCoP(false, DT, LI);
Tobias Grosser75805372011-04-29 06:27:02 +00002814}
2815
2816Scop::~Scop() {
2817 isl_set_free(Context);
Tobias Grossere86109f2013-10-29 21:05:49 +00002818 isl_set_free(AssumedContext);
Johannes Doerfert066dbf32016-03-01 13:06:28 +00002819 isl_set_free(InvalidContext);
Tobias Grosser808cd692015-07-14 09:33:13 +00002820 isl_schedule_free(Schedule);
Tobias Grosser75805372011-04-29 06:27:02 +00002821
Johannes Doerfert96425c22015-08-30 21:13:53 +00002822 for (auto It : DomainMap)
2823 isl_set_free(It.second);
2824
Johannes Doerfertb164c792014-09-18 11:17:17 +00002825 // Free the alias groups
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002826 for (MinMaxVectorPairTy &MinMaxAccessPair : MinMaxAliasGroups) {
Johannes Doerfert210b09a2015-07-26 13:14:38 +00002827 for (MinMaxAccessTy &MMA : MinMaxAccessPair.first) {
Johannes Doerfertb164c792014-09-18 11:17:17 +00002828 isl_pw_multi_aff_free(MMA.first);
2829 isl_pw_multi_aff_free(MMA.second);
2830 }
Johannes Doerfert210b09a2015-07-26 13:14:38 +00002831 for (MinMaxAccessTy &MMA : MinMaxAccessPair.second) {
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002832 isl_pw_multi_aff_free(MMA.first);
2833 isl_pw_multi_aff_free(MMA.second);
2834 }
Johannes Doerfertb164c792014-09-18 11:17:17 +00002835 }
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00002836
Johannes Doerfert697fdf82015-10-09 17:12:26 +00002837 for (const auto &IAClass : InvariantEquivClasses)
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00002838 isl_set_free(std::get<2>(IAClass));
Hongbin Zheng8831eb72016-02-17 15:49:21 +00002839
2840 // Explicitly release all Scop objects and the underlying isl objects before
2841 // we relase the isl context.
2842 Stmts.clear();
2843 ScopArrayInfoMap.clear();
2844 AccFuncMap.clear();
Tobias Grosser75805372011-04-29 06:27:02 +00002845}
2846
Tobias Grosser99c70dd2015-09-26 08:55:54 +00002847void Scop::updateAccessDimensionality() {
Johannes Doerfert4d9bb8d2016-02-18 16:50:12 +00002848 // Check all array accesses for each base pointer and find a (virtual) element
2849 // size for the base pointer that divides all access functions.
2850 for (auto &Stmt : *this)
2851 for (auto *Access : Stmt) {
2852 if (!Access->isArrayKind())
2853 continue;
2854 auto &SAI = ScopArrayInfoMap[std::make_pair(Access->getBaseAddr(),
2855 ScopArrayInfo::MK_Array)];
2856 if (SAI->getNumberOfDimensions() != 1)
2857 continue;
2858 unsigned DivisibleSize = SAI->getElemSizeInBytes();
2859 auto *Subscript = Access->getSubscript(0);
2860 while (!isDivisible(Subscript, DivisibleSize, *SE))
2861 DivisibleSize /= 2;
2862 auto *Ty = IntegerType::get(SE->getContext(), DivisibleSize * 8);
2863 SAI->updateElementType(Ty);
2864 }
2865
Tobias Grosser99c70dd2015-09-26 08:55:54 +00002866 for (auto &Stmt : *this)
2867 for (auto &Access : Stmt)
2868 Access->updateDimensionality();
2869}
2870
Hongbin Zheng192f69a2016-02-13 15:12:54 +00002871void Scop::simplifySCoP(bool RemoveIgnoredStmts, DominatorTree &DT,
2872 LoopInfo &LI) {
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00002873 for (auto StmtIt = Stmts.begin(), StmtEnd = Stmts.end(); StmtIt != StmtEnd;) {
2874 ScopStmt &Stmt = *StmtIt;
Michael Kruse7b5caa42016-02-24 22:08:28 +00002875 RegionNode *RN = Stmt.getRegionNode();
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00002876
Johannes Doerferteca9e892015-11-03 16:54:49 +00002877 bool RemoveStmt = StmtIt->isEmpty();
2878 if (!RemoveStmt)
Michael Kruse375cb5f2016-02-24 22:08:24 +00002879 RemoveStmt = isl_set_is_empty(DomainMap[Stmt.getEntryBlock()]);
Johannes Doerferteca9e892015-11-03 16:54:49 +00002880 if (!RemoveStmt)
Hongbin Zheng192f69a2016-02-13 15:12:54 +00002881 RemoveStmt = (RemoveIgnoredStmts && isIgnored(RN, DT, LI));
Johannes Doerfertf17a78e2015-10-04 15:00:05 +00002882
Johannes Doerferteca9e892015-11-03 16:54:49 +00002883 // Remove read only statements only after invariant loop hoisting.
2884 if (!RemoveStmt && !RemoveIgnoredStmts) {
2885 bool OnlyRead = true;
2886 for (MemoryAccess *MA : Stmt) {
2887 if (MA->isRead())
2888 continue;
2889
2890 OnlyRead = false;
2891 break;
2892 }
2893
2894 RemoveStmt = OnlyRead;
2895 }
2896
2897 if (RemoveStmt) {
Michael Krusecac948e2015-10-02 13:53:07 +00002898 // Remove the statement because it is unnecessary.
2899 if (Stmt.isRegionStmt())
2900 for (BasicBlock *BB : Stmt.getRegion()->blocks())
2901 StmtMap.erase(BB);
2902 else
2903 StmtMap.erase(Stmt.getBasicBlock());
2904
2905 StmtIt = Stmts.erase(StmtIt);
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00002906 continue;
2907 }
2908
Michael Krusecac948e2015-10-02 13:53:07 +00002909 StmtIt++;
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00002910 }
2911}
2912
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00002913const InvariantEquivClassTy *Scop::lookupInvariantEquivClass(Value *Val) const {
2914 LoadInst *LInst = dyn_cast<LoadInst>(Val);
2915 if (!LInst)
2916 return nullptr;
2917
2918 if (Value *Rep = InvEquivClassVMap.lookup(LInst))
2919 LInst = cast<LoadInst>(Rep);
2920
Johannes Doerfert96e54712016-02-07 17:30:13 +00002921 Type *Ty = LInst->getType();
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00002922 const SCEV *PointerSCEV = SE->getSCEV(LInst->getPointerOperand());
2923 for (auto &IAClass : InvariantEquivClasses)
Johannes Doerfert96e54712016-02-07 17:30:13 +00002924 if (PointerSCEV == std::get<0>(IAClass) && Ty == std::get<3>(IAClass))
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00002925 return &IAClass;
2926
2927 return nullptr;
2928}
2929
2930void Scop::addInvariantLoads(ScopStmt &Stmt, MemoryAccessList &InvMAs) {
2931
2932 // Get the context under which the statement is executed.
2933 isl_set *DomainCtx = isl_set_params(Stmt.getDomain());
2934 DomainCtx = isl_set_remove_redundancies(DomainCtx);
2935 DomainCtx = isl_set_detect_equalities(DomainCtx);
2936 DomainCtx = isl_set_coalesce(DomainCtx);
2937
2938 // Project out all parameters that relate to loads in the statement. Otherwise
2939 // we could have cyclic dependences on the constraints under which the
2940 // hoisted loads are executed and we could not determine an order in which to
2941 // pre-load them. This happens because not only lower bounds are part of the
2942 // domain but also upper bounds.
2943 for (MemoryAccess *MA : InvMAs) {
2944 Instruction *AccInst = MA->getAccessInstruction();
2945 if (SE->isSCEVable(AccInst->getType())) {
Johannes Doerfert44483c52015-11-07 19:45:27 +00002946 SetVector<Value *> Values;
2947 for (const SCEV *Parameter : Parameters) {
2948 Values.clear();
2949 findValues(Parameter, Values);
2950 if (!Values.count(AccInst))
2951 continue;
2952
2953 if (isl_id *ParamId = getIdForParam(Parameter)) {
2954 int Dim = isl_set_find_dim_by_id(DomainCtx, isl_dim_param, ParamId);
2955 DomainCtx = isl_set_eliminate(DomainCtx, isl_dim_param, Dim, 1);
2956 isl_id_free(ParamId);
2957 }
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00002958 }
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00002959 }
2960 }
2961
2962 for (MemoryAccess *MA : InvMAs) {
2963 // Check for another invariant access that accesses the same location as
2964 // MA and if found consolidate them. Otherwise create a new equivalence
2965 // class at the end of InvariantEquivClasses.
2966 LoadInst *LInst = cast<LoadInst>(MA->getAccessInstruction());
Johannes Doerfert96e54712016-02-07 17:30:13 +00002967 Type *Ty = LInst->getType();
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00002968 const SCEV *PointerSCEV = SE->getSCEV(LInst->getPointerOperand());
2969
2970 bool Consolidated = false;
2971 for (auto &IAClass : InvariantEquivClasses) {
Johannes Doerfert96e54712016-02-07 17:30:13 +00002972 if (PointerSCEV != std::get<0>(IAClass) || Ty != std::get<3>(IAClass))
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00002973 continue;
2974
Johannes Doerfertdf880232016-03-03 12:26:58 +00002975 // If the pointer and the type is equal check if the access function wrt.
2976 // to the domain is equal too. It can happen that the domain fixes
2977 // parameter values and these can be different for distinct part of the
Johannes Doerfertac37c562016-03-03 12:30:19 +00002978 // SCoP. If this happens we cannot consolidate the loads but need to
Johannes Doerfertdf880232016-03-03 12:26:58 +00002979 // create a new invariant load equivalence class.
2980 auto &MAs = std::get<1>(IAClass);
2981 if (!MAs.empty()) {
2982 auto *LastMA = MAs.front();
2983
2984 auto *AR = isl_map_range(MA->getAccessRelation());
2985 auto *LastAR = isl_map_range(LastMA->getAccessRelation());
2986 bool SameAR = isl_set_is_equal(AR, LastAR);
2987 isl_set_free(AR);
2988 isl_set_free(LastAR);
2989
2990 if (!SameAR)
2991 continue;
2992 }
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00002993
2994 // Add MA to the list of accesses that are in this class.
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00002995 MAs.push_front(MA);
2996
Johannes Doerfertdf880232016-03-03 12:26:58 +00002997 Consolidated = true;
2998
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00002999 // Unify the execution context of the class and this statement.
3000 isl_set *&IAClassDomainCtx = std::get<2>(IAClass);
Johannes Doerfertfc4bfc42015-11-11 04:30:07 +00003001 if (IAClassDomainCtx)
3002 IAClassDomainCtx = isl_set_coalesce(
3003 isl_set_union(IAClassDomainCtx, isl_set_copy(DomainCtx)));
3004 else
3005 IAClassDomainCtx = isl_set_copy(DomainCtx);
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003006 break;
3007 }
3008
3009 if (Consolidated)
3010 continue;
3011
3012 // If we did not consolidate MA, thus did not find an equivalence class
3013 // for it, we create a new one.
3014 InvariantEquivClasses.emplace_back(PointerSCEV, MemoryAccessList{MA},
Johannes Doerfert96e54712016-02-07 17:30:13 +00003015 isl_set_copy(DomainCtx), Ty);
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003016 }
3017
3018 isl_set_free(DomainCtx);
3019}
3020
Tobias Grosser29f38ab2015-12-13 21:00:40 +00003021bool Scop::isHoistableAccess(MemoryAccess *Access,
3022 __isl_keep isl_union_map *Writes) {
3023 // TODO: Loads that are not loop carried, hence are in a statement with
3024 // zero iterators, are by construction invariant, though we
3025 // currently "hoist" them anyway. This is necessary because we allow
3026 // them to be treated as parameters (e.g., in conditions) and our code
3027 // generation would otherwise use the old value.
3028
3029 auto &Stmt = *Access->getStatement();
Michael Kruse375cb5f2016-02-24 22:08:24 +00003030 BasicBlock *BB = Stmt.getEntryBlock();
Tobias Grosser29f38ab2015-12-13 21:00:40 +00003031
3032 if (Access->isScalarKind() || Access->isWrite() || !Access->isAffine())
3033 return false;
3034
3035 // Skip accesses that have an invariant base pointer which is defined but
3036 // not loaded inside the SCoP. This can happened e.g., if a readnone call
3037 // returns a pointer that is used as a base address. However, as we want
3038 // to hoist indirect pointers, we allow the base pointer to be defined in
3039 // the region if it is also a memory access. Each ScopArrayInfo object
3040 // that has a base pointer origin has a base pointer that is loaded and
3041 // that it is invariant, thus it will be hoisted too. However, if there is
3042 // no base pointer origin we check that the base pointer is defined
3043 // outside the region.
3044 const ScopArrayInfo *SAI = Access->getScopArrayInfo();
Johannes Doerfert4cf15802016-02-15 12:42:05 +00003045 auto *BasePtrInst = dyn_cast<Instruction>(SAI->getBasePtr());
3046 if (SAI->getBasePtrOriginSAI()) {
3047 assert(BasePtrInst && R.contains(BasePtrInst));
3048 if (!isa<LoadInst>(BasePtrInst))
Tobias Grosser29f38ab2015-12-13 21:00:40 +00003049 return false;
Michael Kruse6f7721f2016-02-24 22:08:19 +00003050 auto *BasePtrStmt = getStmtFor(BasePtrInst);
Johannes Doerfert4cf15802016-02-15 12:42:05 +00003051 assert(BasePtrStmt);
3052 auto *BasePtrMA = BasePtrStmt->getArrayAccessOrNULLFor(BasePtrInst);
3053 if (BasePtrMA && !isHoistableAccess(BasePtrMA, Writes))
3054 return false;
3055 } else if (BasePtrInst && R.contains(BasePtrInst))
3056 return false;
Tobias Grosser29f38ab2015-12-13 21:00:40 +00003057
3058 // Skip accesses in non-affine subregions as they might not be executed
3059 // under the same condition as the entry of the non-affine subregion.
3060 if (BB != Access->getAccessInstruction()->getParent())
3061 return false;
3062
3063 isl_map *AccessRelation = Access->getAccessRelation();
3064
3065 // Skip accesses that have an empty access relation. These can be caused
3066 // by multiple offsets with a type cast in-between that cause the overall
3067 // byte offset to be not divisible by the new types sizes.
3068 if (isl_map_is_empty(AccessRelation)) {
3069 isl_map_free(AccessRelation);
3070 return false;
3071 }
3072
3073 if (isl_map_involves_dims(AccessRelation, isl_dim_in, 0,
3074 Stmt.getNumIterators())) {
3075 isl_map_free(AccessRelation);
3076 return false;
3077 }
3078
3079 AccessRelation = isl_map_intersect_domain(AccessRelation, Stmt.getDomain());
3080 isl_set *AccessRange = isl_map_range(AccessRelation);
3081
3082 isl_union_map *Written = isl_union_map_intersect_range(
3083 isl_union_map_copy(Writes), isl_union_set_from_set(AccessRange));
3084 bool IsWritten = !isl_union_map_is_empty(Written);
3085 isl_union_map_free(Written);
3086
3087 if (IsWritten)
3088 return false;
3089
3090 return true;
3091}
3092
Hongbin Zheng7dddfba2016-02-13 15:12:47 +00003093void Scop::verifyInvariantLoads(ScopDetection &SD) {
Tobias Grosser29f38ab2015-12-13 21:00:40 +00003094 auto &RIL = *SD.getRequiredInvariantLoads(&getRegion());
3095 for (LoadInst *LI : RIL) {
3096 assert(LI && getRegion().contains(LI));
Michael Kruse6f7721f2016-02-24 22:08:19 +00003097 ScopStmt *Stmt = getStmtFor(LI);
Tobias Grosser949e8c62015-12-21 07:10:39 +00003098 if (Stmt && Stmt->getArrayAccessOrNULLFor(LI)) {
Tobias Grosser29f38ab2015-12-13 21:00:40 +00003099 invalidate(INVARIANTLOAD, LI->getDebugLoc());
3100 return;
3101 }
3102 }
3103}
3104
Hongbin Zheng7dddfba2016-02-13 15:12:47 +00003105void Scop::hoistInvariantLoads(ScopDetection &SD) {
Tobias Grosser0865e7752016-02-29 07:29:42 +00003106 if (!PollyInvariantLoadHoisting)
3107 return;
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00003108
Tobias Grosser0865e7752016-02-29 07:29:42 +00003109 isl_union_map *Writes = getWrites();
3110 for (ScopStmt &Stmt : *this) {
3111 MemoryAccessList InvariantAccesses;
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00003112
Tobias Grosser0865e7752016-02-29 07:29:42 +00003113 for (MemoryAccess *Access : Stmt)
3114 if (isHoistableAccess(Access, Writes))
3115 InvariantAccesses.push_front(Access);
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00003116
Tobias Grosser0865e7752016-02-29 07:29:42 +00003117 // We inserted invariant accesses always in the front but need them to be
3118 // sorted in a "natural order". The statements are already sorted in
3119 // reverse post order and that suffices for the accesses too. The reason
3120 // we require an order in the first place is the dependences between
3121 // invariant loads that can be caused by indirect loads.
3122 InvariantAccesses.reverse();
3123
3124 // Transfer the memory access from the statement to the SCoP.
3125 Stmt.removeMemoryAccesses(InvariantAccesses);
3126 addInvariantLoads(Stmt, InvariantAccesses);
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00003127 }
Tobias Grosser0865e7752016-02-29 07:29:42 +00003128 isl_union_map_free(Writes);
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00003129}
3130
Johannes Doerfert80ef1102014-11-07 08:31:31 +00003131const ScopArrayInfo *
Tobias Grossercc779502016-02-02 13:22:54 +00003132Scop::getOrCreateScopArrayInfo(Value *BasePtr, Type *ElementType,
Tobias Grosser6abc75a2015-11-10 17:31:31 +00003133 ArrayRef<const SCEV *> Sizes,
Tobias Grossera535dff2015-12-13 19:59:01 +00003134 ScopArrayInfo::MemoryKind Kind) {
Tobias Grosser6abc75a2015-11-10 17:31:31 +00003135 auto &SAI = ScopArrayInfoMap[std::make_pair(BasePtr, Kind)];
Tobias Grosser99c70dd2015-09-26 08:55:54 +00003136 if (!SAI) {
Johannes Doerfert55b3d8b2015-11-12 20:15:08 +00003137 auto &DL = getRegion().getEntry()->getModule()->getDataLayout();
Tobias Grossercc779502016-02-02 13:22:54 +00003138 SAI.reset(new ScopArrayInfo(BasePtr, ElementType, getIslCtx(), Sizes, Kind,
Johannes Doerfert55b3d8b2015-11-12 20:15:08 +00003139 DL, this));
Tobias Grosser99c70dd2015-09-26 08:55:54 +00003140 } else {
Johannes Doerfert3ff22212016-02-14 22:31:39 +00003141 SAI->updateElementType(ElementType);
Tobias Grosser8286b832015-11-02 11:29:32 +00003142 // In case of mismatching array sizes, we bail out by setting the run-time
3143 // context to false.
Johannes Doerfert3ff22212016-02-14 22:31:39 +00003144 if (!SAI->updateSizes(Sizes))
Tobias Grosser8d4f6262015-12-12 09:52:26 +00003145 invalidate(DELINEARIZATION, DebugLoc());
Tobias Grosser99c70dd2015-09-26 08:55:54 +00003146 }
Tobias Grosserab671442015-05-23 05:58:27 +00003147 return SAI.get();
Johannes Doerfert1a28a892014-10-05 11:32:18 +00003148}
3149
Tobias Grosser6abc75a2015-11-10 17:31:31 +00003150const ScopArrayInfo *Scop::getScopArrayInfo(Value *BasePtr,
Tobias Grossera535dff2015-12-13 19:59:01 +00003151 ScopArrayInfo::MemoryKind Kind) {
Tobias Grosser6abc75a2015-11-10 17:31:31 +00003152 auto *SAI = ScopArrayInfoMap[std::make_pair(BasePtr, Kind)].get();
Johannes Doerfert1a28a892014-10-05 11:32:18 +00003153 assert(SAI && "No ScopArrayInfo available for this base pointer");
3154 return SAI;
3155}
3156
Tobias Grosser74394f02013-01-14 22:40:23 +00003157std::string Scop::getContextStr() const { return stringFromIslObj(Context); }
Johannes Doerfertb92e2182016-02-21 16:37:58 +00003158
Tobias Grosser5e6813d2014-07-02 17:47:48 +00003159std::string Scop::getAssumedContextStr() const {
Johannes Doerfert066dbf32016-03-01 13:06:28 +00003160 assert(AssumedContext && "Assumed context not yet built");
Tobias Grosser5e6813d2014-07-02 17:47:48 +00003161 return stringFromIslObj(AssumedContext);
3162}
Johannes Doerfertb92e2182016-02-21 16:37:58 +00003163
Johannes Doerfert066dbf32016-03-01 13:06:28 +00003164std::string Scop::getInvalidContextStr() const {
3165 return stringFromIslObj(InvalidContext);
Johannes Doerfert883f8c12015-09-15 22:52:53 +00003166}
Tobias Grosser75805372011-04-29 06:27:02 +00003167
3168std::string Scop::getNameStr() const {
3169 std::string ExitName, EntryName;
3170 raw_string_ostream ExitStr(ExitName);
3171 raw_string_ostream EntryStr(EntryName);
3172
Tobias Grosserf240b482014-01-09 10:42:15 +00003173 R.getEntry()->printAsOperand(EntryStr, false);
Tobias Grosser75805372011-04-29 06:27:02 +00003174 EntryStr.str();
3175
3176 if (R.getExit()) {
Tobias Grosserf240b482014-01-09 10:42:15 +00003177 R.getExit()->printAsOperand(ExitStr, false);
Tobias Grosser75805372011-04-29 06:27:02 +00003178 ExitStr.str();
3179 } else
3180 ExitName = "FunctionExit";
3181
3182 return EntryName + "---" + ExitName;
3183}
3184
Tobias Grosser74394f02013-01-14 22:40:23 +00003185__isl_give isl_set *Scop::getContext() const { return isl_set_copy(Context); }
Tobias Grosser37487052011-10-06 00:03:42 +00003186__isl_give isl_space *Scop::getParamSpace() const {
Tobias Grossereeb9f3c2015-05-26 21:37:31 +00003187 return isl_set_get_space(Context);
Tobias Grosser37487052011-10-06 00:03:42 +00003188}
3189
Tobias Grossere86109f2013-10-29 21:05:49 +00003190__isl_give isl_set *Scop::getAssumedContext() const {
Johannes Doerfert066dbf32016-03-01 13:06:28 +00003191 assert(AssumedContext && "Assumed context not yet built");
Tobias Grossere86109f2013-10-29 21:05:49 +00003192 return isl_set_copy(AssumedContext);
3193}
3194
Johannes Doerfert5d5b3062015-08-20 18:06:30 +00003195bool Scop::hasFeasibleRuntimeContext() const {
Johannes Doerfert066dbf32016-03-01 13:06:28 +00003196 auto *PositiveContext = getAssumedContext();
3197 PositiveContext = addNonEmptyDomainConstraints(PositiveContext);
3198 bool IsFeasible = !isl_set_is_empty(PositiveContext);
3199 isl_set_free(PositiveContext);
3200 if (!IsFeasible)
3201 return false;
3202
3203 auto *NegativeContext = getInvalidContext();
3204 auto *DomainContext = isl_union_set_params(getDomains());
3205 IsFeasible = !isl_set_is_subset(DomainContext, NegativeContext);
3206 isl_set_free(NegativeContext);
3207 isl_set_free(DomainContext);
3208
Johannes Doerfert43788c52015-08-20 05:58:56 +00003209 return IsFeasible;
3210}
3211
Johannes Doerfertd84493e2015-11-12 02:33:38 +00003212static std::string toString(AssumptionKind Kind) {
3213 switch (Kind) {
3214 case ALIASING:
3215 return "No-aliasing";
3216 case INBOUNDS:
3217 return "Inbounds";
3218 case WRAPPING:
3219 return "No-overflows";
3220 case ERRORBLOCK:
3221 return "No-error";
3222 case INFINITELOOP:
3223 return "Finite loop";
3224 case INVARIANTLOAD:
3225 return "Invariant load";
3226 case DELINEARIZATION:
3227 return "Delinearization";
Tobias Grosser75dc40c2015-12-20 13:31:48 +00003228 case ERROR_DOMAINCONJUNCTS:
3229 return "Low number of domain conjuncts";
Johannes Doerfertd84493e2015-11-12 02:33:38 +00003230 }
3231 llvm_unreachable("Unknown AssumptionKind!");
3232}
3233
Johannes Doerfert066dbf32016-03-01 13:06:28 +00003234bool Scop::trackAssumption(AssumptionKind Kind, __isl_keep isl_set *Set,
3235 DebugLoc Loc, AssumptionSign Sign) {
3236 if (Sign == AS_ASSUMPTION) {
3237 if (isl_set_is_subset(Context, Set))
3238 return false;
Johannes Doerfertd84493e2015-11-12 02:33:38 +00003239
Johannes Doerfert066dbf32016-03-01 13:06:28 +00003240 if (isl_set_is_subset(AssumedContext, Set))
3241 return false;
3242 } else {
3243 if (isl_set_is_disjoint(Set, Context))
3244 return false;
3245
3246 if (isl_set_is_subset(Set, InvalidContext))
3247 return false;
3248 }
Johannes Doerfertd84493e2015-11-12 02:33:38 +00003249
3250 auto &F = *getRegion().getEntry()->getParent();
Johannes Doerfert066dbf32016-03-01 13:06:28 +00003251 auto Suffix = Sign == AS_ASSUMPTION ? " assumption:\t" : " restriction:\t";
3252 std::string Msg = toString(Kind) + Suffix + stringFromIslObj(Set);
Johannes Doerfertd84493e2015-11-12 02:33:38 +00003253 emitOptimizationRemarkAnalysis(F.getContext(), DEBUG_TYPE, F, Loc, Msg);
Johannes Doerfert066dbf32016-03-01 13:06:28 +00003254 return true;
Johannes Doerfertd84493e2015-11-12 02:33:38 +00003255}
3256
3257void Scop::addAssumption(AssumptionKind Kind, __isl_take isl_set *Set,
Johannes Doerfert066dbf32016-03-01 13:06:28 +00003258 DebugLoc Loc, AssumptionSign Sign) {
3259 if (!trackAssumption(Kind, Set, Loc, Sign)) {
3260 isl_set_free(Set);
3261 return;
Tobias Grosser20a4c0c2015-11-11 16:22:36 +00003262 }
3263
Johannes Doerfert066dbf32016-03-01 13:06:28 +00003264 if (Sign == AS_ASSUMPTION) {
3265 AssumedContext = isl_set_intersect(AssumedContext, Set);
3266 AssumedContext = isl_set_coalesce(AssumedContext);
3267 } else {
3268 InvalidContext = isl_set_union(InvalidContext, Set);
3269 InvalidContext = isl_set_coalesce(InvalidContext);
3270 }
Tobias Grosser5e6813d2014-07-02 17:47:48 +00003271}
3272
Tobias Grosser8d4f6262015-12-12 09:52:26 +00003273void Scop::invalidate(AssumptionKind Kind, DebugLoc Loc) {
Johannes Doerfert066dbf32016-03-01 13:06:28 +00003274 addAssumption(Kind, isl_set_empty(getParamSpace()), Loc, AS_ASSUMPTION);
Tobias Grosser8d4f6262015-12-12 09:52:26 +00003275}
3276
Johannes Doerfert066dbf32016-03-01 13:06:28 +00003277__isl_give isl_set *Scop::getInvalidContext() const {
3278 return isl_set_copy(InvalidContext);
Johannes Doerfert883f8c12015-09-15 22:52:53 +00003279}
3280
Tobias Grosser75805372011-04-29 06:27:02 +00003281void Scop::printContext(raw_ostream &OS) const {
3282 OS << "Context:\n";
Johannes Doerfert066dbf32016-03-01 13:06:28 +00003283 OS.indent(4) << Context << "\n";
Tobias Grosser60b54f12011-11-08 15:41:28 +00003284
Tobias Grosser5e6813d2014-07-02 17:47:48 +00003285 OS.indent(4) << "Assumed Context:\n";
Johannes Doerfert066dbf32016-03-01 13:06:28 +00003286 OS.indent(4) << AssumedContext << "\n";
Tobias Grosser5e6813d2014-07-02 17:47:48 +00003287
Johannes Doerfert066dbf32016-03-01 13:06:28 +00003288 OS.indent(4) << "Invalid Context:\n";
3289 OS.indent(4) << InvalidContext << "\n";
Johannes Doerfert883f8c12015-09-15 22:52:53 +00003290
Tobias Grosser083d3d32014-06-28 08:59:45 +00003291 for (const SCEV *Parameter : Parameters) {
Tobias Grosser60b54f12011-11-08 15:41:28 +00003292 int Dim = ParameterIds.find(Parameter)->second;
Tobias Grosser60b54f12011-11-08 15:41:28 +00003293 OS.indent(4) << "p" << Dim << ": " << *Parameter << "\n";
3294 }
Tobias Grosser75805372011-04-29 06:27:02 +00003295}
3296
Johannes Doerfertb164c792014-09-18 11:17:17 +00003297void Scop::printAliasAssumptions(raw_ostream &OS) const {
Tobias Grosserbb853c22015-07-25 12:31:03 +00003298 int noOfGroups = 0;
3299 for (const MinMaxVectorPairTy &Pair : MinMaxAliasGroups) {
Johannes Doerfert210b09a2015-07-26 13:14:38 +00003300 if (Pair.second.size() == 0)
Johannes Doerfert338b42c2015-07-23 17:04:54 +00003301 noOfGroups += 1;
3302 else
Johannes Doerfert210b09a2015-07-26 13:14:38 +00003303 noOfGroups += Pair.second.size();
Johannes Doerfert338b42c2015-07-23 17:04:54 +00003304 }
3305
Tobias Grosserbb853c22015-07-25 12:31:03 +00003306 OS.indent(4) << "Alias Groups (" << noOfGroups << "):\n";
Johannes Doerfertb164c792014-09-18 11:17:17 +00003307 if (MinMaxAliasGroups.empty()) {
3308 OS.indent(8) << "n/a\n";
3309 return;
3310 }
Johannes Doerfert338b42c2015-07-23 17:04:54 +00003311
Tobias Grosserbb853c22015-07-25 12:31:03 +00003312 for (const MinMaxVectorPairTy &Pair : MinMaxAliasGroups) {
Johannes Doerfert338b42c2015-07-23 17:04:54 +00003313
3314 // If the group has no read only accesses print the write accesses.
Johannes Doerfert210b09a2015-07-26 13:14:38 +00003315 if (Pair.second.empty()) {
Johannes Doerfert338b42c2015-07-23 17:04:54 +00003316 OS.indent(8) << "[[";
Johannes Doerfert210b09a2015-07-26 13:14:38 +00003317 for (const MinMaxAccessTy &MMANonReadOnly : Pair.first) {
Tobias Grosserbb853c22015-07-25 12:31:03 +00003318 OS << " <" << MMANonReadOnly.first << ", " << MMANonReadOnly.second
3319 << ">";
Johannes Doerfert338b42c2015-07-23 17:04:54 +00003320 }
3321 OS << " ]]\n";
3322 }
3323
Johannes Doerfert210b09a2015-07-26 13:14:38 +00003324 for (const MinMaxAccessTy &MMAReadOnly : Pair.second) {
Johannes Doerfert338b42c2015-07-23 17:04:54 +00003325 OS.indent(8) << "[[";
Tobias Grosserbb853c22015-07-25 12:31:03 +00003326 OS << " <" << MMAReadOnly.first << ", " << MMAReadOnly.second << ">";
Johannes Doerfert210b09a2015-07-26 13:14:38 +00003327 for (const MinMaxAccessTy &MMANonReadOnly : Pair.first) {
Tobias Grosserbb853c22015-07-25 12:31:03 +00003328 OS << " <" << MMANonReadOnly.first << ", " << MMANonReadOnly.second
3329 << ">";
Johannes Doerfert338b42c2015-07-23 17:04:54 +00003330 }
3331 OS << " ]]\n";
3332 }
Johannes Doerfertb164c792014-09-18 11:17:17 +00003333 }
3334}
3335
Tobias Grosser75805372011-04-29 06:27:02 +00003336void Scop::printStatements(raw_ostream &OS) const {
3337 OS << "Statements {\n";
3338
Tobias Grosser7c3bad52015-05-27 05:16:57 +00003339 for (const ScopStmt &Stmt : *this)
3340 OS.indent(4) << Stmt;
Tobias Grosser75805372011-04-29 06:27:02 +00003341
3342 OS.indent(4) << "}\n";
3343}
3344
Tobias Grosser49ad36c2015-05-20 08:05:31 +00003345void Scop::printArrayInfo(raw_ostream &OS) const {
3346 OS << "Arrays {\n";
3347
Tobias Grosserab671442015-05-23 05:58:27 +00003348 for (auto &Array : arrays())
Tobias Grosser49ad36c2015-05-20 08:05:31 +00003349 Array.second->print(OS);
3350
3351 OS.indent(4) << "}\n";
Tobias Grosserd46fd5e2015-08-12 15:27:16 +00003352
3353 OS.indent(4) << "Arrays (Bounds as pw_affs) {\n";
3354
3355 for (auto &Array : arrays())
3356 Array.second->print(OS, /* SizeAsPwAff */ true);
3357
3358 OS.indent(4) << "}\n";
Tobias Grosser49ad36c2015-05-20 08:05:31 +00003359}
3360
Tobias Grosser75805372011-04-29 06:27:02 +00003361void Scop::print(raw_ostream &OS) const {
Tobias Grosser4eb7ddb2014-03-18 18:51:11 +00003362 OS.indent(4) << "Function: " << getRegion().getEntry()->getParent()->getName()
3363 << "\n";
Tobias Grosser483fdd42014-03-18 18:05:38 +00003364 OS.indent(4) << "Region: " << getNameStr() << "\n";
David Peixottodc0a11c2015-01-13 18:31:55 +00003365 OS.indent(4) << "Max Loop Depth: " << getMaxLoopDepth() << "\n";
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00003366 OS.indent(4) << "Invariant Accesses: {\n";
Johannes Doerfert697fdf82015-10-09 17:12:26 +00003367 for (const auto &IAClass : InvariantEquivClasses) {
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003368 const auto &MAs = std::get<1>(IAClass);
3369 if (MAs.empty()) {
3370 OS.indent(12) << "Class Pointer: " << *std::get<0>(IAClass) << "\n";
Johannes Doerfert697fdf82015-10-09 17:12:26 +00003371 } else {
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003372 MAs.front()->print(OS);
3373 OS.indent(12) << "Execution Context: " << std::get<2>(IAClass) << "\n";
Johannes Doerfert697fdf82015-10-09 17:12:26 +00003374 }
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00003375 }
3376 OS.indent(4) << "}\n";
Tobias Grosser75805372011-04-29 06:27:02 +00003377 printContext(OS.indent(4));
Tobias Grosser49ad36c2015-05-20 08:05:31 +00003378 printArrayInfo(OS.indent(4));
Johannes Doerfertb164c792014-09-18 11:17:17 +00003379 printAliasAssumptions(OS);
Tobias Grosser75805372011-04-29 06:27:02 +00003380 printStatements(OS.indent(4));
3381}
3382
3383void Scop::dump() const { print(dbgs()); }
3384
Hongbin Zheng8831eb72016-02-17 15:49:21 +00003385isl_ctx *Scop::getIslCtx() const { return IslCtx.get(); }
Tobias Grosser75805372011-04-29 06:27:02 +00003386
Johannes Doerfertcef616f2015-09-15 22:49:04 +00003387__isl_give isl_pw_aff *Scop::getPwAff(const SCEV *E, BasicBlock *BB) {
3388 return Affinator.getPwAff(E, BB);
Johannes Doerfert574182d2015-08-12 10:19:50 +00003389}
3390
Tobias Grosser808cd692015-07-14 09:33:13 +00003391__isl_give isl_union_set *Scop::getDomains() const {
Tobias Grosserbc4ef902014-06-28 08:59:38 +00003392 isl_union_set *Domain = isl_union_set_empty(getParamSpace());
Tobias Grosser5f9a7622012-02-14 14:02:40 +00003393
Tobias Grosser808cd692015-07-14 09:33:13 +00003394 for (const ScopStmt &Stmt : *this)
Tobias Grosser7c3bad52015-05-27 05:16:57 +00003395 Domain = isl_union_set_add_set(Domain, Stmt.getDomain());
Tobias Grosser5f9a7622012-02-14 14:02:40 +00003396
3397 return Domain;
3398}
3399
Tobias Grossere5a35142015-11-12 14:07:09 +00003400__isl_give isl_union_map *
3401Scop::getAccessesOfType(std::function<bool(MemoryAccess &)> Predicate) {
3402 isl_union_map *Accesses = isl_union_map_empty(getParamSpace());
Tobias Grosser780ce0f2014-07-11 07:12:10 +00003403
Tobias Grosser7c3bad52015-05-27 05:16:57 +00003404 for (ScopStmt &Stmt : *this) {
3405 for (MemoryAccess *MA : Stmt) {
Tobias Grossere5a35142015-11-12 14:07:09 +00003406 if (!Predicate(*MA))
Tobias Grosser780ce0f2014-07-11 07:12:10 +00003407 continue;
3408
Tobias Grosser7c3bad52015-05-27 05:16:57 +00003409 isl_set *Domain = Stmt.getDomain();
Tobias Grosser780ce0f2014-07-11 07:12:10 +00003410 isl_map *AccessDomain = MA->getAccessRelation();
3411 AccessDomain = isl_map_intersect_domain(AccessDomain, Domain);
Tobias Grossere5a35142015-11-12 14:07:09 +00003412 Accesses = isl_union_map_add_map(Accesses, AccessDomain);
Tobias Grosser780ce0f2014-07-11 07:12:10 +00003413 }
3414 }
Tobias Grossere5a35142015-11-12 14:07:09 +00003415 return isl_union_map_coalesce(Accesses);
3416}
3417
3418__isl_give isl_union_map *Scop::getMustWrites() {
3419 return getAccessesOfType([](MemoryAccess &MA) { return MA.isMustWrite(); });
Tobias Grosser780ce0f2014-07-11 07:12:10 +00003420}
3421
3422__isl_give isl_union_map *Scop::getMayWrites() {
Tobias Grossere5a35142015-11-12 14:07:09 +00003423 return getAccessesOfType([](MemoryAccess &MA) { return MA.isMayWrite(); });
Tobias Grosser780ce0f2014-07-11 07:12:10 +00003424}
3425
Tobias Grosser37eb4222014-02-20 21:43:54 +00003426__isl_give isl_union_map *Scop::getWrites() {
Tobias Grossere5a35142015-11-12 14:07:09 +00003427 return getAccessesOfType([](MemoryAccess &MA) { return MA.isWrite(); });
Tobias Grosser37eb4222014-02-20 21:43:54 +00003428}
3429
3430__isl_give isl_union_map *Scop::getReads() {
Tobias Grossere5a35142015-11-12 14:07:09 +00003431 return getAccessesOfType([](MemoryAccess &MA) { return MA.isRead(); });
Tobias Grosser37eb4222014-02-20 21:43:54 +00003432}
3433
Tobias Grosser2ac23382015-11-12 14:07:13 +00003434__isl_give isl_union_map *Scop::getAccesses() {
3435 return getAccessesOfType([](MemoryAccess &MA) { return true; });
3436}
3437
Tobias Grosser808cd692015-07-14 09:33:13 +00003438__isl_give isl_union_map *Scop::getSchedule() const {
Johannes Doerferta90943d2016-02-21 16:37:25 +00003439 auto *Tree = getScheduleTree();
3440 auto *S = isl_schedule_get_map(Tree);
Tobias Grosser808cd692015-07-14 09:33:13 +00003441 isl_schedule_free(Tree);
3442 return S;
3443}
Tobias Grosser37eb4222014-02-20 21:43:54 +00003444
Tobias Grosser808cd692015-07-14 09:33:13 +00003445__isl_give isl_schedule *Scop::getScheduleTree() const {
3446 return isl_schedule_intersect_domain(isl_schedule_copy(Schedule),
3447 getDomains());
3448}
Tobias Grosserbc4ef902014-06-28 08:59:38 +00003449
Tobias Grosser808cd692015-07-14 09:33:13 +00003450void Scop::setSchedule(__isl_take isl_union_map *NewSchedule) {
3451 auto *S = isl_schedule_from_domain(getDomains());
3452 S = isl_schedule_insert_partial_schedule(
3453 S, isl_multi_union_pw_aff_from_union_map(NewSchedule));
3454 isl_schedule_free(Schedule);
3455 Schedule = S;
3456}
3457
3458void Scop::setScheduleTree(__isl_take isl_schedule *NewSchedule) {
3459 isl_schedule_free(Schedule);
3460 Schedule = NewSchedule;
Tobias Grosser37eb4222014-02-20 21:43:54 +00003461}
3462
3463bool Scop::restrictDomains(__isl_take isl_union_set *Domain) {
3464 bool Changed = false;
Tobias Grosser7c3bad52015-05-27 05:16:57 +00003465 for (ScopStmt &Stmt : *this) {
3466 isl_union_set *StmtDomain = isl_union_set_from_set(Stmt.getDomain());
Tobias Grosser37eb4222014-02-20 21:43:54 +00003467 isl_union_set *NewStmtDomain = isl_union_set_intersect(
3468 isl_union_set_copy(StmtDomain), isl_union_set_copy(Domain));
3469
3470 if (isl_union_set_is_subset(StmtDomain, NewStmtDomain)) {
3471 isl_union_set_free(StmtDomain);
3472 isl_union_set_free(NewStmtDomain);
3473 continue;
3474 }
3475
3476 Changed = true;
3477
3478 isl_union_set_free(StmtDomain);
3479 NewStmtDomain = isl_union_set_coalesce(NewStmtDomain);
3480
3481 if (isl_union_set_is_empty(NewStmtDomain)) {
Tobias Grosser7c3bad52015-05-27 05:16:57 +00003482 Stmt.restrictDomain(isl_set_empty(Stmt.getDomainSpace()));
Tobias Grosser37eb4222014-02-20 21:43:54 +00003483 isl_union_set_free(NewStmtDomain);
3484 } else
Tobias Grosser7c3bad52015-05-27 05:16:57 +00003485 Stmt.restrictDomain(isl_set_from_union_set(NewStmtDomain));
Tobias Grosser37eb4222014-02-20 21:43:54 +00003486 }
3487 isl_union_set_free(Domain);
3488 return Changed;
3489}
3490
Tobias Grosser75805372011-04-29 06:27:02 +00003491ScalarEvolution *Scop::getSE() const { return SE; }
3492
Hongbin Zheng192f69a2016-02-13 15:12:54 +00003493bool Scop::isIgnored(RegionNode *RN, DominatorTree &DT, LoopInfo &LI) {
Johannes Doerfertf5673802015-10-01 23:48:18 +00003494 BasicBlock *BB = getRegionNodeBasicBlock(RN);
Michael Kruse6f7721f2016-02-24 22:08:19 +00003495 ScopStmt *Stmt = getStmtFor(RN);
Michael Krusea902ba62015-12-13 19:21:45 +00003496
3497 // If there is no stmt, then it already has been removed.
3498 if (!Stmt)
3499 return true;
Tobias Grosser75805372011-04-29 06:27:02 +00003500
Johannes Doerfertf5673802015-10-01 23:48:18 +00003501 // Check if there are accesses contained.
Michael Krusea902ba62015-12-13 19:21:45 +00003502 if (Stmt->isEmpty())
Johannes Doerfertf5673802015-10-01 23:48:18 +00003503 return true;
3504
3505 // Check for reachability via non-error blocks.
3506 if (!DomainMap.count(BB))
3507 return true;
3508
3509 // Check if error blocks are contained.
Johannes Doerfert08d90a32015-10-07 20:32:43 +00003510 if (containsErrorBlock(RN, getRegion(), LI, DT))
Johannes Doerfertf5673802015-10-01 23:48:18 +00003511 return true;
3512
3513 return false;
Tobias Grosser75805372011-04-29 06:27:02 +00003514}
3515
Tobias Grosser808cd692015-07-14 09:33:13 +00003516struct MapToDimensionDataTy {
3517 int N;
3518 isl_union_pw_multi_aff *Res;
3519};
Johannes Doerfertff9d1982015-02-24 12:00:50 +00003520
Tobias Grosser808cd692015-07-14 09:33:13 +00003521// @brief Create a function that maps the elements of 'Set' to its N-th
Tobias Grossercbf7ae82015-12-21 22:45:53 +00003522// dimension and add it to User->Res.
Tobias Grosser808cd692015-07-14 09:33:13 +00003523//
Tobias Grossercbf7ae82015-12-21 22:45:53 +00003524// @param Set The input set.
3525// @param User->N The dimension to map to.
3526// @param User->Res The isl_union_pw_multi_aff to which to add the result.
Tobias Grosser808cd692015-07-14 09:33:13 +00003527//
Tobias Grossercbf7ae82015-12-21 22:45:53 +00003528// @returns isl_stat_ok if no error occured, othewise isl_stat_error.
Tobias Grosser808cd692015-07-14 09:33:13 +00003529static isl_stat mapToDimension_AddSet(__isl_take isl_set *Set, void *User) {
3530 struct MapToDimensionDataTy *Data = (struct MapToDimensionDataTy *)User;
3531 int Dim;
3532 isl_space *Space;
3533 isl_pw_multi_aff *PMA;
3534
3535 Dim = isl_set_dim(Set, isl_dim_set);
3536 Space = isl_set_get_space(Set);
3537 PMA = isl_pw_multi_aff_project_out_map(Space, isl_dim_set, Data->N,
3538 Dim - Data->N);
3539 if (Data->N > 1)
3540 PMA = isl_pw_multi_aff_drop_dims(PMA, isl_dim_out, 0, Data->N - 1);
3541 Data->Res = isl_union_pw_multi_aff_add_pw_multi_aff(Data->Res, PMA);
3542
3543 isl_set_free(Set);
3544
3545 return isl_stat_ok;
Johannes Doerfertff9d1982015-02-24 12:00:50 +00003546}
3547
Tobias Grossercbf7ae82015-12-21 22:45:53 +00003548// @brief Create an isl_multi_union_aff that defines an identity mapping
3549// from the elements of USet to their N-th dimension.
Tobias Grosser808cd692015-07-14 09:33:13 +00003550//
Tobias Grossercbf7ae82015-12-21 22:45:53 +00003551// # Example:
3552//
3553// Domain: { A[i,j]; B[i,j,k] }
3554// N: 1
3555//
3556// Resulting Mapping: { {A[i,j] -> [(j)]; B[i,j,k] -> [(j)] }
3557//
3558// @param USet A union set describing the elements for which to generate a
3559// mapping.
Tobias Grosser808cd692015-07-14 09:33:13 +00003560// @param N The dimension to map to.
Tobias Grossercbf7ae82015-12-21 22:45:53 +00003561// @returns A mapping from USet to its N-th dimension.
Tobias Grosser808cd692015-07-14 09:33:13 +00003562static __isl_give isl_multi_union_pw_aff *
Tobias Grossercbf7ae82015-12-21 22:45:53 +00003563mapToDimension(__isl_take isl_union_set *USet, int N) {
3564 assert(N >= 0);
Tobias Grosserc900633d2015-12-21 23:01:53 +00003565 assert(USet);
Tobias Grossercbf7ae82015-12-21 22:45:53 +00003566 assert(!isl_union_set_is_empty(USet));
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00003567
Tobias Grosser808cd692015-07-14 09:33:13 +00003568 struct MapToDimensionDataTy Data;
Tobias Grosser808cd692015-07-14 09:33:13 +00003569
Tobias Grossercbf7ae82015-12-21 22:45:53 +00003570 auto *Space = isl_union_set_get_space(USet);
3571 auto *PwAff = isl_union_pw_multi_aff_empty(Space);
Tobias Grosser808cd692015-07-14 09:33:13 +00003572
Tobias Grossercbf7ae82015-12-21 22:45:53 +00003573 Data = {N, PwAff};
3574
3575 auto Res = isl_union_set_foreach_set(USet, &mapToDimension_AddSet, &Data);
Sumanth Gundapaneni4b1472f2016-01-20 15:41:30 +00003576 (void)Res;
3577
Tobias Grossercbf7ae82015-12-21 22:45:53 +00003578 assert(Res == isl_stat_ok);
3579
3580 isl_union_set_free(USet);
Tobias Grosser808cd692015-07-14 09:33:13 +00003581 return isl_multi_union_pw_aff_from_union_pw_multi_aff(Data.Res);
3582}
3583
Tobias Grosser316b5b22015-11-11 19:28:14 +00003584void Scop::addScopStmt(BasicBlock *BB, Region *R) {
Tobias Grosser808cd692015-07-14 09:33:13 +00003585 if (BB) {
Michael Kruse9d080092015-09-11 21:41:48 +00003586 Stmts.emplace_back(*this, *BB);
Johannes Doerferta90943d2016-02-21 16:37:25 +00003587 auto *Stmt = &Stmts.back();
Tobias Grosser808cd692015-07-14 09:33:13 +00003588 StmtMap[BB] = Stmt;
3589 } else {
3590 assert(R && "Either basic block or a region expected.");
Michael Kruse9d080092015-09-11 21:41:48 +00003591 Stmts.emplace_back(*this, *R);
Johannes Doerferta90943d2016-02-21 16:37:25 +00003592 auto *Stmt = &Stmts.back();
Tobias Grosser808cd692015-07-14 09:33:13 +00003593 for (BasicBlock *BB : R->blocks())
3594 StmtMap[BB] = Stmt;
3595 }
Tobias Grosser808cd692015-07-14 09:33:13 +00003596}
3597
Hongbin Zheng192f69a2016-02-13 15:12:54 +00003598void Scop::buildSchedule(ScopDetection &SD, LoopInfo &LI) {
Johannes Doerfertf9711ef2016-01-06 12:59:23 +00003599 Loop *L = getLoopSurroundingRegion(getRegion(), LI);
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00003600 LoopStackTy LoopStack({LoopStackElementTy(L, nullptr, 0)});
Hongbin Zheng192f69a2016-02-13 15:12:54 +00003601 buildSchedule(getRegion().getNode(), LoopStack, SD, LI);
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00003602 assert(LoopStack.size() == 1 && LoopStack.back().L == L);
3603 Schedule = LoopStack[0].Schedule;
Johannes Doerfertf9711ef2016-01-06 12:59:23 +00003604}
3605
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00003606/// To generate a schedule for the elements in a Region we traverse the Region
3607/// in reverse-post-order and add the contained RegionNodes in traversal order
3608/// to the schedule of the loop that is currently at the top of the LoopStack.
3609/// For loop-free codes, this results in a correct sequential ordering.
3610///
3611/// Example:
3612/// bb1(0)
3613/// / \.
3614/// bb2(1) bb3(2)
3615/// \ / \.
3616/// bb4(3) bb5(4)
3617/// \ /
3618/// bb6(5)
3619///
3620/// Including loops requires additional processing. Whenever a loop header is
3621/// encountered, the corresponding loop is added to the @p LoopStack. Starting
3622/// from an empty schedule, we first process all RegionNodes that are within
3623/// this loop and complete the sequential schedule at this loop-level before
3624/// processing about any other nodes. To implement this
3625/// loop-nodes-first-processing, the reverse post-order traversal is
3626/// insufficient. Hence, we additionally check if the traversal yields
3627/// sub-regions or blocks that are outside the last loop on the @p LoopStack.
3628/// These region-nodes are then queue and only traverse after the all nodes
3629/// within the current loop have been processed.
Hongbin Zheng192f69a2016-02-13 15:12:54 +00003630void Scop::buildSchedule(Region *R, LoopStackTy &LoopStack, ScopDetection &SD,
3631 LoopInfo &LI) {
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00003632 Loop *OuterScopLoop = getLoopSurroundingRegion(getRegion(), LI);
3633
3634 ReversePostOrderTraversal<Region *> RTraversal(R);
3635 std::deque<RegionNode *> WorkList(RTraversal.begin(), RTraversal.end());
3636 std::deque<RegionNode *> DelayList;
3637 bool LastRNWaiting = false;
3638
3639 // Iterate over the region @p R in reverse post-order but queue
3640 // sub-regions/blocks iff they are not part of the last encountered but not
3641 // completely traversed loop. The variable LastRNWaiting is a flag to indicate
3642 // that we queued the last sub-region/block from the reverse post-order
3643 // iterator. If it is set we have to explore the next sub-region/block from
3644 // the iterator (if any) to guarantee progress. If it is not set we first try
3645 // the next queued sub-region/blocks.
3646 while (!WorkList.empty() || !DelayList.empty()) {
3647 RegionNode *RN;
3648
3649 if ((LastRNWaiting && !WorkList.empty()) || DelayList.size() == 0) {
3650 RN = WorkList.front();
3651 WorkList.pop_front();
3652 LastRNWaiting = false;
3653 } else {
3654 RN = DelayList.front();
3655 DelayList.pop_front();
3656 }
3657
3658 Loop *L = getRegionNodeLoop(RN, LI);
3659 if (!getRegion().contains(L))
3660 L = OuterScopLoop;
3661
3662 Loop *LastLoop = LoopStack.back().L;
3663 if (LastLoop != L) {
3664 if (!LastLoop->contains(L)) {
3665 LastRNWaiting = true;
3666 DelayList.push_back(RN);
3667 continue;
3668 }
3669 LoopStack.push_back({L, nullptr, 0});
3670 }
Hongbin Zheng192f69a2016-02-13 15:12:54 +00003671 buildSchedule(RN, LoopStack, SD, LI);
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00003672 }
3673
3674 return;
3675}
3676
Hongbin Zheng7dddfba2016-02-13 15:12:47 +00003677void Scop::buildSchedule(RegionNode *RN, LoopStackTy &LoopStack,
Hongbin Zheng192f69a2016-02-13 15:12:54 +00003678 ScopDetection &SD, LoopInfo &LI) {
Michael Kruse046dde42015-08-10 13:01:57 +00003679
Tobias Grosser8362c262016-01-06 15:30:06 +00003680 if (RN->isSubRegion()) {
3681 auto *LocalRegion = RN->getNodeAs<Region>();
3682 if (!SD.isNonAffineSubRegion(LocalRegion, &getRegion())) {
Hongbin Zheng192f69a2016-02-13 15:12:54 +00003683 buildSchedule(LocalRegion, LoopStack, SD, LI);
Tobias Grosser8362c262016-01-06 15:30:06 +00003684 return;
3685 }
3686 }
Michael Kruse046dde42015-08-10 13:01:57 +00003687
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00003688 auto &LoopData = LoopStack.back();
3689 LoopData.NumBlocksProcessed += getNumBlocksInRegionNode(RN);
Tobias Grosser8362c262016-01-06 15:30:06 +00003690
Michael Kruse6f7721f2016-02-24 22:08:19 +00003691 if (auto *Stmt = getStmtFor(RN)) {
Tobias Grosser8362c262016-01-06 15:30:06 +00003692 auto *UDomain = isl_union_set_from_set(Stmt->getDomain());
3693 auto *StmtSchedule = isl_schedule_from_domain(UDomain);
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00003694 LoopData.Schedule = combineInSequence(LoopData.Schedule, StmtSchedule);
Tobias Grosser8362c262016-01-06 15:30:06 +00003695 }
3696
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00003697 // Check if we just processed the last node in this loop. If we did, finalize
3698 // the loop by:
3699 //
3700 // - adding new schedule dimensions
3701 // - folding the resulting schedule into the parent loop schedule
3702 // - dropping the loop schedule from the LoopStack.
3703 //
3704 // Then continue to check surrounding loops, which might also have been
3705 // completed by this node.
3706 while (LoopData.L &&
3707 LoopData.NumBlocksProcessed == LoopData.L->getNumBlocks()) {
Johannes Doerferta90943d2016-02-21 16:37:25 +00003708 auto *Schedule = LoopData.Schedule;
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00003709 auto NumBlocksProcessed = LoopData.NumBlocksProcessed;
Tobias Grosser8362c262016-01-06 15:30:06 +00003710
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00003711 LoopStack.pop_back();
3712 auto &NextLoopData = LoopStack.back();
Tobias Grosser8362c262016-01-06 15:30:06 +00003713
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00003714 if (Schedule) {
3715 auto *Domain = isl_schedule_get_domain(Schedule);
3716 auto *MUPA = mapToDimension(Domain, LoopStack.size());
3717 Schedule = isl_schedule_insert_partial_schedule(Schedule, MUPA);
3718 NextLoopData.Schedule =
3719 combineInSequence(NextLoopData.Schedule, Schedule);
Tobias Grosser75805372011-04-29 06:27:02 +00003720 }
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00003721
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00003722 NextLoopData.NumBlocksProcessed += NumBlocksProcessed;
3723 LoopData = NextLoopData;
Tobias Grosser808cd692015-07-14 09:33:13 +00003724 }
Tobias Grosser75805372011-04-29 06:27:02 +00003725}
3726
Michael Kruse6f7721f2016-02-24 22:08:19 +00003727ScopStmt *Scop::getStmtFor(BasicBlock *BB) const {
Tobias Grosser57411e32015-05-27 06:51:34 +00003728 auto StmtMapIt = StmtMap.find(BB);
Johannes Doerfert7c494212014-10-31 23:13:39 +00003729 if (StmtMapIt == StmtMap.end())
3730 return nullptr;
3731 return StmtMapIt->second;
3732}
3733
Michael Kruse6f7721f2016-02-24 22:08:19 +00003734ScopStmt *Scop::getStmtFor(RegionNode *RN) const {
3735 if (RN->isSubRegion())
3736 return getStmtFor(RN->getNodeAs<Region>());
3737 return getStmtFor(RN->getNodeAs<BasicBlock>());
3738}
3739
3740ScopStmt *Scop::getStmtFor(Region *R) const {
3741 ScopStmt *Stmt = getStmtFor(R->getEntry());
3742 assert(!Stmt || Stmt->getRegion() == R);
3743 return Stmt;
Michael Krusea902ba62015-12-13 19:21:45 +00003744}
3745
Johannes Doerfert96425c22015-08-30 21:13:53 +00003746int Scop::getRelativeLoopDepth(const Loop *L) const {
3747 Loop *OuterLoop =
3748 L ? R.outermostLoopInRegion(const_cast<Loop *>(L)) : nullptr;
3749 if (!OuterLoop)
3750 return -1;
Johannes Doerfertd020b772015-08-27 06:53:52 +00003751 return L->getLoopDepth() - OuterLoop->getLoopDepth();
3752}
3753
Michael Krused868b5d2015-09-10 15:25:24 +00003754void ScopInfo::buildPHIAccesses(PHINode *PHI, Region &R,
Michael Krused868b5d2015-09-10 15:25:24 +00003755 Region *NonAffineSubRegion, bool IsExitBlock) {
Michael Kruse7bf39442015-09-10 12:46:52 +00003756
3757 // PHI nodes that are in the exit block of the region, hence if IsExitBlock is
3758 // true, are not modeled as ordinary PHI nodes as they are not part of the
3759 // region. However, we model the operands in the predecessor blocks that are
3760 // part of the region as regular scalar accesses.
3761
3762 // If we can synthesize a PHI we can skip it, however only if it is in
3763 // the region. If it is not it can only be in the exit block of the region.
3764 // In this case we model the operands but not the PHI itself.
Michael Krusec7e0d9c2016-03-01 21:44:06 +00003765 auto *Scope = LI->getLoopFor(PHI->getParent());
3766 if (!IsExitBlock && canSynthesize(PHI, LI, SE, &R, Scope))
Michael Kruse7bf39442015-09-10 12:46:52 +00003767 return;
3768
3769 // PHI nodes are modeled as if they had been demoted prior to the SCoP
3770 // detection. Hence, the PHI is a load of a new memory location in which the
3771 // incoming value was written at the end of the incoming basic block.
3772 bool OnlyNonAffineSubRegionOperands = true;
3773 for (unsigned u = 0; u < PHI->getNumIncomingValues(); u++) {
3774 Value *Op = PHI->getIncomingValue(u);
3775 BasicBlock *OpBB = PHI->getIncomingBlock(u);
3776
3777 // Do not build scalar dependences inside a non-affine subregion.
3778 if (NonAffineSubRegion && NonAffineSubRegion->contains(OpBB))
3779 continue;
3780
3781 OnlyNonAffineSubRegionOperands = false;
Michael Kruseee6a4fc2016-01-26 13:33:27 +00003782 ensurePHIWrite(PHI, OpBB, Op, IsExitBlock);
Michael Kruse7bf39442015-09-10 12:46:52 +00003783 }
3784
Michael Kruse33d6c0b2015-09-25 18:53:27 +00003785 if (!OnlyNonAffineSubRegionOperands && !IsExitBlock) {
3786 addPHIReadAccess(PHI);
Michael Kruse7bf39442015-09-10 12:46:52 +00003787 }
3788}
3789
Michael Kruse2e02d562016-02-06 09:19:40 +00003790void ScopInfo::buildScalarDependences(Instruction *Inst) {
3791 assert(!isa<PHINode>(Inst));
Michael Kruse7bf39442015-09-10 12:46:52 +00003792
Michael Kruse2e02d562016-02-06 09:19:40 +00003793 // Pull-in required operands.
3794 for (Use &Op : Inst->operands())
3795 ensureValueRead(Op.get(), Inst->getParent());
3796}
Michael Kruse7bf39442015-09-10 12:46:52 +00003797
Michael Kruse2e02d562016-02-06 09:19:40 +00003798void ScopInfo::buildEscapingDependences(Instruction *Inst) {
3799 Region *R = &scop->getRegion();
Michael Kruse7bf39442015-09-10 12:46:52 +00003800
Michael Kruse2e02d562016-02-06 09:19:40 +00003801 // Check for uses of this instruction outside the scop. Because we do not
3802 // iterate over such instructions and therefore did not "ensure" the existence
3803 // of a write, we must determine such use here.
3804 for (Use &U : Inst->uses()) {
3805 Instruction *UI = dyn_cast<Instruction>(U.getUser());
3806 if (!UI)
Michael Kruse7bf39442015-09-10 12:46:52 +00003807 continue;
3808
Michael Kruse2e02d562016-02-06 09:19:40 +00003809 BasicBlock *UseParent = getUseBlock(U);
3810 BasicBlock *UserParent = UI->getParent();
Michael Kruse7bf39442015-09-10 12:46:52 +00003811
Michael Kruse2e02d562016-02-06 09:19:40 +00003812 // An escaping value is either used by an instruction not within the scop,
3813 // or (when the scop region's exit needs to be simplified) by a PHI in the
3814 // scop's exit block. This is because region simplification before code
3815 // generation inserts new basic blocks before the PHI such that its incoming
3816 // blocks are not in the scop anymore.
3817 if (!R->contains(UseParent) ||
3818 (isa<PHINode>(UI) && UserParent == R->getExit() &&
3819 R->getExitingBlock())) {
3820 // At least one escaping use found.
3821 ensureValueWrite(Inst);
3822 break;
Michael Kruse7bf39442015-09-10 12:46:52 +00003823 }
3824 }
Michael Kruse7bf39442015-09-10 12:46:52 +00003825}
3826
Tobias Grosserdb543ed2016-02-02 16:46:49 +00003827bool ScopInfo::buildAccessMultiDimFixed(
Michael Kruse70131d32016-01-27 17:09:17 +00003828 MemAccInst Inst, Loop *L, Region *R,
Johannes Doerfert09e36972015-10-07 20:17:36 +00003829 const ScopDetection::BoxedLoopsSetTy *BoxedLoops,
3830 const InvariantLoadsSetTy &ScopRIL) {
Michael Kruse70131d32016-01-27 17:09:17 +00003831 Value *Val = Inst.getValueOperand();
Johannes Doerfertcea61932016-02-21 19:13:19 +00003832 Type *ElementType = Val->getType();
Tobias Grosserdb543ed2016-02-02 16:46:49 +00003833 Value *Address = Inst.getPointerOperand();
Tobias Grosser5fd8c092015-09-17 17:28:15 +00003834 const SCEV *AccessFunction = SE->getSCEVAtScope(Address, L);
Michael Kruse7bf39442015-09-10 12:46:52 +00003835 const SCEVUnknown *BasePointer =
3836 dyn_cast<SCEVUnknown>(SE->getPointerBase(AccessFunction));
Tobias Grosserdb543ed2016-02-02 16:46:49 +00003837 enum MemoryAccess::AccessType Type =
Hongbin Zheng8efb22e2016-02-27 01:49:58 +00003838 isa<LoadInst>(Inst) ? MemoryAccess::READ : MemoryAccess::MUST_WRITE;
Michael Kruse7bf39442015-09-10 12:46:52 +00003839
Michael Kruse37d136e2016-02-26 16:08:24 +00003840 if (auto *BitCast = dyn_cast<BitCastInst>(Address)) {
3841 auto *Src = BitCast->getOperand(0);
3842 auto *SrcTy = Src->getType();
3843 auto *DstTy = BitCast->getType();
3844 if (SrcTy->getPrimitiveSizeInBits() == DstTy->getPrimitiveSizeInBits())
3845 Address = Src;
Tobias Grosser5fd8c092015-09-17 17:28:15 +00003846 }
Michael Kruse37d136e2016-02-26 16:08:24 +00003847
3848 auto *GEP = dyn_cast<GetElementPtrInst>(Address);
3849 if (!GEP)
3850 return false;
3851
3852 std::vector<const SCEV *> Subscripts;
3853 std::vector<int> Sizes;
3854 std::tie(Subscripts, Sizes) = getIndexExpressionsFromGEP(GEP, *SE);
3855 auto *BasePtr = GEP->getOperand(0);
3856
3857 std::vector<const SCEV *> SizesSCEV;
3858
3859 for (auto *Subscript : Subscripts) {
3860 InvariantLoadsSetTy AccessILS;
Michael Kruse09eb4452016-03-03 22:10:47 +00003861 if (!isAffineExpr(R, L, Subscript, *SE, nullptr, &AccessILS))
Michael Kruse37d136e2016-02-26 16:08:24 +00003862 return false;
3863
3864 for (LoadInst *LInst : AccessILS)
3865 if (!ScopRIL.count(LInst))
3866 return false;
3867 }
3868
3869 if (Sizes.empty())
3870 return false;
3871
3872 for (auto V : Sizes)
3873 SizesSCEV.push_back(SE->getSCEV(
3874 ConstantInt::get(IntegerType::getInt64Ty(BasePtr->getContext()), V)));
3875
3876 addArrayAccess(Inst, Type, BasePointer->getValue(), ElementType, true,
3877 Subscripts, SizesSCEV, Val);
3878 return true;
Tobias Grosserdb543ed2016-02-02 16:46:49 +00003879}
3880
3881bool ScopInfo::buildAccessMultiDimParam(
3882 MemAccInst Inst, Loop *L, Region *R,
3883 const ScopDetection::BoxedLoopsSetTy *BoxedLoops,
Hongbin Zheng22623202016-02-15 00:20:58 +00003884 const InvariantLoadsSetTy &ScopRIL, const MapInsnToMemAcc &InsnToMemAcc) {
Michael Kruse37d136e2016-02-26 16:08:24 +00003885 if (!PollyDelinearize)
3886 return false;
3887
Tobias Grosserdb543ed2016-02-02 16:46:49 +00003888 Value *Address = Inst.getPointerOperand();
3889 Value *Val = Inst.getValueOperand();
Johannes Doerfertcea61932016-02-21 19:13:19 +00003890 Type *ElementType = Val->getType();
3891 unsigned ElementSize = DL->getTypeAllocSize(ElementType);
Tobias Grosserdb543ed2016-02-02 16:46:49 +00003892 enum MemoryAccess::AccessType Type =
Hongbin Zheng8efb22e2016-02-27 01:49:58 +00003893 isa<LoadInst>(Inst) ? MemoryAccess::READ : MemoryAccess::MUST_WRITE;
Tobias Grosserdb543ed2016-02-02 16:46:49 +00003894
3895 const SCEV *AccessFunction = SE->getSCEVAtScope(Address, L);
3896 const SCEVUnknown *BasePointer =
3897 dyn_cast<SCEVUnknown>(SE->getPointerBase(AccessFunction));
3898
3899 assert(BasePointer && "Could not find base pointer");
3900 AccessFunction = SE->getMinusSCEV(AccessFunction, BasePointer);
Tobias Grosser5fd8c092015-09-17 17:28:15 +00003901
Michael Kruse7bf39442015-09-10 12:46:52 +00003902 auto AccItr = InsnToMemAcc.find(Inst);
Michael Kruse37d136e2016-02-26 16:08:24 +00003903 if (AccItr == InsnToMemAcc.end())
3904 return false;
Tobias Grosser5d51afe2016-02-02 16:46:45 +00003905
Michael Kruse37d136e2016-02-26 16:08:24 +00003906 std::vector<const SCEV *> Sizes(
3907 AccItr->second.Shape->DelinearizedSizes.begin(),
3908 AccItr->second.Shape->DelinearizedSizes.end());
3909 // Remove the element size. This information is already provided by the
3910 // ElementSize parameter. In case the element size of this access and the
3911 // element size used for delinearization differs the delinearization is
3912 // incorrect. Hence, we invalidate the scop.
3913 //
3914 // TODO: Handle delinearization with differing element sizes.
3915 auto DelinearizedSize =
3916 cast<SCEVConstant>(Sizes.back())->getAPInt().getSExtValue();
3917 Sizes.pop_back();
3918 if (ElementSize != DelinearizedSize)
3919 scop->invalidate(DELINEARIZATION, Inst->getDebugLoc());
3920
3921 addArrayAccess(Inst, Type, BasePointer->getValue(), ElementType, true,
3922 AccItr->second.DelinearizedSubscripts, Sizes, Val);
3923 return true;
Tobias Grosserdb543ed2016-02-02 16:46:49 +00003924}
3925
Johannes Doerfertcea61932016-02-21 19:13:19 +00003926bool ScopInfo::buildAccessMemIntrinsic(
3927 MemAccInst Inst, Loop *L, Region *R,
3928 const ScopDetection::BoxedLoopsSetTy *BoxedLoops,
3929 const InvariantLoadsSetTy &ScopRIL) {
Hongbin Zheng8efb22e2016-02-27 01:49:58 +00003930 auto *MemIntr = dyn_cast_or_null<MemIntrinsic>(Inst);
3931
3932 if (MemIntr == nullptr)
Johannes Doerfertcea61932016-02-21 19:13:19 +00003933 return false;
3934
Hongbin Zheng8efb22e2016-02-27 01:49:58 +00003935 auto *LengthVal = SE->getSCEVAtScope(MemIntr->getLength(), L);
Johannes Doerfertcea61932016-02-21 19:13:19 +00003936 assert(LengthVal);
3937
Johannes Doerferta7920982016-02-25 14:08:48 +00003938 // Check if the length val is actually affine or if we overapproximate it
3939 InvariantLoadsSetTy AccessILS;
Michael Kruse09eb4452016-03-03 22:10:47 +00003940 bool LengthIsAffine = isAffineExpr(R, L, LengthVal, *SE, nullptr, &AccessILS);
Johannes Doerferta7920982016-02-25 14:08:48 +00003941 for (LoadInst *LInst : AccessILS)
3942 if (!ScopRIL.count(LInst))
3943 LengthIsAffine = false;
3944 if (!LengthIsAffine)
3945 LengthVal = nullptr;
3946
Hongbin Zheng8efb22e2016-02-27 01:49:58 +00003947 auto *DestPtrVal = MemIntr->getDest();
Johannes Doerfertcea61932016-02-21 19:13:19 +00003948 assert(DestPtrVal);
3949 auto *DestAccFunc = SE->getSCEVAtScope(DestPtrVal, L);
3950 assert(DestAccFunc);
3951 auto *DestPtrSCEV = dyn_cast<SCEVUnknown>(SE->getPointerBase(DestAccFunc));
3952 assert(DestPtrSCEV);
3953 DestAccFunc = SE->getMinusSCEV(DestAccFunc, DestPtrSCEV);
3954 addArrayAccess(Inst, MemoryAccess::MUST_WRITE, DestPtrSCEV->getValue(),
3955 IntegerType::getInt8Ty(DestPtrVal->getContext()), false,
3956 {DestAccFunc, LengthVal}, {}, Inst.getValueOperand());
3957
Hongbin Zheng8efb22e2016-02-27 01:49:58 +00003958 auto *MemTrans = dyn_cast<MemTransferInst>(MemIntr);
3959 if (!MemTrans)
Johannes Doerfertcea61932016-02-21 19:13:19 +00003960 return true;
3961
Hongbin Zheng8efb22e2016-02-27 01:49:58 +00003962 auto *SrcPtrVal = MemTrans->getSource();
Johannes Doerfertcea61932016-02-21 19:13:19 +00003963 assert(SrcPtrVal);
3964 auto *SrcAccFunc = SE->getSCEVAtScope(SrcPtrVal, L);
3965 assert(SrcAccFunc);
3966 auto *SrcPtrSCEV = dyn_cast<SCEVUnknown>(SE->getPointerBase(SrcAccFunc));
3967 assert(SrcPtrSCEV);
3968 SrcAccFunc = SE->getMinusSCEV(SrcAccFunc, SrcPtrSCEV);
3969 addArrayAccess(Inst, MemoryAccess::READ, SrcPtrSCEV->getValue(),
3970 IntegerType::getInt8Ty(SrcPtrVal->getContext()), false,
3971 {SrcAccFunc, LengthVal}, {}, Inst.getValueOperand());
3972
3973 return true;
3974}
3975
Johannes Doerferta7920982016-02-25 14:08:48 +00003976bool ScopInfo::buildAccessCallInst(
3977 MemAccInst Inst, Loop *L, Region *R,
3978 const ScopDetection::BoxedLoopsSetTy *BoxedLoops,
3979 const InvariantLoadsSetTy &ScopRIL) {
Hongbin Zheng8efb22e2016-02-27 01:49:58 +00003980 auto *CI = dyn_cast_or_null<CallInst>(Inst);
3981
3982 if (CI == nullptr)
Johannes Doerferta7920982016-02-25 14:08:48 +00003983 return false;
3984
Hongbin Zheng8efb22e2016-02-27 01:49:58 +00003985 if (CI->doesNotAccessMemory() || isIgnoredIntrinsic(CI))
Johannes Doerferta7920982016-02-25 14:08:48 +00003986 return true;
3987
3988 bool ReadOnly = false;
Hongbin Zheng8efb22e2016-02-27 01:49:58 +00003989 auto *AF = SE->getConstant(IntegerType::getInt64Ty(CI->getContext()), 0);
3990 auto *CalledFunction = CI->getCalledFunction();
Johannes Doerferta7920982016-02-25 14:08:48 +00003991 switch (AA->getModRefBehavior(CalledFunction)) {
3992 case llvm::FMRB_UnknownModRefBehavior:
3993 llvm_unreachable("Unknown mod ref behaviour cannot be represented.");
3994 case llvm::FMRB_DoesNotAccessMemory:
3995 return true;
3996 case llvm::FMRB_OnlyReadsMemory:
Hongbin Zheng8efb22e2016-02-27 01:49:58 +00003997 GlobalReads.push_back(CI);
Johannes Doerferta7920982016-02-25 14:08:48 +00003998 return true;
3999 case llvm::FMRB_OnlyReadsArgumentPointees:
4000 ReadOnly = true;
4001 // Fall through
4002 case llvm::FMRB_OnlyAccessesArgumentPointees:
4003 auto AccType = ReadOnly ? MemoryAccess::READ : MemoryAccess::MAY_WRITE;
Hongbin Zheng8efb22e2016-02-27 01:49:58 +00004004 for (const auto &Arg : CI->arg_operands()) {
Johannes Doerferta7920982016-02-25 14:08:48 +00004005 if (!Arg->getType()->isPointerTy())
4006 continue;
4007
4008 auto *ArgSCEV = SE->getSCEVAtScope(Arg, L);
4009 if (ArgSCEV->isZero())
4010 continue;
4011
4012 auto *ArgBasePtr = cast<SCEVUnknown>(SE->getPointerBase(ArgSCEV));
4013 addArrayAccess(Inst, AccType, ArgBasePtr->getValue(),
Hongbin Zheng8efb22e2016-02-27 01:49:58 +00004014 ArgBasePtr->getType(), false, {AF}, {}, CI);
Johannes Doerferta7920982016-02-25 14:08:48 +00004015 }
4016 return true;
4017 }
4018
4019 return true;
4020}
4021
Tobias Grosserdb543ed2016-02-02 16:46:49 +00004022void ScopInfo::buildAccessSingleDim(
4023 MemAccInst Inst, Loop *L, Region *R,
4024 const ScopDetection::BoxedLoopsSetTy *BoxedLoops,
4025 const InvariantLoadsSetTy &ScopRIL) {
4026 Value *Address = Inst.getPointerOperand();
4027 Value *Val = Inst.getValueOperand();
Johannes Doerfertcea61932016-02-21 19:13:19 +00004028 Type *ElementType = Val->getType();
Tobias Grosserdb543ed2016-02-02 16:46:49 +00004029 enum MemoryAccess::AccessType Type =
Hongbin Zheng8efb22e2016-02-27 01:49:58 +00004030 isa<LoadInst>(Inst) ? MemoryAccess::READ : MemoryAccess::MUST_WRITE;
Tobias Grosserdb543ed2016-02-02 16:46:49 +00004031
4032 const SCEV *AccessFunction = SE->getSCEVAtScope(Address, L);
4033 const SCEVUnknown *BasePointer =
4034 dyn_cast<SCEVUnknown>(SE->getPointerBase(AccessFunction));
4035
4036 assert(BasePointer && "Could not find base pointer");
4037 AccessFunction = SE->getMinusSCEV(AccessFunction, BasePointer);
Michael Kruse7bf39442015-09-10 12:46:52 +00004038
4039 // Check if the access depends on a loop contained in a non-affine subregion.
4040 bool isVariantInNonAffineLoop = false;
4041 if (BoxedLoops) {
4042 SetVector<const Loop *> Loops;
4043 findLoops(AccessFunction, Loops);
4044 for (const Loop *L : Loops)
4045 if (BoxedLoops->count(L))
4046 isVariantInNonAffineLoop = true;
4047 }
4048
Johannes Doerfert09e36972015-10-07 20:17:36 +00004049 InvariantLoadsSetTy AccessILS;
Michael Kruse09eb4452016-03-03 22:10:47 +00004050 bool IsAffine = !isVariantInNonAffineLoop &&
4051 isAffineExpr(R, L, AccessFunction, *SE,
4052 BasePointer->getValue(), &AccessILS);
Johannes Doerfert09e36972015-10-07 20:17:36 +00004053
4054 for (LoadInst *LInst : AccessILS)
4055 if (!ScopRIL.count(LInst))
4056 IsAffine = false;
Michael Kruse7bf39442015-09-10 12:46:52 +00004057
Michael Krusee2bccbb2015-09-18 19:59:43 +00004058 if (!IsAffine && Type == MemoryAccess::MUST_WRITE)
4059 Type = MemoryAccess::MAY_WRITE;
Michael Kruse7bf39442015-09-10 12:46:52 +00004060
Johannes Doerfertcea61932016-02-21 19:13:19 +00004061 addArrayAccess(Inst, Type, BasePointer->getValue(), ElementType, IsAffine,
Tobias Grosser5d51afe2016-02-02 16:46:45 +00004062 {AccessFunction}, {}, Val);
Michael Kruse7bf39442015-09-10 12:46:52 +00004063}
4064
Tobias Grosserdb543ed2016-02-02 16:46:49 +00004065void ScopInfo::buildMemoryAccess(
4066 MemAccInst Inst, Loop *L, Region *R,
4067 const ScopDetection::BoxedLoopsSetTy *BoxedLoops,
Hongbin Zheng22623202016-02-15 00:20:58 +00004068 const InvariantLoadsSetTy &ScopRIL, const MapInsnToMemAcc &InsnToMemAcc) {
Tobias Grosserdb543ed2016-02-02 16:46:49 +00004069
Johannes Doerfertcea61932016-02-21 19:13:19 +00004070 if (buildAccessMemIntrinsic(Inst, L, R, BoxedLoops, ScopRIL))
4071 return;
4072
Johannes Doerferta7920982016-02-25 14:08:48 +00004073 if (buildAccessCallInst(Inst, L, R, BoxedLoops, ScopRIL))
4074 return;
4075
Tobias Grosserdb543ed2016-02-02 16:46:49 +00004076 if (buildAccessMultiDimFixed(Inst, L, R, BoxedLoops, ScopRIL))
4077 return;
4078
Hongbin Zheng22623202016-02-15 00:20:58 +00004079 if (buildAccessMultiDimParam(Inst, L, R, BoxedLoops, ScopRIL, InsnToMemAcc))
Tobias Grosserdb543ed2016-02-02 16:46:49 +00004080 return;
4081
4082 buildAccessSingleDim(Inst, L, R, BoxedLoops, ScopRIL);
4083}
4084
Hongbin Zheng22623202016-02-15 00:20:58 +00004085void ScopInfo::buildAccessFunctions(Region &R, Region &SR,
4086 const MapInsnToMemAcc &InsnToMemAcc) {
Michael Kruse7bf39442015-09-10 12:46:52 +00004087
4088 if (SD->isNonAffineSubRegion(&SR, &R)) {
4089 for (BasicBlock *BB : SR.blocks())
Hongbin Zheng22623202016-02-15 00:20:58 +00004090 buildAccessFunctions(R, *BB, InsnToMemAcc, &SR);
Michael Kruse7bf39442015-09-10 12:46:52 +00004091 return;
4092 }
4093
4094 for (auto I = SR.element_begin(), E = SR.element_end(); I != E; ++I)
4095 if (I->isSubRegion())
Hongbin Zheng22623202016-02-15 00:20:58 +00004096 buildAccessFunctions(R, *I->getNodeAs<Region>(), InsnToMemAcc);
Michael Kruse7bf39442015-09-10 12:46:52 +00004097 else
Hongbin Zheng22623202016-02-15 00:20:58 +00004098 buildAccessFunctions(R, *I->getNodeAs<BasicBlock>(), InsnToMemAcc);
Michael Kruse7bf39442015-09-10 12:46:52 +00004099}
4100
Johannes Doerferta8781032016-02-02 14:14:40 +00004101void ScopInfo::buildStmts(Region &R, Region &SR) {
Michael Krusecac948e2015-10-02 13:53:07 +00004102
Johannes Doerferta8781032016-02-02 14:14:40 +00004103 if (SD->isNonAffineSubRegion(&SR, &R)) {
Michael Krusecac948e2015-10-02 13:53:07 +00004104 scop->addScopStmt(nullptr, &SR);
4105 return;
4106 }
4107
4108 for (auto I = SR.element_begin(), E = SR.element_end(); I != E; ++I)
4109 if (I->isSubRegion())
Johannes Doerferta8781032016-02-02 14:14:40 +00004110 buildStmts(R, *I->getNodeAs<Region>());
Michael Krusecac948e2015-10-02 13:53:07 +00004111 else
4112 scop->addScopStmt(I->getNodeAs<BasicBlock>(), nullptr);
4113}
4114
Michael Krused868b5d2015-09-10 15:25:24 +00004115void ScopInfo::buildAccessFunctions(Region &R, BasicBlock &BB,
Hongbin Zheng22623202016-02-15 00:20:58 +00004116 const MapInsnToMemAcc &InsnToMemAcc,
Michael Krused868b5d2015-09-10 15:25:24 +00004117 Region *NonAffineSubRegion,
4118 bool IsExitBlock) {
Tobias Grosser910cf262015-11-11 20:15:49 +00004119 // We do not build access functions for error blocks, as they may contain
4120 // instructions we can not model.
Johannes Doerfertc36d39b2016-02-02 14:14:20 +00004121 if (isErrorBlock(BB, R, *LI, *DT) && !IsExitBlock)
Tobias Grosser910cf262015-11-11 20:15:49 +00004122 return;
4123
Michael Kruse7bf39442015-09-10 12:46:52 +00004124 Loop *L = LI->getLoopFor(&BB);
4125
4126 // The set of loops contained in non-affine subregions that are part of R.
4127 const ScopDetection::BoxedLoopsSetTy *BoxedLoops = SD->getBoxedLoops(&R);
4128
Johannes Doerfert09e36972015-10-07 20:17:36 +00004129 // The set of loads that are required to be invariant.
4130 auto &ScopRIL = *SD->getRequiredInvariantLoads(&R);
4131
Michael Kruse2e02d562016-02-06 09:19:40 +00004132 for (Instruction &Inst : BB) {
4133 PHINode *PHI = dyn_cast<PHINode>(&Inst);
Michael Kruse7bf39442015-09-10 12:46:52 +00004134 if (PHI)
Michael Krusee2bccbb2015-09-18 19:59:43 +00004135 buildPHIAccesses(PHI, R, NonAffineSubRegion, IsExitBlock);
Michael Kruse7bf39442015-09-10 12:46:52 +00004136
4137 // For the exit block we stop modeling after the last PHI node.
4138 if (!PHI && IsExitBlock)
4139 break;
4140
Johannes Doerfert09e36972015-10-07 20:17:36 +00004141 // TODO: At this point we only know that elements of ScopRIL have to be
4142 // invariant and will be hoisted for the SCoP to be processed. Though,
4143 // there might be other invariant accesses that will be hoisted and
4144 // that would allow to make a non-affine access affine.
Michael Kruse70131d32016-01-27 17:09:17 +00004145 if (auto MemInst = MemAccInst::dyn_cast(Inst))
Hongbin Zheng22623202016-02-15 00:20:58 +00004146 buildMemoryAccess(MemInst, L, &R, BoxedLoops, ScopRIL, InsnToMemAcc);
Michael Kruse7bf39442015-09-10 12:46:52 +00004147
Michael Kruse2e02d562016-02-06 09:19:40 +00004148 if (isIgnoredIntrinsic(&Inst))
Michael Kruse7bf39442015-09-10 12:46:52 +00004149 continue;
4150
Tobias Grosser0904c692016-03-16 23:33:54 +00004151 // PHI nodes have already been modeled above and TerminatorInsts that are
4152 // not part of a non-affine subregion are fully modeled and regenerated
4153 // from the polyhedral domains. Hence, they do not need to be modeled as
4154 // explicit data dependences.
4155 if (!PHI && (!isa<TerminatorInst>(&Inst) || NonAffineSubRegion))
Michael Kruse2e02d562016-02-06 09:19:40 +00004156 buildScalarDependences(&Inst);
Tobias Grosser0904c692016-03-16 23:33:54 +00004157
Michael Kruse2e02d562016-02-06 09:19:40 +00004158 if (!IsExitBlock)
4159 buildEscapingDependences(&Inst);
Michael Kruse7bf39442015-09-10 12:46:52 +00004160 }
Michael Krusee2bccbb2015-09-18 19:59:43 +00004161}
Michael Kruse7bf39442015-09-10 12:46:52 +00004162
Michael Kruseee6a4fc2016-01-26 13:33:27 +00004163MemoryAccess *ScopInfo::addMemoryAccess(BasicBlock *BB, Instruction *Inst,
Johannes Doerfertcea61932016-02-21 19:13:19 +00004164 MemoryAccess::AccessType AccType,
4165 Value *BaseAddress, Type *ElementType,
Michael Kruseee6a4fc2016-01-26 13:33:27 +00004166 bool Affine, Value *AccessValue,
4167 ArrayRef<const SCEV *> Subscripts,
4168 ArrayRef<const SCEV *> Sizes,
4169 ScopArrayInfo::MemoryKind Kind) {
Michael Kruse6f7721f2016-02-24 22:08:19 +00004170 ScopStmt *Stmt = scop->getStmtFor(BB);
Michael Krusecac948e2015-10-02 13:53:07 +00004171
4172 // Do not create a memory access for anything not in the SCoP. It would be
4173 // ignored anyway.
4174 if (!Stmt)
Michael Kruseee6a4fc2016-01-26 13:33:27 +00004175 return nullptr;
Michael Krusecac948e2015-10-02 13:53:07 +00004176
Hongbin Zheng660f3cc2016-02-13 15:12:58 +00004177 AccFuncSetType &AccList = scop->getOrCreateAccessFunctions(BB);
Michael Krusee2bccbb2015-09-18 19:59:43 +00004178 Value *BaseAddr = BaseAddress;
4179 std::string BaseName = getIslCompatibleName("MemRef_", BaseAddr, "");
4180
Tobias Grosserf4f68702015-12-14 15:05:37 +00004181 bool isKnownMustAccess = false;
4182
4183 // Accesses in single-basic block statements are always excuted.
4184 if (Stmt->isBlockStmt())
4185 isKnownMustAccess = true;
4186
4187 if (Stmt->isRegionStmt()) {
4188 // Accesses that dominate the exit block of a non-affine region are always
4189 // executed. In non-affine regions there may exist MK_Values that do not
4190 // dominate the exit. MK_Values will always dominate the exit and MK_PHIs
4191 // only if there is at most one PHI_WRITE in the non-affine region.
4192 if (DT->dominates(BB, Stmt->getRegion()->getExit()))
4193 isKnownMustAccess = true;
4194 }
4195
Michael Kruseee6a4fc2016-01-26 13:33:27 +00004196 // Non-affine PHI writes do not "happen" at a particular instruction, but
4197 // after exiting the statement. Therefore they are guaranteed execute and
4198 // overwrite the old value.
4199 if (Kind == ScopArrayInfo::MK_PHI || Kind == ScopArrayInfo::MK_ExitPHI)
4200 isKnownMustAccess = true;
4201
Johannes Doerfertcea61932016-02-21 19:13:19 +00004202 if (!isKnownMustAccess && AccType == MemoryAccess::MUST_WRITE)
4203 AccType = MemoryAccess::MAY_WRITE;
Michael Krusecac948e2015-10-02 13:53:07 +00004204
Johannes Doerfertcea61932016-02-21 19:13:19 +00004205 AccList.emplace_back(Stmt, Inst, AccType, BaseAddress, ElementType, Affine,
Tobias Grossera535dff2015-12-13 19:59:01 +00004206 Subscripts, Sizes, AccessValue, Kind, BaseName);
Michael Krusecac948e2015-10-02 13:53:07 +00004207 Stmt->addAccess(&AccList.back());
Michael Kruseee6a4fc2016-01-26 13:33:27 +00004208 return &AccList.back();
Michael Kruse7bf39442015-09-10 12:46:52 +00004209}
4210
Michael Kruse70131d32016-01-27 17:09:17 +00004211void ScopInfo::addArrayAccess(MemAccInst MemAccInst,
Johannes Doerfertcea61932016-02-21 19:13:19 +00004212 MemoryAccess::AccessType AccType,
4213 Value *BaseAddress, Type *ElementType,
4214 bool IsAffine, ArrayRef<const SCEV *> Subscripts,
Tobias Grossera535dff2015-12-13 19:59:01 +00004215 ArrayRef<const SCEV *> Sizes,
4216 Value *AccessValue) {
Johannes Doerferta7920982016-02-25 14:08:48 +00004217 ArrayBasePointers.insert(BaseAddress);
Hongbin Zhengf3d66122016-02-26 09:47:11 +00004218 addMemoryAccess(MemAccInst->getParent(), MemAccInst, AccType, BaseAddress,
Johannes Doerfertcea61932016-02-21 19:13:19 +00004219 ElementType, IsAffine, AccessValue, Subscripts, Sizes,
Tobias Grossera535dff2015-12-13 19:59:01 +00004220 ScopArrayInfo::MK_Array);
Michael Kruse33d6c0b2015-09-25 18:53:27 +00004221}
Johannes Doerfertb92e2182016-02-21 16:37:58 +00004222
Johannes Doerfert68898ce2016-02-21 16:36:21 +00004223void ScopInfo::ensureValueWrite(Instruction *Inst) {
Michael Kruse6f7721f2016-02-24 22:08:19 +00004224 ScopStmt *Stmt = scop->getStmtFor(Inst);
Michael Kruse436db622016-01-26 13:33:10 +00004225
Johannes Doerfert68898ce2016-02-21 16:36:21 +00004226 // Inst not defined within this SCoP.
Michael Kruse436db622016-01-26 13:33:10 +00004227 if (!Stmt)
4228 return;
4229
Johannes Doerfert68898ce2016-02-21 16:36:21 +00004230 // Do not process further if the instruction is already written.
4231 if (Stmt->lookupValueWriteOf(Inst))
Michael Kruse436db622016-01-26 13:33:10 +00004232 return;
4233
Johannes Doerfertcea61932016-02-21 19:13:19 +00004234 addMemoryAccess(Inst->getParent(), Inst, MemoryAccess::MUST_WRITE, Inst,
4235 Inst->getType(), true, Inst, ArrayRef<const SCEV *>(),
Tobias Grossera535dff2015-12-13 19:59:01 +00004236 ArrayRef<const SCEV *>(), ScopArrayInfo::MK_Value);
Michael Kruse33d6c0b2015-09-25 18:53:27 +00004237}
Johannes Doerfertb92e2182016-02-21 16:37:58 +00004238
Johannes Doerfert68898ce2016-02-21 16:36:21 +00004239void ScopInfo::ensureValueRead(Value *V, BasicBlock *UserBB) {
Michael Krusefd463082016-01-27 22:51:56 +00004240
Michael Kruse2e02d562016-02-06 09:19:40 +00004241 // There cannot be an "access" for literal constants. BasicBlock references
4242 // (jump destinations) also never change.
Johannes Doerfert68898ce2016-02-21 16:36:21 +00004243 if ((isa<Constant>(V) && !isa<GlobalVariable>(V)) || isa<BasicBlock>(V))
Michael Kruse2e02d562016-02-06 09:19:40 +00004244 return;
4245
Michael Krusefd463082016-01-27 22:51:56 +00004246 // If the instruction can be synthesized and the user is in the region we do
4247 // not need to add a value dependences.
4248 Region &ScopRegion = scop->getRegion();
Michael Krusec7e0d9c2016-03-01 21:44:06 +00004249 auto *Scope = LI->getLoopFor(UserBB);
4250 if (canSynthesize(V, LI, SE, &ScopRegion, Scope))
Michael Krusefd463082016-01-27 22:51:56 +00004251 return;
4252
Michael Kruse2e02d562016-02-06 09:19:40 +00004253 // Do not build scalar dependences for required invariant loads as we will
4254 // hoist them later on anyway or drop the SCoP if we cannot.
Johannes Doerferta90943d2016-02-21 16:37:25 +00004255 auto *ScopRIL = SD->getRequiredInvariantLoads(&ScopRegion);
Johannes Doerfert68898ce2016-02-21 16:36:21 +00004256 if (ScopRIL->count(dyn_cast<LoadInst>(V)))
Michael Kruse2e02d562016-02-06 09:19:40 +00004257 return;
4258
4259 // Determine the ScopStmt containing the value's definition and use. There is
4260 // no defining ScopStmt if the value is a function argument, a global value,
4261 // or defined outside the SCoP.
Johannes Doerfert68898ce2016-02-21 16:36:21 +00004262 Instruction *ValueInst = dyn_cast<Instruction>(V);
Michael Kruse6f7721f2016-02-24 22:08:19 +00004263 ScopStmt *ValueStmt = ValueInst ? scop->getStmtFor(ValueInst) : nullptr;
Michael Kruse2e02d562016-02-06 09:19:40 +00004264
Michael Kruse6f7721f2016-02-24 22:08:19 +00004265 ScopStmt *UserStmt = scop->getStmtFor(UserBB);
Michael Krusead28e5a2016-01-26 13:33:15 +00004266
4267 // We do not model uses outside the scop.
4268 if (!UserStmt)
4269 return;
4270
Michael Kruse2e02d562016-02-06 09:19:40 +00004271 // Add MemoryAccess for invariant values only if requested.
4272 if (!ModelReadOnlyScalars && !ValueStmt)
4273 return;
4274
4275 // Ignore use-def chains within the same ScopStmt.
4276 if (ValueStmt == UserStmt)
4277 return;
4278
Michael Krusead28e5a2016-01-26 13:33:15 +00004279 // Do not create another MemoryAccess for reloading the value if one already
4280 // exists.
Johannes Doerfert68898ce2016-02-21 16:36:21 +00004281 if (UserStmt->lookupValueReadOf(V))
Michael Krusead28e5a2016-01-26 13:33:15 +00004282 return;
4283
Johannes Doerfertcea61932016-02-21 19:13:19 +00004284 addMemoryAccess(UserBB, nullptr, MemoryAccess::READ, V, V->getType(), true, V,
Michael Kruse8d0b7342015-09-25 21:21:00 +00004285 ArrayRef<const SCEV *>(), ArrayRef<const SCEV *>(),
Tobias Grossera535dff2015-12-13 19:59:01 +00004286 ScopArrayInfo::MK_Value);
Michael Kruse2e02d562016-02-06 09:19:40 +00004287 if (ValueInst)
4288 ensureValueWrite(ValueInst);
Michael Kruse33d6c0b2015-09-25 18:53:27 +00004289}
Johannes Doerfertb92e2182016-02-21 16:37:58 +00004290
Michael Kruseee6a4fc2016-01-26 13:33:27 +00004291void ScopInfo::ensurePHIWrite(PHINode *PHI, BasicBlock *IncomingBlock,
4292 Value *IncomingValue, bool IsExitBlock) {
Michael Kruse6f7721f2016-02-24 22:08:19 +00004293 ScopStmt *IncomingStmt = scop->getStmtFor(IncomingBlock);
Michael Kruse2e02d562016-02-06 09:19:40 +00004294 if (!IncomingStmt)
4295 return;
4296
4297 // Take care for the incoming value being available in the incoming block.
4298 // This must be done before the check for multiple PHI writes because multiple
4299 // exiting edges from subregion each can be the effective written value of the
4300 // subregion. As such, all of them must be made available in the subregion
4301 // statement.
4302 ensureValueRead(IncomingValue, IncomingBlock);
Michael Kruseee6a4fc2016-01-26 13:33:27 +00004303
4304 // Do not add more than one MemoryAccess per PHINode and ScopStmt.
4305 if (MemoryAccess *Acc = IncomingStmt->lookupPHIWriteOf(PHI)) {
4306 assert(Acc->getAccessInstruction() == PHI);
4307 Acc->addIncoming(IncomingBlock, IncomingValue);
4308 return;
4309 }
4310
4311 MemoryAccess *Acc = addMemoryAccess(
Michael Kruse375cb5f2016-02-24 22:08:24 +00004312 IncomingStmt->getEntryBlock(), PHI, MemoryAccess::MUST_WRITE, PHI,
4313 PHI->getType(), true, PHI, ArrayRef<const SCEV *>(),
4314 ArrayRef<const SCEV *>(),
Michael Kruseee6a4fc2016-01-26 13:33:27 +00004315 IsExitBlock ? ScopArrayInfo::MK_ExitPHI : ScopArrayInfo::MK_PHI);
4316 assert(Acc);
4317 Acc->addIncoming(IncomingBlock, IncomingValue);
Michael Kruse33d6c0b2015-09-25 18:53:27 +00004318}
Johannes Doerfertb92e2182016-02-21 16:37:58 +00004319
Michael Kruse33d6c0b2015-09-25 18:53:27 +00004320void ScopInfo::addPHIReadAccess(PHINode *PHI) {
Johannes Doerfertcea61932016-02-21 19:13:19 +00004321 addMemoryAccess(PHI->getParent(), PHI, MemoryAccess::READ, PHI,
4322 PHI->getType(), true, PHI, ArrayRef<const SCEV *>(),
4323 ArrayRef<const SCEV *>(), ScopArrayInfo::MK_PHI);
Michael Kruse33d6c0b2015-09-25 18:53:27 +00004324}
4325
Michael Krusedaf66942015-12-13 22:10:37 +00004326void ScopInfo::buildScop(Region &R, AssumptionCache &AC) {
Michael Kruse9d080092015-09-11 21:41:48 +00004327 unsigned MaxLoopDepth = getMaxLoopDepthInRegion(R, *LI, *SD);
Michael Kruse09eb4452016-03-03 22:10:47 +00004328 scop.reset(new Scop(R, *SE, *LI, MaxLoopDepth));
Michael Kruse7bf39442015-09-10 12:46:52 +00004329
Johannes Doerferta8781032016-02-02 14:14:40 +00004330 buildStmts(R, R);
Hongbin Zheng22623202016-02-15 00:20:58 +00004331 buildAccessFunctions(R, R, *SD->getInsnToMemAccMap(&R));
Michael Kruse7bf39442015-09-10 12:46:52 +00004332
4333 // In case the region does not have an exiting block we will later (during
4334 // code generation) split the exit block. This will move potential PHI nodes
4335 // from the current exit block into the new region exiting block. Hence, PHI
4336 // nodes that are at this point not part of the region will be.
4337 // To handle these PHI nodes later we will now model their operands as scalar
4338 // accesses. Note that we do not model anything in the exit block if we have
4339 // an exiting block in the region, as there will not be any splitting later.
4340 if (!R.getExitingBlock())
Hongbin Zheng22623202016-02-15 00:20:58 +00004341 buildAccessFunctions(R, *R.getExit(), *SD->getInsnToMemAccMap(&R), nullptr,
4342 /* IsExitBlock */ true);
Michael Kruse7bf39442015-09-10 12:46:52 +00004343
Johannes Doerferta7920982016-02-25 14:08:48 +00004344 // Create memory accesses for global reads since all arrays are now known.
4345 auto *AF = SE->getConstant(IntegerType::getInt64Ty(SE->getContext()), 0);
4346 for (auto *GlobalRead : GlobalReads)
4347 for (auto *BP : ArrayBasePointers)
4348 addArrayAccess(MemAccInst(GlobalRead), MemoryAccess::READ, BP,
4349 BP->getType(), false, {AF}, {}, GlobalRead);
4350
Hongbin Zheng192f69a2016-02-13 15:12:54 +00004351 scop->init(*AA, AC, *SD, *DT, *LI);
Michael Kruse7bf39442015-09-10 12:46:52 +00004352}
4353
Michael Krused868b5d2015-09-10 15:25:24 +00004354void ScopInfo::print(raw_ostream &OS, const Module *) const {
Michael Kruse9d080092015-09-11 21:41:48 +00004355 if (!scop) {
Michael Krused868b5d2015-09-10 15:25:24 +00004356 OS << "Invalid Scop!\n";
Michael Kruse9d080092015-09-11 21:41:48 +00004357 return;
4358 }
4359
Michael Kruse9d080092015-09-11 21:41:48 +00004360 scop->print(OS);
Michael Kruse7bf39442015-09-10 12:46:52 +00004361}
4362
Hongbin Zhengfec32802016-02-13 15:13:02 +00004363void ScopInfo::clear() { scop.reset(); }
Michael Kruse7bf39442015-09-10 12:46:52 +00004364
4365//===----------------------------------------------------------------------===//
Hongbin Zheng8831eb72016-02-17 15:49:21 +00004366ScopInfo::ScopInfo() : RegionPass(ID) {}
Tobias Grosserb76f38532011-08-20 11:11:25 +00004367
Hongbin Zheng8831eb72016-02-17 15:49:21 +00004368ScopInfo::~ScopInfo() { clear(); }
Tobias Grosserb76f38532011-08-20 11:11:25 +00004369
Tobias Grosser75805372011-04-29 06:27:02 +00004370void ScopInfo::getAnalysisUsage(AnalysisUsage &AU) const {
Chandler Carruthf5579872015-01-17 14:16:56 +00004371 AU.addRequired<LoopInfoWrapperPass>();
Matt Arsenault8ca36812014-07-19 18:40:17 +00004372 AU.addRequired<RegionInfoPass>();
Johannes Doerfert96425c22015-08-30 21:13:53 +00004373 AU.addRequired<DominatorTreeWrapperPass>();
Michael Krused868b5d2015-09-10 15:25:24 +00004374 AU.addRequiredTransitive<ScalarEvolutionWrapperPass>();
4375 AU.addRequiredTransitive<ScopDetection>();
Chandler Carruth66ef16b2015-09-09 22:13:56 +00004376 AU.addRequired<AAResultsWrapperPass>();
Johannes Doerfert2af10e22015-11-12 03:25:01 +00004377 AU.addRequired<AssumptionCacheTracker>();
Tobias Grosser75805372011-04-29 06:27:02 +00004378 AU.setPreservesAll();
4379}
4380
4381bool ScopInfo::runOnRegion(Region *R, RGPassManager &RGM) {
Michael Krused868b5d2015-09-10 15:25:24 +00004382 SD = &getAnalysis<ScopDetection>();
Tobias Grosser75805372011-04-29 06:27:02 +00004383
Michael Krused868b5d2015-09-10 15:25:24 +00004384 if (!SD->isMaxRegionInScop(*R))
4385 return false;
4386
4387 Function *F = R->getEntry()->getParent();
4388 SE = &getAnalysis<ScalarEvolutionWrapperPass>().getSE();
4389 LI = &getAnalysis<LoopInfoWrapperPass>().getLoopInfo();
4390 AA = &getAnalysis<AAResultsWrapperPass>().getAAResults();
Johannes Doerferta1f291e2016-02-02 14:15:13 +00004391 DL = &F->getParent()->getDataLayout();
Michael Krusedaf66942015-12-13 22:10:37 +00004392 DT = &getAnalysis<DominatorTreeWrapperPass>().getDomTree();
Johannes Doerfert2af10e22015-11-12 03:25:01 +00004393 auto &AC = getAnalysis<AssumptionCacheTracker>().getAssumptionCache(*F);
Michael Krused868b5d2015-09-10 15:25:24 +00004394
Johannes Doerfert48fe86f2015-11-12 02:32:32 +00004395 DebugLoc Beg, End;
4396 getDebugLocations(R, Beg, End);
4397 std::string Msg = "SCoP begins here.";
4398 emitOptimizationRemarkAnalysis(F->getContext(), DEBUG_TYPE, *F, Beg, Msg);
4399
Michael Krusedaf66942015-12-13 22:10:37 +00004400 buildScop(*R, AC);
Tobias Grosser75805372011-04-29 06:27:02 +00004401
Tobias Grosserd6a50b32015-05-30 06:26:21 +00004402 DEBUG(scop->print(dbgs()));
4403
Michael Kruseafe06702015-10-02 16:33:27 +00004404 if (scop->isEmpty() || !scop->hasFeasibleRuntimeContext()) {
Johannes Doerfert48fe86f2015-11-12 02:32:32 +00004405 Msg = "SCoP ends here but was dismissed.";
Hongbin Zhengfec32802016-02-13 15:13:02 +00004406 scop.reset();
Johannes Doerfert48fe86f2015-11-12 02:32:32 +00004407 } else {
4408 Msg = "SCoP ends here.";
4409 ++ScopFound;
4410 if (scop->getMaxLoopDepth() > 0)
4411 ++RichScopFound;
Johannes Doerfert43788c52015-08-20 05:58:56 +00004412 }
4413
Johannes Doerfert48fe86f2015-11-12 02:32:32 +00004414 emitOptimizationRemarkAnalysis(F->getContext(), DEBUG_TYPE, *F, End, Msg);
4415
Tobias Grosser75805372011-04-29 06:27:02 +00004416 return false;
4417}
4418
4419char ScopInfo::ID = 0;
4420
Tobias Grosser4d96c8d2013-03-23 01:05:07 +00004421Pass *polly::createScopInfoPass() { return new ScopInfo(); }
4422
Tobias Grosser73600b82011-10-08 00:30:40 +00004423INITIALIZE_PASS_BEGIN(ScopInfo, "polly-scops",
4424 "Polly - Create polyhedral description of Scops", false,
Tobias Grosser4d96c8d2013-03-23 01:05:07 +00004425 false);
Chandler Carruth66ef16b2015-09-09 22:13:56 +00004426INITIALIZE_PASS_DEPENDENCY(AAResultsWrapperPass);
Johannes Doerfert2af10e22015-11-12 03:25:01 +00004427INITIALIZE_PASS_DEPENDENCY(AssumptionCacheTracker);
Chandler Carruthf5579872015-01-17 14:16:56 +00004428INITIALIZE_PASS_DEPENDENCY(LoopInfoWrapperPass);
Matt Arsenault8ca36812014-07-19 18:40:17 +00004429INITIALIZE_PASS_DEPENDENCY(RegionInfoPass);
Tobias Grosserc5bcf242015-08-17 10:57:08 +00004430INITIALIZE_PASS_DEPENDENCY(ScalarEvolutionWrapperPass);
Johannes Doerfertff9d1982015-02-24 12:00:50 +00004431INITIALIZE_PASS_DEPENDENCY(ScopDetection);
Johannes Doerfert96425c22015-08-30 21:13:53 +00004432INITIALIZE_PASS_DEPENDENCY(DominatorTreeWrapperPass);
Tobias Grosser73600b82011-10-08 00:30:40 +00004433INITIALIZE_PASS_END(ScopInfo, "polly-scops",
4434 "Polly - Create polyhedral description of Scops", false,
4435 false)