blob: 7c348619888775a11879ee3addd4ecee26e3c347 [file] [log] [blame]
Tobias Grosser75805372011-04-29 06:27:02 +00001//===--------- ScopInfo.cpp - Create Scops from LLVM IR ------------------===//
2//
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 Grosser75805372011-04-29 06:27:02 +000020#include "polly/LinkAllPasses.h"
Johannes Doerfert0ee1f212014-06-17 17:31:36 +000021#include "polly/Options.h"
Tobias Grosserba0d0922015-05-09 09:13:42 +000022#include "polly/ScopInfo.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"
Sebastian Pop27c10c62013-03-22 22:07:43 +000026#include "polly/TempScopInfo.h"
Tobias Grosserf4c24b22015-04-05 13:11:54 +000027#include "llvm/ADT/MapVector.h"
Tobias Grosserba0d0922015-05-09 09:13:42 +000028#include "llvm/ADT/SetVector.h"
Tobias Grosser83628182013-05-07 08:11:54 +000029#include "llvm/ADT/Statistic.h"
Johannes Doerfertecff11d2015-05-22 23:43:58 +000030#include "llvm/ADT/STLExtras.h"
Hongbin Zheng86a37742012-04-25 08:01:38 +000031#include "llvm/ADT/StringExtras.h"
Johannes Doerfertb164c792014-09-18 11:17:17 +000032#include "llvm/Analysis/AliasAnalysis.h"
Tobias Grosserba0d0922015-05-09 09:13:42 +000033#include "llvm/Analysis/LoopInfo.h"
Tobias Grosser83628182013-05-07 08:11:54 +000034#include "llvm/Analysis/RegionIterator.h"
35#include "llvm/Analysis/ScalarEvolutionExpressions.h"
Tobias Grosser75805372011-04-29 06:27:02 +000036#include "llvm/Support/Debug.h"
Tobias Grosser33ba62ad2011-08-18 06:31:50 +000037#include "isl/aff.h"
Tobias Grosserba0d0922015-05-09 09:13:42 +000038#include "isl/constraint.h"
Tobias Grosserf5338802011-10-06 00:03:35 +000039#include "isl/local_space.h"
Tobias Grosserba0d0922015-05-09 09:13:42 +000040#include "isl/map.h"
Tobias Grosser4a8e3562011-12-07 07:42:51 +000041#include "isl/options.h"
Tobias Grosserba0d0922015-05-09 09:13:42 +000042#include "isl/printer.h"
43#include "isl/set.h"
44#include "isl/union_map.h"
Tobias Grossercd524dc2015-05-09 09:36:38 +000045#include "isl/union_set.h"
Tobias Grosseredab1352013-06-21 06:41:31 +000046#include "isl/val.h"
Tobias Grosser75805372011-04-29 06:27:02 +000047#include <sstream>
48#include <string>
49#include <vector>
50
51using namespace llvm;
52using namespace polly;
53
Chandler Carruth95fef942014-04-22 03:30:19 +000054#define DEBUG_TYPE "polly-scops"
55
Tobias Grosser74394f02013-01-14 22:40:23 +000056STATISTIC(ScopFound, "Number of valid Scops");
57STATISTIC(RichScopFound, "Number of Scops containing a loop");
Tobias Grosser75805372011-04-29 06:27:02 +000058
Johannes Doerfert9e7b17b2014-08-18 00:40:13 +000059// Multiplicative reductions can be disabled separately as these kind of
Johannes Doerfert0ee1f212014-06-17 17:31:36 +000060// operations can overflow easily. Additive reductions and bit operations
61// are in contrast pretty stable.
Tobias Grosser483a90d2014-07-09 10:50:10 +000062static cl::opt<bool> DisableMultiplicativeReductions(
63 "polly-disable-multiplicative-reductions",
64 cl::desc("Disable multiplicative reductions"), cl::Hidden, cl::ZeroOrMore,
65 cl::init(false), cl::cat(PollyCategory));
Johannes Doerfert0ee1f212014-06-17 17:31:36 +000066
Johannes Doerfert9143d672014-09-27 11:02:39 +000067static cl::opt<unsigned> RunTimeChecksMaxParameters(
68 "polly-rtc-max-parameters",
69 cl::desc("The maximal number of parameters allowed in RTCs."), cl::Hidden,
70 cl::ZeroOrMore, cl::init(8), cl::cat(PollyCategory));
71
Tobias Grosser71500722015-03-28 15:11:14 +000072static cl::opt<unsigned> RunTimeChecksMaxArraysPerGroup(
73 "polly-rtc-max-arrays-per-group",
74 cl::desc("The maximal number of arrays to compare in each alias group."),
75 cl::Hidden, cl::ZeroOrMore, cl::init(20), cl::cat(PollyCategory));
76
Tobias Grosser0695ee42013-09-17 03:30:31 +000077/// Translate a 'const SCEV *' expression in an isl_pw_aff.
Tobias Grosserabfbe632013-02-05 12:09:06 +000078struct SCEVAffinator : public SCEVVisitor<SCEVAffinator, isl_pw_aff *> {
Tobias Grosser0695ee42013-09-17 03:30:31 +000079public:
Tobias Grosser0695ee42013-09-17 03:30:31 +000080 /// @brief Translate a 'const SCEV *' to an isl_pw_aff.
81 ///
82 /// @param Stmt The location at which the scalar evolution expression
83 /// is evaluated.
84 /// @param Expr The expression that is translated.
85 static __isl_give isl_pw_aff *getPwAff(ScopStmt *Stmt, const SCEV *Expr);
86
Tobias Grosser33ba62ad2011-08-18 06:31:50 +000087private:
Tobias Grosser3cc99742012-06-06 16:33:15 +000088 isl_ctx *Ctx;
Tobias Grosserf5338802011-10-06 00:03:35 +000089 int NbLoopSpaces;
Tobias Grosser3cc99742012-06-06 16:33:15 +000090 const Scop *S;
Tobias Grosser33ba62ad2011-08-18 06:31:50 +000091
Tobias Grosser0695ee42013-09-17 03:30:31 +000092 SCEVAffinator(const ScopStmt *Stmt);
93 int getLoopDepth(const Loop *L);
Tobias Grosser60b54f12011-11-08 15:41:28 +000094
Tobias Grosser0695ee42013-09-17 03:30:31 +000095 __isl_give isl_pw_aff *visit(const SCEV *Expr);
96 __isl_give isl_pw_aff *visitConstant(const SCEVConstant *Expr);
97 __isl_give isl_pw_aff *visitTruncateExpr(const SCEVTruncateExpr *Expr);
98 __isl_give isl_pw_aff *visitZeroExtendExpr(const SCEVZeroExtendExpr *Expr);
99 __isl_give isl_pw_aff *visitSignExtendExpr(const SCEVSignExtendExpr *Expr);
100 __isl_give isl_pw_aff *visitAddExpr(const SCEVAddExpr *Expr);
101 __isl_give isl_pw_aff *visitMulExpr(const SCEVMulExpr *Expr);
102 __isl_give isl_pw_aff *visitUDivExpr(const SCEVUDivExpr *Expr);
103 __isl_give isl_pw_aff *visitAddRecExpr(const SCEVAddRecExpr *Expr);
104 __isl_give isl_pw_aff *visitSMaxExpr(const SCEVSMaxExpr *Expr);
105 __isl_give isl_pw_aff *visitUMaxExpr(const SCEVUMaxExpr *Expr);
106 __isl_give isl_pw_aff *visitUnknown(const SCEVUnknown *Expr);
Johannes Doerfertb9d18882015-02-11 14:54:50 +0000107 __isl_give isl_pw_aff *visitSDivInstruction(Instruction *SDiv);
Tobias Grosser60b54f12011-11-08 15:41:28 +0000108
Tobias Grosser0695ee42013-09-17 03:30:31 +0000109 friend struct SCEVVisitor<SCEVAffinator, isl_pw_aff *>;
110};
Tobias Grosser33ba62ad2011-08-18 06:31:50 +0000111
Tobias Grosser0695ee42013-09-17 03:30:31 +0000112SCEVAffinator::SCEVAffinator(const ScopStmt *Stmt)
113 : Ctx(Stmt->getIslCtx()), NbLoopSpaces(Stmt->getNumIterators()),
114 S(Stmt->getParent()) {}
Tobias Grosser33ba62ad2011-08-18 06:31:50 +0000115
Tobias Grosser0695ee42013-09-17 03:30:31 +0000116__isl_give isl_pw_aff *SCEVAffinator::getPwAff(ScopStmt *Stmt,
117 const SCEV *Scev) {
118 Scop *S = Stmt->getParent();
119 const Region *Reg = &S->getRegion();
Tobias Grosser33ba62ad2011-08-18 06:31:50 +0000120
Tobias Grosser0695ee42013-09-17 03:30:31 +0000121 S->addParams(getParamsInAffineExpr(Reg, Scev, *S->getSE()));
Tobias Grosser33ba62ad2011-08-18 06:31:50 +0000122
Tobias Grosser0695ee42013-09-17 03:30:31 +0000123 SCEVAffinator Affinator(Stmt);
124 return Affinator.visit(Scev);
125}
Tobias Grosser33ba62ad2011-08-18 06:31:50 +0000126
Tobias Grosser0695ee42013-09-17 03:30:31 +0000127__isl_give isl_pw_aff *SCEVAffinator::visit(const SCEV *Expr) {
128 // In case the scev is a valid parameter, we do not further analyze this
129 // expression, but create a new parameter in the isl_pw_aff. This allows us
130 // to treat subexpressions that we cannot translate into an piecewise affine
131 // expression, as constant parameters of the piecewise affine expression.
132 if (isl_id *Id = S->getIdForParam(Expr)) {
133 isl_space *Space = isl_space_set_alloc(Ctx, 1, NbLoopSpaces);
134 Space = isl_space_set_dim_id(Space, isl_dim_param, 0, Id);
Tobias Grosser33ba62ad2011-08-18 06:31:50 +0000135
Tobias Grosser0695ee42013-09-17 03:30:31 +0000136 isl_set *Domain = isl_set_universe(isl_space_copy(Space));
137 isl_aff *Affine = isl_aff_zero_on_domain(isl_local_space_from_space(Space));
138 Affine = isl_aff_add_coefficient_si(Affine, isl_dim_param, 0, 1);
Tobias Grosser33ba62ad2011-08-18 06:31:50 +0000139
140 return isl_pw_aff_alloc(Domain, Affine);
141 }
142
Tobias Grosser0695ee42013-09-17 03:30:31 +0000143 return SCEVVisitor<SCEVAffinator, isl_pw_aff *>::visit(Expr);
144}
145
Tobias Grosser0d170132013-10-03 13:09:19 +0000146__isl_give isl_pw_aff *SCEVAffinator::visitConstant(const SCEVConstant *Expr) {
Tobias Grosser0695ee42013-09-17 03:30:31 +0000147 ConstantInt *Value = Expr->getValue();
148 isl_val *v;
149
150 // LLVM does not define if an integer value is interpreted as a signed or
151 // unsigned value. Hence, without further information, it is unknown how
152 // this value needs to be converted to GMP. At the moment, we only support
153 // signed operations. So we just interpret it as signed. Later, there are
154 // two options:
155 //
156 // 1. We always interpret any value as signed and convert the values on
157 // demand.
158 // 2. We pass down the signedness of the calculation and use it to interpret
159 // this constant correctly.
160 v = isl_valFromAPInt(Ctx, Value->getValue(), /* isSigned */ true);
161
162 isl_space *Space = isl_space_set_alloc(Ctx, 0, NbLoopSpaces);
Johannes Doerfert9c147372014-11-19 15:36:59 +0000163 isl_local_space *ls = isl_local_space_from_space(Space);
164 return isl_pw_aff_from_aff(isl_aff_val_on_domain(ls, v));
Tobias Grosser0695ee42013-09-17 03:30:31 +0000165}
166
167__isl_give isl_pw_aff *
168SCEVAffinator::visitTruncateExpr(const SCEVTruncateExpr *Expr) {
169 llvm_unreachable("SCEVTruncateExpr not yet supported");
170}
171
172__isl_give isl_pw_aff *
173SCEVAffinator::visitZeroExtendExpr(const SCEVZeroExtendExpr *Expr) {
174 llvm_unreachable("SCEVZeroExtendExpr not yet supported");
175}
176
177__isl_give isl_pw_aff *
178SCEVAffinator::visitSignExtendExpr(const SCEVSignExtendExpr *Expr) {
179 // Assuming the value is signed, a sign extension is basically a noop.
180 // TODO: Reconsider this as soon as we support unsigned values.
181 return visit(Expr->getOperand());
182}
183
184__isl_give isl_pw_aff *SCEVAffinator::visitAddExpr(const SCEVAddExpr *Expr) {
185 isl_pw_aff *Sum = visit(Expr->getOperand(0));
186
187 for (int i = 1, e = Expr->getNumOperands(); i < e; ++i) {
188 isl_pw_aff *NextSummand = visit(Expr->getOperand(i));
189 Sum = isl_pw_aff_add(Sum, NextSummand);
Tobias Grosser33ba62ad2011-08-18 06:31:50 +0000190 }
191
Tobias Grosser0695ee42013-09-17 03:30:31 +0000192 // TODO: Check for NSW and NUW.
Tobias Grosser33ba62ad2011-08-18 06:31:50 +0000193
Tobias Grosser0695ee42013-09-17 03:30:31 +0000194 return Sum;
195}
Tobias Grosser33ba62ad2011-08-18 06:31:50 +0000196
Tobias Grosser0695ee42013-09-17 03:30:31 +0000197__isl_give isl_pw_aff *SCEVAffinator::visitMulExpr(const SCEVMulExpr *Expr) {
Johannes Doerfertbe409962015-03-29 20:45:09 +0000198 // Divide Expr into a constant part and the rest. Then visit both and multiply
199 // the result to obtain the representation for Expr. While the second part of
200 // ConstantAndLeftOverPair might still be a SCEVMulExpr we will not get to
201 // this point again. The reason is that if it is a multiplication it consists
202 // only of parameters and we will stop in the visit(const SCEV *) function and
203 // return the isl_pw_aff for that parameter.
204 auto ConstantAndLeftOverPair = extractConstantFactor(Expr, *S->getSE());
205 return isl_pw_aff_mul(visit(ConstantAndLeftOverPair.first),
206 visit(ConstantAndLeftOverPair.second));
Tobias Grosser0695ee42013-09-17 03:30:31 +0000207}
Tobias Grosser33ba62ad2011-08-18 06:31:50 +0000208
Tobias Grosser0695ee42013-09-17 03:30:31 +0000209__isl_give isl_pw_aff *SCEVAffinator::visitUDivExpr(const SCEVUDivExpr *Expr) {
210 llvm_unreachable("SCEVUDivExpr not yet supported");
211}
Tobias Grosser33ba62ad2011-08-18 06:31:50 +0000212
Tobias Grosser0695ee42013-09-17 03:30:31 +0000213__isl_give isl_pw_aff *
214SCEVAffinator::visitAddRecExpr(const SCEVAddRecExpr *Expr) {
215 assert(Expr->isAffine() && "Only affine AddRecurrences allowed");
Tobias Grosser33ba62ad2011-08-18 06:31:50 +0000216
Johannes Doerfertd5d8f672015-04-26 19:55:21 +0000217 auto Flags = Expr->getNoWrapFlags();
218
Tobias Grosser0695ee42013-09-17 03:30:31 +0000219 // Directly generate isl_pw_aff for Expr if 'start' is zero.
220 if (Expr->getStart()->isZero()) {
221 assert(S->getRegion().contains(Expr->getLoop()) &&
222 "Scop does not contain the loop referenced in this AddRec");
Tobias Grosser33ba62ad2011-08-18 06:31:50 +0000223
Tobias Grosser33ba62ad2011-08-18 06:31:50 +0000224 isl_pw_aff *Start = visit(Expr->getStart());
Tobias Grosser0695ee42013-09-17 03:30:31 +0000225 isl_pw_aff *Step = visit(Expr->getOperand(1));
226 isl_space *Space = isl_space_set_alloc(Ctx, 0, NbLoopSpaces);
227 isl_local_space *LocalSpace = isl_local_space_from_space(Space);
Tobias Grosser33ba62ad2011-08-18 06:31:50 +0000228
Tobias Grosser0695ee42013-09-17 03:30:31 +0000229 int loopDimension = getLoopDepth(Expr->getLoop());
230
231 isl_aff *LAff = isl_aff_set_coefficient_si(
232 isl_aff_zero_on_domain(LocalSpace), isl_dim_in, loopDimension, 1);
233 isl_pw_aff *LPwAff = isl_pw_aff_from_aff(LAff);
234
235 // TODO: Do we need to check for NSW and NUW?
236 return isl_pw_aff_add(Start, isl_pw_aff_mul(Step, LPwAff));
Tobias Grosser33ba62ad2011-08-18 06:31:50 +0000237 }
238
Tobias Grosser0695ee42013-09-17 03:30:31 +0000239 // Translate AddRecExpr from '{start, +, inc}' into 'start + {0, +, inc}'
240 // if 'start' is not zero.
Johannes Doerfertd5d8f672015-04-26 19:55:21 +0000241 // TODO: Using the original SCEV no-wrap flags is not always safe, however
242 // as our code generation is reordering the expression anyway it doesn't
243 // really matter.
Tobias Grosser0695ee42013-09-17 03:30:31 +0000244 ScalarEvolution &SE = *S->getSE();
Johannes Doerfertd5d8f672015-04-26 19:55:21 +0000245 const SCEV *ZeroStartExpr =
246 SE.getAddRecExpr(SE.getConstant(Expr->getStart()->getType(), 0),
247 Expr->getStepRecurrence(SE), Expr->getLoop(), Flags);
Tobias Grosser33ba62ad2011-08-18 06:31:50 +0000248
Tobias Grosser0695ee42013-09-17 03:30:31 +0000249 isl_pw_aff *ZeroStartResult = visit(ZeroStartExpr);
250 isl_pw_aff *Start = visit(Expr->getStart());
Tobias Grosser33ba62ad2011-08-18 06:31:50 +0000251
Tobias Grosser0695ee42013-09-17 03:30:31 +0000252 return isl_pw_aff_add(ZeroStartResult, Start);
253}
254
255__isl_give isl_pw_aff *SCEVAffinator::visitSMaxExpr(const SCEVSMaxExpr *Expr) {
256 isl_pw_aff *Max = visit(Expr->getOperand(0));
257
258 for (int i = 1, e = Expr->getNumOperands(); i < e; ++i) {
259 isl_pw_aff *NextOperand = visit(Expr->getOperand(i));
260 Max = isl_pw_aff_max(Max, NextOperand);
Tobias Grosser33ba62ad2011-08-18 06:31:50 +0000261 }
262
Tobias Grosser0695ee42013-09-17 03:30:31 +0000263 return Max;
264}
Tobias Grosser33ba62ad2011-08-18 06:31:50 +0000265
Tobias Grosser0695ee42013-09-17 03:30:31 +0000266__isl_give isl_pw_aff *SCEVAffinator::visitUMaxExpr(const SCEVUMaxExpr *Expr) {
267 llvm_unreachable("SCEVUMaxExpr not yet supported");
268}
269
Johannes Doerfertb9d18882015-02-11 14:54:50 +0000270__isl_give isl_pw_aff *SCEVAffinator::visitSDivInstruction(Instruction *SDiv) {
271 assert(SDiv->getOpcode() == Instruction::SDiv && "Assumed SDiv instruction!");
272 auto *SE = S->getSE();
273
274 auto *Divisor = SDiv->getOperand(1);
275 auto *DivisorSCEV = SE->getSCEV(Divisor);
276 auto *DivisorPWA = visit(DivisorSCEV);
277 assert(isa<ConstantInt>(Divisor) &&
278 "SDiv is no parameter but has a non-constant RHS.");
279
280 auto *Dividend = SDiv->getOperand(0);
281 auto *DividendSCEV = SE->getSCEV(Dividend);
282 auto *DividendPWA = visit(DividendSCEV);
283 return isl_pw_aff_tdiv_q(DividendPWA, DivisorPWA);
284}
285
Tobias Grosser0695ee42013-09-17 03:30:31 +0000286__isl_give isl_pw_aff *SCEVAffinator::visitUnknown(const SCEVUnknown *Expr) {
Johannes Doerfertb9d18882015-02-11 14:54:50 +0000287 if (Instruction *I = dyn_cast<Instruction>(Expr->getValue())) {
288 switch (I->getOpcode()) {
289 case Instruction::SDiv:
290 return visitSDivInstruction(I);
291 default:
292 break; // Fall through.
293 }
294 }
295
296 llvm_unreachable(
297 "Unknowns SCEV was neither parameter nor a valid instruction.");
Tobias Grosser0695ee42013-09-17 03:30:31 +0000298}
299
300int SCEVAffinator::getLoopDepth(const Loop *L) {
301 Loop *outerLoop = S->getRegion().outermostLoopInRegion(const_cast<Loop *>(L));
302 assert(outerLoop && "Scop does not contain this loop");
303 return L->getLoopDepth() - outerLoop->getLoopDepth();
304}
Tobias Grosser33ba62ad2011-08-18 06:31:50 +0000305
Johannes Doerferte7044942015-02-24 11:58:30 +0000306/// @brief Add the bounds of @p Range to the set @p S for dimension @p dim.
307static __isl_give isl_set *addRangeBoundsToSet(__isl_take isl_set *S,
308 const ConstantRange &Range,
309 int dim,
310 enum isl_dim_type type) {
311 isl_val *V;
312 isl_ctx *ctx = isl_set_get_ctx(S);
313
Johannes Doerfert8f8af432015-04-26 20:07:21 +0000314 bool useLowerUpperBound = Range.isSignWrappedSet() && !Range.isFullSet();
315 const auto LB = useLowerUpperBound ? Range.getLower() : Range.getSignedMin();
Johannes Doerferte4bd53b2015-03-08 19:49:50 +0000316 V = isl_valFromAPInt(ctx, LB, true);
Johannes Doerferte7044942015-02-24 11:58:30 +0000317 isl_set *SLB = isl_set_lower_bound_val(isl_set_copy(S), type, dim, V);
318
Johannes Doerfert8f8af432015-04-26 20:07:21 +0000319 const auto UB = useLowerUpperBound ? Range.getUpper() : Range.getSignedMax();
Johannes Doerferte4bd53b2015-03-08 19:49:50 +0000320 V = isl_valFromAPInt(ctx, UB, true);
Johannes Doerfert8f8af432015-04-26 20:07:21 +0000321 if (useLowerUpperBound)
Johannes Doerferte4bd53b2015-03-08 19:49:50 +0000322 V = isl_val_sub_ui(V, 1);
Johannes Doerferte7044942015-02-24 11:58:30 +0000323 isl_set *SUB = isl_set_upper_bound_val(S, type, dim, V);
324
Johannes Doerfert8f8af432015-04-26 20:07:21 +0000325 if (useLowerUpperBound)
Johannes Doerferte7044942015-02-24 11:58:30 +0000326 return isl_set_union(SLB, SUB);
327 else
328 return isl_set_intersect(SLB, SUB);
329}
330
Tobias Grosser49ad36c2015-05-20 08:05:31 +0000331ScopArrayInfo::ScopArrayInfo(Value *BasePtr, Type *ElementType, isl_ctx *Ctx,
Johannes Doerfert1a28a892014-10-05 11:32:18 +0000332 const SmallVector<const SCEV *, 4> &DimensionSizes)
Tobias Grosser49ad36c2015-05-20 08:05:31 +0000333 : BasePtr(BasePtr), ElementType(ElementType),
334 DimensionSizes(DimensionSizes) {
Johannes Doerfert1a28a892014-10-05 11:32:18 +0000335 const std::string BasePtrName = getIslCompatibleName("MemRef_", BasePtr, "");
336 Id = isl_id_alloc(Ctx, BasePtrName.c_str(), this);
337}
338
339ScopArrayInfo::~ScopArrayInfo() { isl_id_free(Id); }
340
Tobias Grosser49ad36c2015-05-20 08:05:31 +0000341std::string ScopArrayInfo::getName() const { return isl_id_get_name(Id); }
342
343int ScopArrayInfo::getElemSizeInBytes() const {
344 return ElementType->getPrimitiveSizeInBits() / 8;
345}
346
Johannes Doerfert1a28a892014-10-05 11:32:18 +0000347isl_id *ScopArrayInfo::getBasePtrId() const { return isl_id_copy(Id); }
348
349void ScopArrayInfo::dump() const { print(errs()); }
350
351void ScopArrayInfo::print(raw_ostream &OS) const {
Tobias Grosser49ad36c2015-05-20 08:05:31 +0000352 OS.indent(8) << *getElementType() << " " << getName() << "[*]";
Johannes Doerfert1a28a892014-10-05 11:32:18 +0000353 for (unsigned u = 0; u < getNumberOfDimensions(); u++)
Tobias Grosser49ad36c2015-05-20 08:05:31 +0000354 OS << "[" << *DimensionSizes[u] << "]";
355 OS << " // Element size " << getElemSizeInBytes() << "\n";
Johannes Doerfert1a28a892014-10-05 11:32:18 +0000356}
357
358const ScopArrayInfo *
359ScopArrayInfo::getFromAccessFunction(__isl_keep isl_pw_multi_aff *PMA) {
360 isl_id *Id = isl_pw_multi_aff_get_tuple_id(PMA, isl_dim_out);
361 assert(Id && "Output dimension didn't have an ID");
362 return getFromId(Id);
363}
364
365const ScopArrayInfo *ScopArrayInfo::getFromId(isl_id *Id) {
366 void *User = isl_id_get_user(Id);
367 const ScopArrayInfo *SAI = static_cast<ScopArrayInfo *>(User);
368 isl_id_free(Id);
369 return SAI;
370}
371
Johannes Doerfert32868bf2014-08-01 08:13:25 +0000372const std::string
373MemoryAccess::getReductionOperatorStr(MemoryAccess::ReductionType RT) {
374 switch (RT) {
375 case MemoryAccess::RT_NONE:
376 llvm_unreachable("Requested a reduction operator string for a memory "
377 "access which isn't a reduction");
378 case MemoryAccess::RT_ADD:
379 return "+";
380 case MemoryAccess::RT_MUL:
381 return "*";
382 case MemoryAccess::RT_BOR:
383 return "|";
384 case MemoryAccess::RT_BXOR:
385 return "^";
386 case MemoryAccess::RT_BAND:
387 return "&";
388 }
389 llvm_unreachable("Unknown reduction type");
390 return "";
391}
392
Johannes Doerfertf6183392014-07-01 20:52:51 +0000393/// @brief Return the reduction type for a given binary operator
394static MemoryAccess::ReductionType getReductionType(const BinaryOperator *BinOp,
395 const Instruction *Load) {
396 if (!BinOp)
397 return MemoryAccess::RT_NONE;
398 switch (BinOp->getOpcode()) {
399 case Instruction::FAdd:
400 if (!BinOp->hasUnsafeAlgebra())
401 return MemoryAccess::RT_NONE;
402 // Fall through
403 case Instruction::Add:
404 return MemoryAccess::RT_ADD;
405 case Instruction::Or:
406 return MemoryAccess::RT_BOR;
407 case Instruction::Xor:
408 return MemoryAccess::RT_BXOR;
409 case Instruction::And:
410 return MemoryAccess::RT_BAND;
411 case Instruction::FMul:
412 if (!BinOp->hasUnsafeAlgebra())
413 return MemoryAccess::RT_NONE;
414 // Fall through
415 case Instruction::Mul:
416 if (DisableMultiplicativeReductions)
417 return MemoryAccess::RT_NONE;
418 return MemoryAccess::RT_MUL;
419 default:
420 return MemoryAccess::RT_NONE;
421 }
422}
Tobias Grosser75805372011-04-29 06:27:02 +0000423//===----------------------------------------------------------------------===//
424
425MemoryAccess::~MemoryAccess() {
Tobias Grosser6f48e0f2015-05-15 09:58:32 +0000426 isl_id_free(Id);
Tobias Grosser54a86e62011-08-18 06:31:46 +0000427 isl_map_free(AccessRelation);
Raghesh Aloor129e8672011-08-15 02:33:39 +0000428 isl_map_free(newAccessRelation);
Tobias Grosser75805372011-04-29 06:27:02 +0000429}
430
Johannes Doerfert8f7124c2014-09-12 11:00:49 +0000431static MemoryAccess::AccessType getMemoryAccessType(const IRAccess &Access) {
432 switch (Access.getType()) {
433 case IRAccess::READ:
434 return MemoryAccess::READ;
435 case IRAccess::MUST_WRITE:
436 return MemoryAccess::MUST_WRITE;
437 case IRAccess::MAY_WRITE:
438 return MemoryAccess::MAY_WRITE;
439 }
440 llvm_unreachable("Unknown IRAccess type!");
441}
442
Johannes Doerfert1a28a892014-10-05 11:32:18 +0000443const ScopArrayInfo *MemoryAccess::getScopArrayInfo() const {
444 isl_id *ArrayId = getArrayId();
445 void *User = isl_id_get_user(ArrayId);
446 const ScopArrayInfo *SAI = static_cast<ScopArrayInfo *>(User);
447 isl_id_free(ArrayId);
448 return SAI;
449}
450
Tobias Grosser4f663aa2015-03-30 11:52:59 +0000451__isl_give isl_id *MemoryAccess::getArrayId() const {
Johannes Doerfert5d83f092014-07-29 08:37:55 +0000452 return isl_map_get_tuple_id(AccessRelation, isl_dim_out);
453}
454
Tobias Grosser4f663aa2015-03-30 11:52:59 +0000455__isl_give isl_pw_multi_aff *MemoryAccess::applyScheduleToAccessRelation(
456 __isl_take isl_union_map *USchedule) const {
Johannes Doerferta99130f2014-10-13 12:58:03 +0000457 isl_map *Schedule, *ScheduledAccRel;
458 isl_union_set *UDomain;
459
460 UDomain = isl_union_set_from_set(getStatement()->getDomain());
461 USchedule = isl_union_map_intersect_domain(USchedule, UDomain);
462 Schedule = isl_map_from_union_map(USchedule);
463 ScheduledAccRel = isl_map_apply_domain(getAccessRelation(), Schedule);
464 return isl_pw_multi_aff_from_map(ScheduledAccRel);
465}
466
Tobias Grosser4f663aa2015-03-30 11:52:59 +0000467__isl_give isl_map *MemoryAccess::getOriginalAccessRelation() const {
Tobias Grosser5d453812011-10-06 00:04:11 +0000468 return isl_map_copy(AccessRelation);
469}
470
Johannes Doerferta99130f2014-10-13 12:58:03 +0000471std::string MemoryAccess::getOriginalAccessRelationStr() const {
Tobias Grosser5d453812011-10-06 00:04:11 +0000472 return stringFromIslObj(AccessRelation);
473}
474
Johannes Doerferta99130f2014-10-13 12:58:03 +0000475__isl_give isl_space *MemoryAccess::getOriginalAccessRelationSpace() const {
Tobias Grosser5e6813d2014-07-02 17:47:48 +0000476 return isl_map_get_space(AccessRelation);
477}
478
Tobias Grosser4f663aa2015-03-30 11:52:59 +0000479__isl_give isl_map *MemoryAccess::getNewAccessRelation() const {
Tobias Grosser5d453812011-10-06 00:04:11 +0000480 return isl_map_copy(newAccessRelation);
Tobias Grosser75805372011-04-29 06:27:02 +0000481}
482
Tobias Grosser4f663aa2015-03-30 11:52:59 +0000483__isl_give isl_basic_map *
484MemoryAccess::createBasicAccessMap(ScopStmt *Statement) {
Tobias Grosser084d8f72012-05-29 09:29:44 +0000485 isl_space *Space = isl_space_set_alloc(Statement->getIslCtx(), 0, 1);
Tobias Grossered295662012-09-11 13:50:21 +0000486 Space = isl_space_align_params(Space, Statement->getDomainSpace());
Tobias Grosser75805372011-04-29 06:27:02 +0000487
Tobias Grosser084d8f72012-05-29 09:29:44 +0000488 return isl_basic_map_from_domain_and_range(
Tobias Grosserabfbe632013-02-05 12:09:06 +0000489 isl_basic_set_universe(Statement->getDomainSpace()),
490 isl_basic_set_universe(Space));
Tobias Grosser75805372011-04-29 06:27:02 +0000491}
492
Tobias Grosser5e6813d2014-07-02 17:47:48 +0000493// Formalize no out-of-bound access assumption
494//
495// When delinearizing array accesses we optimistically assume that the
496// delinearized accesses do not access out of bound locations (the subscript
497// expression of each array evaluates for each statement instance that is
498// executed to a value that is larger than zero and strictly smaller than the
499// size of the corresponding dimension). The only exception is the outermost
Tobias Grosserf57d63f2014-08-03 21:07:30 +0000500// dimension for which we do not need to assume any upper bound. At this point
501// we formalize this assumption to ensure that at code generation time the
502// relevant run-time checks can be generated.
Tobias Grosser5e6813d2014-07-02 17:47:48 +0000503//
504// To find the set of constraints necessary to avoid out of bound accesses, we
505// first build the set of data locations that are not within array bounds. We
506// then apply the reverse access relation to obtain the set of iterations that
507// may contain invalid accesses and reduce this set of iterations to the ones
508// that are actually executed by intersecting them with the domain of the
509// statement. If we now project out all loop dimensions, we obtain a set of
510// parameters that may cause statement instances to be executed that may
511// possibly yield out of bound memory accesses. The complement of these
512// constraints is the set of constraints that needs to be assumed to ensure such
513// statement instances are never executed.
514void MemoryAccess::assumeNoOutOfBound(const IRAccess &Access) {
Johannes Doerferta99130f2014-10-13 12:58:03 +0000515 isl_space *Space = isl_space_range(getOriginalAccessRelationSpace());
Tobias Grosser5e6813d2014-07-02 17:47:48 +0000516 isl_set *Outside = isl_set_empty(isl_space_copy(Space));
Tobias Grosserf57d63f2014-08-03 21:07:30 +0000517 for (int i = 1, Size = Access.Subscripts.size(); i < Size; ++i) {
Tobias Grosser5e6813d2014-07-02 17:47:48 +0000518 isl_local_space *LS = isl_local_space_from_space(isl_space_copy(Space));
519 isl_pw_aff *Var =
520 isl_pw_aff_var_on_domain(isl_local_space_copy(LS), isl_dim_set, i);
521 isl_pw_aff *Zero = isl_pw_aff_zero_on_domain(LS);
522
523 isl_set *DimOutside;
524
Tobias Grosserf57d63f2014-08-03 21:07:30 +0000525 DimOutside = isl_pw_aff_lt_set(isl_pw_aff_copy(Var), Zero);
526 isl_pw_aff *SizeE = SCEVAffinator::getPwAff(Statement, Access.Sizes[i - 1]);
Tobias Grosser5e6813d2014-07-02 17:47:48 +0000527
Tobias Grosserf57d63f2014-08-03 21:07:30 +0000528 SizeE = isl_pw_aff_drop_dims(SizeE, isl_dim_in, 0,
529 Statement->getNumIterators());
530 SizeE = isl_pw_aff_add_dims(SizeE, isl_dim_in,
531 isl_space_dim(Space, isl_dim_set));
532 SizeE = isl_pw_aff_set_tuple_id(SizeE, isl_dim_in,
533 isl_space_get_tuple_id(Space, isl_dim_set));
Tobias Grosser5e6813d2014-07-02 17:47:48 +0000534
Tobias Grosserf57d63f2014-08-03 21:07:30 +0000535 DimOutside = isl_set_union(DimOutside, isl_pw_aff_le_set(SizeE, Var));
Tobias Grosser5e6813d2014-07-02 17:47:48 +0000536
537 Outside = isl_set_union(Outside, DimOutside);
538 }
539
540 Outside = isl_set_apply(Outside, isl_map_reverse(getAccessRelation()));
541 Outside = isl_set_intersect(Outside, Statement->getDomain());
542 Outside = isl_set_params(Outside);
543 Outside = isl_set_complement(Outside);
544 Statement->getParent()->addAssumption(Outside);
545 isl_space_free(Space);
546}
547
Johannes Doerferte7044942015-02-24 11:58:30 +0000548void MemoryAccess::computeBoundsOnAccessRelation(unsigned ElementSize) {
549 ScalarEvolution *SE = Statement->getParent()->getSE();
550
551 Value *Ptr = getPointerOperand(*getAccessInstruction());
552 if (!Ptr || !SE->isSCEVable(Ptr->getType()))
553 return;
554
555 auto *PtrSCEV = SE->getSCEV(Ptr);
556 if (isa<SCEVCouldNotCompute>(PtrSCEV))
557 return;
558
559 auto *BasePtrSCEV = SE->getPointerBase(PtrSCEV);
560 if (BasePtrSCEV && !isa<SCEVCouldNotCompute>(BasePtrSCEV))
561 PtrSCEV = SE->getMinusSCEV(PtrSCEV, BasePtrSCEV);
562
563 const ConstantRange &Range = SE->getSignedRange(PtrSCEV);
564 if (Range.isFullSet())
565 return;
566
Johannes Doerferte4bd53b2015-03-08 19:49:50 +0000567 bool isWrapping = Range.isSignWrappedSet();
Johannes Doerferte7044942015-02-24 11:58:30 +0000568 unsigned BW = Range.getBitWidth();
Johannes Doerferte4bd53b2015-03-08 19:49:50 +0000569 const auto LB = isWrapping ? Range.getLower() : Range.getSignedMin();
570 const auto UB = isWrapping ? Range.getUpper() : Range.getSignedMax();
571
572 auto Min = LB.sdiv(APInt(BW, ElementSize));
573 auto Max = (UB - APInt(BW, 1)).sdiv(APInt(BW, ElementSize));
Johannes Doerferte7044942015-02-24 11:58:30 +0000574
575 isl_set *AccessRange = isl_map_range(isl_map_copy(AccessRelation));
576 AccessRange =
577 addRangeBoundsToSet(AccessRange, ConstantRange(Min, Max), 0, isl_dim_set);
578 AccessRelation = isl_map_intersect_range(AccessRelation, AccessRange);
579}
580
Tobias Grosser619190d2015-03-30 17:22:28 +0000581__isl_give isl_map *MemoryAccess::foldAccess(const IRAccess &Access,
582 __isl_take isl_map *AccessRelation,
583 ScopStmt *Statement) {
584 int Size = Access.Subscripts.size();
585
586 for (int i = Size - 2; i >= 0; --i) {
587 isl_space *Space;
588 isl_map *MapOne, *MapTwo;
589 isl_pw_aff *DimSize = SCEVAffinator::getPwAff(Statement, Access.Sizes[i]);
590
591 isl_space *SpaceSize = isl_pw_aff_get_space(DimSize);
592 isl_pw_aff_free(DimSize);
593 isl_id *ParamId = isl_space_get_dim_id(SpaceSize, isl_dim_param, 0);
594
595 Space = isl_map_get_space(AccessRelation);
596 Space = isl_space_map_from_set(isl_space_range(Space));
597 Space = isl_space_align_params(Space, SpaceSize);
598
599 int ParamLocation = isl_space_find_dim_by_id(Space, isl_dim_param, ParamId);
600 isl_id_free(ParamId);
601
602 MapOne = isl_map_universe(isl_space_copy(Space));
603 for (int j = 0; j < Size; ++j)
604 MapOne = isl_map_equate(MapOne, isl_dim_in, j, isl_dim_out, j);
605 MapOne = isl_map_lower_bound_si(MapOne, isl_dim_in, i + 1, 0);
606
607 MapTwo = isl_map_universe(isl_space_copy(Space));
608 for (int j = 0; j < Size; ++j)
609 if (j < i || j > i + 1)
610 MapTwo = isl_map_equate(MapTwo, isl_dim_in, j, isl_dim_out, j);
611
612 isl_local_space *LS = isl_local_space_from_space(Space);
613 isl_constraint *C;
614 C = isl_equality_alloc(isl_local_space_copy(LS));
615 C = isl_constraint_set_constant_si(C, -1);
616 C = isl_constraint_set_coefficient_si(C, isl_dim_in, i, 1);
617 C = isl_constraint_set_coefficient_si(C, isl_dim_out, i, -1);
618 MapTwo = isl_map_add_constraint(MapTwo, C);
619 C = isl_equality_alloc(LS);
620 C = isl_constraint_set_coefficient_si(C, isl_dim_in, i + 1, 1);
621 C = isl_constraint_set_coefficient_si(C, isl_dim_out, i + 1, -1);
622 C = isl_constraint_set_coefficient_si(C, isl_dim_param, ParamLocation, 1);
623 MapTwo = isl_map_add_constraint(MapTwo, C);
624 MapTwo = isl_map_upper_bound_si(MapTwo, isl_dim_in, i + 1, -1);
625
626 MapOne = isl_map_union(MapOne, MapTwo);
627 AccessRelation = isl_map_apply_range(AccessRelation, MapOne);
628 }
629 return AccessRelation;
630}
631
Johannes Doerfert13c8cf22014-08-10 08:09:38 +0000632MemoryAccess::MemoryAccess(const IRAccess &Access, Instruction *AccInst,
Tobias Grosser6f48e0f2015-05-15 09:58:32 +0000633 ScopStmt *Statement, const ScopArrayInfo *SAI,
634 int Identifier)
Johannes Doerfert4c7ce472014-10-08 10:11:33 +0000635 : AccType(getMemoryAccessType(Access)), Statement(Statement), Inst(AccInst),
Johannes Doerfert8f7124c2014-09-12 11:00:49 +0000636 newAccessRelation(nullptr) {
Tobias Grosser75805372011-04-29 06:27:02 +0000637
Johannes Doerfert5d83f092014-07-29 08:37:55 +0000638 isl_ctx *Ctx = Statement->getIslCtx();
Tobias Grosser9759f852011-11-10 12:44:55 +0000639 BaseAddr = Access.getBase();
Johannes Doerfert79fc23f2014-07-24 23:48:02 +0000640 BaseName = getIslCompatibleName("MemRef_", getBaseAddr(), "");
Johannes Doerfert1a28a892014-10-05 11:32:18 +0000641
642 isl_id *BaseAddrId = SAI->getBasePtrId();
Tobias Grosser5683df42011-11-09 22:34:34 +0000643
Tobias Grossere29d31c2015-05-15 12:24:09 +0000644 auto IdName = "__polly_array_ref_ " + std::to_string(Identifier);
645 Id = isl_id_alloc(Ctx, IdName.c_str(), nullptr);
Tobias Grosser6f48e0f2015-05-15 09:58:32 +0000646
Tobias Grossera1879642011-12-20 10:43:14 +0000647 if (!Access.isAffine()) {
Tobias Grosser4f967492013-06-23 05:21:18 +0000648 // We overapproximate non-affine accesses with a possible access to the
649 // whole array. For read accesses it does not make a difference, if an
650 // access must or may happen. However, for write accesses it is important to
651 // differentiate between writes that must happen and writes that may happen.
Tobias Grosser04d6ae62013-06-23 06:04:54 +0000652 AccessRelation = isl_map_from_basic_map(createBasicAccessMap(Statement));
Johannes Doerfert5d83f092014-07-29 08:37:55 +0000653 AccessRelation =
654 isl_map_set_tuple_id(AccessRelation, isl_dim_out, BaseAddrId);
Johannes Doerferte7044942015-02-24 11:58:30 +0000655
656 computeBoundsOnAccessRelation(Access.getElemSizeInBytes());
Tobias Grossera1879642011-12-20 10:43:14 +0000657 return;
658 }
659
Johannes Doerfert5d83f092014-07-29 08:37:55 +0000660 isl_space *Space = isl_space_alloc(Ctx, 0, Statement->getNumIterators(), 0);
Tobias Grosser79baa212014-04-10 08:38:02 +0000661 AccessRelation = isl_map_universe(Space);
Tobias Grossera1879642011-12-20 10:43:14 +0000662
Tobias Grosser79baa212014-04-10 08:38:02 +0000663 for (int i = 0, Size = Access.Subscripts.size(); i < Size; ++i) {
Sebastian Pop18016682014-04-08 21:20:44 +0000664 isl_pw_aff *Affine =
665 SCEVAffinator::getPwAff(Statement, Access.Subscripts[i]);
Tobias Grosser75805372011-04-29 06:27:02 +0000666
Sebastian Pop422e33f2014-06-03 18:16:31 +0000667 if (Size == 1) {
668 // For the non delinearized arrays, divide the access function of the last
669 // subscript by the size of the elements in the array.
Sebastian Pop18016682014-04-08 21:20:44 +0000670 //
671 // A stride one array access in C expressed as A[i] is expressed in
672 // LLVM-IR as something like A[i * elementsize]. This hides the fact that
673 // two subsequent values of 'i' index two values that are stored next to
674 // each other in memory. By this division we make this characteristic
675 // obvious again.
Johannes Doerfert5d83f092014-07-29 08:37:55 +0000676 isl_val *v = isl_val_int_from_si(Ctx, Access.getElemSizeInBytes());
Sebastian Pop18016682014-04-08 21:20:44 +0000677 Affine = isl_pw_aff_scale_down_val(Affine, v);
678 }
679
680 isl_map *SubscriptMap = isl_map_from_pw_aff(Affine);
681
Tobias Grosser79baa212014-04-10 08:38:02 +0000682 AccessRelation = isl_map_flat_range_product(AccessRelation, SubscriptMap);
Sebastian Pop18016682014-04-08 21:20:44 +0000683 }
684
Tobias Grosser619190d2015-03-30 17:22:28 +0000685 AccessRelation = foldAccess(Access, AccessRelation, Statement);
686
Tobias Grosser79baa212014-04-10 08:38:02 +0000687 Space = Statement->getDomainSpace();
Tobias Grosserabfbe632013-02-05 12:09:06 +0000688 AccessRelation = isl_map_set_tuple_id(
689 AccessRelation, isl_dim_in, isl_space_get_tuple_id(Space, isl_dim_set));
Johannes Doerfert5d83f092014-07-29 08:37:55 +0000690 AccessRelation =
691 isl_map_set_tuple_id(AccessRelation, isl_dim_out, BaseAddrId);
692
Tobias Grosser5e6813d2014-07-02 17:47:48 +0000693 assumeNoOutOfBound(Access);
Tobias Grosseraa660a92015-03-30 00:07:50 +0000694 AccessRelation = isl_map_gist_domain(AccessRelation, Statement->getDomain());
Johannes Doerfert5d83f092014-07-29 08:37:55 +0000695 isl_space_free(Space);
Tobias Grosser8cae72f2011-11-08 15:41:08 +0000696}
Tobias Grosser30b8a092011-08-18 07:51:37 +0000697
Tobias Grosser8cae72f2011-11-08 15:41:08 +0000698void MemoryAccess::realignParams() {
Tobias Grosser6defb5b2014-04-10 08:37:44 +0000699 isl_space *ParamSpace = Statement->getParent()->getParamSpace();
Tobias Grosser37487052011-10-06 00:03:42 +0000700 AccessRelation = isl_map_align_params(AccessRelation, ParamSpace);
Tobias Grosser75805372011-04-29 06:27:02 +0000701}
702
Johannes Doerfert32868bf2014-08-01 08:13:25 +0000703const std::string MemoryAccess::getReductionOperatorStr() const {
704 return MemoryAccess::getReductionOperatorStr(getReductionType());
705}
706
Tobias Grosser6f48e0f2015-05-15 09:58:32 +0000707__isl_give isl_id *MemoryAccess::getId() const { return isl_id_copy(Id); }
708
Johannes Doerfertf6183392014-07-01 20:52:51 +0000709raw_ostream &polly::operator<<(raw_ostream &OS,
710 MemoryAccess::ReductionType RT) {
Johannes Doerfert32868bf2014-08-01 08:13:25 +0000711 if (RT == MemoryAccess::RT_NONE)
Johannes Doerfertf6183392014-07-01 20:52:51 +0000712 OS << "NONE";
Johannes Doerfert32868bf2014-08-01 08:13:25 +0000713 else
714 OS << MemoryAccess::getReductionOperatorStr(RT);
Johannes Doerfertf6183392014-07-01 20:52:51 +0000715 return OS;
716}
717
Tobias Grosser75805372011-04-29 06:27:02 +0000718void MemoryAccess::print(raw_ostream &OS) const {
Johannes Doerfert4c7ce472014-10-08 10:11:33 +0000719 switch (AccType) {
Tobias Grosserb58f6a42013-07-13 20:41:24 +0000720 case READ:
Johannes Doerfert6780bc32014-06-26 18:47:03 +0000721 OS.indent(12) << "ReadAccess :=\t";
Tobias Grosser4f967492013-06-23 05:21:18 +0000722 break;
Tobias Grosserb58f6a42013-07-13 20:41:24 +0000723 case MUST_WRITE:
Johannes Doerfert6780bc32014-06-26 18:47:03 +0000724 OS.indent(12) << "MustWriteAccess :=\t";
Tobias Grosser4f967492013-06-23 05:21:18 +0000725 break;
Tobias Grosserb58f6a42013-07-13 20:41:24 +0000726 case MAY_WRITE:
Johannes Doerfert6780bc32014-06-26 18:47:03 +0000727 OS.indent(12) << "MayWriteAccess :=\t";
Tobias Grosser4f967492013-06-23 05:21:18 +0000728 break;
729 }
Johannes Doerfert0ff23ec2015-02-06 20:13:15 +0000730 OS << "[Reduction Type: " << getReductionType() << "] ";
731 OS << "[Scalar: " << isScalar() << "]\n";
Johannes Doerferta99130f2014-10-13 12:58:03 +0000732 OS.indent(16) << getOriginalAccessRelationStr() << ";\n";
Tobias Grosser75805372011-04-29 06:27:02 +0000733}
734
Tobias Grosser74394f02013-01-14 22:40:23 +0000735void MemoryAccess::dump() const { print(errs()); }
Tobias Grosser75805372011-04-29 06:27:02 +0000736
737// Create a map in the size of the provided set domain, that maps from the
738// one element of the provided set domain to another element of the provided
739// set domain.
740// The mapping is limited to all points that are equal in all but the last
741// dimension and for which the last dimension of the input is strict smaller
742// than the last dimension of the output.
743//
744// getEqualAndLarger(set[i0, i1, ..., iX]):
745//
746// set[i0, i1, ..., iX] -> set[o0, o1, ..., oX]
747// : i0 = o0, i1 = o1, ..., i(X-1) = o(X-1), iX < oX
748//
Tobias Grosserf5338802011-10-06 00:03:35 +0000749static isl_map *getEqualAndLarger(isl_space *setDomain) {
Tobias Grosserc327932c2012-02-01 14:23:36 +0000750 isl_space *Space = isl_space_map_from_set(setDomain);
Tobias Grosser1b6ea572015-05-21 19:02:44 +0000751 isl_map *Map = isl_map_universe(Space);
Sebastian Pop40408762013-10-04 17:14:53 +0000752 unsigned lastDimension = isl_map_dim(Map, isl_dim_in) - 1;
Tobias Grosser75805372011-04-29 06:27:02 +0000753
754 // Set all but the last dimension to be equal for the input and output
755 //
756 // input[i0, i1, ..., iX] -> output[o0, o1, ..., oX]
757 // : i0 = o0, i1 = o1, ..., i(X-1) = o(X-1)
Sebastian Pop40408762013-10-04 17:14:53 +0000758 for (unsigned i = 0; i < lastDimension; ++i)
Tobias Grosserc327932c2012-02-01 14:23:36 +0000759 Map = isl_map_equate(Map, isl_dim_in, i, isl_dim_out, i);
Tobias Grosser75805372011-04-29 06:27:02 +0000760
761 // Set the last dimension of the input to be strict smaller than the
762 // last dimension of the output.
763 //
764 // input[?,?,?,...,iX] -> output[?,?,?,...,oX] : iX < oX
Tobias Grosser1b6ea572015-05-21 19:02:44 +0000765 Map = isl_map_order_lt(Map, isl_dim_in, lastDimension, isl_dim_out,
766 lastDimension);
Tobias Grosserc327932c2012-02-01 14:23:36 +0000767 return Map;
Tobias Grosser75805372011-04-29 06:27:02 +0000768}
769
Tobias Grosser4f663aa2015-03-30 11:52:59 +0000770__isl_give isl_set *
771MemoryAccess::getStride(__isl_take const isl_map *Schedule) const {
Tobias Grosserabfbe632013-02-05 12:09:06 +0000772 isl_map *S = const_cast<isl_map *>(Schedule);
Johannes Doerferta99130f2014-10-13 12:58:03 +0000773 isl_map *AccessRelation = getAccessRelation();
Sebastian Popa00a0292012-12-18 07:46:06 +0000774 isl_space *Space = isl_space_range(isl_map_get_space(S));
775 isl_map *NextScatt = getEqualAndLarger(Space);
Tobias Grosser75805372011-04-29 06:27:02 +0000776
Sebastian Popa00a0292012-12-18 07:46:06 +0000777 S = isl_map_reverse(S);
778 NextScatt = isl_map_lexmin(NextScatt);
Tobias Grosser75805372011-04-29 06:27:02 +0000779
Sebastian Popa00a0292012-12-18 07:46:06 +0000780 NextScatt = isl_map_apply_range(NextScatt, isl_map_copy(S));
781 NextScatt = isl_map_apply_range(NextScatt, isl_map_copy(AccessRelation));
782 NextScatt = isl_map_apply_domain(NextScatt, S);
783 NextScatt = isl_map_apply_domain(NextScatt, AccessRelation);
Tobias Grosser75805372011-04-29 06:27:02 +0000784
Sebastian Popa00a0292012-12-18 07:46:06 +0000785 isl_set *Deltas = isl_map_deltas(NextScatt);
786 return Deltas;
Tobias Grosser75805372011-04-29 06:27:02 +0000787}
788
Sebastian Popa00a0292012-12-18 07:46:06 +0000789bool MemoryAccess::isStrideX(__isl_take const isl_map *Schedule,
Tobias Grosser28dd4862012-01-24 16:42:16 +0000790 int StrideWidth) const {
791 isl_set *Stride, *StrideX;
792 bool IsStrideX;
Tobias Grosser75805372011-04-29 06:27:02 +0000793
Sebastian Popa00a0292012-12-18 07:46:06 +0000794 Stride = getStride(Schedule);
Tobias Grosser28dd4862012-01-24 16:42:16 +0000795 StrideX = isl_set_universe(isl_set_get_space(Stride));
796 StrideX = isl_set_fix_si(StrideX, isl_dim_set, 0, StrideWidth);
797 IsStrideX = isl_set_is_equal(Stride, StrideX);
Tobias Grosser75805372011-04-29 06:27:02 +0000798
Tobias Grosser28dd4862012-01-24 16:42:16 +0000799 isl_set_free(StrideX);
Tobias Grosserdea98232012-01-17 20:34:27 +0000800 isl_set_free(Stride);
Tobias Grosserb76f38532011-08-20 11:11:25 +0000801
Tobias Grosser28dd4862012-01-24 16:42:16 +0000802 return IsStrideX;
803}
804
Sebastian Popa00a0292012-12-18 07:46:06 +0000805bool MemoryAccess::isStrideZero(const isl_map *Schedule) const {
806 return isStrideX(Schedule, 0);
Tobias Grosser75805372011-04-29 06:27:02 +0000807}
808
Tobias Grosser79baa212014-04-10 08:38:02 +0000809bool MemoryAccess::isScalar() const {
810 return isl_map_n_out(AccessRelation) == 0;
811}
812
Sebastian Popa00a0292012-12-18 07:46:06 +0000813bool MemoryAccess::isStrideOne(const isl_map *Schedule) const {
814 return isStrideX(Schedule, 1);
Tobias Grosser75805372011-04-29 06:27:02 +0000815}
816
Tobias Grosser5d453812011-10-06 00:04:11 +0000817void MemoryAccess::setNewAccessRelation(isl_map *newAccess) {
Tobias Grosserb76f38532011-08-20 11:11:25 +0000818 isl_map_free(newAccessRelation);
Raghesh Aloor7a04f4f2011-08-03 13:47:59 +0000819 newAccessRelation = newAccess;
Raghesh Aloor3cb66282011-07-12 17:14:03 +0000820}
Tobias Grosser75805372011-04-29 06:27:02 +0000821
822//===----------------------------------------------------------------------===//
Tobias Grossercf3942d2011-10-06 00:04:05 +0000823
Tobias Grosser54839312015-04-21 11:37:25 +0000824isl_map *ScopStmt::getSchedule() const { return isl_map_copy(Schedule); }
Tobias Grossercf3942d2011-10-06 00:04:05 +0000825
Tobias Grosser37eb4222014-02-20 21:43:54 +0000826void ScopStmt::restrictDomain(__isl_take isl_set *NewDomain) {
827 assert(isl_set_is_subset(NewDomain, Domain) &&
828 "New domain is not a subset of old domain!");
829 isl_set_free(Domain);
830 Domain = NewDomain;
Tobias Grosser54839312015-04-21 11:37:25 +0000831 Schedule = isl_map_intersect_domain(Schedule, isl_set_copy(Domain));
Tobias Grosser37eb4222014-02-20 21:43:54 +0000832}
833
Tobias Grosser54839312015-04-21 11:37:25 +0000834void ScopStmt::setSchedule(__isl_take isl_map *NewSchedule) {
835 assert(NewSchedule && "New schedule is nullptr");
836 isl_map_free(Schedule);
837 Schedule = NewSchedule;
Tobias Grosserb76f38532011-08-20 11:11:25 +0000838}
839
Tobias Grosser54839312015-04-21 11:37:25 +0000840void ScopStmt::buildSchedule(SmallVectorImpl<unsigned> &ScheduleVec) {
Tobias Grosser78d8a3d2012-01-17 20:34:23 +0000841 unsigned NbIterators = getNumIterators();
Tobias Grosser54839312015-04-21 11:37:25 +0000842 unsigned NbScheduleDims = Parent.getMaxLoopDepth() * 2 + 1;
Tobias Grosser78d8a3d2012-01-17 20:34:23 +0000843
Tobias Grosser54839312015-04-21 11:37:25 +0000844 isl_space *Space = isl_space_set_alloc(getIslCtx(), 0, NbScheduleDims);
Tobias Grosser78d8a3d2012-01-17 20:34:23 +0000845
Tobias Grosser54839312015-04-21 11:37:25 +0000846 Schedule = isl_map_from_domain_and_range(isl_set_universe(getDomainSpace()),
Tobias Grosser654af8f2015-04-21 11:42:01 +0000847 isl_set_universe(Space));
Tobias Grosser75805372011-04-29 06:27:02 +0000848
849 // Loop dimensions.
Tobias Grosser78d8a3d2012-01-17 20:34:23 +0000850 for (unsigned i = 0; i < NbIterators; ++i)
Tobias Grosser654af8f2015-04-21 11:42:01 +0000851 Schedule = isl_map_equate(Schedule, isl_dim_out, 2 * i + 1, isl_dim_in, i);
Tobias Grosser75805372011-04-29 06:27:02 +0000852
853 // Constant dimensions
Tobias Grosser78d8a3d2012-01-17 20:34:23 +0000854 for (unsigned i = 0; i < NbIterators + 1; ++i)
Tobias Grosser54839312015-04-21 11:37:25 +0000855 Schedule = isl_map_fix_si(Schedule, isl_dim_out, 2 * i, ScheduleVec[i]);
Tobias Grosser75805372011-04-29 06:27:02 +0000856
Tobias Grosser54839312015-04-21 11:37:25 +0000857 // Fill schedule dimensions.
858 for (unsigned i = 2 * NbIterators + 1; i < NbScheduleDims; ++i)
859 Schedule = isl_map_fix_si(Schedule, isl_dim_out, i, 0);
Tobias Grosser75805372011-04-29 06:27:02 +0000860
Tobias Grosser54839312015-04-21 11:37:25 +0000861 Schedule = isl_map_align_params(Schedule, Parent.getParamSpace());
Tobias Grosser75805372011-04-29 06:27:02 +0000862}
863
Johannes Doerfertff9d1982015-02-24 12:00:50 +0000864void ScopStmt::buildAccesses(TempScop &tempScop, BasicBlock *Block,
865 bool isApproximated) {
866 AccFuncSetType *AFS = tempScop.getAccessFunctions(Block);
867 if (!AFS)
868 return;
869
870 for (auto &AccessPair : *AFS) {
871 IRAccess &Access = AccessPair.first;
Johannes Doerfert1a28a892014-10-05 11:32:18 +0000872 Instruction *AccessInst = AccessPair.second;
873
Tobias Grosser49ad36c2015-05-20 08:05:31 +0000874 Type *ElementType = getAccessInstType(AccessInst);
Johannes Doerfert80ef1102014-11-07 08:31:31 +0000875 const ScopArrayInfo *SAI = getParent()->getOrCreateScopArrayInfo(
Tobias Grosser49ad36c2015-05-20 08:05:31 +0000876 Access.getBase(), ElementType, Access.Sizes);
Johannes Doerfert80ef1102014-11-07 08:31:31 +0000877
Johannes Doerfertff9d1982015-02-24 12:00:50 +0000878 if (isApproximated && Access.isWrite())
879 Access.setMayWrite();
880
Johannes Doerfertecff11d2015-05-22 23:43:58 +0000881 MemoryAccessList *&MAL = InstructionToAccess[AccessInst];
882 if (!MAL)
883 MAL = new MemoryAccessList();
884 MAL->emplace_front(Access, AccessInst, this, SAI, MemAccs.size());
885 MemAccs.push_back(&MAL->front());
Tobias Grosser75805372011-04-29 06:27:02 +0000886 }
887}
888
Tobias Grosser8cae72f2011-11-08 15:41:08 +0000889void ScopStmt::realignParams() {
Johannes Doerfertf6752892014-06-13 18:01:45 +0000890 for (MemoryAccess *MA : *this)
891 MA->realignParams();
Tobias Grosser8cae72f2011-11-08 15:41:08 +0000892
893 Domain = isl_set_align_params(Domain, Parent.getParamSpace());
Tobias Grosser54839312015-04-21 11:37:25 +0000894 Schedule = isl_map_align_params(Schedule, Parent.getParamSpace());
Tobias Grosser8cae72f2011-11-08 15:41:08 +0000895}
896
Tobias Grosser65b00582011-11-08 15:41:19 +0000897__isl_give isl_set *ScopStmt::buildConditionSet(const Comparison &Comp) {
Tobias Grossera601fbd2011-11-09 22:34:44 +0000898 isl_pw_aff *L = SCEVAffinator::getPwAff(this, Comp.getLHS());
899 isl_pw_aff *R = SCEVAffinator::getPwAff(this, Comp.getRHS());
Tobias Grosser75805372011-04-29 06:27:02 +0000900
Tobias Grosserd2795d02011-08-18 07:51:40 +0000901 switch (Comp.getPred()) {
Tobias Grosser75805372011-04-29 06:27:02 +0000902 case ICmpInst::ICMP_EQ:
Tobias Grosser048c8792011-10-23 20:59:20 +0000903 return isl_pw_aff_eq_set(L, R);
Tobias Grosser75805372011-04-29 06:27:02 +0000904 case ICmpInst::ICMP_NE:
Tobias Grosser048c8792011-10-23 20:59:20 +0000905 return isl_pw_aff_ne_set(L, R);
Tobias Grosser75805372011-04-29 06:27:02 +0000906 case ICmpInst::ICMP_SLT:
Tobias Grosser048c8792011-10-23 20:59:20 +0000907 return isl_pw_aff_lt_set(L, R);
Tobias Grosser75805372011-04-29 06:27:02 +0000908 case ICmpInst::ICMP_SLE:
Tobias Grosser048c8792011-10-23 20:59:20 +0000909 return isl_pw_aff_le_set(L, R);
Tobias Grosserd2795d02011-08-18 07:51:40 +0000910 case ICmpInst::ICMP_SGT:
Tobias Grosser048c8792011-10-23 20:59:20 +0000911 return isl_pw_aff_gt_set(L, R);
Tobias Grosser75805372011-04-29 06:27:02 +0000912 case ICmpInst::ICMP_SGE:
Tobias Grosser048c8792011-10-23 20:59:20 +0000913 return isl_pw_aff_ge_set(L, R);
Tobias Grosserd2795d02011-08-18 07:51:40 +0000914 case ICmpInst::ICMP_ULT:
Tobias Grosserbfbc3692015-01-09 00:01:33 +0000915 return isl_pw_aff_lt_set(L, R);
Tobias Grosserd2795d02011-08-18 07:51:40 +0000916 case ICmpInst::ICMP_UGT:
Tobias Grosserbfbc3692015-01-09 00:01:33 +0000917 return isl_pw_aff_gt_set(L, R);
Tobias Grosserd2795d02011-08-18 07:51:40 +0000918 case ICmpInst::ICMP_ULE:
Tobias Grosserbfbc3692015-01-09 00:01:33 +0000919 return isl_pw_aff_le_set(L, R);
Tobias Grosser75805372011-04-29 06:27:02 +0000920 case ICmpInst::ICMP_UGE:
Tobias Grosserbfbc3692015-01-09 00:01:33 +0000921 return isl_pw_aff_ge_set(L, R);
Tobias Grosser75805372011-04-29 06:27:02 +0000922 default:
923 llvm_unreachable("Non integer predicate not supported");
924 }
Tobias Grosser75805372011-04-29 06:27:02 +0000925}
926
Tobias Grossere19661e2011-10-07 08:46:57 +0000927__isl_give isl_set *ScopStmt::addLoopBoundsToDomain(__isl_take isl_set *Domain,
Tobias Grosser60b54f12011-11-08 15:41:28 +0000928 TempScop &tempScop) {
Tobias Grossere19661e2011-10-07 08:46:57 +0000929 isl_space *Space;
930 isl_local_space *LocalSpace;
Tobias Grosser75805372011-04-29 06:27:02 +0000931
Tobias Grossere19661e2011-10-07 08:46:57 +0000932 Space = isl_set_get_space(Domain);
933 LocalSpace = isl_local_space_from_space(Space);
Tobias Grosserf5338802011-10-06 00:03:35 +0000934
Johannes Doerfert5ad8a6a2014-11-01 01:14:56 +0000935 ScalarEvolution *SE = getParent()->getSE();
Tobias Grosser75805372011-04-29 06:27:02 +0000936 for (int i = 0, e = getNumIterators(); i != e; ++i) {
Tobias Grosser9b13d3d2011-10-06 22:32:58 +0000937 isl_aff *Zero = isl_aff_zero_on_domain(isl_local_space_copy(LocalSpace));
Tobias Grosserabfbe632013-02-05 12:09:06 +0000938 isl_pw_aff *IV =
939 isl_pw_aff_from_aff(isl_aff_set_coefficient_si(Zero, isl_dim_in, i, 1));
Tobias Grosser75805372011-04-29 06:27:02 +0000940
Tobias Grosser9b13d3d2011-10-06 22:32:58 +0000941 // 0 <= IV.
942 isl_set *LowerBound = isl_pw_aff_nonneg_set(isl_pw_aff_copy(IV));
943 Domain = isl_set_intersect(Domain, LowerBound);
944
945 // IV <= LatchExecutions.
Hongbin Zheng27f3afb2011-04-30 03:26:51 +0000946 const Loop *L = getLoopForDimension(i);
Johannes Doerfert5ad8a6a2014-11-01 01:14:56 +0000947 const SCEV *LatchExecutions = SE->getBackedgeTakenCount(L);
Tobias Grosser9b13d3d2011-10-06 22:32:58 +0000948 isl_pw_aff *UpperBound = SCEVAffinator::getPwAff(this, LatchExecutions);
949 isl_set *UpperBoundSet = isl_pw_aff_le_set(IV, UpperBound);
Tobias Grosser75805372011-04-29 06:27:02 +0000950 Domain = isl_set_intersect(Domain, UpperBoundSet);
951 }
952
Tobias Grosserf5338802011-10-06 00:03:35 +0000953 isl_local_space_free(LocalSpace);
Tobias Grossere19661e2011-10-07 08:46:57 +0000954 return Domain;
Tobias Grosser75805372011-04-29 06:27:02 +0000955}
956
Tobias Grossere602a072013-05-07 07:30:56 +0000957__isl_give isl_set *ScopStmt::addConditionsToDomain(__isl_take isl_set *Domain,
958 TempScop &tempScop,
959 const Region &CurRegion) {
Tobias Grossere19661e2011-10-07 08:46:57 +0000960 const Region *TopRegion = tempScop.getMaxRegion().getParent(),
Tobias Grosserd7e58642013-04-10 06:55:45 +0000961 *CurrentRegion = &CurRegion;
Johannes Doerfertff9d1982015-02-24 12:00:50 +0000962 const BasicBlock *BranchingBB = BB ? BB : R->getEntry();
Tobias Grosser75805372011-04-29 06:27:02 +0000963
Tobias Grosser75805372011-04-29 06:27:02 +0000964 do {
Tobias Grossere19661e2011-10-07 08:46:57 +0000965 if (BranchingBB != CurrentRegion->getEntry()) {
966 if (const BBCond *Condition = tempScop.getBBCond(BranchingBB))
Tobias Grosser083d3d32014-06-28 08:59:45 +0000967 for (const auto &C : *Condition) {
968 isl_set *ConditionSet = buildConditionSet(C);
Tobias Grossere19661e2011-10-07 08:46:57 +0000969 Domain = isl_set_intersect(Domain, ConditionSet);
Tobias Grosser75805372011-04-29 06:27:02 +0000970 }
971 }
Tobias Grossere19661e2011-10-07 08:46:57 +0000972 BranchingBB = CurrentRegion->getEntry();
973 CurrentRegion = CurrentRegion->getParent();
974 } while (TopRegion != CurrentRegion);
Tobias Grosser75805372011-04-29 06:27:02 +0000975
Tobias Grossere19661e2011-10-07 08:46:57 +0000976 return Domain;
Tobias Grosser75805372011-04-29 06:27:02 +0000977}
978
Tobias Grossere602a072013-05-07 07:30:56 +0000979__isl_give isl_set *ScopStmt::buildDomain(TempScop &tempScop,
980 const Region &CurRegion) {
Tobias Grossere19661e2011-10-07 08:46:57 +0000981 isl_space *Space;
982 isl_set *Domain;
Tobias Grosser084d8f72012-05-29 09:29:44 +0000983 isl_id *Id;
Tobias Grossere19661e2011-10-07 08:46:57 +0000984
985 Space = isl_space_set_alloc(getIslCtx(), 0, getNumIterators());
986
Tobias Grosser084d8f72012-05-29 09:29:44 +0000987 Id = isl_id_alloc(getIslCtx(), getBaseName(), this);
988
Tobias Grossere19661e2011-10-07 08:46:57 +0000989 Domain = isl_set_universe(Space);
Tobias Grossere19661e2011-10-07 08:46:57 +0000990 Domain = addLoopBoundsToDomain(Domain, tempScop);
991 Domain = addConditionsToDomain(Domain, tempScop, CurRegion);
Tobias Grosser084d8f72012-05-29 09:29:44 +0000992 Domain = isl_set_set_tuple_id(Domain, Id);
Tobias Grossere19661e2011-10-07 08:46:57 +0000993
994 return Domain;
Tobias Grosser75805372011-04-29 06:27:02 +0000995}
996
Tobias Grosser7b50bee2014-11-25 10:51:12 +0000997void ScopStmt::deriveAssumptionsFromGEP(GetElementPtrInst *GEP) {
998 int Dimension = 0;
999 isl_ctx *Ctx = Parent.getIslCtx();
1000 isl_local_space *LSpace = isl_local_space_from_space(getDomainSpace());
1001 Type *Ty = GEP->getPointerOperandType();
1002 ScalarEvolution &SE = *Parent.getSE();
1003
1004 if (auto *PtrTy = dyn_cast<PointerType>(Ty)) {
1005 Dimension = 1;
1006 Ty = PtrTy->getElementType();
1007 }
1008
1009 while (auto ArrayTy = dyn_cast<ArrayType>(Ty)) {
1010 unsigned int Operand = 1 + Dimension;
1011
1012 if (GEP->getNumOperands() <= Operand)
1013 break;
1014
1015 const SCEV *Expr = SE.getSCEV(GEP->getOperand(Operand));
1016
1017 if (isAffineExpr(&Parent.getRegion(), Expr, SE)) {
1018 isl_pw_aff *AccessOffset = SCEVAffinator::getPwAff(this, Expr);
1019 AccessOffset =
1020 isl_pw_aff_set_tuple_id(AccessOffset, isl_dim_in, getDomainId());
1021
1022 isl_pw_aff *DimSize = isl_pw_aff_from_aff(isl_aff_val_on_domain(
1023 isl_local_space_copy(LSpace),
1024 isl_val_int_from_si(Ctx, ArrayTy->getNumElements())));
1025
1026 isl_set *OutOfBound = isl_pw_aff_ge_set(AccessOffset, DimSize);
1027 OutOfBound = isl_set_intersect(getDomain(), OutOfBound);
1028 OutOfBound = isl_set_params(OutOfBound);
1029 isl_set *InBound = isl_set_complement(OutOfBound);
1030 isl_set *Executed = isl_set_params(getDomain());
1031
1032 // A => B == !A or B
1033 isl_set *InBoundIfExecuted =
1034 isl_set_union(isl_set_complement(Executed), InBound);
1035
1036 Parent.addAssumption(InBoundIfExecuted);
1037 }
1038
1039 Dimension += 1;
1040 Ty = ArrayTy->getElementType();
1041 }
1042
1043 isl_local_space_free(LSpace);
1044}
1045
Johannes Doerfertff9d1982015-02-24 12:00:50 +00001046void ScopStmt::deriveAssumptions(BasicBlock *Block) {
1047 for (Instruction &Inst : *Block)
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001048 if (auto *GEP = dyn_cast<GetElementPtrInst>(&Inst))
1049 deriveAssumptionsFromGEP(GEP);
1050}
1051
Tobias Grosser74394f02013-01-14 22:40:23 +00001052ScopStmt::ScopStmt(Scop &parent, TempScop &tempScop, const Region &CurRegion,
Johannes Doerfertff9d1982015-02-24 12:00:50 +00001053 Region &R, SmallVectorImpl<Loop *> &Nest,
Tobias Grosser54839312015-04-21 11:37:25 +00001054 SmallVectorImpl<unsigned> &ScheduleVec)
Johannes Doerfertff9d1982015-02-24 12:00:50 +00001055 : Parent(parent), BB(nullptr), R(&R), Build(nullptr),
1056 NestLoops(Nest.size()) {
1057 // Setup the induction variables.
1058 for (unsigned i = 0, e = Nest.size(); i < e; ++i)
1059 NestLoops[i] = Nest[i];
1060
1061 BaseName = getIslCompatibleName("Stmt_(", R.getNameStr(), ")");
1062
1063 Domain = buildDomain(tempScop, CurRegion);
Tobias Grosser54839312015-04-21 11:37:25 +00001064 buildSchedule(ScheduleVec);
Johannes Doerfertff9d1982015-02-24 12:00:50 +00001065
1066 BasicBlock *EntryBB = R.getEntry();
1067 for (BasicBlock *Block : R.blocks()) {
1068 buildAccesses(tempScop, Block, Block != EntryBB);
1069 deriveAssumptions(Block);
1070 }
1071 checkForReductions();
1072}
1073
1074ScopStmt::ScopStmt(Scop &parent, TempScop &tempScop, const Region &CurRegion,
Sebastian Pop860e0212013-02-15 21:26:44 +00001075 BasicBlock &bb, SmallVectorImpl<Loop *> &Nest,
Tobias Grosser54839312015-04-21 11:37:25 +00001076 SmallVectorImpl<unsigned> &ScheduleVec)
Johannes Doerfertff9d1982015-02-24 12:00:50 +00001077 : Parent(parent), BB(&bb), R(nullptr), Build(nullptr),
1078 NestLoops(Nest.size()) {
Tobias Grosser75805372011-04-29 06:27:02 +00001079 // Setup the induction variables.
Tobias Grosser683b8e42014-11-30 14:33:31 +00001080 for (unsigned i = 0, e = Nest.size(); i < e; ++i)
Sebastian Pop860e0212013-02-15 21:26:44 +00001081 NestLoops[i] = Nest[i];
Tobias Grosser75805372011-04-29 06:27:02 +00001082
Johannes Doerfert79fc23f2014-07-24 23:48:02 +00001083 BaseName = getIslCompatibleName("Stmt_", &bb, "");
Tobias Grosser75805372011-04-29 06:27:02 +00001084
Tobias Grossere19661e2011-10-07 08:46:57 +00001085 Domain = buildDomain(tempScop, CurRegion);
Tobias Grosser54839312015-04-21 11:37:25 +00001086 buildSchedule(ScheduleVec);
Johannes Doerfertff9d1982015-02-24 12:00:50 +00001087 buildAccesses(tempScop, BB);
1088 deriveAssumptions(BB);
Johannes Doerferte58a0122014-06-27 20:31:28 +00001089 checkForReductions();
Johannes Doerfert0ee1f212014-06-17 17:31:36 +00001090}
1091
Johannes Doerferte58a0122014-06-27 20:31:28 +00001092/// @brief Collect loads which might form a reduction chain with @p StoreMA
1093///
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00001094/// Check if the stored value for @p StoreMA is a binary operator with one or
1095/// two loads as operands. If the binary operand is commutative & associative,
Johannes Doerferte58a0122014-06-27 20:31:28 +00001096/// used only once (by @p StoreMA) and its load operands are also used only
1097/// once, we have found a possible reduction chain. It starts at an operand
1098/// load and includes the binary operator and @p StoreMA.
1099///
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00001100/// Note: We allow only one use to ensure the load and binary operator cannot
Johannes Doerferte58a0122014-06-27 20:31:28 +00001101/// escape this block or into any other store except @p StoreMA.
1102void ScopStmt::collectCandiateReductionLoads(
1103 MemoryAccess *StoreMA, SmallVectorImpl<MemoryAccess *> &Loads) {
1104 auto *Store = dyn_cast<StoreInst>(StoreMA->getAccessInstruction());
1105 if (!Store)
Johannes Doerfert0ee1f212014-06-17 17:31:36 +00001106 return;
1107
1108 // Skip if there is not one binary operator between the load and the store
1109 auto *BinOp = dyn_cast<BinaryOperator>(Store->getValueOperand());
Johannes Doerferte58a0122014-06-27 20:31:28 +00001110 if (!BinOp)
1111 return;
1112
1113 // Skip if the binary operators has multiple uses
1114 if (BinOp->getNumUses() != 1)
Johannes Doerfert0ee1f212014-06-17 17:31:36 +00001115 return;
1116
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00001117 // Skip if the opcode of the binary operator is not commutative/associative
Johannes Doerfert0ee1f212014-06-17 17:31:36 +00001118 if (!BinOp->isCommutative() || !BinOp->isAssociative())
1119 return;
1120
Johannes Doerfert9890a052014-07-01 00:32:29 +00001121 // Skip if the binary operator is outside the current SCoP
1122 if (BinOp->getParent() != Store->getParent())
1123 return;
1124
Johannes Doerfert0ee1f212014-06-17 17:31:36 +00001125 // Skip if it is a multiplicative reduction and we disabled them
1126 if (DisableMultiplicativeReductions &&
1127 (BinOp->getOpcode() == Instruction::Mul ||
1128 BinOp->getOpcode() == Instruction::FMul))
1129 return;
1130
Johannes Doerferte58a0122014-06-27 20:31:28 +00001131 // Check the binary operator operands for a candidate load
1132 auto *PossibleLoad0 = dyn_cast<LoadInst>(BinOp->getOperand(0));
1133 auto *PossibleLoad1 = dyn_cast<LoadInst>(BinOp->getOperand(1));
1134 if (!PossibleLoad0 && !PossibleLoad1)
1135 return;
1136
1137 // A load is only a candidate if it cannot escape (thus has only this use)
1138 if (PossibleLoad0 && PossibleLoad0->getNumUses() == 1)
Johannes Doerfert9890a052014-07-01 00:32:29 +00001139 if (PossibleLoad0->getParent() == Store->getParent())
1140 Loads.push_back(lookupAccessFor(PossibleLoad0));
Johannes Doerferte58a0122014-06-27 20:31:28 +00001141 if (PossibleLoad1 && PossibleLoad1->getNumUses() == 1)
Johannes Doerfert9890a052014-07-01 00:32:29 +00001142 if (PossibleLoad1->getParent() == Store->getParent())
1143 Loads.push_back(lookupAccessFor(PossibleLoad1));
Johannes Doerferte58a0122014-06-27 20:31:28 +00001144}
1145
1146/// @brief Check for reductions in this ScopStmt
1147///
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00001148/// Iterate over all store memory accesses and check for valid binary reduction
1149/// like chains. For all candidates we check if they have the same base address
1150/// and there are no other accesses which overlap with them. The base address
1151/// check rules out impossible reductions candidates early. The overlap check,
1152/// together with the "only one user" check in collectCandiateReductionLoads,
Johannes Doerferte58a0122014-06-27 20:31:28 +00001153/// guarantees that none of the intermediate results will escape during
1154/// execution of the loop nest. We basically check here that no other memory
1155/// access can access the same memory as the potential reduction.
1156void ScopStmt::checkForReductions() {
1157 SmallVector<MemoryAccess *, 2> Loads;
1158 SmallVector<std::pair<MemoryAccess *, MemoryAccess *>, 4> Candidates;
1159
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00001160 // First collect candidate load-store reduction chains by iterating over all
Johannes Doerferte58a0122014-06-27 20:31:28 +00001161 // stores and collecting possible reduction loads.
1162 for (MemoryAccess *StoreMA : MemAccs) {
1163 if (StoreMA->isRead())
1164 continue;
1165
1166 Loads.clear();
1167 collectCandiateReductionLoads(StoreMA, Loads);
1168 for (MemoryAccess *LoadMA : Loads)
1169 Candidates.push_back(std::make_pair(LoadMA, StoreMA));
1170 }
1171
1172 // Then check each possible candidate pair.
1173 for (const auto &CandidatePair : Candidates) {
1174 bool Valid = true;
1175 isl_map *LoadAccs = CandidatePair.first->getAccessRelation();
1176 isl_map *StoreAccs = CandidatePair.second->getAccessRelation();
1177
1178 // Skip those with obviously unequal base addresses.
1179 if (!isl_map_has_equal_space(LoadAccs, StoreAccs)) {
1180 isl_map_free(LoadAccs);
1181 isl_map_free(StoreAccs);
1182 continue;
1183 }
1184
1185 // And check if the remaining for overlap with other memory accesses.
1186 isl_map *AllAccsRel = isl_map_union(LoadAccs, StoreAccs);
1187 AllAccsRel = isl_map_intersect_domain(AllAccsRel, getDomain());
1188 isl_set *AllAccs = isl_map_range(AllAccsRel);
1189
1190 for (MemoryAccess *MA : MemAccs) {
1191 if (MA == CandidatePair.first || MA == CandidatePair.second)
1192 continue;
1193
1194 isl_map *AccRel =
1195 isl_map_intersect_domain(MA->getAccessRelation(), getDomain());
1196 isl_set *Accs = isl_map_range(AccRel);
1197
1198 if (isl_set_has_equal_space(AllAccs, Accs) || isl_set_free(Accs)) {
1199 isl_set *OverlapAccs = isl_set_intersect(Accs, isl_set_copy(AllAccs));
1200 Valid = Valid && isl_set_is_empty(OverlapAccs);
1201 isl_set_free(OverlapAccs);
1202 }
1203 }
1204
1205 isl_set_free(AllAccs);
1206 if (!Valid)
1207 continue;
1208
Johannes Doerfertf6183392014-07-01 20:52:51 +00001209 const LoadInst *Load =
1210 dyn_cast<const LoadInst>(CandidatePair.first->getAccessInstruction());
1211 MemoryAccess::ReductionType RT =
1212 getReductionType(dyn_cast<BinaryOperator>(Load->user_back()), Load);
1213
Johannes Doerferte58a0122014-06-27 20:31:28 +00001214 // If no overlapping access was found we mark the load and store as
1215 // reduction like.
Johannes Doerfertf6183392014-07-01 20:52:51 +00001216 CandidatePair.first->markAsReductionLike(RT);
1217 CandidatePair.second->markAsReductionLike(RT);
Johannes Doerferte58a0122014-06-27 20:31:28 +00001218 }
Tobias Grosser75805372011-04-29 06:27:02 +00001219}
1220
Tobias Grosser74394f02013-01-14 22:40:23 +00001221std::string ScopStmt::getDomainStr() const { return stringFromIslObj(Domain); }
Tobias Grosser75805372011-04-29 06:27:02 +00001222
Tobias Grosser54839312015-04-21 11:37:25 +00001223std::string ScopStmt::getScheduleStr() const {
1224 return stringFromIslObj(Schedule);
Tobias Grosser75805372011-04-29 06:27:02 +00001225}
1226
Tobias Grosser74394f02013-01-14 22:40:23 +00001227unsigned ScopStmt::getNumParams() const { return Parent.getNumParams(); }
Tobias Grosser75805372011-04-29 06:27:02 +00001228
Tobias Grosserf567e1a2015-02-19 22:16:12 +00001229unsigned ScopStmt::getNumIterators() const { return NestLoops.size(); }
Tobias Grosser75805372011-04-29 06:27:02 +00001230
Tobias Grosser54839312015-04-21 11:37:25 +00001231unsigned ScopStmt::getNumSchedule() const {
1232 return isl_map_dim(Schedule, isl_dim_out);
Tobias Grosser75805372011-04-29 06:27:02 +00001233}
1234
1235const char *ScopStmt::getBaseName() const { return BaseName.c_str(); }
1236
Hongbin Zheng27f3afb2011-04-30 03:26:51 +00001237const Loop *ScopStmt::getLoopForDimension(unsigned Dimension) const {
Sebastian Pop860e0212013-02-15 21:26:44 +00001238 return NestLoops[Dimension];
Tobias Grosser75805372011-04-29 06:27:02 +00001239}
1240
Tobias Grosser74394f02013-01-14 22:40:23 +00001241isl_ctx *ScopStmt::getIslCtx() const { return Parent.getIslCtx(); }
Tobias Grosser75805372011-04-29 06:27:02 +00001242
Tobias Grosser4f663aa2015-03-30 11:52:59 +00001243__isl_give isl_set *ScopStmt::getDomain() const { return isl_set_copy(Domain); }
Tobias Grosserd5a7bfc2011-05-06 19:52:19 +00001244
Tobias Grosser6e6c7e02015-03-30 12:22:39 +00001245__isl_give isl_space *ScopStmt::getDomainSpace() const {
Tobias Grosser78d8a3d2012-01-17 20:34:23 +00001246 return isl_set_get_space(Domain);
1247}
1248
Tobias Grosser4f663aa2015-03-30 11:52:59 +00001249__isl_give isl_id *ScopStmt::getDomainId() const {
1250 return isl_set_get_tuple_id(Domain);
1251}
Tobias Grossercd95b772012-08-30 11:49:38 +00001252
Tobias Grosser75805372011-04-29 06:27:02 +00001253ScopStmt::~ScopStmt() {
Johannes Doerfertecff11d2015-05-22 23:43:58 +00001254 DeleteContainerSeconds(InstructionToAccess);
Tobias Grosser75805372011-04-29 06:27:02 +00001255 isl_set_free(Domain);
Tobias Grosser54839312015-04-21 11:37:25 +00001256 isl_map_free(Schedule);
Tobias Grosser75805372011-04-29 06:27:02 +00001257}
1258
1259void ScopStmt::print(raw_ostream &OS) const {
1260 OS << "\t" << getBaseName() << "\n";
Tobias Grosser75805372011-04-29 06:27:02 +00001261 OS.indent(12) << "Domain :=\n";
1262
1263 if (Domain) {
1264 OS.indent(16) << getDomainStr() << ";\n";
1265 } else
1266 OS.indent(16) << "n/a\n";
1267
Tobias Grosser54839312015-04-21 11:37:25 +00001268 OS.indent(12) << "Schedule :=\n";
Tobias Grosser75805372011-04-29 06:27:02 +00001269
1270 if (Domain) {
Tobias Grosser54839312015-04-21 11:37:25 +00001271 OS.indent(16) << getScheduleStr() << ";\n";
Tobias Grosser75805372011-04-29 06:27:02 +00001272 } else
1273 OS.indent(16) << "n/a\n";
1274
Tobias Grosser083d3d32014-06-28 08:59:45 +00001275 for (MemoryAccess *Access : MemAccs)
1276 Access->print(OS);
Tobias Grosser75805372011-04-29 06:27:02 +00001277}
1278
1279void ScopStmt::dump() const { print(dbgs()); }
1280
1281//===----------------------------------------------------------------------===//
1282/// Scop class implement
Tobias Grosser60b54f12011-11-08 15:41:28 +00001283
Tobias Grosser7ffe4e82011-11-17 12:56:10 +00001284void Scop::setContext(__isl_take isl_set *NewContext) {
Tobias Grosserff9b54d2011-11-15 11:38:44 +00001285 NewContext = isl_set_align_params(NewContext, isl_set_get_space(Context));
1286 isl_set_free(Context);
1287 Context = NewContext;
1288}
1289
Tobias Grosserabfbe632013-02-05 12:09:06 +00001290void Scop::addParams(std::vector<const SCEV *> NewParameters) {
Tobias Grosser083d3d32014-06-28 08:59:45 +00001291 for (const SCEV *Parameter : NewParameters) {
Johannes Doerfertbe409962015-03-29 20:45:09 +00001292 Parameter = extractConstantFactor(Parameter, *SE).second;
Tobias Grosser60b54f12011-11-08 15:41:28 +00001293 if (ParameterIds.find(Parameter) != ParameterIds.end())
1294 continue;
1295
1296 int dimension = Parameters.size();
1297
1298 Parameters.push_back(Parameter);
1299 ParameterIds[Parameter] = dimension;
1300 }
1301}
1302
Tobias Grosser9a38ab82011-11-08 15:41:03 +00001303__isl_give isl_id *Scop::getIdForParam(const SCEV *Parameter) const {
1304 ParamIdType::const_iterator IdIter = ParameterIds.find(Parameter);
Tobias Grosser76c2e322011-11-07 12:58:59 +00001305
Tobias Grosser9a38ab82011-11-08 15:41:03 +00001306 if (IdIter == ParameterIds.end())
Tobias Grosser5a56cbf2014-04-16 07:33:47 +00001307 return nullptr;
Tobias Grosser76c2e322011-11-07 12:58:59 +00001308
Tobias Grosser8f99c162011-11-15 11:38:55 +00001309 std::string ParameterName;
1310
1311 if (const SCEVUnknown *ValueParameter = dyn_cast<SCEVUnknown>(Parameter)) {
1312 Value *Val = ValueParameter->getValue();
Tobias Grosser29ee0b12011-11-17 14:52:36 +00001313 ParameterName = Val->getName();
Tobias Grosser8f99c162011-11-15 11:38:55 +00001314 }
1315
1316 if (ParameterName == "" || ParameterName.substr(0, 2) == "p_")
Hongbin Zheng86a37742012-04-25 08:01:38 +00001317 ParameterName = "p_" + utostr_32(IdIter->second);
Tobias Grosser8f99c162011-11-15 11:38:55 +00001318
Tobias Grosser20532b82014-04-11 17:56:49 +00001319 return isl_id_alloc(getIslCtx(), ParameterName.c_str(),
1320 const_cast<void *>((const void *)Parameter));
Tobias Grosser76c2e322011-11-07 12:58:59 +00001321}
Tobias Grosser75805372011-04-29 06:27:02 +00001322
Tobias Grosser6be480c2011-11-08 15:41:13 +00001323void Scop::buildContext() {
1324 isl_space *Space = isl_space_params_alloc(IslCtx, 0);
Tobias Grossere86109f2013-10-29 21:05:49 +00001325 Context = isl_set_universe(isl_space_copy(Space));
1326 AssumedContext = isl_set_universe(Space);
Tobias Grosser0e27e242011-10-06 00:03:48 +00001327}
1328
Tobias Grosser18daaca2012-05-22 10:47:27 +00001329void Scop::addParameterBounds() {
Johannes Doerfert4f8ac3d2015-02-23 16:15:51 +00001330 for (const auto &ParamID : ParameterIds) {
Johannes Doerfert4f8ac3d2015-02-23 16:15:51 +00001331 int dim = ParamID.second;
Tobias Grosser18daaca2012-05-22 10:47:27 +00001332
Johannes Doerfert4f8ac3d2015-02-23 16:15:51 +00001333 ConstantRange SRange = SE->getSignedRange(ParamID.first);
Tobias Grosser18daaca2012-05-22 10:47:27 +00001334
Johannes Doerferte7044942015-02-24 11:58:30 +00001335 Context = addRangeBoundsToSet(Context, SRange, dim, isl_dim_param);
Tobias Grosser18daaca2012-05-22 10:47:27 +00001336 }
1337}
1338
Tobias Grosser8cae72f2011-11-08 15:41:08 +00001339void Scop::realignParams() {
Tobias Grosser6be480c2011-11-08 15:41:13 +00001340 // Add all parameters into a common model.
Tobias Grosser60b54f12011-11-08 15:41:28 +00001341 isl_space *Space = isl_space_params_alloc(IslCtx, ParameterIds.size());
Tobias Grosser6be480c2011-11-08 15:41:13 +00001342
Tobias Grosser083d3d32014-06-28 08:59:45 +00001343 for (const auto &ParamID : ParameterIds) {
1344 const SCEV *Parameter = ParamID.first;
Tobias Grosser6be480c2011-11-08 15:41:13 +00001345 isl_id *id = getIdForParam(Parameter);
Tobias Grosser083d3d32014-06-28 08:59:45 +00001346 Space = isl_space_set_dim_id(Space, isl_dim_param, ParamID.second, id);
Tobias Grosser6be480c2011-11-08 15:41:13 +00001347 }
1348
1349 // Align the parameters of all data structures to the model.
1350 Context = isl_set_align_params(Context, Space);
1351
Tobias Grosser7c3bad52015-05-27 05:16:57 +00001352 for (ScopStmt &Stmt : *this)
1353 Stmt.realignParams();
Tobias Grosser8cae72f2011-11-08 15:41:08 +00001354}
1355
Tobias Grosser5e6813d2014-07-02 17:47:48 +00001356void Scop::simplifyAssumedContext() {
1357 // The parameter constraints of the iteration domains give us a set of
1358 // constraints that need to hold for all cases where at least a single
1359 // statement iteration is executed in the whole scop. We now simplify the
1360 // assumed context under the assumption that such constraints hold and at
1361 // least a single statement iteration is executed. For cases where no
1362 // statement instances are executed, the assumptions we have taken about
1363 // the executed code do not matter and can be changed.
1364 //
1365 // WARNING: This only holds if the assumptions we have taken do not reduce
1366 // the set of statement instances that are executed. Otherwise we
1367 // may run into a case where the iteration domains suggest that
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00001368 // for a certain set of parameter constraints no code is executed,
Tobias Grosser5e6813d2014-07-02 17:47:48 +00001369 // but in the original program some computation would have been
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00001370 // performed. In such a case, modifying the run-time conditions and
1371 // possibly influencing the run-time check may cause certain scops
Tobias Grosser5e6813d2014-07-02 17:47:48 +00001372 // to not be executed.
1373 //
1374 // Example:
1375 //
1376 // When delinearizing the following code:
1377 //
1378 // for (long i = 0; i < 100; i++)
1379 // for (long j = 0; j < m; j++)
1380 // A[i+p][j] = 1.0;
1381 //
1382 // we assume that the condition m <= 0 or (m >= 1 and p >= 0) holds as
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00001383 // otherwise we would access out of bound data. Now, knowing that code is
Tobias Grosser5e6813d2014-07-02 17:47:48 +00001384 // only executed for the case m >= 0, it is sufficient to assume p >= 0.
1385 AssumedContext =
1386 isl_set_gist_params(AssumedContext, isl_union_set_params(getDomains()));
Johannes Doerfert4f8ac3d2015-02-23 16:15:51 +00001387 AssumedContext = isl_set_gist_params(AssumedContext, getContext());
Tobias Grosser5e6813d2014-07-02 17:47:48 +00001388}
1389
Johannes Doerfertb164c792014-09-18 11:17:17 +00001390/// @brief Add the minimal/maximal access in @p Set to @p User.
1391static int buildMinMaxAccess(__isl_take isl_set *Set, void *User) {
1392 Scop::MinMaxVectorTy *MinMaxAccesses = (Scop::MinMaxVectorTy *)User;
1393 isl_pw_multi_aff *MinPMA, *MaxPMA;
1394 isl_pw_aff *LastDimAff;
1395 isl_aff *OneAff;
1396 unsigned Pos;
1397
Johannes Doerfert9143d672014-09-27 11:02:39 +00001398 // Restrict the number of parameters involved in the access as the lexmin/
1399 // lexmax computation will take too long if this number is high.
1400 //
1401 // Experiments with a simple test case using an i7 4800MQ:
1402 //
1403 // #Parameters involved | Time (in sec)
1404 // 6 | 0.01
1405 // 7 | 0.04
1406 // 8 | 0.12
1407 // 9 | 0.40
1408 // 10 | 1.54
1409 // 11 | 6.78
1410 // 12 | 30.38
1411 //
1412 if (isl_set_n_param(Set) > RunTimeChecksMaxParameters) {
1413 unsigned InvolvedParams = 0;
1414 for (unsigned u = 0, e = isl_set_n_param(Set); u < e; u++)
1415 if (isl_set_involves_dims(Set, isl_dim_param, u, 1))
1416 InvolvedParams++;
1417
1418 if (InvolvedParams > RunTimeChecksMaxParameters) {
1419 isl_set_free(Set);
1420 return -1;
1421 }
1422 }
1423
Johannes Doerfertb6755bb2015-02-14 12:00:06 +00001424 Set = isl_set_remove_divs(Set);
1425
Johannes Doerfertb164c792014-09-18 11:17:17 +00001426 MinPMA = isl_set_lexmin_pw_multi_aff(isl_set_copy(Set));
1427 MaxPMA = isl_set_lexmax_pw_multi_aff(isl_set_copy(Set));
1428
Johannes Doerfert219b20e2014-10-07 14:37:59 +00001429 MinPMA = isl_pw_multi_aff_coalesce(MinPMA);
1430 MaxPMA = isl_pw_multi_aff_coalesce(MaxPMA);
1431
Johannes Doerfertb164c792014-09-18 11:17:17 +00001432 // Adjust the last dimension of the maximal access by one as we want to
1433 // enclose the accessed memory region by MinPMA and MaxPMA. The pointer
1434 // we test during code generation might now point after the end of the
1435 // allocated array but we will never dereference it anyway.
1436 assert(isl_pw_multi_aff_dim(MaxPMA, isl_dim_out) &&
1437 "Assumed at least one output dimension");
1438 Pos = isl_pw_multi_aff_dim(MaxPMA, isl_dim_out) - 1;
1439 LastDimAff = isl_pw_multi_aff_get_pw_aff(MaxPMA, Pos);
1440 OneAff = isl_aff_zero_on_domain(
1441 isl_local_space_from_space(isl_pw_aff_get_domain_space(LastDimAff)));
1442 OneAff = isl_aff_add_constant_si(OneAff, 1);
1443 LastDimAff = isl_pw_aff_add(LastDimAff, isl_pw_aff_from_aff(OneAff));
1444 MaxPMA = isl_pw_multi_aff_set_pw_aff(MaxPMA, Pos, LastDimAff);
1445
1446 MinMaxAccesses->push_back(std::make_pair(MinPMA, MaxPMA));
1447
1448 isl_set_free(Set);
1449 return 0;
1450}
1451
Johannes Doerferteeab05a2014-10-01 12:42:37 +00001452static __isl_give isl_set *getAccessDomain(MemoryAccess *MA) {
1453 isl_set *Domain = MA->getStatement()->getDomain();
1454 Domain = isl_set_project_out(Domain, isl_dim_set, 0, isl_set_n_dim(Domain));
1455 return isl_set_reset_tuple_id(Domain);
1456}
1457
Johannes Doerfert9143d672014-09-27 11:02:39 +00001458bool Scop::buildAliasGroups(AliasAnalysis &AA) {
Johannes Doerfertb164c792014-09-18 11:17:17 +00001459 // To create sound alias checks we perform the following steps:
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00001460 // o) Use the alias analysis and an alias set tracker to build alias sets
Johannes Doerfertb164c792014-09-18 11:17:17 +00001461 // for all memory accesses inside the SCoP.
1462 // o) For each alias set we then map the aliasing pointers back to the
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00001463 // memory accesses we know, thus obtain groups of memory accesses which
Johannes Doerfertb164c792014-09-18 11:17:17 +00001464 // might alias.
Johannes Doerferteeab05a2014-10-01 12:42:37 +00001465 // o) We divide each group based on the domains of the minimal/maximal
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00001466 // accesses. That means two minimal/maximal accesses are only in a group
Johannes Doerferteeab05a2014-10-01 12:42:37 +00001467 // if their access domains intersect, otherwise they are in different
1468 // ones.
Johannes Doerfert13771732014-10-01 12:40:46 +00001469 // o) We split groups such that they contain at most one read only base
1470 // address.
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00001471 // o) For each group with more than one base pointer we then compute minimal
Johannes Doerfertb164c792014-09-18 11:17:17 +00001472 // and maximal accesses to each array in this group.
1473 using AliasGroupTy = SmallVector<MemoryAccess *, 4>;
1474
1475 AliasSetTracker AST(AA);
1476
1477 DenseMap<Value *, MemoryAccess *> PtrToAcc;
Johannes Doerfert13771732014-10-01 12:40:46 +00001478 DenseSet<Value *> HasWriteAccess;
Tobias Grosser7c3bad52015-05-27 05:16:57 +00001479 for (ScopStmt &Stmt : *this) {
Johannes Doerfertf1ee2622014-10-06 17:43:00 +00001480
1481 // Skip statements with an empty domain as they will never be executed.
Tobias Grosser7c3bad52015-05-27 05:16:57 +00001482 isl_set *StmtDomain = Stmt.getDomain();
Johannes Doerfertf1ee2622014-10-06 17:43:00 +00001483 bool StmtDomainEmpty = isl_set_is_empty(StmtDomain);
1484 isl_set_free(StmtDomain);
1485 if (StmtDomainEmpty)
1486 continue;
1487
Tobias Grosser7c3bad52015-05-27 05:16:57 +00001488 for (MemoryAccess *MA : Stmt) {
Johannes Doerfertb164c792014-09-18 11:17:17 +00001489 if (MA->isScalar())
1490 continue;
Johannes Doerfert13771732014-10-01 12:40:46 +00001491 if (!MA->isRead())
1492 HasWriteAccess.insert(MA->getBaseAddr());
Johannes Doerfertb164c792014-09-18 11:17:17 +00001493 Instruction *Acc = MA->getAccessInstruction();
1494 PtrToAcc[getPointerOperand(*Acc)] = MA;
1495 AST.add(Acc);
1496 }
1497 }
1498
1499 SmallVector<AliasGroupTy, 4> AliasGroups;
1500 for (AliasSet &AS : AST) {
Johannes Doerfert74f68692014-10-08 02:23:48 +00001501 if (AS.isMustAlias() || AS.isForwardingAliasSet())
Johannes Doerfertb164c792014-09-18 11:17:17 +00001502 continue;
1503 AliasGroupTy AG;
1504 for (auto PR : AS)
1505 AG.push_back(PtrToAcc[PR.getValue()]);
1506 assert(AG.size() > 1 &&
1507 "Alias groups should contain at least two accesses");
1508 AliasGroups.push_back(std::move(AG));
1509 }
1510
Johannes Doerferteeab05a2014-10-01 12:42:37 +00001511 // Split the alias groups based on their domain.
1512 for (unsigned u = 0; u < AliasGroups.size(); u++) {
1513 AliasGroupTy NewAG;
1514 AliasGroupTy &AG = AliasGroups[u];
1515 AliasGroupTy::iterator AGI = AG.begin();
1516 isl_set *AGDomain = getAccessDomain(*AGI);
1517 while (AGI != AG.end()) {
1518 MemoryAccess *MA = *AGI;
1519 isl_set *MADomain = getAccessDomain(MA);
1520 if (isl_set_is_disjoint(AGDomain, MADomain)) {
1521 NewAG.push_back(MA);
1522 AGI = AG.erase(AGI);
1523 isl_set_free(MADomain);
1524 } else {
1525 AGDomain = isl_set_union(AGDomain, MADomain);
1526 AGI++;
1527 }
1528 }
1529 if (NewAG.size() > 1)
1530 AliasGroups.push_back(std::move(NewAG));
1531 isl_set_free(AGDomain);
1532 }
1533
Tobias Grosserf4c24b22015-04-05 13:11:54 +00001534 MapVector<const Value *, SmallPtrSet<MemoryAccess *, 8>> ReadOnlyPairs;
Johannes Doerfert13771732014-10-01 12:40:46 +00001535 SmallPtrSet<const Value *, 4> NonReadOnlyBaseValues;
1536 for (AliasGroupTy &AG : AliasGroups) {
1537 NonReadOnlyBaseValues.clear();
1538 ReadOnlyPairs.clear();
1539
Johannes Doerferteeab05a2014-10-01 12:42:37 +00001540 if (AG.size() < 2) {
1541 AG.clear();
1542 continue;
1543 }
1544
Johannes Doerfert13771732014-10-01 12:40:46 +00001545 for (auto II = AG.begin(); II != AG.end();) {
1546 Value *BaseAddr = (*II)->getBaseAddr();
1547 if (HasWriteAccess.count(BaseAddr)) {
1548 NonReadOnlyBaseValues.insert(BaseAddr);
1549 II++;
1550 } else {
1551 ReadOnlyPairs[BaseAddr].insert(*II);
1552 II = AG.erase(II);
1553 }
1554 }
1555
1556 // If we don't have read only pointers check if there are at least two
1557 // non read only pointers, otherwise clear the alias group.
1558 if (ReadOnlyPairs.empty()) {
1559 if (NonReadOnlyBaseValues.size() <= 1)
1560 AG.clear();
1561 continue;
1562 }
1563
1564 // If we don't have non read only pointers clear the alias group.
1565 if (NonReadOnlyBaseValues.empty()) {
1566 AG.clear();
1567 continue;
1568 }
1569
1570 // If we have both read only and non read only base pointers we combine
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00001571 // the non read only ones with exactly one read only one at a time into a
Johannes Doerfert13771732014-10-01 12:40:46 +00001572 // new alias group and clear the old alias group in the end.
1573 for (const auto &ReadOnlyPair : ReadOnlyPairs) {
1574 AliasGroupTy AGNonReadOnly = AG;
1575 for (MemoryAccess *MA : ReadOnlyPair.second)
1576 AGNonReadOnly.push_back(MA);
1577 AliasGroups.push_back(std::move(AGNonReadOnly));
1578 }
1579 AG.clear();
Johannes Doerfertb164c792014-09-18 11:17:17 +00001580 }
1581
1582 for (AliasGroupTy &AG : AliasGroups) {
Johannes Doerfert13771732014-10-01 12:40:46 +00001583 if (AG.empty())
1584 continue;
1585
Johannes Doerfertb164c792014-09-18 11:17:17 +00001586 MinMaxVectorTy *MinMaxAccesses = new MinMaxVectorTy();
1587 MinMaxAccesses->reserve(AG.size());
1588
1589 isl_union_map *Accesses = isl_union_map_empty(getParamSpace());
1590 for (MemoryAccess *MA : AG)
1591 Accesses = isl_union_map_add_map(Accesses, MA->getAccessRelation());
1592 Accesses = isl_union_map_intersect_domain(Accesses, getDomains());
1593
1594 isl_union_set *Locations = isl_union_map_range(Accesses);
1595 Locations = isl_union_set_intersect_params(Locations, getAssumedContext());
1596 Locations = isl_union_set_coalesce(Locations);
1597 Locations = isl_union_set_detect_equalities(Locations);
Tobias Grosser50d4e2e2015-03-28 14:50:32 +00001598 bool Valid = (0 == isl_union_set_foreach_set(Locations, buildMinMaxAccess,
1599 MinMaxAccesses));
Johannes Doerfertb164c792014-09-18 11:17:17 +00001600 isl_union_set_free(Locations);
Johannes Doerfertb164c792014-09-18 11:17:17 +00001601 MinMaxAliasGroups.push_back(MinMaxAccesses);
Johannes Doerfert9143d672014-09-27 11:02:39 +00001602
1603 if (!Valid)
Tobias Grosser50d4e2e2015-03-28 14:50:32 +00001604 return false;
Johannes Doerfertb164c792014-09-18 11:17:17 +00001605 }
Johannes Doerfert9143d672014-09-27 11:02:39 +00001606
Tobias Grosser71500722015-03-28 15:11:14 +00001607 // Bail out if the number of values we need to compare is too large.
1608 // This is important as the number of comparisions grows quadratically with
1609 // the number of values we need to compare.
1610 for (const auto *Values : MinMaxAliasGroups)
1611 if (Values->size() > RunTimeChecksMaxArraysPerGroup)
1612 return false;
1613
Tobias Grosser50d4e2e2015-03-28 14:50:32 +00001614 return true;
Johannes Doerfertb164c792014-09-18 11:17:17 +00001615}
1616
Johannes Doerfertf8206cf2015-04-12 22:58:40 +00001617static unsigned getMaxLoopDepthInRegion(const Region &R, LoopInfo &LI,
1618 ScopDetection &SD) {
1619
1620 const ScopDetection::BoxedLoopsSetTy *BoxedLoops = SD.getBoxedLoops(&R);
1621
Johannes Doerferte3da05a2014-11-01 00:12:13 +00001622 unsigned MinLD = INT_MAX, MaxLD = 0;
1623 for (BasicBlock *BB : R.blocks()) {
1624 if (Loop *L = LI.getLoopFor(BB)) {
David Peixottodc0a11c2015-01-13 18:31:55 +00001625 if (!R.contains(L))
1626 continue;
Johannes Doerfertf8206cf2015-04-12 22:58:40 +00001627 if (BoxedLoops && BoxedLoops->count(L))
1628 continue;
Johannes Doerferte3da05a2014-11-01 00:12:13 +00001629 unsigned LD = L->getLoopDepth();
1630 MinLD = std::min(MinLD, LD);
1631 MaxLD = std::max(MaxLD, LD);
1632 }
1633 }
1634
1635 // Handle the case that there is no loop in the SCoP first.
1636 if (MaxLD == 0)
1637 return 1;
1638
1639 assert(MinLD >= 1 && "Minimal loop depth should be at least one");
1640 assert(MaxLD >= MinLD &&
1641 "Maximal loop depth was smaller than mininaml loop depth?");
1642 return MaxLD - MinLD + 1;
1643}
1644
Tobias Grosser3f296192015-01-01 23:01:11 +00001645void Scop::dropConstantScheduleDims() {
1646 isl_union_map *FullSchedule = getSchedule();
1647
1648 if (isl_union_map_n_map(FullSchedule) == 0) {
1649 isl_union_map_free(FullSchedule);
1650 return;
1651 }
1652
1653 isl_set *ScheduleSpace =
1654 isl_set_from_union_set(isl_union_map_range(FullSchedule));
1655 isl_map *DropDimMap = isl_set_identity(isl_set_copy(ScheduleSpace));
1656
1657 int NumDimsDropped = 0;
Johannes Doerfert3f21e272015-03-04 22:23:21 +00001658 for (unsigned i = 0; i < isl_set_dim(ScheduleSpace, isl_dim_set); i += 2) {
1659 isl_val *FixedVal =
1660 isl_set_plain_get_val_if_fixed(ScheduleSpace, isl_dim_set, i);
1661 if (isl_val_is_int(FixedVal)) {
1662 DropDimMap =
1663 isl_map_project_out(DropDimMap, isl_dim_out, i - NumDimsDropped, 1);
1664 NumDimsDropped++;
Tobias Grosser3f296192015-01-01 23:01:11 +00001665 }
Johannes Doerfert3f21e272015-03-04 22:23:21 +00001666 isl_val_free(FixedVal);
1667 }
Tobias Grosser3f296192015-01-01 23:01:11 +00001668
Tobias Grosser7c3bad52015-05-27 05:16:57 +00001669 for (ScopStmt &Stmt : *this) {
1670 isl_map *Schedule = Stmt.getSchedule();
Tobias Grosser3f296192015-01-01 23:01:11 +00001671 Schedule = isl_map_apply_range(Schedule, isl_map_copy(DropDimMap));
Tobias Grosser7c3bad52015-05-27 05:16:57 +00001672 Stmt.setSchedule(Schedule);
Tobias Grosser3f296192015-01-01 23:01:11 +00001673 }
1674 isl_set_free(ScheduleSpace);
1675 isl_map_free(DropDimMap);
1676}
1677
Tobias Grosser0e27e242011-10-06 00:03:48 +00001678Scop::Scop(TempScop &tempScop, LoopInfo &LI, ScalarEvolution &ScalarEvolution,
Johannes Doerfertff9d1982015-02-24 12:00:50 +00001679 ScopDetection &SD, isl_ctx *Context)
Johannes Doerfert7ceb0402015-02-11 17:25:09 +00001680 : SE(&ScalarEvolution), R(tempScop.getMaxRegion()), IsOptimized(false),
Johannes Doerfertf8206cf2015-04-12 22:58:40 +00001681 MaxLoopDepth(getMaxLoopDepthInRegion(tempScop.getMaxRegion(), LI, SD)) {
Tobias Grosser9a38ab82011-11-08 15:41:03 +00001682 IslCtx = Context;
Johannes Doerfertff9d1982015-02-24 12:00:50 +00001683
Tobias Grosser6be480c2011-11-08 15:41:13 +00001684 buildContext();
Tobias Grosser75805372011-04-29 06:27:02 +00001685
Tobias Grosserabfbe632013-02-05 12:09:06 +00001686 SmallVector<Loop *, 8> NestLoops;
Tobias Grosser54839312015-04-21 11:37:25 +00001687 SmallVector<unsigned, 8> Schedule;
Tobias Grosser75805372011-04-29 06:27:02 +00001688
Tobias Grosser54839312015-04-21 11:37:25 +00001689 Schedule.assign(MaxLoopDepth + 1, 0);
Tobias Grosser75805372011-04-29 06:27:02 +00001690
Tobias Grosser54839312015-04-21 11:37:25 +00001691 // Build the iteration domain, access functions and schedule functions
Tobias Grosser75805372011-04-29 06:27:02 +00001692 // traversing the region tree.
Tobias Grosser54839312015-04-21 11:37:25 +00001693 buildScop(tempScop, getRegion(), NestLoops, Schedule, LI, SD);
Tobias Grosser75805372011-04-29 06:27:02 +00001694
Tobias Grosser8cae72f2011-11-08 15:41:08 +00001695 realignParams();
Tobias Grosser18daaca2012-05-22 10:47:27 +00001696 addParameterBounds();
Tobias Grosser5e6813d2014-07-02 17:47:48 +00001697 simplifyAssumedContext();
Tobias Grosser3f296192015-01-01 23:01:11 +00001698 dropConstantScheduleDims();
Tobias Grosser8cae72f2011-11-08 15:41:08 +00001699
Tobias Grosser75805372011-04-29 06:27:02 +00001700 assert(NestLoops.empty() && "NestLoops not empty at top level!");
1701}
1702
1703Scop::~Scop() {
1704 isl_set_free(Context);
Tobias Grossere86109f2013-10-29 21:05:49 +00001705 isl_set_free(AssumedContext);
Tobias Grosser75805372011-04-29 06:27:02 +00001706
Johannes Doerfertb164c792014-09-18 11:17:17 +00001707 // Free the alias groups
1708 for (MinMaxVectorTy *MinMaxAccesses : MinMaxAliasGroups) {
1709 for (MinMaxAccessTy &MMA : *MinMaxAccesses) {
1710 isl_pw_multi_aff_free(MMA.first);
1711 isl_pw_multi_aff_free(MMA.second);
1712 }
1713 delete MinMaxAccesses;
1714 }
Tobias Grosser75805372011-04-29 06:27:02 +00001715}
1716
Johannes Doerfert80ef1102014-11-07 08:31:31 +00001717const ScopArrayInfo *
1718Scop::getOrCreateScopArrayInfo(Value *BasePtr, Type *AccessType,
1719 const SmallVector<const SCEV *, 4> &Sizes) {
Tobias Grosserab671442015-05-23 05:58:27 +00001720 auto &SAI = ScopArrayInfoMap[BasePtr];
Johannes Doerfert80ef1102014-11-07 08:31:31 +00001721 if (!SAI)
Tobias Grosserab671442015-05-23 05:58:27 +00001722 SAI.reset(new ScopArrayInfo(BasePtr, AccessType, getIslCtx(), Sizes));
1723 return SAI.get();
Johannes Doerfert1a28a892014-10-05 11:32:18 +00001724}
1725
1726const ScopArrayInfo *Scop::getScopArrayInfo(Value *BasePtr) {
Tobias Grosser2d7611f2015-05-23 05:58:30 +00001727 const ScopArrayInfo *SAI = ScopArrayInfoMap[BasePtr].get();
Johannes Doerfert1a28a892014-10-05 11:32:18 +00001728 assert(SAI && "No ScopArrayInfo available for this base pointer");
1729 return SAI;
1730}
1731
Tobias Grosser74394f02013-01-14 22:40:23 +00001732std::string Scop::getContextStr() const { return stringFromIslObj(Context); }
Tobias Grosser5e6813d2014-07-02 17:47:48 +00001733std::string Scop::getAssumedContextStr() const {
1734 return stringFromIslObj(AssumedContext);
1735}
Tobias Grosser75805372011-04-29 06:27:02 +00001736
1737std::string Scop::getNameStr() const {
1738 std::string ExitName, EntryName;
1739 raw_string_ostream ExitStr(ExitName);
1740 raw_string_ostream EntryStr(EntryName);
1741
Tobias Grosserf240b482014-01-09 10:42:15 +00001742 R.getEntry()->printAsOperand(EntryStr, false);
Tobias Grosser75805372011-04-29 06:27:02 +00001743 EntryStr.str();
1744
1745 if (R.getExit()) {
Tobias Grosserf240b482014-01-09 10:42:15 +00001746 R.getExit()->printAsOperand(ExitStr, false);
Tobias Grosser75805372011-04-29 06:27:02 +00001747 ExitStr.str();
1748 } else
1749 ExitName = "FunctionExit";
1750
1751 return EntryName + "---" + ExitName;
1752}
1753
Tobias Grosser74394f02013-01-14 22:40:23 +00001754__isl_give isl_set *Scop::getContext() const { return isl_set_copy(Context); }
Tobias Grosser37487052011-10-06 00:03:42 +00001755__isl_give isl_space *Scop::getParamSpace() const {
Tobias Grossereeb9f3c2015-05-26 21:37:31 +00001756 return isl_set_get_space(Context);
Tobias Grosser37487052011-10-06 00:03:42 +00001757}
1758
Tobias Grossere86109f2013-10-29 21:05:49 +00001759__isl_give isl_set *Scop::getAssumedContext() const {
1760 return isl_set_copy(AssumedContext);
1761}
1762
Tobias Grosser5e6813d2014-07-02 17:47:48 +00001763void Scop::addAssumption(__isl_take isl_set *Set) {
1764 AssumedContext = isl_set_intersect(AssumedContext, Set);
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001765 AssumedContext = isl_set_coalesce(AssumedContext);
Tobias Grosser5e6813d2014-07-02 17:47:48 +00001766}
1767
Tobias Grosser75805372011-04-29 06:27:02 +00001768void Scop::printContext(raw_ostream &OS) const {
1769 OS << "Context:\n";
1770
1771 if (!Context) {
1772 OS.indent(4) << "n/a\n\n";
1773 return;
1774 }
1775
1776 OS.indent(4) << getContextStr() << "\n";
Tobias Grosser60b54f12011-11-08 15:41:28 +00001777
Tobias Grosser5e6813d2014-07-02 17:47:48 +00001778 OS.indent(4) << "Assumed Context:\n";
1779 if (!AssumedContext) {
1780 OS.indent(4) << "n/a\n\n";
1781 return;
1782 }
1783
1784 OS.indent(4) << getAssumedContextStr() << "\n";
1785
Tobias Grosser083d3d32014-06-28 08:59:45 +00001786 for (const SCEV *Parameter : Parameters) {
Tobias Grosser60b54f12011-11-08 15:41:28 +00001787 int Dim = ParameterIds.find(Parameter)->second;
Tobias Grosser60b54f12011-11-08 15:41:28 +00001788 OS.indent(4) << "p" << Dim << ": " << *Parameter << "\n";
1789 }
Tobias Grosser75805372011-04-29 06:27:02 +00001790}
1791
Johannes Doerfertb164c792014-09-18 11:17:17 +00001792void Scop::printAliasAssumptions(raw_ostream &OS) const {
1793 OS.indent(4) << "Alias Groups (" << MinMaxAliasGroups.size() << "):\n";
1794 if (MinMaxAliasGroups.empty()) {
1795 OS.indent(8) << "n/a\n";
1796 return;
1797 }
1798 for (MinMaxVectorTy *MinMaxAccesses : MinMaxAliasGroups) {
1799 OS.indent(8) << "[[";
1800 for (MinMaxAccessTy &MinMacAccess : *MinMaxAccesses)
1801 OS << " <" << MinMacAccess.first << ", " << MinMacAccess.second << ">";
1802 OS << " ]]\n";
1803 }
1804}
1805
Tobias Grosser75805372011-04-29 06:27:02 +00001806void Scop::printStatements(raw_ostream &OS) const {
1807 OS << "Statements {\n";
1808
Tobias Grosser7c3bad52015-05-27 05:16:57 +00001809 for (const ScopStmt &Stmt : *this)
1810 OS.indent(4) << Stmt;
Tobias Grosser75805372011-04-29 06:27:02 +00001811
1812 OS.indent(4) << "}\n";
1813}
1814
Tobias Grosser49ad36c2015-05-20 08:05:31 +00001815void Scop::printArrayInfo(raw_ostream &OS) const {
1816 OS << "Arrays {\n";
1817
Tobias Grosserab671442015-05-23 05:58:27 +00001818 for (auto &Array : arrays())
Tobias Grosser49ad36c2015-05-20 08:05:31 +00001819 Array.second->print(OS);
1820
1821 OS.indent(4) << "}\n";
1822}
1823
Tobias Grosser75805372011-04-29 06:27:02 +00001824void Scop::print(raw_ostream &OS) const {
Tobias Grosser4eb7ddb2014-03-18 18:51:11 +00001825 OS.indent(4) << "Function: " << getRegion().getEntry()->getParent()->getName()
1826 << "\n";
Tobias Grosser483fdd42014-03-18 18:05:38 +00001827 OS.indent(4) << "Region: " << getNameStr() << "\n";
David Peixottodc0a11c2015-01-13 18:31:55 +00001828 OS.indent(4) << "Max Loop Depth: " << getMaxLoopDepth() << "\n";
Tobias Grosser75805372011-04-29 06:27:02 +00001829 printContext(OS.indent(4));
Tobias Grosser49ad36c2015-05-20 08:05:31 +00001830 printArrayInfo(OS.indent(4));
Johannes Doerfertb164c792014-09-18 11:17:17 +00001831 printAliasAssumptions(OS);
Tobias Grosser75805372011-04-29 06:27:02 +00001832 printStatements(OS.indent(4));
1833}
1834
1835void Scop::dump() const { print(dbgs()); }
1836
Tobias Grosser9a38ab82011-11-08 15:41:03 +00001837isl_ctx *Scop::getIslCtx() const { return IslCtx; }
Tobias Grosser75805372011-04-29 06:27:02 +00001838
Tobias Grosser5f9a7622012-02-14 14:02:40 +00001839__isl_give isl_union_set *Scop::getDomains() {
Tobias Grosserbc4ef902014-06-28 08:59:38 +00001840 isl_union_set *Domain = isl_union_set_empty(getParamSpace());
Tobias Grosser5f9a7622012-02-14 14:02:40 +00001841
Tobias Grosser7c3bad52015-05-27 05:16:57 +00001842 for (ScopStmt &Stmt : *this)
1843 Domain = isl_union_set_add_set(Domain, Stmt.getDomain());
Tobias Grosser5f9a7622012-02-14 14:02:40 +00001844
1845 return Domain;
1846}
1847
Tobias Grosser780ce0f2014-07-11 07:12:10 +00001848__isl_give isl_union_map *Scop::getMustWrites() {
Tobias Grossereeb9f3c2015-05-26 21:37:31 +00001849 isl_union_map *Write = isl_union_map_empty(getParamSpace());
Tobias Grosser780ce0f2014-07-11 07:12:10 +00001850
Tobias Grosser7c3bad52015-05-27 05:16:57 +00001851 for (ScopStmt &Stmt : *this) {
1852 for (MemoryAccess *MA : Stmt) {
Tobias Grosser780ce0f2014-07-11 07:12:10 +00001853 if (!MA->isMustWrite())
1854 continue;
1855
Tobias Grosser7c3bad52015-05-27 05:16:57 +00001856 isl_set *Domain = Stmt.getDomain();
Tobias Grosser780ce0f2014-07-11 07:12:10 +00001857 isl_map *AccessDomain = MA->getAccessRelation();
1858 AccessDomain = isl_map_intersect_domain(AccessDomain, Domain);
1859 Write = isl_union_map_add_map(Write, AccessDomain);
1860 }
1861 }
1862 return isl_union_map_coalesce(Write);
1863}
1864
1865__isl_give isl_union_map *Scop::getMayWrites() {
Tobias Grossereeb9f3c2015-05-26 21:37:31 +00001866 isl_union_map *Write = isl_union_map_empty(getParamSpace());
Tobias Grosser780ce0f2014-07-11 07:12:10 +00001867
Tobias Grosser7c3bad52015-05-27 05:16:57 +00001868 for (ScopStmt &Stmt : *this) {
1869 for (MemoryAccess *MA : Stmt) {
Tobias Grosser780ce0f2014-07-11 07:12:10 +00001870 if (!MA->isMayWrite())
1871 continue;
1872
Tobias Grosser7c3bad52015-05-27 05:16:57 +00001873 isl_set *Domain = Stmt.getDomain();
Tobias Grosser780ce0f2014-07-11 07:12:10 +00001874 isl_map *AccessDomain = MA->getAccessRelation();
1875 AccessDomain = isl_map_intersect_domain(AccessDomain, Domain);
1876 Write = isl_union_map_add_map(Write, AccessDomain);
1877 }
1878 }
1879 return isl_union_map_coalesce(Write);
1880}
1881
Tobias Grosser37eb4222014-02-20 21:43:54 +00001882__isl_give isl_union_map *Scop::getWrites() {
Tobias Grossereeb9f3c2015-05-26 21:37:31 +00001883 isl_union_map *Write = isl_union_map_empty(getParamSpace());
Tobias Grosser37eb4222014-02-20 21:43:54 +00001884
Tobias Grosser7c3bad52015-05-27 05:16:57 +00001885 for (ScopStmt &Stmt : *this) {
1886 for (MemoryAccess *MA : Stmt) {
Johannes Doerfertf6752892014-06-13 18:01:45 +00001887 if (!MA->isWrite())
Tobias Grosser37eb4222014-02-20 21:43:54 +00001888 continue;
1889
Tobias Grosser7c3bad52015-05-27 05:16:57 +00001890 isl_set *Domain = Stmt.getDomain();
Johannes Doerfertf6752892014-06-13 18:01:45 +00001891 isl_map *AccessDomain = MA->getAccessRelation();
Tobias Grosser37eb4222014-02-20 21:43:54 +00001892 AccessDomain = isl_map_intersect_domain(AccessDomain, Domain);
1893 Write = isl_union_map_add_map(Write, AccessDomain);
1894 }
1895 }
1896 return isl_union_map_coalesce(Write);
1897}
1898
1899__isl_give isl_union_map *Scop::getReads() {
Tobias Grosserbc4ef902014-06-28 08:59:38 +00001900 isl_union_map *Read = isl_union_map_empty(getParamSpace());
Tobias Grosser37eb4222014-02-20 21:43:54 +00001901
Tobias Grosser7c3bad52015-05-27 05:16:57 +00001902 for (ScopStmt &Stmt : *this) {
1903 for (MemoryAccess *MA : Stmt) {
Johannes Doerfertf6752892014-06-13 18:01:45 +00001904 if (!MA->isRead())
Tobias Grosser37eb4222014-02-20 21:43:54 +00001905 continue;
1906
Tobias Grosser7c3bad52015-05-27 05:16:57 +00001907 isl_set *Domain = Stmt.getDomain();
Johannes Doerfertf6752892014-06-13 18:01:45 +00001908 isl_map *AccessDomain = MA->getAccessRelation();
Tobias Grosser37eb4222014-02-20 21:43:54 +00001909
1910 AccessDomain = isl_map_intersect_domain(AccessDomain, Domain);
1911 Read = isl_union_map_add_map(Read, AccessDomain);
1912 }
1913 }
1914 return isl_union_map_coalesce(Read);
1915}
1916
1917__isl_give isl_union_map *Scop::getSchedule() {
Tobias Grosserbc4ef902014-06-28 08:59:38 +00001918 isl_union_map *Schedule = isl_union_map_empty(getParamSpace());
Tobias Grosser37eb4222014-02-20 21:43:54 +00001919
Tobias Grosser7c3bad52015-05-27 05:16:57 +00001920 for (ScopStmt &Stmt : *this)
1921 Schedule = isl_union_map_add_map(Schedule, Stmt.getSchedule());
Tobias Grosserbc4ef902014-06-28 08:59:38 +00001922
Tobias Grosser37eb4222014-02-20 21:43:54 +00001923 return isl_union_map_coalesce(Schedule);
1924}
1925
1926bool Scop::restrictDomains(__isl_take isl_union_set *Domain) {
1927 bool Changed = false;
Tobias Grosser7c3bad52015-05-27 05:16:57 +00001928 for (ScopStmt &Stmt : *this) {
1929 isl_union_set *StmtDomain = isl_union_set_from_set(Stmt.getDomain());
Tobias Grosser37eb4222014-02-20 21:43:54 +00001930 isl_union_set *NewStmtDomain = isl_union_set_intersect(
1931 isl_union_set_copy(StmtDomain), isl_union_set_copy(Domain));
1932
1933 if (isl_union_set_is_subset(StmtDomain, NewStmtDomain)) {
1934 isl_union_set_free(StmtDomain);
1935 isl_union_set_free(NewStmtDomain);
1936 continue;
1937 }
1938
1939 Changed = true;
1940
1941 isl_union_set_free(StmtDomain);
1942 NewStmtDomain = isl_union_set_coalesce(NewStmtDomain);
1943
1944 if (isl_union_set_is_empty(NewStmtDomain)) {
Tobias Grosser7c3bad52015-05-27 05:16:57 +00001945 Stmt.restrictDomain(isl_set_empty(Stmt.getDomainSpace()));
Tobias Grosser37eb4222014-02-20 21:43:54 +00001946 isl_union_set_free(NewStmtDomain);
1947 } else
Tobias Grosser7c3bad52015-05-27 05:16:57 +00001948 Stmt.restrictDomain(isl_set_from_union_set(NewStmtDomain));
Tobias Grosser37eb4222014-02-20 21:43:54 +00001949 }
1950 isl_union_set_free(Domain);
1951 return Changed;
1952}
1953
Tobias Grosser75805372011-04-29 06:27:02 +00001954ScalarEvolution *Scop::getSE() const { return SE; }
1955
1956bool Scop::isTrivialBB(BasicBlock *BB, TempScop &tempScop) {
1957 if (tempScop.getAccessFunctions(BB))
1958 return false;
1959
1960 return true;
1961}
1962
Johannes Doerfertff9d1982015-02-24 12:00:50 +00001963void Scop::addScopStmt(BasicBlock *BB, Region *R, TempScop &tempScop,
1964 const Region &CurRegion,
1965 SmallVectorImpl<Loop *> &NestLoops,
Tobias Grosser54839312015-04-21 11:37:25 +00001966 SmallVectorImpl<unsigned> &ScheduleVec) {
Johannes Doerfertff9d1982015-02-24 12:00:50 +00001967 if (BB) {
Tobias Grosser7c3bad52015-05-27 05:16:57 +00001968 Stmts.emplace_back(*this, tempScop, CurRegion, *BB, NestLoops, ScheduleVec);
1969 StmtMap[BB] = &Stmts.back();
Johannes Doerfertff9d1982015-02-24 12:00:50 +00001970 } else {
Tobias Grosser7c3bad52015-05-27 05:16:57 +00001971 assert(R && "Either basic block or a region expected.");
1972 Stmts.emplace_back(*this, tempScop, CurRegion, *R, NestLoops, ScheduleVec);
1973 auto *Ptr = &Stmts.back();
Johannes Doerfertff9d1982015-02-24 12:00:50 +00001974 for (BasicBlock *BB : R->blocks())
Tobias Grosser7c3bad52015-05-27 05:16:57 +00001975 StmtMap[BB] = Ptr;
Johannes Doerfertff9d1982015-02-24 12:00:50 +00001976 }
1977
Tobias Grosser54839312015-04-21 11:37:25 +00001978 // Increasing the Schedule function is OK for the moment, because
Johannes Doerfertff9d1982015-02-24 12:00:50 +00001979 // we are using a depth first iterator and the program is well structured.
Tobias Grosser54839312015-04-21 11:37:25 +00001980 ++ScheduleVec[NestLoops.size()];
Johannes Doerfertff9d1982015-02-24 12:00:50 +00001981}
1982
Tobias Grosser74394f02013-01-14 22:40:23 +00001983void Scop::buildScop(TempScop &tempScop, const Region &CurRegion,
1984 SmallVectorImpl<Loop *> &NestLoops,
Tobias Grosser54839312015-04-21 11:37:25 +00001985 SmallVectorImpl<unsigned> &ScheduleVec, LoopInfo &LI,
Johannes Doerfertff9d1982015-02-24 12:00:50 +00001986 ScopDetection &SD) {
1987 if (SD.isNonAffineSubRegion(&CurRegion, &getRegion()))
1988 return addScopStmt(nullptr, const_cast<Region *>(&CurRegion), tempScop,
Tobias Grosser54839312015-04-21 11:37:25 +00001989 CurRegion, NestLoops, ScheduleVec);
Johannes Doerfertff9d1982015-02-24 12:00:50 +00001990
Tobias Grosser75805372011-04-29 06:27:02 +00001991 Loop *L = castToLoop(CurRegion, LI);
1992
1993 if (L)
1994 NestLoops.push_back(L);
1995
1996 unsigned loopDepth = NestLoops.size();
Tobias Grosser54839312015-04-21 11:37:25 +00001997 assert(ScheduleVec.size() > loopDepth && "Schedule not big enough!");
Tobias Grosser75805372011-04-29 06:27:02 +00001998
1999 for (Region::const_element_iterator I = CurRegion.element_begin(),
Tobias Grosserabfbe632013-02-05 12:09:06 +00002000 E = CurRegion.element_end();
2001 I != E; ++I)
Johannes Doerfertff9d1982015-02-24 12:00:50 +00002002 if (I->isSubRegion()) {
Tobias Grosser654af8f2015-04-21 11:42:01 +00002003 buildScop(tempScop, *I->getNodeAs<Region>(), NestLoops, ScheduleVec, LI,
2004 SD);
Johannes Doerfertff9d1982015-02-24 12:00:50 +00002005 } else {
Tobias Grosser75805372011-04-29 06:27:02 +00002006 BasicBlock *BB = I->getNodeAs<BasicBlock>();
2007
2008 if (isTrivialBB(BB, tempScop))
2009 continue;
2010
Tobias Grosser54839312015-04-21 11:37:25 +00002011 addScopStmt(BB, nullptr, tempScop, CurRegion, NestLoops, ScheduleVec);
Tobias Grosser75805372011-04-29 06:27:02 +00002012 }
2013
2014 if (!L)
2015 return;
2016
2017 // Exiting a loop region.
Tobias Grosser54839312015-04-21 11:37:25 +00002018 ScheduleVec[loopDepth] = 0;
Tobias Grosser75805372011-04-29 06:27:02 +00002019 NestLoops.pop_back();
Tobias Grosser54839312015-04-21 11:37:25 +00002020 ++ScheduleVec[loopDepth - 1];
Tobias Grosser75805372011-04-29 06:27:02 +00002021}
2022
Johannes Doerfert7c494212014-10-31 23:13:39 +00002023ScopStmt *Scop::getStmtForBasicBlock(BasicBlock *BB) const {
Tobias Grosser57411e32015-05-27 06:51:34 +00002024 auto StmtMapIt = StmtMap.find(BB);
Johannes Doerfert7c494212014-10-31 23:13:39 +00002025 if (StmtMapIt == StmtMap.end())
2026 return nullptr;
2027 return StmtMapIt->second;
2028}
2029
Tobias Grosser75805372011-04-29 06:27:02 +00002030//===----------------------------------------------------------------------===//
Tobias Grosserb76f38532011-08-20 11:11:25 +00002031ScopInfo::ScopInfo() : RegionPass(ID), scop(0) {
2032 ctx = isl_ctx_alloc();
Tobias Grosser4a8e3562011-12-07 07:42:51 +00002033 isl_options_set_on_error(ctx, ISL_ON_ERROR_ABORT);
Tobias Grosserb76f38532011-08-20 11:11:25 +00002034}
2035
2036ScopInfo::~ScopInfo() {
2037 clear();
2038 isl_ctx_free(ctx);
2039}
2040
Tobias Grosser75805372011-04-29 06:27:02 +00002041void ScopInfo::getAnalysisUsage(AnalysisUsage &AU) const {
Chandler Carruthf5579872015-01-17 14:16:56 +00002042 AU.addRequired<LoopInfoWrapperPass>();
Matt Arsenault8ca36812014-07-19 18:40:17 +00002043 AU.addRequired<RegionInfoPass>();
Tobias Grosser75805372011-04-29 06:27:02 +00002044 AU.addRequired<ScalarEvolution>();
Johannes Doerfertff9d1982015-02-24 12:00:50 +00002045 AU.addRequired<ScopDetection>();
Tobias Grosser75805372011-04-29 06:27:02 +00002046 AU.addRequired<TempScopInfo>();
Johannes Doerfertb164c792014-09-18 11:17:17 +00002047 AU.addRequired<AliasAnalysis>();
Tobias Grosser75805372011-04-29 06:27:02 +00002048 AU.setPreservesAll();
2049}
2050
2051bool ScopInfo::runOnRegion(Region *R, RGPassManager &RGM) {
Chandler Carruthf5579872015-01-17 14:16:56 +00002052 LoopInfo &LI = getAnalysis<LoopInfoWrapperPass>().getLoopInfo();
Johannes Doerfertb164c792014-09-18 11:17:17 +00002053 AliasAnalysis &AA = getAnalysis<AliasAnalysis>();
Johannes Doerfertff9d1982015-02-24 12:00:50 +00002054 ScopDetection &SD = getAnalysis<ScopDetection>();
Tobias Grosser75805372011-04-29 06:27:02 +00002055 ScalarEvolution &SE = getAnalysis<ScalarEvolution>();
2056
2057 TempScop *tempScop = getAnalysis<TempScopInfo>().getTempScop(R);
2058
2059 // This region is no Scop.
2060 if (!tempScop) {
Tobias Grosserc98a8fc2014-11-14 11:12:31 +00002061 scop = nullptr;
Tobias Grosser75805372011-04-29 06:27:02 +00002062 return false;
2063 }
2064
Johannes Doerfertff9d1982015-02-24 12:00:50 +00002065 scop = new Scop(*tempScop, LI, SE, SD, ctx);
Tobias Grosser75805372011-04-29 06:27:02 +00002066
Johannes Doerfert21aa3dc2014-11-01 01:30:11 +00002067 if (!PollyUseRuntimeAliasChecks) {
2068 // Statistics.
2069 ++ScopFound;
2070 if (scop->getMaxLoopDepth() > 0)
2071 ++RichScopFound;
Johannes Doerfert9143d672014-09-27 11:02:39 +00002072 return false;
Johannes Doerfert21aa3dc2014-11-01 01:30:11 +00002073 }
Johannes Doerfertb164c792014-09-18 11:17:17 +00002074
Johannes Doerfert9143d672014-09-27 11:02:39 +00002075 // If a problem occurs while building the alias groups we need to delete
2076 // this SCoP and pretend it wasn't valid in the first place.
Johannes Doerfert21aa3dc2014-11-01 01:30:11 +00002077 if (scop->buildAliasGroups(AA)) {
2078 // Statistics.
2079 ++ScopFound;
2080 if (scop->getMaxLoopDepth() > 0)
2081 ++RichScopFound;
Johannes Doerfert9143d672014-09-27 11:02:39 +00002082 return false;
Johannes Doerfert21aa3dc2014-11-01 01:30:11 +00002083 }
Johannes Doerfert9143d672014-09-27 11:02:39 +00002084
2085 DEBUG(dbgs()
2086 << "\n\nNOTE: Run time checks for " << scop->getNameStr()
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00002087 << " could not be created as the number of parameters involved is too "
Johannes Doerfert9143d672014-09-27 11:02:39 +00002088 "high. The SCoP will be "
2089 "dismissed.\nUse:\n\t--polly-rtc-max-parameters=X\nto adjust the "
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00002090 "maximal number of parameters but be advised that the compile time "
Johannes Doerfert9143d672014-09-27 11:02:39 +00002091 "might increase exponentially.\n\n");
2092
2093 delete scop;
2094 scop = nullptr;
Tobias Grosser75805372011-04-29 06:27:02 +00002095 return false;
2096}
2097
2098char ScopInfo::ID = 0;
2099
Tobias Grosser4d96c8d2013-03-23 01:05:07 +00002100Pass *polly::createScopInfoPass() { return new ScopInfo(); }
2101
Tobias Grosser73600b82011-10-08 00:30:40 +00002102INITIALIZE_PASS_BEGIN(ScopInfo, "polly-scops",
2103 "Polly - Create polyhedral description of Scops", false,
Tobias Grosser4d96c8d2013-03-23 01:05:07 +00002104 false);
Johannes Doerfertb164c792014-09-18 11:17:17 +00002105INITIALIZE_AG_DEPENDENCY(AliasAnalysis);
Chandler Carruthf5579872015-01-17 14:16:56 +00002106INITIALIZE_PASS_DEPENDENCY(LoopInfoWrapperPass);
Matt Arsenault8ca36812014-07-19 18:40:17 +00002107INITIALIZE_PASS_DEPENDENCY(RegionInfoPass);
Tobias Grosser4d96c8d2013-03-23 01:05:07 +00002108INITIALIZE_PASS_DEPENDENCY(ScalarEvolution);
Johannes Doerfertff9d1982015-02-24 12:00:50 +00002109INITIALIZE_PASS_DEPENDENCY(ScopDetection);
Tobias Grosser4d96c8d2013-03-23 01:05:07 +00002110INITIALIZE_PASS_DEPENDENCY(TempScopInfo);
Tobias Grosser73600b82011-10-08 00:30:40 +00002111INITIALIZE_PASS_END(ScopInfo, "polly-scops",
2112 "Polly - Create polyhedral description of Scops", false,
2113 false)