blob: 951dfc79a4d273b0f693ac65e92bdbf83f58f19c [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"
Hongbin Zheng86a37742012-04-25 08:01:38 +000030#include "llvm/ADT/StringExtras.h"
Johannes Doerfertb164c792014-09-18 11:17:17 +000031#include "llvm/Analysis/AliasAnalysis.h"
Tobias Grosserba0d0922015-05-09 09:13:42 +000032#include "llvm/Analysis/LoopInfo.h"
Tobias Grosser83628182013-05-07 08:11:54 +000033#include "llvm/Analysis/RegionIterator.h"
34#include "llvm/Analysis/ScalarEvolutionExpressions.h"
Tobias Grosser75805372011-04-29 06:27:02 +000035#include "llvm/Support/Debug.h"
Tobias Grosser33ba62ad2011-08-18 06:31:50 +000036#include "isl/aff.h"
Tobias Grosserba0d0922015-05-09 09:13:42 +000037#include "isl/constraint.h"
Tobias Grosserf5338802011-10-06 00:03:35 +000038#include "isl/local_space.h"
Tobias Grosserba0d0922015-05-09 09:13:42 +000039#include "isl/map.h"
Tobias Grosser4a8e3562011-12-07 07:42:51 +000040#include "isl/options.h"
Tobias Grosserba0d0922015-05-09 09:13:42 +000041#include "isl/printer.h"
42#include "isl/set.h"
43#include "isl/union_map.h"
Tobias Grossercd524dc2015-05-09 09:36:38 +000044#include "isl/union_set.h"
Tobias Grosseredab1352013-06-21 06:41:31 +000045#include "isl/val.h"
Tobias Grosser75805372011-04-29 06:27:02 +000046#include <sstream>
47#include <string>
48#include <vector>
49
50using namespace llvm;
51using namespace polly;
52
Chandler Carruth95fef942014-04-22 03:30:19 +000053#define DEBUG_TYPE "polly-scops"
54
Tobias Grosser74394f02013-01-14 22:40:23 +000055STATISTIC(ScopFound, "Number of valid Scops");
56STATISTIC(RichScopFound, "Number of Scops containing a loop");
Tobias Grosser75805372011-04-29 06:27:02 +000057
Johannes Doerfert9e7b17b2014-08-18 00:40:13 +000058// Multiplicative reductions can be disabled separately as these kind of
Johannes Doerfert0ee1f212014-06-17 17:31:36 +000059// operations can overflow easily. Additive reductions and bit operations
60// are in contrast pretty stable.
Tobias Grosser483a90d2014-07-09 10:50:10 +000061static cl::opt<bool> DisableMultiplicativeReductions(
62 "polly-disable-multiplicative-reductions",
63 cl::desc("Disable multiplicative reductions"), cl::Hidden, cl::ZeroOrMore,
64 cl::init(false), cl::cat(PollyCategory));
Johannes Doerfert0ee1f212014-06-17 17:31:36 +000065
Johannes Doerfert9143d672014-09-27 11:02:39 +000066static cl::opt<unsigned> RunTimeChecksMaxParameters(
67 "polly-rtc-max-parameters",
68 cl::desc("The maximal number of parameters allowed in RTCs."), cl::Hidden,
69 cl::ZeroOrMore, cl::init(8), cl::cat(PollyCategory));
70
Tobias Grosser71500722015-03-28 15:11:14 +000071static cl::opt<unsigned> RunTimeChecksMaxArraysPerGroup(
72 "polly-rtc-max-arrays-per-group",
73 cl::desc("The maximal number of arrays to compare in each alias group."),
74 cl::Hidden, cl::ZeroOrMore, cl::init(20), cl::cat(PollyCategory));
75
Tobias Grosser0695ee42013-09-17 03:30:31 +000076/// Translate a 'const SCEV *' expression in an isl_pw_aff.
Tobias Grosserabfbe632013-02-05 12:09:06 +000077struct SCEVAffinator : public SCEVVisitor<SCEVAffinator, isl_pw_aff *> {
Tobias Grosser0695ee42013-09-17 03:30:31 +000078public:
Tobias Grosser0695ee42013-09-17 03:30:31 +000079 /// @brief Translate a 'const SCEV *' to an isl_pw_aff.
80 ///
81 /// @param Stmt The location at which the scalar evolution expression
82 /// is evaluated.
83 /// @param Expr The expression that is translated.
84 static __isl_give isl_pw_aff *getPwAff(ScopStmt *Stmt, const SCEV *Expr);
85
Tobias Grosser33ba62ad2011-08-18 06:31:50 +000086private:
Tobias Grosser3cc99742012-06-06 16:33:15 +000087 isl_ctx *Ctx;
Tobias Grosserf5338802011-10-06 00:03:35 +000088 int NbLoopSpaces;
Tobias Grosser3cc99742012-06-06 16:33:15 +000089 const Scop *S;
Tobias Grosser33ba62ad2011-08-18 06:31:50 +000090
Tobias Grosser0695ee42013-09-17 03:30:31 +000091 SCEVAffinator(const ScopStmt *Stmt);
92 int getLoopDepth(const Loop *L);
Tobias Grosser60b54f12011-11-08 15:41:28 +000093
Tobias Grosser0695ee42013-09-17 03:30:31 +000094 __isl_give isl_pw_aff *visit(const SCEV *Expr);
95 __isl_give isl_pw_aff *visitConstant(const SCEVConstant *Expr);
96 __isl_give isl_pw_aff *visitTruncateExpr(const SCEVTruncateExpr *Expr);
97 __isl_give isl_pw_aff *visitZeroExtendExpr(const SCEVZeroExtendExpr *Expr);
98 __isl_give isl_pw_aff *visitSignExtendExpr(const SCEVSignExtendExpr *Expr);
99 __isl_give isl_pw_aff *visitAddExpr(const SCEVAddExpr *Expr);
100 __isl_give isl_pw_aff *visitMulExpr(const SCEVMulExpr *Expr);
101 __isl_give isl_pw_aff *visitUDivExpr(const SCEVUDivExpr *Expr);
102 __isl_give isl_pw_aff *visitAddRecExpr(const SCEVAddRecExpr *Expr);
103 __isl_give isl_pw_aff *visitSMaxExpr(const SCEVSMaxExpr *Expr);
104 __isl_give isl_pw_aff *visitUMaxExpr(const SCEVUMaxExpr *Expr);
105 __isl_give isl_pw_aff *visitUnknown(const SCEVUnknown *Expr);
Johannes Doerfertb9d18882015-02-11 14:54:50 +0000106 __isl_give isl_pw_aff *visitSDivInstruction(Instruction *SDiv);
Tobias Grosser60b54f12011-11-08 15:41:28 +0000107
Tobias Grosser0695ee42013-09-17 03:30:31 +0000108 friend struct SCEVVisitor<SCEVAffinator, isl_pw_aff *>;
109};
Tobias Grosser33ba62ad2011-08-18 06:31:50 +0000110
Tobias Grosser0695ee42013-09-17 03:30:31 +0000111SCEVAffinator::SCEVAffinator(const ScopStmt *Stmt)
112 : Ctx(Stmt->getIslCtx()), NbLoopSpaces(Stmt->getNumIterators()),
113 S(Stmt->getParent()) {}
Tobias Grosser33ba62ad2011-08-18 06:31:50 +0000114
Tobias Grosser0695ee42013-09-17 03:30:31 +0000115__isl_give isl_pw_aff *SCEVAffinator::getPwAff(ScopStmt *Stmt,
116 const SCEV *Scev) {
117 Scop *S = Stmt->getParent();
118 const Region *Reg = &S->getRegion();
Tobias Grosser33ba62ad2011-08-18 06:31:50 +0000119
Tobias Grosser0695ee42013-09-17 03:30:31 +0000120 S->addParams(getParamsInAffineExpr(Reg, Scev, *S->getSE()));
Tobias Grosser33ba62ad2011-08-18 06:31:50 +0000121
Tobias Grosser0695ee42013-09-17 03:30:31 +0000122 SCEVAffinator Affinator(Stmt);
123 return Affinator.visit(Scev);
124}
Tobias Grosser33ba62ad2011-08-18 06:31:50 +0000125
Tobias Grosser0695ee42013-09-17 03:30:31 +0000126__isl_give isl_pw_aff *SCEVAffinator::visit(const SCEV *Expr) {
127 // In case the scev is a valid parameter, we do not further analyze this
128 // expression, but create a new parameter in the isl_pw_aff. This allows us
129 // to treat subexpressions that we cannot translate into an piecewise affine
130 // expression, as constant parameters of the piecewise affine expression.
131 if (isl_id *Id = S->getIdForParam(Expr)) {
132 isl_space *Space = isl_space_set_alloc(Ctx, 1, NbLoopSpaces);
133 Space = isl_space_set_dim_id(Space, isl_dim_param, 0, Id);
Tobias Grosser33ba62ad2011-08-18 06:31:50 +0000134
Tobias Grosser0695ee42013-09-17 03:30:31 +0000135 isl_set *Domain = isl_set_universe(isl_space_copy(Space));
136 isl_aff *Affine = isl_aff_zero_on_domain(isl_local_space_from_space(Space));
137 Affine = isl_aff_add_coefficient_si(Affine, isl_dim_param, 0, 1);
Tobias Grosser33ba62ad2011-08-18 06:31:50 +0000138
139 return isl_pw_aff_alloc(Domain, Affine);
140 }
141
Tobias Grosser0695ee42013-09-17 03:30:31 +0000142 return SCEVVisitor<SCEVAffinator, isl_pw_aff *>::visit(Expr);
143}
144
Tobias Grosser0d170132013-10-03 13:09:19 +0000145__isl_give isl_pw_aff *SCEVAffinator::visitConstant(const SCEVConstant *Expr) {
Tobias Grosser0695ee42013-09-17 03:30:31 +0000146 ConstantInt *Value = Expr->getValue();
147 isl_val *v;
148
149 // LLVM does not define if an integer value is interpreted as a signed or
150 // unsigned value. Hence, without further information, it is unknown how
151 // this value needs to be converted to GMP. At the moment, we only support
152 // signed operations. So we just interpret it as signed. Later, there are
153 // two options:
154 //
155 // 1. We always interpret any value as signed and convert the values on
156 // demand.
157 // 2. We pass down the signedness of the calculation and use it to interpret
158 // this constant correctly.
159 v = isl_valFromAPInt(Ctx, Value->getValue(), /* isSigned */ true);
160
161 isl_space *Space = isl_space_set_alloc(Ctx, 0, NbLoopSpaces);
Johannes Doerfert9c147372014-11-19 15:36:59 +0000162 isl_local_space *ls = isl_local_space_from_space(Space);
163 return isl_pw_aff_from_aff(isl_aff_val_on_domain(ls, v));
Tobias Grosser0695ee42013-09-17 03:30:31 +0000164}
165
166__isl_give isl_pw_aff *
167SCEVAffinator::visitTruncateExpr(const SCEVTruncateExpr *Expr) {
168 llvm_unreachable("SCEVTruncateExpr not yet supported");
169}
170
171__isl_give isl_pw_aff *
172SCEVAffinator::visitZeroExtendExpr(const SCEVZeroExtendExpr *Expr) {
173 llvm_unreachable("SCEVZeroExtendExpr not yet supported");
174}
175
176__isl_give isl_pw_aff *
177SCEVAffinator::visitSignExtendExpr(const SCEVSignExtendExpr *Expr) {
178 // Assuming the value is signed, a sign extension is basically a noop.
179 // TODO: Reconsider this as soon as we support unsigned values.
180 return visit(Expr->getOperand());
181}
182
183__isl_give isl_pw_aff *SCEVAffinator::visitAddExpr(const SCEVAddExpr *Expr) {
184 isl_pw_aff *Sum = visit(Expr->getOperand(0));
185
186 for (int i = 1, e = Expr->getNumOperands(); i < e; ++i) {
187 isl_pw_aff *NextSummand = visit(Expr->getOperand(i));
188 Sum = isl_pw_aff_add(Sum, NextSummand);
Tobias Grosser33ba62ad2011-08-18 06:31:50 +0000189 }
190
Tobias Grosser0695ee42013-09-17 03:30:31 +0000191 // TODO: Check for NSW and NUW.
Tobias Grosser33ba62ad2011-08-18 06:31:50 +0000192
Tobias Grosser0695ee42013-09-17 03:30:31 +0000193 return Sum;
194}
Tobias Grosser33ba62ad2011-08-18 06:31:50 +0000195
Tobias Grosser0695ee42013-09-17 03:30:31 +0000196__isl_give isl_pw_aff *SCEVAffinator::visitMulExpr(const SCEVMulExpr *Expr) {
Johannes Doerfertbe409962015-03-29 20:45:09 +0000197 // Divide Expr into a constant part and the rest. Then visit both and multiply
198 // the result to obtain the representation for Expr. While the second part of
199 // ConstantAndLeftOverPair might still be a SCEVMulExpr we will not get to
200 // this point again. The reason is that if it is a multiplication it consists
201 // only of parameters and we will stop in the visit(const SCEV *) function and
202 // return the isl_pw_aff for that parameter.
203 auto ConstantAndLeftOverPair = extractConstantFactor(Expr, *S->getSE());
204 return isl_pw_aff_mul(visit(ConstantAndLeftOverPair.first),
205 visit(ConstantAndLeftOverPair.second));
Tobias Grosser0695ee42013-09-17 03:30:31 +0000206}
Tobias Grosser33ba62ad2011-08-18 06:31:50 +0000207
Tobias Grosser0695ee42013-09-17 03:30:31 +0000208__isl_give isl_pw_aff *SCEVAffinator::visitUDivExpr(const SCEVUDivExpr *Expr) {
209 llvm_unreachable("SCEVUDivExpr not yet supported");
210}
Tobias Grosser33ba62ad2011-08-18 06:31:50 +0000211
Tobias Grosser0695ee42013-09-17 03:30:31 +0000212__isl_give isl_pw_aff *
213SCEVAffinator::visitAddRecExpr(const SCEVAddRecExpr *Expr) {
214 assert(Expr->isAffine() && "Only affine AddRecurrences allowed");
Tobias Grosser33ba62ad2011-08-18 06:31:50 +0000215
Johannes Doerfertd5d8f672015-04-26 19:55:21 +0000216 auto Flags = Expr->getNoWrapFlags();
217
Tobias Grosser0695ee42013-09-17 03:30:31 +0000218 // Directly generate isl_pw_aff for Expr if 'start' is zero.
219 if (Expr->getStart()->isZero()) {
220 assert(S->getRegion().contains(Expr->getLoop()) &&
221 "Scop does not contain the loop referenced in this AddRec");
Tobias Grosser33ba62ad2011-08-18 06:31:50 +0000222
Tobias Grosser33ba62ad2011-08-18 06:31:50 +0000223 isl_pw_aff *Start = visit(Expr->getStart());
Tobias Grosser0695ee42013-09-17 03:30:31 +0000224 isl_pw_aff *Step = visit(Expr->getOperand(1));
225 isl_space *Space = isl_space_set_alloc(Ctx, 0, NbLoopSpaces);
226 isl_local_space *LocalSpace = isl_local_space_from_space(Space);
Tobias Grosser33ba62ad2011-08-18 06:31:50 +0000227
Tobias Grosser0695ee42013-09-17 03:30:31 +0000228 int loopDimension = getLoopDepth(Expr->getLoop());
229
230 isl_aff *LAff = isl_aff_set_coefficient_si(
231 isl_aff_zero_on_domain(LocalSpace), isl_dim_in, loopDimension, 1);
232 isl_pw_aff *LPwAff = isl_pw_aff_from_aff(LAff);
233
234 // TODO: Do we need to check for NSW and NUW?
235 return isl_pw_aff_add(Start, isl_pw_aff_mul(Step, LPwAff));
Tobias Grosser33ba62ad2011-08-18 06:31:50 +0000236 }
237
Tobias Grosser0695ee42013-09-17 03:30:31 +0000238 // Translate AddRecExpr from '{start, +, inc}' into 'start + {0, +, inc}'
239 // if 'start' is not zero.
Johannes Doerfertd5d8f672015-04-26 19:55:21 +0000240 // TODO: Using the original SCEV no-wrap flags is not always safe, however
241 // as our code generation is reordering the expression anyway it doesn't
242 // really matter.
Tobias Grosser0695ee42013-09-17 03:30:31 +0000243 ScalarEvolution &SE = *S->getSE();
Johannes Doerfertd5d8f672015-04-26 19:55:21 +0000244 const SCEV *ZeroStartExpr =
245 SE.getAddRecExpr(SE.getConstant(Expr->getStart()->getType(), 0),
246 Expr->getStepRecurrence(SE), Expr->getLoop(), Flags);
Tobias Grosser33ba62ad2011-08-18 06:31:50 +0000247
Tobias Grosser0695ee42013-09-17 03:30:31 +0000248 isl_pw_aff *ZeroStartResult = visit(ZeroStartExpr);
249 isl_pw_aff *Start = visit(Expr->getStart());
Tobias Grosser33ba62ad2011-08-18 06:31:50 +0000250
Tobias Grosser0695ee42013-09-17 03:30:31 +0000251 return isl_pw_aff_add(ZeroStartResult, Start);
252}
253
254__isl_give isl_pw_aff *SCEVAffinator::visitSMaxExpr(const SCEVSMaxExpr *Expr) {
255 isl_pw_aff *Max = visit(Expr->getOperand(0));
256
257 for (int i = 1, e = Expr->getNumOperands(); i < e; ++i) {
258 isl_pw_aff *NextOperand = visit(Expr->getOperand(i));
259 Max = isl_pw_aff_max(Max, NextOperand);
Tobias Grosser33ba62ad2011-08-18 06:31:50 +0000260 }
261
Tobias Grosser0695ee42013-09-17 03:30:31 +0000262 return Max;
263}
Tobias Grosser33ba62ad2011-08-18 06:31:50 +0000264
Tobias Grosser0695ee42013-09-17 03:30:31 +0000265__isl_give isl_pw_aff *SCEVAffinator::visitUMaxExpr(const SCEVUMaxExpr *Expr) {
266 llvm_unreachable("SCEVUMaxExpr not yet supported");
267}
268
Johannes Doerfertb9d18882015-02-11 14:54:50 +0000269__isl_give isl_pw_aff *SCEVAffinator::visitSDivInstruction(Instruction *SDiv) {
270 assert(SDiv->getOpcode() == Instruction::SDiv && "Assumed SDiv instruction!");
271 auto *SE = S->getSE();
272
273 auto *Divisor = SDiv->getOperand(1);
274 auto *DivisorSCEV = SE->getSCEV(Divisor);
275 auto *DivisorPWA = visit(DivisorSCEV);
276 assert(isa<ConstantInt>(Divisor) &&
277 "SDiv is no parameter but has a non-constant RHS.");
278
279 auto *Dividend = SDiv->getOperand(0);
280 auto *DividendSCEV = SE->getSCEV(Dividend);
281 auto *DividendPWA = visit(DividendSCEV);
282 return isl_pw_aff_tdiv_q(DividendPWA, DivisorPWA);
283}
284
Tobias Grosser0695ee42013-09-17 03:30:31 +0000285__isl_give isl_pw_aff *SCEVAffinator::visitUnknown(const SCEVUnknown *Expr) {
Johannes Doerfertb9d18882015-02-11 14:54:50 +0000286 if (Instruction *I = dyn_cast<Instruction>(Expr->getValue())) {
287 switch (I->getOpcode()) {
288 case Instruction::SDiv:
289 return visitSDivInstruction(I);
290 default:
291 break; // Fall through.
292 }
293 }
294
295 llvm_unreachable(
296 "Unknowns SCEV was neither parameter nor a valid instruction.");
Tobias Grosser0695ee42013-09-17 03:30:31 +0000297}
298
299int SCEVAffinator::getLoopDepth(const Loop *L) {
300 Loop *outerLoop = S->getRegion().outermostLoopInRegion(const_cast<Loop *>(L));
301 assert(outerLoop && "Scop does not contain this loop");
302 return L->getLoopDepth() - outerLoop->getLoopDepth();
303}
Tobias Grosser33ba62ad2011-08-18 06:31:50 +0000304
Johannes Doerferte7044942015-02-24 11:58:30 +0000305/// @brief Add the bounds of @p Range to the set @p S for dimension @p dim.
306static __isl_give isl_set *addRangeBoundsToSet(__isl_take isl_set *S,
307 const ConstantRange &Range,
308 int dim,
309 enum isl_dim_type type) {
310 isl_val *V;
311 isl_ctx *ctx = isl_set_get_ctx(S);
312
Johannes Doerfert8f8af432015-04-26 20:07:21 +0000313 bool useLowerUpperBound = Range.isSignWrappedSet() && !Range.isFullSet();
314 const auto LB = useLowerUpperBound ? Range.getLower() : Range.getSignedMin();
Johannes Doerferte4bd53b2015-03-08 19:49:50 +0000315 V = isl_valFromAPInt(ctx, LB, true);
Johannes Doerferte7044942015-02-24 11:58:30 +0000316 isl_set *SLB = isl_set_lower_bound_val(isl_set_copy(S), type, dim, V);
317
Johannes Doerfert8f8af432015-04-26 20:07:21 +0000318 const auto UB = useLowerUpperBound ? Range.getUpper() : Range.getSignedMax();
Johannes Doerferte4bd53b2015-03-08 19:49:50 +0000319 V = isl_valFromAPInt(ctx, UB, true);
Johannes Doerfert8f8af432015-04-26 20:07:21 +0000320 if (useLowerUpperBound)
Johannes Doerferte4bd53b2015-03-08 19:49:50 +0000321 V = isl_val_sub_ui(V, 1);
Johannes Doerferte7044942015-02-24 11:58:30 +0000322 isl_set *SUB = isl_set_upper_bound_val(S, type, dim, V);
323
Johannes Doerfert8f8af432015-04-26 20:07:21 +0000324 if (useLowerUpperBound)
Johannes Doerferte7044942015-02-24 11:58:30 +0000325 return isl_set_union(SLB, SUB);
326 else
327 return isl_set_intersect(SLB, SUB);
328}
329
Tobias Grosser49ad36c2015-05-20 08:05:31 +0000330ScopArrayInfo::ScopArrayInfo(Value *BasePtr, Type *ElementType, isl_ctx *Ctx,
Johannes Doerfert1a28a892014-10-05 11:32:18 +0000331 const SmallVector<const SCEV *, 4> &DimensionSizes)
Tobias Grosser49ad36c2015-05-20 08:05:31 +0000332 : BasePtr(BasePtr), ElementType(ElementType),
333 DimensionSizes(DimensionSizes) {
Johannes Doerfert1a28a892014-10-05 11:32:18 +0000334 const std::string BasePtrName = getIslCompatibleName("MemRef_", BasePtr, "");
335 Id = isl_id_alloc(Ctx, BasePtrName.c_str(), this);
336}
337
338ScopArrayInfo::~ScopArrayInfo() { isl_id_free(Id); }
339
Tobias Grosser49ad36c2015-05-20 08:05:31 +0000340std::string ScopArrayInfo::getName() const { return isl_id_get_name(Id); }
341
342int ScopArrayInfo::getElemSizeInBytes() const {
343 return ElementType->getPrimitiveSizeInBits() / 8;
344}
345
Johannes Doerfert1a28a892014-10-05 11:32:18 +0000346isl_id *ScopArrayInfo::getBasePtrId() const { return isl_id_copy(Id); }
347
348void ScopArrayInfo::dump() const { print(errs()); }
349
350void ScopArrayInfo::print(raw_ostream &OS) const {
Tobias Grosser49ad36c2015-05-20 08:05:31 +0000351 OS.indent(8) << *getElementType() << " " << getName() << "[*]";
Johannes Doerfert1a28a892014-10-05 11:32:18 +0000352 for (unsigned u = 0; u < getNumberOfDimensions(); u++)
Tobias Grosser49ad36c2015-05-20 08:05:31 +0000353 OS << "[" << *DimensionSizes[u] << "]";
354 OS << " // Element size " << getElemSizeInBytes() << "\n";
Johannes Doerfert1a28a892014-10-05 11:32:18 +0000355}
356
357const ScopArrayInfo *
358ScopArrayInfo::getFromAccessFunction(__isl_keep isl_pw_multi_aff *PMA) {
359 isl_id *Id = isl_pw_multi_aff_get_tuple_id(PMA, isl_dim_out);
360 assert(Id && "Output dimension didn't have an ID");
361 return getFromId(Id);
362}
363
364const ScopArrayInfo *ScopArrayInfo::getFromId(isl_id *Id) {
365 void *User = isl_id_get_user(Id);
366 const ScopArrayInfo *SAI = static_cast<ScopArrayInfo *>(User);
367 isl_id_free(Id);
368 return SAI;
369}
370
Johannes Doerfert32868bf2014-08-01 08:13:25 +0000371const std::string
372MemoryAccess::getReductionOperatorStr(MemoryAccess::ReductionType RT) {
373 switch (RT) {
374 case MemoryAccess::RT_NONE:
375 llvm_unreachable("Requested a reduction operator string for a memory "
376 "access which isn't a reduction");
377 case MemoryAccess::RT_ADD:
378 return "+";
379 case MemoryAccess::RT_MUL:
380 return "*";
381 case MemoryAccess::RT_BOR:
382 return "|";
383 case MemoryAccess::RT_BXOR:
384 return "^";
385 case MemoryAccess::RT_BAND:
386 return "&";
387 }
388 llvm_unreachable("Unknown reduction type");
389 return "";
390}
391
Johannes Doerfertf6183392014-07-01 20:52:51 +0000392/// @brief Return the reduction type for a given binary operator
393static MemoryAccess::ReductionType getReductionType(const BinaryOperator *BinOp,
394 const Instruction *Load) {
395 if (!BinOp)
396 return MemoryAccess::RT_NONE;
397 switch (BinOp->getOpcode()) {
398 case Instruction::FAdd:
399 if (!BinOp->hasUnsafeAlgebra())
400 return MemoryAccess::RT_NONE;
401 // Fall through
402 case Instruction::Add:
403 return MemoryAccess::RT_ADD;
404 case Instruction::Or:
405 return MemoryAccess::RT_BOR;
406 case Instruction::Xor:
407 return MemoryAccess::RT_BXOR;
408 case Instruction::And:
409 return MemoryAccess::RT_BAND;
410 case Instruction::FMul:
411 if (!BinOp->hasUnsafeAlgebra())
412 return MemoryAccess::RT_NONE;
413 // Fall through
414 case Instruction::Mul:
415 if (DisableMultiplicativeReductions)
416 return MemoryAccess::RT_NONE;
417 return MemoryAccess::RT_MUL;
418 default:
419 return MemoryAccess::RT_NONE;
420 }
421}
Tobias Grosser75805372011-04-29 06:27:02 +0000422//===----------------------------------------------------------------------===//
423
424MemoryAccess::~MemoryAccess() {
Tobias Grosser6f48e0f2015-05-15 09:58:32 +0000425 isl_id_free(Id);
Tobias Grosser54a86e62011-08-18 06:31:46 +0000426 isl_map_free(AccessRelation);
Raghesh Aloor129e8672011-08-15 02:33:39 +0000427 isl_map_free(newAccessRelation);
Tobias Grosser75805372011-04-29 06:27:02 +0000428}
429
Johannes Doerfert8f7124c2014-09-12 11:00:49 +0000430static MemoryAccess::AccessType getMemoryAccessType(const IRAccess &Access) {
431 switch (Access.getType()) {
432 case IRAccess::READ:
433 return MemoryAccess::READ;
434 case IRAccess::MUST_WRITE:
435 return MemoryAccess::MUST_WRITE;
436 case IRAccess::MAY_WRITE:
437 return MemoryAccess::MAY_WRITE;
438 }
439 llvm_unreachable("Unknown IRAccess type!");
440}
441
Johannes Doerfert1a28a892014-10-05 11:32:18 +0000442const ScopArrayInfo *MemoryAccess::getScopArrayInfo() const {
443 isl_id *ArrayId = getArrayId();
444 void *User = isl_id_get_user(ArrayId);
445 const ScopArrayInfo *SAI = static_cast<ScopArrayInfo *>(User);
446 isl_id_free(ArrayId);
447 return SAI;
448}
449
Tobias Grosser4f663aa2015-03-30 11:52:59 +0000450__isl_give isl_id *MemoryAccess::getArrayId() const {
Johannes Doerfert5d83f092014-07-29 08:37:55 +0000451 return isl_map_get_tuple_id(AccessRelation, isl_dim_out);
452}
453
Tobias Grosser4f663aa2015-03-30 11:52:59 +0000454__isl_give isl_pw_multi_aff *MemoryAccess::applyScheduleToAccessRelation(
455 __isl_take isl_union_map *USchedule) const {
Johannes Doerferta99130f2014-10-13 12:58:03 +0000456 isl_map *Schedule, *ScheduledAccRel;
457 isl_union_set *UDomain;
458
459 UDomain = isl_union_set_from_set(getStatement()->getDomain());
460 USchedule = isl_union_map_intersect_domain(USchedule, UDomain);
461 Schedule = isl_map_from_union_map(USchedule);
462 ScheduledAccRel = isl_map_apply_domain(getAccessRelation(), Schedule);
463 return isl_pw_multi_aff_from_map(ScheduledAccRel);
464}
465
Tobias Grosser4f663aa2015-03-30 11:52:59 +0000466__isl_give isl_map *MemoryAccess::getOriginalAccessRelation() const {
Tobias Grosser5d453812011-10-06 00:04:11 +0000467 return isl_map_copy(AccessRelation);
468}
469
Johannes Doerferta99130f2014-10-13 12:58:03 +0000470std::string MemoryAccess::getOriginalAccessRelationStr() const {
Tobias Grosser5d453812011-10-06 00:04:11 +0000471 return stringFromIslObj(AccessRelation);
472}
473
Johannes Doerferta99130f2014-10-13 12:58:03 +0000474__isl_give isl_space *MemoryAccess::getOriginalAccessRelationSpace() const {
Tobias Grosser5e6813d2014-07-02 17:47:48 +0000475 return isl_map_get_space(AccessRelation);
476}
477
Tobias Grosser4f663aa2015-03-30 11:52:59 +0000478__isl_give isl_map *MemoryAccess::getNewAccessRelation() const {
Tobias Grosser5d453812011-10-06 00:04:11 +0000479 return isl_map_copy(newAccessRelation);
Tobias Grosser75805372011-04-29 06:27:02 +0000480}
481
Tobias Grosser4f663aa2015-03-30 11:52:59 +0000482__isl_give isl_basic_map *
483MemoryAccess::createBasicAccessMap(ScopStmt *Statement) {
Tobias Grosser084d8f72012-05-29 09:29:44 +0000484 isl_space *Space = isl_space_set_alloc(Statement->getIslCtx(), 0, 1);
Tobias Grossered295662012-09-11 13:50:21 +0000485 Space = isl_space_align_params(Space, Statement->getDomainSpace());
Tobias Grosser75805372011-04-29 06:27:02 +0000486
Tobias Grosser084d8f72012-05-29 09:29:44 +0000487 return isl_basic_map_from_domain_and_range(
Tobias Grosserabfbe632013-02-05 12:09:06 +0000488 isl_basic_set_universe(Statement->getDomainSpace()),
489 isl_basic_set_universe(Space));
Tobias Grosser75805372011-04-29 06:27:02 +0000490}
491
Tobias Grosser5e6813d2014-07-02 17:47:48 +0000492// Formalize no out-of-bound access assumption
493//
494// When delinearizing array accesses we optimistically assume that the
495// delinearized accesses do not access out of bound locations (the subscript
496// expression of each array evaluates for each statement instance that is
497// executed to a value that is larger than zero and strictly smaller than the
498// size of the corresponding dimension). The only exception is the outermost
Tobias Grosserf57d63f2014-08-03 21:07:30 +0000499// dimension for which we do not need to assume any upper bound. At this point
500// we formalize this assumption to ensure that at code generation time the
501// relevant run-time checks can be generated.
Tobias Grosser5e6813d2014-07-02 17:47:48 +0000502//
503// To find the set of constraints necessary to avoid out of bound accesses, we
504// first build the set of data locations that are not within array bounds. We
505// then apply the reverse access relation to obtain the set of iterations that
506// may contain invalid accesses and reduce this set of iterations to the ones
507// that are actually executed by intersecting them with the domain of the
508// statement. If we now project out all loop dimensions, we obtain a set of
509// parameters that may cause statement instances to be executed that may
510// possibly yield out of bound memory accesses. The complement of these
511// constraints is the set of constraints that needs to be assumed to ensure such
512// statement instances are never executed.
513void MemoryAccess::assumeNoOutOfBound(const IRAccess &Access) {
Johannes Doerferta99130f2014-10-13 12:58:03 +0000514 isl_space *Space = isl_space_range(getOriginalAccessRelationSpace());
Tobias Grosser5e6813d2014-07-02 17:47:48 +0000515 isl_set *Outside = isl_set_empty(isl_space_copy(Space));
Tobias Grosserf57d63f2014-08-03 21:07:30 +0000516 for (int i = 1, Size = Access.Subscripts.size(); i < Size; ++i) {
Tobias Grosser5e6813d2014-07-02 17:47:48 +0000517 isl_local_space *LS = isl_local_space_from_space(isl_space_copy(Space));
518 isl_pw_aff *Var =
519 isl_pw_aff_var_on_domain(isl_local_space_copy(LS), isl_dim_set, i);
520 isl_pw_aff *Zero = isl_pw_aff_zero_on_domain(LS);
521
522 isl_set *DimOutside;
523
Tobias Grosserf57d63f2014-08-03 21:07:30 +0000524 DimOutside = isl_pw_aff_lt_set(isl_pw_aff_copy(Var), Zero);
525 isl_pw_aff *SizeE = SCEVAffinator::getPwAff(Statement, Access.Sizes[i - 1]);
Tobias Grosser5e6813d2014-07-02 17:47:48 +0000526
Tobias Grosserf57d63f2014-08-03 21:07:30 +0000527 SizeE = isl_pw_aff_drop_dims(SizeE, isl_dim_in, 0,
528 Statement->getNumIterators());
529 SizeE = isl_pw_aff_add_dims(SizeE, isl_dim_in,
530 isl_space_dim(Space, isl_dim_set));
531 SizeE = isl_pw_aff_set_tuple_id(SizeE, isl_dim_in,
532 isl_space_get_tuple_id(Space, isl_dim_set));
Tobias Grosser5e6813d2014-07-02 17:47:48 +0000533
Tobias Grosserf57d63f2014-08-03 21:07:30 +0000534 DimOutside = isl_set_union(DimOutside, isl_pw_aff_le_set(SizeE, Var));
Tobias Grosser5e6813d2014-07-02 17:47:48 +0000535
536 Outside = isl_set_union(Outside, DimOutside);
537 }
538
539 Outside = isl_set_apply(Outside, isl_map_reverse(getAccessRelation()));
540 Outside = isl_set_intersect(Outside, Statement->getDomain());
541 Outside = isl_set_params(Outside);
542 Outside = isl_set_complement(Outside);
543 Statement->getParent()->addAssumption(Outside);
544 isl_space_free(Space);
545}
546
Johannes Doerferte7044942015-02-24 11:58:30 +0000547void MemoryAccess::computeBoundsOnAccessRelation(unsigned ElementSize) {
548 ScalarEvolution *SE = Statement->getParent()->getSE();
549
550 Value *Ptr = getPointerOperand(*getAccessInstruction());
551 if (!Ptr || !SE->isSCEVable(Ptr->getType()))
552 return;
553
554 auto *PtrSCEV = SE->getSCEV(Ptr);
555 if (isa<SCEVCouldNotCompute>(PtrSCEV))
556 return;
557
558 auto *BasePtrSCEV = SE->getPointerBase(PtrSCEV);
559 if (BasePtrSCEV && !isa<SCEVCouldNotCompute>(BasePtrSCEV))
560 PtrSCEV = SE->getMinusSCEV(PtrSCEV, BasePtrSCEV);
561
562 const ConstantRange &Range = SE->getSignedRange(PtrSCEV);
563 if (Range.isFullSet())
564 return;
565
Johannes Doerferte4bd53b2015-03-08 19:49:50 +0000566 bool isWrapping = Range.isSignWrappedSet();
Johannes Doerferte7044942015-02-24 11:58:30 +0000567 unsigned BW = Range.getBitWidth();
Johannes Doerferte4bd53b2015-03-08 19:49:50 +0000568 const auto LB = isWrapping ? Range.getLower() : Range.getSignedMin();
569 const auto UB = isWrapping ? Range.getUpper() : Range.getSignedMax();
570
571 auto Min = LB.sdiv(APInt(BW, ElementSize));
572 auto Max = (UB - APInt(BW, 1)).sdiv(APInt(BW, ElementSize));
Johannes Doerferte7044942015-02-24 11:58:30 +0000573
574 isl_set *AccessRange = isl_map_range(isl_map_copy(AccessRelation));
575 AccessRange =
576 addRangeBoundsToSet(AccessRange, ConstantRange(Min, Max), 0, isl_dim_set);
577 AccessRelation = isl_map_intersect_range(AccessRelation, AccessRange);
578}
579
Tobias Grosser619190d2015-03-30 17:22:28 +0000580__isl_give isl_map *MemoryAccess::foldAccess(const IRAccess &Access,
581 __isl_take isl_map *AccessRelation,
582 ScopStmt *Statement) {
583 int Size = Access.Subscripts.size();
584
585 for (int i = Size - 2; i >= 0; --i) {
586 isl_space *Space;
587 isl_map *MapOne, *MapTwo;
588 isl_pw_aff *DimSize = SCEVAffinator::getPwAff(Statement, Access.Sizes[i]);
589
590 isl_space *SpaceSize = isl_pw_aff_get_space(DimSize);
591 isl_pw_aff_free(DimSize);
592 isl_id *ParamId = isl_space_get_dim_id(SpaceSize, isl_dim_param, 0);
593
594 Space = isl_map_get_space(AccessRelation);
595 Space = isl_space_map_from_set(isl_space_range(Space));
596 Space = isl_space_align_params(Space, SpaceSize);
597
598 int ParamLocation = isl_space_find_dim_by_id(Space, isl_dim_param, ParamId);
599 isl_id_free(ParamId);
600
601 MapOne = isl_map_universe(isl_space_copy(Space));
602 for (int j = 0; j < Size; ++j)
603 MapOne = isl_map_equate(MapOne, isl_dim_in, j, isl_dim_out, j);
604 MapOne = isl_map_lower_bound_si(MapOne, isl_dim_in, i + 1, 0);
605
606 MapTwo = isl_map_universe(isl_space_copy(Space));
607 for (int j = 0; j < Size; ++j)
608 if (j < i || j > i + 1)
609 MapTwo = isl_map_equate(MapTwo, isl_dim_in, j, isl_dim_out, j);
610
611 isl_local_space *LS = isl_local_space_from_space(Space);
612 isl_constraint *C;
613 C = isl_equality_alloc(isl_local_space_copy(LS));
614 C = isl_constraint_set_constant_si(C, -1);
615 C = isl_constraint_set_coefficient_si(C, isl_dim_in, i, 1);
616 C = isl_constraint_set_coefficient_si(C, isl_dim_out, i, -1);
617 MapTwo = isl_map_add_constraint(MapTwo, C);
618 C = isl_equality_alloc(LS);
619 C = isl_constraint_set_coefficient_si(C, isl_dim_in, i + 1, 1);
620 C = isl_constraint_set_coefficient_si(C, isl_dim_out, i + 1, -1);
621 C = isl_constraint_set_coefficient_si(C, isl_dim_param, ParamLocation, 1);
622 MapTwo = isl_map_add_constraint(MapTwo, C);
623 MapTwo = isl_map_upper_bound_si(MapTwo, isl_dim_in, i + 1, -1);
624
625 MapOne = isl_map_union(MapOne, MapTwo);
626 AccessRelation = isl_map_apply_range(AccessRelation, MapOne);
627 }
628 return AccessRelation;
629}
630
Johannes Doerfert13c8cf22014-08-10 08:09:38 +0000631MemoryAccess::MemoryAccess(const IRAccess &Access, Instruction *AccInst,
Tobias Grosser6f48e0f2015-05-15 09:58:32 +0000632 ScopStmt *Statement, const ScopArrayInfo *SAI,
633 int Identifier)
Johannes Doerfert4c7ce472014-10-08 10:11:33 +0000634 : AccType(getMemoryAccessType(Access)), Statement(Statement), Inst(AccInst),
Johannes Doerfert8f7124c2014-09-12 11:00:49 +0000635 newAccessRelation(nullptr) {
Tobias Grosser75805372011-04-29 06:27:02 +0000636
Johannes Doerfert5d83f092014-07-29 08:37:55 +0000637 isl_ctx *Ctx = Statement->getIslCtx();
Tobias Grosser9759f852011-11-10 12:44:55 +0000638 BaseAddr = Access.getBase();
Johannes Doerfert79fc23f2014-07-24 23:48:02 +0000639 BaseName = getIslCompatibleName("MemRef_", getBaseAddr(), "");
Johannes Doerfert1a28a892014-10-05 11:32:18 +0000640
641 isl_id *BaseAddrId = SAI->getBasePtrId();
Tobias Grosser5683df42011-11-09 22:34:34 +0000642
Tobias Grossere29d31c2015-05-15 12:24:09 +0000643 auto IdName = "__polly_array_ref_ " + std::to_string(Identifier);
644 Id = isl_id_alloc(Ctx, IdName.c_str(), nullptr);
Tobias Grosser6f48e0f2015-05-15 09:58:32 +0000645
Tobias Grossera1879642011-12-20 10:43:14 +0000646 if (!Access.isAffine()) {
Tobias Grosser4f967492013-06-23 05:21:18 +0000647 // We overapproximate non-affine accesses with a possible access to the
648 // whole array. For read accesses it does not make a difference, if an
649 // access must or may happen. However, for write accesses it is important to
650 // differentiate between writes that must happen and writes that may happen.
Tobias Grosser04d6ae62013-06-23 06:04:54 +0000651 AccessRelation = isl_map_from_basic_map(createBasicAccessMap(Statement));
Johannes Doerfert5d83f092014-07-29 08:37:55 +0000652 AccessRelation =
653 isl_map_set_tuple_id(AccessRelation, isl_dim_out, BaseAddrId);
Johannes Doerferte7044942015-02-24 11:58:30 +0000654
655 computeBoundsOnAccessRelation(Access.getElemSizeInBytes());
Tobias Grossera1879642011-12-20 10:43:14 +0000656 return;
657 }
658
Johannes Doerfert5d83f092014-07-29 08:37:55 +0000659 isl_space *Space = isl_space_alloc(Ctx, 0, Statement->getNumIterators(), 0);
Tobias Grosser79baa212014-04-10 08:38:02 +0000660 AccessRelation = isl_map_universe(Space);
Tobias Grossera1879642011-12-20 10:43:14 +0000661
Tobias Grosser79baa212014-04-10 08:38:02 +0000662 for (int i = 0, Size = Access.Subscripts.size(); i < Size; ++i) {
Sebastian Pop18016682014-04-08 21:20:44 +0000663 isl_pw_aff *Affine =
664 SCEVAffinator::getPwAff(Statement, Access.Subscripts[i]);
Tobias Grosser75805372011-04-29 06:27:02 +0000665
Sebastian Pop422e33f2014-06-03 18:16:31 +0000666 if (Size == 1) {
667 // For the non delinearized arrays, divide the access function of the last
668 // subscript by the size of the elements in the array.
Sebastian Pop18016682014-04-08 21:20:44 +0000669 //
670 // A stride one array access in C expressed as A[i] is expressed in
671 // LLVM-IR as something like A[i * elementsize]. This hides the fact that
672 // two subsequent values of 'i' index two values that are stored next to
673 // each other in memory. By this division we make this characteristic
674 // obvious again.
Johannes Doerfert5d83f092014-07-29 08:37:55 +0000675 isl_val *v = isl_val_int_from_si(Ctx, Access.getElemSizeInBytes());
Sebastian Pop18016682014-04-08 21:20:44 +0000676 Affine = isl_pw_aff_scale_down_val(Affine, v);
677 }
678
679 isl_map *SubscriptMap = isl_map_from_pw_aff(Affine);
680
Tobias Grosser79baa212014-04-10 08:38:02 +0000681 AccessRelation = isl_map_flat_range_product(AccessRelation, SubscriptMap);
Sebastian Pop18016682014-04-08 21:20:44 +0000682 }
683
Tobias Grosser619190d2015-03-30 17:22:28 +0000684 AccessRelation = foldAccess(Access, AccessRelation, Statement);
685
Tobias Grosser79baa212014-04-10 08:38:02 +0000686 Space = Statement->getDomainSpace();
Tobias Grosserabfbe632013-02-05 12:09:06 +0000687 AccessRelation = isl_map_set_tuple_id(
688 AccessRelation, isl_dim_in, isl_space_get_tuple_id(Space, isl_dim_set));
Johannes Doerfert5d83f092014-07-29 08:37:55 +0000689 AccessRelation =
690 isl_map_set_tuple_id(AccessRelation, isl_dim_out, BaseAddrId);
691
Tobias Grosser5e6813d2014-07-02 17:47:48 +0000692 assumeNoOutOfBound(Access);
Tobias Grosseraa660a92015-03-30 00:07:50 +0000693 AccessRelation = isl_map_gist_domain(AccessRelation, Statement->getDomain());
Johannes Doerfert5d83f092014-07-29 08:37:55 +0000694 isl_space_free(Space);
Tobias Grosser8cae72f2011-11-08 15:41:08 +0000695}
Tobias Grosser30b8a092011-08-18 07:51:37 +0000696
Tobias Grosser8cae72f2011-11-08 15:41:08 +0000697void MemoryAccess::realignParams() {
Tobias Grosser6defb5b2014-04-10 08:37:44 +0000698 isl_space *ParamSpace = Statement->getParent()->getParamSpace();
Tobias Grosser37487052011-10-06 00:03:42 +0000699 AccessRelation = isl_map_align_params(AccessRelation, ParamSpace);
Tobias Grosser75805372011-04-29 06:27:02 +0000700}
701
Johannes Doerfert32868bf2014-08-01 08:13:25 +0000702const std::string MemoryAccess::getReductionOperatorStr() const {
703 return MemoryAccess::getReductionOperatorStr(getReductionType());
704}
705
Tobias Grosser6f48e0f2015-05-15 09:58:32 +0000706__isl_give isl_id *MemoryAccess::getId() const { return isl_id_copy(Id); }
707
Johannes Doerfertf6183392014-07-01 20:52:51 +0000708raw_ostream &polly::operator<<(raw_ostream &OS,
709 MemoryAccess::ReductionType RT) {
Johannes Doerfert32868bf2014-08-01 08:13:25 +0000710 if (RT == MemoryAccess::RT_NONE)
Johannes Doerfertf6183392014-07-01 20:52:51 +0000711 OS << "NONE";
Johannes Doerfert32868bf2014-08-01 08:13:25 +0000712 else
713 OS << MemoryAccess::getReductionOperatorStr(RT);
Johannes Doerfertf6183392014-07-01 20:52:51 +0000714 return OS;
715}
716
Tobias Grosser75805372011-04-29 06:27:02 +0000717void MemoryAccess::print(raw_ostream &OS) const {
Johannes Doerfert4c7ce472014-10-08 10:11:33 +0000718 switch (AccType) {
Tobias Grosserb58f6a42013-07-13 20:41:24 +0000719 case READ:
Johannes Doerfert6780bc32014-06-26 18:47:03 +0000720 OS.indent(12) << "ReadAccess :=\t";
Tobias Grosser4f967492013-06-23 05:21:18 +0000721 break;
Tobias Grosserb58f6a42013-07-13 20:41:24 +0000722 case MUST_WRITE:
Johannes Doerfert6780bc32014-06-26 18:47:03 +0000723 OS.indent(12) << "MustWriteAccess :=\t";
Tobias Grosser4f967492013-06-23 05:21:18 +0000724 break;
Tobias Grosserb58f6a42013-07-13 20:41:24 +0000725 case MAY_WRITE:
Johannes Doerfert6780bc32014-06-26 18:47:03 +0000726 OS.indent(12) << "MayWriteAccess :=\t";
Tobias Grosser4f967492013-06-23 05:21:18 +0000727 break;
728 }
Johannes Doerfert0ff23ec2015-02-06 20:13:15 +0000729 OS << "[Reduction Type: " << getReductionType() << "] ";
730 OS << "[Scalar: " << isScalar() << "]\n";
Johannes Doerferta99130f2014-10-13 12:58:03 +0000731 OS.indent(16) << getOriginalAccessRelationStr() << ";\n";
Tobias Grosser75805372011-04-29 06:27:02 +0000732}
733
Tobias Grosser74394f02013-01-14 22:40:23 +0000734void MemoryAccess::dump() const { print(errs()); }
Tobias Grosser75805372011-04-29 06:27:02 +0000735
736// Create a map in the size of the provided set domain, that maps from the
737// one element of the provided set domain to another element of the provided
738// set domain.
739// The mapping is limited to all points that are equal in all but the last
740// dimension and for which the last dimension of the input is strict smaller
741// than the last dimension of the output.
742//
743// getEqualAndLarger(set[i0, i1, ..., iX]):
744//
745// set[i0, i1, ..., iX] -> set[o0, o1, ..., oX]
746// : i0 = o0, i1 = o1, ..., i(X-1) = o(X-1), iX < oX
747//
Tobias Grosserf5338802011-10-06 00:03:35 +0000748static isl_map *getEqualAndLarger(isl_space *setDomain) {
Tobias Grosserc327932c2012-02-01 14:23:36 +0000749 isl_space *Space = isl_space_map_from_set(setDomain);
750 isl_map *Map = isl_map_universe(isl_space_copy(Space));
751 isl_local_space *MapLocalSpace = isl_local_space_from_space(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
765 //
Tobias Grosseredab1352013-06-21 06:41:31 +0000766 isl_val *v;
767 isl_ctx *Ctx = isl_map_get_ctx(Map);
Tobias Grosserf5338802011-10-06 00:03:35 +0000768 isl_constraint *c = isl_inequality_alloc(isl_local_space_copy(MapLocalSpace));
Tobias Grosseredab1352013-06-21 06:41:31 +0000769 v = isl_val_int_from_si(Ctx, -1);
770 c = isl_constraint_set_coefficient_val(c, isl_dim_in, lastDimension, v);
771 v = isl_val_int_from_si(Ctx, 1);
772 c = isl_constraint_set_coefficient_val(c, isl_dim_out, lastDimension, v);
773 v = isl_val_int_from_si(Ctx, -1);
774 c = isl_constraint_set_constant_val(c, v);
Tobias Grosser75805372011-04-29 06:27:02 +0000775
Tobias Grosserc327932c2012-02-01 14:23:36 +0000776 Map = isl_map_add_constraint(Map, c);
Tobias Grosser75805372011-04-29 06:27:02 +0000777
Tobias Grosser23b36662011-10-17 08:32:36 +0000778 isl_local_space_free(MapLocalSpace);
Tobias Grosserc327932c2012-02-01 14:23:36 +0000779 return Map;
Tobias Grosser75805372011-04-29 06:27:02 +0000780}
781
Tobias Grosser4f663aa2015-03-30 11:52:59 +0000782__isl_give isl_set *
783MemoryAccess::getStride(__isl_take const isl_map *Schedule) const {
Tobias Grosserabfbe632013-02-05 12:09:06 +0000784 isl_map *S = const_cast<isl_map *>(Schedule);
Johannes Doerferta99130f2014-10-13 12:58:03 +0000785 isl_map *AccessRelation = getAccessRelation();
Sebastian Popa00a0292012-12-18 07:46:06 +0000786 isl_space *Space = isl_space_range(isl_map_get_space(S));
787 isl_map *NextScatt = getEqualAndLarger(Space);
Tobias Grosser75805372011-04-29 06:27:02 +0000788
Sebastian Popa00a0292012-12-18 07:46:06 +0000789 S = isl_map_reverse(S);
790 NextScatt = isl_map_lexmin(NextScatt);
Tobias Grosser75805372011-04-29 06:27:02 +0000791
Sebastian Popa00a0292012-12-18 07:46:06 +0000792 NextScatt = isl_map_apply_range(NextScatt, isl_map_copy(S));
793 NextScatt = isl_map_apply_range(NextScatt, isl_map_copy(AccessRelation));
794 NextScatt = isl_map_apply_domain(NextScatt, S);
795 NextScatt = isl_map_apply_domain(NextScatt, AccessRelation);
Tobias Grosser75805372011-04-29 06:27:02 +0000796
Sebastian Popa00a0292012-12-18 07:46:06 +0000797 isl_set *Deltas = isl_map_deltas(NextScatt);
798 return Deltas;
Tobias Grosser75805372011-04-29 06:27:02 +0000799}
800
Sebastian Popa00a0292012-12-18 07:46:06 +0000801bool MemoryAccess::isStrideX(__isl_take const isl_map *Schedule,
Tobias Grosser28dd4862012-01-24 16:42:16 +0000802 int StrideWidth) const {
803 isl_set *Stride, *StrideX;
804 bool IsStrideX;
Tobias Grosser75805372011-04-29 06:27:02 +0000805
Sebastian Popa00a0292012-12-18 07:46:06 +0000806 Stride = getStride(Schedule);
Tobias Grosser28dd4862012-01-24 16:42:16 +0000807 StrideX = isl_set_universe(isl_set_get_space(Stride));
808 StrideX = isl_set_fix_si(StrideX, isl_dim_set, 0, StrideWidth);
809 IsStrideX = isl_set_is_equal(Stride, StrideX);
Tobias Grosser75805372011-04-29 06:27:02 +0000810
Tobias Grosser28dd4862012-01-24 16:42:16 +0000811 isl_set_free(StrideX);
Tobias Grosserdea98232012-01-17 20:34:27 +0000812 isl_set_free(Stride);
Tobias Grosserb76f38532011-08-20 11:11:25 +0000813
Tobias Grosser28dd4862012-01-24 16:42:16 +0000814 return IsStrideX;
815}
816
Sebastian Popa00a0292012-12-18 07:46:06 +0000817bool MemoryAccess::isStrideZero(const isl_map *Schedule) const {
818 return isStrideX(Schedule, 0);
Tobias Grosser75805372011-04-29 06:27:02 +0000819}
820
Tobias Grosser79baa212014-04-10 08:38:02 +0000821bool MemoryAccess::isScalar() const {
822 return isl_map_n_out(AccessRelation) == 0;
823}
824
Sebastian Popa00a0292012-12-18 07:46:06 +0000825bool MemoryAccess::isStrideOne(const isl_map *Schedule) const {
826 return isStrideX(Schedule, 1);
Tobias Grosser75805372011-04-29 06:27:02 +0000827}
828
Tobias Grosser5d453812011-10-06 00:04:11 +0000829void MemoryAccess::setNewAccessRelation(isl_map *newAccess) {
Tobias Grosserb76f38532011-08-20 11:11:25 +0000830 isl_map_free(newAccessRelation);
Raghesh Aloor7a04f4f2011-08-03 13:47:59 +0000831 newAccessRelation = newAccess;
Raghesh Aloor3cb66282011-07-12 17:14:03 +0000832}
Tobias Grosser75805372011-04-29 06:27:02 +0000833
834//===----------------------------------------------------------------------===//
Tobias Grossercf3942d2011-10-06 00:04:05 +0000835
Tobias Grosser54839312015-04-21 11:37:25 +0000836isl_map *ScopStmt::getSchedule() const { return isl_map_copy(Schedule); }
Tobias Grossercf3942d2011-10-06 00:04:05 +0000837
Tobias Grosser37eb4222014-02-20 21:43:54 +0000838void ScopStmt::restrictDomain(__isl_take isl_set *NewDomain) {
839 assert(isl_set_is_subset(NewDomain, Domain) &&
840 "New domain is not a subset of old domain!");
841 isl_set_free(Domain);
842 Domain = NewDomain;
Tobias Grosser54839312015-04-21 11:37:25 +0000843 Schedule = isl_map_intersect_domain(Schedule, isl_set_copy(Domain));
Tobias Grosser37eb4222014-02-20 21:43:54 +0000844}
845
Tobias Grosser54839312015-04-21 11:37:25 +0000846void ScopStmt::setSchedule(__isl_take isl_map *NewSchedule) {
847 assert(NewSchedule && "New schedule is nullptr");
848 isl_map_free(Schedule);
849 Schedule = NewSchedule;
Tobias Grosserb76f38532011-08-20 11:11:25 +0000850}
851
Tobias Grosser54839312015-04-21 11:37:25 +0000852void ScopStmt::buildSchedule(SmallVectorImpl<unsigned> &ScheduleVec) {
Tobias Grosser78d8a3d2012-01-17 20:34:23 +0000853 unsigned NbIterators = getNumIterators();
Tobias Grosser54839312015-04-21 11:37:25 +0000854 unsigned NbScheduleDims = Parent.getMaxLoopDepth() * 2 + 1;
Tobias Grosser78d8a3d2012-01-17 20:34:23 +0000855
Tobias Grosser54839312015-04-21 11:37:25 +0000856 isl_space *Space = isl_space_set_alloc(getIslCtx(), 0, NbScheduleDims);
Tobias Grosser78d8a3d2012-01-17 20:34:23 +0000857
Tobias Grosser54839312015-04-21 11:37:25 +0000858 Schedule = isl_map_from_domain_and_range(isl_set_universe(getDomainSpace()),
Tobias Grosser654af8f2015-04-21 11:42:01 +0000859 isl_set_universe(Space));
Tobias Grosser75805372011-04-29 06:27:02 +0000860
861 // Loop dimensions.
Tobias Grosser78d8a3d2012-01-17 20:34:23 +0000862 for (unsigned i = 0; i < NbIterators; ++i)
Tobias Grosser654af8f2015-04-21 11:42:01 +0000863 Schedule = isl_map_equate(Schedule, isl_dim_out, 2 * i + 1, isl_dim_in, i);
Tobias Grosser75805372011-04-29 06:27:02 +0000864
865 // Constant dimensions
Tobias Grosser78d8a3d2012-01-17 20:34:23 +0000866 for (unsigned i = 0; i < NbIterators + 1; ++i)
Tobias Grosser54839312015-04-21 11:37:25 +0000867 Schedule = isl_map_fix_si(Schedule, isl_dim_out, 2 * i, ScheduleVec[i]);
Tobias Grosser75805372011-04-29 06:27:02 +0000868
Tobias Grosser54839312015-04-21 11:37:25 +0000869 // Fill schedule dimensions.
870 for (unsigned i = 2 * NbIterators + 1; i < NbScheduleDims; ++i)
871 Schedule = isl_map_fix_si(Schedule, isl_dim_out, i, 0);
Tobias Grosser75805372011-04-29 06:27:02 +0000872
Tobias Grosser54839312015-04-21 11:37:25 +0000873 Schedule = isl_map_align_params(Schedule, Parent.getParamSpace());
Tobias Grosser75805372011-04-29 06:27:02 +0000874}
875
Johannes Doerfertff9d1982015-02-24 12:00:50 +0000876void ScopStmt::buildAccesses(TempScop &tempScop, BasicBlock *Block,
877 bool isApproximated) {
878 AccFuncSetType *AFS = tempScop.getAccessFunctions(Block);
879 if (!AFS)
880 return;
881
882 for (auto &AccessPair : *AFS) {
883 IRAccess &Access = AccessPair.first;
Johannes Doerfert1a28a892014-10-05 11:32:18 +0000884 Instruction *AccessInst = AccessPair.second;
885
Tobias Grosser49ad36c2015-05-20 08:05:31 +0000886 Type *ElementType = getAccessInstType(AccessInst);
Johannes Doerfert80ef1102014-11-07 08:31:31 +0000887 const ScopArrayInfo *SAI = getParent()->getOrCreateScopArrayInfo(
Tobias Grosser49ad36c2015-05-20 08:05:31 +0000888 Access.getBase(), ElementType, Access.Sizes);
Johannes Doerfert80ef1102014-11-07 08:31:31 +0000889
Johannes Doerfertff9d1982015-02-24 12:00:50 +0000890 if (isApproximated && Access.isWrite())
891 Access.setMayWrite();
892
Tobias Grosser6f48e0f2015-05-15 09:58:32 +0000893 MemAccs.push_back(
Tobias Grosser4ac75ba2015-05-15 12:24:12 +0000894 new MemoryAccess(Access, AccessInst, this, SAI, MemAccs.size()));
Tobias Grosserd6aafa72014-02-20 21:29:09 +0000895
896 // We do not track locations for scalar memory accesses at the moment.
897 //
898 // We do not have a use for this information at the moment. If we need this
899 // at some point, the "instruction -> access" mapping needs to be enhanced
900 // as a single instruction could then possibly perform multiple accesses.
Johannes Doerfert1a28a892014-10-05 11:32:18 +0000901 if (!Access.isScalar()) {
902 assert(!InstructionToAccess.count(AccessInst) &&
Tobias Grosser3fc91542014-02-20 21:43:45 +0000903 "Unexpected 1-to-N mapping on instruction to access map!");
Johannes Doerfert1a28a892014-10-05 11:32:18 +0000904 InstructionToAccess[AccessInst] = MemAccs.back();
Tobias Grosserd6aafa72014-02-20 21:29:09 +0000905 }
Tobias Grosser75805372011-04-29 06:27:02 +0000906 }
907}
908
Tobias Grosser8cae72f2011-11-08 15:41:08 +0000909void ScopStmt::realignParams() {
Johannes Doerfertf6752892014-06-13 18:01:45 +0000910 for (MemoryAccess *MA : *this)
911 MA->realignParams();
Tobias Grosser8cae72f2011-11-08 15:41:08 +0000912
913 Domain = isl_set_align_params(Domain, Parent.getParamSpace());
Tobias Grosser54839312015-04-21 11:37:25 +0000914 Schedule = isl_map_align_params(Schedule, Parent.getParamSpace());
Tobias Grosser8cae72f2011-11-08 15:41:08 +0000915}
916
Tobias Grosser65b00582011-11-08 15:41:19 +0000917__isl_give isl_set *ScopStmt::buildConditionSet(const Comparison &Comp) {
Tobias Grossera601fbd2011-11-09 22:34:44 +0000918 isl_pw_aff *L = SCEVAffinator::getPwAff(this, Comp.getLHS());
919 isl_pw_aff *R = SCEVAffinator::getPwAff(this, Comp.getRHS());
Tobias Grosser75805372011-04-29 06:27:02 +0000920
Tobias Grosserd2795d02011-08-18 07:51:40 +0000921 switch (Comp.getPred()) {
Tobias Grosser75805372011-04-29 06:27:02 +0000922 case ICmpInst::ICMP_EQ:
Tobias Grosser048c8792011-10-23 20:59:20 +0000923 return isl_pw_aff_eq_set(L, R);
Tobias Grosser75805372011-04-29 06:27:02 +0000924 case ICmpInst::ICMP_NE:
Tobias Grosser048c8792011-10-23 20:59:20 +0000925 return isl_pw_aff_ne_set(L, R);
Tobias Grosser75805372011-04-29 06:27:02 +0000926 case ICmpInst::ICMP_SLT:
Tobias Grosser048c8792011-10-23 20:59:20 +0000927 return isl_pw_aff_lt_set(L, R);
Tobias Grosser75805372011-04-29 06:27:02 +0000928 case ICmpInst::ICMP_SLE:
Tobias Grosser048c8792011-10-23 20:59:20 +0000929 return isl_pw_aff_le_set(L, R);
Tobias Grosserd2795d02011-08-18 07:51:40 +0000930 case ICmpInst::ICMP_SGT:
Tobias Grosser048c8792011-10-23 20:59:20 +0000931 return isl_pw_aff_gt_set(L, R);
Tobias Grosser75805372011-04-29 06:27:02 +0000932 case ICmpInst::ICMP_SGE:
Tobias Grosser048c8792011-10-23 20:59:20 +0000933 return isl_pw_aff_ge_set(L, R);
Tobias Grosserd2795d02011-08-18 07:51:40 +0000934 case ICmpInst::ICMP_ULT:
Tobias Grosserbfbc3692015-01-09 00:01:33 +0000935 return isl_pw_aff_lt_set(L, R);
Tobias Grosserd2795d02011-08-18 07:51:40 +0000936 case ICmpInst::ICMP_UGT:
Tobias Grosserbfbc3692015-01-09 00:01:33 +0000937 return isl_pw_aff_gt_set(L, R);
Tobias Grosserd2795d02011-08-18 07:51:40 +0000938 case ICmpInst::ICMP_ULE:
Tobias Grosserbfbc3692015-01-09 00:01:33 +0000939 return isl_pw_aff_le_set(L, R);
Tobias Grosser75805372011-04-29 06:27:02 +0000940 case ICmpInst::ICMP_UGE:
Tobias Grosserbfbc3692015-01-09 00:01:33 +0000941 return isl_pw_aff_ge_set(L, R);
Tobias Grosser75805372011-04-29 06:27:02 +0000942 default:
943 llvm_unreachable("Non integer predicate not supported");
944 }
Tobias Grosser75805372011-04-29 06:27:02 +0000945}
946
Tobias Grossere19661e2011-10-07 08:46:57 +0000947__isl_give isl_set *ScopStmt::addLoopBoundsToDomain(__isl_take isl_set *Domain,
Tobias Grosser60b54f12011-11-08 15:41:28 +0000948 TempScop &tempScop) {
Tobias Grossere19661e2011-10-07 08:46:57 +0000949 isl_space *Space;
950 isl_local_space *LocalSpace;
Tobias Grosser75805372011-04-29 06:27:02 +0000951
Tobias Grossere19661e2011-10-07 08:46:57 +0000952 Space = isl_set_get_space(Domain);
953 LocalSpace = isl_local_space_from_space(Space);
Tobias Grosserf5338802011-10-06 00:03:35 +0000954
Johannes Doerfert5ad8a6a2014-11-01 01:14:56 +0000955 ScalarEvolution *SE = getParent()->getSE();
Tobias Grosser75805372011-04-29 06:27:02 +0000956 for (int i = 0, e = getNumIterators(); i != e; ++i) {
Tobias Grosser9b13d3d2011-10-06 22:32:58 +0000957 isl_aff *Zero = isl_aff_zero_on_domain(isl_local_space_copy(LocalSpace));
Tobias Grosserabfbe632013-02-05 12:09:06 +0000958 isl_pw_aff *IV =
959 isl_pw_aff_from_aff(isl_aff_set_coefficient_si(Zero, isl_dim_in, i, 1));
Tobias Grosser75805372011-04-29 06:27:02 +0000960
Tobias Grosser9b13d3d2011-10-06 22:32:58 +0000961 // 0 <= IV.
962 isl_set *LowerBound = isl_pw_aff_nonneg_set(isl_pw_aff_copy(IV));
963 Domain = isl_set_intersect(Domain, LowerBound);
964
965 // IV <= LatchExecutions.
Hongbin Zheng27f3afb2011-04-30 03:26:51 +0000966 const Loop *L = getLoopForDimension(i);
Johannes Doerfert5ad8a6a2014-11-01 01:14:56 +0000967 const SCEV *LatchExecutions = SE->getBackedgeTakenCount(L);
Tobias Grosser9b13d3d2011-10-06 22:32:58 +0000968 isl_pw_aff *UpperBound = SCEVAffinator::getPwAff(this, LatchExecutions);
969 isl_set *UpperBoundSet = isl_pw_aff_le_set(IV, UpperBound);
Tobias Grosser75805372011-04-29 06:27:02 +0000970 Domain = isl_set_intersect(Domain, UpperBoundSet);
971 }
972
Tobias Grosserf5338802011-10-06 00:03:35 +0000973 isl_local_space_free(LocalSpace);
Tobias Grossere19661e2011-10-07 08:46:57 +0000974 return Domain;
Tobias Grosser75805372011-04-29 06:27:02 +0000975}
976
Tobias Grossere602a072013-05-07 07:30:56 +0000977__isl_give isl_set *ScopStmt::addConditionsToDomain(__isl_take isl_set *Domain,
978 TempScop &tempScop,
979 const Region &CurRegion) {
Tobias Grossere19661e2011-10-07 08:46:57 +0000980 const Region *TopRegion = tempScop.getMaxRegion().getParent(),
Tobias Grosserd7e58642013-04-10 06:55:45 +0000981 *CurrentRegion = &CurRegion;
Johannes Doerfertff9d1982015-02-24 12:00:50 +0000982 const BasicBlock *BranchingBB = BB ? BB : R->getEntry();
Tobias Grosser75805372011-04-29 06:27:02 +0000983
Tobias Grosser75805372011-04-29 06:27:02 +0000984 do {
Tobias Grossere19661e2011-10-07 08:46:57 +0000985 if (BranchingBB != CurrentRegion->getEntry()) {
986 if (const BBCond *Condition = tempScop.getBBCond(BranchingBB))
Tobias Grosser083d3d32014-06-28 08:59:45 +0000987 for (const auto &C : *Condition) {
988 isl_set *ConditionSet = buildConditionSet(C);
Tobias Grossere19661e2011-10-07 08:46:57 +0000989 Domain = isl_set_intersect(Domain, ConditionSet);
Tobias Grosser75805372011-04-29 06:27:02 +0000990 }
991 }
Tobias Grossere19661e2011-10-07 08:46:57 +0000992 BranchingBB = CurrentRegion->getEntry();
993 CurrentRegion = CurrentRegion->getParent();
994 } while (TopRegion != CurrentRegion);
Tobias Grosser75805372011-04-29 06:27:02 +0000995
Tobias Grossere19661e2011-10-07 08:46:57 +0000996 return Domain;
Tobias Grosser75805372011-04-29 06:27:02 +0000997}
998
Tobias Grossere602a072013-05-07 07:30:56 +0000999__isl_give isl_set *ScopStmt::buildDomain(TempScop &tempScop,
1000 const Region &CurRegion) {
Tobias Grossere19661e2011-10-07 08:46:57 +00001001 isl_space *Space;
1002 isl_set *Domain;
Tobias Grosser084d8f72012-05-29 09:29:44 +00001003 isl_id *Id;
Tobias Grossere19661e2011-10-07 08:46:57 +00001004
1005 Space = isl_space_set_alloc(getIslCtx(), 0, getNumIterators());
1006
Tobias Grosser084d8f72012-05-29 09:29:44 +00001007 Id = isl_id_alloc(getIslCtx(), getBaseName(), this);
1008
Tobias Grossere19661e2011-10-07 08:46:57 +00001009 Domain = isl_set_universe(Space);
Tobias Grossere19661e2011-10-07 08:46:57 +00001010 Domain = addLoopBoundsToDomain(Domain, tempScop);
1011 Domain = addConditionsToDomain(Domain, tempScop, CurRegion);
Tobias Grosser084d8f72012-05-29 09:29:44 +00001012 Domain = isl_set_set_tuple_id(Domain, Id);
Tobias Grossere19661e2011-10-07 08:46:57 +00001013
1014 return Domain;
Tobias Grosser75805372011-04-29 06:27:02 +00001015}
1016
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001017void ScopStmt::deriveAssumptionsFromGEP(GetElementPtrInst *GEP) {
1018 int Dimension = 0;
1019 isl_ctx *Ctx = Parent.getIslCtx();
1020 isl_local_space *LSpace = isl_local_space_from_space(getDomainSpace());
1021 Type *Ty = GEP->getPointerOperandType();
1022 ScalarEvolution &SE = *Parent.getSE();
1023
1024 if (auto *PtrTy = dyn_cast<PointerType>(Ty)) {
1025 Dimension = 1;
1026 Ty = PtrTy->getElementType();
1027 }
1028
1029 while (auto ArrayTy = dyn_cast<ArrayType>(Ty)) {
1030 unsigned int Operand = 1 + Dimension;
1031
1032 if (GEP->getNumOperands() <= Operand)
1033 break;
1034
1035 const SCEV *Expr = SE.getSCEV(GEP->getOperand(Operand));
1036
1037 if (isAffineExpr(&Parent.getRegion(), Expr, SE)) {
1038 isl_pw_aff *AccessOffset = SCEVAffinator::getPwAff(this, Expr);
1039 AccessOffset =
1040 isl_pw_aff_set_tuple_id(AccessOffset, isl_dim_in, getDomainId());
1041
1042 isl_pw_aff *DimSize = isl_pw_aff_from_aff(isl_aff_val_on_domain(
1043 isl_local_space_copy(LSpace),
1044 isl_val_int_from_si(Ctx, ArrayTy->getNumElements())));
1045
1046 isl_set *OutOfBound = isl_pw_aff_ge_set(AccessOffset, DimSize);
1047 OutOfBound = isl_set_intersect(getDomain(), OutOfBound);
1048 OutOfBound = isl_set_params(OutOfBound);
1049 isl_set *InBound = isl_set_complement(OutOfBound);
1050 isl_set *Executed = isl_set_params(getDomain());
1051
1052 // A => B == !A or B
1053 isl_set *InBoundIfExecuted =
1054 isl_set_union(isl_set_complement(Executed), InBound);
1055
1056 Parent.addAssumption(InBoundIfExecuted);
1057 }
1058
1059 Dimension += 1;
1060 Ty = ArrayTy->getElementType();
1061 }
1062
1063 isl_local_space_free(LSpace);
1064}
1065
Johannes Doerfertff9d1982015-02-24 12:00:50 +00001066void ScopStmt::deriveAssumptions(BasicBlock *Block) {
1067 for (Instruction &Inst : *Block)
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001068 if (auto *GEP = dyn_cast<GetElementPtrInst>(&Inst))
1069 deriveAssumptionsFromGEP(GEP);
1070}
1071
Tobias Grosser74394f02013-01-14 22:40:23 +00001072ScopStmt::ScopStmt(Scop &parent, TempScop &tempScop, const Region &CurRegion,
Johannes Doerfertff9d1982015-02-24 12:00:50 +00001073 Region &R, SmallVectorImpl<Loop *> &Nest,
Tobias Grosser54839312015-04-21 11:37:25 +00001074 SmallVectorImpl<unsigned> &ScheduleVec)
Johannes Doerfertff9d1982015-02-24 12:00:50 +00001075 : Parent(parent), BB(nullptr), R(&R), Build(nullptr),
1076 NestLoops(Nest.size()) {
1077 // Setup the induction variables.
1078 for (unsigned i = 0, e = Nest.size(); i < e; ++i)
1079 NestLoops[i] = Nest[i];
1080
1081 BaseName = getIslCompatibleName("Stmt_(", R.getNameStr(), ")");
1082
1083 Domain = buildDomain(tempScop, CurRegion);
Tobias Grosser54839312015-04-21 11:37:25 +00001084 buildSchedule(ScheduleVec);
Johannes Doerfertff9d1982015-02-24 12:00:50 +00001085
1086 BasicBlock *EntryBB = R.getEntry();
1087 for (BasicBlock *Block : R.blocks()) {
1088 buildAccesses(tempScop, Block, Block != EntryBB);
1089 deriveAssumptions(Block);
1090 }
1091 checkForReductions();
1092}
1093
1094ScopStmt::ScopStmt(Scop &parent, TempScop &tempScop, const Region &CurRegion,
Sebastian Pop860e0212013-02-15 21:26:44 +00001095 BasicBlock &bb, SmallVectorImpl<Loop *> &Nest,
Tobias Grosser54839312015-04-21 11:37:25 +00001096 SmallVectorImpl<unsigned> &ScheduleVec)
Johannes Doerfertff9d1982015-02-24 12:00:50 +00001097 : Parent(parent), BB(&bb), R(nullptr), Build(nullptr),
1098 NestLoops(Nest.size()) {
Tobias Grosser75805372011-04-29 06:27:02 +00001099 // Setup the induction variables.
Tobias Grosser683b8e42014-11-30 14:33:31 +00001100 for (unsigned i = 0, e = Nest.size(); i < e; ++i)
Sebastian Pop860e0212013-02-15 21:26:44 +00001101 NestLoops[i] = Nest[i];
Tobias Grosser75805372011-04-29 06:27:02 +00001102
Johannes Doerfert79fc23f2014-07-24 23:48:02 +00001103 BaseName = getIslCompatibleName("Stmt_", &bb, "");
Tobias Grosser75805372011-04-29 06:27:02 +00001104
Tobias Grossere19661e2011-10-07 08:46:57 +00001105 Domain = buildDomain(tempScop, CurRegion);
Tobias Grosser54839312015-04-21 11:37:25 +00001106 buildSchedule(ScheduleVec);
Johannes Doerfertff9d1982015-02-24 12:00:50 +00001107 buildAccesses(tempScop, BB);
1108 deriveAssumptions(BB);
Johannes Doerferte58a0122014-06-27 20:31:28 +00001109 checkForReductions();
Johannes Doerfert0ee1f212014-06-17 17:31:36 +00001110}
1111
Johannes Doerferte58a0122014-06-27 20:31:28 +00001112/// @brief Collect loads which might form a reduction chain with @p StoreMA
1113///
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00001114/// Check if the stored value for @p StoreMA is a binary operator with one or
1115/// two loads as operands. If the binary operand is commutative & associative,
Johannes Doerferte58a0122014-06-27 20:31:28 +00001116/// used only once (by @p StoreMA) and its load operands are also used only
1117/// once, we have found a possible reduction chain. It starts at an operand
1118/// load and includes the binary operator and @p StoreMA.
1119///
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00001120/// Note: We allow only one use to ensure the load and binary operator cannot
Johannes Doerferte58a0122014-06-27 20:31:28 +00001121/// escape this block or into any other store except @p StoreMA.
1122void ScopStmt::collectCandiateReductionLoads(
1123 MemoryAccess *StoreMA, SmallVectorImpl<MemoryAccess *> &Loads) {
1124 auto *Store = dyn_cast<StoreInst>(StoreMA->getAccessInstruction());
1125 if (!Store)
Johannes Doerfert0ee1f212014-06-17 17:31:36 +00001126 return;
1127
1128 // Skip if there is not one binary operator between the load and the store
1129 auto *BinOp = dyn_cast<BinaryOperator>(Store->getValueOperand());
Johannes Doerferte58a0122014-06-27 20:31:28 +00001130 if (!BinOp)
1131 return;
1132
1133 // Skip if the binary operators has multiple uses
1134 if (BinOp->getNumUses() != 1)
Johannes Doerfert0ee1f212014-06-17 17:31:36 +00001135 return;
1136
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00001137 // Skip if the opcode of the binary operator is not commutative/associative
Johannes Doerfert0ee1f212014-06-17 17:31:36 +00001138 if (!BinOp->isCommutative() || !BinOp->isAssociative())
1139 return;
1140
Johannes Doerfert9890a052014-07-01 00:32:29 +00001141 // Skip if the binary operator is outside the current SCoP
1142 if (BinOp->getParent() != Store->getParent())
1143 return;
1144
Johannes Doerfert0ee1f212014-06-17 17:31:36 +00001145 // Skip if it is a multiplicative reduction and we disabled them
1146 if (DisableMultiplicativeReductions &&
1147 (BinOp->getOpcode() == Instruction::Mul ||
1148 BinOp->getOpcode() == Instruction::FMul))
1149 return;
1150
Johannes Doerferte58a0122014-06-27 20:31:28 +00001151 // Check the binary operator operands for a candidate load
1152 auto *PossibleLoad0 = dyn_cast<LoadInst>(BinOp->getOperand(0));
1153 auto *PossibleLoad1 = dyn_cast<LoadInst>(BinOp->getOperand(1));
1154 if (!PossibleLoad0 && !PossibleLoad1)
1155 return;
1156
1157 // A load is only a candidate if it cannot escape (thus has only this use)
1158 if (PossibleLoad0 && PossibleLoad0->getNumUses() == 1)
Johannes Doerfert9890a052014-07-01 00:32:29 +00001159 if (PossibleLoad0->getParent() == Store->getParent())
1160 Loads.push_back(lookupAccessFor(PossibleLoad0));
Johannes Doerferte58a0122014-06-27 20:31:28 +00001161 if (PossibleLoad1 && PossibleLoad1->getNumUses() == 1)
Johannes Doerfert9890a052014-07-01 00:32:29 +00001162 if (PossibleLoad1->getParent() == Store->getParent())
1163 Loads.push_back(lookupAccessFor(PossibleLoad1));
Johannes Doerferte58a0122014-06-27 20:31:28 +00001164}
1165
1166/// @brief Check for reductions in this ScopStmt
1167///
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00001168/// Iterate over all store memory accesses and check for valid binary reduction
1169/// like chains. For all candidates we check if they have the same base address
1170/// and there are no other accesses which overlap with them. The base address
1171/// check rules out impossible reductions candidates early. The overlap check,
1172/// together with the "only one user" check in collectCandiateReductionLoads,
Johannes Doerferte58a0122014-06-27 20:31:28 +00001173/// guarantees that none of the intermediate results will escape during
1174/// execution of the loop nest. We basically check here that no other memory
1175/// access can access the same memory as the potential reduction.
1176void ScopStmt::checkForReductions() {
1177 SmallVector<MemoryAccess *, 2> Loads;
1178 SmallVector<std::pair<MemoryAccess *, MemoryAccess *>, 4> Candidates;
1179
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00001180 // First collect candidate load-store reduction chains by iterating over all
Johannes Doerferte58a0122014-06-27 20:31:28 +00001181 // stores and collecting possible reduction loads.
1182 for (MemoryAccess *StoreMA : MemAccs) {
1183 if (StoreMA->isRead())
1184 continue;
1185
1186 Loads.clear();
1187 collectCandiateReductionLoads(StoreMA, Loads);
1188 for (MemoryAccess *LoadMA : Loads)
1189 Candidates.push_back(std::make_pair(LoadMA, StoreMA));
1190 }
1191
1192 // Then check each possible candidate pair.
1193 for (const auto &CandidatePair : Candidates) {
1194 bool Valid = true;
1195 isl_map *LoadAccs = CandidatePair.first->getAccessRelation();
1196 isl_map *StoreAccs = CandidatePair.second->getAccessRelation();
1197
1198 // Skip those with obviously unequal base addresses.
1199 if (!isl_map_has_equal_space(LoadAccs, StoreAccs)) {
1200 isl_map_free(LoadAccs);
1201 isl_map_free(StoreAccs);
1202 continue;
1203 }
1204
1205 // And check if the remaining for overlap with other memory accesses.
1206 isl_map *AllAccsRel = isl_map_union(LoadAccs, StoreAccs);
1207 AllAccsRel = isl_map_intersect_domain(AllAccsRel, getDomain());
1208 isl_set *AllAccs = isl_map_range(AllAccsRel);
1209
1210 for (MemoryAccess *MA : MemAccs) {
1211 if (MA == CandidatePair.first || MA == CandidatePair.second)
1212 continue;
1213
1214 isl_map *AccRel =
1215 isl_map_intersect_domain(MA->getAccessRelation(), getDomain());
1216 isl_set *Accs = isl_map_range(AccRel);
1217
1218 if (isl_set_has_equal_space(AllAccs, Accs) || isl_set_free(Accs)) {
1219 isl_set *OverlapAccs = isl_set_intersect(Accs, isl_set_copy(AllAccs));
1220 Valid = Valid && isl_set_is_empty(OverlapAccs);
1221 isl_set_free(OverlapAccs);
1222 }
1223 }
1224
1225 isl_set_free(AllAccs);
1226 if (!Valid)
1227 continue;
1228
Johannes Doerfertf6183392014-07-01 20:52:51 +00001229 const LoadInst *Load =
1230 dyn_cast<const LoadInst>(CandidatePair.first->getAccessInstruction());
1231 MemoryAccess::ReductionType RT =
1232 getReductionType(dyn_cast<BinaryOperator>(Load->user_back()), Load);
1233
Johannes Doerferte58a0122014-06-27 20:31:28 +00001234 // If no overlapping access was found we mark the load and store as
1235 // reduction like.
Johannes Doerfertf6183392014-07-01 20:52:51 +00001236 CandidatePair.first->markAsReductionLike(RT);
1237 CandidatePair.second->markAsReductionLike(RT);
Johannes Doerferte58a0122014-06-27 20:31:28 +00001238 }
Tobias Grosser75805372011-04-29 06:27:02 +00001239}
1240
Tobias Grosser74394f02013-01-14 22:40:23 +00001241std::string ScopStmt::getDomainStr() const { return stringFromIslObj(Domain); }
Tobias Grosser75805372011-04-29 06:27:02 +00001242
Tobias Grosser54839312015-04-21 11:37:25 +00001243std::string ScopStmt::getScheduleStr() const {
1244 return stringFromIslObj(Schedule);
Tobias Grosser75805372011-04-29 06:27:02 +00001245}
1246
Tobias Grosser74394f02013-01-14 22:40:23 +00001247unsigned ScopStmt::getNumParams() const { return Parent.getNumParams(); }
Tobias Grosser75805372011-04-29 06:27:02 +00001248
Tobias Grosserf567e1a2015-02-19 22:16:12 +00001249unsigned ScopStmt::getNumIterators() const { return NestLoops.size(); }
Tobias Grosser75805372011-04-29 06:27:02 +00001250
Tobias Grosser54839312015-04-21 11:37:25 +00001251unsigned ScopStmt::getNumSchedule() const {
1252 return isl_map_dim(Schedule, isl_dim_out);
Tobias Grosser75805372011-04-29 06:27:02 +00001253}
1254
1255const char *ScopStmt::getBaseName() const { return BaseName.c_str(); }
1256
Hongbin Zheng27f3afb2011-04-30 03:26:51 +00001257const Loop *ScopStmt::getLoopForDimension(unsigned Dimension) const {
Sebastian Pop860e0212013-02-15 21:26:44 +00001258 return NestLoops[Dimension];
Tobias Grosser75805372011-04-29 06:27:02 +00001259}
1260
Tobias Grosser74394f02013-01-14 22:40:23 +00001261isl_ctx *ScopStmt::getIslCtx() const { return Parent.getIslCtx(); }
Tobias Grosser75805372011-04-29 06:27:02 +00001262
Tobias Grosser4f663aa2015-03-30 11:52:59 +00001263__isl_give isl_set *ScopStmt::getDomain() const { return isl_set_copy(Domain); }
Tobias Grosserd5a7bfc2011-05-06 19:52:19 +00001264
Tobias Grosser6e6c7e02015-03-30 12:22:39 +00001265__isl_give isl_space *ScopStmt::getDomainSpace() const {
Tobias Grosser78d8a3d2012-01-17 20:34:23 +00001266 return isl_set_get_space(Domain);
1267}
1268
Tobias Grosser4f663aa2015-03-30 11:52:59 +00001269__isl_give isl_id *ScopStmt::getDomainId() const {
1270 return isl_set_get_tuple_id(Domain);
1271}
Tobias Grossercd95b772012-08-30 11:49:38 +00001272
Tobias Grosser75805372011-04-29 06:27:02 +00001273ScopStmt::~ScopStmt() {
1274 while (!MemAccs.empty()) {
1275 delete MemAccs.back();
1276 MemAccs.pop_back();
1277 }
1278
1279 isl_set_free(Domain);
Tobias Grosser54839312015-04-21 11:37:25 +00001280 isl_map_free(Schedule);
Tobias Grosser75805372011-04-29 06:27:02 +00001281}
1282
1283void ScopStmt::print(raw_ostream &OS) const {
1284 OS << "\t" << getBaseName() << "\n";
Tobias Grosser75805372011-04-29 06:27:02 +00001285 OS.indent(12) << "Domain :=\n";
1286
1287 if (Domain) {
1288 OS.indent(16) << getDomainStr() << ";\n";
1289 } else
1290 OS.indent(16) << "n/a\n";
1291
Tobias Grosser54839312015-04-21 11:37:25 +00001292 OS.indent(12) << "Schedule :=\n";
Tobias Grosser75805372011-04-29 06:27:02 +00001293
1294 if (Domain) {
Tobias Grosser54839312015-04-21 11:37:25 +00001295 OS.indent(16) << getScheduleStr() << ";\n";
Tobias Grosser75805372011-04-29 06:27:02 +00001296 } else
1297 OS.indent(16) << "n/a\n";
1298
Tobias Grosser083d3d32014-06-28 08:59:45 +00001299 for (MemoryAccess *Access : MemAccs)
1300 Access->print(OS);
Tobias Grosser75805372011-04-29 06:27:02 +00001301}
1302
1303void ScopStmt::dump() const { print(dbgs()); }
1304
1305//===----------------------------------------------------------------------===//
1306/// Scop class implement
Tobias Grosser60b54f12011-11-08 15:41:28 +00001307
Tobias Grosser7ffe4e82011-11-17 12:56:10 +00001308void Scop::setContext(__isl_take isl_set *NewContext) {
Tobias Grosserff9b54d2011-11-15 11:38:44 +00001309 NewContext = isl_set_align_params(NewContext, isl_set_get_space(Context));
1310 isl_set_free(Context);
1311 Context = NewContext;
1312}
1313
Tobias Grosserabfbe632013-02-05 12:09:06 +00001314void Scop::addParams(std::vector<const SCEV *> NewParameters) {
Tobias Grosser083d3d32014-06-28 08:59:45 +00001315 for (const SCEV *Parameter : NewParameters) {
Johannes Doerfertbe409962015-03-29 20:45:09 +00001316 Parameter = extractConstantFactor(Parameter, *SE).second;
Tobias Grosser60b54f12011-11-08 15:41:28 +00001317 if (ParameterIds.find(Parameter) != ParameterIds.end())
1318 continue;
1319
1320 int dimension = Parameters.size();
1321
1322 Parameters.push_back(Parameter);
1323 ParameterIds[Parameter] = dimension;
1324 }
1325}
1326
Tobias Grosser9a38ab82011-11-08 15:41:03 +00001327__isl_give isl_id *Scop::getIdForParam(const SCEV *Parameter) const {
1328 ParamIdType::const_iterator IdIter = ParameterIds.find(Parameter);
Tobias Grosser76c2e322011-11-07 12:58:59 +00001329
Tobias Grosser9a38ab82011-11-08 15:41:03 +00001330 if (IdIter == ParameterIds.end())
Tobias Grosser5a56cbf2014-04-16 07:33:47 +00001331 return nullptr;
Tobias Grosser76c2e322011-11-07 12:58:59 +00001332
Tobias Grosser8f99c162011-11-15 11:38:55 +00001333 std::string ParameterName;
1334
1335 if (const SCEVUnknown *ValueParameter = dyn_cast<SCEVUnknown>(Parameter)) {
1336 Value *Val = ValueParameter->getValue();
Tobias Grosser29ee0b12011-11-17 14:52:36 +00001337 ParameterName = Val->getName();
Tobias Grosser8f99c162011-11-15 11:38:55 +00001338 }
1339
1340 if (ParameterName == "" || ParameterName.substr(0, 2) == "p_")
Hongbin Zheng86a37742012-04-25 08:01:38 +00001341 ParameterName = "p_" + utostr_32(IdIter->second);
Tobias Grosser8f99c162011-11-15 11:38:55 +00001342
Tobias Grosser20532b82014-04-11 17:56:49 +00001343 return isl_id_alloc(getIslCtx(), ParameterName.c_str(),
1344 const_cast<void *>((const void *)Parameter));
Tobias Grosser76c2e322011-11-07 12:58:59 +00001345}
Tobias Grosser75805372011-04-29 06:27:02 +00001346
Tobias Grosser6be480c2011-11-08 15:41:13 +00001347void Scop::buildContext() {
1348 isl_space *Space = isl_space_params_alloc(IslCtx, 0);
Tobias Grossere86109f2013-10-29 21:05:49 +00001349 Context = isl_set_universe(isl_space_copy(Space));
1350 AssumedContext = isl_set_universe(Space);
Tobias Grosser0e27e242011-10-06 00:03:48 +00001351}
1352
Tobias Grosser18daaca2012-05-22 10:47:27 +00001353void Scop::addParameterBounds() {
Johannes Doerfert4f8ac3d2015-02-23 16:15:51 +00001354 for (const auto &ParamID : ParameterIds) {
Johannes Doerfert4f8ac3d2015-02-23 16:15:51 +00001355 int dim = ParamID.second;
Tobias Grosser18daaca2012-05-22 10:47:27 +00001356
Johannes Doerfert4f8ac3d2015-02-23 16:15:51 +00001357 ConstantRange SRange = SE->getSignedRange(ParamID.first);
Tobias Grosser18daaca2012-05-22 10:47:27 +00001358
Johannes Doerferte7044942015-02-24 11:58:30 +00001359 Context = addRangeBoundsToSet(Context, SRange, dim, isl_dim_param);
Tobias Grosser18daaca2012-05-22 10:47:27 +00001360 }
1361}
1362
Tobias Grosser8cae72f2011-11-08 15:41:08 +00001363void Scop::realignParams() {
Tobias Grosser6be480c2011-11-08 15:41:13 +00001364 // Add all parameters into a common model.
Tobias Grosser60b54f12011-11-08 15:41:28 +00001365 isl_space *Space = isl_space_params_alloc(IslCtx, ParameterIds.size());
Tobias Grosser6be480c2011-11-08 15:41:13 +00001366
Tobias Grosser083d3d32014-06-28 08:59:45 +00001367 for (const auto &ParamID : ParameterIds) {
1368 const SCEV *Parameter = ParamID.first;
Tobias Grosser6be480c2011-11-08 15:41:13 +00001369 isl_id *id = getIdForParam(Parameter);
Tobias Grosser083d3d32014-06-28 08:59:45 +00001370 Space = isl_space_set_dim_id(Space, isl_dim_param, ParamID.second, id);
Tobias Grosser6be480c2011-11-08 15:41:13 +00001371 }
1372
1373 // Align the parameters of all data structures to the model.
1374 Context = isl_set_align_params(Context, Space);
1375
Tobias Grosser083d3d32014-06-28 08:59:45 +00001376 for (ScopStmt *Stmt : *this)
1377 Stmt->realignParams();
Tobias Grosser8cae72f2011-11-08 15:41:08 +00001378}
1379
Tobias Grosser5e6813d2014-07-02 17:47:48 +00001380void Scop::simplifyAssumedContext() {
1381 // The parameter constraints of the iteration domains give us a set of
1382 // constraints that need to hold for all cases where at least a single
1383 // statement iteration is executed in the whole scop. We now simplify the
1384 // assumed context under the assumption that such constraints hold and at
1385 // least a single statement iteration is executed. For cases where no
1386 // statement instances are executed, the assumptions we have taken about
1387 // the executed code do not matter and can be changed.
1388 //
1389 // WARNING: This only holds if the assumptions we have taken do not reduce
1390 // the set of statement instances that are executed. Otherwise we
1391 // may run into a case where the iteration domains suggest that
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00001392 // for a certain set of parameter constraints no code is executed,
Tobias Grosser5e6813d2014-07-02 17:47:48 +00001393 // but in the original program some computation would have been
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00001394 // performed. In such a case, modifying the run-time conditions and
1395 // possibly influencing the run-time check may cause certain scops
Tobias Grosser5e6813d2014-07-02 17:47:48 +00001396 // to not be executed.
1397 //
1398 // Example:
1399 //
1400 // When delinearizing the following code:
1401 //
1402 // for (long i = 0; i < 100; i++)
1403 // for (long j = 0; j < m; j++)
1404 // A[i+p][j] = 1.0;
1405 //
1406 // we assume that the condition m <= 0 or (m >= 1 and p >= 0) holds as
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00001407 // otherwise we would access out of bound data. Now, knowing that code is
Tobias Grosser5e6813d2014-07-02 17:47:48 +00001408 // only executed for the case m >= 0, it is sufficient to assume p >= 0.
1409 AssumedContext =
1410 isl_set_gist_params(AssumedContext, isl_union_set_params(getDomains()));
Johannes Doerfert4f8ac3d2015-02-23 16:15:51 +00001411 AssumedContext = isl_set_gist_params(AssumedContext, getContext());
Tobias Grosser5e6813d2014-07-02 17:47:48 +00001412}
1413
Johannes Doerfertb164c792014-09-18 11:17:17 +00001414/// @brief Add the minimal/maximal access in @p Set to @p User.
1415static int buildMinMaxAccess(__isl_take isl_set *Set, void *User) {
1416 Scop::MinMaxVectorTy *MinMaxAccesses = (Scop::MinMaxVectorTy *)User;
1417 isl_pw_multi_aff *MinPMA, *MaxPMA;
1418 isl_pw_aff *LastDimAff;
1419 isl_aff *OneAff;
1420 unsigned Pos;
1421
Johannes Doerfert9143d672014-09-27 11:02:39 +00001422 // Restrict the number of parameters involved in the access as the lexmin/
1423 // lexmax computation will take too long if this number is high.
1424 //
1425 // Experiments with a simple test case using an i7 4800MQ:
1426 //
1427 // #Parameters involved | Time (in sec)
1428 // 6 | 0.01
1429 // 7 | 0.04
1430 // 8 | 0.12
1431 // 9 | 0.40
1432 // 10 | 1.54
1433 // 11 | 6.78
1434 // 12 | 30.38
1435 //
1436 if (isl_set_n_param(Set) > RunTimeChecksMaxParameters) {
1437 unsigned InvolvedParams = 0;
1438 for (unsigned u = 0, e = isl_set_n_param(Set); u < e; u++)
1439 if (isl_set_involves_dims(Set, isl_dim_param, u, 1))
1440 InvolvedParams++;
1441
1442 if (InvolvedParams > RunTimeChecksMaxParameters) {
1443 isl_set_free(Set);
1444 return -1;
1445 }
1446 }
1447
Johannes Doerfertb6755bb2015-02-14 12:00:06 +00001448 Set = isl_set_remove_divs(Set);
1449
Johannes Doerfertb164c792014-09-18 11:17:17 +00001450 MinPMA = isl_set_lexmin_pw_multi_aff(isl_set_copy(Set));
1451 MaxPMA = isl_set_lexmax_pw_multi_aff(isl_set_copy(Set));
1452
Johannes Doerfert219b20e2014-10-07 14:37:59 +00001453 MinPMA = isl_pw_multi_aff_coalesce(MinPMA);
1454 MaxPMA = isl_pw_multi_aff_coalesce(MaxPMA);
1455
Johannes Doerfertb164c792014-09-18 11:17:17 +00001456 // Adjust the last dimension of the maximal access by one as we want to
1457 // enclose the accessed memory region by MinPMA and MaxPMA. The pointer
1458 // we test during code generation might now point after the end of the
1459 // allocated array but we will never dereference it anyway.
1460 assert(isl_pw_multi_aff_dim(MaxPMA, isl_dim_out) &&
1461 "Assumed at least one output dimension");
1462 Pos = isl_pw_multi_aff_dim(MaxPMA, isl_dim_out) - 1;
1463 LastDimAff = isl_pw_multi_aff_get_pw_aff(MaxPMA, Pos);
1464 OneAff = isl_aff_zero_on_domain(
1465 isl_local_space_from_space(isl_pw_aff_get_domain_space(LastDimAff)));
1466 OneAff = isl_aff_add_constant_si(OneAff, 1);
1467 LastDimAff = isl_pw_aff_add(LastDimAff, isl_pw_aff_from_aff(OneAff));
1468 MaxPMA = isl_pw_multi_aff_set_pw_aff(MaxPMA, Pos, LastDimAff);
1469
1470 MinMaxAccesses->push_back(std::make_pair(MinPMA, MaxPMA));
1471
1472 isl_set_free(Set);
1473 return 0;
1474}
1475
Johannes Doerferteeab05a2014-10-01 12:42:37 +00001476static __isl_give isl_set *getAccessDomain(MemoryAccess *MA) {
1477 isl_set *Domain = MA->getStatement()->getDomain();
1478 Domain = isl_set_project_out(Domain, isl_dim_set, 0, isl_set_n_dim(Domain));
1479 return isl_set_reset_tuple_id(Domain);
1480}
1481
Johannes Doerfert9143d672014-09-27 11:02:39 +00001482bool Scop::buildAliasGroups(AliasAnalysis &AA) {
Johannes Doerfertb164c792014-09-18 11:17:17 +00001483 // To create sound alias checks we perform the following steps:
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00001484 // o) Use the alias analysis and an alias set tracker to build alias sets
Johannes Doerfertb164c792014-09-18 11:17:17 +00001485 // for all memory accesses inside the SCoP.
1486 // o) For each alias set we then map the aliasing pointers back to the
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00001487 // memory accesses we know, thus obtain groups of memory accesses which
Johannes Doerfertb164c792014-09-18 11:17:17 +00001488 // might alias.
Johannes Doerferteeab05a2014-10-01 12:42:37 +00001489 // o) We divide each group based on the domains of the minimal/maximal
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00001490 // accesses. That means two minimal/maximal accesses are only in a group
Johannes Doerferteeab05a2014-10-01 12:42:37 +00001491 // if their access domains intersect, otherwise they are in different
1492 // ones.
Johannes Doerfert13771732014-10-01 12:40:46 +00001493 // o) We split groups such that they contain at most one read only base
1494 // address.
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00001495 // o) For each group with more than one base pointer we then compute minimal
Johannes Doerfertb164c792014-09-18 11:17:17 +00001496 // and maximal accesses to each array in this group.
1497 using AliasGroupTy = SmallVector<MemoryAccess *, 4>;
1498
1499 AliasSetTracker AST(AA);
1500
1501 DenseMap<Value *, MemoryAccess *> PtrToAcc;
Johannes Doerfert13771732014-10-01 12:40:46 +00001502 DenseSet<Value *> HasWriteAccess;
Johannes Doerfertb164c792014-09-18 11:17:17 +00001503 for (ScopStmt *Stmt : *this) {
Johannes Doerfertf1ee2622014-10-06 17:43:00 +00001504
1505 // Skip statements with an empty domain as they will never be executed.
1506 isl_set *StmtDomain = Stmt->getDomain();
1507 bool StmtDomainEmpty = isl_set_is_empty(StmtDomain);
1508 isl_set_free(StmtDomain);
1509 if (StmtDomainEmpty)
1510 continue;
1511
Johannes Doerfertb164c792014-09-18 11:17:17 +00001512 for (MemoryAccess *MA : *Stmt) {
1513 if (MA->isScalar())
1514 continue;
Johannes Doerfert13771732014-10-01 12:40:46 +00001515 if (!MA->isRead())
1516 HasWriteAccess.insert(MA->getBaseAddr());
Johannes Doerfertb164c792014-09-18 11:17:17 +00001517 Instruction *Acc = MA->getAccessInstruction();
1518 PtrToAcc[getPointerOperand(*Acc)] = MA;
1519 AST.add(Acc);
1520 }
1521 }
1522
1523 SmallVector<AliasGroupTy, 4> AliasGroups;
1524 for (AliasSet &AS : AST) {
Johannes Doerfert74f68692014-10-08 02:23:48 +00001525 if (AS.isMustAlias() || AS.isForwardingAliasSet())
Johannes Doerfertb164c792014-09-18 11:17:17 +00001526 continue;
1527 AliasGroupTy AG;
1528 for (auto PR : AS)
1529 AG.push_back(PtrToAcc[PR.getValue()]);
1530 assert(AG.size() > 1 &&
1531 "Alias groups should contain at least two accesses");
1532 AliasGroups.push_back(std::move(AG));
1533 }
1534
Johannes Doerferteeab05a2014-10-01 12:42:37 +00001535 // Split the alias groups based on their domain.
1536 for (unsigned u = 0; u < AliasGroups.size(); u++) {
1537 AliasGroupTy NewAG;
1538 AliasGroupTy &AG = AliasGroups[u];
1539 AliasGroupTy::iterator AGI = AG.begin();
1540 isl_set *AGDomain = getAccessDomain(*AGI);
1541 while (AGI != AG.end()) {
1542 MemoryAccess *MA = *AGI;
1543 isl_set *MADomain = getAccessDomain(MA);
1544 if (isl_set_is_disjoint(AGDomain, MADomain)) {
1545 NewAG.push_back(MA);
1546 AGI = AG.erase(AGI);
1547 isl_set_free(MADomain);
1548 } else {
1549 AGDomain = isl_set_union(AGDomain, MADomain);
1550 AGI++;
1551 }
1552 }
1553 if (NewAG.size() > 1)
1554 AliasGroups.push_back(std::move(NewAG));
1555 isl_set_free(AGDomain);
1556 }
1557
Tobias Grosserf4c24b22015-04-05 13:11:54 +00001558 MapVector<const Value *, SmallPtrSet<MemoryAccess *, 8>> ReadOnlyPairs;
Johannes Doerfert13771732014-10-01 12:40:46 +00001559 SmallPtrSet<const Value *, 4> NonReadOnlyBaseValues;
1560 for (AliasGroupTy &AG : AliasGroups) {
1561 NonReadOnlyBaseValues.clear();
1562 ReadOnlyPairs.clear();
1563
Johannes Doerferteeab05a2014-10-01 12:42:37 +00001564 if (AG.size() < 2) {
1565 AG.clear();
1566 continue;
1567 }
1568
Johannes Doerfert13771732014-10-01 12:40:46 +00001569 for (auto II = AG.begin(); II != AG.end();) {
1570 Value *BaseAddr = (*II)->getBaseAddr();
1571 if (HasWriteAccess.count(BaseAddr)) {
1572 NonReadOnlyBaseValues.insert(BaseAddr);
1573 II++;
1574 } else {
1575 ReadOnlyPairs[BaseAddr].insert(*II);
1576 II = AG.erase(II);
1577 }
1578 }
1579
1580 // If we don't have read only pointers check if there are at least two
1581 // non read only pointers, otherwise clear the alias group.
1582 if (ReadOnlyPairs.empty()) {
1583 if (NonReadOnlyBaseValues.size() <= 1)
1584 AG.clear();
1585 continue;
1586 }
1587
1588 // If we don't have non read only pointers clear the alias group.
1589 if (NonReadOnlyBaseValues.empty()) {
1590 AG.clear();
1591 continue;
1592 }
1593
1594 // If we have both read only and non read only base pointers we combine
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00001595 // the non read only ones with exactly one read only one at a time into a
Johannes Doerfert13771732014-10-01 12:40:46 +00001596 // new alias group and clear the old alias group in the end.
1597 for (const auto &ReadOnlyPair : ReadOnlyPairs) {
1598 AliasGroupTy AGNonReadOnly = AG;
1599 for (MemoryAccess *MA : ReadOnlyPair.second)
1600 AGNonReadOnly.push_back(MA);
1601 AliasGroups.push_back(std::move(AGNonReadOnly));
1602 }
1603 AG.clear();
Johannes Doerfertb164c792014-09-18 11:17:17 +00001604 }
1605
1606 for (AliasGroupTy &AG : AliasGroups) {
Johannes Doerfert13771732014-10-01 12:40:46 +00001607 if (AG.empty())
1608 continue;
1609
Johannes Doerfertb164c792014-09-18 11:17:17 +00001610 MinMaxVectorTy *MinMaxAccesses = new MinMaxVectorTy();
1611 MinMaxAccesses->reserve(AG.size());
1612
1613 isl_union_map *Accesses = isl_union_map_empty(getParamSpace());
1614 for (MemoryAccess *MA : AG)
1615 Accesses = isl_union_map_add_map(Accesses, MA->getAccessRelation());
1616 Accesses = isl_union_map_intersect_domain(Accesses, getDomains());
1617
1618 isl_union_set *Locations = isl_union_map_range(Accesses);
1619 Locations = isl_union_set_intersect_params(Locations, getAssumedContext());
1620 Locations = isl_union_set_coalesce(Locations);
1621 Locations = isl_union_set_detect_equalities(Locations);
Tobias Grosser50d4e2e2015-03-28 14:50:32 +00001622 bool Valid = (0 == isl_union_set_foreach_set(Locations, buildMinMaxAccess,
1623 MinMaxAccesses));
Johannes Doerfertb164c792014-09-18 11:17:17 +00001624 isl_union_set_free(Locations);
Johannes Doerfertb164c792014-09-18 11:17:17 +00001625 MinMaxAliasGroups.push_back(MinMaxAccesses);
Johannes Doerfert9143d672014-09-27 11:02:39 +00001626
1627 if (!Valid)
Tobias Grosser50d4e2e2015-03-28 14:50:32 +00001628 return false;
Johannes Doerfertb164c792014-09-18 11:17:17 +00001629 }
Johannes Doerfert9143d672014-09-27 11:02:39 +00001630
Tobias Grosser71500722015-03-28 15:11:14 +00001631 // Bail out if the number of values we need to compare is too large.
1632 // This is important as the number of comparisions grows quadratically with
1633 // the number of values we need to compare.
1634 for (const auto *Values : MinMaxAliasGroups)
1635 if (Values->size() > RunTimeChecksMaxArraysPerGroup)
1636 return false;
1637
Tobias Grosser50d4e2e2015-03-28 14:50:32 +00001638 return true;
Johannes Doerfertb164c792014-09-18 11:17:17 +00001639}
1640
Johannes Doerfertf8206cf2015-04-12 22:58:40 +00001641static unsigned getMaxLoopDepthInRegion(const Region &R, LoopInfo &LI,
1642 ScopDetection &SD) {
1643
1644 const ScopDetection::BoxedLoopsSetTy *BoxedLoops = SD.getBoxedLoops(&R);
1645
Johannes Doerferte3da05a2014-11-01 00:12:13 +00001646 unsigned MinLD = INT_MAX, MaxLD = 0;
1647 for (BasicBlock *BB : R.blocks()) {
1648 if (Loop *L = LI.getLoopFor(BB)) {
David Peixottodc0a11c2015-01-13 18:31:55 +00001649 if (!R.contains(L))
1650 continue;
Johannes Doerfertf8206cf2015-04-12 22:58:40 +00001651 if (BoxedLoops && BoxedLoops->count(L))
1652 continue;
Johannes Doerferte3da05a2014-11-01 00:12:13 +00001653 unsigned LD = L->getLoopDepth();
1654 MinLD = std::min(MinLD, LD);
1655 MaxLD = std::max(MaxLD, LD);
1656 }
1657 }
1658
1659 // Handle the case that there is no loop in the SCoP first.
1660 if (MaxLD == 0)
1661 return 1;
1662
1663 assert(MinLD >= 1 && "Minimal loop depth should be at least one");
1664 assert(MaxLD >= MinLD &&
1665 "Maximal loop depth was smaller than mininaml loop depth?");
1666 return MaxLD - MinLD + 1;
1667}
1668
Tobias Grosser3f296192015-01-01 23:01:11 +00001669void Scop::dropConstantScheduleDims() {
1670 isl_union_map *FullSchedule = getSchedule();
1671
1672 if (isl_union_map_n_map(FullSchedule) == 0) {
1673 isl_union_map_free(FullSchedule);
1674 return;
1675 }
1676
1677 isl_set *ScheduleSpace =
1678 isl_set_from_union_set(isl_union_map_range(FullSchedule));
1679 isl_map *DropDimMap = isl_set_identity(isl_set_copy(ScheduleSpace));
1680
1681 int NumDimsDropped = 0;
Johannes Doerfert3f21e272015-03-04 22:23:21 +00001682 for (unsigned i = 0; i < isl_set_dim(ScheduleSpace, isl_dim_set); i += 2) {
1683 isl_val *FixedVal =
1684 isl_set_plain_get_val_if_fixed(ScheduleSpace, isl_dim_set, i);
1685 if (isl_val_is_int(FixedVal)) {
1686 DropDimMap =
1687 isl_map_project_out(DropDimMap, isl_dim_out, i - NumDimsDropped, 1);
1688 NumDimsDropped++;
Tobias Grosser3f296192015-01-01 23:01:11 +00001689 }
Johannes Doerfert3f21e272015-03-04 22:23:21 +00001690 isl_val_free(FixedVal);
1691 }
Tobias Grosser3f296192015-01-01 23:01:11 +00001692
Tobias Grosser3f296192015-01-01 23:01:11 +00001693 for (auto *S : *this) {
Tobias Grosser54839312015-04-21 11:37:25 +00001694 isl_map *Schedule = S->getSchedule();
Tobias Grosser3f296192015-01-01 23:01:11 +00001695 Schedule = isl_map_apply_range(Schedule, isl_map_copy(DropDimMap));
Tobias Grosser54839312015-04-21 11:37:25 +00001696 S->setSchedule(Schedule);
Tobias Grosser3f296192015-01-01 23:01:11 +00001697 }
1698 isl_set_free(ScheduleSpace);
1699 isl_map_free(DropDimMap);
1700}
1701
Tobias Grosser0e27e242011-10-06 00:03:48 +00001702Scop::Scop(TempScop &tempScop, LoopInfo &LI, ScalarEvolution &ScalarEvolution,
Johannes Doerfertff9d1982015-02-24 12:00:50 +00001703 ScopDetection &SD, isl_ctx *Context)
Johannes Doerfert7ceb0402015-02-11 17:25:09 +00001704 : SE(&ScalarEvolution), R(tempScop.getMaxRegion()), IsOptimized(false),
Johannes Doerfertf8206cf2015-04-12 22:58:40 +00001705 MaxLoopDepth(getMaxLoopDepthInRegion(tempScop.getMaxRegion(), LI, SD)) {
Tobias Grosser9a38ab82011-11-08 15:41:03 +00001706 IslCtx = Context;
Johannes Doerfertff9d1982015-02-24 12:00:50 +00001707
Tobias Grosser6be480c2011-11-08 15:41:13 +00001708 buildContext();
Tobias Grosser75805372011-04-29 06:27:02 +00001709
Tobias Grosserabfbe632013-02-05 12:09:06 +00001710 SmallVector<Loop *, 8> NestLoops;
Tobias Grosser54839312015-04-21 11:37:25 +00001711 SmallVector<unsigned, 8> Schedule;
Tobias Grosser75805372011-04-29 06:27:02 +00001712
Tobias Grosser54839312015-04-21 11:37:25 +00001713 Schedule.assign(MaxLoopDepth + 1, 0);
Tobias Grosser75805372011-04-29 06:27:02 +00001714
Tobias Grosser54839312015-04-21 11:37:25 +00001715 // Build the iteration domain, access functions and schedule functions
Tobias Grosser75805372011-04-29 06:27:02 +00001716 // traversing the region tree.
Tobias Grosser54839312015-04-21 11:37:25 +00001717 buildScop(tempScop, getRegion(), NestLoops, Schedule, LI, SD);
Tobias Grosser75805372011-04-29 06:27:02 +00001718
Tobias Grosser8cae72f2011-11-08 15:41:08 +00001719 realignParams();
Tobias Grosser18daaca2012-05-22 10:47:27 +00001720 addParameterBounds();
Tobias Grosser5e6813d2014-07-02 17:47:48 +00001721 simplifyAssumedContext();
Tobias Grosser3f296192015-01-01 23:01:11 +00001722 dropConstantScheduleDims();
Tobias Grosser8cae72f2011-11-08 15:41:08 +00001723
Tobias Grosser75805372011-04-29 06:27:02 +00001724 assert(NestLoops.empty() && "NestLoops not empty at top level!");
1725}
1726
1727Scop::~Scop() {
1728 isl_set_free(Context);
Tobias Grossere86109f2013-10-29 21:05:49 +00001729 isl_set_free(AssumedContext);
Tobias Grosser75805372011-04-29 06:27:02 +00001730
1731 // Free the statements;
Tobias Grosser083d3d32014-06-28 08:59:45 +00001732 for (ScopStmt *Stmt : *this)
1733 delete Stmt;
Johannes Doerfertb164c792014-09-18 11:17:17 +00001734
Johannes Doerfert1a28a892014-10-05 11:32:18 +00001735 // Free the ScopArrayInfo objects.
Tobias Grossere71ed192015-05-06 10:05:20 +00001736 for (auto &ScopArrayInfoPair : arrays())
Johannes Doerfert1a28a892014-10-05 11:32:18 +00001737 delete ScopArrayInfoPair.second;
1738
Johannes Doerfertb164c792014-09-18 11:17:17 +00001739 // Free the alias groups
1740 for (MinMaxVectorTy *MinMaxAccesses : MinMaxAliasGroups) {
1741 for (MinMaxAccessTy &MMA : *MinMaxAccesses) {
1742 isl_pw_multi_aff_free(MMA.first);
1743 isl_pw_multi_aff_free(MMA.second);
1744 }
1745 delete MinMaxAccesses;
1746 }
Tobias Grosser75805372011-04-29 06:27:02 +00001747}
1748
Johannes Doerfert80ef1102014-11-07 08:31:31 +00001749const ScopArrayInfo *
1750Scop::getOrCreateScopArrayInfo(Value *BasePtr, Type *AccessType,
1751 const SmallVector<const SCEV *, 4> &Sizes) {
Johannes Doerfert1a28a892014-10-05 11:32:18 +00001752 const ScopArrayInfo *&SAI = ScopArrayInfoMap[BasePtr];
Johannes Doerfert80ef1102014-11-07 08:31:31 +00001753 if (!SAI)
1754 SAI = new ScopArrayInfo(BasePtr, AccessType, getIslCtx(), Sizes);
Johannes Doerfert1a28a892014-10-05 11:32:18 +00001755 return SAI;
1756}
1757
1758const ScopArrayInfo *Scop::getScopArrayInfo(Value *BasePtr) {
1759 const SCEV *PtrSCEV = SE->getSCEV(BasePtr);
1760 const SCEVUnknown *PtrBaseSCEV =
1761 cast<SCEVUnknown>(SE->getPointerBase(PtrSCEV));
1762 const ScopArrayInfo *SAI = ScopArrayInfoMap[PtrBaseSCEV->getValue()];
1763 assert(SAI && "No ScopArrayInfo available for this base pointer");
1764 return SAI;
1765}
1766
Tobias Grosser74394f02013-01-14 22:40:23 +00001767std::string Scop::getContextStr() const { return stringFromIslObj(Context); }
Tobias Grosser5e6813d2014-07-02 17:47:48 +00001768std::string Scop::getAssumedContextStr() const {
1769 return stringFromIslObj(AssumedContext);
1770}
Tobias Grosser75805372011-04-29 06:27:02 +00001771
1772std::string Scop::getNameStr() const {
1773 std::string ExitName, EntryName;
1774 raw_string_ostream ExitStr(ExitName);
1775 raw_string_ostream EntryStr(EntryName);
1776
Tobias Grosserf240b482014-01-09 10:42:15 +00001777 R.getEntry()->printAsOperand(EntryStr, false);
Tobias Grosser75805372011-04-29 06:27:02 +00001778 EntryStr.str();
1779
1780 if (R.getExit()) {
Tobias Grosserf240b482014-01-09 10:42:15 +00001781 R.getExit()->printAsOperand(ExitStr, false);
Tobias Grosser75805372011-04-29 06:27:02 +00001782 ExitStr.str();
1783 } else
1784 ExitName = "FunctionExit";
1785
1786 return EntryName + "---" + ExitName;
1787}
1788
Tobias Grosser74394f02013-01-14 22:40:23 +00001789__isl_give isl_set *Scop::getContext() const { return isl_set_copy(Context); }
Tobias Grosser37487052011-10-06 00:03:42 +00001790__isl_give isl_space *Scop::getParamSpace() const {
1791 return isl_set_get_space(this->Context);
1792}
1793
Tobias Grossere86109f2013-10-29 21:05:49 +00001794__isl_give isl_set *Scop::getAssumedContext() const {
1795 return isl_set_copy(AssumedContext);
1796}
1797
Tobias Grosser5e6813d2014-07-02 17:47:48 +00001798void Scop::addAssumption(__isl_take isl_set *Set) {
1799 AssumedContext = isl_set_intersect(AssumedContext, Set);
Tobias Grosser7b50bee2014-11-25 10:51:12 +00001800 AssumedContext = isl_set_coalesce(AssumedContext);
Tobias Grosser5e6813d2014-07-02 17:47:48 +00001801}
1802
Tobias Grosser75805372011-04-29 06:27:02 +00001803void Scop::printContext(raw_ostream &OS) const {
1804 OS << "Context:\n";
1805
1806 if (!Context) {
1807 OS.indent(4) << "n/a\n\n";
1808 return;
1809 }
1810
1811 OS.indent(4) << getContextStr() << "\n";
Tobias Grosser60b54f12011-11-08 15:41:28 +00001812
Tobias Grosser5e6813d2014-07-02 17:47:48 +00001813 OS.indent(4) << "Assumed Context:\n";
1814 if (!AssumedContext) {
1815 OS.indent(4) << "n/a\n\n";
1816 return;
1817 }
1818
1819 OS.indent(4) << getAssumedContextStr() << "\n";
1820
Tobias Grosser083d3d32014-06-28 08:59:45 +00001821 for (const SCEV *Parameter : Parameters) {
Tobias Grosser60b54f12011-11-08 15:41:28 +00001822 int Dim = ParameterIds.find(Parameter)->second;
Tobias Grosser60b54f12011-11-08 15:41:28 +00001823 OS.indent(4) << "p" << Dim << ": " << *Parameter << "\n";
1824 }
Tobias Grosser75805372011-04-29 06:27:02 +00001825}
1826
Johannes Doerfertb164c792014-09-18 11:17:17 +00001827void Scop::printAliasAssumptions(raw_ostream &OS) const {
1828 OS.indent(4) << "Alias Groups (" << MinMaxAliasGroups.size() << "):\n";
1829 if (MinMaxAliasGroups.empty()) {
1830 OS.indent(8) << "n/a\n";
1831 return;
1832 }
1833 for (MinMaxVectorTy *MinMaxAccesses : MinMaxAliasGroups) {
1834 OS.indent(8) << "[[";
1835 for (MinMaxAccessTy &MinMacAccess : *MinMaxAccesses)
1836 OS << " <" << MinMacAccess.first << ", " << MinMacAccess.second << ">";
1837 OS << " ]]\n";
1838 }
1839}
1840
Tobias Grosser75805372011-04-29 06:27:02 +00001841void Scop::printStatements(raw_ostream &OS) const {
1842 OS << "Statements {\n";
1843
Tobias Grosser083d3d32014-06-28 08:59:45 +00001844 for (ScopStmt *Stmt : *this)
1845 OS.indent(4) << *Stmt;
Tobias Grosser75805372011-04-29 06:27:02 +00001846
1847 OS.indent(4) << "}\n";
1848}
1849
Tobias Grosser49ad36c2015-05-20 08:05:31 +00001850void Scop::printArrayInfo(raw_ostream &OS) const {
1851 OS << "Arrays {\n";
1852
1853 for (auto Array : arrays())
1854 Array.second->print(OS);
1855
1856 OS.indent(4) << "}\n";
1857}
1858
Tobias Grosser75805372011-04-29 06:27:02 +00001859void Scop::print(raw_ostream &OS) const {
Tobias Grosser4eb7ddb2014-03-18 18:51:11 +00001860 OS.indent(4) << "Function: " << getRegion().getEntry()->getParent()->getName()
1861 << "\n";
Tobias Grosser483fdd42014-03-18 18:05:38 +00001862 OS.indent(4) << "Region: " << getNameStr() << "\n";
David Peixottodc0a11c2015-01-13 18:31:55 +00001863 OS.indent(4) << "Max Loop Depth: " << getMaxLoopDepth() << "\n";
Tobias Grosser75805372011-04-29 06:27:02 +00001864 printContext(OS.indent(4));
Tobias Grosser49ad36c2015-05-20 08:05:31 +00001865 printArrayInfo(OS.indent(4));
Johannes Doerfertb164c792014-09-18 11:17:17 +00001866 printAliasAssumptions(OS);
Tobias Grosser75805372011-04-29 06:27:02 +00001867 printStatements(OS.indent(4));
1868}
1869
1870void Scop::dump() const { print(dbgs()); }
1871
Tobias Grosser9a38ab82011-11-08 15:41:03 +00001872isl_ctx *Scop::getIslCtx() const { return IslCtx; }
Tobias Grosser75805372011-04-29 06:27:02 +00001873
Tobias Grosser5f9a7622012-02-14 14:02:40 +00001874__isl_give isl_union_set *Scop::getDomains() {
Tobias Grosserbc4ef902014-06-28 08:59:38 +00001875 isl_union_set *Domain = isl_union_set_empty(getParamSpace());
Tobias Grosser5f9a7622012-02-14 14:02:40 +00001876
Tobias Grosserbc4ef902014-06-28 08:59:38 +00001877 for (ScopStmt *Stmt : *this)
1878 Domain = isl_union_set_add_set(Domain, Stmt->getDomain());
Tobias Grosser5f9a7622012-02-14 14:02:40 +00001879
1880 return Domain;
1881}
1882
Tobias Grosser780ce0f2014-07-11 07:12:10 +00001883__isl_give isl_union_map *Scop::getMustWrites() {
1884 isl_union_map *Write = isl_union_map_empty(this->getParamSpace());
1885
1886 for (ScopStmt *Stmt : *this) {
1887 for (MemoryAccess *MA : *Stmt) {
1888 if (!MA->isMustWrite())
1889 continue;
1890
1891 isl_set *Domain = Stmt->getDomain();
1892 isl_map *AccessDomain = MA->getAccessRelation();
1893 AccessDomain = isl_map_intersect_domain(AccessDomain, Domain);
1894 Write = isl_union_map_add_map(Write, AccessDomain);
1895 }
1896 }
1897 return isl_union_map_coalesce(Write);
1898}
1899
1900__isl_give isl_union_map *Scop::getMayWrites() {
1901 isl_union_map *Write = isl_union_map_empty(this->getParamSpace());
1902
1903 for (ScopStmt *Stmt : *this) {
1904 for (MemoryAccess *MA : *Stmt) {
1905 if (!MA->isMayWrite())
1906 continue;
1907
1908 isl_set *Domain = Stmt->getDomain();
1909 isl_map *AccessDomain = MA->getAccessRelation();
1910 AccessDomain = isl_map_intersect_domain(AccessDomain, Domain);
1911 Write = isl_union_map_add_map(Write, AccessDomain);
1912 }
1913 }
1914 return isl_union_map_coalesce(Write);
1915}
1916
Tobias Grosser37eb4222014-02-20 21:43:54 +00001917__isl_give isl_union_map *Scop::getWrites() {
1918 isl_union_map *Write = isl_union_map_empty(this->getParamSpace());
1919
Tobias Grosserbc4ef902014-06-28 08:59:38 +00001920 for (ScopStmt *Stmt : *this) {
Johannes Doerfertf6752892014-06-13 18:01:45 +00001921 for (MemoryAccess *MA : *Stmt) {
1922 if (!MA->isWrite())
Tobias Grosser37eb4222014-02-20 21:43:54 +00001923 continue;
1924
1925 isl_set *Domain = Stmt->getDomain();
Johannes Doerfertf6752892014-06-13 18:01:45 +00001926 isl_map *AccessDomain = MA->getAccessRelation();
Tobias Grosser37eb4222014-02-20 21:43:54 +00001927 AccessDomain = isl_map_intersect_domain(AccessDomain, Domain);
1928 Write = isl_union_map_add_map(Write, AccessDomain);
1929 }
1930 }
1931 return isl_union_map_coalesce(Write);
1932}
1933
1934__isl_give isl_union_map *Scop::getReads() {
Tobias Grosserbc4ef902014-06-28 08:59:38 +00001935 isl_union_map *Read = isl_union_map_empty(getParamSpace());
Tobias Grosser37eb4222014-02-20 21:43:54 +00001936
Tobias Grosserbc4ef902014-06-28 08:59:38 +00001937 for (ScopStmt *Stmt : *this) {
Johannes Doerfertf6752892014-06-13 18:01:45 +00001938 for (MemoryAccess *MA : *Stmt) {
1939 if (!MA->isRead())
Tobias Grosser37eb4222014-02-20 21:43:54 +00001940 continue;
1941
1942 isl_set *Domain = Stmt->getDomain();
Johannes Doerfertf6752892014-06-13 18:01:45 +00001943 isl_map *AccessDomain = MA->getAccessRelation();
Tobias Grosser37eb4222014-02-20 21:43:54 +00001944
1945 AccessDomain = isl_map_intersect_domain(AccessDomain, Domain);
1946 Read = isl_union_map_add_map(Read, AccessDomain);
1947 }
1948 }
1949 return isl_union_map_coalesce(Read);
1950}
1951
1952__isl_give isl_union_map *Scop::getSchedule() {
Tobias Grosserbc4ef902014-06-28 08:59:38 +00001953 isl_union_map *Schedule = isl_union_map_empty(getParamSpace());
Tobias Grosser37eb4222014-02-20 21:43:54 +00001954
Tobias Grosserbc4ef902014-06-28 08:59:38 +00001955 for (ScopStmt *Stmt : *this)
Tobias Grosser54839312015-04-21 11:37:25 +00001956 Schedule = isl_union_map_add_map(Schedule, Stmt->getSchedule());
Tobias Grosserbc4ef902014-06-28 08:59:38 +00001957
Tobias Grosser37eb4222014-02-20 21:43:54 +00001958 return isl_union_map_coalesce(Schedule);
1959}
1960
1961bool Scop::restrictDomains(__isl_take isl_union_set *Domain) {
1962 bool Changed = false;
Tobias Grosserbc4ef902014-06-28 08:59:38 +00001963 for (ScopStmt *Stmt : *this) {
Tobias Grosser37eb4222014-02-20 21:43:54 +00001964 isl_union_set *StmtDomain = isl_union_set_from_set(Stmt->getDomain());
Tobias Grosser37eb4222014-02-20 21:43:54 +00001965 isl_union_set *NewStmtDomain = isl_union_set_intersect(
1966 isl_union_set_copy(StmtDomain), isl_union_set_copy(Domain));
1967
1968 if (isl_union_set_is_subset(StmtDomain, NewStmtDomain)) {
1969 isl_union_set_free(StmtDomain);
1970 isl_union_set_free(NewStmtDomain);
1971 continue;
1972 }
1973
1974 Changed = true;
1975
1976 isl_union_set_free(StmtDomain);
1977 NewStmtDomain = isl_union_set_coalesce(NewStmtDomain);
1978
1979 if (isl_union_set_is_empty(NewStmtDomain)) {
1980 Stmt->restrictDomain(isl_set_empty(Stmt->getDomainSpace()));
1981 isl_union_set_free(NewStmtDomain);
1982 } else
1983 Stmt->restrictDomain(isl_set_from_union_set(NewStmtDomain));
1984 }
1985 isl_union_set_free(Domain);
1986 return Changed;
1987}
1988
Tobias Grosser75805372011-04-29 06:27:02 +00001989ScalarEvolution *Scop::getSE() const { return SE; }
1990
1991bool Scop::isTrivialBB(BasicBlock *BB, TempScop &tempScop) {
1992 if (tempScop.getAccessFunctions(BB))
1993 return false;
1994
1995 return true;
1996}
1997
Johannes Doerfertff9d1982015-02-24 12:00:50 +00001998void Scop::addScopStmt(BasicBlock *BB, Region *R, TempScop &tempScop,
1999 const Region &CurRegion,
2000 SmallVectorImpl<Loop *> &NestLoops,
Tobias Grosser54839312015-04-21 11:37:25 +00002001 SmallVectorImpl<unsigned> &ScheduleVec) {
Johannes Doerfertff9d1982015-02-24 12:00:50 +00002002 ScopStmt *Stmt;
2003
2004 if (BB) {
Tobias Grosser654af8f2015-04-21 11:42:01 +00002005 Stmt =
2006 new ScopStmt(*this, tempScop, CurRegion, *BB, NestLoops, ScheduleVec);
Johannes Doerfertff9d1982015-02-24 12:00:50 +00002007 StmtMap[BB] = Stmt;
2008 } else {
2009 assert(R && "Either a basic block or a region is needed to "
2010 "create a new SCoP stmt.");
Tobias Grosser54839312015-04-21 11:37:25 +00002011 Stmt = new ScopStmt(*this, tempScop, CurRegion, *R, NestLoops, ScheduleVec);
Johannes Doerfertff9d1982015-02-24 12:00:50 +00002012 for (BasicBlock *BB : R->blocks())
2013 StmtMap[BB] = Stmt;
2014 }
2015
2016 // Insert all statements into the statement map and the statement vector.
2017 Stmts.push_back(Stmt);
2018
Tobias Grosser54839312015-04-21 11:37:25 +00002019 // Increasing the Schedule function is OK for the moment, because
Johannes Doerfertff9d1982015-02-24 12:00:50 +00002020 // we are using a depth first iterator and the program is well structured.
Tobias Grosser54839312015-04-21 11:37:25 +00002021 ++ScheduleVec[NestLoops.size()];
Johannes Doerfertff9d1982015-02-24 12:00:50 +00002022}
2023
Tobias Grosser74394f02013-01-14 22:40:23 +00002024void Scop::buildScop(TempScop &tempScop, const Region &CurRegion,
2025 SmallVectorImpl<Loop *> &NestLoops,
Tobias Grosser54839312015-04-21 11:37:25 +00002026 SmallVectorImpl<unsigned> &ScheduleVec, LoopInfo &LI,
Johannes Doerfertff9d1982015-02-24 12:00:50 +00002027 ScopDetection &SD) {
2028 if (SD.isNonAffineSubRegion(&CurRegion, &getRegion()))
2029 return addScopStmt(nullptr, const_cast<Region *>(&CurRegion), tempScop,
Tobias Grosser54839312015-04-21 11:37:25 +00002030 CurRegion, NestLoops, ScheduleVec);
Johannes Doerfertff9d1982015-02-24 12:00:50 +00002031
Tobias Grosser75805372011-04-29 06:27:02 +00002032 Loop *L = castToLoop(CurRegion, LI);
2033
2034 if (L)
2035 NestLoops.push_back(L);
2036
2037 unsigned loopDepth = NestLoops.size();
Tobias Grosser54839312015-04-21 11:37:25 +00002038 assert(ScheduleVec.size() > loopDepth && "Schedule not big enough!");
Tobias Grosser75805372011-04-29 06:27:02 +00002039
2040 for (Region::const_element_iterator I = CurRegion.element_begin(),
Tobias Grosserabfbe632013-02-05 12:09:06 +00002041 E = CurRegion.element_end();
2042 I != E; ++I)
Johannes Doerfertff9d1982015-02-24 12:00:50 +00002043 if (I->isSubRegion()) {
Tobias Grosser654af8f2015-04-21 11:42:01 +00002044 buildScop(tempScop, *I->getNodeAs<Region>(), NestLoops, ScheduleVec, LI,
2045 SD);
Johannes Doerfertff9d1982015-02-24 12:00:50 +00002046 } else {
Tobias Grosser75805372011-04-29 06:27:02 +00002047 BasicBlock *BB = I->getNodeAs<BasicBlock>();
2048
2049 if (isTrivialBB(BB, tempScop))
2050 continue;
2051
Tobias Grosser54839312015-04-21 11:37:25 +00002052 addScopStmt(BB, nullptr, tempScop, CurRegion, NestLoops, ScheduleVec);
Tobias Grosser75805372011-04-29 06:27:02 +00002053 }
2054
2055 if (!L)
2056 return;
2057
2058 // Exiting a loop region.
Tobias Grosser54839312015-04-21 11:37:25 +00002059 ScheduleVec[loopDepth] = 0;
Tobias Grosser75805372011-04-29 06:27:02 +00002060 NestLoops.pop_back();
Tobias Grosser54839312015-04-21 11:37:25 +00002061 ++ScheduleVec[loopDepth - 1];
Tobias Grosser75805372011-04-29 06:27:02 +00002062}
2063
Johannes Doerfert7c494212014-10-31 23:13:39 +00002064ScopStmt *Scop::getStmtForBasicBlock(BasicBlock *BB) const {
2065 const auto &StmtMapIt = StmtMap.find(BB);
2066 if (StmtMapIt == StmtMap.end())
2067 return nullptr;
2068 return StmtMapIt->second;
2069}
2070
Tobias Grosser75805372011-04-29 06:27:02 +00002071//===----------------------------------------------------------------------===//
Tobias Grosserb76f38532011-08-20 11:11:25 +00002072ScopInfo::ScopInfo() : RegionPass(ID), scop(0) {
2073 ctx = isl_ctx_alloc();
Tobias Grosser4a8e3562011-12-07 07:42:51 +00002074 isl_options_set_on_error(ctx, ISL_ON_ERROR_ABORT);
Tobias Grosserb76f38532011-08-20 11:11:25 +00002075}
2076
2077ScopInfo::~ScopInfo() {
2078 clear();
2079 isl_ctx_free(ctx);
2080}
2081
Tobias Grosser75805372011-04-29 06:27:02 +00002082void ScopInfo::getAnalysisUsage(AnalysisUsage &AU) const {
Chandler Carruthf5579872015-01-17 14:16:56 +00002083 AU.addRequired<LoopInfoWrapperPass>();
Matt Arsenault8ca36812014-07-19 18:40:17 +00002084 AU.addRequired<RegionInfoPass>();
Tobias Grosser75805372011-04-29 06:27:02 +00002085 AU.addRequired<ScalarEvolution>();
Johannes Doerfertff9d1982015-02-24 12:00:50 +00002086 AU.addRequired<ScopDetection>();
Tobias Grosser75805372011-04-29 06:27:02 +00002087 AU.addRequired<TempScopInfo>();
Johannes Doerfertb164c792014-09-18 11:17:17 +00002088 AU.addRequired<AliasAnalysis>();
Tobias Grosser75805372011-04-29 06:27:02 +00002089 AU.setPreservesAll();
2090}
2091
2092bool ScopInfo::runOnRegion(Region *R, RGPassManager &RGM) {
Chandler Carruthf5579872015-01-17 14:16:56 +00002093 LoopInfo &LI = getAnalysis<LoopInfoWrapperPass>().getLoopInfo();
Johannes Doerfertb164c792014-09-18 11:17:17 +00002094 AliasAnalysis &AA = getAnalysis<AliasAnalysis>();
Johannes Doerfertff9d1982015-02-24 12:00:50 +00002095 ScopDetection &SD = getAnalysis<ScopDetection>();
Tobias Grosser75805372011-04-29 06:27:02 +00002096 ScalarEvolution &SE = getAnalysis<ScalarEvolution>();
2097
2098 TempScop *tempScop = getAnalysis<TempScopInfo>().getTempScop(R);
2099
2100 // This region is no Scop.
2101 if (!tempScop) {
Tobias Grosserc98a8fc2014-11-14 11:12:31 +00002102 scop = nullptr;
Tobias Grosser75805372011-04-29 06:27:02 +00002103 return false;
2104 }
2105
Johannes Doerfertff9d1982015-02-24 12:00:50 +00002106 scop = new Scop(*tempScop, LI, SE, SD, ctx);
Tobias Grosser75805372011-04-29 06:27:02 +00002107
Johannes Doerfert21aa3dc2014-11-01 01:30:11 +00002108 if (!PollyUseRuntimeAliasChecks) {
2109 // Statistics.
2110 ++ScopFound;
2111 if (scop->getMaxLoopDepth() > 0)
2112 ++RichScopFound;
Johannes Doerfert9143d672014-09-27 11:02:39 +00002113 return false;
Johannes Doerfert21aa3dc2014-11-01 01:30:11 +00002114 }
Johannes Doerfertb164c792014-09-18 11:17:17 +00002115
Johannes Doerfert9143d672014-09-27 11:02:39 +00002116 // If a problem occurs while building the alias groups we need to delete
2117 // this SCoP and pretend it wasn't valid in the first place.
Johannes Doerfert21aa3dc2014-11-01 01:30:11 +00002118 if (scop->buildAliasGroups(AA)) {
2119 // Statistics.
2120 ++ScopFound;
2121 if (scop->getMaxLoopDepth() > 0)
2122 ++RichScopFound;
Johannes Doerfert9143d672014-09-27 11:02:39 +00002123 return false;
Johannes Doerfert21aa3dc2014-11-01 01:30:11 +00002124 }
Johannes Doerfert9143d672014-09-27 11:02:39 +00002125
2126 DEBUG(dbgs()
2127 << "\n\nNOTE: Run time checks for " << scop->getNameStr()
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00002128 << " could not be created as the number of parameters involved is too "
Johannes Doerfert9143d672014-09-27 11:02:39 +00002129 "high. The SCoP will be "
2130 "dismissed.\nUse:\n\t--polly-rtc-max-parameters=X\nto adjust the "
Johannes Doerfert6cad9c42015-02-24 16:00:29 +00002131 "maximal number of parameters but be advised that the compile time "
Johannes Doerfert9143d672014-09-27 11:02:39 +00002132 "might increase exponentially.\n\n");
2133
2134 delete scop;
2135 scop = nullptr;
Tobias Grosser75805372011-04-29 06:27:02 +00002136 return false;
2137}
2138
2139char ScopInfo::ID = 0;
2140
Tobias Grosser4d96c8d2013-03-23 01:05:07 +00002141Pass *polly::createScopInfoPass() { return new ScopInfo(); }
2142
Tobias Grosser73600b82011-10-08 00:30:40 +00002143INITIALIZE_PASS_BEGIN(ScopInfo, "polly-scops",
2144 "Polly - Create polyhedral description of Scops", false,
Tobias Grosser4d96c8d2013-03-23 01:05:07 +00002145 false);
Johannes Doerfertb164c792014-09-18 11:17:17 +00002146INITIALIZE_AG_DEPENDENCY(AliasAnalysis);
Chandler Carruthf5579872015-01-17 14:16:56 +00002147INITIALIZE_PASS_DEPENDENCY(LoopInfoWrapperPass);
Matt Arsenault8ca36812014-07-19 18:40:17 +00002148INITIALIZE_PASS_DEPENDENCY(RegionInfoPass);
Tobias Grosser4d96c8d2013-03-23 01:05:07 +00002149INITIALIZE_PASS_DEPENDENCY(ScalarEvolution);
Johannes Doerfertff9d1982015-02-24 12:00:50 +00002150INITIALIZE_PASS_DEPENDENCY(ScopDetection);
Tobias Grosser4d96c8d2013-03-23 01:05:07 +00002151INITIALIZE_PASS_DEPENDENCY(TempScopInfo);
Tobias Grosser73600b82011-10-08 00:30:40 +00002152INITIALIZE_PASS_END(ScopInfo, "polly-scops",
2153 "Polly - Create polyhedral description of Scops", false,
2154 false)