blob: 71584ffdef5cd8dc2e87fcc19e170543a92aec76 [file] [log] [blame]
Johannes Doerfert58a7c752015-09-28 09:48:53 +00001//===--------- ScopInfo.cpp - Create Scops from LLVM IR ------------------===//
Tobias Grosser75805372011-04-29 06:27:02 +00002//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
10// Create a polyhedral description for a static control flow region.
11//
12// The pass creates a polyhedral description of the Scops detected by the Scop
13// detection derived from their LLVM-IR code.
14//
Tobias Grossera5605d32014-10-29 19:58:28 +000015// This representation is shared among several tools in the polyhedral
Tobias Grosser75805372011-04-29 06:27:02 +000016// community, which are e.g. Cloog, Pluto, Loopo, Graphite.
17//
18//===----------------------------------------------------------------------===//
19
Tobias Grosser5624d3c2015-12-21 12:38:56 +000020#include "polly/ScopInfo.h"
Tobias Grosser75805372011-04-29 06:27:02 +000021#include "polly/LinkAllPasses.h"
Johannes Doerfert0ee1f212014-06-17 17:31:36 +000022#include "polly/Options.h"
Tobias Grosser75805372011-04-29 06:27:02 +000023#include "polly/Support/GICHelper.h"
Tobias Grosser60b54f12011-11-08 15:41:28 +000024#include "polly/Support/SCEVValidator.h"
Tobias Grosser83628182013-05-07 08:11:54 +000025#include "polly/Support/ScopHelper.h"
Tobias Grosser9737c7b2015-11-22 11:06:51 +000026#include "llvm/ADT/DepthFirstIterator.h"
Tobias Grosserf4c24b22015-04-05 13:11:54 +000027#include "llvm/ADT/MapVector.h"
Tobias Grosserc2bb0cb2015-09-25 09:49:19 +000028#include "llvm/ADT/PostOrderIterator.h"
29#include "llvm/ADT/STLExtras.h"
Tobias Grosserba0d0922015-05-09 09:13:42 +000030#include "llvm/ADT/SetVector.h"
Tobias Grosser83628182013-05-07 08:11:54 +000031#include "llvm/ADT/Statistic.h"
Hongbin Zheng86a37742012-04-25 08:01:38 +000032#include "llvm/ADT/StringExtras.h"
Johannes Doerfertb164c792014-09-18 11:17:17 +000033#include "llvm/Analysis/AliasAnalysis.h"
Johannes Doerfert2af10e22015-11-12 03:25:01 +000034#include "llvm/Analysis/AssumptionCache.h"
Tobias Grosserba0d0922015-05-09 09:13:42 +000035#include "llvm/Analysis/LoopInfo.h"
Tobias Grosserc2bb0cb2015-09-25 09:49:19 +000036#include "llvm/Analysis/LoopIterator.h"
Tobias Grosser83628182013-05-07 08:11:54 +000037#include "llvm/Analysis/RegionIterator.h"
38#include "llvm/Analysis/ScalarEvolutionExpressions.h"
Johannes Doerfert48fe86f2015-11-12 02:32:32 +000039#include "llvm/IR/DiagnosticInfo.h"
Tobias Grosser75805372011-04-29 06:27:02 +000040#include "llvm/Support/Debug.h"
Tobias Grosser33ba62ad2011-08-18 06:31:50 +000041#include "isl/aff.h"
Tobias Grosserba0d0922015-05-09 09:13:42 +000042#include "isl/constraint.h"
Tobias Grosserf5338802011-10-06 00:03:35 +000043#include "isl/local_space.h"
Tobias Grosserba0d0922015-05-09 09:13:42 +000044#include "isl/map.h"
Tobias Grosser4a8e3562011-12-07 07:42:51 +000045#include "isl/options.h"
Tobias Grosserba0d0922015-05-09 09:13:42 +000046#include "isl/printer.h"
Tobias Grosser808cd692015-07-14 09:33:13 +000047#include "isl/schedule.h"
48#include "isl/schedule_node.h"
Tobias Grosserba0d0922015-05-09 09:13:42 +000049#include "isl/set.h"
50#include "isl/union_map.h"
Tobias Grossercd524dc2015-05-09 09:36:38 +000051#include "isl/union_set.h"
Tobias Grosseredab1352013-06-21 06:41:31 +000052#include "isl/val.h"
Tobias Grosser75805372011-04-29 06:27:02 +000053#include <sstream>
54#include <string>
55#include <vector>
56
57using namespace llvm;
58using namespace polly;
59
Chandler Carruth95fef942014-04-22 03:30:19 +000060#define DEBUG_TYPE "polly-scops"
61
Tobias Grosser74394f02013-01-14 22:40:23 +000062STATISTIC(ScopFound, "Number of valid Scops");
63STATISTIC(RichScopFound, "Number of Scops containing a loop");
Tobias Grosser75805372011-04-29 06:27:02 +000064
Tobias Grosser75dc40c2015-12-20 13:31:48 +000065// The maximal number of basic sets we allow during domain construction to
66// be created. More complex scops will result in very high compile time and
67// are also unlikely to result in good code
68static int const MaxConjunctsInDomain = 20;
69
Michael Kruse7bf39442015-09-10 12:46:52 +000070static cl::opt<bool> ModelReadOnlyScalars(
71 "polly-analyze-read-only-scalars",
72 cl::desc("Model read-only scalar values in the scop description"),
73 cl::Hidden, cl::ZeroOrMore, cl::init(true), cl::cat(PollyCategory));
74
Johannes Doerfert9e7b17b2014-08-18 00:40:13 +000075// Multiplicative reductions can be disabled separately as these kind of
Johannes Doerfert0ee1f212014-06-17 17:31:36 +000076// operations can overflow easily. Additive reductions and bit operations
77// are in contrast pretty stable.
Tobias Grosser483a90d2014-07-09 10:50:10 +000078static cl::opt<bool> DisableMultiplicativeReductions(
79 "polly-disable-multiplicative-reductions",
80 cl::desc("Disable multiplicative reductions"), cl::Hidden, cl::ZeroOrMore,
81 cl::init(false), cl::cat(PollyCategory));
Johannes Doerfert0ee1f212014-06-17 17:31:36 +000082
Johannes Doerfert9143d672014-09-27 11:02:39 +000083static cl::opt<unsigned> RunTimeChecksMaxParameters(
84 "polly-rtc-max-parameters",
85 cl::desc("The maximal number of parameters allowed in RTCs."), cl::Hidden,
86 cl::ZeroOrMore, cl::init(8), cl::cat(PollyCategory));
87
Tobias Grosser71500722015-03-28 15:11:14 +000088static cl::opt<unsigned> RunTimeChecksMaxArraysPerGroup(
89 "polly-rtc-max-arrays-per-group",
90 cl::desc("The maximal number of arrays to compare in each alias group."),
91 cl::Hidden, cl::ZeroOrMore, cl::init(20), cl::cat(PollyCategory));
Tobias Grosser8a9c2352015-08-16 10:19:29 +000092static cl::opt<std::string> UserContextStr(
93 "polly-context", cl::value_desc("isl parameter set"),
94 cl::desc("Provide additional constraints on the context parameters"),
95 cl::init(""), cl::cat(PollyCategory));
Tobias Grosser71500722015-03-28 15:11:14 +000096
Tobias Grosserd83b8a82015-08-20 19:08:11 +000097static cl::opt<bool> DetectReductions("polly-detect-reductions",
98 cl::desc("Detect and exploit reductions"),
99 cl::Hidden, cl::ZeroOrMore,
100 cl::init(true), cl::cat(PollyCategory));
101
Tobias Grosser20a4c0c2015-11-11 16:22:36 +0000102static cl::opt<int> MaxDisjunctsAssumed(
103 "polly-max-disjuncts-assumed",
104 cl::desc("The maximal number of disjuncts we allow in the assumption "
105 "context (this bounds compile time)"),
106 cl::Hidden, cl::ZeroOrMore, cl::init(150), cl::cat(PollyCategory));
107
Tobias Grosser4927c8e2015-11-24 12:50:02 +0000108static cl::opt<bool> IgnoreIntegerWrapping(
109 "polly-ignore-integer-wrapping",
110 cl::desc("Do not build run-time checks to proof absence of integer "
111 "wrapping"),
112 cl::Hidden, cl::ZeroOrMore, cl::init(false), cl::cat(PollyCategory));
113
Michael Kruse7bf39442015-09-10 12:46:52 +0000114//===----------------------------------------------------------------------===//
Michael Kruse7bf39442015-09-10 12:46:52 +0000115
Michael Kruse046dde42015-08-10 13:01:57 +0000116// Create a sequence of two schedules. Either argument may be null and is
117// interpreted as the empty schedule. Can also return null if both schedules are
118// empty.
119static __isl_give isl_schedule *
120combineInSequence(__isl_take isl_schedule *Prev,
121 __isl_take isl_schedule *Succ) {
122 if (!Prev)
123 return Succ;
124 if (!Succ)
125 return Prev;
126
127 return isl_schedule_sequence(Prev, Succ);
128}
129
Johannes Doerferte7044942015-02-24 11:58:30 +0000130static __isl_give isl_set *addRangeBoundsToSet(__isl_take isl_set *S,
131 const ConstantRange &Range,
132 int dim,
133 enum isl_dim_type type) {
134 isl_val *V;
135 isl_ctx *ctx = isl_set_get_ctx(S);
136
Johannes Doerfert8f8af432015-04-26 20:07:21 +0000137 bool useLowerUpperBound = Range.isSignWrappedSet() && !Range.isFullSet();
138 const auto LB = useLowerUpperBound ? Range.getLower() : Range.getSignedMin();
Johannes Doerferte4bd53b2015-03-08 19:49:50 +0000139 V = isl_valFromAPInt(ctx, LB, true);
Johannes Doerferte7044942015-02-24 11:58:30 +0000140 isl_set *SLB = isl_set_lower_bound_val(isl_set_copy(S), type, dim, V);
141
Johannes Doerfert8f8af432015-04-26 20:07:21 +0000142 const auto UB = useLowerUpperBound ? Range.getUpper() : Range.getSignedMax();
Johannes Doerferte4bd53b2015-03-08 19:49:50 +0000143 V = isl_valFromAPInt(ctx, UB, true);
Johannes Doerfert8f8af432015-04-26 20:07:21 +0000144 if (useLowerUpperBound)
Johannes Doerferte4bd53b2015-03-08 19:49:50 +0000145 V = isl_val_sub_ui(V, 1);
Johannes Doerferte7044942015-02-24 11:58:30 +0000146 isl_set *SUB = isl_set_upper_bound_val(S, type, dim, V);
147
Johannes Doerfert8f8af432015-04-26 20:07:21 +0000148 if (useLowerUpperBound)
Johannes Doerferte7044942015-02-24 11:58:30 +0000149 return isl_set_union(SLB, SUB);
150 else
151 return isl_set_intersect(SLB, SUB);
152}
153
Johannes Doerfert4eed5be2015-08-20 18:04:22 +0000154static const ScopArrayInfo *identifyBasePtrOriginSAI(Scop *S, Value *BasePtr) {
155 LoadInst *BasePtrLI = dyn_cast<LoadInst>(BasePtr);
156 if (!BasePtrLI)
157 return nullptr;
158
159 if (!S->getRegion().contains(BasePtrLI))
160 return nullptr;
161
162 ScalarEvolution &SE = *S->getSE();
163
164 auto *OriginBaseSCEV =
165 SE.getPointerBase(SE.getSCEV(BasePtrLI->getPointerOperand()));
166 if (!OriginBaseSCEV)
167 return nullptr;
168
169 auto *OriginBaseSCEVUnknown = dyn_cast<SCEVUnknown>(OriginBaseSCEV);
170 if (!OriginBaseSCEVUnknown)
171 return nullptr;
172
Tobias Grosser6abc75a2015-11-10 17:31:31 +0000173 return S->getScopArrayInfo(OriginBaseSCEVUnknown->getValue(),
Tobias Grossera535dff2015-12-13 19:59:01 +0000174 ScopArrayInfo::MK_Array);
Johannes Doerfert4eed5be2015-08-20 18:04:22 +0000175}
176
Tobias Grosser49ad36c2015-05-20 08:05:31 +0000177ScopArrayInfo::ScopArrayInfo(Value *BasePtr, Type *ElementType, isl_ctx *Ctx,
Tobias Grossera535dff2015-12-13 19:59:01 +0000178 ArrayRef<const SCEV *> Sizes, enum MemoryKind Kind,
Johannes Doerfert55b3d8b2015-11-12 20:15:08 +0000179 const DataLayout &DL, Scop *S)
180 : BasePtr(BasePtr), ElementType(ElementType), Kind(Kind), DL(DL), S(*S) {
Tobias Grosser92245222015-07-28 14:53:44 +0000181 std::string BasePtrName =
Tobias Grossera535dff2015-12-13 19:59:01 +0000182 getIslCompatibleName("MemRef_", BasePtr, Kind == MK_PHI ? "__phi" : "");
Johannes Doerfert1a28a892014-10-05 11:32:18 +0000183 Id = isl_id_alloc(Ctx, BasePtrName.c_str(), this);
Johannes Doerfert4eed5be2015-08-20 18:04:22 +0000184
Johannes Doerfert3ff22212016-02-14 22:31:39 +0000185 updateSizes(Sizes);
Johannes Doerfert4eed5be2015-08-20 18:04:22 +0000186 BasePtrOriginSAI = identifyBasePtrOriginSAI(S, BasePtr);
187 if (BasePtrOriginSAI)
188 const_cast<ScopArrayInfo *>(BasePtrOriginSAI)->addDerivedSAI(this);
Johannes Doerfert1a28a892014-10-05 11:32:18 +0000189}
190
Tobias Grosser99c70dd2015-09-26 08:55:54 +0000191__isl_give isl_space *ScopArrayInfo::getSpace() const {
Johannes Doerferta90943d2016-02-21 16:37:25 +0000192 auto *Space =
Tobias Grosser99c70dd2015-09-26 08:55:54 +0000193 isl_space_set_alloc(isl_id_get_ctx(Id), 0, getNumberOfDimensions());
194 Space = isl_space_set_tuple_id(Space, isl_dim_set, isl_id_copy(Id));
195 return Space;
196}
197
Johannes Doerfert3ff22212016-02-14 22:31:39 +0000198void ScopArrayInfo::updateElementType(Type *NewElementType) {
199 if (NewElementType == ElementType)
200 return;
201
Tobias Grosserd840fc72016-02-04 13:18:42 +0000202 auto OldElementSize = DL.getTypeAllocSizeInBits(ElementType);
203 auto NewElementSize = DL.getTypeAllocSizeInBits(NewElementType);
204
Johannes Doerfert3ff22212016-02-14 22:31:39 +0000205 if (NewElementSize == OldElementSize)
206 return;
Tobias Grosserd840fc72016-02-04 13:18:42 +0000207
Johannes Doerfert3ff22212016-02-14 22:31:39 +0000208 if (NewElementSize % OldElementSize == 0 && NewElementSize < OldElementSize) {
209 ElementType = NewElementType;
210 } else {
211 auto GCD = GreatestCommonDivisor64(NewElementSize, OldElementSize);
212 ElementType = IntegerType::get(ElementType->getContext(), GCD);
213 }
214}
215
216bool ScopArrayInfo::updateSizes(ArrayRef<const SCEV *> NewSizes) {
Tobias Grosser99c70dd2015-09-26 08:55:54 +0000217 int SharedDims = std::min(NewSizes.size(), DimensionSizes.size());
218 int ExtraDimsNew = NewSizes.size() - SharedDims;
219 int ExtraDimsOld = DimensionSizes.size() - SharedDims;
Tobias Grosser8286b832015-11-02 11:29:32 +0000220 for (int i = 0; i < SharedDims; i++)
221 if (NewSizes[i + ExtraDimsNew] != DimensionSizes[i + ExtraDimsOld])
222 return false;
223
224 if (DimensionSizes.size() >= NewSizes.size())
225 return true;
Tobias Grosser99c70dd2015-09-26 08:55:54 +0000226
227 DimensionSizes.clear();
228 DimensionSizes.insert(DimensionSizes.begin(), NewSizes.begin(),
229 NewSizes.end());
230 for (isl_pw_aff *Size : DimensionSizesPw)
231 isl_pw_aff_free(Size);
232 DimensionSizesPw.clear();
233 for (const SCEV *Expr : DimensionSizes) {
234 isl_pw_aff *Size = S.getPwAff(Expr);
235 DimensionSizesPw.push_back(Size);
236 }
Tobias Grosser8286b832015-11-02 11:29:32 +0000237 return true;
Tobias Grosser99c70dd2015-09-26 08:55:54 +0000238}
239
Tobias Grosserd46fd5e2015-08-12 15:27:16 +0000240ScopArrayInfo::~ScopArrayInfo() {
241 isl_id_free(Id);
242 for (isl_pw_aff *Size : DimensionSizesPw)
243 isl_pw_aff_free(Size);
244}
Johannes Doerfert1a28a892014-10-05 11:32:18 +0000245
Tobias Grosser49ad36c2015-05-20 08:05:31 +0000246std::string ScopArrayInfo::getName() const { return isl_id_get_name(Id); }
247
248int ScopArrayInfo::getElemSizeInBytes() const {
Johannes Doerfert55b3d8b2015-11-12 20:15:08 +0000249 return DL.getTypeAllocSize(ElementType);
Tobias Grosser49ad36c2015-05-20 08:05:31 +0000250}
251
Johannes Doerfert1a28a892014-10-05 11:32:18 +0000252isl_id *ScopArrayInfo::getBasePtrId() const { return isl_id_copy(Id); }
253
254void ScopArrayInfo::dump() const { print(errs()); }
255
Tobias Grosserd46fd5e2015-08-12 15:27:16 +0000256void ScopArrayInfo::print(raw_ostream &OS, bool SizeAsPwAff) const {
Tobias Grosser4ea2e072015-11-10 14:02:54 +0000257 OS.indent(8) << *getElementType() << " " << getName();
258 if (getNumberOfDimensions() > 0)
259 OS << "[*]";
Tobias Grosser26253842015-11-10 14:24:21 +0000260 for (unsigned u = 1; u < getNumberOfDimensions(); u++) {
Tobias Grosserd46fd5e2015-08-12 15:27:16 +0000261 OS << "[";
262
Tobias Grosser26253842015-11-10 14:24:21 +0000263 if (SizeAsPwAff) {
Johannes Doerferta90943d2016-02-21 16:37:25 +0000264 auto *Size = getDimensionSizePw(u);
Tobias Grosser26253842015-11-10 14:24:21 +0000265 OS << " " << Size << " ";
266 isl_pw_aff_free(Size);
267 } else {
268 OS << *getDimensionSize(u);
269 }
Tobias Grosserd46fd5e2015-08-12 15:27:16 +0000270
271 OS << "]";
272 }
273
Tobias Grosser4ea2e072015-11-10 14:02:54 +0000274 OS << ";";
275
Johannes Doerfert4eed5be2015-08-20 18:04:22 +0000276 if (BasePtrOriginSAI)
277 OS << " [BasePtrOrigin: " << BasePtrOriginSAI->getName() << "]";
278
Tobias Grosser49ad36c2015-05-20 08:05:31 +0000279 OS << " // Element size " << getElemSizeInBytes() << "\n";
Johannes Doerfert1a28a892014-10-05 11:32:18 +0000280}
281
282const ScopArrayInfo *
283ScopArrayInfo::getFromAccessFunction(__isl_keep isl_pw_multi_aff *PMA) {
284 isl_id *Id = isl_pw_multi_aff_get_tuple_id(PMA, isl_dim_out);
285 assert(Id && "Output dimension didn't have an ID");
286 return getFromId(Id);
287}
288
289const ScopArrayInfo *ScopArrayInfo::getFromId(isl_id *Id) {
290 void *User = isl_id_get_user(Id);
291 const ScopArrayInfo *SAI = static_cast<ScopArrayInfo *>(User);
292 isl_id_free(Id);
293 return SAI;
294}
295
Tobias Grosser99c70dd2015-09-26 08:55:54 +0000296void MemoryAccess::updateDimensionality() {
Johannes Doerfert4d9bb8d2016-02-18 16:50:12 +0000297 auto *SAI = getScopArrayInfo();
Johannes Doerferta90943d2016-02-21 16:37:25 +0000298 auto *ArraySpace = SAI->getSpace();
299 auto *AccessSpace = isl_space_range(isl_map_get_space(AccessRelation));
Johannes Doerfert4d9bb8d2016-02-18 16:50:12 +0000300 auto *Ctx = isl_space_get_ctx(AccessSpace);
Tobias Grosser99c70dd2015-09-26 08:55:54 +0000301
302 auto DimsArray = isl_space_dim(ArraySpace, isl_dim_set);
303 auto DimsAccess = isl_space_dim(AccessSpace, isl_dim_set);
304 auto DimsMissing = DimsArray - DimsAccess;
305
Johannes Doerfertcea61932016-02-21 19:13:19 +0000306 auto *BB = getStatement()->getParent()->getRegion().getEntry();
307 auto &DL = BB->getModule()->getDataLayout();
Johannes Doerfert4d9bb8d2016-02-18 16:50:12 +0000308 unsigned ArrayElemSize = SAI->getElemSizeInBytes();
Johannes Doerfertcea61932016-02-21 19:13:19 +0000309 unsigned ElemBytes = DL.getTypeAllocSize(getElementType());
Johannes Doerfert4d9bb8d2016-02-18 16:50:12 +0000310
Johannes Doerferta90943d2016-02-21 16:37:25 +0000311 auto *Map = isl_map_from_domain_and_range(
Tobias Grosserd840fc72016-02-04 13:18:42 +0000312 isl_set_universe(AccessSpace),
313 isl_set_universe(isl_space_copy(ArraySpace)));
Tobias Grosser99c70dd2015-09-26 08:55:54 +0000314
315 for (unsigned i = 0; i < DimsMissing; i++)
316 Map = isl_map_fix_si(Map, isl_dim_out, i, 0);
317
318 for (unsigned i = DimsMissing; i < DimsArray; i++)
319 Map = isl_map_equate(Map, isl_dim_in, i - DimsMissing, isl_dim_out, i);
320
321 AccessRelation = isl_map_apply_range(AccessRelation, Map);
Roman Gareev10595a12016-01-08 14:01:59 +0000322
Johannes Doerfert4d9bb8d2016-02-18 16:50:12 +0000323 // For the non delinearized arrays, divide the access function of the last
324 // subscript by the size of the elements in the array.
325 //
326 // A stride one array access in C expressed as A[i] is expressed in
327 // LLVM-IR as something like A[i * elementsize]. This hides the fact that
328 // two subsequent values of 'i' index two values that are stored next to
329 // each other in memory. By this division we make this characteristic
330 // obvious again. If the base pointer was accessed with offsets not divisible
331 // by the accesses element size, we will have choosen a smaller ArrayElemSize
332 // that divides the offsets of all accesses to this base pointer.
333 if (DimsAccess == 1) {
334 isl_val *V = isl_val_int_from_si(Ctx, ArrayElemSize);
335 AccessRelation = isl_map_floordiv_val(AccessRelation, V);
336 }
337
338 if (!isAffine())
339 computeBoundsOnAccessRelation(ArrayElemSize);
340
Tobias Grosserd840fc72016-02-04 13:18:42 +0000341 // Introduce multi-element accesses in case the type loaded by this memory
342 // access is larger than the canonical element type of the array.
343 //
344 // An access ((float *)A)[i] to an array char *A is modeled as
345 // {[i] -> A[o] : 4 i <= o <= 4 i + 3
Tobias Grosserd840fc72016-02-04 13:18:42 +0000346 if (ElemBytes > ArrayElemSize) {
347 assert(ElemBytes % ArrayElemSize == 0 &&
348 "Loaded element size should be multiple of canonical element size");
Johannes Doerferta90943d2016-02-21 16:37:25 +0000349 auto *Map = isl_map_from_domain_and_range(
Tobias Grosserd840fc72016-02-04 13:18:42 +0000350 isl_set_universe(isl_space_copy(ArraySpace)),
351 isl_set_universe(isl_space_copy(ArraySpace)));
352 for (unsigned i = 0; i < DimsArray - 1; i++)
353 Map = isl_map_equate(Map, isl_dim_in, i, isl_dim_out, i);
354
Tobias Grosserd840fc72016-02-04 13:18:42 +0000355 isl_constraint *C;
356 isl_local_space *LS;
357
358 LS = isl_local_space_from_space(isl_map_get_space(Map));
Tobias Grosserd840fc72016-02-04 13:18:42 +0000359 int Num = ElemBytes / getScopArrayInfo()->getElemSizeInBytes();
360
361 C = isl_constraint_alloc_inequality(isl_local_space_copy(LS));
362 C = isl_constraint_set_constant_val(C, isl_val_int_from_si(Ctx, Num - 1));
Johannes Doerfert4d9bb8d2016-02-18 16:50:12 +0000363 C = isl_constraint_set_coefficient_si(C, isl_dim_in, DimsArray - 1, 1);
Tobias Grosserd840fc72016-02-04 13:18:42 +0000364 C = isl_constraint_set_coefficient_si(C, isl_dim_out, DimsArray - 1, -1);
365 Map = isl_map_add_constraint(Map, C);
366
367 C = isl_constraint_alloc_inequality(LS);
Johannes Doerfert4d9bb8d2016-02-18 16:50:12 +0000368 C = isl_constraint_set_coefficient_si(C, isl_dim_in, DimsArray - 1, -1);
Tobias Grosserd840fc72016-02-04 13:18:42 +0000369 C = isl_constraint_set_coefficient_si(C, isl_dim_out, DimsArray - 1, 1);
370 C = isl_constraint_set_constant_val(C, isl_val_int_from_si(Ctx, 0));
371 Map = isl_map_add_constraint(Map, C);
372 AccessRelation = isl_map_apply_range(AccessRelation, Map);
373 }
374
375 isl_space_free(ArraySpace);
376
Roman Gareev10595a12016-01-08 14:01:59 +0000377 assumeNoOutOfBound();
Tobias Grosser99c70dd2015-09-26 08:55:54 +0000378}
379
Johannes Doerfert32868bf2014-08-01 08:13:25 +0000380const std::string
381MemoryAccess::getReductionOperatorStr(MemoryAccess::ReductionType RT) {
382 switch (RT) {
383 case MemoryAccess::RT_NONE:
384 llvm_unreachable("Requested a reduction operator string for a memory "
385 "access which isn't a reduction");
386 case MemoryAccess::RT_ADD:
387 return "+";
388 case MemoryAccess::RT_MUL:
389 return "*";
390 case MemoryAccess::RT_BOR:
391 return "|";
392 case MemoryAccess::RT_BXOR:
393 return "^";
394 case MemoryAccess::RT_BAND:
395 return "&";
396 }
397 llvm_unreachable("Unknown reduction type");
398 return "";
399}
400
Johannes Doerfertf6183392014-07-01 20:52:51 +0000401/// @brief Return the reduction type for a given binary operator
402static MemoryAccess::ReductionType getReductionType(const BinaryOperator *BinOp,
403 const Instruction *Load) {
404 if (!BinOp)
405 return MemoryAccess::RT_NONE;
406 switch (BinOp->getOpcode()) {
407 case Instruction::FAdd:
408 if (!BinOp->hasUnsafeAlgebra())
409 return MemoryAccess::RT_NONE;
410 // Fall through
411 case Instruction::Add:
412 return MemoryAccess::RT_ADD;
413 case Instruction::Or:
414 return MemoryAccess::RT_BOR;
415 case Instruction::Xor:
416 return MemoryAccess::RT_BXOR;
417 case Instruction::And:
418 return MemoryAccess::RT_BAND;
419 case Instruction::FMul:
420 if (!BinOp->hasUnsafeAlgebra())
421 return MemoryAccess::RT_NONE;
422 // Fall through
423 case Instruction::Mul:
424 if (DisableMultiplicativeReductions)
425 return MemoryAccess::RT_NONE;
426 return MemoryAccess::RT_MUL;
427 default:
428 return MemoryAccess::RT_NONE;
429 }
430}
Tobias Grosser5fd8c092015-09-17 17:28:15 +0000431
Tobias Grosser5fd8c092015-09-17 17:28:15 +0000432/// @brief Derive the individual index expressions from a GEP instruction
433///
434/// This function optimistically assumes the GEP references into a fixed size
435/// array. If this is actually true, this function returns a list of array
436/// subscript expressions as SCEV as well as a list of integers describing
437/// the size of the individual array dimensions. Both lists have either equal
438/// length of the size list is one element shorter in case there is no known
439/// size available for the outermost array dimension.
440///
441/// @param GEP The GetElementPtr instruction to analyze.
442///
443/// @return A tuple with the subscript expressions and the dimension sizes.
444static std::tuple<std::vector<const SCEV *>, std::vector<int>>
445getIndexExpressionsFromGEP(GetElementPtrInst *GEP, ScalarEvolution &SE) {
446 std::vector<const SCEV *> Subscripts;
447 std::vector<int> Sizes;
448
449 Type *Ty = GEP->getPointerOperandType();
450
451 bool DroppedFirstDim = false;
452
Michael Kruse26ed65e2015-09-24 17:32:49 +0000453 for (unsigned i = 1; i < GEP->getNumOperands(); i++) {
Tobias Grosser5fd8c092015-09-17 17:28:15 +0000454
455 const SCEV *Expr = SE.getSCEV(GEP->getOperand(i));
456
457 if (i == 1) {
Johannes Doerferta90943d2016-02-21 16:37:25 +0000458 if (auto *PtrTy = dyn_cast<PointerType>(Ty)) {
Tobias Grosser5fd8c092015-09-17 17:28:15 +0000459 Ty = PtrTy->getElementType();
Johannes Doerferta90943d2016-02-21 16:37:25 +0000460 } else if (auto *ArrayTy = dyn_cast<ArrayType>(Ty)) {
Tobias Grosser5fd8c092015-09-17 17:28:15 +0000461 Ty = ArrayTy->getElementType();
462 } else {
463 Subscripts.clear();
464 Sizes.clear();
465 break;
466 }
Johannes Doerferta90943d2016-02-21 16:37:25 +0000467 if (auto *Const = dyn_cast<SCEVConstant>(Expr))
Tobias Grosser5fd8c092015-09-17 17:28:15 +0000468 if (Const->getValue()->isZero()) {
469 DroppedFirstDim = true;
470 continue;
471 }
472 Subscripts.push_back(Expr);
473 continue;
474 }
475
Johannes Doerferta90943d2016-02-21 16:37:25 +0000476 auto *ArrayTy = dyn_cast<ArrayType>(Ty);
Tobias Grosser5fd8c092015-09-17 17:28:15 +0000477 if (!ArrayTy) {
478 Subscripts.clear();
479 Sizes.clear();
480 break;
481 }
482
483 Subscripts.push_back(Expr);
484 if (!(DroppedFirstDim && i == 2))
485 Sizes.push_back(ArrayTy->getNumElements());
486
487 Ty = ArrayTy->getElementType();
488 }
489
490 return std::make_tuple(Subscripts, Sizes);
491}
492
Tobias Grosser75805372011-04-29 06:27:02 +0000493MemoryAccess::~MemoryAccess() {
Tobias Grosser6f48e0f2015-05-15 09:58:32 +0000494 isl_id_free(Id);
Tobias Grosser54a86e62011-08-18 06:31:46 +0000495 isl_map_free(AccessRelation);
Tobias Grosser166c4222015-09-05 07:46:40 +0000496 isl_map_free(NewAccessRelation);
Tobias Grosser75805372011-04-29 06:27:02 +0000497}
498
Johannes Doerfert1a28a892014-10-05 11:32:18 +0000499const ScopArrayInfo *MemoryAccess::getScopArrayInfo() const {
500 isl_id *ArrayId = getArrayId();
501 void *User = isl_id_get_user(ArrayId);
502 const ScopArrayInfo *SAI = static_cast<ScopArrayInfo *>(User);
503 isl_id_free(ArrayId);
504 return SAI;
505}
506
Tobias Grosser4f663aa2015-03-30 11:52:59 +0000507__isl_give isl_id *MemoryAccess::getArrayId() const {
Johannes Doerfert5d83f092014-07-29 08:37:55 +0000508 return isl_map_get_tuple_id(AccessRelation, isl_dim_out);
509}
510
Tobias Grosserd840fc72016-02-04 13:18:42 +0000511__isl_give isl_map *MemoryAccess::getAddressFunction() const {
512 return isl_map_lexmin(getAccessRelation());
513}
514
Tobias Grosser4f663aa2015-03-30 11:52:59 +0000515__isl_give isl_pw_multi_aff *MemoryAccess::applyScheduleToAccessRelation(
516 __isl_take isl_union_map *USchedule) const {
Johannes Doerferta99130f2014-10-13 12:58:03 +0000517 isl_map *Schedule, *ScheduledAccRel;
518 isl_union_set *UDomain;
519
520 UDomain = isl_union_set_from_set(getStatement()->getDomain());
521 USchedule = isl_union_map_intersect_domain(USchedule, UDomain);
522 Schedule = isl_map_from_union_map(USchedule);
Tobias Grosserd840fc72016-02-04 13:18:42 +0000523 ScheduledAccRel = isl_map_apply_domain(getAddressFunction(), Schedule);
Johannes Doerferta99130f2014-10-13 12:58:03 +0000524 return isl_pw_multi_aff_from_map(ScheduledAccRel);
525}
526
Tobias Grosser4f663aa2015-03-30 11:52:59 +0000527__isl_give isl_map *MemoryAccess::getOriginalAccessRelation() const {
Tobias Grosser5d453812011-10-06 00:04:11 +0000528 return isl_map_copy(AccessRelation);
529}
530
Johannes Doerferta99130f2014-10-13 12:58:03 +0000531std::string MemoryAccess::getOriginalAccessRelationStr() const {
Tobias Grosser5d453812011-10-06 00:04:11 +0000532 return stringFromIslObj(AccessRelation);
533}
534
Johannes Doerferta99130f2014-10-13 12:58:03 +0000535__isl_give isl_space *MemoryAccess::getOriginalAccessRelationSpace() const {
Tobias Grosser5e6813d2014-07-02 17:47:48 +0000536 return isl_map_get_space(AccessRelation);
537}
538
Tobias Grosser4f663aa2015-03-30 11:52:59 +0000539__isl_give isl_map *MemoryAccess::getNewAccessRelation() const {
Tobias Grosser166c4222015-09-05 07:46:40 +0000540 return isl_map_copy(NewAccessRelation);
Tobias Grosser75805372011-04-29 06:27:02 +0000541}
542
Tobias Grosser6f730082015-09-05 07:46:47 +0000543std::string MemoryAccess::getNewAccessRelationStr() const {
544 return stringFromIslObj(NewAccessRelation);
545}
546
Tobias Grosser4f663aa2015-03-30 11:52:59 +0000547__isl_give isl_basic_map *
548MemoryAccess::createBasicAccessMap(ScopStmt *Statement) {
Tobias Grosser084d8f72012-05-29 09:29:44 +0000549 isl_space *Space = isl_space_set_alloc(Statement->getIslCtx(), 0, 1);
Tobias Grossered295662012-09-11 13:50:21 +0000550 Space = isl_space_align_params(Space, Statement->getDomainSpace());
Tobias Grosser75805372011-04-29 06:27:02 +0000551
Tobias Grosser084d8f72012-05-29 09:29:44 +0000552 return isl_basic_map_from_domain_and_range(
Tobias Grosserabfbe632013-02-05 12:09:06 +0000553 isl_basic_set_universe(Statement->getDomainSpace()),
554 isl_basic_set_universe(Space));
Tobias Grosser75805372011-04-29 06:27:02 +0000555}
556
Tobias Grosser5e6813d2014-07-02 17:47:48 +0000557// Formalize no out-of-bound access assumption
558//
559// When delinearizing array accesses we optimistically assume that the
560// delinearized accesses do not access out of bound locations (the subscript
561// expression of each array evaluates for each statement instance that is
562// executed to a value that is larger than zero and strictly smaller than the
563// size of the corresponding dimension). The only exception is the outermost
Tobias Grosserf57d63f2014-08-03 21:07:30 +0000564// dimension for which we do not need to assume any upper bound. At this point
565// we formalize this assumption to ensure that at code generation time the
566// relevant run-time checks can be generated.
Tobias Grosser5e6813d2014-07-02 17:47:48 +0000567//
568// To find the set of constraints necessary to avoid out of bound accesses, we
569// first build the set of data locations that are not within array bounds. We
570// then apply the reverse access relation to obtain the set of iterations that
571// may contain invalid accesses and reduce this set of iterations to the ones
572// that are actually executed by intersecting them with the domain of the
573// statement. If we now project out all loop dimensions, we obtain a set of
574// parameters that may cause statement instances to be executed that may
575// possibly yield out of bound memory accesses. The complement of these
576// constraints is the set of constraints that needs to be assumed to ensure such
577// statement instances are never executed.
Michael Krusee2bccbb2015-09-18 19:59:43 +0000578void MemoryAccess::assumeNoOutOfBound() {
Johannes Doerfertadeab372016-02-07 13:57:32 +0000579 auto *SAI = getScopArrayInfo();
Johannes Doerferta99130f2014-10-13 12:58:03 +0000580 isl_space *Space = isl_space_range(getOriginalAccessRelationSpace());
Tobias Grosser5e6813d2014-07-02 17:47:48 +0000581 isl_set *Outside = isl_set_empty(isl_space_copy(Space));
Roman Gareev10595a12016-01-08 14:01:59 +0000582 for (int i = 1, Size = isl_space_dim(Space, isl_dim_set); i < Size; ++i) {
Tobias Grosser5e6813d2014-07-02 17:47:48 +0000583 isl_local_space *LS = isl_local_space_from_space(isl_space_copy(Space));
584 isl_pw_aff *Var =
585 isl_pw_aff_var_on_domain(isl_local_space_copy(LS), isl_dim_set, i);
586 isl_pw_aff *Zero = isl_pw_aff_zero_on_domain(LS);
587
588 isl_set *DimOutside;
589
Tobias Grosserf57d63f2014-08-03 21:07:30 +0000590 DimOutside = isl_pw_aff_lt_set(isl_pw_aff_copy(Var), Zero);
Johannes Doerfertadeab372016-02-07 13:57:32 +0000591 isl_pw_aff *SizeE = SAI->getDimensionSizePw(i);
Tobias Grosserf57d63f2014-08-03 21:07:30 +0000592 SizeE = isl_pw_aff_add_dims(SizeE, isl_dim_in,
593 isl_space_dim(Space, isl_dim_set));
594 SizeE = isl_pw_aff_set_tuple_id(SizeE, isl_dim_in,
595 isl_space_get_tuple_id(Space, isl_dim_set));
Tobias Grosser5e6813d2014-07-02 17:47:48 +0000596
Tobias Grosserf57d63f2014-08-03 21:07:30 +0000597 DimOutside = isl_set_union(DimOutside, isl_pw_aff_le_set(SizeE, Var));
Tobias Grosser5e6813d2014-07-02 17:47:48 +0000598
599 Outside = isl_set_union(Outside, DimOutside);
600 }
601
602 Outside = isl_set_apply(Outside, isl_map_reverse(getAccessRelation()));
603 Outside = isl_set_intersect(Outside, Statement->getDomain());
604 Outside = isl_set_params(Outside);
Tobias Grosserf54bb772015-06-26 12:09:28 +0000605
606 // Remove divs to avoid the construction of overly complicated assumptions.
607 // Doing so increases the set of parameter combinations that are assumed to
608 // not appear. This is always save, but may make the resulting run-time check
609 // bail out more often than strictly necessary.
610 Outside = isl_set_remove_divs(Outside);
Tobias Grosser5e6813d2014-07-02 17:47:48 +0000611 Outside = isl_set_complement(Outside);
Michael Krusead28e5a2016-01-26 13:33:15 +0000612 Statement->getParent()->addAssumption(
613 INBOUNDS, Outside,
614 getAccessInstruction() ? getAccessInstruction()->getDebugLoc() : nullptr);
Tobias Grosser5e6813d2014-07-02 17:47:48 +0000615 isl_space_free(Space);
616}
617
Johannes Doerfertcea61932016-02-21 19:13:19 +0000618void MemoryAccess::buildMemIntrinsicAccessRelation() {
619 auto MAI = MemAccInst(getAccessInstruction());
620 assert(MAI.isMemIntrinsic());
621 assert(Subscripts.size() == 2 && Sizes.size() == 0);
622
623 auto *LengthPWA = Statement->getPwAff(Subscripts[1]);
624 auto *LengthMap = isl_map_from_pw_aff(LengthPWA);
625 auto *RangeSpace = isl_space_range(isl_map_get_space(LengthMap));
626 LengthMap = isl_map_apply_range(LengthMap, isl_map_lex_gt(RangeSpace));
627 LengthMap = isl_map_lower_bound_si(LengthMap, isl_dim_out, 0, 0);
628 auto *SubscriptPWA = Statement->getPwAff(Subscripts[0]);
629 auto *SubscriptMap = isl_map_from_pw_aff(SubscriptPWA);
630 SubscriptMap =
631 isl_map_align_params(SubscriptMap, isl_map_get_space(LengthMap));
632 LengthMap = isl_map_align_params(LengthMap, isl_map_get_space(SubscriptMap));
633 LengthMap = isl_map_sum(LengthMap, SubscriptMap);
634 AccessRelation = isl_map_set_tuple_id(LengthMap, isl_dim_in,
635 getStatement()->getDomainId());
636}
637
Johannes Doerferte7044942015-02-24 11:58:30 +0000638void MemoryAccess::computeBoundsOnAccessRelation(unsigned ElementSize) {
639 ScalarEvolution *SE = Statement->getParent()->getSE();
640
Johannes Doerfertcea61932016-02-21 19:13:19 +0000641 auto MAI = MemAccInst(getAccessInstruction());
642 if (MAI.isMemIntrinsic())
643 return;
644
645 Value *Ptr = MAI.getPointerOperand();
Johannes Doerferte7044942015-02-24 11:58:30 +0000646 if (!Ptr || !SE->isSCEVable(Ptr->getType()))
647 return;
648
649 auto *PtrSCEV = SE->getSCEV(Ptr);
650 if (isa<SCEVCouldNotCompute>(PtrSCEV))
651 return;
652
653 auto *BasePtrSCEV = SE->getPointerBase(PtrSCEV);
654 if (BasePtrSCEV && !isa<SCEVCouldNotCompute>(BasePtrSCEV))
655 PtrSCEV = SE->getMinusSCEV(PtrSCEV, BasePtrSCEV);
656
657 const ConstantRange &Range = SE->getSignedRange(PtrSCEV);
658 if (Range.isFullSet())
659 return;
660
Johannes Doerferte4bd53b2015-03-08 19:49:50 +0000661 bool isWrapping = Range.isSignWrappedSet();
Johannes Doerferte7044942015-02-24 11:58:30 +0000662 unsigned BW = Range.getBitWidth();
Johannes Doerferte7087902016-02-07 13:59:03 +0000663 const auto One = APInt(BW, 1);
Johannes Doerferte4bd53b2015-03-08 19:49:50 +0000664 const auto LB = isWrapping ? Range.getLower() : Range.getSignedMin();
Johannes Doerferte7087902016-02-07 13:59:03 +0000665 const auto UB = isWrapping ? (Range.getUpper() - One) : Range.getSignedMax();
Johannes Doerferte4bd53b2015-03-08 19:49:50 +0000666
667 auto Min = LB.sdiv(APInt(BW, ElementSize));
Johannes Doerferte7087902016-02-07 13:59:03 +0000668 auto Max = UB.sdiv(APInt(BW, ElementSize)) + One;
Johannes Doerferte7044942015-02-24 11:58:30 +0000669
670 isl_set *AccessRange = isl_map_range(isl_map_copy(AccessRelation));
671 AccessRange =
672 addRangeBoundsToSet(AccessRange, ConstantRange(Min, Max), 0, isl_dim_set);
673 AccessRelation = isl_map_intersect_range(AccessRelation, AccessRange);
674}
675
Michael Krusee2bccbb2015-09-18 19:59:43 +0000676__isl_give isl_map *MemoryAccess::foldAccess(__isl_take isl_map *AccessRelation,
Tobias Grosser619190d2015-03-30 17:22:28 +0000677 ScopStmt *Statement) {
Michael Krusee2bccbb2015-09-18 19:59:43 +0000678 int Size = Subscripts.size();
Tobias Grosser619190d2015-03-30 17:22:28 +0000679
680 for (int i = Size - 2; i >= 0; --i) {
681 isl_space *Space;
682 isl_map *MapOne, *MapTwo;
Michael Krusee2bccbb2015-09-18 19:59:43 +0000683 isl_pw_aff *DimSize = Statement->getPwAff(Sizes[i]);
Tobias Grosser619190d2015-03-30 17:22:28 +0000684
685 isl_space *SpaceSize = isl_pw_aff_get_space(DimSize);
686 isl_pw_aff_free(DimSize);
687 isl_id *ParamId = isl_space_get_dim_id(SpaceSize, isl_dim_param, 0);
688
689 Space = isl_map_get_space(AccessRelation);
690 Space = isl_space_map_from_set(isl_space_range(Space));
691 Space = isl_space_align_params(Space, SpaceSize);
692
693 int ParamLocation = isl_space_find_dim_by_id(Space, isl_dim_param, ParamId);
694 isl_id_free(ParamId);
695
696 MapOne = isl_map_universe(isl_space_copy(Space));
697 for (int j = 0; j < Size; ++j)
698 MapOne = isl_map_equate(MapOne, isl_dim_in, j, isl_dim_out, j);
699 MapOne = isl_map_lower_bound_si(MapOne, isl_dim_in, i + 1, 0);
700
701 MapTwo = isl_map_universe(isl_space_copy(Space));
702 for (int j = 0; j < Size; ++j)
703 if (j < i || j > i + 1)
704 MapTwo = isl_map_equate(MapTwo, isl_dim_in, j, isl_dim_out, j);
705
706 isl_local_space *LS = isl_local_space_from_space(Space);
707 isl_constraint *C;
708 C = isl_equality_alloc(isl_local_space_copy(LS));
709 C = isl_constraint_set_constant_si(C, -1);
710 C = isl_constraint_set_coefficient_si(C, isl_dim_in, i, 1);
711 C = isl_constraint_set_coefficient_si(C, isl_dim_out, i, -1);
712 MapTwo = isl_map_add_constraint(MapTwo, C);
713 C = isl_equality_alloc(LS);
714 C = isl_constraint_set_coefficient_si(C, isl_dim_in, i + 1, 1);
715 C = isl_constraint_set_coefficient_si(C, isl_dim_out, i + 1, -1);
716 C = isl_constraint_set_coefficient_si(C, isl_dim_param, ParamLocation, 1);
717 MapTwo = isl_map_add_constraint(MapTwo, C);
718 MapTwo = isl_map_upper_bound_si(MapTwo, isl_dim_in, i + 1, -1);
719
720 MapOne = isl_map_union(MapOne, MapTwo);
721 AccessRelation = isl_map_apply_range(AccessRelation, MapOne);
722 }
723 return AccessRelation;
724}
725
Johannes Doerferta4b77c02015-11-12 20:15:32 +0000726/// @brief Check if @p Expr is divisible by @p Size.
727static bool isDivisible(const SCEV *Expr, unsigned Size, ScalarEvolution &SE) {
Johannes Doerfert4d9bb8d2016-02-18 16:50:12 +0000728 if (Size == 1)
729 return true;
Johannes Doerferta4b77c02015-11-12 20:15:32 +0000730
731 // Only one factor needs to be divisible.
732 if (auto *MulExpr = dyn_cast<SCEVMulExpr>(Expr)) {
733 for (auto *FactorExpr : MulExpr->operands())
734 if (isDivisible(FactorExpr, Size, SE))
735 return true;
736 return false;
737 }
738
739 // For other n-ary expressions (Add, AddRec, Max,...) all operands need
740 // to be divisble.
741 if (auto *NAryExpr = dyn_cast<SCEVNAryExpr>(Expr)) {
742 for (auto *OpExpr : NAryExpr->operands())
743 if (!isDivisible(OpExpr, Size, SE))
744 return false;
745 return true;
746 }
747
748 auto *SizeSCEV = SE.getConstant(Expr->getType(), Size);
749 auto *UDivSCEV = SE.getUDivExpr(Expr, SizeSCEV);
750 auto *MulSCEV = SE.getMulExpr(UDivSCEV, SizeSCEV);
751 return MulSCEV == Expr;
752}
753
Michael Krusee2bccbb2015-09-18 19:59:43 +0000754void MemoryAccess::buildAccessRelation(const ScopArrayInfo *SAI) {
755 assert(!AccessRelation && "AccessReltation already built");
Tobias Grosser75805372011-04-29 06:27:02 +0000756
Michael Krusee2bccbb2015-09-18 19:59:43 +0000757 isl_ctx *Ctx = isl_id_get_ctx(Id);
Johannes Doerfert1a28a892014-10-05 11:32:18 +0000758 isl_id *BaseAddrId = SAI->getBasePtrId();
Tobias Grosser5683df42011-11-09 22:34:34 +0000759
Michael Krusee2bccbb2015-09-18 19:59:43 +0000760 if (!isAffine()) {
Johannes Doerfertcea61932016-02-21 19:13:19 +0000761 if (isa<MemIntrinsic>(getAccessInstruction()))
762 buildMemIntrinsicAccessRelation();
763
Tobias Grosser4f967492013-06-23 05:21:18 +0000764 // We overapproximate non-affine accesses with a possible access to the
765 // whole array. For read accesses it does not make a difference, if an
766 // access must or may happen. However, for write accesses it is important to
767 // differentiate between writes that must happen and writes that may happen.
Johannes Doerfertcea61932016-02-21 19:13:19 +0000768 if (!AccessRelation)
769 AccessRelation = isl_map_from_basic_map(createBasicAccessMap(Statement));
770
Johannes Doerfert5d83f092014-07-29 08:37:55 +0000771 AccessRelation =
772 isl_map_set_tuple_id(AccessRelation, isl_dim_out, BaseAddrId);
Tobias Grossera1879642011-12-20 10:43:14 +0000773 return;
774 }
775
Johannes Doerfert5d83f092014-07-29 08:37:55 +0000776 isl_space *Space = isl_space_alloc(Ctx, 0, Statement->getNumIterators(), 0);
Tobias Grosser79baa212014-04-10 08:38:02 +0000777 AccessRelation = isl_map_universe(Space);
Tobias Grossera1879642011-12-20 10:43:14 +0000778
Michael Krusee2bccbb2015-09-18 19:59:43 +0000779 for (int i = 0, Size = Subscripts.size(); i < Size; ++i) {
780 isl_pw_aff *Affine = Statement->getPwAff(Subscripts[i]);
Sebastian Pop18016682014-04-08 21:20:44 +0000781 isl_map *SubscriptMap = isl_map_from_pw_aff(Affine);
Tobias Grosser79baa212014-04-10 08:38:02 +0000782 AccessRelation = isl_map_flat_range_product(AccessRelation, SubscriptMap);
Sebastian Pop18016682014-04-08 21:20:44 +0000783 }
784
Tobias Grosser5d51afe2016-02-02 16:46:45 +0000785 if (Sizes.size() >= 1 && !isa<SCEVConstant>(Sizes[0]))
Michael Krusee2bccbb2015-09-18 19:59:43 +0000786 AccessRelation = foldAccess(AccessRelation, Statement);
Tobias Grosser619190d2015-03-30 17:22:28 +0000787
Tobias Grosser79baa212014-04-10 08:38:02 +0000788 Space = Statement->getDomainSpace();
Tobias Grosserabfbe632013-02-05 12:09:06 +0000789 AccessRelation = isl_map_set_tuple_id(
790 AccessRelation, isl_dim_in, isl_space_get_tuple_id(Space, isl_dim_set));
Johannes Doerfert5d83f092014-07-29 08:37:55 +0000791 AccessRelation =
792 isl_map_set_tuple_id(AccessRelation, isl_dim_out, BaseAddrId);
793
Tobias Grosseraa660a92015-03-30 00:07:50 +0000794 AccessRelation = isl_map_gist_domain(AccessRelation, Statement->getDomain());
Johannes Doerfert5d83f092014-07-29 08:37:55 +0000795 isl_space_free(Space);
Tobias Grosser8cae72f2011-11-08 15:41:08 +0000796}
Tobias Grosser30b8a092011-08-18 07:51:37 +0000797
Michael Krusecac948e2015-10-02 13:53:07 +0000798MemoryAccess::MemoryAccess(ScopStmt *Stmt, Instruction *AccessInst,
Johannes Doerfertcea61932016-02-21 19:13:19 +0000799 AccessType AccType, Value *BaseAddress,
800 Type *ElementType, bool Affine,
Michael Krusee2bccbb2015-09-18 19:59:43 +0000801 ArrayRef<const SCEV *> Subscripts,
802 ArrayRef<const SCEV *> Sizes, Value *AccessValue,
Tobias Grossera535dff2015-12-13 19:59:01 +0000803 ScopArrayInfo::MemoryKind Kind, StringRef BaseName)
Johannes Doerfertcea61932016-02-21 19:13:19 +0000804 : Kind(Kind), AccType(AccType), RedType(RT_NONE), Statement(Stmt),
805 BaseAddr(BaseAddress), BaseName(BaseName), ElementType(ElementType),
Michael Krusecac948e2015-10-02 13:53:07 +0000806 Sizes(Sizes.begin(), Sizes.end()), AccessInstruction(AccessInst),
807 AccessValue(AccessValue), IsAffine(Affine),
Michael Krusee2bccbb2015-09-18 19:59:43 +0000808 Subscripts(Subscripts.begin(), Subscripts.end()), AccessRelation(nullptr),
Tobias Grosserf1bfd752015-11-05 20:15:37 +0000809 NewAccessRelation(nullptr) {
Hongbin Zheng86f43ea2016-02-20 03:40:15 +0000810 static const std::string TypeStrings[] = {"", "_Read", "_Write", "_MayWrite"};
Johannes Doerfertcea61932016-02-21 19:13:19 +0000811 const std::string Access = TypeStrings[AccType] + utostr(Stmt->size()) + "_";
Tobias Grosserf1bfd752015-11-05 20:15:37 +0000812
Hongbin Zheng86f43ea2016-02-20 03:40:15 +0000813 std::string IdName =
814 getIslCompatibleName(Stmt->getBaseName(), Access, BaseName);
Tobias Grosserf1bfd752015-11-05 20:15:37 +0000815 Id = isl_id_alloc(Stmt->getParent()->getIslCtx(), IdName.c_str(), this);
816}
Michael Krusee2bccbb2015-09-18 19:59:43 +0000817
Tobias Grosser8cae72f2011-11-08 15:41:08 +0000818void MemoryAccess::realignParams() {
Tobias Grosser6defb5b2014-04-10 08:37:44 +0000819 isl_space *ParamSpace = Statement->getParent()->getParamSpace();
Tobias Grosser37487052011-10-06 00:03:42 +0000820 AccessRelation = isl_map_align_params(AccessRelation, ParamSpace);
Tobias Grosser75805372011-04-29 06:27:02 +0000821}
822
Johannes Doerfert32868bf2014-08-01 08:13:25 +0000823const std::string MemoryAccess::getReductionOperatorStr() const {
824 return MemoryAccess::getReductionOperatorStr(getReductionType());
825}
826
Tobias Grosser6f48e0f2015-05-15 09:58:32 +0000827__isl_give isl_id *MemoryAccess::getId() const { return isl_id_copy(Id); }
828
Johannes Doerfertf6183392014-07-01 20:52:51 +0000829raw_ostream &polly::operator<<(raw_ostream &OS,
830 MemoryAccess::ReductionType RT) {
Johannes Doerfert32868bf2014-08-01 08:13:25 +0000831 if (RT == MemoryAccess::RT_NONE)
Johannes Doerfertf6183392014-07-01 20:52:51 +0000832 OS << "NONE";
Johannes Doerfert32868bf2014-08-01 08:13:25 +0000833 else
834 OS << MemoryAccess::getReductionOperatorStr(RT);
Johannes Doerfertf6183392014-07-01 20:52:51 +0000835 return OS;
836}
837
Tobias Grosser75805372011-04-29 06:27:02 +0000838void MemoryAccess::print(raw_ostream &OS) const {
Johannes Doerfert4c7ce472014-10-08 10:11:33 +0000839 switch (AccType) {
Tobias Grosserb58f6a42013-07-13 20:41:24 +0000840 case READ:
Johannes Doerfert6780bc32014-06-26 18:47:03 +0000841 OS.indent(12) << "ReadAccess :=\t";
Tobias Grosser4f967492013-06-23 05:21:18 +0000842 break;
Tobias Grosserb58f6a42013-07-13 20:41:24 +0000843 case MUST_WRITE:
Johannes Doerfert6780bc32014-06-26 18:47:03 +0000844 OS.indent(12) << "MustWriteAccess :=\t";
Tobias Grosser4f967492013-06-23 05:21:18 +0000845 break;
Tobias Grosserb58f6a42013-07-13 20:41:24 +0000846 case MAY_WRITE:
Johannes Doerfert6780bc32014-06-26 18:47:03 +0000847 OS.indent(12) << "MayWriteAccess :=\t";
Tobias Grosser4f967492013-06-23 05:21:18 +0000848 break;
849 }
Johannes Doerfert0ff23ec2015-02-06 20:13:15 +0000850 OS << "[Reduction Type: " << getReductionType() << "] ";
Tobias Grossera535dff2015-12-13 19:59:01 +0000851 OS << "[Scalar: " << isScalarKind() << "]\n";
Michael Kruseb8d26442015-12-13 19:35:26 +0000852 OS.indent(16) << getOriginalAccessRelationStr() << ";\n";
Tobias Grosser6f730082015-09-05 07:46:47 +0000853 if (hasNewAccessRelation())
854 OS.indent(11) << "new: " << getNewAccessRelationStr() << ";\n";
Tobias Grosser75805372011-04-29 06:27:02 +0000855}
856
Tobias Grosser74394f02013-01-14 22:40:23 +0000857void MemoryAccess::dump() const { print(errs()); }
Tobias Grosser75805372011-04-29 06:27:02 +0000858
859// Create a map in the size of the provided set domain, that maps from the
860// one element of the provided set domain to another element of the provided
861// set domain.
862// The mapping is limited to all points that are equal in all but the last
863// dimension and for which the last dimension of the input is strict smaller
864// than the last dimension of the output.
865//
866// getEqualAndLarger(set[i0, i1, ..., iX]):
867//
868// set[i0, i1, ..., iX] -> set[o0, o1, ..., oX]
869// : i0 = o0, i1 = o1, ..., i(X-1) = o(X-1), iX < oX
870//
Tobias Grosserf5338802011-10-06 00:03:35 +0000871static isl_map *getEqualAndLarger(isl_space *setDomain) {
Tobias Grosserc327932c2012-02-01 14:23:36 +0000872 isl_space *Space = isl_space_map_from_set(setDomain);
Tobias Grosser1b6ea572015-05-21 19:02:44 +0000873 isl_map *Map = isl_map_universe(Space);
Sebastian Pop40408762013-10-04 17:14:53 +0000874 unsigned lastDimension = isl_map_dim(Map, isl_dim_in) - 1;
Tobias Grosser75805372011-04-29 06:27:02 +0000875
876 // Set all but the last dimension to be equal for the input and output
877 //
878 // input[i0, i1, ..., iX] -> output[o0, o1, ..., oX]
879 // : i0 = o0, i1 = o1, ..., i(X-1) = o(X-1)
Sebastian Pop40408762013-10-04 17:14:53 +0000880 for (unsigned i = 0; i < lastDimension; ++i)
Tobias Grosserc327932c2012-02-01 14:23:36 +0000881 Map = isl_map_equate(Map, isl_dim_in, i, isl_dim_out, i);
Tobias Grosser75805372011-04-29 06:27:02 +0000882
883 // Set the last dimension of the input to be strict smaller than the
884 // last dimension of the output.
885 //
886 // input[?,?,?,...,iX] -> output[?,?,?,...,oX] : iX < oX
Tobias Grosser1b6ea572015-05-21 19:02:44 +0000887 Map = isl_map_order_lt(Map, isl_dim_in, lastDimension, isl_dim_out,
888 lastDimension);
Tobias Grosserc327932c2012-02-01 14:23:36 +0000889 return Map;
Tobias Grosser75805372011-04-29 06:27:02 +0000890}
891
Tobias Grosser4f663aa2015-03-30 11:52:59 +0000892__isl_give isl_set *
893MemoryAccess::getStride(__isl_take const isl_map *Schedule) const {
Tobias Grosserabfbe632013-02-05 12:09:06 +0000894 isl_map *S = const_cast<isl_map *>(Schedule);
Johannes Doerferta99130f2014-10-13 12:58:03 +0000895 isl_map *AccessRelation = getAccessRelation();
Sebastian Popa00a0292012-12-18 07:46:06 +0000896 isl_space *Space = isl_space_range(isl_map_get_space(S));
897 isl_map *NextScatt = getEqualAndLarger(Space);
Tobias Grosser75805372011-04-29 06:27:02 +0000898
Sebastian Popa00a0292012-12-18 07:46:06 +0000899 S = isl_map_reverse(S);
900 NextScatt = isl_map_lexmin(NextScatt);
Tobias Grosser75805372011-04-29 06:27:02 +0000901
Sebastian Popa00a0292012-12-18 07:46:06 +0000902 NextScatt = isl_map_apply_range(NextScatt, isl_map_copy(S));
903 NextScatt = isl_map_apply_range(NextScatt, isl_map_copy(AccessRelation));
904 NextScatt = isl_map_apply_domain(NextScatt, S);
905 NextScatt = isl_map_apply_domain(NextScatt, AccessRelation);
Tobias Grosser75805372011-04-29 06:27:02 +0000906
Sebastian Popa00a0292012-12-18 07:46:06 +0000907 isl_set *Deltas = isl_map_deltas(NextScatt);
908 return Deltas;
Tobias Grosser75805372011-04-29 06:27:02 +0000909}
910
Sebastian Popa00a0292012-12-18 07:46:06 +0000911bool MemoryAccess::isStrideX(__isl_take const isl_map *Schedule,
Tobias Grosser28dd4862012-01-24 16:42:16 +0000912 int StrideWidth) const {
913 isl_set *Stride, *StrideX;
914 bool IsStrideX;
Tobias Grosser75805372011-04-29 06:27:02 +0000915
Sebastian Popa00a0292012-12-18 07:46:06 +0000916 Stride = getStride(Schedule);
Tobias Grosser28dd4862012-01-24 16:42:16 +0000917 StrideX = isl_set_universe(isl_set_get_space(Stride));
Tobias Grosser01c8f5f2015-08-24 22:20:46 +0000918 for (unsigned i = 0; i < isl_set_dim(StrideX, isl_dim_set) - 1; i++)
919 StrideX = isl_set_fix_si(StrideX, isl_dim_set, i, 0);
920 StrideX = isl_set_fix_si(StrideX, isl_dim_set,
921 isl_set_dim(StrideX, isl_dim_set) - 1, StrideWidth);
Roman Gareevf2bd72e2015-08-18 16:12:05 +0000922 IsStrideX = isl_set_is_subset(Stride, StrideX);
Tobias Grosser75805372011-04-29 06:27:02 +0000923
Tobias Grosser28dd4862012-01-24 16:42:16 +0000924 isl_set_free(StrideX);
Tobias Grosserdea98232012-01-17 20:34:27 +0000925 isl_set_free(Stride);
Tobias Grosserb76f38532011-08-20 11:11:25 +0000926
Tobias Grosser28dd4862012-01-24 16:42:16 +0000927 return IsStrideX;
928}
929
Sebastian Popa00a0292012-12-18 07:46:06 +0000930bool MemoryAccess::isStrideZero(const isl_map *Schedule) const {
931 return isStrideX(Schedule, 0);
Tobias Grosser75805372011-04-29 06:27:02 +0000932}
933
Sebastian Popa00a0292012-12-18 07:46:06 +0000934bool MemoryAccess::isStrideOne(const isl_map *Schedule) const {
935 return isStrideX(Schedule, 1);
Tobias Grosser75805372011-04-29 06:27:02 +0000936}
937
Tobias Grosser166c4222015-09-05 07:46:40 +0000938void MemoryAccess::setNewAccessRelation(isl_map *NewAccess) {
939 isl_map_free(NewAccessRelation);
940 NewAccessRelation = NewAccess;
Raghesh Aloor3cb66282011-07-12 17:14:03 +0000941}
Tobias Grosser75805372011-04-29 06:27:02 +0000942
943//===----------------------------------------------------------------------===//
Tobias Grossercf3942d2011-10-06 00:04:05 +0000944
Tobias Grosser808cd692015-07-14 09:33:13 +0000945isl_map *ScopStmt::getSchedule() const {
946 isl_set *Domain = getDomain();
947 if (isl_set_is_empty(Domain)) {
948 isl_set_free(Domain);
949 return isl_map_from_aff(
950 isl_aff_zero_on_domain(isl_local_space_from_space(getDomainSpace())));
951 }
952 auto *Schedule = getParent()->getSchedule();
953 Schedule = isl_union_map_intersect_domain(
954 Schedule, isl_union_set_from_set(isl_set_copy(Domain)));
955 if (isl_union_map_is_empty(Schedule)) {
956 isl_set_free(Domain);
957 isl_union_map_free(Schedule);
958 return isl_map_from_aff(
959 isl_aff_zero_on_domain(isl_local_space_from_space(getDomainSpace())));
960 }
961 auto *M = isl_map_from_union_map(Schedule);
962 M = isl_map_coalesce(M);
963 M = isl_map_gist_domain(M, Domain);
964 M = isl_map_coalesce(M);
965 return M;
966}
Tobias Grossercf3942d2011-10-06 00:04:05 +0000967
Johannes Doerfert574182d2015-08-12 10:19:50 +0000968__isl_give isl_pw_aff *ScopStmt::getPwAff(const SCEV *E) {
Johannes Doerfertcef616f2015-09-15 22:49:04 +0000969 return getParent()->getPwAff(E, isBlockStmt() ? getBasicBlock()
970 : getRegion()->getEntry());
Johannes Doerfert574182d2015-08-12 10:19:50 +0000971}
972
Tobias Grosser37eb4222014-02-20 21:43:54 +0000973void ScopStmt::restrictDomain(__isl_take isl_set *NewDomain) {
974 assert(isl_set_is_subset(NewDomain, Domain) &&
975 "New domain is not a subset of old domain!");
976 isl_set_free(Domain);
977 Domain = NewDomain;
Tobias Grosser75805372011-04-29 06:27:02 +0000978}
979
Michael Krusecac948e2015-10-02 13:53:07 +0000980void ScopStmt::buildAccessRelations() {
Johannes Doerfertadeab372016-02-07 13:57:32 +0000981 Scop &S = *getParent();
Michael Krusecac948e2015-10-02 13:53:07 +0000982 for (MemoryAccess *Access : MemAccs) {
Johannes Doerfertcea61932016-02-21 19:13:19 +0000983 Type *ElementType = Access->getElementType();
Johannes Doerfert1a28a892014-10-05 11:32:18 +0000984
Tobias Grossera535dff2015-12-13 19:59:01 +0000985 ScopArrayInfo::MemoryKind Ty;
986 if (Access->isPHIKind())
987 Ty = ScopArrayInfo::MK_PHI;
988 else if (Access->isExitPHIKind())
989 Ty = ScopArrayInfo::MK_ExitPHI;
990 else if (Access->isValueKind())
991 Ty = ScopArrayInfo::MK_Value;
Tobias Grosser6abc75a2015-11-10 17:31:31 +0000992 else
Tobias Grossera535dff2015-12-13 19:59:01 +0000993 Ty = ScopArrayInfo::MK_Array;
Tobias Grosser6abc75a2015-11-10 17:31:31 +0000994
Johannes Doerfertadeab372016-02-07 13:57:32 +0000995 auto *SAI = S.getOrCreateScopArrayInfo(Access->getBaseAddr(), ElementType,
996 Access->Sizes, Ty);
Michael Krusecac948e2015-10-02 13:53:07 +0000997 Access->buildAccessRelation(SAI);
Tobias Grosser75805372011-04-29 06:27:02 +0000998 }
999}
1000
Michael Krusecac948e2015-10-02 13:53:07 +00001001void ScopStmt::addAccess(MemoryAccess *Access) {
1002 Instruction *AccessInst = Access->getAccessInstruction();
1003
Michael Kruse58fa3bb2015-12-22 23:25:11 +00001004 if (Access->isArrayKind()) {
1005 MemoryAccessList &MAL = InstructionToAccess[AccessInst];
1006 MAL.emplace_front(Access);
Michael Kruse436db622016-01-26 13:33:10 +00001007 } else if (Access->isValueKind() && Access->isWrite()) {
1008 Instruction *AccessVal = cast<Instruction>(Access->getAccessValue());
Michael Kruse6f7721f2016-02-24 22:08:19 +00001009 assert(Parent.getStmtFor(AccessVal) == this);
Michael Kruse436db622016-01-26 13:33:10 +00001010 assert(!ValueWrites.lookup(AccessVal));
1011
1012 ValueWrites[AccessVal] = Access;
Michael Krusead28e5a2016-01-26 13:33:15 +00001013 } else if (Access->isValueKind() && Access->isRead()) {
1014 Value *AccessVal = Access->getAccessValue();
1015 assert(!ValueReads.lookup(AccessVal));
1016
1017 ValueReads[AccessVal] = Access;
Michael Kruseee6a4fc2016-01-26 13:33:27 +00001018 } else if (Access->isAnyPHIKind() && Access->isWrite()) {
1019 PHINode *PHI = cast<PHINode>(Access->getBaseAddr());
1020 assert(!PHIWrites.lookup(PHI));
1021
1022 PHIWrites[PHI] = Access;
Michael Kruse58fa3bb2015-12-22 23:25:11 +00001023 }
1024
1025 MemAccs.push_back(Access);
Michael Krusecac948e2015-10-02 13:53:07 +00001026}
1027
Tobias Grosser8cae72f2011-11-08 15:41:08 +00001028void ScopStmt::realignParams() {
Johannes Doerfertf6752892014-06-13 18:01:45 +00001029 for (MemoryAccess *MA : *this)
1030 MA->realignParams();
Tobias Grosser8cae72f2011-11-08 15:41:08 +00001031
1032 Domain = isl_set_align_params(Domain, Parent.getParamSpace());
Tobias Grosser8cae72f2011-11-08 15:41:08 +00001033}
1034
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00001035/// @brief Add @p BSet to the set @p User if @p BSet is bounded.
1036static isl_stat collectBoundedParts(__isl_take isl_basic_set *BSet,
1037 void *User) {
1038 isl_set **BoundedParts = static_cast<isl_set **>(User);
1039 if (isl_basic_set_is_bounded(BSet))
1040 *BoundedParts = isl_set_union(*BoundedParts, isl_set_from_basic_set(BSet));
1041 else
1042 isl_basic_set_free(BSet);
1043 return isl_stat_ok;
1044}
1045
1046/// @brief Return the bounded parts of @p S.
1047static __isl_give isl_set *collectBoundedParts(__isl_take isl_set *S) {
1048 isl_set *BoundedParts = isl_set_empty(isl_set_get_space(S));
1049 isl_set_foreach_basic_set(S, collectBoundedParts, &BoundedParts);
1050 isl_set_free(S);
1051 return BoundedParts;
1052}
1053
1054/// @brief Compute the (un)bounded parts of @p S wrt. to dimension @p Dim.
1055///
1056/// @returns A separation of @p S into first an unbounded then a bounded subset,
1057/// both with regards to the dimension @p Dim.
1058static std::pair<__isl_give isl_set *, __isl_give isl_set *>
1059partitionSetParts(__isl_take isl_set *S, unsigned Dim) {
1060
1061 for (unsigned u = 0, e = isl_set_n_dim(S); u < e; u++)
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00001062 S = isl_set_lower_bound_si(S, isl_dim_set, u, 0);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00001063
1064 unsigned NumDimsS = isl_set_n_dim(S);
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00001065 isl_set *OnlyDimS = isl_set_copy(S);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00001066
1067 // Remove dimensions that are greater than Dim as they are not interesting.
1068 assert(NumDimsS >= Dim + 1);
1069 OnlyDimS =
1070 isl_set_project_out(OnlyDimS, isl_dim_set, Dim + 1, NumDimsS - Dim - 1);
1071
1072 // Create artificial parametric upper bounds for dimensions smaller than Dim
1073 // as we are not interested in them.
1074 OnlyDimS = isl_set_insert_dims(OnlyDimS, isl_dim_param, 0, Dim);
1075 for (unsigned u = 0; u < Dim; u++) {
1076 isl_constraint *C = isl_inequality_alloc(
1077 isl_local_space_from_space(isl_set_get_space(OnlyDimS)));
1078 C = isl_constraint_set_coefficient_si(C, isl_dim_param, u, 1);
1079 C = isl_constraint_set_coefficient_si(C, isl_dim_set, u, -1);
1080 OnlyDimS = isl_set_add_constraint(OnlyDimS, C);
1081 }
1082
1083 // Collect all bounded parts of OnlyDimS.
1084 isl_set *BoundedParts = collectBoundedParts(OnlyDimS);
1085
1086 // Create the dimensions greater than Dim again.
1087 BoundedParts = isl_set_insert_dims(BoundedParts, isl_dim_set, Dim + 1,
1088 NumDimsS - Dim - 1);
1089
1090 // Remove the artificial upper bound parameters again.
1091 BoundedParts = isl_set_remove_dims(BoundedParts, isl_dim_param, 0, Dim);
1092
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00001093 isl_set *UnboundedParts = isl_set_subtract(S, isl_set_copy(BoundedParts));
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00001094 return std::make_pair(UnboundedParts, BoundedParts);
1095}
1096
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001097/// @brief Set the dimension Ids from @p From in @p To.
1098static __isl_give isl_set *setDimensionIds(__isl_keep isl_set *From,
1099 __isl_take isl_set *To) {
1100 for (unsigned u = 0, e = isl_set_n_dim(From); u < e; u++) {
1101 isl_id *DimId = isl_set_get_dim_id(From, isl_dim_set, u);
1102 To = isl_set_set_dim_id(To, isl_dim_set, u, DimId);
1103 }
1104 return To;
1105}
1106
1107/// @brief Create the conditions under which @p L @p Pred @p R is true.
Johannes Doerfert96425c22015-08-30 21:13:53 +00001108static __isl_give isl_set *buildConditionSet(ICmpInst::Predicate Pred,
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001109 __isl_take isl_pw_aff *L,
1110 __isl_take isl_pw_aff *R) {
Johannes Doerfert96425c22015-08-30 21:13:53 +00001111 switch (Pred) {
1112 case ICmpInst::ICMP_EQ:
1113 return isl_pw_aff_eq_set(L, R);
1114 case ICmpInst::ICMP_NE:
1115 return isl_pw_aff_ne_set(L, R);
1116 case ICmpInst::ICMP_SLT:
1117 return isl_pw_aff_lt_set(L, R);
1118 case ICmpInst::ICMP_SLE:
1119 return isl_pw_aff_le_set(L, R);
1120 case ICmpInst::ICMP_SGT:
1121 return isl_pw_aff_gt_set(L, R);
1122 case ICmpInst::ICMP_SGE:
1123 return isl_pw_aff_ge_set(L, R);
1124 case ICmpInst::ICMP_ULT:
1125 return isl_pw_aff_lt_set(L, R);
1126 case ICmpInst::ICMP_UGT:
1127 return isl_pw_aff_gt_set(L, R);
1128 case ICmpInst::ICMP_ULE:
1129 return isl_pw_aff_le_set(L, R);
1130 case ICmpInst::ICMP_UGE:
1131 return isl_pw_aff_ge_set(L, R);
1132 default:
1133 llvm_unreachable("Non integer predicate not supported");
1134 }
1135}
1136
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001137/// @brief Create the conditions under which @p L @p Pred @p R is true.
1138///
1139/// Helper function that will make sure the dimensions of the result have the
1140/// same isl_id's as the @p Domain.
1141static __isl_give isl_set *buildConditionSet(ICmpInst::Predicate Pred,
1142 __isl_take isl_pw_aff *L,
1143 __isl_take isl_pw_aff *R,
1144 __isl_keep isl_set *Domain) {
1145 isl_set *ConsequenceCondSet = buildConditionSet(Pred, L, R);
1146 return setDimensionIds(Domain, ConsequenceCondSet);
1147}
1148
1149/// @brief Build the conditions sets for the switch @p SI in the @p Domain.
Johannes Doerfert96425c22015-08-30 21:13:53 +00001150///
1151/// This will fill @p ConditionSets with the conditions under which control
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001152/// will be moved from @p SI to its successors. Hence, @p ConditionSets will
1153/// have as many elements as @p SI has successors.
Johannes Doerfert96425c22015-08-30 21:13:53 +00001154static void
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001155buildConditionSets(Scop &S, SwitchInst *SI, Loop *L, __isl_keep isl_set *Domain,
Johannes Doerfert96425c22015-08-30 21:13:53 +00001156 SmallVectorImpl<__isl_give isl_set *> &ConditionSets) {
1157
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001158 Value *Condition = getConditionFromTerminator(SI);
1159 assert(Condition && "No condition for switch");
1160
1161 ScalarEvolution &SE = *S.getSE();
1162 BasicBlock *BB = SI->getParent();
1163 isl_pw_aff *LHS, *RHS;
1164 LHS = S.getPwAff(SE.getSCEVAtScope(Condition, L), BB);
1165
1166 unsigned NumSuccessors = SI->getNumSuccessors();
1167 ConditionSets.resize(NumSuccessors);
1168 for (auto &Case : SI->cases()) {
1169 unsigned Idx = Case.getSuccessorIndex();
1170 ConstantInt *CaseValue = Case.getCaseValue();
1171
1172 RHS = S.getPwAff(SE.getSCEV(CaseValue), BB);
1173 isl_set *CaseConditionSet =
1174 buildConditionSet(ICmpInst::ICMP_EQ, isl_pw_aff_copy(LHS), RHS, Domain);
1175 ConditionSets[Idx] = isl_set_coalesce(
1176 isl_set_intersect(CaseConditionSet, isl_set_copy(Domain)));
1177 }
1178
1179 assert(ConditionSets[0] == nullptr && "Default condition set was set");
1180 isl_set *ConditionSetUnion = isl_set_copy(ConditionSets[1]);
1181 for (unsigned u = 2; u < NumSuccessors; u++)
1182 ConditionSetUnion =
1183 isl_set_union(ConditionSetUnion, isl_set_copy(ConditionSets[u]));
1184 ConditionSets[0] = setDimensionIds(
1185 Domain, isl_set_subtract(isl_set_copy(Domain), ConditionSetUnion));
1186
1187 S.markAsOptimized();
1188 isl_pw_aff_free(LHS);
1189}
1190
Johannes Doerfert9b1f9c82015-10-11 13:21:03 +00001191/// @brief Build the conditions sets for the branch condition @p Condition in
1192/// the @p Domain.
1193///
1194/// This will fill @p ConditionSets with the conditions under which control
1195/// will be moved from @p TI to its successors. Hence, @p ConditionSets will
Johannes Doerfert2af10e22015-11-12 03:25:01 +00001196/// have as many elements as @p TI has successors. If @p TI is nullptr the
1197/// context under which @p Condition is true/false will be returned as the
1198/// new elements of @p ConditionSets.
Johannes Doerfert9b1f9c82015-10-11 13:21:03 +00001199static void
1200buildConditionSets(Scop &S, Value *Condition, TerminatorInst *TI, Loop *L,
1201 __isl_keep isl_set *Domain,
1202 SmallVectorImpl<__isl_give isl_set *> &ConditionSets) {
1203
1204 isl_set *ConsequenceCondSet = nullptr;
1205 if (auto *CCond = dyn_cast<ConstantInt>(Condition)) {
1206 if (CCond->isZero())
1207 ConsequenceCondSet = isl_set_empty(isl_set_get_space(Domain));
1208 else
1209 ConsequenceCondSet = isl_set_universe(isl_set_get_space(Domain));
1210 } else if (BinaryOperator *BinOp = dyn_cast<BinaryOperator>(Condition)) {
1211 auto Opcode = BinOp->getOpcode();
1212 assert(Opcode == Instruction::And || Opcode == Instruction::Or);
1213
1214 buildConditionSets(S, BinOp->getOperand(0), TI, L, Domain, ConditionSets);
1215 buildConditionSets(S, BinOp->getOperand(1), TI, L, Domain, ConditionSets);
1216
1217 isl_set_free(ConditionSets.pop_back_val());
1218 isl_set *ConsCondPart0 = ConditionSets.pop_back_val();
1219 isl_set_free(ConditionSets.pop_back_val());
1220 isl_set *ConsCondPart1 = ConditionSets.pop_back_val();
1221
1222 if (Opcode == Instruction::And)
1223 ConsequenceCondSet = isl_set_intersect(ConsCondPart0, ConsCondPart1);
1224 else
1225 ConsequenceCondSet = isl_set_union(ConsCondPart0, ConsCondPart1);
1226 } else {
1227 auto *ICond = dyn_cast<ICmpInst>(Condition);
1228 assert(ICond &&
1229 "Condition of exiting branch was neither constant nor ICmp!");
1230
1231 ScalarEvolution &SE = *S.getSE();
Johannes Doerfert2af10e22015-11-12 03:25:01 +00001232 BasicBlock *BB = TI ? TI->getParent() : nullptr;
Johannes Doerfert9b1f9c82015-10-11 13:21:03 +00001233 isl_pw_aff *LHS, *RHS;
1234 LHS = S.getPwAff(SE.getSCEVAtScope(ICond->getOperand(0), L), BB);
1235 RHS = S.getPwAff(SE.getSCEVAtScope(ICond->getOperand(1), L), BB);
1236 ConsequenceCondSet =
1237 buildConditionSet(ICond->getPredicate(), LHS, RHS, Domain);
1238 }
1239
Johannes Doerfert2af10e22015-11-12 03:25:01 +00001240 // If no terminator was given we are only looking for parameter constraints
1241 // under which @p Condition is true/false.
1242 if (!TI)
1243 ConsequenceCondSet = isl_set_params(ConsequenceCondSet);
1244
Johannes Doerfert9b1f9c82015-10-11 13:21:03 +00001245 assert(ConsequenceCondSet);
1246 isl_set *AlternativeCondSet =
1247 isl_set_complement(isl_set_copy(ConsequenceCondSet));
1248
1249 ConditionSets.push_back(isl_set_coalesce(
1250 isl_set_intersect(ConsequenceCondSet, isl_set_copy(Domain))));
1251 ConditionSets.push_back(isl_set_coalesce(
1252 isl_set_intersect(AlternativeCondSet, isl_set_copy(Domain))));
1253}
1254
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001255/// @brief Build the conditions sets for the terminator @p TI in the @p Domain.
1256///
1257/// This will fill @p ConditionSets with the conditions under which control
1258/// will be moved from @p TI to its successors. Hence, @p ConditionSets will
1259/// have as many elements as @p TI has successors.
1260static void
1261buildConditionSets(Scop &S, TerminatorInst *TI, Loop *L,
1262 __isl_keep isl_set *Domain,
1263 SmallVectorImpl<__isl_give isl_set *> &ConditionSets) {
1264
1265 if (SwitchInst *SI = dyn_cast<SwitchInst>(TI))
1266 return buildConditionSets(S, SI, L, Domain, ConditionSets);
1267
1268 assert(isa<BranchInst>(TI) && "Terminator was neither branch nor switch.");
1269
1270 if (TI->getNumSuccessors() == 1) {
Johannes Doerfert96425c22015-08-30 21:13:53 +00001271 ConditionSets.push_back(isl_set_copy(Domain));
1272 return;
1273 }
1274
Johannes Doerfert9a132f32015-09-28 09:33:22 +00001275 Value *Condition = getConditionFromTerminator(TI);
1276 assert(Condition && "No condition for Terminator");
Johannes Doerfert96425c22015-08-30 21:13:53 +00001277
Johannes Doerfert9b1f9c82015-10-11 13:21:03 +00001278 return buildConditionSets(S, Condition, TI, L, Domain, ConditionSets);
Johannes Doerfert96425c22015-08-30 21:13:53 +00001279}
1280
Johannes Doerfert32ae76e2015-09-10 13:12:02 +00001281void ScopStmt::buildDomain() {
Michael Kruse526fcf52016-02-24 22:08:08 +00001282 isl_id *Id = isl_id_alloc(getIslCtx(), getBaseName(), this);
Tobias Grosser084d8f72012-05-29 09:29:44 +00001283
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00001284 Domain = getParent()->getDomainConditions(this);
Tobias Grosser084d8f72012-05-29 09:29:44 +00001285 Domain = isl_set_set_tuple_id(Domain, Id);
Tobias Grosser75805372011-04-29 06:27:02 +00001286}
1287
Hongbin Zheng7dddfba2016-02-13 15:12:47 +00001288void ScopStmt::deriveAssumptionsFromGEP(GetElementPtrInst *GEP,
1289 ScopDetection &SD) {
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001290 isl_ctx *Ctx = Parent.getIslCtx();
1291 isl_local_space *LSpace = isl_local_space_from_space(getDomainSpace());
1292 Type *Ty = GEP->getPointerOperandType();
1293 ScalarEvolution &SE = *Parent.getSE();
Johannes Doerfert09e36972015-10-07 20:17:36 +00001294
1295 // The set of loads that are required to be invariant.
1296 auto &ScopRIL = *SD.getRequiredInvariantLoads(&Parent.getRegion());
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001297
Tobias Grosserfaf8f6f2015-09-17 15:47:52 +00001298 std::vector<const SCEV *> Subscripts;
1299 std::vector<int> Sizes;
1300
Tobias Grosser5fd8c092015-09-17 17:28:15 +00001301 std::tie(Subscripts, Sizes) = getIndexExpressionsFromGEP(GEP, SE);
Tobias Grosserfaf8f6f2015-09-17 15:47:52 +00001302
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001303 if (auto *PtrTy = dyn_cast<PointerType>(Ty)) {
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001304 Ty = PtrTy->getElementType();
1305 }
1306
Tobias Grosserfaf8f6f2015-09-17 15:47:52 +00001307 int IndexOffset = Subscripts.size() - Sizes.size();
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001308
Tobias Grosserfaf8f6f2015-09-17 15:47:52 +00001309 assert(IndexOffset <= 1 && "Unexpected large index offset");
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001310
Tobias Grosserfaf8f6f2015-09-17 15:47:52 +00001311 for (size_t i = 0; i < Sizes.size(); i++) {
Johannes Doerferta90943d2016-02-21 16:37:25 +00001312 auto *Expr = Subscripts[i + IndexOffset];
Tobias Grosserfaf8f6f2015-09-17 15:47:52 +00001313 auto Size = Sizes[i];
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001314
Johannes Doerfert09e36972015-10-07 20:17:36 +00001315 InvariantLoadsSetTy AccessILS;
1316 if (!isAffineExpr(&Parent.getRegion(), Expr, SE, nullptr, &AccessILS))
1317 continue;
1318
1319 bool NonAffine = false;
1320 for (LoadInst *LInst : AccessILS)
1321 if (!ScopRIL.count(LInst))
1322 NonAffine = true;
1323
1324 if (NonAffine)
Tobias Grosserfaf8f6f2015-09-17 15:47:52 +00001325 continue;
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001326
Tobias Grosserfaf8f6f2015-09-17 15:47:52 +00001327 isl_pw_aff *AccessOffset = getPwAff(Expr);
1328 AccessOffset =
1329 isl_pw_aff_set_tuple_id(AccessOffset, isl_dim_in, getDomainId());
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001330
Tobias Grosserfaf8f6f2015-09-17 15:47:52 +00001331 isl_pw_aff *DimSize = isl_pw_aff_from_aff(isl_aff_val_on_domain(
1332 isl_local_space_copy(LSpace), isl_val_int_from_si(Ctx, Size)));
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001333
Tobias Grosserfaf8f6f2015-09-17 15:47:52 +00001334 isl_set *OutOfBound = isl_pw_aff_ge_set(AccessOffset, DimSize);
1335 OutOfBound = isl_set_intersect(getDomain(), OutOfBound);
1336 OutOfBound = isl_set_params(OutOfBound);
1337 isl_set *InBound = isl_set_complement(OutOfBound);
1338 isl_set *Executed = isl_set_params(getDomain());
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001339
Tobias Grosserfaf8f6f2015-09-17 15:47:52 +00001340 // A => B == !A or B
1341 isl_set *InBoundIfExecuted =
1342 isl_set_union(isl_set_complement(Executed), InBound);
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001343
Roman Gareev10595a12016-01-08 14:01:59 +00001344 InBoundIfExecuted = isl_set_coalesce(InBoundIfExecuted);
Johannes Doerfertd84493e2015-11-12 02:33:38 +00001345 Parent.addAssumption(INBOUNDS, InBoundIfExecuted, GEP->getDebugLoc());
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001346 }
1347
1348 isl_local_space_free(LSpace);
1349}
1350
Hongbin Zheng7dddfba2016-02-13 15:12:47 +00001351void ScopStmt::deriveAssumptions(BasicBlock *Block, ScopDetection &SD) {
Johannes Doerfertff9d1982015-02-24 12:00:50 +00001352 for (Instruction &Inst : *Block)
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001353 if (auto *GEP = dyn_cast<GetElementPtrInst>(&Inst))
Hongbin Zheng7dddfba2016-02-13 15:12:47 +00001354 deriveAssumptionsFromGEP(GEP, SD);
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001355}
1356
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00001357void ScopStmt::collectSurroundingLoops() {
1358 for (unsigned u = 0, e = isl_set_n_dim(Domain); u < e; u++) {
1359 isl_id *DimId = isl_set_get_dim_id(Domain, isl_dim_set, u);
1360 NestLoops.push_back(static_cast<Loop *>(isl_id_get_user(DimId)));
1361 isl_id_free(DimId);
1362 }
1363}
1364
Michael Kruse9d080092015-09-11 21:41:48 +00001365ScopStmt::ScopStmt(Scop &parent, Region &R)
Michael Krusecac948e2015-10-02 13:53:07 +00001366 : Parent(parent), Domain(nullptr), BB(nullptr), R(&R), Build(nullptr) {
Johannes Doerfertff9d1982015-02-24 12:00:50 +00001367
Tobias Grosser16c44032015-07-09 07:31:45 +00001368 BaseName = getIslCompatibleName("Stmt_", R.getNameStr(), "");
Johannes Doerfertff9d1982015-02-24 12:00:50 +00001369}
1370
Michael Kruse9d080092015-09-11 21:41:48 +00001371ScopStmt::ScopStmt(Scop &parent, BasicBlock &bb)
Michael Krusecac948e2015-10-02 13:53:07 +00001372 : Parent(parent), Domain(nullptr), BB(&bb), R(nullptr), Build(nullptr) {
Tobias Grosser75805372011-04-29 06:27:02 +00001373
Johannes Doerfert79fc23f2014-07-24 23:48:02 +00001374 BaseName = getIslCompatibleName("Stmt_", &bb, "");
Michael Krusecac948e2015-10-02 13:53:07 +00001375}
1376
Hongbin Zheng7dddfba2016-02-13 15:12:47 +00001377void ScopStmt::init(ScopDetection &SD) {
Michael Krusecac948e2015-10-02 13:53:07 +00001378 assert(!Domain && "init must be called only once");
Tobias Grosser75805372011-04-29 06:27:02 +00001379
Johannes Doerfert32ae76e2015-09-10 13:12:02 +00001380 buildDomain();
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00001381 collectSurroundingLoops();
Michael Krusecac948e2015-10-02 13:53:07 +00001382 buildAccessRelations();
1383
1384 if (BB) {
Hongbin Zheng7dddfba2016-02-13 15:12:47 +00001385 deriveAssumptions(BB, SD);
Michael Krusecac948e2015-10-02 13:53:07 +00001386 } else {
1387 for (BasicBlock *Block : R->blocks()) {
Hongbin Zheng7dddfba2016-02-13 15:12:47 +00001388 deriveAssumptions(Block, SD);
Michael Krusecac948e2015-10-02 13:53:07 +00001389 }
1390 }
1391
Tobias Grosserd83b8a82015-08-20 19:08:11 +00001392 if (DetectReductions)
1393 checkForReductions();
Johannes Doerfert0ee1f212014-06-17 17:31:36 +00001394}
1395
Johannes Doerferte58a0122014-06-27 20:31:28 +00001396/// @brief Collect loads which might form a reduction chain with @p StoreMA
1397///
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00001398/// Check if the stored value for @p StoreMA is a binary operator with one or
1399/// two loads as operands. If the binary operand is commutative & associative,
Johannes Doerferte58a0122014-06-27 20:31:28 +00001400/// used only once (by @p StoreMA) and its load operands are also used only
1401/// once, we have found a possible reduction chain. It starts at an operand
1402/// load and includes the binary operator and @p StoreMA.
1403///
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00001404/// Note: We allow only one use to ensure the load and binary operator cannot
Johannes Doerferte58a0122014-06-27 20:31:28 +00001405/// escape this block or into any other store except @p StoreMA.
1406void ScopStmt::collectCandiateReductionLoads(
1407 MemoryAccess *StoreMA, SmallVectorImpl<MemoryAccess *> &Loads) {
1408 auto *Store = dyn_cast<StoreInst>(StoreMA->getAccessInstruction());
1409 if (!Store)
Johannes Doerfert0ee1f212014-06-17 17:31:36 +00001410 return;
1411
1412 // Skip if there is not one binary operator between the load and the store
1413 auto *BinOp = dyn_cast<BinaryOperator>(Store->getValueOperand());
Johannes Doerferte58a0122014-06-27 20:31:28 +00001414 if (!BinOp)
1415 return;
1416
1417 // Skip if the binary operators has multiple uses
1418 if (BinOp->getNumUses() != 1)
Johannes Doerfert0ee1f212014-06-17 17:31:36 +00001419 return;
1420
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00001421 // Skip if the opcode of the binary operator is not commutative/associative
Johannes Doerfert0ee1f212014-06-17 17:31:36 +00001422 if (!BinOp->isCommutative() || !BinOp->isAssociative())
1423 return;
1424
Johannes Doerfert9890a052014-07-01 00:32:29 +00001425 // Skip if the binary operator is outside the current SCoP
1426 if (BinOp->getParent() != Store->getParent())
1427 return;
1428
Johannes Doerfert0ee1f212014-06-17 17:31:36 +00001429 // Skip if it is a multiplicative reduction and we disabled them
1430 if (DisableMultiplicativeReductions &&
1431 (BinOp->getOpcode() == Instruction::Mul ||
1432 BinOp->getOpcode() == Instruction::FMul))
1433 return;
1434
Johannes Doerferte58a0122014-06-27 20:31:28 +00001435 // Check the binary operator operands for a candidate load
1436 auto *PossibleLoad0 = dyn_cast<LoadInst>(BinOp->getOperand(0));
1437 auto *PossibleLoad1 = dyn_cast<LoadInst>(BinOp->getOperand(1));
1438 if (!PossibleLoad0 && !PossibleLoad1)
1439 return;
1440
1441 // A load is only a candidate if it cannot escape (thus has only this use)
1442 if (PossibleLoad0 && PossibleLoad0->getNumUses() == 1)
Johannes Doerfert9890a052014-07-01 00:32:29 +00001443 if (PossibleLoad0->getParent() == Store->getParent())
Tobias Grosser35ec5fb2015-12-15 23:50:04 +00001444 Loads.push_back(&getArrayAccessFor(PossibleLoad0));
Johannes Doerferte58a0122014-06-27 20:31:28 +00001445 if (PossibleLoad1 && PossibleLoad1->getNumUses() == 1)
Johannes Doerfert9890a052014-07-01 00:32:29 +00001446 if (PossibleLoad1->getParent() == Store->getParent())
Tobias Grosser35ec5fb2015-12-15 23:50:04 +00001447 Loads.push_back(&getArrayAccessFor(PossibleLoad1));
Johannes Doerferte58a0122014-06-27 20:31:28 +00001448}
1449
1450/// @brief Check for reductions in this ScopStmt
1451///
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00001452/// Iterate over all store memory accesses and check for valid binary reduction
1453/// like chains. For all candidates we check if they have the same base address
1454/// and there are no other accesses which overlap with them. The base address
1455/// check rules out impossible reductions candidates early. The overlap check,
1456/// together with the "only one user" check in collectCandiateReductionLoads,
Johannes Doerferte58a0122014-06-27 20:31:28 +00001457/// guarantees that none of the intermediate results will escape during
1458/// execution of the loop nest. We basically check here that no other memory
1459/// access can access the same memory as the potential reduction.
1460void ScopStmt::checkForReductions() {
1461 SmallVector<MemoryAccess *, 2> Loads;
1462 SmallVector<std::pair<MemoryAccess *, MemoryAccess *>, 4> Candidates;
1463
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00001464 // First collect candidate load-store reduction chains by iterating over all
Johannes Doerferte58a0122014-06-27 20:31:28 +00001465 // stores and collecting possible reduction loads.
1466 for (MemoryAccess *StoreMA : MemAccs) {
1467 if (StoreMA->isRead())
1468 continue;
1469
1470 Loads.clear();
1471 collectCandiateReductionLoads(StoreMA, Loads);
1472 for (MemoryAccess *LoadMA : Loads)
1473 Candidates.push_back(std::make_pair(LoadMA, StoreMA));
1474 }
1475
1476 // Then check each possible candidate pair.
1477 for (const auto &CandidatePair : Candidates) {
1478 bool Valid = true;
1479 isl_map *LoadAccs = CandidatePair.first->getAccessRelation();
1480 isl_map *StoreAccs = CandidatePair.second->getAccessRelation();
1481
1482 // Skip those with obviously unequal base addresses.
1483 if (!isl_map_has_equal_space(LoadAccs, StoreAccs)) {
1484 isl_map_free(LoadAccs);
1485 isl_map_free(StoreAccs);
1486 continue;
1487 }
1488
1489 // And check if the remaining for overlap with other memory accesses.
1490 isl_map *AllAccsRel = isl_map_union(LoadAccs, StoreAccs);
1491 AllAccsRel = isl_map_intersect_domain(AllAccsRel, getDomain());
1492 isl_set *AllAccs = isl_map_range(AllAccsRel);
1493
1494 for (MemoryAccess *MA : MemAccs) {
1495 if (MA == CandidatePair.first || MA == CandidatePair.second)
1496 continue;
1497
1498 isl_map *AccRel =
1499 isl_map_intersect_domain(MA->getAccessRelation(), getDomain());
1500 isl_set *Accs = isl_map_range(AccRel);
1501
1502 if (isl_set_has_equal_space(AllAccs, Accs) || isl_set_free(Accs)) {
1503 isl_set *OverlapAccs = isl_set_intersect(Accs, isl_set_copy(AllAccs));
1504 Valid = Valid && isl_set_is_empty(OverlapAccs);
1505 isl_set_free(OverlapAccs);
1506 }
1507 }
1508
1509 isl_set_free(AllAccs);
1510 if (!Valid)
1511 continue;
1512
Johannes Doerfertf6183392014-07-01 20:52:51 +00001513 const LoadInst *Load =
1514 dyn_cast<const LoadInst>(CandidatePair.first->getAccessInstruction());
1515 MemoryAccess::ReductionType RT =
1516 getReductionType(dyn_cast<BinaryOperator>(Load->user_back()), Load);
1517
Johannes Doerferte58a0122014-06-27 20:31:28 +00001518 // If no overlapping access was found we mark the load and store as
1519 // reduction like.
Johannes Doerfertf6183392014-07-01 20:52:51 +00001520 CandidatePair.first->markAsReductionLike(RT);
1521 CandidatePair.second->markAsReductionLike(RT);
Johannes Doerferte58a0122014-06-27 20:31:28 +00001522 }
Tobias Grosser75805372011-04-29 06:27:02 +00001523}
1524
Tobias Grosser74394f02013-01-14 22:40:23 +00001525std::string ScopStmt::getDomainStr() const { return stringFromIslObj(Domain); }
Tobias Grosser75805372011-04-29 06:27:02 +00001526
Tobias Grosser54839312015-04-21 11:37:25 +00001527std::string ScopStmt::getScheduleStr() const {
Tobias Grosser808cd692015-07-14 09:33:13 +00001528 auto *S = getSchedule();
1529 auto Str = stringFromIslObj(S);
1530 isl_map_free(S);
1531 return Str;
Tobias Grosser75805372011-04-29 06:27:02 +00001532}
1533
Tobias Grosser74394f02013-01-14 22:40:23 +00001534unsigned ScopStmt::getNumParams() const { return Parent.getNumParams(); }
Tobias Grosser75805372011-04-29 06:27:02 +00001535
Tobias Grosserf567e1a2015-02-19 22:16:12 +00001536unsigned ScopStmt::getNumIterators() const { return NestLoops.size(); }
Tobias Grosser75805372011-04-29 06:27:02 +00001537
Tobias Grosser75805372011-04-29 06:27:02 +00001538const char *ScopStmt::getBaseName() const { return BaseName.c_str(); }
1539
Hongbin Zheng27f3afb2011-04-30 03:26:51 +00001540const Loop *ScopStmt::getLoopForDimension(unsigned Dimension) const {
Sebastian Pop860e0212013-02-15 21:26:44 +00001541 return NestLoops[Dimension];
Tobias Grosser75805372011-04-29 06:27:02 +00001542}
1543
Tobias Grosser74394f02013-01-14 22:40:23 +00001544isl_ctx *ScopStmt::getIslCtx() const { return Parent.getIslCtx(); }
Tobias Grosser75805372011-04-29 06:27:02 +00001545
Tobias Grosser4f663aa2015-03-30 11:52:59 +00001546__isl_give isl_set *ScopStmt::getDomain() const { return isl_set_copy(Domain); }
Tobias Grosserd5a7bfc2011-05-06 19:52:19 +00001547
Tobias Grosser6e6c7e02015-03-30 12:22:39 +00001548__isl_give isl_space *ScopStmt::getDomainSpace() const {
Tobias Grosser78d8a3d2012-01-17 20:34:23 +00001549 return isl_set_get_space(Domain);
1550}
1551
Tobias Grosser4f663aa2015-03-30 11:52:59 +00001552__isl_give isl_id *ScopStmt::getDomainId() const {
1553 return isl_set_get_tuple_id(Domain);
1554}
Tobias Grossercd95b772012-08-30 11:49:38 +00001555
Tobias Grosser10120182015-12-16 16:14:03 +00001556ScopStmt::~ScopStmt() { isl_set_free(Domain); }
Tobias Grosser75805372011-04-29 06:27:02 +00001557
1558void ScopStmt::print(raw_ostream &OS) const {
1559 OS << "\t" << getBaseName() << "\n";
Tobias Grosser75805372011-04-29 06:27:02 +00001560 OS.indent(12) << "Domain :=\n";
1561
1562 if (Domain) {
1563 OS.indent(16) << getDomainStr() << ";\n";
1564 } else
1565 OS.indent(16) << "n/a\n";
1566
Tobias Grosser54839312015-04-21 11:37:25 +00001567 OS.indent(12) << "Schedule :=\n";
Tobias Grosser75805372011-04-29 06:27:02 +00001568
1569 if (Domain) {
Tobias Grosser54839312015-04-21 11:37:25 +00001570 OS.indent(16) << getScheduleStr() << ";\n";
Tobias Grosser75805372011-04-29 06:27:02 +00001571 } else
1572 OS.indent(16) << "n/a\n";
1573
Tobias Grosser083d3d32014-06-28 08:59:45 +00001574 for (MemoryAccess *Access : MemAccs)
1575 Access->print(OS);
Tobias Grosser75805372011-04-29 06:27:02 +00001576}
1577
1578void ScopStmt::dump() const { print(dbgs()); }
1579
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00001580void ScopStmt::removeMemoryAccesses(MemoryAccessList &InvMAs) {
Tobias Grosseref9ca5d2015-11-30 17:20:40 +00001581 // Remove all memory accesses in @p InvMAs from this statement
1582 // together with all scalar accesses that were caused by them.
Michael Krusead28e5a2016-01-26 13:33:15 +00001583 // MK_Value READs have no access instruction, hence would not be removed by
1584 // this function. However, it is only used for invariant LoadInst accesses,
1585 // its arguments are always affine, hence synthesizable, and therefore there
1586 // are no MK_Value READ accesses to be removed.
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00001587 for (MemoryAccess *MA : InvMAs) {
Tobias Grosseref9ca5d2015-11-30 17:20:40 +00001588 auto Predicate = [&](MemoryAccess *Acc) {
Tobias Grosser3a6ac9f2015-11-30 21:13:43 +00001589 return Acc->getAccessInstruction() == MA->getAccessInstruction();
Tobias Grosseref9ca5d2015-11-30 17:20:40 +00001590 };
1591 MemAccs.erase(std::remove_if(MemAccs.begin(), MemAccs.end(), Predicate),
1592 MemAccs.end());
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00001593 InstructionToAccess.erase(MA->getAccessInstruction());
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00001594 }
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00001595}
1596
Tobias Grosser75805372011-04-29 06:27:02 +00001597//===----------------------------------------------------------------------===//
1598/// Scop class implement
Tobias Grosser60b54f12011-11-08 15:41:28 +00001599
Tobias Grosser7ffe4e82011-11-17 12:56:10 +00001600void Scop::setContext(__isl_take isl_set *NewContext) {
Tobias Grosserff9b54d2011-11-15 11:38:44 +00001601 NewContext = isl_set_align_params(NewContext, isl_set_get_space(Context));
1602 isl_set_free(Context);
1603 Context = NewContext;
1604}
1605
Johannes Doerfertd6fc0702015-11-03 16:47:58 +00001606/// @brief Remap parameter values but keep AddRecs valid wrt. invariant loads.
1607struct SCEVSensitiveParameterRewriter
1608 : public SCEVVisitor<SCEVSensitiveParameterRewriter, const SCEV *> {
1609 ValueToValueMap &VMap;
1610 ScalarEvolution &SE;
1611
1612public:
1613 SCEVSensitiveParameterRewriter(ValueToValueMap &VMap, ScalarEvolution &SE)
1614 : VMap(VMap), SE(SE) {}
1615
1616 static const SCEV *rewrite(const SCEV *E, ScalarEvolution &SE,
1617 ValueToValueMap &VMap) {
1618 SCEVSensitiveParameterRewriter SSPR(VMap, SE);
1619 return SSPR.visit(E);
1620 }
1621
1622 const SCEV *visit(const SCEV *E) {
1623 return SCEVVisitor<SCEVSensitiveParameterRewriter, const SCEV *>::visit(E);
1624 }
1625
1626 const SCEV *visitConstant(const SCEVConstant *E) { return E; }
1627
1628 const SCEV *visitTruncateExpr(const SCEVTruncateExpr *E) {
1629 return SE.getTruncateExpr(visit(E->getOperand()), E->getType());
1630 }
1631
1632 const SCEV *visitZeroExtendExpr(const SCEVZeroExtendExpr *E) {
1633 return SE.getZeroExtendExpr(visit(E->getOperand()), E->getType());
1634 }
1635
1636 const SCEV *visitSignExtendExpr(const SCEVSignExtendExpr *E) {
1637 return SE.getSignExtendExpr(visit(E->getOperand()), E->getType());
1638 }
1639
1640 const SCEV *visitAddExpr(const SCEVAddExpr *E) {
1641 SmallVector<const SCEV *, 4> Operands;
1642 for (int i = 0, e = E->getNumOperands(); i < e; ++i)
1643 Operands.push_back(visit(E->getOperand(i)));
1644 return SE.getAddExpr(Operands);
1645 }
1646
1647 const SCEV *visitMulExpr(const SCEVMulExpr *E) {
1648 SmallVector<const SCEV *, 4> Operands;
1649 for (int i = 0, e = E->getNumOperands(); i < e; ++i)
1650 Operands.push_back(visit(E->getOperand(i)));
1651 return SE.getMulExpr(Operands);
1652 }
1653
1654 const SCEV *visitSMaxExpr(const SCEVSMaxExpr *E) {
1655 SmallVector<const SCEV *, 4> Operands;
1656 for (int i = 0, e = E->getNumOperands(); i < e; ++i)
1657 Operands.push_back(visit(E->getOperand(i)));
1658 return SE.getSMaxExpr(Operands);
1659 }
1660
1661 const SCEV *visitUMaxExpr(const SCEVUMaxExpr *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.getUMaxExpr(Operands);
1666 }
1667
1668 const SCEV *visitUDivExpr(const SCEVUDivExpr *E) {
1669 return SE.getUDivExpr(visit(E->getLHS()), visit(E->getRHS()));
1670 }
1671
1672 const SCEV *visitAddRecExpr(const SCEVAddRecExpr *E) {
1673 auto *Start = visit(E->getStart());
1674 auto *AddRec = SE.getAddRecExpr(SE.getConstant(E->getType(), 0),
1675 visit(E->getStepRecurrence(SE)),
1676 E->getLoop(), SCEV::FlagAnyWrap);
1677 return SE.getAddExpr(Start, AddRec);
1678 }
1679
1680 const SCEV *visitUnknown(const SCEVUnknown *E) {
1681 if (auto *NewValue = VMap.lookup(E->getValue()))
1682 return SE.getUnknown(NewValue);
1683 return E;
1684 }
1685};
1686
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00001687const SCEV *Scop::getRepresentingInvariantLoadSCEV(const SCEV *S) {
Johannes Doerfertd6fc0702015-11-03 16:47:58 +00001688 return SCEVSensitiveParameterRewriter::rewrite(S, *SE, InvEquivClassVMap);
Johannes Doerfert697fdf82015-10-09 17:12:26 +00001689}
1690
Tobias Grosserabfbe632013-02-05 12:09:06 +00001691void Scop::addParams(std::vector<const SCEV *> NewParameters) {
Tobias Grosser083d3d32014-06-28 08:59:45 +00001692 for (const SCEV *Parameter : NewParameters) {
Johannes Doerfertbe409962015-03-29 20:45:09 +00001693 Parameter = extractConstantFactor(Parameter, *SE).second;
Johannes Doerfert697fdf82015-10-09 17:12:26 +00001694
1695 // Normalize the SCEV to get the representing element for an invariant load.
1696 Parameter = getRepresentingInvariantLoadSCEV(Parameter);
1697
Tobias Grosser60b54f12011-11-08 15:41:28 +00001698 if (ParameterIds.find(Parameter) != ParameterIds.end())
1699 continue;
1700
1701 int dimension = Parameters.size();
1702
1703 Parameters.push_back(Parameter);
1704 ParameterIds[Parameter] = dimension;
1705 }
1706}
1707
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00001708__isl_give isl_id *Scop::getIdForParam(const SCEV *Parameter) {
Johannes Doerfert697fdf82015-10-09 17:12:26 +00001709 // Normalize the SCEV to get the representing element for an invariant load.
1710 Parameter = getRepresentingInvariantLoadSCEV(Parameter);
1711
Tobias Grosser9a38ab82011-11-08 15:41:03 +00001712 ParamIdType::const_iterator IdIter = ParameterIds.find(Parameter);
Tobias Grosser76c2e322011-11-07 12:58:59 +00001713
Tobias Grosser9a38ab82011-11-08 15:41:03 +00001714 if (IdIter == ParameterIds.end())
Tobias Grosser5a56cbf2014-04-16 07:33:47 +00001715 return nullptr;
Tobias Grosser76c2e322011-11-07 12:58:59 +00001716
Tobias Grosser8f99c162011-11-15 11:38:55 +00001717 std::string ParameterName;
1718
Craig Topper7fb6e472016-01-31 20:36:20 +00001719 ParameterName = "p_" + utostr(IdIter->second);
Tobias Grosserb39c96a2015-11-17 11:54:51 +00001720
Tobias Grosser8f99c162011-11-15 11:38:55 +00001721 if (const SCEVUnknown *ValueParameter = dyn_cast<SCEVUnknown>(Parameter)) {
1722 Value *Val = ValueParameter->getValue();
Tobias Grosser8f99c162011-11-15 11:38:55 +00001723
Tobias Grosserb39c96a2015-11-17 11:54:51 +00001724 // If this parameter references a specific Value and this value has a name
1725 // we use this name as it is likely to be unique and more useful than just
1726 // a number.
1727 if (Val->hasName())
1728 ParameterName = Val->getName();
1729 else if (LoadInst *LI = dyn_cast<LoadInst>(Val)) {
Johannes Doerferta90943d2016-02-21 16:37:25 +00001730 auto *LoadOrigin = LI->getPointerOperand()->stripInBoundsOffsets();
Tobias Grosserb39c96a2015-11-17 11:54:51 +00001731 if (LoadOrigin->hasName()) {
1732 ParameterName += "_loaded_from_";
1733 ParameterName +=
1734 LI->getPointerOperand()->stripInBoundsOffsets()->getName();
1735 }
1736 }
1737 }
Tobias Grosser8f99c162011-11-15 11:38:55 +00001738
Tobias Grosser20532b82014-04-11 17:56:49 +00001739 return isl_id_alloc(getIslCtx(), ParameterName.c_str(),
1740 const_cast<void *>((const void *)Parameter));
Tobias Grosser76c2e322011-11-07 12:58:59 +00001741}
Tobias Grosser75805372011-04-29 06:27:02 +00001742
Johannes Doerfert5d5b3062015-08-20 18:06:30 +00001743isl_set *Scop::addNonEmptyDomainConstraints(isl_set *C) const {
1744 isl_set *DomainContext = isl_union_set_params(getDomains());
1745 return isl_set_intersect_params(C, DomainContext);
1746}
1747
Johannes Doerfert883f8c12015-09-15 22:52:53 +00001748void Scop::buildBoundaryContext() {
Tobias Grosser4927c8e2015-11-24 12:50:02 +00001749 if (IgnoreIntegerWrapping) {
1750 BoundaryContext = isl_set_universe(getParamSpace());
1751 return;
1752 }
1753
Johannes Doerfert883f8c12015-09-15 22:52:53 +00001754 BoundaryContext = Affinator.getWrappingContext();
Tobias Grosser4cd07b12015-11-11 17:34:02 +00001755
1756 // The isl_set_complement operation used to create the boundary context
1757 // can possibly become very expensive. We bound the compile time of
1758 // this operation by setting a compute out.
1759 //
1760 // TODO: We can probably get around using isl_set_complement and directly
1761 // AST generate BoundaryContext.
1762 long MaxOpsOld = isl_ctx_get_max_operations(getIslCtx());
Tobias Grosserf920fb12015-11-13 16:56:13 +00001763 isl_ctx_reset_operations(getIslCtx());
Tobias Grosser4cd07b12015-11-11 17:34:02 +00001764 isl_ctx_set_max_operations(getIslCtx(), 300000);
1765 isl_options_set_on_error(getIslCtx(), ISL_ON_ERROR_CONTINUE);
1766
Johannes Doerfert883f8c12015-09-15 22:52:53 +00001767 BoundaryContext = isl_set_complement(BoundaryContext);
Tobias Grosser4cd07b12015-11-11 17:34:02 +00001768
Tobias Grossera52b4da2015-11-11 17:59:53 +00001769 if (isl_ctx_last_error(getIslCtx()) == isl_error_quota) {
1770 isl_set_free(BoundaryContext);
Tobias Grosser4cd07b12015-11-11 17:34:02 +00001771 BoundaryContext = isl_set_empty(getParamSpace());
Tobias Grossera52b4da2015-11-11 17:59:53 +00001772 }
Tobias Grosser4cd07b12015-11-11 17:34:02 +00001773
1774 isl_options_set_on_error(getIslCtx(), ISL_ON_ERROR_ABORT);
1775 isl_ctx_reset_operations(getIslCtx());
1776 isl_ctx_set_max_operations(getIslCtx(), MaxOpsOld);
Johannes Doerfert883f8c12015-09-15 22:52:53 +00001777 BoundaryContext = isl_set_gist_params(BoundaryContext, getContext());
Johannes Doerfertd84493e2015-11-12 02:33:38 +00001778 trackAssumption(WRAPPING, BoundaryContext, DebugLoc());
Johannes Doerfert883f8c12015-09-15 22:52:53 +00001779}
1780
Hongbin Zheng192f69a2016-02-13 15:12:54 +00001781void Scop::addUserAssumptions(AssumptionCache &AC, DominatorTree &DT,
1782 LoopInfo &LI) {
Johannes Doerfert2af10e22015-11-12 03:25:01 +00001783 auto *R = &getRegion();
1784 auto &F = *R->getEntry()->getParent();
1785 for (auto &Assumption : AC.assumptions()) {
1786 auto *CI = dyn_cast_or_null<CallInst>(Assumption);
1787 if (!CI || CI->getNumArgOperands() != 1)
1788 continue;
1789 if (!DT.dominates(CI->getParent(), R->getEntry()))
1790 continue;
1791
1792 auto *Val = CI->getArgOperand(0);
1793 std::vector<const SCEV *> Params;
1794 if (!isAffineParamConstraint(Val, R, *SE, Params)) {
1795 emitOptimizationRemarkAnalysis(F.getContext(), DEBUG_TYPE, F,
1796 CI->getDebugLoc(),
1797 "Non-affine user assumption ignored.");
1798 continue;
1799 }
1800
1801 addParams(Params);
1802
1803 auto *L = LI.getLoopFor(CI->getParent());
1804 SmallVector<isl_set *, 2> ConditionSets;
1805 buildConditionSets(*this, Val, nullptr, L, Context, ConditionSets);
1806 assert(ConditionSets.size() == 2);
1807 isl_set_free(ConditionSets[1]);
1808
1809 auto *AssumptionCtx = ConditionSets[0];
1810 emitOptimizationRemarkAnalysis(
1811 F.getContext(), DEBUG_TYPE, F, CI->getDebugLoc(),
1812 "Use user assumption: " + stringFromIslObj(AssumptionCtx));
1813 Context = isl_set_intersect(Context, AssumptionCtx);
1814 }
1815}
1816
Tobias Grosser8a9c2352015-08-16 10:19:29 +00001817void Scop::addUserContext() {
1818 if (UserContextStr.empty())
1819 return;
1820
Hongbin Zheng8831eb72016-02-17 15:49:21 +00001821 isl_set *UserContext =
1822 isl_set_read_from_str(getIslCtx(), UserContextStr.c_str());
Tobias Grosser8a9c2352015-08-16 10:19:29 +00001823 isl_space *Space = getParamSpace();
1824 if (isl_space_dim(Space, isl_dim_param) !=
1825 isl_set_dim(UserContext, isl_dim_param)) {
1826 auto SpaceStr = isl_space_to_str(Space);
1827 errs() << "Error: the context provided in -polly-context has not the same "
1828 << "number of dimensions than the computed context. Due to this "
1829 << "mismatch, the -polly-context option is ignored. Please provide "
1830 << "the context in the parameter space: " << SpaceStr << ".\n";
1831 free(SpaceStr);
1832 isl_set_free(UserContext);
1833 isl_space_free(Space);
1834 return;
1835 }
1836
1837 for (unsigned i = 0; i < isl_space_dim(Space, isl_dim_param); i++) {
Johannes Doerferta90943d2016-02-21 16:37:25 +00001838 auto *NameContext = isl_set_get_dim_name(Context, isl_dim_param, i);
1839 auto *NameUserContext = isl_set_get_dim_name(UserContext, isl_dim_param, i);
Tobias Grosser8a9c2352015-08-16 10:19:29 +00001840
1841 if (strcmp(NameContext, NameUserContext) != 0) {
1842 auto SpaceStr = isl_space_to_str(Space);
1843 errs() << "Error: the name of dimension " << i
1844 << " provided in -polly-context "
1845 << "is '" << NameUserContext << "', but the name in the computed "
1846 << "context is '" << NameContext
1847 << "'. Due to this name mismatch, "
1848 << "the -polly-context option is ignored. Please provide "
1849 << "the context in the parameter space: " << SpaceStr << ".\n";
1850 free(SpaceStr);
1851 isl_set_free(UserContext);
1852 isl_space_free(Space);
1853 return;
1854 }
1855
1856 UserContext =
1857 isl_set_set_dim_id(UserContext, isl_dim_param, i,
1858 isl_space_get_dim_id(Space, isl_dim_param, i));
1859 }
1860
1861 Context = isl_set_intersect(Context, UserContext);
1862 isl_space_free(Space);
1863}
1864
Hongbin Zheng7dddfba2016-02-13 15:12:47 +00001865void Scop::buildInvariantEquivalenceClasses(ScopDetection &SD) {
Johannes Doerfert96e54712016-02-07 17:30:13 +00001866 DenseMap<std::pair<const SCEV *, Type *>, LoadInst *> EquivClasses;
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00001867
Johannes Doerfert697fdf82015-10-09 17:12:26 +00001868 const InvariantLoadsSetTy &RIL = *SD.getRequiredInvariantLoads(&getRegion());
Johannes Doerfert697fdf82015-10-09 17:12:26 +00001869 for (LoadInst *LInst : RIL) {
1870 const SCEV *PointerSCEV = SE->getSCEV(LInst->getPointerOperand());
1871
Johannes Doerfert96e54712016-02-07 17:30:13 +00001872 Type *Ty = LInst->getType();
1873 LoadInst *&ClassRep = EquivClasses[std::make_pair(PointerSCEV, Ty)];
Johannes Doerfertfc4bfc42015-11-11 04:30:07 +00001874 if (ClassRep) {
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00001875 InvEquivClassVMap[LInst] = ClassRep;
Johannes Doerfertfc4bfc42015-11-11 04:30:07 +00001876 continue;
1877 }
1878
1879 ClassRep = LInst;
Johannes Doerfert96e54712016-02-07 17:30:13 +00001880 InvariantEquivClasses.emplace_back(PointerSCEV, MemoryAccessList(), nullptr,
1881 Ty);
Johannes Doerfert697fdf82015-10-09 17:12:26 +00001882 }
1883}
1884
Tobias Grosser6be480c2011-11-08 15:41:13 +00001885void Scop::buildContext() {
Hongbin Zheng8831eb72016-02-17 15:49:21 +00001886 isl_space *Space = isl_space_params_alloc(getIslCtx(), 0);
Tobias Grossere86109f2013-10-29 21:05:49 +00001887 Context = isl_set_universe(isl_space_copy(Space));
1888 AssumedContext = isl_set_universe(Space);
Tobias Grosser0e27e242011-10-06 00:03:48 +00001889}
1890
Tobias Grosser18daaca2012-05-22 10:47:27 +00001891void Scop::addParameterBounds() {
Johannes Doerfert4f8ac3d2015-02-23 16:15:51 +00001892 for (const auto &ParamID : ParameterIds) {
Johannes Doerfert4f8ac3d2015-02-23 16:15:51 +00001893 int dim = ParamID.second;
Tobias Grosser18daaca2012-05-22 10:47:27 +00001894
Johannes Doerfert4f8ac3d2015-02-23 16:15:51 +00001895 ConstantRange SRange = SE->getSignedRange(ParamID.first);
Tobias Grosser18daaca2012-05-22 10:47:27 +00001896
Johannes Doerferte7044942015-02-24 11:58:30 +00001897 Context = addRangeBoundsToSet(Context, SRange, dim, isl_dim_param);
Tobias Grosser18daaca2012-05-22 10:47:27 +00001898 }
1899}
1900
Tobias Grosser8cae72f2011-11-08 15:41:08 +00001901void Scop::realignParams() {
Tobias Grosser6be480c2011-11-08 15:41:13 +00001902 // Add all parameters into a common model.
Hongbin Zheng8831eb72016-02-17 15:49:21 +00001903 isl_space *Space = isl_space_params_alloc(getIslCtx(), ParameterIds.size());
Tobias Grosser6be480c2011-11-08 15:41:13 +00001904
Tobias Grosser083d3d32014-06-28 08:59:45 +00001905 for (const auto &ParamID : ParameterIds) {
1906 const SCEV *Parameter = ParamID.first;
Tobias Grosser6be480c2011-11-08 15:41:13 +00001907 isl_id *id = getIdForParam(Parameter);
Tobias Grosser083d3d32014-06-28 08:59:45 +00001908 Space = isl_space_set_dim_id(Space, isl_dim_param, ParamID.second, id);
Tobias Grosser6be480c2011-11-08 15:41:13 +00001909 }
1910
1911 // Align the parameters of all data structures to the model.
1912 Context = isl_set_align_params(Context, Space);
1913
Tobias Grosser7c3bad52015-05-27 05:16:57 +00001914 for (ScopStmt &Stmt : *this)
1915 Stmt.realignParams();
Tobias Grosser8cae72f2011-11-08 15:41:08 +00001916}
1917
Johannes Doerfert883f8c12015-09-15 22:52:53 +00001918static __isl_give isl_set *
1919simplifyAssumptionContext(__isl_take isl_set *AssumptionContext,
1920 const Scop &S) {
Johannes Doerfertf85ad042015-11-08 20:16:39 +00001921 // If we modelt all blocks in the SCoP that have side effects we can simplify
1922 // the context with the constraints that are needed for anything to be
1923 // executed at all. However, if we have error blocks in the SCoP we already
1924 // assumed some parameter combinations cannot occure and removed them from the
1925 // domains, thus we cannot use the remaining domain to simplify the
1926 // assumptions.
1927 if (!S.hasErrorBlock()) {
1928 isl_set *DomainParameters = isl_union_set_params(S.getDomains());
1929 AssumptionContext =
1930 isl_set_gist_params(AssumptionContext, DomainParameters);
1931 }
1932
Johannes Doerfert883f8c12015-09-15 22:52:53 +00001933 AssumptionContext = isl_set_gist_params(AssumptionContext, S.getContext());
1934 return AssumptionContext;
1935}
1936
1937void Scop::simplifyContexts() {
Tobias Grosser5e6813d2014-07-02 17:47:48 +00001938 // The parameter constraints of the iteration domains give us a set of
1939 // constraints that need to hold for all cases where at least a single
1940 // statement iteration is executed in the whole scop. We now simplify the
1941 // assumed context under the assumption that such constraints hold and at
1942 // least a single statement iteration is executed. For cases where no
1943 // statement instances are executed, the assumptions we have taken about
1944 // the executed code do not matter and can be changed.
1945 //
1946 // WARNING: This only holds if the assumptions we have taken do not reduce
1947 // the set of statement instances that are executed. Otherwise we
1948 // may run into a case where the iteration domains suggest that
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00001949 // for a certain set of parameter constraints no code is executed,
Tobias Grosser5e6813d2014-07-02 17:47:48 +00001950 // but in the original program some computation would have been
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00001951 // performed. In such a case, modifying the run-time conditions and
1952 // possibly influencing the run-time check may cause certain scops
Tobias Grosser5e6813d2014-07-02 17:47:48 +00001953 // to not be executed.
1954 //
1955 // Example:
1956 //
1957 // When delinearizing the following code:
1958 //
1959 // for (long i = 0; i < 100; i++)
1960 // for (long j = 0; j < m; j++)
1961 // A[i+p][j] = 1.0;
1962 //
1963 // we assume that the condition m <= 0 or (m >= 1 and p >= 0) holds as
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00001964 // otherwise we would access out of bound data. Now, knowing that code is
Tobias Grosser5e6813d2014-07-02 17:47:48 +00001965 // only executed for the case m >= 0, it is sufficient to assume p >= 0.
Johannes Doerfert883f8c12015-09-15 22:52:53 +00001966 AssumedContext = simplifyAssumptionContext(AssumedContext, *this);
1967 BoundaryContext = simplifyAssumptionContext(BoundaryContext, *this);
Tobias Grosser5e6813d2014-07-02 17:47:48 +00001968}
1969
Johannes Doerfertb164c792014-09-18 11:17:17 +00001970/// @brief Add the minimal/maximal access in @p Set to @p User.
Tobias Grosserb2f39922015-05-28 13:32:11 +00001971static isl_stat buildMinMaxAccess(__isl_take isl_set *Set, void *User) {
Johannes Doerfertb164c792014-09-18 11:17:17 +00001972 Scop::MinMaxVectorTy *MinMaxAccesses = (Scop::MinMaxVectorTy *)User;
1973 isl_pw_multi_aff *MinPMA, *MaxPMA;
1974 isl_pw_aff *LastDimAff;
1975 isl_aff *OneAff;
1976 unsigned Pos;
1977
Johannes Doerfert9143d672014-09-27 11:02:39 +00001978 // Restrict the number of parameters involved in the access as the lexmin/
1979 // lexmax computation will take too long if this number is high.
1980 //
1981 // Experiments with a simple test case using an i7 4800MQ:
1982 //
1983 // #Parameters involved | Time (in sec)
1984 // 6 | 0.01
1985 // 7 | 0.04
1986 // 8 | 0.12
1987 // 9 | 0.40
1988 // 10 | 1.54
1989 // 11 | 6.78
1990 // 12 | 30.38
1991 //
1992 if (isl_set_n_param(Set) > RunTimeChecksMaxParameters) {
1993 unsigned InvolvedParams = 0;
1994 for (unsigned u = 0, e = isl_set_n_param(Set); u < e; u++)
1995 if (isl_set_involves_dims(Set, isl_dim_param, u, 1))
1996 InvolvedParams++;
1997
1998 if (InvolvedParams > RunTimeChecksMaxParameters) {
1999 isl_set_free(Set);
Tobias Grosserb2f39922015-05-28 13:32:11 +00002000 return isl_stat_error;
Johannes Doerfert9143d672014-09-27 11:02:39 +00002001 }
2002 }
2003
Johannes Doerfertb6755bb2015-02-14 12:00:06 +00002004 Set = isl_set_remove_divs(Set);
2005
Johannes Doerfertb164c792014-09-18 11:17:17 +00002006 MinPMA = isl_set_lexmin_pw_multi_aff(isl_set_copy(Set));
2007 MaxPMA = isl_set_lexmax_pw_multi_aff(isl_set_copy(Set));
2008
Johannes Doerfert219b20e2014-10-07 14:37:59 +00002009 MinPMA = isl_pw_multi_aff_coalesce(MinPMA);
2010 MaxPMA = isl_pw_multi_aff_coalesce(MaxPMA);
2011
Johannes Doerfertb164c792014-09-18 11:17:17 +00002012 // Adjust the last dimension of the maximal access by one as we want to
2013 // enclose the accessed memory region by MinPMA and MaxPMA. The pointer
2014 // we test during code generation might now point after the end of the
2015 // allocated array but we will never dereference it anyway.
2016 assert(isl_pw_multi_aff_dim(MaxPMA, isl_dim_out) &&
2017 "Assumed at least one output dimension");
2018 Pos = isl_pw_multi_aff_dim(MaxPMA, isl_dim_out) - 1;
2019 LastDimAff = isl_pw_multi_aff_get_pw_aff(MaxPMA, Pos);
2020 OneAff = isl_aff_zero_on_domain(
2021 isl_local_space_from_space(isl_pw_aff_get_domain_space(LastDimAff)));
2022 OneAff = isl_aff_add_constant_si(OneAff, 1);
2023 LastDimAff = isl_pw_aff_add(LastDimAff, isl_pw_aff_from_aff(OneAff));
2024 MaxPMA = isl_pw_multi_aff_set_pw_aff(MaxPMA, Pos, LastDimAff);
2025
2026 MinMaxAccesses->push_back(std::make_pair(MinPMA, MaxPMA));
2027
2028 isl_set_free(Set);
Tobias Grosserb2f39922015-05-28 13:32:11 +00002029 return isl_stat_ok;
Johannes Doerfertb164c792014-09-18 11:17:17 +00002030}
2031
Johannes Doerferteeab05a2014-10-01 12:42:37 +00002032static __isl_give isl_set *getAccessDomain(MemoryAccess *MA) {
2033 isl_set *Domain = MA->getStatement()->getDomain();
2034 Domain = isl_set_project_out(Domain, isl_dim_set, 0, isl_set_n_dim(Domain));
2035 return isl_set_reset_tuple_id(Domain);
2036}
2037
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002038/// @brief Wrapper function to calculate minimal/maximal accesses to each array.
2039static bool calculateMinMaxAccess(__isl_take isl_union_map *Accesses,
Tobias Grosserbb853c22015-07-25 12:31:03 +00002040 __isl_take isl_union_set *Domains,
Johannes Doerfert210b09a2015-07-26 13:14:38 +00002041 Scop::MinMaxVectorTy &MinMaxAccesses) {
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002042
2043 Accesses = isl_union_map_intersect_domain(Accesses, Domains);
2044 isl_union_set *Locations = isl_union_map_range(Accesses);
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002045 Locations = isl_union_set_coalesce(Locations);
2046 Locations = isl_union_set_detect_equalities(Locations);
2047 bool Valid = (0 == isl_union_set_foreach_set(Locations, buildMinMaxAccess,
Johannes Doerfert210b09a2015-07-26 13:14:38 +00002048 &MinMaxAccesses));
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002049 isl_union_set_free(Locations);
2050 return Valid;
2051}
2052
Johannes Doerfert96425c22015-08-30 21:13:53 +00002053/// @brief Helper to treat non-affine regions and basic blocks the same.
2054///
2055///{
2056
2057/// @brief Return the block that is the representing block for @p RN.
2058static inline BasicBlock *getRegionNodeBasicBlock(RegionNode *RN) {
2059 return RN->isSubRegion() ? RN->getNodeAs<Region>()->getEntry()
2060 : RN->getNodeAs<BasicBlock>();
2061}
2062
2063/// @brief Return the @p idx'th block that is executed after @p RN.
Johannes Doerfert9a132f32015-09-28 09:33:22 +00002064static inline BasicBlock *
2065getRegionNodeSuccessor(RegionNode *RN, TerminatorInst *TI, unsigned idx) {
Johannes Doerfert96425c22015-08-30 21:13:53 +00002066 if (RN->isSubRegion()) {
2067 assert(idx == 0);
2068 return RN->getNodeAs<Region>()->getExit();
2069 }
Johannes Doerfert9a132f32015-09-28 09:33:22 +00002070 return TI->getSuccessor(idx);
Johannes Doerfert96425c22015-08-30 21:13:53 +00002071}
2072
2073/// @brief Return the smallest loop surrounding @p RN.
2074static inline Loop *getRegionNodeLoop(RegionNode *RN, LoopInfo &LI) {
2075 if (!RN->isSubRegion())
2076 return LI.getLoopFor(RN->getNodeAs<BasicBlock>());
2077
2078 Region *NonAffineSubRegion = RN->getNodeAs<Region>();
2079 Loop *L = LI.getLoopFor(NonAffineSubRegion->getEntry());
2080 while (L && NonAffineSubRegion->contains(L))
2081 L = L->getParentLoop();
2082 return L;
2083}
2084
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002085static inline unsigned getNumBlocksInRegionNode(RegionNode *RN) {
2086 if (!RN->isSubRegion())
2087 return 1;
2088
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002089 Region *R = RN->getNodeAs<Region>();
Tobias Grosser0dd4a9a2016-02-01 01:55:08 +00002090 return std::distance(R->block_begin(), R->block_end());
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002091}
2092
Johannes Doerfert08d90a32015-10-07 20:32:43 +00002093static bool containsErrorBlock(RegionNode *RN, const Region &R, LoopInfo &LI,
2094 const DominatorTree &DT) {
Johannes Doerfertf5673802015-10-01 23:48:18 +00002095 if (!RN->isSubRegion())
Johannes Doerfert08d90a32015-10-07 20:32:43 +00002096 return isErrorBlock(*RN->getNodeAs<BasicBlock>(), R, LI, DT);
Johannes Doerfertf5673802015-10-01 23:48:18 +00002097 for (BasicBlock *BB : RN->getNodeAs<Region>()->blocks())
Johannes Doerfert08d90a32015-10-07 20:32:43 +00002098 if (isErrorBlock(*BB, R, LI, DT))
Johannes Doerfertf5673802015-10-01 23:48:18 +00002099 return true;
2100 return false;
2101}
2102
Johannes Doerfert96425c22015-08-30 21:13:53 +00002103///}
2104
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002105static inline __isl_give isl_set *addDomainDimId(__isl_take isl_set *Domain,
2106 unsigned Dim, Loop *L) {
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002107 Domain = isl_set_lower_bound_si(Domain, isl_dim_set, Dim, -1);
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002108 isl_id *DimId =
2109 isl_id_alloc(isl_set_get_ctx(Domain), nullptr, static_cast<void *>(L));
2110 return isl_set_set_dim_id(Domain, isl_dim_set, Dim, DimId);
2111}
2112
Johannes Doerfert96425c22015-08-30 21:13:53 +00002113isl_set *Scop::getDomainConditions(ScopStmt *Stmt) {
2114 BasicBlock *BB = Stmt->isBlockStmt() ? Stmt->getBasicBlock()
2115 : Stmt->getRegion()->getEntry();
Johannes Doerfertcef616f2015-09-15 22:49:04 +00002116 return getDomainConditions(BB);
2117}
2118
2119isl_set *Scop::getDomainConditions(BasicBlock *BB) {
2120 assert(DomainMap.count(BB) && "Requested BB did not have a domain");
Johannes Doerfertf08bd002015-08-31 13:56:32 +00002121 return isl_set_copy(DomainMap[BB]);
Johannes Doerfert96425c22015-08-30 21:13:53 +00002122}
2123
Hongbin Zheng192f69a2016-02-13 15:12:54 +00002124void Scop::removeErrorBlockDomains(ScopDetection &SD, DominatorTree &DT,
2125 LoopInfo &LI) {
Hongbin Zhengf53ffa62016-02-13 15:12:51 +00002126 auto removeDomains = [this, &DT](BasicBlock *Start) {
Johannes Doerferta90943d2016-02-21 16:37:25 +00002127 auto *BBNode = DT.getNode(Start);
2128 for (auto *ErrorChild : depth_first(BBNode)) {
2129 auto *ErrorChildBlock = ErrorChild->getBlock();
2130 auto *CurrentDomain = DomainMap[ErrorChildBlock];
2131 auto *Empty = isl_set_empty(isl_set_get_space(CurrentDomain));
Tobias Grosser9737c7b2015-11-22 11:06:51 +00002132 DomainMap[ErrorChildBlock] = Empty;
2133 isl_set_free(CurrentDomain);
2134 }
2135 };
2136
Tobias Grosser5ef2bc32015-11-23 10:18:23 +00002137 SmallVector<Region *, 4> Todo = {&R};
Tobias Grosser9737c7b2015-11-22 11:06:51 +00002138
2139 while (!Todo.empty()) {
Johannes Doerferta90943d2016-02-21 16:37:25 +00002140 auto *SubRegion = Todo.back();
Tobias Grosser9737c7b2015-11-22 11:06:51 +00002141 Todo.pop_back();
2142
2143 if (!SD.isNonAffineSubRegion(SubRegion, &getRegion())) {
2144 for (auto &Child : *SubRegion)
2145 Todo.push_back(Child.get());
2146 continue;
2147 }
2148 if (containsErrorBlock(SubRegion->getNode(), getRegion(), LI, DT))
2149 removeDomains(SubRegion->getEntry());
2150 }
2151
Johannes Doerferta90943d2016-02-21 16:37:25 +00002152 for (auto *BB : R.blocks())
Tobias Grosser9737c7b2015-11-22 11:06:51 +00002153 if (isErrorBlock(*BB, R, LI, DT))
2154 removeDomains(BB);
2155}
2156
Hongbin Zheng192f69a2016-02-13 15:12:54 +00002157void Scop::buildDomains(Region *R, ScopDetection &SD, DominatorTree &DT,
2158 LoopInfo &LI) {
Johannes Doerfert96425c22015-08-30 21:13:53 +00002159
Johannes Doerfert432658d2016-01-26 11:01:41 +00002160 bool IsOnlyNonAffineRegion = SD.isNonAffineSubRegion(R, R);
Johannes Doerfertf08bd002015-08-31 13:56:32 +00002161 auto *EntryBB = R->getEntry();
Johannes Doerfert432658d2016-01-26 11:01:41 +00002162 auto *L = IsOnlyNonAffineRegion ? nullptr : LI.getLoopFor(EntryBB);
2163 int LD = getRelativeLoopDepth(L);
Johannes Doerfertf08bd002015-08-31 13:56:32 +00002164 auto *S = isl_set_universe(isl_space_set_alloc(getIslCtx(), 0, LD + 1));
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002165
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002166 while (LD-- >= 0) {
2167 S = addDomainDimId(S, LD + 1, L);
2168 L = L->getParentLoop();
2169 }
2170
Johannes Doerfertf08bd002015-08-31 13:56:32 +00002171 DomainMap[EntryBB] = S;
Johannes Doerfert96425c22015-08-30 21:13:53 +00002172
Johannes Doerfert432658d2016-01-26 11:01:41 +00002173 if (IsOnlyNonAffineRegion)
Johannes Doerfert40fa56f2015-09-14 11:15:07 +00002174 return;
2175
Hongbin Zheng192f69a2016-02-13 15:12:54 +00002176 buildDomainsWithBranchConstraints(R, SD, DT, LI);
2177 propagateDomainConstraints(R, SD, DT, LI);
Tobias Grosser9737c7b2015-11-22 11:06:51 +00002178
2179 // Error blocks and blocks dominated by them have been assumed to never be
2180 // executed. Representing them in the Scop does not add any value. In fact,
2181 // it is likely to cause issues during construction of the ScopStmts. The
2182 // contents of error blocks have not been verfied to be expressible and
2183 // will cause problems when building up a ScopStmt for them.
2184 // Furthermore, basic blocks dominated by error blocks may reference
2185 // instructions in the error block which, if the error block is not modeled,
2186 // can themselves not be constructed properly.
Hongbin Zheng192f69a2016-02-13 15:12:54 +00002187 removeErrorBlockDomains(SD, DT, LI);
Johannes Doerfert96425c22015-08-30 21:13:53 +00002188}
2189
Hongbin Zhengf53ffa62016-02-13 15:12:51 +00002190void Scop::buildDomainsWithBranchConstraints(Region *R, ScopDetection &SD,
Hongbin Zheng192f69a2016-02-13 15:12:54 +00002191 DominatorTree &DT, LoopInfo &LI) {
Johannes Doerfert6f50c292016-01-26 11:03:25 +00002192 auto &BoxedLoops = *SD.getBoxedLoops(&getRegion());
Johannes Doerfert96425c22015-08-30 21:13:53 +00002193
2194 // To create the domain for each block in R we iterate over all blocks and
2195 // subregions in R and propagate the conditions under which the current region
2196 // element is executed. To this end we iterate in reverse post order over R as
2197 // it ensures that we first visit all predecessors of a region node (either a
2198 // basic block or a subregion) before we visit the region node itself.
2199 // Initially, only the domain for the SCoP region entry block is set and from
2200 // there we propagate the current domain to all successors, however we add the
2201 // condition that the successor is actually executed next.
2202 // As we are only interested in non-loop carried constraints here we can
2203 // simply skip loop back edges.
2204
2205 ReversePostOrderTraversal<Region *> RTraversal(R);
2206 for (auto *RN : RTraversal) {
2207
2208 // Recurse for affine subregions but go on for basic blocks and non-affine
2209 // subregions.
2210 if (RN->isSubRegion()) {
2211 Region *SubRegion = RN->getNodeAs<Region>();
2212 if (!SD.isNonAffineSubRegion(SubRegion, &getRegion())) {
Hongbin Zheng192f69a2016-02-13 15:12:54 +00002213 buildDomainsWithBranchConstraints(SubRegion, SD, DT, LI);
Johannes Doerfert96425c22015-08-30 21:13:53 +00002214 continue;
2215 }
2216 }
2217
Tobias Grosserb76cd3c2015-11-11 08:42:20 +00002218 if (containsErrorBlock(RN, getRegion(), LI, DT))
Johannes Doerfertf85ad042015-11-08 20:16:39 +00002219 HasErrorBlock = true;
Johannes Doerfertf5673802015-10-01 23:48:18 +00002220
Johannes Doerfert96425c22015-08-30 21:13:53 +00002221 BasicBlock *BB = getRegionNodeBasicBlock(RN);
Johannes Doerfert90db75e2015-09-10 17:51:27 +00002222 TerminatorInst *TI = BB->getTerminator();
2223
Tobias Grosserb76cd3c2015-11-11 08:42:20 +00002224 if (isa<UnreachableInst>(TI))
2225 continue;
2226
Johannes Doerfertf5673802015-10-01 23:48:18 +00002227 isl_set *Domain = DomainMap.lookup(BB);
2228 if (!Domain) {
2229 DEBUG(dbgs() << "\tSkip: " << BB->getName()
2230 << ", it is only reachable from error blocks.\n");
Johannes Doerfert90db75e2015-09-10 17:51:27 +00002231 continue;
2232 }
2233
Johannes Doerfert96425c22015-08-30 21:13:53 +00002234 DEBUG(dbgs() << "\tVisit: " << BB->getName() << " : " << Domain << "\n");
Johannes Doerfert96425c22015-08-30 21:13:53 +00002235
2236 Loop *BBLoop = getRegionNodeLoop(RN, LI);
2237 int BBLoopDepth = getRelativeLoopDepth(BBLoop);
2238
2239 // Build the condition sets for the successor nodes of the current region
2240 // node. If it is a non-affine subregion we will always execute the single
2241 // exit node, hence the single entry node domain is the condition set. For
2242 // basic blocks we use the helper function buildConditionSets.
Johannes Doerfert9a132f32015-09-28 09:33:22 +00002243 SmallVector<isl_set *, 8> ConditionSets;
Johannes Doerfert96425c22015-08-30 21:13:53 +00002244 if (RN->isSubRegion())
2245 ConditionSets.push_back(isl_set_copy(Domain));
2246 else
Johannes Doerfert9a132f32015-09-28 09:33:22 +00002247 buildConditionSets(*this, TI, BBLoop, Domain, ConditionSets);
Johannes Doerfert96425c22015-08-30 21:13:53 +00002248
2249 // Now iterate over the successors and set their initial domain based on
2250 // their condition set. We skip back edges here and have to be careful when
2251 // we leave a loop not to keep constraints over a dimension that doesn't
2252 // exist anymore.
Johannes Doerfert9a132f32015-09-28 09:33:22 +00002253 assert(RN->isSubRegion() || TI->getNumSuccessors() == ConditionSets.size());
Johannes Doerfert96425c22015-08-30 21:13:53 +00002254 for (unsigned u = 0, e = ConditionSets.size(); u < e; u++) {
Johannes Doerfert96425c22015-08-30 21:13:53 +00002255 isl_set *CondSet = ConditionSets[u];
Johannes Doerfert9a132f32015-09-28 09:33:22 +00002256 BasicBlock *SuccBB = getRegionNodeSuccessor(RN, TI, u);
Johannes Doerfert96425c22015-08-30 21:13:53 +00002257
2258 // Skip back edges.
2259 if (DT.dominates(SuccBB, BB)) {
2260 isl_set_free(CondSet);
2261 continue;
2262 }
2263
Johannes Doerfertf08bd002015-08-31 13:56:32 +00002264 // Do not adjust the number of dimensions if we enter a boxed loop or are
2265 // in a non-affine subregion or if the surrounding loop stays the same.
Johannes Doerfert96425c22015-08-30 21:13:53 +00002266 Loop *SuccBBLoop = LI.getLoopFor(SuccBB);
Johannes Doerfert6f50c292016-01-26 11:03:25 +00002267 while (BoxedLoops.count(SuccBBLoop))
2268 SuccBBLoop = SuccBBLoop->getParentLoop();
Johannes Doerfert634909c2015-10-04 14:57:41 +00002269
2270 if (BBLoop != SuccBBLoop) {
Johannes Doerfertf08bd002015-08-31 13:56:32 +00002271
2272 // Check if the edge to SuccBB is a loop entry or exit edge. If so
2273 // adjust the dimensionality accordingly. Lastly, if we leave a loop
2274 // and enter a new one we need to drop the old constraints.
2275 int SuccBBLoopDepth = getRelativeLoopDepth(SuccBBLoop);
Johannes Doerfertf4fa9872015-09-10 15:53:59 +00002276 unsigned LoopDepthDiff = std::abs(BBLoopDepth - SuccBBLoopDepth);
Tobias Grosser2df884f2015-09-01 18:17:41 +00002277 if (BBLoopDepth > SuccBBLoopDepth) {
Johannes Doerfertf4fa9872015-09-10 15:53:59 +00002278 CondSet = isl_set_project_out(CondSet, isl_dim_set,
2279 isl_set_n_dim(CondSet) - LoopDepthDiff,
2280 LoopDepthDiff);
Tobias Grosser2df884f2015-09-01 18:17:41 +00002281 } else if (SuccBBLoopDepth > BBLoopDepth) {
Johannes Doerfertf4fa9872015-09-10 15:53:59 +00002282 assert(LoopDepthDiff == 1);
Johannes Doerfertf08bd002015-08-31 13:56:32 +00002283 CondSet = isl_set_add_dims(CondSet, isl_dim_set, 1);
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002284 CondSet = addDomainDimId(CondSet, SuccBBLoopDepth, SuccBBLoop);
Tobias Grosser2df884f2015-09-01 18:17:41 +00002285 } else if (BBLoopDepth >= 0) {
Johannes Doerfertf4fa9872015-09-10 15:53:59 +00002286 assert(LoopDepthDiff <= 1);
Tobias Grosser2df884f2015-09-01 18:17:41 +00002287 CondSet = isl_set_project_out(CondSet, isl_dim_set, BBLoopDepth, 1);
2288 CondSet = isl_set_add_dims(CondSet, isl_dim_set, 1);
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002289 CondSet = addDomainDimId(CondSet, SuccBBLoopDepth, SuccBBLoop);
Tobias Grosser2df884f2015-09-01 18:17:41 +00002290 }
Johannes Doerfert96425c22015-08-30 21:13:53 +00002291 }
2292
2293 // Set the domain for the successor or merge it with an existing domain in
2294 // case there are multiple paths (without loop back edges) to the
2295 // successor block.
2296 isl_set *&SuccDomain = DomainMap[SuccBB];
2297 if (!SuccDomain)
2298 SuccDomain = CondSet;
2299 else
2300 SuccDomain = isl_set_union(SuccDomain, CondSet);
2301
2302 SuccDomain = isl_set_coalesce(SuccDomain);
Tobias Grosser75dc40c2015-12-20 13:31:48 +00002303 if (isl_set_n_basic_set(SuccDomain) > MaxConjunctsInDomain) {
2304 auto *Empty = isl_set_empty(isl_set_get_space(SuccDomain));
2305 isl_set_free(SuccDomain);
2306 SuccDomain = Empty;
2307 invalidate(ERROR_DOMAINCONJUNCTS, DebugLoc());
2308 }
Johannes Doerfert634909c2015-10-04 14:57:41 +00002309 DEBUG(dbgs() << "\tSet SuccBB: " << SuccBB->getName() << " : "
2310 << SuccDomain << "\n");
Johannes Doerfert96425c22015-08-30 21:13:53 +00002311 }
2312 }
2313}
2314
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002315/// @brief Return the domain for @p BB wrt @p DomainMap.
2316///
2317/// This helper function will lookup @p BB in @p DomainMap but also handle the
2318/// case where @p BB is contained in a non-affine subregion using the region
2319/// tree obtained by @p RI.
2320static __isl_give isl_set *
2321getDomainForBlock(BasicBlock *BB, DenseMap<BasicBlock *, isl_set *> &DomainMap,
2322 RegionInfo &RI) {
2323 auto DIt = DomainMap.find(BB);
2324 if (DIt != DomainMap.end())
2325 return isl_set_copy(DIt->getSecond());
2326
2327 Region *R = RI.getRegionFor(BB);
2328 while (R->getEntry() == BB)
2329 R = R->getParent();
2330 return getDomainForBlock(R->getEntry(), DomainMap, RI);
2331}
2332
Hongbin Zhengf53ffa62016-02-13 15:12:51 +00002333void Scop::propagateDomainConstraints(Region *R, ScopDetection &SD,
Hongbin Zheng192f69a2016-02-13 15:12:54 +00002334 DominatorTree &DT, LoopInfo &LI) {
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002335 // Iterate over the region R and propagate the domain constrains from the
2336 // predecessors to the current node. In contrast to the
2337 // buildDomainsWithBranchConstraints function, this one will pull the domain
2338 // information from the predecessors instead of pushing it to the successors.
2339 // Additionally, we assume the domains to be already present in the domain
2340 // map here. However, we iterate again in reverse post order so we know all
2341 // predecessors have been visited before a block or non-affine subregion is
2342 // visited.
2343
2344 // The set of boxed loops (loops in non-affine subregions) for this SCoP.
2345 auto &BoxedLoops = *SD.getBoxedLoops(&getRegion());
2346
2347 ReversePostOrderTraversal<Region *> RTraversal(R);
2348 for (auto *RN : RTraversal) {
2349
2350 // Recurse for affine subregions but go on for basic blocks and non-affine
2351 // subregions.
2352 if (RN->isSubRegion()) {
2353 Region *SubRegion = RN->getNodeAs<Region>();
2354 if (!SD.isNonAffineSubRegion(SubRegion, &getRegion())) {
Hongbin Zheng192f69a2016-02-13 15:12:54 +00002355 propagateDomainConstraints(SubRegion, SD, DT, LI);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002356 continue;
2357 }
2358 }
2359
Johannes Doerfertf5673802015-10-01 23:48:18 +00002360 // Get the domain for the current block and check if it was initialized or
2361 // not. The only way it was not is if this block is only reachable via error
2362 // blocks, thus will not be executed under the assumptions we make. Such
2363 // blocks have to be skipped as their predecessors might not have domains
2364 // either. It would not benefit us to compute the domain anyway, only the
2365 // domains of the error blocks that are reachable from non-error blocks
2366 // are needed to generate assumptions.
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002367 BasicBlock *BB = getRegionNodeBasicBlock(RN);
Johannes Doerfertf5673802015-10-01 23:48:18 +00002368 isl_set *&Domain = DomainMap[BB];
2369 if (!Domain) {
2370 DEBUG(dbgs() << "\tSkip: " << BB->getName()
2371 << ", it is only reachable from error blocks.\n");
2372 DomainMap.erase(BB);
2373 continue;
2374 }
2375 DEBUG(dbgs() << "\tVisit: " << BB->getName() << " : " << Domain << "\n");
2376
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002377 Loop *BBLoop = getRegionNodeLoop(RN, LI);
2378 int BBLoopDepth = getRelativeLoopDepth(BBLoop);
2379
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002380 isl_set *PredDom = isl_set_empty(isl_set_get_space(Domain));
2381 for (auto *PredBB : predecessors(BB)) {
2382
2383 // Skip backedges
2384 if (DT.dominates(BB, PredBB))
2385 continue;
2386
2387 isl_set *PredBBDom = nullptr;
2388
2389 // Handle the SCoP entry block with its outside predecessors.
2390 if (!getRegion().contains(PredBB))
2391 PredBBDom = isl_set_universe(isl_set_get_space(PredDom));
2392
2393 if (!PredBBDom) {
2394 // Determine the loop depth of the predecessor and adjust its domain to
2395 // the domain of the current block. This can mean we have to:
2396 // o) Drop a dimension if this block is the exit of a loop, not the
2397 // header of a new loop and the predecessor was part of the loop.
2398 // o) Add an unconstrainted new dimension if this block is the header
2399 // of a loop and the predecessor is not part of it.
2400 // o) Drop the information about the innermost loop dimension when the
2401 // predecessor and the current block are surrounded by different
2402 // loops in the same depth.
2403 PredBBDom = getDomainForBlock(PredBB, DomainMap, *R->getRegionInfo());
2404 Loop *PredBBLoop = LI.getLoopFor(PredBB);
2405 while (BoxedLoops.count(PredBBLoop))
2406 PredBBLoop = PredBBLoop->getParentLoop();
2407
2408 int PredBBLoopDepth = getRelativeLoopDepth(PredBBLoop);
Johannes Doerfertf4fa9872015-09-10 15:53:59 +00002409 unsigned LoopDepthDiff = std::abs(BBLoopDepth - PredBBLoopDepth);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002410 if (BBLoopDepth < PredBBLoopDepth)
Johannes Doerfertf4fa9872015-09-10 15:53:59 +00002411 PredBBDom = isl_set_project_out(
2412 PredBBDom, isl_dim_set, isl_set_n_dim(PredBBDom) - LoopDepthDiff,
2413 LoopDepthDiff);
2414 else if (PredBBLoopDepth < BBLoopDepth) {
2415 assert(LoopDepthDiff == 1);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002416 PredBBDom = isl_set_add_dims(PredBBDom, isl_dim_set, 1);
Johannes Doerfertf4fa9872015-09-10 15:53:59 +00002417 } else if (BBLoop != PredBBLoop && BBLoopDepth >= 0) {
2418 assert(LoopDepthDiff <= 1);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002419 PredBBDom = isl_set_drop_constraints_involving_dims(
2420 PredBBDom, isl_dim_set, BBLoopDepth, 1);
Johannes Doerfertf4fa9872015-09-10 15:53:59 +00002421 }
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002422 }
2423
2424 PredDom = isl_set_union(PredDom, PredBBDom);
2425 }
2426
2427 // Under the union of all predecessor conditions we can reach this block.
Johannes Doerfertb20f1512015-09-15 22:11:49 +00002428 Domain = isl_set_coalesce(isl_set_intersect(Domain, PredDom));
Johannes Doerfert90db75e2015-09-10 17:51:27 +00002429
Johannes Doerfertf32f5f22015-09-28 01:30:37 +00002430 if (BBLoop && BBLoop->getHeader() == BB && getRegion().contains(BBLoop))
Hongbin Zheng192f69a2016-02-13 15:12:54 +00002431 addLoopBoundsToHeaderDomain(BBLoop, LI);
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002432
Johannes Doerfert90db75e2015-09-10 17:51:27 +00002433 // Add assumptions for error blocks.
Johannes Doerfert08d90a32015-10-07 20:32:43 +00002434 if (containsErrorBlock(RN, getRegion(), LI, DT)) {
Johannes Doerfert90db75e2015-09-10 17:51:27 +00002435 IsOptimized = true;
2436 isl_set *DomPar = isl_set_params(isl_set_copy(Domain));
Johannes Doerfertd84493e2015-11-12 02:33:38 +00002437 addAssumption(ERRORBLOCK, isl_set_complement(DomPar),
2438 BB->getTerminator()->getDebugLoc());
Johannes Doerfert90db75e2015-09-10 17:51:27 +00002439 }
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002440 }
2441}
2442
2443/// @brief Create a map from SetSpace -> SetSpace where the dimensions @p Dim
2444/// is incremented by one and all other dimensions are equal, e.g.,
2445/// [i0, i1, i2, i3] -> [i0, i1, i2 + 1, i3]
2446/// if @p Dim is 2 and @p SetSpace has 4 dimensions.
2447static __isl_give isl_map *
2448createNextIterationMap(__isl_take isl_space *SetSpace, unsigned Dim) {
2449 auto *MapSpace = isl_space_map_from_set(SetSpace);
2450 auto *NextIterationMap = isl_map_universe(isl_space_copy(MapSpace));
2451 for (unsigned u = 0; u < isl_map_n_in(NextIterationMap); u++)
2452 if (u != Dim)
2453 NextIterationMap =
2454 isl_map_equate(NextIterationMap, isl_dim_in, u, isl_dim_out, u);
2455 auto *C = isl_constraint_alloc_equality(isl_local_space_from_space(MapSpace));
2456 C = isl_constraint_set_constant_si(C, 1);
2457 C = isl_constraint_set_coefficient_si(C, isl_dim_in, Dim, 1);
2458 C = isl_constraint_set_coefficient_si(C, isl_dim_out, Dim, -1);
2459 NextIterationMap = isl_map_add_constraint(NextIterationMap, C);
2460 return NextIterationMap;
2461}
2462
Hongbin Zheng192f69a2016-02-13 15:12:54 +00002463void Scop::addLoopBoundsToHeaderDomain(Loop *L, LoopInfo &LI) {
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002464 int LoopDepth = getRelativeLoopDepth(L);
2465 assert(LoopDepth >= 0 && "Loop in region should have at least depth one");
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002466
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002467 BasicBlock *HeaderBB = L->getHeader();
2468 assert(DomainMap.count(HeaderBB));
2469 isl_set *&HeaderBBDom = DomainMap[HeaderBB];
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002470
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002471 isl_map *NextIterationMap =
2472 createNextIterationMap(isl_set_get_space(HeaderBBDom), LoopDepth);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002473
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002474 isl_set *UnionBackedgeCondition =
2475 isl_set_empty(isl_set_get_space(HeaderBBDom));
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002476
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002477 SmallVector<llvm::BasicBlock *, 4> LatchBlocks;
2478 L->getLoopLatches(LatchBlocks);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002479
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002480 for (BasicBlock *LatchBB : LatchBlocks) {
Johannes Doerfertf5673802015-10-01 23:48:18 +00002481
2482 // If the latch is only reachable via error statements we skip it.
2483 isl_set *LatchBBDom = DomainMap.lookup(LatchBB);
2484 if (!LatchBBDom)
2485 continue;
2486
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002487 isl_set *BackedgeCondition = nullptr;
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002488
Johannes Doerfert9a132f32015-09-28 09:33:22 +00002489 TerminatorInst *TI = LatchBB->getTerminator();
2490 BranchInst *BI = dyn_cast<BranchInst>(TI);
2491 if (BI && BI->isUnconditional())
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002492 BackedgeCondition = isl_set_copy(LatchBBDom);
2493 else {
Johannes Doerfert9a132f32015-09-28 09:33:22 +00002494 SmallVector<isl_set *, 8> ConditionSets;
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002495 int idx = BI->getSuccessor(0) != HeaderBB;
Johannes Doerfert9a132f32015-09-28 09:33:22 +00002496 buildConditionSets(*this, TI, L, LatchBBDom, ConditionSets);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002497
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002498 // Free the non back edge condition set as we do not need it.
2499 isl_set_free(ConditionSets[1 - idx]);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002500
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002501 BackedgeCondition = ConditionSets[idx];
Johannes Doerfert06c57b52015-09-20 15:00:20 +00002502 }
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002503
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002504 int LatchLoopDepth = getRelativeLoopDepth(LI.getLoopFor(LatchBB));
2505 assert(LatchLoopDepth >= LoopDepth);
2506 BackedgeCondition =
2507 isl_set_project_out(BackedgeCondition, isl_dim_set, LoopDepth + 1,
2508 LatchLoopDepth - LoopDepth);
2509 UnionBackedgeCondition =
2510 isl_set_union(UnionBackedgeCondition, BackedgeCondition);
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002511 }
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002512
2513 isl_map *ForwardMap = isl_map_lex_le(isl_set_get_space(HeaderBBDom));
2514 for (int i = 0; i < LoopDepth; i++)
2515 ForwardMap = isl_map_equate(ForwardMap, isl_dim_in, i, isl_dim_out, i);
2516
2517 isl_set *UnionBackedgeConditionComplement =
2518 isl_set_complement(UnionBackedgeCondition);
2519 UnionBackedgeConditionComplement = isl_set_lower_bound_si(
2520 UnionBackedgeConditionComplement, isl_dim_set, LoopDepth, 0);
2521 UnionBackedgeConditionComplement =
2522 isl_set_apply(UnionBackedgeConditionComplement, ForwardMap);
2523 HeaderBBDom = isl_set_subtract(HeaderBBDom, UnionBackedgeConditionComplement);
2524 HeaderBBDom = isl_set_apply(HeaderBBDom, NextIterationMap);
2525
2526 auto Parts = partitionSetParts(HeaderBBDom, LoopDepth);
2527 HeaderBBDom = Parts.second;
2528
Johannes Doerfert6a72a2a2015-09-20 16:59:23 +00002529 // Check if there is a <nsw> tagged AddRec for this loop and if so do not add
2530 // the bounded assumptions to the context as they are already implied by the
2531 // <nsw> tag.
2532 if (Affinator.hasNSWAddRecForLoop(L)) {
2533 isl_set_free(Parts.first);
2534 return;
2535 }
2536
Johannes Doerfertf2cc86e2015-09-20 16:15:32 +00002537 isl_set *UnboundedCtx = isl_set_params(Parts.first);
2538 isl_set *BoundedCtx = isl_set_complement(UnboundedCtx);
Johannes Doerfertd84493e2015-11-12 02:33:38 +00002539 addAssumption(INFINITELOOP, BoundedCtx,
2540 HeaderBB->getTerminator()->getDebugLoc());
Johannes Doerfert5b9ff8b2015-09-10 13:00:06 +00002541}
2542
Johannes Doerfert120de4b2015-08-20 18:30:08 +00002543void Scop::buildAliasChecks(AliasAnalysis &AA) {
2544 if (!PollyUseRuntimeAliasChecks)
2545 return;
2546
2547 if (buildAliasGroups(AA))
2548 return;
2549
2550 // If a problem occurs while building the alias groups we need to delete
2551 // this SCoP and pretend it wasn't valid in the first place. To this end
2552 // we make the assumed context infeasible.
Tobias Grosser8d4f6262015-12-12 09:52:26 +00002553 invalidate(ALIASING, DebugLoc());
Johannes Doerfert120de4b2015-08-20 18:30:08 +00002554
2555 DEBUG(dbgs() << "\n\nNOTE: Run time checks for " << getNameStr()
2556 << " could not be created as the number of parameters involved "
2557 "is too high. The SCoP will be "
2558 "dismissed.\nUse:\n\t--polly-rtc-max-parameters=X\nto adjust "
2559 "the maximal number of parameters but be advised that the "
2560 "compile time might increase exponentially.\n\n");
2561}
2562
Johannes Doerfert9143d672014-09-27 11:02:39 +00002563bool Scop::buildAliasGroups(AliasAnalysis &AA) {
Johannes Doerfertb164c792014-09-18 11:17:17 +00002564 // To create sound alias checks we perform the following steps:
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00002565 // o) Use the alias analysis and an alias set tracker to build alias sets
Johannes Doerfertb164c792014-09-18 11:17:17 +00002566 // for all memory accesses inside the SCoP.
2567 // o) For each alias set we then map the aliasing pointers back to the
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00002568 // memory accesses we know, thus obtain groups of memory accesses which
Johannes Doerfertb164c792014-09-18 11:17:17 +00002569 // might alias.
Johannes Doerferteeab05a2014-10-01 12:42:37 +00002570 // o) We divide each group based on the domains of the minimal/maximal
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00002571 // accesses. That means two minimal/maximal accesses are only in a group
Johannes Doerferteeab05a2014-10-01 12:42:37 +00002572 // if their access domains intersect, otherwise they are in different
2573 // ones.
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002574 // o) We partition each group into read only and non read only accesses.
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00002575 // o) For each group with more than one base pointer we then compute minimal
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002576 // and maximal accesses to each array of a group in read only and non
2577 // read only partitions separately.
Johannes Doerfertb164c792014-09-18 11:17:17 +00002578 using AliasGroupTy = SmallVector<MemoryAccess *, 4>;
2579
2580 AliasSetTracker AST(AA);
2581
2582 DenseMap<Value *, MemoryAccess *> PtrToAcc;
Johannes Doerfert13771732014-10-01 12:40:46 +00002583 DenseSet<Value *> HasWriteAccess;
Tobias Grosser7c3bad52015-05-27 05:16:57 +00002584 for (ScopStmt &Stmt : *this) {
Johannes Doerfertf1ee2622014-10-06 17:43:00 +00002585
2586 // Skip statements with an empty domain as they will never be executed.
Tobias Grosser7c3bad52015-05-27 05:16:57 +00002587 isl_set *StmtDomain = Stmt.getDomain();
Johannes Doerfertf1ee2622014-10-06 17:43:00 +00002588 bool StmtDomainEmpty = isl_set_is_empty(StmtDomain);
2589 isl_set_free(StmtDomain);
2590 if (StmtDomainEmpty)
2591 continue;
2592
Tobias Grosser7c3bad52015-05-27 05:16:57 +00002593 for (MemoryAccess *MA : Stmt) {
Tobias Grossera535dff2015-12-13 19:59:01 +00002594 if (MA->isScalarKind())
Johannes Doerfertb164c792014-09-18 11:17:17 +00002595 continue;
Johannes Doerfert13771732014-10-01 12:40:46 +00002596 if (!MA->isRead())
2597 HasWriteAccess.insert(MA->getBaseAddr());
Michael Kruse70131d32016-01-27 17:09:17 +00002598 MemAccInst Acc(MA->getAccessInstruction());
Johannes Doerfertcea61932016-02-21 19:13:19 +00002599 if (MA->isRead() && Acc.isMemTransferInst())
2600 PtrToAcc[Acc.asMemTransferInst()->getSource()] = MA;
2601 else
2602 PtrToAcc[Acc.getPointerOperand()] = MA;
Johannes Doerfertb164c792014-09-18 11:17:17 +00002603 AST.add(Acc);
2604 }
2605 }
2606
2607 SmallVector<AliasGroupTy, 4> AliasGroups;
2608 for (AliasSet &AS : AST) {
Johannes Doerfert74f68692014-10-08 02:23:48 +00002609 if (AS.isMustAlias() || AS.isForwardingAliasSet())
Johannes Doerfertb164c792014-09-18 11:17:17 +00002610 continue;
2611 AliasGroupTy AG;
Johannes Doerferta90943d2016-02-21 16:37:25 +00002612 for (auto &PR : AS)
Johannes Doerfertb164c792014-09-18 11:17:17 +00002613 AG.push_back(PtrToAcc[PR.getValue()]);
Johannes Doerfertcea61932016-02-21 19:13:19 +00002614 if (AG.size() < 2)
2615 continue;
Johannes Doerfertb164c792014-09-18 11:17:17 +00002616 AliasGroups.push_back(std::move(AG));
2617 }
2618
Johannes Doerferteeab05a2014-10-01 12:42:37 +00002619 // Split the alias groups based on their domain.
2620 for (unsigned u = 0; u < AliasGroups.size(); u++) {
2621 AliasGroupTy NewAG;
2622 AliasGroupTy &AG = AliasGroups[u];
2623 AliasGroupTy::iterator AGI = AG.begin();
2624 isl_set *AGDomain = getAccessDomain(*AGI);
2625 while (AGI != AG.end()) {
2626 MemoryAccess *MA = *AGI;
2627 isl_set *MADomain = getAccessDomain(MA);
2628 if (isl_set_is_disjoint(AGDomain, MADomain)) {
2629 NewAG.push_back(MA);
2630 AGI = AG.erase(AGI);
2631 isl_set_free(MADomain);
2632 } else {
2633 AGDomain = isl_set_union(AGDomain, MADomain);
2634 AGI++;
2635 }
2636 }
2637 if (NewAG.size() > 1)
2638 AliasGroups.push_back(std::move(NewAG));
2639 isl_set_free(AGDomain);
2640 }
2641
Johannes Doerfert0cf4e0a2015-11-12 02:32:51 +00002642 auto &F = *getRegion().getEntry()->getParent();
Tobias Grosserf4c24b22015-04-05 13:11:54 +00002643 MapVector<const Value *, SmallPtrSet<MemoryAccess *, 8>> ReadOnlyPairs;
Johannes Doerfert13771732014-10-01 12:40:46 +00002644 SmallPtrSet<const Value *, 4> NonReadOnlyBaseValues;
2645 for (AliasGroupTy &AG : AliasGroups) {
2646 NonReadOnlyBaseValues.clear();
2647 ReadOnlyPairs.clear();
2648
Johannes Doerferteeab05a2014-10-01 12:42:37 +00002649 if (AG.size() < 2) {
2650 AG.clear();
2651 continue;
2652 }
2653
Johannes Doerfert13771732014-10-01 12:40:46 +00002654 for (auto II = AG.begin(); II != AG.end();) {
Johannes Doerfert0cf4e0a2015-11-12 02:32:51 +00002655 emitOptimizationRemarkAnalysis(
2656 F.getContext(), DEBUG_TYPE, F,
2657 (*II)->getAccessInstruction()->getDebugLoc(),
2658 "Possibly aliasing pointer, use restrict keyword.");
2659
Johannes Doerfert13771732014-10-01 12:40:46 +00002660 Value *BaseAddr = (*II)->getBaseAddr();
2661 if (HasWriteAccess.count(BaseAddr)) {
2662 NonReadOnlyBaseValues.insert(BaseAddr);
2663 II++;
2664 } else {
2665 ReadOnlyPairs[BaseAddr].insert(*II);
2666 II = AG.erase(II);
2667 }
2668 }
2669
2670 // If we don't have read only pointers check if there are at least two
2671 // non read only pointers, otherwise clear the alias group.
Tobias Grosserbb853c22015-07-25 12:31:03 +00002672 if (ReadOnlyPairs.empty() && NonReadOnlyBaseValues.size() <= 1) {
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002673 AG.clear();
Johannes Doerfert13771732014-10-01 12:40:46 +00002674 continue;
2675 }
2676
2677 // If we don't have non read only pointers clear the alias group.
2678 if (NonReadOnlyBaseValues.empty()) {
2679 AG.clear();
2680 continue;
2681 }
2682
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002683 // Calculate minimal and maximal accesses for non read only accesses.
Johannes Doerfert210b09a2015-07-26 13:14:38 +00002684 MinMaxAliasGroups.emplace_back();
2685 MinMaxVectorPairTy &pair = MinMaxAliasGroups.back();
2686 MinMaxVectorTy &MinMaxAccessesNonReadOnly = pair.first;
2687 MinMaxVectorTy &MinMaxAccessesReadOnly = pair.second;
2688 MinMaxAccessesNonReadOnly.reserve(AG.size());
Johannes Doerfertb164c792014-09-18 11:17:17 +00002689
2690 isl_union_map *Accesses = isl_union_map_empty(getParamSpace());
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002691
2692 // AG contains only non read only accesses.
Johannes Doerfertb164c792014-09-18 11:17:17 +00002693 for (MemoryAccess *MA : AG)
2694 Accesses = isl_union_map_add_map(Accesses, MA->getAccessRelation());
Johannes Doerfertb164c792014-09-18 11:17:17 +00002695
Tobias Grosserdaaed0e2015-08-20 21:29:26 +00002696 bool Valid = calculateMinMaxAccess(Accesses, getDomains(),
2697 MinMaxAccessesNonReadOnly);
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002698
2699 // Bail out if the number of values we need to compare is too large.
2700 // This is important as the number of comparisions grows quadratically with
2701 // the number of values we need to compare.
Johannes Doerfert210b09a2015-07-26 13:14:38 +00002702 if (!Valid || (MinMaxAccessesNonReadOnly.size() + !ReadOnlyPairs.empty() >
2703 RunTimeChecksMaxArraysPerGroup))
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002704 return false;
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002705
2706 // Calculate minimal and maximal accesses for read only accesses.
Johannes Doerfert210b09a2015-07-26 13:14:38 +00002707 MinMaxAccessesReadOnly.reserve(ReadOnlyPairs.size());
Johannes Doerfert338b42c2015-07-23 17:04:54 +00002708 Accesses = isl_union_map_empty(getParamSpace());
2709
2710 for (const auto &ReadOnlyPair : ReadOnlyPairs)
2711 for (MemoryAccess *MA : ReadOnlyPair.second)
2712 Accesses = isl_union_map_add_map(Accesses, MA->getAccessRelation());
2713
Tobias Grosserdaaed0e2015-08-20 21:29:26 +00002714 Valid =
2715 calculateMinMaxAccess(Accesses, getDomains(), MinMaxAccessesReadOnly);
Johannes Doerfert9143d672014-09-27 11:02:39 +00002716
2717 if (!Valid)
Tobias Grosser50d4e2e2015-03-28 14:50:32 +00002718 return false;
Johannes Doerfertb164c792014-09-18 11:17:17 +00002719 }
Johannes Doerfert9143d672014-09-27 11:02:39 +00002720
Tobias Grosser50d4e2e2015-03-28 14:50:32 +00002721 return true;
Johannes Doerfertb164c792014-09-18 11:17:17 +00002722}
2723
Johannes Doerfertdec27df2015-11-21 16:56:13 +00002724/// @brief Get the smallest loop that contains @p R but is not in @p R.
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002725static Loop *getLoopSurroundingRegion(Region &R, LoopInfo &LI) {
Johannes Doerfertdec27df2015-11-21 16:56:13 +00002726 // Start with the smallest loop containing the entry and expand that
2727 // loop until it contains all blocks in the region. If there is a loop
2728 // containing all blocks in the region check if it is itself contained
2729 // and if so take the parent loop as it will be the smallest containing
2730 // the region but not contained by it.
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002731 Loop *L = LI.getLoopFor(R.getEntry());
Johannes Doerfertdec27df2015-11-21 16:56:13 +00002732 while (L) {
2733 bool AllContained = true;
2734 for (auto *BB : R.blocks())
2735 AllContained &= L->contains(BB);
2736 if (AllContained)
2737 break;
2738 L = L->getParentLoop();
2739 }
2740
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00002741 return L ? (R.contains(L) ? L->getParentLoop() : L) : nullptr;
2742}
2743
Johannes Doerfertf8206cf2015-04-12 22:58:40 +00002744static unsigned getMaxLoopDepthInRegion(const Region &R, LoopInfo &LI,
2745 ScopDetection &SD) {
2746
2747 const ScopDetection::BoxedLoopsSetTy *BoxedLoops = SD.getBoxedLoops(&R);
2748
Johannes Doerferte3da05a2014-11-01 00:12:13 +00002749 unsigned MinLD = INT_MAX, MaxLD = 0;
2750 for (BasicBlock *BB : R.blocks()) {
2751 if (Loop *L = LI.getLoopFor(BB)) {
David Peixottodc0a11c2015-01-13 18:31:55 +00002752 if (!R.contains(L))
2753 continue;
Johannes Doerfertf8206cf2015-04-12 22:58:40 +00002754 if (BoxedLoops && BoxedLoops->count(L))
2755 continue;
Johannes Doerferte3da05a2014-11-01 00:12:13 +00002756 unsigned LD = L->getLoopDepth();
2757 MinLD = std::min(MinLD, LD);
2758 MaxLD = std::max(MaxLD, LD);
2759 }
2760 }
2761
2762 // Handle the case that there is no loop in the SCoP first.
2763 if (MaxLD == 0)
2764 return 1;
2765
2766 assert(MinLD >= 1 && "Minimal loop depth should be at least one");
2767 assert(MaxLD >= MinLD &&
2768 "Maximal loop depth was smaller than mininaml loop depth?");
2769 return MaxLD - MinLD + 1;
2770}
2771
Hongbin Zheng8831eb72016-02-17 15:49:21 +00002772Scop::Scop(Region &R, ScalarEvolution &ScalarEvolution, unsigned MaxLoopDepth)
Hongbin Zheng660f3cc2016-02-13 15:12:58 +00002773 : SE(&ScalarEvolution), R(R), IsOptimized(false),
Hongbin Zheng192f69a2016-02-13 15:12:54 +00002774 HasSingleExitEdge(R.getExitingBlock()), HasErrorBlock(false),
Hongbin Zheng8831eb72016-02-17 15:49:21 +00002775 MaxLoopDepth(MaxLoopDepth), IslCtx(isl_ctx_alloc(), isl_ctx_free),
2776 Context(nullptr), Affinator(this), AssumedContext(nullptr),
2777 BoundaryContext(nullptr), Schedule(nullptr) {
2778 isl_options_set_on_error(getIslCtx(), ISL_ON_ERROR_ABORT);
Tobias Grosserd840fc72016-02-04 13:18:42 +00002779 buildContext();
2780}
Johannes Doerfertff9d1982015-02-24 12:00:50 +00002781
Hongbin Zhengf53ffa62016-02-13 15:12:51 +00002782void Scop::init(AliasAnalysis &AA, AssumptionCache &AC, ScopDetection &SD,
Hongbin Zheng192f69a2016-02-13 15:12:54 +00002783 DominatorTree &DT, LoopInfo &LI) {
2784 addUserAssumptions(AC, DT, LI);
Hongbin Zheng7dddfba2016-02-13 15:12:47 +00002785 buildInvariantEquivalenceClasses(SD);
Johannes Doerfert697fdf82015-10-09 17:12:26 +00002786
Hongbin Zheng192f69a2016-02-13 15:12:54 +00002787 buildDomains(&R, SD, DT, LI);
Johannes Doerfert96425c22015-08-30 21:13:53 +00002788
Michael Krusecac948e2015-10-02 13:53:07 +00002789 // Remove empty and ignored statements.
Michael Kruseafe06702015-10-02 16:33:27 +00002790 // Exit early in case there are no executable statements left in this scop.
Hongbin Zheng192f69a2016-02-13 15:12:54 +00002791 simplifySCoP(true, DT, LI);
Michael Kruseafe06702015-10-02 16:33:27 +00002792 if (Stmts.empty())
2793 return;
Tobias Grosser75805372011-04-29 06:27:02 +00002794
Michael Krusecac948e2015-10-02 13:53:07 +00002795 // The ScopStmts now have enough information to initialize themselves.
2796 for (ScopStmt &Stmt : Stmts)
Hongbin Zheng7dddfba2016-02-13 15:12:47 +00002797 Stmt.init(SD);
Michael Krusecac948e2015-10-02 13:53:07 +00002798
Hongbin Zheng192f69a2016-02-13 15:12:54 +00002799 buildSchedule(SD, LI);
Tobias Grosser75805372011-04-29 06:27:02 +00002800
Tobias Grosser8286b832015-11-02 11:29:32 +00002801 if (isl_set_is_empty(AssumedContext))
2802 return;
2803
2804 updateAccessDimensionality();
Tobias Grosser8cae72f2011-11-08 15:41:08 +00002805 realignParams();
Tobias Grosser18daaca2012-05-22 10:47:27 +00002806 addParameterBounds();
Tobias Grosser8a9c2352015-08-16 10:19:29 +00002807 addUserContext();
Johannes Doerfert883f8c12015-09-15 22:52:53 +00002808 buildBoundaryContext();
2809 simplifyContexts();
Johannes Doerfert120de4b2015-08-20 18:30:08 +00002810 buildAliasChecks(AA);
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00002811
Hongbin Zheng7dddfba2016-02-13 15:12:47 +00002812 hoistInvariantLoads(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 Doerfert883f8c12015-09-15 22:52:53 +00002819 isl_set_free(BoundaryContext);
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 Krusecac948e2015-10-02 13:53:07 +00002875 RegionNode *RN = Stmt.isRegionStmt()
2876 ? Stmt.getRegion()->getNode()
2877 : getRegion().getBBNode(Stmt.getBasicBlock());
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00002878
Johannes Doerferteca9e892015-11-03 16:54:49 +00002879 bool RemoveStmt = StmtIt->isEmpty();
2880 if (!RemoveStmt)
2881 RemoveStmt = isl_set_is_empty(DomainMap[getRegionNodeBasicBlock(RN)]);
2882 if (!RemoveStmt)
Hongbin Zheng192f69a2016-02-13 15:12:54 +00002883 RemoveStmt = (RemoveIgnoredStmts && isIgnored(RN, DT, LI));
Johannes Doerfertf17a78e2015-10-04 15:00:05 +00002884
Johannes Doerferteca9e892015-11-03 16:54:49 +00002885 // Remove read only statements only after invariant loop hoisting.
2886 if (!RemoveStmt && !RemoveIgnoredStmts) {
2887 bool OnlyRead = true;
2888 for (MemoryAccess *MA : Stmt) {
2889 if (MA->isRead())
2890 continue;
2891
2892 OnlyRead = false;
2893 break;
2894 }
2895
2896 RemoveStmt = OnlyRead;
2897 }
2898
2899 if (RemoveStmt) {
Michael Krusecac948e2015-10-02 13:53:07 +00002900 // Remove the statement because it is unnecessary.
2901 if (Stmt.isRegionStmt())
2902 for (BasicBlock *BB : Stmt.getRegion()->blocks())
2903 StmtMap.erase(BB);
2904 else
2905 StmtMap.erase(Stmt.getBasicBlock());
2906
2907 StmtIt = Stmts.erase(StmtIt);
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00002908 continue;
2909 }
2910
Michael Krusecac948e2015-10-02 13:53:07 +00002911 StmtIt++;
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00002912 }
2913}
2914
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00002915const InvariantEquivClassTy *Scop::lookupInvariantEquivClass(Value *Val) const {
2916 LoadInst *LInst = dyn_cast<LoadInst>(Val);
2917 if (!LInst)
2918 return nullptr;
2919
2920 if (Value *Rep = InvEquivClassVMap.lookup(LInst))
2921 LInst = cast<LoadInst>(Rep);
2922
Johannes Doerfert96e54712016-02-07 17:30:13 +00002923 Type *Ty = LInst->getType();
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00002924 const SCEV *PointerSCEV = SE->getSCEV(LInst->getPointerOperand());
2925 for (auto &IAClass : InvariantEquivClasses)
Johannes Doerfert96e54712016-02-07 17:30:13 +00002926 if (PointerSCEV == std::get<0>(IAClass) && Ty == std::get<3>(IAClass))
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00002927 return &IAClass;
2928
2929 return nullptr;
2930}
2931
2932void Scop::addInvariantLoads(ScopStmt &Stmt, MemoryAccessList &InvMAs) {
2933
2934 // Get the context under which the statement is executed.
2935 isl_set *DomainCtx = isl_set_params(Stmt.getDomain());
2936 DomainCtx = isl_set_remove_redundancies(DomainCtx);
2937 DomainCtx = isl_set_detect_equalities(DomainCtx);
2938 DomainCtx = isl_set_coalesce(DomainCtx);
2939
2940 // Project out all parameters that relate to loads in the statement. Otherwise
2941 // we could have cyclic dependences on the constraints under which the
2942 // hoisted loads are executed and we could not determine an order in which to
2943 // pre-load them. This happens because not only lower bounds are part of the
2944 // domain but also upper bounds.
2945 for (MemoryAccess *MA : InvMAs) {
2946 Instruction *AccInst = MA->getAccessInstruction();
2947 if (SE->isSCEVable(AccInst->getType())) {
Johannes Doerfert44483c52015-11-07 19:45:27 +00002948 SetVector<Value *> Values;
2949 for (const SCEV *Parameter : Parameters) {
2950 Values.clear();
2951 findValues(Parameter, Values);
2952 if (!Values.count(AccInst))
2953 continue;
2954
2955 if (isl_id *ParamId = getIdForParam(Parameter)) {
2956 int Dim = isl_set_find_dim_by_id(DomainCtx, isl_dim_param, ParamId);
2957 DomainCtx = isl_set_eliminate(DomainCtx, isl_dim_param, Dim, 1);
2958 isl_id_free(ParamId);
2959 }
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00002960 }
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00002961 }
2962 }
2963
2964 for (MemoryAccess *MA : InvMAs) {
2965 // Check for another invariant access that accesses the same location as
2966 // MA and if found consolidate them. Otherwise create a new equivalence
2967 // class at the end of InvariantEquivClasses.
2968 LoadInst *LInst = cast<LoadInst>(MA->getAccessInstruction());
Johannes Doerfert96e54712016-02-07 17:30:13 +00002969 Type *Ty = LInst->getType();
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00002970 const SCEV *PointerSCEV = SE->getSCEV(LInst->getPointerOperand());
2971
2972 bool Consolidated = false;
2973 for (auto &IAClass : InvariantEquivClasses) {
Johannes Doerfert96e54712016-02-07 17:30:13 +00002974 if (PointerSCEV != std::get<0>(IAClass) || Ty != std::get<3>(IAClass))
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00002975 continue;
2976
2977 Consolidated = true;
2978
2979 // Add MA to the list of accesses that are in this class.
2980 auto &MAs = std::get<1>(IAClass);
2981 MAs.push_front(MA);
2982
2983 // Unify the execution context of the class and this statement.
2984 isl_set *&IAClassDomainCtx = std::get<2>(IAClass);
Johannes Doerfertfc4bfc42015-11-11 04:30:07 +00002985 if (IAClassDomainCtx)
2986 IAClassDomainCtx = isl_set_coalesce(
2987 isl_set_union(IAClassDomainCtx, isl_set_copy(DomainCtx)));
2988 else
2989 IAClassDomainCtx = isl_set_copy(DomainCtx);
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00002990 break;
2991 }
2992
2993 if (Consolidated)
2994 continue;
2995
2996 // If we did not consolidate MA, thus did not find an equivalence class
2997 // for it, we create a new one.
2998 InvariantEquivClasses.emplace_back(PointerSCEV, MemoryAccessList{MA},
Johannes Doerfert96e54712016-02-07 17:30:13 +00002999 isl_set_copy(DomainCtx), Ty);
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003000 }
3001
3002 isl_set_free(DomainCtx);
3003}
3004
Tobias Grosser29f38ab2015-12-13 21:00:40 +00003005bool Scop::isHoistableAccess(MemoryAccess *Access,
3006 __isl_keep isl_union_map *Writes) {
3007 // TODO: Loads that are not loop carried, hence are in a statement with
3008 // zero iterators, are by construction invariant, though we
3009 // currently "hoist" them anyway. This is necessary because we allow
3010 // them to be treated as parameters (e.g., in conditions) and our code
3011 // generation would otherwise use the old value.
3012
3013 auto &Stmt = *Access->getStatement();
3014 BasicBlock *BB =
3015 Stmt.isBlockStmt() ? Stmt.getBasicBlock() : Stmt.getRegion()->getEntry();
3016
3017 if (Access->isScalarKind() || Access->isWrite() || !Access->isAffine())
3018 return false;
3019
3020 // Skip accesses that have an invariant base pointer which is defined but
3021 // not loaded inside the SCoP. This can happened e.g., if a readnone call
3022 // returns a pointer that is used as a base address. However, as we want
3023 // to hoist indirect pointers, we allow the base pointer to be defined in
3024 // the region if it is also a memory access. Each ScopArrayInfo object
3025 // that has a base pointer origin has a base pointer that is loaded and
3026 // that it is invariant, thus it will be hoisted too. However, if there is
3027 // no base pointer origin we check that the base pointer is defined
3028 // outside the region.
3029 const ScopArrayInfo *SAI = Access->getScopArrayInfo();
Johannes Doerfert4cf15802016-02-15 12:42:05 +00003030 auto *BasePtrInst = dyn_cast<Instruction>(SAI->getBasePtr());
3031 if (SAI->getBasePtrOriginSAI()) {
3032 assert(BasePtrInst && R.contains(BasePtrInst));
3033 if (!isa<LoadInst>(BasePtrInst))
Tobias Grosser29f38ab2015-12-13 21:00:40 +00003034 return false;
Michael Kruse6f7721f2016-02-24 22:08:19 +00003035 auto *BasePtrStmt = getStmtFor(BasePtrInst);
Johannes Doerfert4cf15802016-02-15 12:42:05 +00003036 assert(BasePtrStmt);
3037 auto *BasePtrMA = BasePtrStmt->getArrayAccessOrNULLFor(BasePtrInst);
3038 if (BasePtrMA && !isHoistableAccess(BasePtrMA, Writes))
3039 return false;
3040 } else if (BasePtrInst && R.contains(BasePtrInst))
3041 return false;
Tobias Grosser29f38ab2015-12-13 21:00:40 +00003042
3043 // Skip accesses in non-affine subregions as they might not be executed
3044 // under the same condition as the entry of the non-affine subregion.
3045 if (BB != Access->getAccessInstruction()->getParent())
3046 return false;
3047
3048 isl_map *AccessRelation = Access->getAccessRelation();
3049
3050 // Skip accesses that have an empty access relation. These can be caused
3051 // by multiple offsets with a type cast in-between that cause the overall
3052 // byte offset to be not divisible by the new types sizes.
3053 if (isl_map_is_empty(AccessRelation)) {
3054 isl_map_free(AccessRelation);
3055 return false;
3056 }
3057
3058 if (isl_map_involves_dims(AccessRelation, isl_dim_in, 0,
3059 Stmt.getNumIterators())) {
3060 isl_map_free(AccessRelation);
3061 return false;
3062 }
3063
3064 AccessRelation = isl_map_intersect_domain(AccessRelation, Stmt.getDomain());
3065 isl_set *AccessRange = isl_map_range(AccessRelation);
3066
3067 isl_union_map *Written = isl_union_map_intersect_range(
3068 isl_union_map_copy(Writes), isl_union_set_from_set(AccessRange));
3069 bool IsWritten = !isl_union_map_is_empty(Written);
3070 isl_union_map_free(Written);
3071
3072 if (IsWritten)
3073 return false;
3074
3075 return true;
3076}
3077
Hongbin Zheng7dddfba2016-02-13 15:12:47 +00003078void Scop::verifyInvariantLoads(ScopDetection &SD) {
Tobias Grosser29f38ab2015-12-13 21:00:40 +00003079 auto &RIL = *SD.getRequiredInvariantLoads(&getRegion());
3080 for (LoadInst *LI : RIL) {
3081 assert(LI && getRegion().contains(LI));
Michael Kruse6f7721f2016-02-24 22:08:19 +00003082 ScopStmt *Stmt = getStmtFor(LI);
Tobias Grosser949e8c62015-12-21 07:10:39 +00003083 if (Stmt && Stmt->getArrayAccessOrNULLFor(LI)) {
Tobias Grosser29f38ab2015-12-13 21:00:40 +00003084 invalidate(INVARIANTLOAD, LI->getDebugLoc());
3085 return;
3086 }
3087 }
3088}
3089
Hongbin Zheng7dddfba2016-02-13 15:12:47 +00003090void Scop::hoistInvariantLoads(ScopDetection &SD) {
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00003091 isl_union_map *Writes = getWrites();
3092 for (ScopStmt &Stmt : *this) {
3093
Tobias Grosser29f38ab2015-12-13 21:00:40 +00003094 MemoryAccessList InvariantAccesses;
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00003095
Tobias Grosser29f38ab2015-12-13 21:00:40 +00003096 for (MemoryAccess *Access : Stmt)
3097 if (isHoistableAccess(Access, Writes))
3098 InvariantAccesses.push_front(Access);
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00003099
3100 // We inserted invariant accesses always in the front but need them to be
3101 // sorted in a "natural order". The statements are already sorted in reverse
3102 // post order and that suffices for the accesses too. The reason we require
3103 // an order in the first place is the dependences between invariant loads
3104 // that can be caused by indirect loads.
Tobias Grosser29f38ab2015-12-13 21:00:40 +00003105 InvariantAccesses.reverse();
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00003106
3107 // Transfer the memory access from the statement to the SCoP.
Tobias Grosser29f38ab2015-12-13 21:00:40 +00003108 Stmt.removeMemoryAccesses(InvariantAccesses);
3109 addInvariantLoads(Stmt, InvariantAccesses);
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00003110 }
3111 isl_union_map_free(Writes);
3112
Hongbin Zheng7dddfba2016-02-13 15:12:47 +00003113 verifyInvariantLoads(SD);
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00003114}
3115
Johannes Doerfert80ef1102014-11-07 08:31:31 +00003116const ScopArrayInfo *
Tobias Grossercc779502016-02-02 13:22:54 +00003117Scop::getOrCreateScopArrayInfo(Value *BasePtr, Type *ElementType,
Tobias Grosser6abc75a2015-11-10 17:31:31 +00003118 ArrayRef<const SCEV *> Sizes,
Tobias Grossera535dff2015-12-13 19:59:01 +00003119 ScopArrayInfo::MemoryKind Kind) {
Tobias Grosser6abc75a2015-11-10 17:31:31 +00003120 auto &SAI = ScopArrayInfoMap[std::make_pair(BasePtr, Kind)];
Tobias Grosser99c70dd2015-09-26 08:55:54 +00003121 if (!SAI) {
Johannes Doerfert55b3d8b2015-11-12 20:15:08 +00003122 auto &DL = getRegion().getEntry()->getModule()->getDataLayout();
Tobias Grossercc779502016-02-02 13:22:54 +00003123 SAI.reset(new ScopArrayInfo(BasePtr, ElementType, getIslCtx(), Sizes, Kind,
Johannes Doerfert55b3d8b2015-11-12 20:15:08 +00003124 DL, this));
Tobias Grosser99c70dd2015-09-26 08:55:54 +00003125 } else {
Johannes Doerfert3ff22212016-02-14 22:31:39 +00003126 SAI->updateElementType(ElementType);
Tobias Grosser8286b832015-11-02 11:29:32 +00003127 // In case of mismatching array sizes, we bail out by setting the run-time
3128 // context to false.
Johannes Doerfert3ff22212016-02-14 22:31:39 +00003129 if (!SAI->updateSizes(Sizes))
Tobias Grosser8d4f6262015-12-12 09:52:26 +00003130 invalidate(DELINEARIZATION, DebugLoc());
Tobias Grosser99c70dd2015-09-26 08:55:54 +00003131 }
Tobias Grosserab671442015-05-23 05:58:27 +00003132 return SAI.get();
Johannes Doerfert1a28a892014-10-05 11:32:18 +00003133}
3134
Tobias Grosser6abc75a2015-11-10 17:31:31 +00003135const ScopArrayInfo *Scop::getScopArrayInfo(Value *BasePtr,
Tobias Grossera535dff2015-12-13 19:59:01 +00003136 ScopArrayInfo::MemoryKind Kind) {
Tobias Grosser6abc75a2015-11-10 17:31:31 +00003137 auto *SAI = ScopArrayInfoMap[std::make_pair(BasePtr, Kind)].get();
Johannes Doerfert1a28a892014-10-05 11:32:18 +00003138 assert(SAI && "No ScopArrayInfo available for this base pointer");
3139 return SAI;
3140}
3141
Tobias Grosser74394f02013-01-14 22:40:23 +00003142std::string Scop::getContextStr() const { return stringFromIslObj(Context); }
Johannes Doerfertb92e2182016-02-21 16:37:58 +00003143
Tobias Grosser5e6813d2014-07-02 17:47:48 +00003144std::string Scop::getAssumedContextStr() const {
3145 return stringFromIslObj(AssumedContext);
3146}
Johannes Doerfertb92e2182016-02-21 16:37:58 +00003147
Johannes Doerfert883f8c12015-09-15 22:52:53 +00003148std::string Scop::getBoundaryContextStr() const {
3149 return stringFromIslObj(BoundaryContext);
3150}
Tobias Grosser75805372011-04-29 06:27:02 +00003151
3152std::string Scop::getNameStr() const {
3153 std::string ExitName, EntryName;
3154 raw_string_ostream ExitStr(ExitName);
3155 raw_string_ostream EntryStr(EntryName);
3156
Tobias Grosserf240b482014-01-09 10:42:15 +00003157 R.getEntry()->printAsOperand(EntryStr, false);
Tobias Grosser75805372011-04-29 06:27:02 +00003158 EntryStr.str();
3159
3160 if (R.getExit()) {
Tobias Grosserf240b482014-01-09 10:42:15 +00003161 R.getExit()->printAsOperand(ExitStr, false);
Tobias Grosser75805372011-04-29 06:27:02 +00003162 ExitStr.str();
3163 } else
3164 ExitName = "FunctionExit";
3165
3166 return EntryName + "---" + ExitName;
3167}
3168
Tobias Grosser74394f02013-01-14 22:40:23 +00003169__isl_give isl_set *Scop::getContext() const { return isl_set_copy(Context); }
Tobias Grosser37487052011-10-06 00:03:42 +00003170__isl_give isl_space *Scop::getParamSpace() const {
Tobias Grossereeb9f3c2015-05-26 21:37:31 +00003171 return isl_set_get_space(Context);
Tobias Grosser37487052011-10-06 00:03:42 +00003172}
3173
Tobias Grossere86109f2013-10-29 21:05:49 +00003174__isl_give isl_set *Scop::getAssumedContext() const {
3175 return isl_set_copy(AssumedContext);
3176}
3177
Johannes Doerfert43788c52015-08-20 05:58:56 +00003178__isl_give isl_set *Scop::getRuntimeCheckContext() const {
3179 isl_set *RuntimeCheckContext = getAssumedContext();
Johannes Doerfert883f8c12015-09-15 22:52:53 +00003180 RuntimeCheckContext =
3181 isl_set_intersect(RuntimeCheckContext, getBoundaryContext());
3182 RuntimeCheckContext = simplifyAssumptionContext(RuntimeCheckContext, *this);
Johannes Doerfert43788c52015-08-20 05:58:56 +00003183 return RuntimeCheckContext;
3184}
3185
Johannes Doerfert5d5b3062015-08-20 18:06:30 +00003186bool Scop::hasFeasibleRuntimeContext() const {
Johannes Doerfert43788c52015-08-20 05:58:56 +00003187 isl_set *RuntimeCheckContext = getRuntimeCheckContext();
Johannes Doerfert5d5b3062015-08-20 18:06:30 +00003188 RuntimeCheckContext = addNonEmptyDomainConstraints(RuntimeCheckContext);
Johannes Doerfert43788c52015-08-20 05:58:56 +00003189 bool IsFeasible = !isl_set_is_empty(RuntimeCheckContext);
3190 isl_set_free(RuntimeCheckContext);
3191 return IsFeasible;
3192}
3193
Johannes Doerfertd84493e2015-11-12 02:33:38 +00003194static std::string toString(AssumptionKind Kind) {
3195 switch (Kind) {
3196 case ALIASING:
3197 return "No-aliasing";
3198 case INBOUNDS:
3199 return "Inbounds";
3200 case WRAPPING:
3201 return "No-overflows";
3202 case ERRORBLOCK:
3203 return "No-error";
3204 case INFINITELOOP:
3205 return "Finite loop";
3206 case INVARIANTLOAD:
3207 return "Invariant load";
3208 case DELINEARIZATION:
3209 return "Delinearization";
Tobias Grosser75dc40c2015-12-20 13:31:48 +00003210 case ERROR_DOMAINCONJUNCTS:
3211 return "Low number of domain conjuncts";
Johannes Doerfertd84493e2015-11-12 02:33:38 +00003212 }
3213 llvm_unreachable("Unknown AssumptionKind!");
3214}
3215
3216void Scop::trackAssumption(AssumptionKind Kind, __isl_keep isl_set *Set,
3217 DebugLoc Loc) {
3218 if (isl_set_is_subset(Context, Set))
3219 return;
3220
3221 if (isl_set_is_subset(AssumedContext, Set))
3222 return;
3223
3224 auto &F = *getRegion().getEntry()->getParent();
3225 std::string Msg = toString(Kind) + " assumption:\t" + stringFromIslObj(Set);
3226 emitOptimizationRemarkAnalysis(F.getContext(), DEBUG_TYPE, F, Loc, Msg);
3227}
3228
3229void Scop::addAssumption(AssumptionKind Kind, __isl_take isl_set *Set,
3230 DebugLoc Loc) {
3231 trackAssumption(Kind, Set, Loc);
Tobias Grosser5e6813d2014-07-02 17:47:48 +00003232 AssumedContext = isl_set_intersect(AssumedContext, Set);
Tobias Grosser20a4c0c2015-11-11 16:22:36 +00003233
Johannes Doerfert9d7899e2015-11-11 20:01:31 +00003234 int NSets = isl_set_n_basic_set(AssumedContext);
Tobias Grosser20a4c0c2015-11-11 16:22:36 +00003235 if (NSets >= MaxDisjunctsAssumed) {
3236 isl_space *Space = isl_set_get_space(AssumedContext);
3237 isl_set_free(AssumedContext);
Tobias Grossere19fca42015-11-11 20:21:39 +00003238 AssumedContext = isl_set_empty(Space);
Tobias Grosser20a4c0c2015-11-11 16:22:36 +00003239 }
3240
Tobias Grosser7b50bee2014-11-25 10:51:12 +00003241 AssumedContext = isl_set_coalesce(AssumedContext);
Tobias Grosser5e6813d2014-07-02 17:47:48 +00003242}
3243
Tobias Grosser8d4f6262015-12-12 09:52:26 +00003244void Scop::invalidate(AssumptionKind Kind, DebugLoc Loc) {
3245 addAssumption(Kind, isl_set_empty(getParamSpace()), Loc);
3246}
3247
Johannes Doerfert883f8c12015-09-15 22:52:53 +00003248__isl_give isl_set *Scop::getBoundaryContext() const {
3249 return isl_set_copy(BoundaryContext);
3250}
3251
Tobias Grosser75805372011-04-29 06:27:02 +00003252void Scop::printContext(raw_ostream &OS) const {
3253 OS << "Context:\n";
3254
3255 if (!Context) {
3256 OS.indent(4) << "n/a\n\n";
3257 return;
3258 }
3259
3260 OS.indent(4) << getContextStr() << "\n";
Tobias Grosser60b54f12011-11-08 15:41:28 +00003261
Tobias Grosser5e6813d2014-07-02 17:47:48 +00003262 OS.indent(4) << "Assumed Context:\n";
3263 if (!AssumedContext) {
3264 OS.indent(4) << "n/a\n\n";
3265 return;
3266 }
3267
3268 OS.indent(4) << getAssumedContextStr() << "\n";
3269
Johannes Doerfert883f8c12015-09-15 22:52:53 +00003270 OS.indent(4) << "Boundary Context:\n";
3271 if (!BoundaryContext) {
3272 OS.indent(4) << "n/a\n\n";
3273 return;
3274 }
3275
3276 OS.indent(4) << getBoundaryContextStr() << "\n";
3277
Tobias Grosser083d3d32014-06-28 08:59:45 +00003278 for (const SCEV *Parameter : Parameters) {
Tobias Grosser60b54f12011-11-08 15:41:28 +00003279 int Dim = ParameterIds.find(Parameter)->second;
Tobias Grosser60b54f12011-11-08 15:41:28 +00003280 OS.indent(4) << "p" << Dim << ": " << *Parameter << "\n";
3281 }
Tobias Grosser75805372011-04-29 06:27:02 +00003282}
3283
Johannes Doerfertb164c792014-09-18 11:17:17 +00003284void Scop::printAliasAssumptions(raw_ostream &OS) const {
Tobias Grosserbb853c22015-07-25 12:31:03 +00003285 int noOfGroups = 0;
3286 for (const MinMaxVectorPairTy &Pair : MinMaxAliasGroups) {
Johannes Doerfert210b09a2015-07-26 13:14:38 +00003287 if (Pair.second.size() == 0)
Johannes Doerfert338b42c2015-07-23 17:04:54 +00003288 noOfGroups += 1;
3289 else
Johannes Doerfert210b09a2015-07-26 13:14:38 +00003290 noOfGroups += Pair.second.size();
Johannes Doerfert338b42c2015-07-23 17:04:54 +00003291 }
3292
Tobias Grosserbb853c22015-07-25 12:31:03 +00003293 OS.indent(4) << "Alias Groups (" << noOfGroups << "):\n";
Johannes Doerfertb164c792014-09-18 11:17:17 +00003294 if (MinMaxAliasGroups.empty()) {
3295 OS.indent(8) << "n/a\n";
3296 return;
3297 }
Johannes Doerfert338b42c2015-07-23 17:04:54 +00003298
Tobias Grosserbb853c22015-07-25 12:31:03 +00003299 for (const MinMaxVectorPairTy &Pair : MinMaxAliasGroups) {
Johannes Doerfert338b42c2015-07-23 17:04:54 +00003300
3301 // If the group has no read only accesses print the write accesses.
Johannes Doerfert210b09a2015-07-26 13:14:38 +00003302 if (Pair.second.empty()) {
Johannes Doerfert338b42c2015-07-23 17:04:54 +00003303 OS.indent(8) << "[[";
Johannes Doerfert210b09a2015-07-26 13:14:38 +00003304 for (const MinMaxAccessTy &MMANonReadOnly : Pair.first) {
Tobias Grosserbb853c22015-07-25 12:31:03 +00003305 OS << " <" << MMANonReadOnly.first << ", " << MMANonReadOnly.second
3306 << ">";
Johannes Doerfert338b42c2015-07-23 17:04:54 +00003307 }
3308 OS << " ]]\n";
3309 }
3310
Johannes Doerfert210b09a2015-07-26 13:14:38 +00003311 for (const MinMaxAccessTy &MMAReadOnly : Pair.second) {
Johannes Doerfert338b42c2015-07-23 17:04:54 +00003312 OS.indent(8) << "[[";
Tobias Grosserbb853c22015-07-25 12:31:03 +00003313 OS << " <" << MMAReadOnly.first << ", " << MMAReadOnly.second << ">";
Johannes Doerfert210b09a2015-07-26 13:14:38 +00003314 for (const MinMaxAccessTy &MMANonReadOnly : Pair.first) {
Tobias Grosserbb853c22015-07-25 12:31:03 +00003315 OS << " <" << MMANonReadOnly.first << ", " << MMANonReadOnly.second
3316 << ">";
Johannes Doerfert338b42c2015-07-23 17:04:54 +00003317 }
3318 OS << " ]]\n";
3319 }
Johannes Doerfertb164c792014-09-18 11:17:17 +00003320 }
3321}
3322
Tobias Grosser75805372011-04-29 06:27:02 +00003323void Scop::printStatements(raw_ostream &OS) const {
3324 OS << "Statements {\n";
3325
Tobias Grosser7c3bad52015-05-27 05:16:57 +00003326 for (const ScopStmt &Stmt : *this)
3327 OS.indent(4) << Stmt;
Tobias Grosser75805372011-04-29 06:27:02 +00003328
3329 OS.indent(4) << "}\n";
3330}
3331
Tobias Grosser49ad36c2015-05-20 08:05:31 +00003332void Scop::printArrayInfo(raw_ostream &OS) const {
3333 OS << "Arrays {\n";
3334
Tobias Grosserab671442015-05-23 05:58:27 +00003335 for (auto &Array : arrays())
Tobias Grosser49ad36c2015-05-20 08:05:31 +00003336 Array.second->print(OS);
3337
3338 OS.indent(4) << "}\n";
Tobias Grosserd46fd5e2015-08-12 15:27:16 +00003339
3340 OS.indent(4) << "Arrays (Bounds as pw_affs) {\n";
3341
3342 for (auto &Array : arrays())
3343 Array.second->print(OS, /* SizeAsPwAff */ true);
3344
3345 OS.indent(4) << "}\n";
Tobias Grosser49ad36c2015-05-20 08:05:31 +00003346}
3347
Tobias Grosser75805372011-04-29 06:27:02 +00003348void Scop::print(raw_ostream &OS) const {
Tobias Grosser4eb7ddb2014-03-18 18:51:11 +00003349 OS.indent(4) << "Function: " << getRegion().getEntry()->getParent()->getName()
3350 << "\n";
Tobias Grosser483fdd42014-03-18 18:05:38 +00003351 OS.indent(4) << "Region: " << getNameStr() << "\n";
David Peixottodc0a11c2015-01-13 18:31:55 +00003352 OS.indent(4) << "Max Loop Depth: " << getMaxLoopDepth() << "\n";
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00003353 OS.indent(4) << "Invariant Accesses: {\n";
Johannes Doerfert697fdf82015-10-09 17:12:26 +00003354 for (const auto &IAClass : InvariantEquivClasses) {
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003355 const auto &MAs = std::get<1>(IAClass);
3356 if (MAs.empty()) {
3357 OS.indent(12) << "Class Pointer: " << *std::get<0>(IAClass) << "\n";
Johannes Doerfert697fdf82015-10-09 17:12:26 +00003358 } else {
Johannes Doerfertaf3e3012015-10-18 12:39:19 +00003359 MAs.front()->print(OS);
3360 OS.indent(12) << "Execution Context: " << std::get<2>(IAClass) << "\n";
Johannes Doerfert697fdf82015-10-09 17:12:26 +00003361 }
Johannes Doerfertc1db67e2015-09-29 23:47:21 +00003362 }
3363 OS.indent(4) << "}\n";
Tobias Grosser75805372011-04-29 06:27:02 +00003364 printContext(OS.indent(4));
Tobias Grosser49ad36c2015-05-20 08:05:31 +00003365 printArrayInfo(OS.indent(4));
Johannes Doerfertb164c792014-09-18 11:17:17 +00003366 printAliasAssumptions(OS);
Tobias Grosser75805372011-04-29 06:27:02 +00003367 printStatements(OS.indent(4));
3368}
3369
3370void Scop::dump() const { print(dbgs()); }
3371
Hongbin Zheng8831eb72016-02-17 15:49:21 +00003372isl_ctx *Scop::getIslCtx() const { return IslCtx.get(); }
Tobias Grosser75805372011-04-29 06:27:02 +00003373
Johannes Doerfertcef616f2015-09-15 22:49:04 +00003374__isl_give isl_pw_aff *Scop::getPwAff(const SCEV *E, BasicBlock *BB) {
3375 return Affinator.getPwAff(E, BB);
Johannes Doerfert574182d2015-08-12 10:19:50 +00003376}
3377
Tobias Grosser808cd692015-07-14 09:33:13 +00003378__isl_give isl_union_set *Scop::getDomains() const {
Tobias Grosserbc4ef902014-06-28 08:59:38 +00003379 isl_union_set *Domain = isl_union_set_empty(getParamSpace());
Tobias Grosser5f9a7622012-02-14 14:02:40 +00003380
Tobias Grosser808cd692015-07-14 09:33:13 +00003381 for (const ScopStmt &Stmt : *this)
Tobias Grosser7c3bad52015-05-27 05:16:57 +00003382 Domain = isl_union_set_add_set(Domain, Stmt.getDomain());
Tobias Grosser5f9a7622012-02-14 14:02:40 +00003383
3384 return Domain;
3385}
3386
Tobias Grossere5a35142015-11-12 14:07:09 +00003387__isl_give isl_union_map *
3388Scop::getAccessesOfType(std::function<bool(MemoryAccess &)> Predicate) {
3389 isl_union_map *Accesses = isl_union_map_empty(getParamSpace());
Tobias Grosser780ce0f2014-07-11 07:12:10 +00003390
Tobias Grosser7c3bad52015-05-27 05:16:57 +00003391 for (ScopStmt &Stmt : *this) {
3392 for (MemoryAccess *MA : Stmt) {
Tobias Grossere5a35142015-11-12 14:07:09 +00003393 if (!Predicate(*MA))
Tobias Grosser780ce0f2014-07-11 07:12:10 +00003394 continue;
3395
Tobias Grosser7c3bad52015-05-27 05:16:57 +00003396 isl_set *Domain = Stmt.getDomain();
Tobias Grosser780ce0f2014-07-11 07:12:10 +00003397 isl_map *AccessDomain = MA->getAccessRelation();
3398 AccessDomain = isl_map_intersect_domain(AccessDomain, Domain);
Tobias Grossere5a35142015-11-12 14:07:09 +00003399 Accesses = isl_union_map_add_map(Accesses, AccessDomain);
Tobias Grosser780ce0f2014-07-11 07:12:10 +00003400 }
3401 }
Tobias Grossere5a35142015-11-12 14:07:09 +00003402 return isl_union_map_coalesce(Accesses);
3403}
3404
3405__isl_give isl_union_map *Scop::getMustWrites() {
3406 return getAccessesOfType([](MemoryAccess &MA) { return MA.isMustWrite(); });
Tobias Grosser780ce0f2014-07-11 07:12:10 +00003407}
3408
3409__isl_give isl_union_map *Scop::getMayWrites() {
Tobias Grossere5a35142015-11-12 14:07:09 +00003410 return getAccessesOfType([](MemoryAccess &MA) { return MA.isMayWrite(); });
Tobias Grosser780ce0f2014-07-11 07:12:10 +00003411}
3412
Tobias Grosser37eb4222014-02-20 21:43:54 +00003413__isl_give isl_union_map *Scop::getWrites() {
Tobias Grossere5a35142015-11-12 14:07:09 +00003414 return getAccessesOfType([](MemoryAccess &MA) { return MA.isWrite(); });
Tobias Grosser37eb4222014-02-20 21:43:54 +00003415}
3416
3417__isl_give isl_union_map *Scop::getReads() {
Tobias Grossere5a35142015-11-12 14:07:09 +00003418 return getAccessesOfType([](MemoryAccess &MA) { return MA.isRead(); });
Tobias Grosser37eb4222014-02-20 21:43:54 +00003419}
3420
Tobias Grosser2ac23382015-11-12 14:07:13 +00003421__isl_give isl_union_map *Scop::getAccesses() {
3422 return getAccessesOfType([](MemoryAccess &MA) { return true; });
3423}
3424
Tobias Grosser808cd692015-07-14 09:33:13 +00003425__isl_give isl_union_map *Scop::getSchedule() const {
Johannes Doerferta90943d2016-02-21 16:37:25 +00003426 auto *Tree = getScheduleTree();
3427 auto *S = isl_schedule_get_map(Tree);
Tobias Grosser808cd692015-07-14 09:33:13 +00003428 isl_schedule_free(Tree);
3429 return S;
3430}
Tobias Grosser37eb4222014-02-20 21:43:54 +00003431
Tobias Grosser808cd692015-07-14 09:33:13 +00003432__isl_give isl_schedule *Scop::getScheduleTree() const {
3433 return isl_schedule_intersect_domain(isl_schedule_copy(Schedule),
3434 getDomains());
3435}
Tobias Grosserbc4ef902014-06-28 08:59:38 +00003436
Tobias Grosser808cd692015-07-14 09:33:13 +00003437void Scop::setSchedule(__isl_take isl_union_map *NewSchedule) {
3438 auto *S = isl_schedule_from_domain(getDomains());
3439 S = isl_schedule_insert_partial_schedule(
3440 S, isl_multi_union_pw_aff_from_union_map(NewSchedule));
3441 isl_schedule_free(Schedule);
3442 Schedule = S;
3443}
3444
3445void Scop::setScheduleTree(__isl_take isl_schedule *NewSchedule) {
3446 isl_schedule_free(Schedule);
3447 Schedule = NewSchedule;
Tobias Grosser37eb4222014-02-20 21:43:54 +00003448}
3449
3450bool Scop::restrictDomains(__isl_take isl_union_set *Domain) {
3451 bool Changed = false;
Tobias Grosser7c3bad52015-05-27 05:16:57 +00003452 for (ScopStmt &Stmt : *this) {
3453 isl_union_set *StmtDomain = isl_union_set_from_set(Stmt.getDomain());
Tobias Grosser37eb4222014-02-20 21:43:54 +00003454 isl_union_set *NewStmtDomain = isl_union_set_intersect(
3455 isl_union_set_copy(StmtDomain), isl_union_set_copy(Domain));
3456
3457 if (isl_union_set_is_subset(StmtDomain, NewStmtDomain)) {
3458 isl_union_set_free(StmtDomain);
3459 isl_union_set_free(NewStmtDomain);
3460 continue;
3461 }
3462
3463 Changed = true;
3464
3465 isl_union_set_free(StmtDomain);
3466 NewStmtDomain = isl_union_set_coalesce(NewStmtDomain);
3467
3468 if (isl_union_set_is_empty(NewStmtDomain)) {
Tobias Grosser7c3bad52015-05-27 05:16:57 +00003469 Stmt.restrictDomain(isl_set_empty(Stmt.getDomainSpace()));
Tobias Grosser37eb4222014-02-20 21:43:54 +00003470 isl_union_set_free(NewStmtDomain);
3471 } else
Tobias Grosser7c3bad52015-05-27 05:16:57 +00003472 Stmt.restrictDomain(isl_set_from_union_set(NewStmtDomain));
Tobias Grosser37eb4222014-02-20 21:43:54 +00003473 }
3474 isl_union_set_free(Domain);
3475 return Changed;
3476}
3477
Tobias Grosser75805372011-04-29 06:27:02 +00003478ScalarEvolution *Scop::getSE() const { return SE; }
3479
Hongbin Zheng192f69a2016-02-13 15:12:54 +00003480bool Scop::isIgnored(RegionNode *RN, DominatorTree &DT, LoopInfo &LI) {
Johannes Doerfertf5673802015-10-01 23:48:18 +00003481 BasicBlock *BB = getRegionNodeBasicBlock(RN);
Michael Kruse6f7721f2016-02-24 22:08:19 +00003482 ScopStmt *Stmt = getStmtFor(RN);
Michael Krusea902ba62015-12-13 19:21:45 +00003483
3484 // If there is no stmt, then it already has been removed.
3485 if (!Stmt)
3486 return true;
Tobias Grosser75805372011-04-29 06:27:02 +00003487
Johannes Doerfertf5673802015-10-01 23:48:18 +00003488 // Check if there are accesses contained.
Michael Krusea902ba62015-12-13 19:21:45 +00003489 if (Stmt->isEmpty())
Johannes Doerfertf5673802015-10-01 23:48:18 +00003490 return true;
3491
3492 // Check for reachability via non-error blocks.
3493 if (!DomainMap.count(BB))
3494 return true;
3495
3496 // Check if error blocks are contained.
Johannes Doerfert08d90a32015-10-07 20:32:43 +00003497 if (containsErrorBlock(RN, getRegion(), LI, DT))
Johannes Doerfertf5673802015-10-01 23:48:18 +00003498 return true;
3499
3500 return false;
Tobias Grosser75805372011-04-29 06:27:02 +00003501}
3502
Tobias Grosser808cd692015-07-14 09:33:13 +00003503struct MapToDimensionDataTy {
3504 int N;
3505 isl_union_pw_multi_aff *Res;
3506};
Johannes Doerfertff9d1982015-02-24 12:00:50 +00003507
Tobias Grosser808cd692015-07-14 09:33:13 +00003508// @brief Create a function that maps the elements of 'Set' to its N-th
Tobias Grossercbf7ae82015-12-21 22:45:53 +00003509// dimension and add it to User->Res.
Tobias Grosser808cd692015-07-14 09:33:13 +00003510//
Tobias Grossercbf7ae82015-12-21 22:45:53 +00003511// @param Set The input set.
3512// @param User->N The dimension to map to.
3513// @param User->Res The isl_union_pw_multi_aff to which to add the result.
Tobias Grosser808cd692015-07-14 09:33:13 +00003514//
Tobias Grossercbf7ae82015-12-21 22:45:53 +00003515// @returns isl_stat_ok if no error occured, othewise isl_stat_error.
Tobias Grosser808cd692015-07-14 09:33:13 +00003516static isl_stat mapToDimension_AddSet(__isl_take isl_set *Set, void *User) {
3517 struct MapToDimensionDataTy *Data = (struct MapToDimensionDataTy *)User;
3518 int Dim;
3519 isl_space *Space;
3520 isl_pw_multi_aff *PMA;
3521
3522 Dim = isl_set_dim(Set, isl_dim_set);
3523 Space = isl_set_get_space(Set);
3524 PMA = isl_pw_multi_aff_project_out_map(Space, isl_dim_set, Data->N,
3525 Dim - Data->N);
3526 if (Data->N > 1)
3527 PMA = isl_pw_multi_aff_drop_dims(PMA, isl_dim_out, 0, Data->N - 1);
3528 Data->Res = isl_union_pw_multi_aff_add_pw_multi_aff(Data->Res, PMA);
3529
3530 isl_set_free(Set);
3531
3532 return isl_stat_ok;
Johannes Doerfertff9d1982015-02-24 12:00:50 +00003533}
3534
Tobias Grossercbf7ae82015-12-21 22:45:53 +00003535// @brief Create an isl_multi_union_aff that defines an identity mapping
3536// from the elements of USet to their N-th dimension.
Tobias Grosser808cd692015-07-14 09:33:13 +00003537//
Tobias Grossercbf7ae82015-12-21 22:45:53 +00003538// # Example:
3539//
3540// Domain: { A[i,j]; B[i,j,k] }
3541// N: 1
3542//
3543// Resulting Mapping: { {A[i,j] -> [(j)]; B[i,j,k] -> [(j)] }
3544//
3545// @param USet A union set describing the elements for which to generate a
3546// mapping.
Tobias Grosser808cd692015-07-14 09:33:13 +00003547// @param N The dimension to map to.
Tobias Grossercbf7ae82015-12-21 22:45:53 +00003548// @returns A mapping from USet to its N-th dimension.
Tobias Grosser808cd692015-07-14 09:33:13 +00003549static __isl_give isl_multi_union_pw_aff *
Tobias Grossercbf7ae82015-12-21 22:45:53 +00003550mapToDimension(__isl_take isl_union_set *USet, int N) {
3551 assert(N >= 0);
Tobias Grosserc900633d2015-12-21 23:01:53 +00003552 assert(USet);
Tobias Grossercbf7ae82015-12-21 22:45:53 +00003553 assert(!isl_union_set_is_empty(USet));
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00003554
Tobias Grosser808cd692015-07-14 09:33:13 +00003555 struct MapToDimensionDataTy Data;
Tobias Grosser808cd692015-07-14 09:33:13 +00003556
Tobias Grossercbf7ae82015-12-21 22:45:53 +00003557 auto *Space = isl_union_set_get_space(USet);
3558 auto *PwAff = isl_union_pw_multi_aff_empty(Space);
Tobias Grosser808cd692015-07-14 09:33:13 +00003559
Tobias Grossercbf7ae82015-12-21 22:45:53 +00003560 Data = {N, PwAff};
3561
3562 auto Res = isl_union_set_foreach_set(USet, &mapToDimension_AddSet, &Data);
Sumanth Gundapaneni4b1472f2016-01-20 15:41:30 +00003563 (void)Res;
3564
Tobias Grossercbf7ae82015-12-21 22:45:53 +00003565 assert(Res == isl_stat_ok);
3566
3567 isl_union_set_free(USet);
Tobias Grosser808cd692015-07-14 09:33:13 +00003568 return isl_multi_union_pw_aff_from_union_pw_multi_aff(Data.Res);
3569}
3570
Tobias Grosser316b5b22015-11-11 19:28:14 +00003571void Scop::addScopStmt(BasicBlock *BB, Region *R) {
Tobias Grosser808cd692015-07-14 09:33:13 +00003572 if (BB) {
Michael Kruse9d080092015-09-11 21:41:48 +00003573 Stmts.emplace_back(*this, *BB);
Johannes Doerferta90943d2016-02-21 16:37:25 +00003574 auto *Stmt = &Stmts.back();
Tobias Grosser808cd692015-07-14 09:33:13 +00003575 StmtMap[BB] = Stmt;
3576 } else {
3577 assert(R && "Either basic block or a region expected.");
Michael Kruse9d080092015-09-11 21:41:48 +00003578 Stmts.emplace_back(*this, *R);
Johannes Doerferta90943d2016-02-21 16:37:25 +00003579 auto *Stmt = &Stmts.back();
Tobias Grosser808cd692015-07-14 09:33:13 +00003580 for (BasicBlock *BB : R->blocks())
3581 StmtMap[BB] = Stmt;
3582 }
Tobias Grosser808cd692015-07-14 09:33:13 +00003583}
3584
Hongbin Zheng192f69a2016-02-13 15:12:54 +00003585void Scop::buildSchedule(ScopDetection &SD, LoopInfo &LI) {
Johannes Doerfertf9711ef2016-01-06 12:59:23 +00003586 Loop *L = getLoopSurroundingRegion(getRegion(), LI);
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00003587 LoopStackTy LoopStack({LoopStackElementTy(L, nullptr, 0)});
Hongbin Zheng192f69a2016-02-13 15:12:54 +00003588 buildSchedule(getRegion().getNode(), LoopStack, SD, LI);
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00003589 assert(LoopStack.size() == 1 && LoopStack.back().L == L);
3590 Schedule = LoopStack[0].Schedule;
Johannes Doerfertf9711ef2016-01-06 12:59:23 +00003591}
3592
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00003593/// To generate a schedule for the elements in a Region we traverse the Region
3594/// in reverse-post-order and add the contained RegionNodes in traversal order
3595/// to the schedule of the loop that is currently at the top of the LoopStack.
3596/// For loop-free codes, this results in a correct sequential ordering.
3597///
3598/// Example:
3599/// bb1(0)
3600/// / \.
3601/// bb2(1) bb3(2)
3602/// \ / \.
3603/// bb4(3) bb5(4)
3604/// \ /
3605/// bb6(5)
3606///
3607/// Including loops requires additional processing. Whenever a loop header is
3608/// encountered, the corresponding loop is added to the @p LoopStack. Starting
3609/// from an empty schedule, we first process all RegionNodes that are within
3610/// this loop and complete the sequential schedule at this loop-level before
3611/// processing about any other nodes. To implement this
3612/// loop-nodes-first-processing, the reverse post-order traversal is
3613/// insufficient. Hence, we additionally check if the traversal yields
3614/// sub-regions or blocks that are outside the last loop on the @p LoopStack.
3615/// These region-nodes are then queue and only traverse after the all nodes
3616/// within the current loop have been processed.
Hongbin Zheng192f69a2016-02-13 15:12:54 +00003617void Scop::buildSchedule(Region *R, LoopStackTy &LoopStack, ScopDetection &SD,
3618 LoopInfo &LI) {
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00003619 Loop *OuterScopLoop = getLoopSurroundingRegion(getRegion(), LI);
3620
3621 ReversePostOrderTraversal<Region *> RTraversal(R);
3622 std::deque<RegionNode *> WorkList(RTraversal.begin(), RTraversal.end());
3623 std::deque<RegionNode *> DelayList;
3624 bool LastRNWaiting = false;
3625
3626 // Iterate over the region @p R in reverse post-order but queue
3627 // sub-regions/blocks iff they are not part of the last encountered but not
3628 // completely traversed loop. The variable LastRNWaiting is a flag to indicate
3629 // that we queued the last sub-region/block from the reverse post-order
3630 // iterator. If it is set we have to explore the next sub-region/block from
3631 // the iterator (if any) to guarantee progress. If it is not set we first try
3632 // the next queued sub-region/blocks.
3633 while (!WorkList.empty() || !DelayList.empty()) {
3634 RegionNode *RN;
3635
3636 if ((LastRNWaiting && !WorkList.empty()) || DelayList.size() == 0) {
3637 RN = WorkList.front();
3638 WorkList.pop_front();
3639 LastRNWaiting = false;
3640 } else {
3641 RN = DelayList.front();
3642 DelayList.pop_front();
3643 }
3644
3645 Loop *L = getRegionNodeLoop(RN, LI);
3646 if (!getRegion().contains(L))
3647 L = OuterScopLoop;
3648
3649 Loop *LastLoop = LoopStack.back().L;
3650 if (LastLoop != L) {
3651 if (!LastLoop->contains(L)) {
3652 LastRNWaiting = true;
3653 DelayList.push_back(RN);
3654 continue;
3655 }
3656 LoopStack.push_back({L, nullptr, 0});
3657 }
Hongbin Zheng192f69a2016-02-13 15:12:54 +00003658 buildSchedule(RN, LoopStack, SD, LI);
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00003659 }
3660
3661 return;
3662}
3663
Hongbin Zheng7dddfba2016-02-13 15:12:47 +00003664void Scop::buildSchedule(RegionNode *RN, LoopStackTy &LoopStack,
Hongbin Zheng192f69a2016-02-13 15:12:54 +00003665 ScopDetection &SD, LoopInfo &LI) {
Michael Kruse046dde42015-08-10 13:01:57 +00003666
Tobias Grosser8362c262016-01-06 15:30:06 +00003667 if (RN->isSubRegion()) {
3668 auto *LocalRegion = RN->getNodeAs<Region>();
3669 if (!SD.isNonAffineSubRegion(LocalRegion, &getRegion())) {
Hongbin Zheng192f69a2016-02-13 15:12:54 +00003670 buildSchedule(LocalRegion, LoopStack, SD, LI);
Tobias Grosser8362c262016-01-06 15:30:06 +00003671 return;
3672 }
3673 }
Michael Kruse046dde42015-08-10 13:01:57 +00003674
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00003675 auto &LoopData = LoopStack.back();
3676 LoopData.NumBlocksProcessed += getNumBlocksInRegionNode(RN);
Tobias Grosser8362c262016-01-06 15:30:06 +00003677
Michael Kruse6f7721f2016-02-24 22:08:19 +00003678 if (auto *Stmt = getStmtFor(RN)) {
Tobias Grosser8362c262016-01-06 15:30:06 +00003679 auto *UDomain = isl_union_set_from_set(Stmt->getDomain());
3680 auto *StmtSchedule = isl_schedule_from_domain(UDomain);
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00003681 LoopData.Schedule = combineInSequence(LoopData.Schedule, StmtSchedule);
Tobias Grosser8362c262016-01-06 15:30:06 +00003682 }
3683
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00003684 // Check if we just processed the last node in this loop. If we did, finalize
3685 // the loop by:
3686 //
3687 // - adding new schedule dimensions
3688 // - folding the resulting schedule into the parent loop schedule
3689 // - dropping the loop schedule from the LoopStack.
3690 //
3691 // Then continue to check surrounding loops, which might also have been
3692 // completed by this node.
3693 while (LoopData.L &&
3694 LoopData.NumBlocksProcessed == LoopData.L->getNumBlocks()) {
Johannes Doerferta90943d2016-02-21 16:37:25 +00003695 auto *Schedule = LoopData.Schedule;
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00003696 auto NumBlocksProcessed = LoopData.NumBlocksProcessed;
Tobias Grosser8362c262016-01-06 15:30:06 +00003697
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00003698 LoopStack.pop_back();
3699 auto &NextLoopData = LoopStack.back();
Tobias Grosser8362c262016-01-06 15:30:06 +00003700
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00003701 if (Schedule) {
3702 auto *Domain = isl_schedule_get_domain(Schedule);
3703 auto *MUPA = mapToDimension(Domain, LoopStack.size());
3704 Schedule = isl_schedule_insert_partial_schedule(Schedule, MUPA);
3705 NextLoopData.Schedule =
3706 combineInSequence(NextLoopData.Schedule, Schedule);
Tobias Grosser75805372011-04-29 06:27:02 +00003707 }
Johannes Doerfertb68cffb2015-09-10 15:27:46 +00003708
Tobias Grosserc2fd8b42016-02-01 11:54:13 +00003709 NextLoopData.NumBlocksProcessed += NumBlocksProcessed;
3710 LoopData = NextLoopData;
Tobias Grosser808cd692015-07-14 09:33:13 +00003711 }
Tobias Grosser75805372011-04-29 06:27:02 +00003712}
3713
Michael Kruse6f7721f2016-02-24 22:08:19 +00003714ScopStmt *Scop::getStmtFor(BasicBlock *BB) const {
Tobias Grosser57411e32015-05-27 06:51:34 +00003715 auto StmtMapIt = StmtMap.find(BB);
Johannes Doerfert7c494212014-10-31 23:13:39 +00003716 if (StmtMapIt == StmtMap.end())
3717 return nullptr;
3718 return StmtMapIt->second;
3719}
3720
Michael Kruse6f7721f2016-02-24 22:08:19 +00003721ScopStmt *Scop::getStmtFor(RegionNode *RN) const {
3722 if (RN->isSubRegion())
3723 return getStmtFor(RN->getNodeAs<Region>());
3724 return getStmtFor(RN->getNodeAs<BasicBlock>());
3725}
3726
3727ScopStmt *Scop::getStmtFor(Region *R) const {
3728 ScopStmt *Stmt = getStmtFor(R->getEntry());
3729 assert(!Stmt || Stmt->getRegion() == R);
3730 return Stmt;
Michael Krusea902ba62015-12-13 19:21:45 +00003731}
3732
Johannes Doerfert96425c22015-08-30 21:13:53 +00003733int Scop::getRelativeLoopDepth(const Loop *L) const {
3734 Loop *OuterLoop =
3735 L ? R.outermostLoopInRegion(const_cast<Loop *>(L)) : nullptr;
3736 if (!OuterLoop)
3737 return -1;
Johannes Doerfertd020b772015-08-27 06:53:52 +00003738 return L->getLoopDepth() - OuterLoop->getLoopDepth();
3739}
3740
Michael Krused868b5d2015-09-10 15:25:24 +00003741void ScopInfo::buildPHIAccesses(PHINode *PHI, Region &R,
Michael Krused868b5d2015-09-10 15:25:24 +00003742 Region *NonAffineSubRegion, bool IsExitBlock) {
Michael Kruse7bf39442015-09-10 12:46:52 +00003743
3744 // PHI nodes that are in the exit block of the region, hence if IsExitBlock is
3745 // true, are not modeled as ordinary PHI nodes as they are not part of the
3746 // region. However, we model the operands in the predecessor blocks that are
3747 // part of the region as regular scalar accesses.
3748
3749 // If we can synthesize a PHI we can skip it, however only if it is in
3750 // the region. If it is not it can only be in the exit block of the region.
3751 // In this case we model the operands but not the PHI itself.
3752 if (!IsExitBlock && canSynthesize(PHI, LI, SE, &R))
3753 return;
3754
3755 // PHI nodes are modeled as if they had been demoted prior to the SCoP
3756 // detection. Hence, the PHI is a load of a new memory location in which the
3757 // incoming value was written at the end of the incoming basic block.
3758 bool OnlyNonAffineSubRegionOperands = true;
3759 for (unsigned u = 0; u < PHI->getNumIncomingValues(); u++) {
3760 Value *Op = PHI->getIncomingValue(u);
3761 BasicBlock *OpBB = PHI->getIncomingBlock(u);
3762
3763 // Do not build scalar dependences inside a non-affine subregion.
3764 if (NonAffineSubRegion && NonAffineSubRegion->contains(OpBB))
3765 continue;
3766
3767 OnlyNonAffineSubRegionOperands = false;
Michael Kruseee6a4fc2016-01-26 13:33:27 +00003768 ensurePHIWrite(PHI, OpBB, Op, IsExitBlock);
Michael Kruse7bf39442015-09-10 12:46:52 +00003769 }
3770
Michael Kruse33d6c0b2015-09-25 18:53:27 +00003771 if (!OnlyNonAffineSubRegionOperands && !IsExitBlock) {
3772 addPHIReadAccess(PHI);
Michael Kruse7bf39442015-09-10 12:46:52 +00003773 }
3774}
3775
Michael Kruse2e02d562016-02-06 09:19:40 +00003776void ScopInfo::buildScalarDependences(Instruction *Inst) {
3777 assert(!isa<PHINode>(Inst));
Michael Kruse7bf39442015-09-10 12:46:52 +00003778
Michael Kruse2e02d562016-02-06 09:19:40 +00003779 // Pull-in required operands.
3780 for (Use &Op : Inst->operands())
3781 ensureValueRead(Op.get(), Inst->getParent());
3782}
Michael Kruse7bf39442015-09-10 12:46:52 +00003783
Michael Kruse2e02d562016-02-06 09:19:40 +00003784void ScopInfo::buildEscapingDependences(Instruction *Inst) {
3785 Region *R = &scop->getRegion();
Michael Kruse7bf39442015-09-10 12:46:52 +00003786
Michael Kruse2e02d562016-02-06 09:19:40 +00003787 // Check for uses of this instruction outside the scop. Because we do not
3788 // iterate over such instructions and therefore did not "ensure" the existence
3789 // of a write, we must determine such use here.
3790 for (Use &U : Inst->uses()) {
3791 Instruction *UI = dyn_cast<Instruction>(U.getUser());
3792 if (!UI)
Michael Kruse7bf39442015-09-10 12:46:52 +00003793 continue;
3794
Michael Kruse2e02d562016-02-06 09:19:40 +00003795 BasicBlock *UseParent = getUseBlock(U);
3796 BasicBlock *UserParent = UI->getParent();
Michael Kruse7bf39442015-09-10 12:46:52 +00003797
Michael Kruse2e02d562016-02-06 09:19:40 +00003798 // An escaping value is either used by an instruction not within the scop,
3799 // or (when the scop region's exit needs to be simplified) by a PHI in the
3800 // scop's exit block. This is because region simplification before code
3801 // generation inserts new basic blocks before the PHI such that its incoming
3802 // blocks are not in the scop anymore.
3803 if (!R->contains(UseParent) ||
3804 (isa<PHINode>(UI) && UserParent == R->getExit() &&
3805 R->getExitingBlock())) {
3806 // At least one escaping use found.
3807 ensureValueWrite(Inst);
3808 break;
Michael Kruse7bf39442015-09-10 12:46:52 +00003809 }
3810 }
Michael Kruse7bf39442015-09-10 12:46:52 +00003811}
3812
Tobias Grosserdb543ed2016-02-02 16:46:49 +00003813bool ScopInfo::buildAccessMultiDimFixed(
Michael Kruse70131d32016-01-27 17:09:17 +00003814 MemAccInst Inst, Loop *L, Region *R,
Johannes Doerfert09e36972015-10-07 20:17:36 +00003815 const ScopDetection::BoxedLoopsSetTy *BoxedLoops,
3816 const InvariantLoadsSetTy &ScopRIL) {
Michael Kruse70131d32016-01-27 17:09:17 +00003817 Value *Val = Inst.getValueOperand();
Johannes Doerfertcea61932016-02-21 19:13:19 +00003818 Type *ElementType = Val->getType();
Tobias Grosserdb543ed2016-02-02 16:46:49 +00003819 Value *Address = Inst.getPointerOperand();
Tobias Grosser5fd8c092015-09-17 17:28:15 +00003820 const SCEV *AccessFunction = SE->getSCEVAtScope(Address, L);
Michael Kruse7bf39442015-09-10 12:46:52 +00003821 const SCEVUnknown *BasePointer =
3822 dyn_cast<SCEVUnknown>(SE->getPointerBase(AccessFunction));
Tobias Grosserdb543ed2016-02-02 16:46:49 +00003823 enum MemoryAccess::AccessType Type =
3824 Inst.isLoad() ? MemoryAccess::READ : MemoryAccess::MUST_WRITE;
Michael Kruse7bf39442015-09-10 12:46:52 +00003825
Tobias Grosser6f36d9a2015-09-17 20:16:21 +00003826 if (isa<GetElementPtrInst>(Address) || isa<BitCastInst>(Address)) {
Johannes Doerferta90943d2016-02-21 16:37:25 +00003827 auto *NewAddress = Address;
Tobias Grosser6f36d9a2015-09-17 20:16:21 +00003828 if (auto *BitCast = dyn_cast<BitCastInst>(Address)) {
Johannes Doerferta90943d2016-02-21 16:37:25 +00003829 auto *Src = BitCast->getOperand(0);
3830 auto *SrcTy = Src->getType();
3831 auto *DstTy = BitCast->getType();
Tobias Grosser6f36d9a2015-09-17 20:16:21 +00003832 if (SrcTy->getPrimitiveSizeInBits() == DstTy->getPrimitiveSizeInBits())
3833 NewAddress = Src;
3834 }
Tobias Grosser5fd8c092015-09-17 17:28:15 +00003835
Tobias Grosser6f36d9a2015-09-17 20:16:21 +00003836 if (auto *GEP = dyn_cast<GetElementPtrInst>(NewAddress)) {
3837 std::vector<const SCEV *> Subscripts;
3838 std::vector<int> Sizes;
3839 std::tie(Subscripts, Sizes) = getIndexExpressionsFromGEP(GEP, *SE);
Johannes Doerferta90943d2016-02-21 16:37:25 +00003840 auto *BasePtr = GEP->getOperand(0);
Tobias Grosser5fd8c092015-09-17 17:28:15 +00003841
Tobias Grosser6f36d9a2015-09-17 20:16:21 +00003842 std::vector<const SCEV *> SizesSCEV;
Tobias Grosser5fd8c092015-09-17 17:28:15 +00003843
Johannes Doerferta90943d2016-02-21 16:37:25 +00003844 for (auto *Subscript : Subscripts) {
Johannes Doerfert09e36972015-10-07 20:17:36 +00003845 InvariantLoadsSetTy AccessILS;
Tobias Grosserdb543ed2016-02-02 16:46:49 +00003846 if (!isAffineExpr(R, Subscript, *SE, nullptr, &AccessILS))
3847 return false;
Johannes Doerfert09e36972015-10-07 20:17:36 +00003848
3849 for (LoadInst *LInst : AccessILS)
3850 if (!ScopRIL.count(LInst))
Tobias Grosserdb543ed2016-02-02 16:46:49 +00003851 return false;
Johannes Doerfert09e36972015-10-07 20:17:36 +00003852 }
Tobias Grosser6f36d9a2015-09-17 20:16:21 +00003853
Tobias Grosserdb543ed2016-02-02 16:46:49 +00003854 if (Sizes.size() > 0) {
Tobias Grosser6f36d9a2015-09-17 20:16:21 +00003855 for (auto V : Sizes)
3856 SizesSCEV.push_back(SE->getSCEV(ConstantInt::get(
3857 IntegerType::getInt64Ty(BasePtr->getContext()), V)));
Tobias Grosser5fd8c092015-09-17 17:28:15 +00003858
Johannes Doerfertcea61932016-02-21 19:13:19 +00003859 addArrayAccess(Inst, Type, BasePointer->getValue(), ElementType, true,
Tobias Grossera535dff2015-12-13 19:59:01 +00003860 Subscripts, SizesSCEV, Val);
Tobias Grosserdb543ed2016-02-02 16:46:49 +00003861 return true;
Tobias Grosser6f36d9a2015-09-17 20:16:21 +00003862 }
Tobias Grosser5fd8c092015-09-17 17:28:15 +00003863 }
3864 }
Tobias Grosserdb543ed2016-02-02 16:46:49 +00003865 return false;
3866}
3867
3868bool ScopInfo::buildAccessMultiDimParam(
3869 MemAccInst Inst, Loop *L, Region *R,
3870 const ScopDetection::BoxedLoopsSetTy *BoxedLoops,
Hongbin Zheng22623202016-02-15 00:20:58 +00003871 const InvariantLoadsSetTy &ScopRIL, const MapInsnToMemAcc &InsnToMemAcc) {
Tobias Grosserdb543ed2016-02-02 16:46:49 +00003872 Value *Address = Inst.getPointerOperand();
3873 Value *Val = Inst.getValueOperand();
Johannes Doerfertcea61932016-02-21 19:13:19 +00003874 Type *ElementType = Val->getType();
3875 unsigned ElementSize = DL->getTypeAllocSize(ElementType);
Tobias Grosserdb543ed2016-02-02 16:46:49 +00003876 enum MemoryAccess::AccessType Type =
3877 Inst.isLoad() ? MemoryAccess::READ : MemoryAccess::MUST_WRITE;
3878
3879 const SCEV *AccessFunction = SE->getSCEVAtScope(Address, L);
3880 const SCEVUnknown *BasePointer =
3881 dyn_cast<SCEVUnknown>(SE->getPointerBase(AccessFunction));
3882
3883 assert(BasePointer && "Could not find base pointer");
3884 AccessFunction = SE->getMinusSCEV(AccessFunction, BasePointer);
Tobias Grosser5fd8c092015-09-17 17:28:15 +00003885
Michael Kruse7bf39442015-09-10 12:46:52 +00003886 auto AccItr = InsnToMemAcc.find(Inst);
Michael Krusee2bccbb2015-09-18 19:59:43 +00003887 if (PollyDelinearize && AccItr != InsnToMemAcc.end()) {
Tobias Grosser5d51afe2016-02-02 16:46:45 +00003888 std::vector<const SCEV *> Sizes(
3889 AccItr->second.Shape->DelinearizedSizes.begin(),
3890 AccItr->second.Shape->DelinearizedSizes.end());
Tobias Grosser5d51afe2016-02-02 16:46:45 +00003891 // Remove the element size. This information is already provided by the
Tobias Grosserd840fc72016-02-04 13:18:42 +00003892 // ElementSize parameter. In case the element size of this access and the
3893 // element size used for delinearization differs the delinearization is
3894 // incorrect. Hence, we invalidate the scop.
3895 //
3896 // TODO: Handle delinearization with differing element sizes.
3897 auto DelinearizedSize =
3898 cast<SCEVConstant>(Sizes.back())->getAPInt().getSExtValue();
Tobias Grosser5d51afe2016-02-02 16:46:45 +00003899 Sizes.pop_back();
Tobias Grosserd840fc72016-02-04 13:18:42 +00003900 if (ElementSize != DelinearizedSize)
3901 scop->invalidate(DELINEARIZATION, Inst.getDebugLoc());
Tobias Grosser5d51afe2016-02-02 16:46:45 +00003902
Johannes Doerfertcea61932016-02-21 19:13:19 +00003903 addArrayAccess(Inst, Type, BasePointer->getValue(), ElementType, true,
Tobias Grosser5d51afe2016-02-02 16:46:45 +00003904 AccItr->second.DelinearizedSubscripts, Sizes, Val);
Tobias Grosserdb543ed2016-02-02 16:46:49 +00003905 return true;
Michael Krusee2bccbb2015-09-18 19:59:43 +00003906 }
Tobias Grosserdb543ed2016-02-02 16:46:49 +00003907 return false;
3908}
3909
Johannes Doerfertcea61932016-02-21 19:13:19 +00003910bool ScopInfo::buildAccessMemIntrinsic(
3911 MemAccInst Inst, Loop *L, Region *R,
3912 const ScopDetection::BoxedLoopsSetTy *BoxedLoops,
3913 const InvariantLoadsSetTy &ScopRIL) {
3914 if (!Inst.isMemIntrinsic())
3915 return false;
3916
3917 auto *LengthVal = SE->getSCEVAtScope(Inst.asMemIntrinsic()->getLength(), L);
3918 assert(LengthVal);
3919
3920 auto *DestPtrVal = Inst.asMemIntrinsic()->getDest();
3921 assert(DestPtrVal);
3922 auto *DestAccFunc = SE->getSCEVAtScope(DestPtrVal, L);
3923 assert(DestAccFunc);
3924 auto *DestPtrSCEV = dyn_cast<SCEVUnknown>(SE->getPointerBase(DestAccFunc));
3925 assert(DestPtrSCEV);
3926 DestAccFunc = SE->getMinusSCEV(DestAccFunc, DestPtrSCEV);
3927 addArrayAccess(Inst, MemoryAccess::MUST_WRITE, DestPtrSCEV->getValue(),
3928 IntegerType::getInt8Ty(DestPtrVal->getContext()), false,
3929 {DestAccFunc, LengthVal}, {}, Inst.getValueOperand());
3930
3931 if (!Inst.isMemTransferInst())
3932 return true;
3933
3934 auto *SrcPtrVal = Inst.asMemTransferInst()->getSource();
3935 assert(SrcPtrVal);
3936 auto *SrcAccFunc = SE->getSCEVAtScope(SrcPtrVal, L);
3937 assert(SrcAccFunc);
3938 auto *SrcPtrSCEV = dyn_cast<SCEVUnknown>(SE->getPointerBase(SrcAccFunc));
3939 assert(SrcPtrSCEV);
3940 SrcAccFunc = SE->getMinusSCEV(SrcAccFunc, SrcPtrSCEV);
3941 addArrayAccess(Inst, MemoryAccess::READ, SrcPtrSCEV->getValue(),
3942 IntegerType::getInt8Ty(SrcPtrVal->getContext()), false,
3943 {SrcAccFunc, LengthVal}, {}, Inst.getValueOperand());
3944
3945 return true;
3946}
3947
Tobias Grosserdb543ed2016-02-02 16:46:49 +00003948void ScopInfo::buildAccessSingleDim(
3949 MemAccInst Inst, Loop *L, Region *R,
3950 const ScopDetection::BoxedLoopsSetTy *BoxedLoops,
3951 const InvariantLoadsSetTy &ScopRIL) {
3952 Value *Address = Inst.getPointerOperand();
3953 Value *Val = Inst.getValueOperand();
Johannes Doerfertcea61932016-02-21 19:13:19 +00003954 Type *ElementType = Val->getType();
Tobias Grosserdb543ed2016-02-02 16:46:49 +00003955 enum MemoryAccess::AccessType Type =
3956 Inst.isLoad() ? MemoryAccess::READ : MemoryAccess::MUST_WRITE;
3957
3958 const SCEV *AccessFunction = SE->getSCEVAtScope(Address, L);
3959 const SCEVUnknown *BasePointer =
3960 dyn_cast<SCEVUnknown>(SE->getPointerBase(AccessFunction));
3961
3962 assert(BasePointer && "Could not find base pointer");
3963 AccessFunction = SE->getMinusSCEV(AccessFunction, BasePointer);
Michael Kruse7bf39442015-09-10 12:46:52 +00003964
3965 // Check if the access depends on a loop contained in a non-affine subregion.
3966 bool isVariantInNonAffineLoop = false;
3967 if (BoxedLoops) {
3968 SetVector<const Loop *> Loops;
3969 findLoops(AccessFunction, Loops);
3970 for (const Loop *L : Loops)
3971 if (BoxedLoops->count(L))
3972 isVariantInNonAffineLoop = true;
3973 }
3974
Johannes Doerfert09e36972015-10-07 20:17:36 +00003975 InvariantLoadsSetTy AccessILS;
3976 bool IsAffine =
3977 !isVariantInNonAffineLoop &&
3978 isAffineExpr(R, AccessFunction, *SE, BasePointer->getValue(), &AccessILS);
3979
3980 for (LoadInst *LInst : AccessILS)
3981 if (!ScopRIL.count(LInst))
3982 IsAffine = false;
Michael Kruse7bf39442015-09-10 12:46:52 +00003983
Michael Krusee2bccbb2015-09-18 19:59:43 +00003984 if (!IsAffine && Type == MemoryAccess::MUST_WRITE)
3985 Type = MemoryAccess::MAY_WRITE;
Michael Kruse7bf39442015-09-10 12:46:52 +00003986
Johannes Doerfertcea61932016-02-21 19:13:19 +00003987 addArrayAccess(Inst, Type, BasePointer->getValue(), ElementType, IsAffine,
Tobias Grosser5d51afe2016-02-02 16:46:45 +00003988 {AccessFunction}, {}, Val);
Michael Kruse7bf39442015-09-10 12:46:52 +00003989}
3990
Tobias Grosserdb543ed2016-02-02 16:46:49 +00003991void ScopInfo::buildMemoryAccess(
3992 MemAccInst Inst, Loop *L, Region *R,
3993 const ScopDetection::BoxedLoopsSetTy *BoxedLoops,
Hongbin Zheng22623202016-02-15 00:20:58 +00003994 const InvariantLoadsSetTy &ScopRIL, const MapInsnToMemAcc &InsnToMemAcc) {
Tobias Grosserdb543ed2016-02-02 16:46:49 +00003995
Johannes Doerfertcea61932016-02-21 19:13:19 +00003996 if (buildAccessMemIntrinsic(Inst, L, R, BoxedLoops, ScopRIL))
3997 return;
3998
Tobias Grosserdb543ed2016-02-02 16:46:49 +00003999 if (buildAccessMultiDimFixed(Inst, L, R, BoxedLoops, ScopRIL))
4000 return;
4001
Hongbin Zheng22623202016-02-15 00:20:58 +00004002 if (buildAccessMultiDimParam(Inst, L, R, BoxedLoops, ScopRIL, InsnToMemAcc))
Tobias Grosserdb543ed2016-02-02 16:46:49 +00004003 return;
4004
4005 buildAccessSingleDim(Inst, L, R, BoxedLoops, ScopRIL);
4006}
4007
Hongbin Zheng22623202016-02-15 00:20:58 +00004008void ScopInfo::buildAccessFunctions(Region &R, Region &SR,
4009 const MapInsnToMemAcc &InsnToMemAcc) {
Michael Kruse7bf39442015-09-10 12:46:52 +00004010
4011 if (SD->isNonAffineSubRegion(&SR, &R)) {
4012 for (BasicBlock *BB : SR.blocks())
Hongbin Zheng22623202016-02-15 00:20:58 +00004013 buildAccessFunctions(R, *BB, InsnToMemAcc, &SR);
Michael Kruse7bf39442015-09-10 12:46:52 +00004014 return;
4015 }
4016
4017 for (auto I = SR.element_begin(), E = SR.element_end(); I != E; ++I)
4018 if (I->isSubRegion())
Hongbin Zheng22623202016-02-15 00:20:58 +00004019 buildAccessFunctions(R, *I->getNodeAs<Region>(), InsnToMemAcc);
Michael Kruse7bf39442015-09-10 12:46:52 +00004020 else
Hongbin Zheng22623202016-02-15 00:20:58 +00004021 buildAccessFunctions(R, *I->getNodeAs<BasicBlock>(), InsnToMemAcc);
Michael Kruse7bf39442015-09-10 12:46:52 +00004022}
4023
Johannes Doerferta8781032016-02-02 14:14:40 +00004024void ScopInfo::buildStmts(Region &R, Region &SR) {
Michael Krusecac948e2015-10-02 13:53:07 +00004025
Johannes Doerferta8781032016-02-02 14:14:40 +00004026 if (SD->isNonAffineSubRegion(&SR, &R)) {
Michael Krusecac948e2015-10-02 13:53:07 +00004027 scop->addScopStmt(nullptr, &SR);
4028 return;
4029 }
4030
4031 for (auto I = SR.element_begin(), E = SR.element_end(); I != E; ++I)
4032 if (I->isSubRegion())
Johannes Doerferta8781032016-02-02 14:14:40 +00004033 buildStmts(R, *I->getNodeAs<Region>());
Michael Krusecac948e2015-10-02 13:53:07 +00004034 else
4035 scop->addScopStmt(I->getNodeAs<BasicBlock>(), nullptr);
4036}
4037
Michael Krused868b5d2015-09-10 15:25:24 +00004038void ScopInfo::buildAccessFunctions(Region &R, BasicBlock &BB,
Hongbin Zheng22623202016-02-15 00:20:58 +00004039 const MapInsnToMemAcc &InsnToMemAcc,
Michael Krused868b5d2015-09-10 15:25:24 +00004040 Region *NonAffineSubRegion,
4041 bool IsExitBlock) {
Tobias Grosser910cf262015-11-11 20:15:49 +00004042 // We do not build access functions for error blocks, as they may contain
4043 // instructions we can not model.
Johannes Doerfertc36d39b2016-02-02 14:14:20 +00004044 if (isErrorBlock(BB, R, *LI, *DT) && !IsExitBlock)
Tobias Grosser910cf262015-11-11 20:15:49 +00004045 return;
4046
Michael Kruse7bf39442015-09-10 12:46:52 +00004047 Loop *L = LI->getLoopFor(&BB);
4048
4049 // The set of loops contained in non-affine subregions that are part of R.
4050 const ScopDetection::BoxedLoopsSetTy *BoxedLoops = SD->getBoxedLoops(&R);
4051
Johannes Doerfert09e36972015-10-07 20:17:36 +00004052 // The set of loads that are required to be invariant.
4053 auto &ScopRIL = *SD->getRequiredInvariantLoads(&R);
4054
Michael Kruse2e02d562016-02-06 09:19:40 +00004055 for (Instruction &Inst : BB) {
4056 PHINode *PHI = dyn_cast<PHINode>(&Inst);
Michael Kruse7bf39442015-09-10 12:46:52 +00004057 if (PHI)
Michael Krusee2bccbb2015-09-18 19:59:43 +00004058 buildPHIAccesses(PHI, R, NonAffineSubRegion, IsExitBlock);
Michael Kruse7bf39442015-09-10 12:46:52 +00004059
4060 // For the exit block we stop modeling after the last PHI node.
4061 if (!PHI && IsExitBlock)
4062 break;
4063
Johannes Doerfert09e36972015-10-07 20:17:36 +00004064 // TODO: At this point we only know that elements of ScopRIL have to be
4065 // invariant and will be hoisted for the SCoP to be processed. Though,
4066 // there might be other invariant accesses that will be hoisted and
4067 // that would allow to make a non-affine access affine.
Michael Kruse70131d32016-01-27 17:09:17 +00004068 if (auto MemInst = MemAccInst::dyn_cast(Inst))
Hongbin Zheng22623202016-02-15 00:20:58 +00004069 buildMemoryAccess(MemInst, L, &R, BoxedLoops, ScopRIL, InsnToMemAcc);
Michael Kruse7bf39442015-09-10 12:46:52 +00004070
Michael Kruse2e02d562016-02-06 09:19:40 +00004071 if (isIgnoredIntrinsic(&Inst))
Michael Kruse7bf39442015-09-10 12:46:52 +00004072 continue;
4073
Michael Kruse2e02d562016-02-06 09:19:40 +00004074 if (!PHI)
4075 buildScalarDependences(&Inst);
4076 if (!IsExitBlock)
4077 buildEscapingDependences(&Inst);
Michael Kruse7bf39442015-09-10 12:46:52 +00004078 }
Michael Krusee2bccbb2015-09-18 19:59:43 +00004079}
Michael Kruse7bf39442015-09-10 12:46:52 +00004080
Michael Kruseee6a4fc2016-01-26 13:33:27 +00004081MemoryAccess *ScopInfo::addMemoryAccess(BasicBlock *BB, Instruction *Inst,
Johannes Doerfertcea61932016-02-21 19:13:19 +00004082 MemoryAccess::AccessType AccType,
4083 Value *BaseAddress, Type *ElementType,
Michael Kruseee6a4fc2016-01-26 13:33:27 +00004084 bool Affine, Value *AccessValue,
4085 ArrayRef<const SCEV *> Subscripts,
4086 ArrayRef<const SCEV *> Sizes,
4087 ScopArrayInfo::MemoryKind Kind) {
Michael Kruse6f7721f2016-02-24 22:08:19 +00004088 ScopStmt *Stmt = scop->getStmtFor(BB);
Michael Krusecac948e2015-10-02 13:53:07 +00004089
4090 // Do not create a memory access for anything not in the SCoP. It would be
4091 // ignored anyway.
4092 if (!Stmt)
Michael Kruseee6a4fc2016-01-26 13:33:27 +00004093 return nullptr;
Michael Krusecac948e2015-10-02 13:53:07 +00004094
Hongbin Zheng660f3cc2016-02-13 15:12:58 +00004095 AccFuncSetType &AccList = scop->getOrCreateAccessFunctions(BB);
Michael Krusee2bccbb2015-09-18 19:59:43 +00004096 Value *BaseAddr = BaseAddress;
4097 std::string BaseName = getIslCompatibleName("MemRef_", BaseAddr, "");
4098
Tobias Grosserf4f68702015-12-14 15:05:37 +00004099 bool isKnownMustAccess = false;
4100
4101 // Accesses in single-basic block statements are always excuted.
4102 if (Stmt->isBlockStmt())
4103 isKnownMustAccess = true;
4104
4105 if (Stmt->isRegionStmt()) {
4106 // Accesses that dominate the exit block of a non-affine region are always
4107 // executed. In non-affine regions there may exist MK_Values that do not
4108 // dominate the exit. MK_Values will always dominate the exit and MK_PHIs
4109 // only if there is at most one PHI_WRITE in the non-affine region.
4110 if (DT->dominates(BB, Stmt->getRegion()->getExit()))
4111 isKnownMustAccess = true;
4112 }
4113
Michael Kruseee6a4fc2016-01-26 13:33:27 +00004114 // Non-affine PHI writes do not "happen" at a particular instruction, but
4115 // after exiting the statement. Therefore they are guaranteed execute and
4116 // overwrite the old value.
4117 if (Kind == ScopArrayInfo::MK_PHI || Kind == ScopArrayInfo::MK_ExitPHI)
4118 isKnownMustAccess = true;
4119
Johannes Doerfertcea61932016-02-21 19:13:19 +00004120 if (!isKnownMustAccess && AccType == MemoryAccess::MUST_WRITE)
4121 AccType = MemoryAccess::MAY_WRITE;
Michael Krusecac948e2015-10-02 13:53:07 +00004122
Johannes Doerfertcea61932016-02-21 19:13:19 +00004123 AccList.emplace_back(Stmt, Inst, AccType, BaseAddress, ElementType, Affine,
Tobias Grossera535dff2015-12-13 19:59:01 +00004124 Subscripts, Sizes, AccessValue, Kind, BaseName);
Michael Krusecac948e2015-10-02 13:53:07 +00004125 Stmt->addAccess(&AccList.back());
Michael Kruseee6a4fc2016-01-26 13:33:27 +00004126 return &AccList.back();
Michael Kruse7bf39442015-09-10 12:46:52 +00004127}
4128
Michael Kruse70131d32016-01-27 17:09:17 +00004129void ScopInfo::addArrayAccess(MemAccInst MemAccInst,
Johannes Doerfertcea61932016-02-21 19:13:19 +00004130 MemoryAccess::AccessType AccType,
4131 Value *BaseAddress, Type *ElementType,
4132 bool IsAffine, ArrayRef<const SCEV *> Subscripts,
Tobias Grossera535dff2015-12-13 19:59:01 +00004133 ArrayRef<const SCEV *> Sizes,
4134 Value *AccessValue) {
Johannes Doerfertcea61932016-02-21 19:13:19 +00004135 addMemoryAccess(MemAccInst.getParent(), MemAccInst, AccType, BaseAddress,
4136 ElementType, IsAffine, AccessValue, Subscripts, Sizes,
Tobias Grossera535dff2015-12-13 19:59:01 +00004137 ScopArrayInfo::MK_Array);
Michael Kruse33d6c0b2015-09-25 18:53:27 +00004138}
Johannes Doerfertb92e2182016-02-21 16:37:58 +00004139
Johannes Doerfert68898ce2016-02-21 16:36:21 +00004140void ScopInfo::ensureValueWrite(Instruction *Inst) {
Michael Kruse6f7721f2016-02-24 22:08:19 +00004141 ScopStmt *Stmt = scop->getStmtFor(Inst);
Michael Kruse436db622016-01-26 13:33:10 +00004142
Johannes Doerfert68898ce2016-02-21 16:36:21 +00004143 // Inst not defined within this SCoP.
Michael Kruse436db622016-01-26 13:33:10 +00004144 if (!Stmt)
4145 return;
4146
Johannes Doerfert68898ce2016-02-21 16:36:21 +00004147 // Do not process further if the instruction is already written.
4148 if (Stmt->lookupValueWriteOf(Inst))
Michael Kruse436db622016-01-26 13:33:10 +00004149 return;
4150
Johannes Doerfertcea61932016-02-21 19:13:19 +00004151 addMemoryAccess(Inst->getParent(), Inst, MemoryAccess::MUST_WRITE, Inst,
4152 Inst->getType(), true, Inst, ArrayRef<const SCEV *>(),
Tobias Grossera535dff2015-12-13 19:59:01 +00004153 ArrayRef<const SCEV *>(), ScopArrayInfo::MK_Value);
Michael Kruse33d6c0b2015-09-25 18:53:27 +00004154}
Johannes Doerfertb92e2182016-02-21 16:37:58 +00004155
Johannes Doerfert68898ce2016-02-21 16:36:21 +00004156void ScopInfo::ensureValueRead(Value *V, BasicBlock *UserBB) {
Michael Krusefd463082016-01-27 22:51:56 +00004157
Michael Kruse2e02d562016-02-06 09:19:40 +00004158 // There cannot be an "access" for literal constants. BasicBlock references
4159 // (jump destinations) also never change.
Johannes Doerfert68898ce2016-02-21 16:36:21 +00004160 if ((isa<Constant>(V) && !isa<GlobalVariable>(V)) || isa<BasicBlock>(V))
Michael Kruse2e02d562016-02-06 09:19:40 +00004161 return;
4162
Michael Krusefd463082016-01-27 22:51:56 +00004163 // If the instruction can be synthesized and the user is in the region we do
4164 // not need to add a value dependences.
4165 Region &ScopRegion = scop->getRegion();
Johannes Doerfert68898ce2016-02-21 16:36:21 +00004166 if (canSynthesize(V, LI, SE, &ScopRegion))
Michael Krusefd463082016-01-27 22:51:56 +00004167 return;
4168
Michael Kruse2e02d562016-02-06 09:19:40 +00004169 // Do not build scalar dependences for required invariant loads as we will
4170 // hoist them later on anyway or drop the SCoP if we cannot.
Johannes Doerferta90943d2016-02-21 16:37:25 +00004171 auto *ScopRIL = SD->getRequiredInvariantLoads(&ScopRegion);
Johannes Doerfert68898ce2016-02-21 16:36:21 +00004172 if (ScopRIL->count(dyn_cast<LoadInst>(V)))
Michael Kruse2e02d562016-02-06 09:19:40 +00004173 return;
4174
4175 // Determine the ScopStmt containing the value's definition and use. There is
4176 // no defining ScopStmt if the value is a function argument, a global value,
4177 // or defined outside the SCoP.
Johannes Doerfert68898ce2016-02-21 16:36:21 +00004178 Instruction *ValueInst = dyn_cast<Instruction>(V);
Michael Kruse6f7721f2016-02-24 22:08:19 +00004179 ScopStmt *ValueStmt = ValueInst ? scop->getStmtFor(ValueInst) : nullptr;
Michael Kruse2e02d562016-02-06 09:19:40 +00004180
Michael Kruse6f7721f2016-02-24 22:08:19 +00004181 ScopStmt *UserStmt = scop->getStmtFor(UserBB);
Michael Krusead28e5a2016-01-26 13:33:15 +00004182
4183 // We do not model uses outside the scop.
4184 if (!UserStmt)
4185 return;
4186
Michael Kruse2e02d562016-02-06 09:19:40 +00004187 // Add MemoryAccess for invariant values only if requested.
4188 if (!ModelReadOnlyScalars && !ValueStmt)
4189 return;
4190
4191 // Ignore use-def chains within the same ScopStmt.
4192 if (ValueStmt == UserStmt)
4193 return;
4194
Michael Krusead28e5a2016-01-26 13:33:15 +00004195 // Do not create another MemoryAccess for reloading the value if one already
4196 // exists.
Johannes Doerfert68898ce2016-02-21 16:36:21 +00004197 if (UserStmt->lookupValueReadOf(V))
Michael Krusead28e5a2016-01-26 13:33:15 +00004198 return;
4199
Johannes Doerfertcea61932016-02-21 19:13:19 +00004200 addMemoryAccess(UserBB, nullptr, MemoryAccess::READ, V, V->getType(), true, V,
Michael Kruse8d0b7342015-09-25 21:21:00 +00004201 ArrayRef<const SCEV *>(), ArrayRef<const SCEV *>(),
Tobias Grossera535dff2015-12-13 19:59:01 +00004202 ScopArrayInfo::MK_Value);
Michael Kruse2e02d562016-02-06 09:19:40 +00004203 if (ValueInst)
4204 ensureValueWrite(ValueInst);
Michael Kruse33d6c0b2015-09-25 18:53:27 +00004205}
Johannes Doerfertb92e2182016-02-21 16:37:58 +00004206
Michael Kruseee6a4fc2016-01-26 13:33:27 +00004207void ScopInfo::ensurePHIWrite(PHINode *PHI, BasicBlock *IncomingBlock,
4208 Value *IncomingValue, bool IsExitBlock) {
Michael Kruse6f7721f2016-02-24 22:08:19 +00004209 ScopStmt *IncomingStmt = scop->getStmtFor(IncomingBlock);
Michael Kruse2e02d562016-02-06 09:19:40 +00004210 if (!IncomingStmt)
4211 return;
4212
4213 // Take care for the incoming value being available in the incoming block.
4214 // This must be done before the check for multiple PHI writes because multiple
4215 // exiting edges from subregion each can be the effective written value of the
4216 // subregion. As such, all of them must be made available in the subregion
4217 // statement.
4218 ensureValueRead(IncomingValue, IncomingBlock);
Michael Kruseee6a4fc2016-01-26 13:33:27 +00004219
4220 // Do not add more than one MemoryAccess per PHINode and ScopStmt.
4221 if (MemoryAccess *Acc = IncomingStmt->lookupPHIWriteOf(PHI)) {
4222 assert(Acc->getAccessInstruction() == PHI);
4223 Acc->addIncoming(IncomingBlock, IncomingValue);
4224 return;
4225 }
4226
4227 MemoryAccess *Acc = addMemoryAccess(
4228 IncomingStmt->isBlockStmt() ? IncomingBlock
4229 : IncomingStmt->getRegion()->getEntry(),
Johannes Doerfertcea61932016-02-21 19:13:19 +00004230 PHI, MemoryAccess::MUST_WRITE, PHI, PHI->getType(), true, PHI,
Michael Kruseee6a4fc2016-01-26 13:33:27 +00004231 ArrayRef<const SCEV *>(), ArrayRef<const SCEV *>(),
4232 IsExitBlock ? ScopArrayInfo::MK_ExitPHI : ScopArrayInfo::MK_PHI);
4233 assert(Acc);
4234 Acc->addIncoming(IncomingBlock, IncomingValue);
Michael Kruse33d6c0b2015-09-25 18:53:27 +00004235}
Johannes Doerfertb92e2182016-02-21 16:37:58 +00004236
Michael Kruse33d6c0b2015-09-25 18:53:27 +00004237void ScopInfo::addPHIReadAccess(PHINode *PHI) {
Johannes Doerfertcea61932016-02-21 19:13:19 +00004238 addMemoryAccess(PHI->getParent(), PHI, MemoryAccess::READ, PHI,
4239 PHI->getType(), true, PHI, ArrayRef<const SCEV *>(),
4240 ArrayRef<const SCEV *>(), ScopArrayInfo::MK_PHI);
Michael Kruse33d6c0b2015-09-25 18:53:27 +00004241}
4242
Michael Krusedaf66942015-12-13 22:10:37 +00004243void ScopInfo::buildScop(Region &R, AssumptionCache &AC) {
Michael Kruse9d080092015-09-11 21:41:48 +00004244 unsigned MaxLoopDepth = getMaxLoopDepthInRegion(R, *LI, *SD);
Hongbin Zheng8831eb72016-02-17 15:49:21 +00004245 scop.reset(new Scop(R, *SE, MaxLoopDepth));
Michael Kruse7bf39442015-09-10 12:46:52 +00004246
Johannes Doerferta8781032016-02-02 14:14:40 +00004247 buildStmts(R, R);
Hongbin Zheng22623202016-02-15 00:20:58 +00004248 buildAccessFunctions(R, R, *SD->getInsnToMemAccMap(&R));
Michael Kruse7bf39442015-09-10 12:46:52 +00004249
4250 // In case the region does not have an exiting block we will later (during
4251 // code generation) split the exit block. This will move potential PHI nodes
4252 // from the current exit block into the new region exiting block. Hence, PHI
4253 // nodes that are at this point not part of the region will be.
4254 // To handle these PHI nodes later we will now model their operands as scalar
4255 // accesses. Note that we do not model anything in the exit block if we have
4256 // an exiting block in the region, as there will not be any splitting later.
4257 if (!R.getExitingBlock())
Hongbin Zheng22623202016-02-15 00:20:58 +00004258 buildAccessFunctions(R, *R.getExit(), *SD->getInsnToMemAccMap(&R), nullptr,
4259 /* IsExitBlock */ true);
Michael Kruse7bf39442015-09-10 12:46:52 +00004260
Hongbin Zheng192f69a2016-02-13 15:12:54 +00004261 scop->init(*AA, AC, *SD, *DT, *LI);
Michael Kruse7bf39442015-09-10 12:46:52 +00004262}
4263
Michael Krused868b5d2015-09-10 15:25:24 +00004264void ScopInfo::print(raw_ostream &OS, const Module *) const {
Michael Kruse9d080092015-09-11 21:41:48 +00004265 if (!scop) {
Michael Krused868b5d2015-09-10 15:25:24 +00004266 OS << "Invalid Scop!\n";
Michael Kruse9d080092015-09-11 21:41:48 +00004267 return;
4268 }
4269
Michael Kruse9d080092015-09-11 21:41:48 +00004270 scop->print(OS);
Michael Kruse7bf39442015-09-10 12:46:52 +00004271}
4272
Hongbin Zhengfec32802016-02-13 15:13:02 +00004273void ScopInfo::clear() { scop.reset(); }
Michael Kruse7bf39442015-09-10 12:46:52 +00004274
4275//===----------------------------------------------------------------------===//
Hongbin Zheng8831eb72016-02-17 15:49:21 +00004276ScopInfo::ScopInfo() : RegionPass(ID) {}
Tobias Grosserb76f38532011-08-20 11:11:25 +00004277
Hongbin Zheng8831eb72016-02-17 15:49:21 +00004278ScopInfo::~ScopInfo() { clear(); }
Tobias Grosserb76f38532011-08-20 11:11:25 +00004279
Tobias Grosser75805372011-04-29 06:27:02 +00004280void ScopInfo::getAnalysisUsage(AnalysisUsage &AU) const {
Chandler Carruthf5579872015-01-17 14:16:56 +00004281 AU.addRequired<LoopInfoWrapperPass>();
Matt Arsenault8ca36812014-07-19 18:40:17 +00004282 AU.addRequired<RegionInfoPass>();
Johannes Doerfert96425c22015-08-30 21:13:53 +00004283 AU.addRequired<DominatorTreeWrapperPass>();
Michael Krused868b5d2015-09-10 15:25:24 +00004284 AU.addRequiredTransitive<ScalarEvolutionWrapperPass>();
4285 AU.addRequiredTransitive<ScopDetection>();
Chandler Carruth66ef16b2015-09-09 22:13:56 +00004286 AU.addRequired<AAResultsWrapperPass>();
Johannes Doerfert2af10e22015-11-12 03:25:01 +00004287 AU.addRequired<AssumptionCacheTracker>();
Tobias Grosser75805372011-04-29 06:27:02 +00004288 AU.setPreservesAll();
4289}
4290
4291bool ScopInfo::runOnRegion(Region *R, RGPassManager &RGM) {
Michael Krused868b5d2015-09-10 15:25:24 +00004292 SD = &getAnalysis<ScopDetection>();
Tobias Grosser75805372011-04-29 06:27:02 +00004293
Michael Krused868b5d2015-09-10 15:25:24 +00004294 if (!SD->isMaxRegionInScop(*R))
4295 return false;
4296
4297 Function *F = R->getEntry()->getParent();
4298 SE = &getAnalysis<ScalarEvolutionWrapperPass>().getSE();
4299 LI = &getAnalysis<LoopInfoWrapperPass>().getLoopInfo();
4300 AA = &getAnalysis<AAResultsWrapperPass>().getAAResults();
Johannes Doerferta1f291e2016-02-02 14:15:13 +00004301 DL = &F->getParent()->getDataLayout();
Michael Krusedaf66942015-12-13 22:10:37 +00004302 DT = &getAnalysis<DominatorTreeWrapperPass>().getDomTree();
Johannes Doerfert2af10e22015-11-12 03:25:01 +00004303 auto &AC = getAnalysis<AssumptionCacheTracker>().getAssumptionCache(*F);
Michael Krused868b5d2015-09-10 15:25:24 +00004304
Johannes Doerfert48fe86f2015-11-12 02:32:32 +00004305 DebugLoc Beg, End;
4306 getDebugLocations(R, Beg, End);
4307 std::string Msg = "SCoP begins here.";
4308 emitOptimizationRemarkAnalysis(F->getContext(), DEBUG_TYPE, *F, Beg, Msg);
4309
Michael Krusedaf66942015-12-13 22:10:37 +00004310 buildScop(*R, AC);
Tobias Grosser75805372011-04-29 06:27:02 +00004311
Tobias Grosserd6a50b32015-05-30 06:26:21 +00004312 DEBUG(scop->print(dbgs()));
4313
Michael Kruseafe06702015-10-02 16:33:27 +00004314 if (scop->isEmpty() || !scop->hasFeasibleRuntimeContext()) {
Johannes Doerfert48fe86f2015-11-12 02:32:32 +00004315 Msg = "SCoP ends here but was dismissed.";
Hongbin Zhengfec32802016-02-13 15:13:02 +00004316 scop.reset();
Johannes Doerfert48fe86f2015-11-12 02:32:32 +00004317 } else {
4318 Msg = "SCoP ends here.";
4319 ++ScopFound;
4320 if (scop->getMaxLoopDepth() > 0)
4321 ++RichScopFound;
Johannes Doerfert43788c52015-08-20 05:58:56 +00004322 }
4323
Johannes Doerfert48fe86f2015-11-12 02:32:32 +00004324 emitOptimizationRemarkAnalysis(F->getContext(), DEBUG_TYPE, *F, End, Msg);
4325
Tobias Grosser75805372011-04-29 06:27:02 +00004326 return false;
4327}
4328
4329char ScopInfo::ID = 0;
4330
Tobias Grosser4d96c8d2013-03-23 01:05:07 +00004331Pass *polly::createScopInfoPass() { return new ScopInfo(); }
4332
Tobias Grosser73600b82011-10-08 00:30:40 +00004333INITIALIZE_PASS_BEGIN(ScopInfo, "polly-scops",
4334 "Polly - Create polyhedral description of Scops", false,
Tobias Grosser4d96c8d2013-03-23 01:05:07 +00004335 false);
Chandler Carruth66ef16b2015-09-09 22:13:56 +00004336INITIALIZE_PASS_DEPENDENCY(AAResultsWrapperPass);
Johannes Doerfert2af10e22015-11-12 03:25:01 +00004337INITIALIZE_PASS_DEPENDENCY(AssumptionCacheTracker);
Chandler Carruthf5579872015-01-17 14:16:56 +00004338INITIALIZE_PASS_DEPENDENCY(LoopInfoWrapperPass);
Matt Arsenault8ca36812014-07-19 18:40:17 +00004339INITIALIZE_PASS_DEPENDENCY(RegionInfoPass);
Tobias Grosserc5bcf242015-08-17 10:57:08 +00004340INITIALIZE_PASS_DEPENDENCY(ScalarEvolutionWrapperPass);
Johannes Doerfertff9d1982015-02-24 12:00:50 +00004341INITIALIZE_PASS_DEPENDENCY(ScopDetection);
Johannes Doerfert96425c22015-08-30 21:13:53 +00004342INITIALIZE_PASS_DEPENDENCY(DominatorTreeWrapperPass);
Tobias Grosser73600b82011-10-08 00:30:40 +00004343INITIALIZE_PASS_END(ScopInfo, "polly-scops",
4344 "Polly - Create polyhedral description of Scops", false,
4345 false)