represent loop increment as isl_pw_aff
[pet.git] / scan.cc
blob92b2be5858de9d251520f4e3b28dbdbe2b06d433
1 /*
2 * Copyright 2011 Leiden University. All rights reserved.
3 * Copyright 2012 Ecole Normale Superieure. All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 *
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above
13 * copyright notice, this list of conditions and the following
14 * disclaimer in the documentation and/or other materials provided
15 * with the distribution.
17 * THIS SOFTWARE IS PROVIDED BY LEIDEN UNIVERSITY ''AS IS'' AND ANY
18 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
20 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL LEIDEN UNIVERSITY OR
21 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
22 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
23 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
24 * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 * The views and conclusions contained in the software and documentation
30 * are those of the authors and should not be interpreted as
31 * representing official policies, either expressed or implied, of
32 * Leiden University.
33 */
35 #include <set>
36 #include <map>
37 #include <iostream>
38 #include <clang/AST/ASTDiagnostic.h>
39 #include <clang/AST/Expr.h>
40 #include <clang/AST/RecursiveASTVisitor.h>
42 #include <isl/id.h>
43 #include <isl/space.h>
44 #include <isl/aff.h>
45 #include <isl/set.h>
47 #include "scan.h"
48 #include "scop.h"
49 #include "scop_plus.h"
51 #include "config.h"
53 using namespace std;
54 using namespace clang;
56 #ifdef DECLREFEXPR_CREATE_REQUIRES_SOURCELOCATION
57 static DeclRefExpr *create_DeclRefExpr(VarDecl *var)
59 return DeclRefExpr::Create(var->getASTContext(), var->getQualifierLoc(),
60 SourceLocation(), var, var->getInnerLocStart(), var->getType(),
61 VK_LValue);
63 #else
64 static DeclRefExpr *create_DeclRefExpr(VarDecl *var)
66 return DeclRefExpr::Create(var->getASTContext(), var->getQualifierLoc(),
67 var, var->getInnerLocStart(), var->getType(), VK_LValue);
69 #endif
71 /* Check if the element type corresponding to the given array type
72 * has a const qualifier.
74 static bool const_base(QualType qt)
76 const Type *type = qt.getTypePtr();
78 if (type->isPointerType())
79 return const_base(type->getPointeeType());
80 if (type->isArrayType()) {
81 const ArrayType *atype;
82 type = type->getCanonicalTypeInternal().getTypePtr();
83 atype = cast<ArrayType>(type);
84 return const_base(atype->getElementType());
87 return qt.isConstQualified();
90 /* Mark "decl" as having an unknown value in "assigned_value".
92 * If no (known or unknown) value was assigned to "decl" before,
93 * then it may have been treated as a parameter before and may
94 * therefore appear in a value assigned to another variable.
95 * If so, this assignment needs to be turned into an unknown value too.
97 static void clear_assignment(map<ValueDecl *, isl_pw_aff *> &assigned_value,
98 ValueDecl *decl)
100 map<ValueDecl *, isl_pw_aff *>::iterator it;
102 it = assigned_value.find(decl);
104 assigned_value[decl] = NULL;
106 if (it == assigned_value.end())
107 return;
109 for (it = assigned_value.begin(); it != assigned_value.end(); ++it) {
110 isl_pw_aff *pa = it->second;
111 int nparam = isl_pw_aff_dim(pa, isl_dim_param);
113 for (int i = 0; i < nparam; ++i) {
114 isl_id *id;
116 if (!isl_pw_aff_has_dim_id(pa, isl_dim_param, i))
117 continue;
118 id = isl_pw_aff_get_dim_id(pa, isl_dim_param, i);
119 if (isl_id_get_user(id) == decl)
120 it->second = NULL;
121 isl_id_free(id);
126 /* Look for any assignments to scalar variables in part of the parse
127 * tree and set assigned_value to NULL for each of them.
128 * Also reset assigned_value if the address of a scalar variable
129 * is being taken. As an exception, if the address is passed to a function
130 * that is declared to receive a const pointer, then assigned_value is
131 * not reset.
133 * This ensures that we won't use any previously stored value
134 * in the current subtree and its parents.
136 struct clear_assignments : RecursiveASTVisitor<clear_assignments> {
137 map<ValueDecl *, isl_pw_aff *> &assigned_value;
138 set<UnaryOperator *> skip;
140 clear_assignments(map<ValueDecl *, isl_pw_aff *> &assigned_value) :
141 assigned_value(assigned_value) {}
143 /* Check for "address of" operators whose value is passed
144 * to a const pointer argument and add them to "skip", so that
145 * we can skip them in VisitUnaryOperator.
147 bool VisitCallExpr(CallExpr *expr) {
148 FunctionDecl *fd;
149 fd = expr->getDirectCallee();
150 if (!fd)
151 return true;
152 for (int i = 0; i < expr->getNumArgs(); ++i) {
153 Expr *arg = expr->getArg(i);
154 UnaryOperator *op;
155 if (arg->getStmtClass() == Stmt::ImplicitCastExprClass) {
156 ImplicitCastExpr *ice;
157 ice = cast<ImplicitCastExpr>(arg);
158 arg = ice->getSubExpr();
160 if (arg->getStmtClass() != Stmt::UnaryOperatorClass)
161 continue;
162 op = cast<UnaryOperator>(arg);
163 if (op->getOpcode() != UO_AddrOf)
164 continue;
165 if (const_base(fd->getParamDecl(i)->getType()))
166 skip.insert(op);
168 return true;
171 bool VisitUnaryOperator(UnaryOperator *expr) {
172 Expr *arg;
173 DeclRefExpr *ref;
174 ValueDecl *decl;
176 if (expr->getOpcode() != UO_AddrOf)
177 return true;
178 if (skip.find(expr) != skip.end())
179 return true;
181 arg = expr->getSubExpr();
182 if (arg->getStmtClass() != Stmt::DeclRefExprClass)
183 return true;
184 ref = cast<DeclRefExpr>(arg);
185 decl = ref->getDecl();
186 clear_assignment(assigned_value, decl);
187 return true;
190 bool VisitBinaryOperator(BinaryOperator *expr) {
191 Expr *lhs;
192 DeclRefExpr *ref;
193 ValueDecl *decl;
195 if (!expr->isAssignmentOp())
196 return true;
197 lhs = expr->getLHS();
198 if (lhs->getStmtClass() != Stmt::DeclRefExprClass)
199 return true;
200 ref = cast<DeclRefExpr>(lhs);
201 decl = ref->getDecl();
202 clear_assignment(assigned_value, decl);
203 return true;
207 /* Keep a copy of the currently assigned values.
209 * Any variable that is assigned a value inside the current scope
210 * is removed again when we leave the scope (either because it wasn't
211 * stored in the cache or because it has a different value in the cache).
213 struct assigned_value_cache {
214 map<ValueDecl *, isl_pw_aff *> &assigned_value;
215 map<ValueDecl *, isl_pw_aff *> cache;
217 assigned_value_cache(map<ValueDecl *, isl_pw_aff *> &assigned_value) :
218 assigned_value(assigned_value), cache(assigned_value) {}
219 ~assigned_value_cache() {
220 map<ValueDecl *, isl_pw_aff *>::iterator it = cache.begin();
221 for (it = assigned_value.begin(); it != assigned_value.end();
222 ++it) {
223 if (!it->second ||
224 (cache.find(it->first) != cache.end() &&
225 cache[it->first] != it->second))
226 cache[it->first] = NULL;
228 assigned_value = cache;
232 /* Insert an expression into the collection of expressions,
233 * provided it is not already in there.
234 * The isl_pw_affs are freed in the destructor.
236 void PetScan::insert_expression(__isl_take isl_pw_aff *expr)
238 std::set<isl_pw_aff *>::iterator it;
240 if (expressions.find(expr) == expressions.end())
241 expressions.insert(expr);
242 else
243 isl_pw_aff_free(expr);
246 PetScan::~PetScan()
248 std::set<isl_pw_aff *>::iterator it;
250 for (it = expressions.begin(); it != expressions.end(); ++it)
251 isl_pw_aff_free(*it);
253 isl_union_map_free(value_bounds);
256 /* Called if we found something we (currently) cannot handle.
257 * We'll provide more informative warnings later.
259 * We only actually complain if autodetect is false.
261 void PetScan::unsupported(Stmt *stmt, const char *msg)
263 if (autodetect)
264 return;
266 SourceLocation loc = stmt->getLocStart();
267 DiagnosticsEngine &diag = PP.getDiagnostics();
268 unsigned id = diag.getCustomDiagID(DiagnosticsEngine::Warning,
269 msg ? msg : "unsupported");
270 DiagnosticBuilder B = diag.Report(loc, id) << stmt->getSourceRange();
273 /* Extract an integer from "expr" and store it in "v".
275 int PetScan::extract_int(IntegerLiteral *expr, isl_int *v)
277 const Type *type = expr->getType().getTypePtr();
278 int is_signed = type->hasSignedIntegerRepresentation();
280 if (is_signed) {
281 int64_t i = expr->getValue().getSExtValue();
282 isl_int_set_si(*v, i);
283 } else {
284 uint64_t i = expr->getValue().getZExtValue();
285 isl_int_set_ui(*v, i);
288 return 0;
291 /* Extract an integer from "expr" and store it in "v".
292 * Return -1 if "expr" does not (obviously) represent an integer.
294 int PetScan::extract_int(clang::ParenExpr *expr, isl_int *v)
296 return extract_int(expr->getSubExpr(), v);
299 /* Extract an integer from "expr" and store it in "v".
300 * Return -1 if "expr" does not (obviously) represent an integer.
302 int PetScan::extract_int(clang::Expr *expr, isl_int *v)
304 if (expr->getStmtClass() == Stmt::IntegerLiteralClass)
305 return extract_int(cast<IntegerLiteral>(expr), v);
306 if (expr->getStmtClass() == Stmt::ParenExprClass)
307 return extract_int(cast<ParenExpr>(expr), v);
309 unsupported(expr);
310 return -1;
313 /* Extract an affine expression from the IntegerLiteral "expr".
315 __isl_give isl_pw_aff *PetScan::extract_affine(IntegerLiteral *expr)
317 isl_space *dim = isl_space_params_alloc(ctx, 0);
318 isl_local_space *ls = isl_local_space_from_space(isl_space_copy(dim));
319 isl_aff *aff = isl_aff_zero_on_domain(ls);
320 isl_set *dom = isl_set_universe(dim);
321 isl_int v;
323 isl_int_init(v);
324 extract_int(expr, &v);
325 aff = isl_aff_add_constant(aff, v);
326 isl_int_clear(v);
328 return isl_pw_aff_alloc(dom, aff);
331 /* Extract an affine expression from the APInt "val".
333 __isl_give isl_pw_aff *PetScan::extract_affine(const llvm::APInt &val)
335 isl_space *dim = isl_space_params_alloc(ctx, 0);
336 isl_local_space *ls = isl_local_space_from_space(isl_space_copy(dim));
337 isl_aff *aff = isl_aff_zero_on_domain(ls);
338 isl_set *dom = isl_set_universe(dim);
339 isl_int v;
341 isl_int_init(v);
342 isl_int_set_ui(v, val.getZExtValue());
343 aff = isl_aff_add_constant(aff, v);
344 isl_int_clear(v);
346 return isl_pw_aff_alloc(dom, aff);
349 __isl_give isl_pw_aff *PetScan::extract_affine(ImplicitCastExpr *expr)
351 return extract_affine(expr->getSubExpr());
354 static unsigned get_type_size(ValueDecl *decl)
356 return decl->getASTContext().getIntWidth(decl->getType());
359 /* Bound parameter "pos" of "set" to the possible values of "decl".
361 static __isl_give isl_set *set_parameter_bounds(__isl_take isl_set *set,
362 unsigned pos, ValueDecl *decl)
364 unsigned width;
365 isl_int v;
367 isl_int_init(v);
369 width = get_type_size(decl);
370 if (decl->getType()->isUnsignedIntegerType()) {
371 set = isl_set_lower_bound_si(set, isl_dim_param, pos, 0);
372 isl_int_set_si(v, 1);
373 isl_int_mul_2exp(v, v, width);
374 isl_int_sub_ui(v, v, 1);
375 set = isl_set_upper_bound(set, isl_dim_param, pos, v);
376 } else {
377 isl_int_set_si(v, 1);
378 isl_int_mul_2exp(v, v, width - 1);
379 isl_int_sub_ui(v, v, 1);
380 set = isl_set_upper_bound(set, isl_dim_param, pos, v);
381 isl_int_neg(v, v);
382 isl_int_sub_ui(v, v, 1);
383 set = isl_set_lower_bound(set, isl_dim_param, pos, v);
386 isl_int_clear(v);
388 return set;
391 /* Extract an affine expression from the DeclRefExpr "expr".
393 * If the variable has been assigned a value, then we check whether
394 * we know what (affine) value was assigned.
395 * If so, we return this value. Otherwise we convert "expr"
396 * to an extra parameter (provided nesting_enabled is set).
398 * Otherwise, we simply return an expression that is equal
399 * to a parameter corresponding to the referenced variable.
401 __isl_give isl_pw_aff *PetScan::extract_affine(DeclRefExpr *expr)
403 ValueDecl *decl = expr->getDecl();
404 const Type *type = decl->getType().getTypePtr();
405 isl_id *id;
406 isl_space *dim;
407 isl_aff *aff;
408 isl_set *dom;
410 if (!type->isIntegerType()) {
411 unsupported(expr);
412 return NULL;
415 if (assigned_value.find(decl) != assigned_value.end()) {
416 if (assigned_value[decl])
417 return isl_pw_aff_copy(assigned_value[decl]);
418 else
419 return nested_access(expr);
422 id = isl_id_alloc(ctx, decl->getName().str().c_str(), decl);
423 dim = isl_space_params_alloc(ctx, 1);
425 dim = isl_space_set_dim_id(dim, isl_dim_param, 0, id);
427 dom = isl_set_universe(isl_space_copy(dim));
428 aff = isl_aff_zero_on_domain(isl_local_space_from_space(dim));
429 aff = isl_aff_add_coefficient_si(aff, isl_dim_param, 0, 1);
431 return isl_pw_aff_alloc(dom, aff);
434 /* Extract an affine expression from an integer division operation.
435 * In particular, if "expr" is lhs/rhs, then return
437 * lhs >= 0 ? floor(lhs/rhs) : ceil(lhs/rhs)
439 * The second argument (rhs) is required to be a (positive) integer constant.
441 __isl_give isl_pw_aff *PetScan::extract_affine_div(BinaryOperator *expr)
443 Expr *rhs_expr;
444 isl_pw_aff *lhs, *lhs_f, *lhs_c;
445 isl_pw_aff *res;
446 isl_int v;
447 isl_set *cond;
449 rhs_expr = expr->getRHS();
450 isl_int_init(v);
451 if (extract_int(rhs_expr, &v) < 0) {
452 isl_int_clear(v);
453 return NULL;
456 lhs = extract_affine(expr->getLHS());
457 cond = isl_pw_aff_nonneg_set(isl_pw_aff_copy(lhs));
459 lhs = isl_pw_aff_scale_down(lhs, v);
460 isl_int_clear(v);
462 lhs_f = isl_pw_aff_floor(isl_pw_aff_copy(lhs));
463 lhs_c = isl_pw_aff_ceil(lhs);
464 res = isl_pw_aff_cond(isl_set_indicator_function(cond), lhs_f, lhs_c);
466 return res;
469 /* Extract an affine expression from a modulo operation.
470 * In particular, if "expr" is lhs/rhs, then return
472 * lhs - rhs * (lhs >= 0 ? floor(lhs/rhs) : ceil(lhs/rhs))
474 * The second argument (rhs) is required to be a (positive) integer constant.
476 __isl_give isl_pw_aff *PetScan::extract_affine_mod(BinaryOperator *expr)
478 Expr *rhs_expr;
479 isl_pw_aff *lhs, *lhs_f, *lhs_c;
480 isl_pw_aff *res;
481 isl_int v;
482 isl_set *cond;
484 rhs_expr = expr->getRHS();
485 if (rhs_expr->getStmtClass() != Stmt::IntegerLiteralClass) {
486 unsupported(expr);
487 return NULL;
490 lhs = extract_affine(expr->getLHS());
491 cond = isl_pw_aff_nonneg_set(isl_pw_aff_copy(lhs));
493 isl_int_init(v);
494 extract_int(cast<IntegerLiteral>(rhs_expr), &v);
495 res = isl_pw_aff_scale_down(isl_pw_aff_copy(lhs), v);
497 lhs_f = isl_pw_aff_floor(isl_pw_aff_copy(res));
498 lhs_c = isl_pw_aff_ceil(res);
499 res = isl_pw_aff_cond(isl_set_indicator_function(cond), lhs_f, lhs_c);
501 res = isl_pw_aff_scale(res, v);
502 isl_int_clear(v);
504 res = isl_pw_aff_sub(lhs, res);
506 return res;
509 /* Extract an affine expression from a multiplication operation.
510 * This is only allowed if at least one of the two arguments
511 * is a (piecewise) constant.
513 __isl_give isl_pw_aff *PetScan::extract_affine_mul(BinaryOperator *expr)
515 isl_pw_aff *lhs;
516 isl_pw_aff *rhs;
518 lhs = extract_affine(expr->getLHS());
519 rhs = extract_affine(expr->getRHS());
521 if (!isl_pw_aff_is_cst(lhs) && !isl_pw_aff_is_cst(rhs)) {
522 isl_pw_aff_free(lhs);
523 isl_pw_aff_free(rhs);
524 unsupported(expr);
525 return NULL;
528 return isl_pw_aff_mul(lhs, rhs);
531 /* Extract an affine expression from an addition or subtraction operation.
533 __isl_give isl_pw_aff *PetScan::extract_affine_add(BinaryOperator *expr)
535 isl_pw_aff *lhs;
536 isl_pw_aff *rhs;
538 lhs = extract_affine(expr->getLHS());
539 rhs = extract_affine(expr->getRHS());
541 switch (expr->getOpcode()) {
542 case BO_Add:
543 return isl_pw_aff_add(lhs, rhs);
544 case BO_Sub:
545 return isl_pw_aff_sub(lhs, rhs);
546 default:
547 isl_pw_aff_free(lhs);
548 isl_pw_aff_free(rhs);
549 return NULL;
554 /* Compute
556 * pwaff mod 2^width
558 static __isl_give isl_pw_aff *wrap(__isl_take isl_pw_aff *pwaff,
559 unsigned width)
561 isl_int mod;
563 isl_int_init(mod);
564 isl_int_set_si(mod, 1);
565 isl_int_mul_2exp(mod, mod, width);
567 pwaff = isl_pw_aff_mod(pwaff, mod);
569 isl_int_clear(mod);
571 return pwaff;
574 /* Return the piecewise affine expression "set ? 1 : 0" defined on "dom".
576 static __isl_give isl_pw_aff *indicator_function(__isl_take isl_set *set,
577 __isl_take isl_set *dom)
579 isl_pw_aff *pa;
580 pa = isl_set_indicator_function(set);
581 pa = isl_pw_aff_intersect_domain(pa, dom);
582 return pa;
585 /* Extract an affine expression from some binary operations.
586 * If the result of the expression is unsigned, then we wrap it
587 * based on the size of the type.
589 __isl_give isl_pw_aff *PetScan::extract_affine(BinaryOperator *expr)
591 isl_pw_aff *res;
593 switch (expr->getOpcode()) {
594 case BO_Add:
595 case BO_Sub:
596 res = extract_affine_add(expr);
597 break;
598 case BO_Div:
599 res = extract_affine_div(expr);
600 break;
601 case BO_Rem:
602 res = extract_affine_mod(expr);
603 break;
604 case BO_Mul:
605 res = extract_affine_mul(expr);
606 break;
607 case BO_LT:
608 case BO_LE:
609 case BO_GT:
610 case BO_GE:
611 case BO_EQ:
612 case BO_NE:
613 case BO_LAnd:
614 case BO_LOr:
615 return extract_condition(expr);
616 default:
617 unsupported(expr);
618 return NULL;
621 if (expr->getType()->isUnsignedIntegerType())
622 res = wrap(res, ast_context.getIntWidth(expr->getType()));
624 return res;
627 /* Extract an affine expression from a negation operation.
629 __isl_give isl_pw_aff *PetScan::extract_affine(UnaryOperator *expr)
631 if (expr->getOpcode() == UO_Minus)
632 return isl_pw_aff_neg(extract_affine(expr->getSubExpr()));
633 if (expr->getOpcode() == UO_LNot)
634 return extract_condition(expr);
636 unsupported(expr);
637 return NULL;
640 __isl_give isl_pw_aff *PetScan::extract_affine(ParenExpr *expr)
642 return extract_affine(expr->getSubExpr());
645 /* Extract an affine expression from some special function calls.
646 * In particular, we handle "min", "max", "ceild" and "floord".
647 * In case of the latter two, the second argument needs to be
648 * a (positive) integer constant.
650 __isl_give isl_pw_aff *PetScan::extract_affine(CallExpr *expr)
652 FunctionDecl *fd;
653 string name;
654 isl_pw_aff *aff1, *aff2;
656 fd = expr->getDirectCallee();
657 if (!fd) {
658 unsupported(expr);
659 return NULL;
662 name = fd->getDeclName().getAsString();
663 if (!(expr->getNumArgs() == 2 && name == "min") &&
664 !(expr->getNumArgs() == 2 && name == "max") &&
665 !(expr->getNumArgs() == 2 && name == "floord") &&
666 !(expr->getNumArgs() == 2 && name == "ceild")) {
667 unsupported(expr);
668 return NULL;
671 if (name == "min" || name == "max") {
672 aff1 = extract_affine(expr->getArg(0));
673 aff2 = extract_affine(expr->getArg(1));
675 if (name == "min")
676 aff1 = isl_pw_aff_min(aff1, aff2);
677 else
678 aff1 = isl_pw_aff_max(aff1, aff2);
679 } else if (name == "floord" || name == "ceild") {
680 isl_int v;
681 Expr *arg2 = expr->getArg(1);
683 if (arg2->getStmtClass() != Stmt::IntegerLiteralClass) {
684 unsupported(expr);
685 return NULL;
687 aff1 = extract_affine(expr->getArg(0));
688 isl_int_init(v);
689 extract_int(cast<IntegerLiteral>(arg2), &v);
690 aff1 = isl_pw_aff_scale_down(aff1, v);
691 isl_int_clear(v);
692 if (name == "floord")
693 aff1 = isl_pw_aff_floor(aff1);
694 else
695 aff1 = isl_pw_aff_ceil(aff1);
696 } else {
697 unsupported(expr);
698 return NULL;
701 return aff1;
705 /* This method is called when we come across an access that is
706 * nested in what is supposed to be an affine expression.
707 * If nesting is allowed, we return a new parameter that corresponds
708 * to this nested access. Otherwise, we simply complain.
710 * The new parameter is resolved in resolve_nested.
712 isl_pw_aff *PetScan::nested_access(Expr *expr)
714 isl_id *id;
715 isl_space *dim;
716 isl_aff *aff;
717 isl_set *dom;
719 if (!nesting_enabled) {
720 unsupported(expr);
721 return NULL;
724 id = isl_id_alloc(ctx, NULL, expr);
725 dim = isl_space_params_alloc(ctx, 1);
727 dim = isl_space_set_dim_id(dim, isl_dim_param, 0, id);
729 dom = isl_set_universe(isl_space_copy(dim));
730 aff = isl_aff_zero_on_domain(isl_local_space_from_space(dim));
731 aff = isl_aff_add_coefficient_si(aff, isl_dim_param, 0, 1);
733 return isl_pw_aff_alloc(dom, aff);
736 /* Affine expressions are not supposed to contain array accesses,
737 * but if nesting is allowed, we return a parameter corresponding
738 * to the array access.
740 __isl_give isl_pw_aff *PetScan::extract_affine(ArraySubscriptExpr *expr)
742 return nested_access(expr);
745 /* Extract an affine expression from a conditional operation.
747 __isl_give isl_pw_aff *PetScan::extract_affine(ConditionalOperator *expr)
749 isl_pw_aff *cond, *lhs, *rhs, *res;
751 cond = extract_condition(expr->getCond());
752 lhs = extract_affine(expr->getTrueExpr());
753 rhs = extract_affine(expr->getFalseExpr());
755 return isl_pw_aff_cond(cond, lhs, rhs);
758 /* Extract an affine expression, if possible, from "expr".
759 * Otherwise return NULL.
761 __isl_give isl_pw_aff *PetScan::extract_affine(Expr *expr)
763 switch (expr->getStmtClass()) {
764 case Stmt::ImplicitCastExprClass:
765 return extract_affine(cast<ImplicitCastExpr>(expr));
766 case Stmt::IntegerLiteralClass:
767 return extract_affine(cast<IntegerLiteral>(expr));
768 case Stmt::DeclRefExprClass:
769 return extract_affine(cast<DeclRefExpr>(expr));
770 case Stmt::BinaryOperatorClass:
771 return extract_affine(cast<BinaryOperator>(expr));
772 case Stmt::UnaryOperatorClass:
773 return extract_affine(cast<UnaryOperator>(expr));
774 case Stmt::ParenExprClass:
775 return extract_affine(cast<ParenExpr>(expr));
776 case Stmt::CallExprClass:
777 return extract_affine(cast<CallExpr>(expr));
778 case Stmt::ArraySubscriptExprClass:
779 return extract_affine(cast<ArraySubscriptExpr>(expr));
780 case Stmt::ConditionalOperatorClass:
781 return extract_affine(cast<ConditionalOperator>(expr));
782 default:
783 unsupported(expr);
785 return NULL;
788 __isl_give isl_map *PetScan::extract_access(ImplicitCastExpr *expr)
790 return extract_access(expr->getSubExpr());
793 /* Return the depth of an array of the given type.
795 static int array_depth(const Type *type)
797 if (type->isPointerType())
798 return 1 + array_depth(type->getPointeeType().getTypePtr());
799 if (type->isArrayType()) {
800 const ArrayType *atype;
801 type = type->getCanonicalTypeInternal().getTypePtr();
802 atype = cast<ArrayType>(type);
803 return 1 + array_depth(atype->getElementType().getTypePtr());
805 return 0;
808 /* Return the element type of the given array type.
810 static QualType base_type(QualType qt)
812 const Type *type = qt.getTypePtr();
814 if (type->isPointerType())
815 return base_type(type->getPointeeType());
816 if (type->isArrayType()) {
817 const ArrayType *atype;
818 type = type->getCanonicalTypeInternal().getTypePtr();
819 atype = cast<ArrayType>(type);
820 return base_type(atype->getElementType());
822 return qt;
825 /* Extract an access relation from a reference to a variable.
826 * If the variable has name "A" and its type corresponds to an
827 * array of depth d, then the returned access relation is of the
828 * form
830 * { [] -> A[i_1,...,i_d] }
832 __isl_give isl_map *PetScan::extract_access(DeclRefExpr *expr)
834 ValueDecl *decl = expr->getDecl();
835 int depth = array_depth(decl->getType().getTypePtr());
836 isl_id *id = isl_id_alloc(ctx, decl->getName().str().c_str(), decl);
837 isl_space *dim = isl_space_alloc(ctx, 0, 0, depth);
838 isl_map *access_rel;
840 dim = isl_space_set_tuple_id(dim, isl_dim_out, id);
842 access_rel = isl_map_universe(dim);
844 return access_rel;
847 /* Extract an access relation from an integer contant.
848 * If the value of the constant is "v", then the returned access relation
849 * is
851 * { [] -> [v] }
853 __isl_give isl_map *PetScan::extract_access(IntegerLiteral *expr)
855 return isl_map_from_range(isl_set_from_pw_aff(extract_affine(expr)));
858 /* Try and extract an access relation from the given Expr.
859 * Return NULL if it doesn't work out.
861 __isl_give isl_map *PetScan::extract_access(Expr *expr)
863 switch (expr->getStmtClass()) {
864 case Stmt::ImplicitCastExprClass:
865 return extract_access(cast<ImplicitCastExpr>(expr));
866 case Stmt::DeclRefExprClass:
867 return extract_access(cast<DeclRefExpr>(expr));
868 case Stmt::ArraySubscriptExprClass:
869 return extract_access(cast<ArraySubscriptExpr>(expr));
870 default:
871 unsupported(expr);
873 return NULL;
876 /* Assign the affine expression "index" to the output dimension "pos" of "map"
877 * and return the result.
879 __isl_give isl_map *set_index(__isl_take isl_map *map, int pos,
880 __isl_take isl_pw_aff *index)
882 isl_map *index_map;
883 int len = isl_map_dim(map, isl_dim_out);
884 isl_id *id;
886 index_map = isl_map_from_range(isl_set_from_pw_aff(index));
887 index_map = isl_map_insert_dims(index_map, isl_dim_out, 0, pos);
888 index_map = isl_map_add_dims(index_map, isl_dim_out, len - pos - 1);
889 id = isl_map_get_tuple_id(map, isl_dim_out);
890 index_map = isl_map_set_tuple_id(index_map, isl_dim_out, id);
892 map = isl_map_intersect(map, index_map);
894 return map;
897 /* Extract an access relation from the given array subscript expression.
898 * If nesting is allowed in general, then we turn it on while
899 * examining the index expression.
901 * We first extract an access relation from the base.
902 * This will result in an access relation with a range that corresponds
903 * to the array being accessed and with earlier indices filled in already.
904 * We then extract the current index and fill that in as well.
905 * The position of the current index is based on the type of base.
906 * If base is the actual array variable, then the depth of this type
907 * will be the same as the depth of the array and we will fill in
908 * the first array index.
909 * Otherwise, the depth of the base type will be smaller and we will fill
910 * in a later index.
912 __isl_give isl_map *PetScan::extract_access(ArraySubscriptExpr *expr)
914 Expr *base = expr->getBase();
915 Expr *idx = expr->getIdx();
916 isl_pw_aff *index;
917 isl_map *base_access;
918 isl_map *access;
919 int depth = array_depth(base->getType().getTypePtr());
920 int pos;
921 bool save_nesting = nesting_enabled;
923 nesting_enabled = allow_nested;
925 base_access = extract_access(base);
926 index = extract_affine(idx);
928 nesting_enabled = save_nesting;
930 pos = isl_map_dim(base_access, isl_dim_out) - depth;
931 access = set_index(base_access, pos, index);
933 return access;
936 /* Check if "expr" calls function "minmax" with two arguments and if so
937 * make lhs and rhs refer to these two arguments.
939 static bool is_minmax(Expr *expr, const char *minmax, Expr *&lhs, Expr *&rhs)
941 CallExpr *call;
942 FunctionDecl *fd;
943 string name;
945 if (expr->getStmtClass() != Stmt::CallExprClass)
946 return false;
948 call = cast<CallExpr>(expr);
949 fd = call->getDirectCallee();
950 if (!fd)
951 return false;
953 if (call->getNumArgs() != 2)
954 return false;
956 name = fd->getDeclName().getAsString();
957 if (name != minmax)
958 return false;
960 lhs = call->getArg(0);
961 rhs = call->getArg(1);
963 return true;
966 /* Check if "expr" is of the form min(lhs, rhs) and if so make
967 * lhs and rhs refer to the two arguments.
969 static bool is_min(Expr *expr, Expr *&lhs, Expr *&rhs)
971 return is_minmax(expr, "min", lhs, rhs);
974 /* Check if "expr" is of the form max(lhs, rhs) and if so make
975 * lhs and rhs refer to the two arguments.
977 static bool is_max(Expr *expr, Expr *&lhs, Expr *&rhs)
979 return is_minmax(expr, "max", lhs, rhs);
982 /* Return "lhs && rhs", defined on the shared definition domain.
984 static __isl_give isl_pw_aff *pw_aff_and(__isl_take isl_pw_aff *lhs,
985 __isl_take isl_pw_aff *rhs)
987 isl_set *cond;
988 isl_set *dom;
990 dom = isl_set_intersect(isl_pw_aff_domain(isl_pw_aff_copy(lhs)),
991 isl_pw_aff_domain(isl_pw_aff_copy(rhs)));
992 cond = isl_set_intersect(isl_pw_aff_non_zero_set(lhs),
993 isl_pw_aff_non_zero_set(rhs));
994 return indicator_function(cond, dom);
997 /* Return "lhs && rhs", with shortcut semantics.
998 * That is, if lhs is false, then the result is defined even if rhs is not.
999 * In practice, we compute lhs ? rhs : lhs.
1001 static __isl_give isl_pw_aff *pw_aff_and_then(__isl_take isl_pw_aff *lhs,
1002 __isl_take isl_pw_aff *rhs)
1004 return isl_pw_aff_cond(isl_pw_aff_copy(lhs), rhs, lhs);
1007 /* Return "lhs || rhs", with shortcut semantics.
1008 * That is, if lhs is true, then the result is defined even if rhs is not.
1009 * In practice, we compute lhs ? lhs : rhs.
1011 static __isl_give isl_pw_aff *pw_aff_or_else(__isl_take isl_pw_aff *lhs,
1012 __isl_take isl_pw_aff *rhs)
1014 return isl_pw_aff_cond(isl_pw_aff_copy(lhs), lhs, rhs);
1017 /* Extract an affine expressions representing the comparison "LHS op RHS"
1018 * "comp" is the original statement that "LHS op RHS" is derived from
1019 * and is used for diagnostics.
1021 * If the comparison is of the form
1023 * a <= min(b,c)
1025 * then the expression is constructed as the conjunction of
1026 * the comparisons
1028 * a <= b and a <= c
1030 * A similar optimization is performed for max(a,b) <= c.
1031 * We do this because that will lead to simpler representations
1032 * of the expression.
1033 * If isl is ever enhanced to explicitly deal with min and max expressions,
1034 * this optimization can be removed.
1036 __isl_give isl_pw_aff *PetScan::extract_comparison(BinaryOperatorKind op,
1037 Expr *LHS, Expr *RHS, Stmt *comp)
1039 isl_pw_aff *lhs;
1040 isl_pw_aff *rhs;
1041 isl_pw_aff *res;
1042 isl_set *cond;
1043 isl_set *dom;
1045 if (op == BO_GT)
1046 return extract_comparison(BO_LT, RHS, LHS, comp);
1047 if (op == BO_GE)
1048 return extract_comparison(BO_LE, RHS, LHS, comp);
1050 if (op == BO_LT || op == BO_LE) {
1051 Expr *expr1, *expr2;
1052 if (is_min(RHS, expr1, expr2)) {
1053 lhs = extract_comparison(op, LHS, expr1, comp);
1054 rhs = extract_comparison(op, LHS, expr2, comp);
1055 return pw_aff_and(lhs, rhs);
1057 if (is_max(LHS, expr1, expr2)) {
1058 lhs = extract_comparison(op, expr1, RHS, comp);
1059 rhs = extract_comparison(op, expr2, RHS, comp);
1060 return pw_aff_and(lhs, rhs);
1064 lhs = extract_affine(LHS);
1065 rhs = extract_affine(RHS);
1067 dom = isl_pw_aff_domain(isl_pw_aff_copy(lhs));
1068 dom = isl_set_intersect(dom, isl_pw_aff_domain(isl_pw_aff_copy(rhs)));
1070 switch (op) {
1071 case BO_LT:
1072 cond = isl_pw_aff_lt_set(lhs, rhs);
1073 break;
1074 case BO_LE:
1075 cond = isl_pw_aff_le_set(lhs, rhs);
1076 break;
1077 case BO_EQ:
1078 cond = isl_pw_aff_eq_set(lhs, rhs);
1079 break;
1080 case BO_NE:
1081 cond = isl_pw_aff_ne_set(lhs, rhs);
1082 break;
1083 default:
1084 isl_pw_aff_free(lhs);
1085 isl_pw_aff_free(rhs);
1086 isl_set_free(dom);
1087 unsupported(comp);
1088 return NULL;
1091 cond = isl_set_coalesce(cond);
1092 res = indicator_function(cond, dom);
1094 return res;
1097 __isl_give isl_pw_aff *PetScan::extract_comparison(BinaryOperator *comp)
1099 return extract_comparison(comp->getOpcode(), comp->getLHS(),
1100 comp->getRHS(), comp);
1103 /* Extract an affine expression representing the negation (logical not)
1104 * of a subexpression.
1106 __isl_give isl_pw_aff *PetScan::extract_boolean(UnaryOperator *op)
1108 isl_set *set_cond, *dom;
1109 isl_pw_aff *cond, *res;
1111 cond = extract_condition(op->getSubExpr());
1113 dom = isl_pw_aff_domain(isl_pw_aff_copy(cond));
1115 set_cond = isl_pw_aff_zero_set(cond);
1117 res = indicator_function(set_cond, dom);
1119 return res;
1122 /* Extract an affine expression representing the disjunction (logical or)
1123 * or conjunction (logical and) of two subexpressions.
1125 __isl_give isl_pw_aff *PetScan::extract_boolean(BinaryOperator *comp)
1127 isl_pw_aff *lhs, *rhs;
1129 lhs = extract_condition(comp->getLHS());
1130 rhs = extract_condition(comp->getRHS());
1132 switch (comp->getOpcode()) {
1133 case BO_LAnd:
1134 return pw_aff_and_then(lhs, rhs);
1135 case BO_LOr:
1136 return pw_aff_or_else(lhs, rhs);
1137 default:
1138 isl_pw_aff_free(lhs);
1139 isl_pw_aff_free(rhs);
1142 unsupported(comp);
1143 return NULL;
1146 __isl_give isl_pw_aff *PetScan::extract_condition(UnaryOperator *expr)
1148 switch (expr->getOpcode()) {
1149 case UO_LNot:
1150 return extract_boolean(expr);
1151 default:
1152 unsupported(expr);
1153 return NULL;
1157 /* Extract the affine expression "expr != 0 ? 1 : 0".
1159 __isl_give isl_pw_aff *PetScan::extract_implicit_condition(Expr *expr)
1161 isl_pw_aff *res;
1162 isl_set *set, *dom;
1164 res = extract_affine(expr);
1166 dom = isl_pw_aff_domain(isl_pw_aff_copy(res));
1167 set = isl_pw_aff_non_zero_set(res);
1169 res = indicator_function(set, dom);
1171 return res;
1174 /* Extract an affine expression from a boolean expression.
1175 * In particular, return the expression "expr ? 1 : 0".
1177 * If the expression doesn't look like a condition, we assume it
1178 * is an affine expression and return the condition "expr != 0 ? 1 : 0".
1180 __isl_give isl_pw_aff *PetScan::extract_condition(Expr *expr)
1182 BinaryOperator *comp;
1184 if (!expr) {
1185 isl_set *u = isl_set_universe(isl_space_params_alloc(ctx, 0));
1186 return indicator_function(u, isl_set_copy(u));
1189 if (expr->getStmtClass() == Stmt::ParenExprClass)
1190 return extract_condition(cast<ParenExpr>(expr)->getSubExpr());
1192 if (expr->getStmtClass() == Stmt::UnaryOperatorClass)
1193 return extract_condition(cast<UnaryOperator>(expr));
1195 if (expr->getStmtClass() != Stmt::BinaryOperatorClass)
1196 return extract_implicit_condition(expr);
1198 comp = cast<BinaryOperator>(expr);
1199 switch (comp->getOpcode()) {
1200 case BO_LT:
1201 case BO_LE:
1202 case BO_GT:
1203 case BO_GE:
1204 case BO_EQ:
1205 case BO_NE:
1206 return extract_comparison(comp);
1207 case BO_LAnd:
1208 case BO_LOr:
1209 return extract_boolean(comp);
1210 default:
1211 return extract_implicit_condition(expr);
1215 static enum pet_op_type UnaryOperatorKind2pet_op_type(UnaryOperatorKind kind)
1217 switch (kind) {
1218 case UO_Minus:
1219 return pet_op_minus;
1220 default:
1221 return pet_op_last;
1225 static enum pet_op_type BinaryOperatorKind2pet_op_type(BinaryOperatorKind kind)
1227 switch (kind) {
1228 case BO_AddAssign:
1229 return pet_op_add_assign;
1230 case BO_SubAssign:
1231 return pet_op_sub_assign;
1232 case BO_MulAssign:
1233 return pet_op_mul_assign;
1234 case BO_DivAssign:
1235 return pet_op_div_assign;
1236 case BO_Assign:
1237 return pet_op_assign;
1238 case BO_Add:
1239 return pet_op_add;
1240 case BO_Sub:
1241 return pet_op_sub;
1242 case BO_Mul:
1243 return pet_op_mul;
1244 case BO_Div:
1245 return pet_op_div;
1246 case BO_EQ:
1247 return pet_op_eq;
1248 case BO_LE:
1249 return pet_op_le;
1250 case BO_LT:
1251 return pet_op_lt;
1252 case BO_GT:
1253 return pet_op_gt;
1254 default:
1255 return pet_op_last;
1259 /* Construct a pet_expr representing a unary operator expression.
1261 struct pet_expr *PetScan::extract_expr(UnaryOperator *expr)
1263 struct pet_expr *arg;
1264 enum pet_op_type op;
1266 op = UnaryOperatorKind2pet_op_type(expr->getOpcode());
1267 if (op == pet_op_last) {
1268 unsupported(expr);
1269 return NULL;
1272 arg = extract_expr(expr->getSubExpr());
1274 return pet_expr_new_unary(ctx, op, arg);
1277 /* Mark the given access pet_expr as a write.
1278 * If a scalar is being accessed, then mark its value
1279 * as unknown in assigned_value.
1281 void PetScan::mark_write(struct pet_expr *access)
1283 isl_id *id;
1284 ValueDecl *decl;
1286 access->acc.write = 1;
1287 access->acc.read = 0;
1289 if (isl_map_dim(access->acc.access, isl_dim_out) != 0)
1290 return;
1292 id = isl_map_get_tuple_id(access->acc.access, isl_dim_out);
1293 decl = (ValueDecl *) isl_id_get_user(id);
1294 clear_assignment(assigned_value, decl);
1295 isl_id_free(id);
1298 /* Construct a pet_expr representing a binary operator expression.
1300 * If the top level operator is an assignment and the LHS is an access,
1301 * then we mark that access as a write. If the operator is a compound
1302 * assignment, the access is marked as both a read and a write.
1304 * If "expr" assigns something to a scalar variable, then we mark
1305 * the variable as having been assigned. If, furthermore, the expression
1306 * is affine, then keep track of this value in assigned_value
1307 * so that we can plug it in when we later come across the same variable.
1309 struct pet_expr *PetScan::extract_expr(BinaryOperator *expr)
1311 struct pet_expr *lhs, *rhs;
1312 enum pet_op_type op;
1314 op = BinaryOperatorKind2pet_op_type(expr->getOpcode());
1315 if (op == pet_op_last) {
1316 unsupported(expr);
1317 return NULL;
1320 lhs = extract_expr(expr->getLHS());
1321 rhs = extract_expr(expr->getRHS());
1323 if (expr->isAssignmentOp() && lhs && lhs->type == pet_expr_access) {
1324 mark_write(lhs);
1325 if (expr->isCompoundAssignmentOp())
1326 lhs->acc.read = 1;
1329 if (expr->getOpcode() == BO_Assign &&
1330 lhs && lhs->type == pet_expr_access &&
1331 isl_map_dim(lhs->acc.access, isl_dim_out) == 0) {
1332 isl_id *id = isl_map_get_tuple_id(lhs->acc.access, isl_dim_out);
1333 ValueDecl *decl = (ValueDecl *) isl_id_get_user(id);
1334 Expr *rhs = expr->getRHS();
1335 isl_pw_aff *pa = try_extract_affine(rhs);
1336 clear_assignment(assigned_value, decl);
1337 if (pa) {
1338 assigned_value[decl] = pa;
1339 insert_expression(pa);
1341 isl_id_free(id);
1344 return pet_expr_new_binary(ctx, op, lhs, rhs);
1347 /* Construct a pet_expr representing a conditional operation.
1349 * We first try to extract the condition as an affine expression.
1350 * If that fails, we construct a pet_expr tree representing the condition.
1352 struct pet_expr *PetScan::extract_expr(ConditionalOperator *expr)
1354 struct pet_expr *cond, *lhs, *rhs;
1355 isl_pw_aff *pa;
1357 pa = try_extract_affine(expr->getCond());
1358 if (pa) {
1359 isl_set *test = isl_set_from_pw_aff(pa);
1360 cond = pet_expr_from_access(isl_map_from_range(test));
1361 } else
1362 cond = extract_expr(expr->getCond());
1363 lhs = extract_expr(expr->getTrueExpr());
1364 rhs = extract_expr(expr->getFalseExpr());
1366 return pet_expr_new_ternary(ctx, cond, lhs, rhs);
1369 struct pet_expr *PetScan::extract_expr(ImplicitCastExpr *expr)
1371 return extract_expr(expr->getSubExpr());
1374 /* Construct a pet_expr representing a floating point value.
1376 struct pet_expr *PetScan::extract_expr(FloatingLiteral *expr)
1378 return pet_expr_new_double(ctx, expr->getValueAsApproximateDouble());
1381 /* Extract an access relation from "expr" and then convert it into
1382 * a pet_expr.
1384 struct pet_expr *PetScan::extract_access_expr(Expr *expr)
1386 isl_map *access;
1387 struct pet_expr *pe;
1389 switch (expr->getStmtClass()) {
1390 case Stmt::ArraySubscriptExprClass:
1391 access = extract_access(cast<ArraySubscriptExpr>(expr));
1392 break;
1393 case Stmt::DeclRefExprClass:
1394 access = extract_access(cast<DeclRefExpr>(expr));
1395 break;
1396 case Stmt::IntegerLiteralClass:
1397 access = extract_access(cast<IntegerLiteral>(expr));
1398 break;
1399 default:
1400 unsupported(expr);
1401 return NULL;
1404 pe = pet_expr_from_access(access);
1406 return pe;
1409 struct pet_expr *PetScan::extract_expr(ParenExpr *expr)
1411 return extract_expr(expr->getSubExpr());
1414 /* Construct a pet_expr representing a function call.
1416 * If we are passing along a pointer to an array element
1417 * or an entire row or even higher dimensional slice of an array,
1418 * then the function being called may write into the array.
1420 * We assume here that if the function is declared to take a pointer
1421 * to a const type, then the function will perform a read
1422 * and that otherwise, it will perform a write.
1424 struct pet_expr *PetScan::extract_expr(CallExpr *expr)
1426 struct pet_expr *res = NULL;
1427 FunctionDecl *fd;
1428 string name;
1430 fd = expr->getDirectCallee();
1431 if (!fd) {
1432 unsupported(expr);
1433 return NULL;
1436 name = fd->getDeclName().getAsString();
1437 res = pet_expr_new_call(ctx, name.c_str(), expr->getNumArgs());
1438 if (!res)
1439 return NULL;
1441 for (int i = 0; i < expr->getNumArgs(); ++i) {
1442 Expr *arg = expr->getArg(i);
1443 int is_addr = 0;
1444 pet_expr *main_arg;
1446 if (arg->getStmtClass() == Stmt::ImplicitCastExprClass) {
1447 ImplicitCastExpr *ice = cast<ImplicitCastExpr>(arg);
1448 arg = ice->getSubExpr();
1450 if (arg->getStmtClass() == Stmt::UnaryOperatorClass) {
1451 UnaryOperator *op = cast<UnaryOperator>(arg);
1452 if (op->getOpcode() == UO_AddrOf) {
1453 is_addr = 1;
1454 arg = op->getSubExpr();
1457 res->args[i] = PetScan::extract_expr(arg);
1458 main_arg = res->args[i];
1459 if (is_addr)
1460 res->args[i] = pet_expr_new_unary(ctx,
1461 pet_op_address_of, res->args[i]);
1462 if (!res->args[i])
1463 goto error;
1464 if (arg->getStmtClass() == Stmt::ArraySubscriptExprClass &&
1465 array_depth(arg->getType().getTypePtr()) > 0)
1466 is_addr = 1;
1467 if (is_addr && main_arg->type == pet_expr_access) {
1468 ParmVarDecl *parm;
1469 if (!fd->hasPrototype()) {
1470 unsupported(expr, "prototype required");
1471 goto error;
1473 parm = fd->getParamDecl(i);
1474 if (!const_base(parm->getType()))
1475 mark_write(main_arg);
1479 return res;
1480 error:
1481 pet_expr_free(res);
1482 return NULL;
1485 /* Try and onstruct a pet_expr representing "expr".
1487 struct pet_expr *PetScan::extract_expr(Expr *expr)
1489 switch (expr->getStmtClass()) {
1490 case Stmt::UnaryOperatorClass:
1491 return extract_expr(cast<UnaryOperator>(expr));
1492 case Stmt::CompoundAssignOperatorClass:
1493 case Stmt::BinaryOperatorClass:
1494 return extract_expr(cast<BinaryOperator>(expr));
1495 case Stmt::ImplicitCastExprClass:
1496 return extract_expr(cast<ImplicitCastExpr>(expr));
1497 case Stmt::ArraySubscriptExprClass:
1498 case Stmt::DeclRefExprClass:
1499 case Stmt::IntegerLiteralClass:
1500 return extract_access_expr(expr);
1501 case Stmt::FloatingLiteralClass:
1502 return extract_expr(cast<FloatingLiteral>(expr));
1503 case Stmt::ParenExprClass:
1504 return extract_expr(cast<ParenExpr>(expr));
1505 case Stmt::ConditionalOperatorClass:
1506 return extract_expr(cast<ConditionalOperator>(expr));
1507 case Stmt::CallExprClass:
1508 return extract_expr(cast<CallExpr>(expr));
1509 default:
1510 unsupported(expr);
1512 return NULL;
1515 /* Check if the given initialization statement is an assignment.
1516 * If so, return that assignment. Otherwise return NULL.
1518 BinaryOperator *PetScan::initialization_assignment(Stmt *init)
1520 BinaryOperator *ass;
1522 if (init->getStmtClass() != Stmt::BinaryOperatorClass)
1523 return NULL;
1525 ass = cast<BinaryOperator>(init);
1526 if (ass->getOpcode() != BO_Assign)
1527 return NULL;
1529 return ass;
1532 /* Check if the given initialization statement is a declaration
1533 * of a single variable.
1534 * If so, return that declaration. Otherwise return NULL.
1536 Decl *PetScan::initialization_declaration(Stmt *init)
1538 DeclStmt *decl;
1540 if (init->getStmtClass() != Stmt::DeclStmtClass)
1541 return NULL;
1543 decl = cast<DeclStmt>(init);
1545 if (!decl->isSingleDecl())
1546 return NULL;
1548 return decl->getSingleDecl();
1551 /* Given the assignment operator in the initialization of a for loop,
1552 * extract the induction variable, i.e., the (integer)variable being
1553 * assigned.
1555 ValueDecl *PetScan::extract_induction_variable(BinaryOperator *init)
1557 Expr *lhs;
1558 DeclRefExpr *ref;
1559 ValueDecl *decl;
1560 const Type *type;
1562 lhs = init->getLHS();
1563 if (lhs->getStmtClass() != Stmt::DeclRefExprClass) {
1564 unsupported(init);
1565 return NULL;
1568 ref = cast<DeclRefExpr>(lhs);
1569 decl = ref->getDecl();
1570 type = decl->getType().getTypePtr();
1572 if (!type->isIntegerType()) {
1573 unsupported(lhs);
1574 return NULL;
1577 return decl;
1580 /* Given the initialization statement of a for loop and the single
1581 * declaration in this initialization statement,
1582 * extract the induction variable, i.e., the (integer) variable being
1583 * declared.
1585 VarDecl *PetScan::extract_induction_variable(Stmt *init, Decl *decl)
1587 VarDecl *vd;
1589 vd = cast<VarDecl>(decl);
1591 const QualType type = vd->getType();
1592 if (!type->isIntegerType()) {
1593 unsupported(init);
1594 return NULL;
1597 if (!vd->getInit()) {
1598 unsupported(init);
1599 return NULL;
1602 return vd;
1605 /* Check that op is of the form iv++ or iv--.
1606 * Return an affine expression "1" or "-1" accordingly.
1608 __isl_give isl_pw_aff *PetScan::extract_unary_increment(
1609 clang::UnaryOperator *op, clang::ValueDecl *iv)
1611 Expr *sub;
1612 DeclRefExpr *ref;
1613 isl_space *space;
1614 isl_aff *aff;
1616 if (!op->isIncrementDecrementOp()) {
1617 unsupported(op);
1618 return NULL;
1621 sub = op->getSubExpr();
1622 if (sub->getStmtClass() != Stmt::DeclRefExprClass) {
1623 unsupported(op);
1624 return NULL;
1627 ref = cast<DeclRefExpr>(sub);
1628 if (ref->getDecl() != iv) {
1629 unsupported(op);
1630 return NULL;
1633 space = isl_space_params_alloc(ctx, 0);
1634 aff = isl_aff_zero_on_domain(isl_local_space_from_space(space));
1636 if (op->isIncrementOp())
1637 aff = isl_aff_add_constant_si(aff, 1);
1638 else
1639 aff = isl_aff_add_constant_si(aff, -1);
1641 return isl_pw_aff_from_aff(aff);
1644 /* If the isl_pw_aff on which isl_pw_aff_foreach_piece is called
1645 * has a single constant expression on a universe domain, then
1646 * put this constant in *user.
1648 static int extract_cst(__isl_take isl_set *set, __isl_take isl_aff *aff,
1649 void *user)
1651 isl_int *inc = (isl_int *)user;
1652 int res = 0;
1654 if (!isl_set_plain_is_universe(set) || !isl_aff_is_cst(aff))
1655 res = -1;
1656 else
1657 isl_aff_get_constant(aff, inc);
1659 isl_set_free(set);
1660 isl_aff_free(aff);
1662 return res;
1665 /* Check if op is of the form
1667 * iv = iv + inc
1669 * and return inc as an affine expression.
1671 * We extract an affine expression from the RHS, subtract iv and return
1672 * the result.
1674 __isl_give isl_pw_aff *PetScan::extract_binary_increment(BinaryOperator *op,
1675 clang::ValueDecl *iv)
1677 Expr *lhs;
1678 DeclRefExpr *ref;
1679 isl_id *id;
1680 isl_space *dim;
1681 isl_aff *aff;
1682 isl_pw_aff *val;
1684 if (op->getOpcode() != BO_Assign) {
1685 unsupported(op);
1686 return NULL;
1689 lhs = op->getLHS();
1690 if (lhs->getStmtClass() != Stmt::DeclRefExprClass) {
1691 unsupported(op);
1692 return NULL;
1695 ref = cast<DeclRefExpr>(lhs);
1696 if (ref->getDecl() != iv) {
1697 unsupported(op);
1698 return NULL;
1701 val = extract_affine(op->getRHS());
1703 id = isl_id_alloc(ctx, iv->getName().str().c_str(), iv);
1705 dim = isl_space_params_alloc(ctx, 1);
1706 dim = isl_space_set_dim_id(dim, isl_dim_param, 0, id);
1707 aff = isl_aff_zero_on_domain(isl_local_space_from_space(dim));
1708 aff = isl_aff_add_coefficient_si(aff, isl_dim_param, 0, 1);
1710 val = isl_pw_aff_sub(val, isl_pw_aff_from_aff(aff));
1712 return val;
1715 /* Check that op is of the form iv += cst or iv -= cst
1716 * and return an affine expression corresponding oto cst or -cst accordingly.
1718 __isl_give isl_pw_aff *PetScan::extract_compound_increment(
1719 CompoundAssignOperator *op, clang::ValueDecl *iv)
1721 Expr *lhs;
1722 DeclRefExpr *ref;
1723 bool neg = false;
1724 isl_pw_aff *val;
1725 BinaryOperatorKind opcode;
1727 opcode = op->getOpcode();
1728 if (opcode != BO_AddAssign && opcode != BO_SubAssign) {
1729 unsupported(op);
1730 return NULL;
1732 if (opcode == BO_SubAssign)
1733 neg = true;
1735 lhs = op->getLHS();
1736 if (lhs->getStmtClass() != Stmt::DeclRefExprClass) {
1737 unsupported(op);
1738 return NULL;
1741 ref = cast<DeclRefExpr>(lhs);
1742 if (ref->getDecl() != iv) {
1743 unsupported(op);
1744 return NULL;
1747 val = extract_affine(op->getRHS());
1748 if (neg)
1749 val = isl_pw_aff_neg(val);
1751 return val;
1754 /* Check that the increment of the given for loop increments
1755 * (or decrements) the induction variable "iv" and return
1756 * the increment as an affine expression if successful.
1758 __isl_give isl_pw_aff *PetScan::extract_increment(clang::ForStmt *stmt,
1759 ValueDecl *iv)
1761 Stmt *inc = stmt->getInc();
1763 if (!inc) {
1764 unsupported(stmt);
1765 return NULL;
1768 if (inc->getStmtClass() == Stmt::UnaryOperatorClass)
1769 return extract_unary_increment(cast<UnaryOperator>(inc), iv);
1770 if (inc->getStmtClass() == Stmt::CompoundAssignOperatorClass)
1771 return extract_compound_increment(
1772 cast<CompoundAssignOperator>(inc), iv);
1773 if (inc->getStmtClass() == Stmt::BinaryOperatorClass)
1774 return extract_binary_increment(cast<BinaryOperator>(inc), iv);
1776 unsupported(inc);
1777 return NULL;
1780 /* Embed the given iteration domain in an extra outer loop
1781 * with induction variable "var".
1782 * If this variable appeared as a parameter in the constraints,
1783 * it is replaced by the new outermost dimension.
1785 static __isl_give isl_set *embed(__isl_take isl_set *set,
1786 __isl_take isl_id *var)
1788 int pos;
1790 set = isl_set_insert_dims(set, isl_dim_set, 0, 1);
1791 pos = isl_set_find_dim_by_id(set, isl_dim_param, var);
1792 if (pos >= 0) {
1793 set = isl_set_equate(set, isl_dim_param, pos, isl_dim_set, 0);
1794 set = isl_set_project_out(set, isl_dim_param, pos, 1);
1797 isl_id_free(var);
1798 return set;
1801 /* Construct a pet_scop for an infinite loop around the given body.
1803 * We extract a pet_scop for the body and then embed it in a loop with
1804 * iteration domain
1806 * { [t] : t >= 0 }
1808 * and schedule
1810 * { [t] -> [t] }
1812 struct pet_scop *PetScan::extract_infinite_loop(Stmt *body)
1814 isl_id *id;
1815 isl_space *dim;
1816 isl_set *domain;
1817 isl_map *sched;
1818 struct pet_scop *scop;
1820 scop = extract(body);
1821 if (!scop)
1822 return NULL;
1824 id = isl_id_alloc(ctx, "t", NULL);
1825 domain = isl_set_nat_universe(isl_space_set_alloc(ctx, 0, 1));
1826 domain = isl_set_set_dim_id(domain, isl_dim_set, 0, isl_id_copy(id));
1827 dim = isl_space_from_domain(isl_set_get_space(domain));
1828 dim = isl_space_add_dims(dim, isl_dim_out, 1);
1829 sched = isl_map_universe(dim);
1830 sched = isl_map_equate(sched, isl_dim_in, 0, isl_dim_out, 0);
1831 scop = pet_scop_embed(scop, domain, sched, id);
1833 return scop;
1836 /* Construct a pet_scop for an infinite loop, i.e., a loop of the form
1838 * for (;;)
1839 * body
1842 struct pet_scop *PetScan::extract_infinite_for(ForStmt *stmt)
1844 return extract_infinite_loop(stmt->getBody());
1847 /* Check if the while loop is of the form
1849 * while (1)
1850 * body
1852 * If so, construct a scop for an infinite loop around body.
1853 * Otherwise, fail.
1855 struct pet_scop *PetScan::extract(WhileStmt *stmt)
1857 Expr *cond;
1858 isl_set *set;
1859 int is_universe;
1861 cond = stmt->getCond();
1862 if (!cond) {
1863 unsupported(stmt);
1864 return NULL;
1867 set = isl_pw_aff_non_zero_set(extract_condition(cond));
1868 is_universe = isl_set_plain_is_universe(set);
1869 isl_set_free(set);
1871 if (!is_universe) {
1872 unsupported(stmt);
1873 return NULL;
1876 return extract_infinite_loop(stmt->getBody());
1879 /* Check whether "cond" expresses a simple loop bound
1880 * on the only set dimension.
1881 * In particular, if "up" is set then "cond" should contain only
1882 * upper bounds on the set dimension.
1883 * Otherwise, it should contain only lower bounds.
1885 static bool is_simple_bound(__isl_keep isl_set *cond, isl_int inc)
1887 if (isl_int_is_pos(inc))
1888 return !isl_set_dim_has_lower_bound(cond, isl_dim_set, 0);
1889 else
1890 return !isl_set_dim_has_upper_bound(cond, isl_dim_set, 0);
1893 /* Extend a condition on a given iteration of a loop to one that
1894 * imposes the same condition on all previous iterations.
1895 * "domain" expresses the lower [upper] bound on the iterations
1896 * when inc is positive [negative].
1898 * In particular, we construct the condition (when inc is positive)
1900 * forall i' : (domain(i') and i' <= i) => cond(i')
1902 * which is equivalent to
1904 * not exists i' : domain(i') and i' <= i and not cond(i')
1906 * We construct this set by negating cond, applying a map
1908 * { [i'] -> [i] : domain(i') and i' <= i }
1910 * and then negating the result again.
1912 static __isl_give isl_set *valid_for_each_iteration(__isl_take isl_set *cond,
1913 __isl_take isl_set *domain, isl_int inc)
1915 isl_map *previous_to_this;
1917 if (isl_int_is_pos(inc))
1918 previous_to_this = isl_map_lex_le(isl_set_get_space(domain));
1919 else
1920 previous_to_this = isl_map_lex_ge(isl_set_get_space(domain));
1922 previous_to_this = isl_map_intersect_domain(previous_to_this, domain);
1924 cond = isl_set_complement(cond);
1925 cond = isl_set_apply(cond, previous_to_this);
1926 cond = isl_set_complement(cond);
1928 return cond;
1931 /* Construct a domain of the form
1933 * [id] -> { : exists a: id = init + a * inc and a >= 0 }
1935 static __isl_give isl_set *strided_domain(__isl_take isl_id *id,
1936 __isl_take isl_pw_aff *init, isl_int inc)
1938 isl_aff *aff;
1939 isl_space *dim;
1940 isl_set *set;
1942 init = isl_pw_aff_insert_dims(init, isl_dim_in, 0, 1);
1943 dim = isl_pw_aff_get_domain_space(init);
1944 aff = isl_aff_zero_on_domain(isl_local_space_from_space(dim));
1945 aff = isl_aff_add_coefficient(aff, isl_dim_in, 0, inc);
1946 init = isl_pw_aff_add(init, isl_pw_aff_from_aff(aff));
1948 dim = isl_space_set_alloc(isl_pw_aff_get_ctx(init), 1, 1);
1949 dim = isl_space_set_dim_id(dim, isl_dim_param, 0, id);
1950 aff = isl_aff_zero_on_domain(isl_local_space_from_space(dim));
1951 aff = isl_aff_add_coefficient_si(aff, isl_dim_param, 0, 1);
1953 set = isl_pw_aff_eq_set(isl_pw_aff_from_aff(aff), init);
1955 set = isl_set_lower_bound_si(set, isl_dim_set, 0, 0);
1957 return isl_set_params(set);
1960 /* Assuming "cond" represents a bound on a loop where the loop
1961 * iterator "iv" is incremented (or decremented) by one, check if wrapping
1962 * is possible.
1964 * Under the given assumptions, wrapping is only possible if "cond" allows
1965 * for the last value before wrapping, i.e., 2^width - 1 in case of an
1966 * increasing iterator and 0 in case of a decreasing iterator.
1968 static bool can_wrap(__isl_keep isl_set *cond, ValueDecl *iv, isl_int inc)
1970 bool cw;
1971 isl_int limit;
1972 isl_set *test;
1974 test = isl_set_copy(cond);
1976 isl_int_init(limit);
1977 if (isl_int_is_neg(inc))
1978 isl_int_set_si(limit, 0);
1979 else {
1980 isl_int_set_si(limit, 1);
1981 isl_int_mul_2exp(limit, limit, get_type_size(iv));
1982 isl_int_sub_ui(limit, limit, 1);
1985 test = isl_set_fix(cond, isl_dim_set, 0, limit);
1986 cw = !isl_set_is_empty(test);
1987 isl_set_free(test);
1989 isl_int_clear(limit);
1991 return cw;
1994 /* Given a one-dimensional space, construct the following mapping on this
1995 * space
1997 * { [v] -> [v mod 2^width] }
1999 * where width is the number of bits used to represent the values
2000 * of the unsigned variable "iv".
2002 static __isl_give isl_map *compute_wrapping(__isl_take isl_space *dim,
2003 ValueDecl *iv)
2005 isl_int mod;
2006 isl_aff *aff;
2007 isl_map *map;
2009 isl_int_init(mod);
2010 isl_int_set_si(mod, 1);
2011 isl_int_mul_2exp(mod, mod, get_type_size(iv));
2013 aff = isl_aff_zero_on_domain(isl_local_space_from_space(dim));
2014 aff = isl_aff_add_coefficient_si(aff, isl_dim_in, 0, 1);
2015 aff = isl_aff_mod(aff, mod);
2017 isl_int_clear(mod);
2019 return isl_map_from_basic_map(isl_basic_map_from_aff(aff));
2020 map = isl_map_reverse(map);
2023 /* Construct a pet_scop for a for statement.
2024 * The for loop is required to be of the form
2026 * for (i = init; condition; ++i)
2028 * or
2030 * for (i = init; condition; --i)
2032 * The initialization of the for loop should either be an assignment
2033 * to an integer variable, or a declaration of such a variable with
2034 * initialization.
2036 * The condition is allowed to contain nested accesses, provided
2037 * they are not being written to inside the body of the loop.
2039 * We extract a pet_scop for the body and then embed it in a loop with
2040 * iteration domain and schedule
2042 * { [i] : i >= init and condition' }
2043 * { [i] -> [i] }
2045 * or
2047 * { [i] : i <= init and condition' }
2048 * { [i] -> [-i] }
2050 * Where condition' is equal to condition if the latter is
2051 * a simple upper [lower] bound and a condition that is extended
2052 * to apply to all previous iterations otherwise.
2054 * If the stride of the loop is not 1, then "i >= init" is replaced by
2056 * (exists a: i = init + stride * a and a >= 0)
2058 * If the loop iterator i is unsigned, then wrapping may occur.
2059 * During the computation, we work with a virtual iterator that
2060 * does not wrap. However, the condition in the code applies
2061 * to the wrapped value, so we need to change condition(i)
2062 * into condition([i % 2^width]).
2063 * After computing the virtual domain and schedule, we apply
2064 * the function { [v] -> [v % 2^width] } to the domain and the domain
2065 * of the schedule. In order not to lose any information, we also
2066 * need to intersect the domain of the schedule with the virtual domain
2067 * first, since some iterations in the wrapped domain may be scheduled
2068 * several times, typically an infinite number of times.
2069 * Note that there is no need to perform this final wrapping
2070 * if the loop condition (after wrapping) is simple.
2072 * Wrapping on unsigned iterators can be avoided entirely if
2073 * loop condition is simple, the loop iterator is incremented
2074 * [decremented] by one and the last value before wrapping cannot
2075 * possibly satisfy the loop condition.
2077 * Before extracting a pet_scop from the body we remove all
2078 * assignments in assigned_value to variables that are assigned
2079 * somewhere in the body of the loop.
2081 struct pet_scop *PetScan::extract_for(ForStmt *stmt)
2083 BinaryOperator *ass;
2084 Decl *decl;
2085 Stmt *init;
2086 Expr *lhs, *rhs;
2087 ValueDecl *iv;
2088 isl_space *dim;
2089 isl_set *domain;
2090 isl_map *sched;
2091 isl_set *cond = NULL;
2092 isl_id *id;
2093 struct pet_scop *scop;
2094 assigned_value_cache cache(assigned_value);
2095 isl_int inc;
2096 bool is_one;
2097 bool is_unsigned;
2098 bool is_simple;
2099 bool is_virtual;
2100 isl_map *wrap = NULL;
2101 isl_pw_aff *pa, *pa_inc;
2103 if (!stmt->getInit() && !stmt->getCond() && !stmt->getInc())
2104 return extract_infinite_for(stmt);
2106 init = stmt->getInit();
2107 if (!init) {
2108 unsupported(stmt);
2109 return NULL;
2111 if ((ass = initialization_assignment(init)) != NULL) {
2112 iv = extract_induction_variable(ass);
2113 if (!iv)
2114 return NULL;
2115 lhs = ass->getLHS();
2116 rhs = ass->getRHS();
2117 } else if ((decl = initialization_declaration(init)) != NULL) {
2118 VarDecl *var = extract_induction_variable(init, decl);
2119 if (!var)
2120 return NULL;
2121 iv = var;
2122 rhs = var->getInit();
2123 lhs = create_DeclRefExpr(var);
2124 } else {
2125 unsupported(stmt->getInit());
2126 return NULL;
2129 pa_inc = extract_increment(stmt, iv);
2130 if (!pa_inc)
2131 return NULL;
2133 isl_int_init(inc);
2134 if (isl_pw_aff_foreach_piece(pa_inc, &extract_cst, &inc) < 0) {
2135 isl_pw_aff_free(pa_inc);
2136 unsupported(stmt->getInc());
2137 isl_int_clear(inc);
2138 return NULL;
2140 isl_pw_aff_free(pa_inc);
2142 is_unsigned = iv->getType()->isUnsignedIntegerType();
2144 assigned_value.erase(iv);
2145 clear_assignments clear(assigned_value);
2146 clear.TraverseStmt(stmt->getBody());
2148 id = isl_id_alloc(ctx, iv->getName().str().c_str(), iv);
2150 scop = extract(stmt->getBody());
2152 pa = try_extract_nested_condition(stmt->getCond());
2153 if (pa && !is_nested_allowed(pa, scop)) {
2154 isl_pw_aff_free(pa);
2155 pa = NULL;
2158 if (!pa)
2159 pa = extract_condition(stmt->getCond());
2160 cond = isl_pw_aff_non_zero_set(pa);
2161 cond = embed(cond, isl_id_copy(id));
2162 is_one = isl_int_is_one(inc) || isl_int_is_negone(inc);
2163 is_virtual = is_unsigned && (!is_one || can_wrap(cond, iv, inc));
2165 if (is_one && !is_virtual) {
2166 pa = extract_comparison(isl_int_is_pos(inc) ? BO_GE : BO_LE,
2167 lhs, rhs, init);
2168 domain = isl_pw_aff_non_zero_set(pa);
2169 } else {
2170 isl_pw_aff *lb = extract_affine(rhs);
2171 domain = strided_domain(isl_id_copy(id), lb, inc);
2174 domain = embed(domain, isl_id_copy(id));
2175 if (is_virtual) {
2176 wrap = compute_wrapping(isl_set_get_space(cond), iv);
2177 cond = isl_set_apply(cond, isl_map_reverse(isl_map_copy(wrap)));
2179 cond = isl_set_gist(cond, isl_set_copy(domain));
2180 is_simple = is_simple_bound(cond, inc);
2181 if (!is_simple)
2182 cond = valid_for_each_iteration(cond,
2183 isl_set_copy(domain), inc);
2184 domain = isl_set_intersect(domain, cond);
2185 domain = isl_set_set_dim_id(domain, isl_dim_set, 0, isl_id_copy(id));
2186 dim = isl_space_from_domain(isl_set_get_space(domain));
2187 dim = isl_space_add_dims(dim, isl_dim_out, 1);
2188 sched = isl_map_universe(dim);
2189 if (isl_int_is_pos(inc))
2190 sched = isl_map_equate(sched, isl_dim_in, 0, isl_dim_out, 0);
2191 else
2192 sched = isl_map_oppose(sched, isl_dim_in, 0, isl_dim_out, 0);
2194 if (is_virtual && !is_simple) {
2195 wrap = isl_map_set_dim_id(wrap,
2196 isl_dim_out, 0, isl_id_copy(id));
2197 sched = isl_map_intersect_domain(sched, isl_set_copy(domain));
2198 domain = isl_set_apply(domain, isl_map_copy(wrap));
2199 sched = isl_map_apply_domain(sched, wrap);
2200 } else
2201 isl_map_free(wrap);
2203 scop = pet_scop_embed(scop, domain, sched, id);
2204 scop = resolve_nested(scop);
2205 clear_assignment(assigned_value, iv);
2207 isl_int_clear(inc);
2208 return scop;
2211 struct pet_scop *PetScan::extract(CompoundStmt *stmt)
2213 return extract(stmt->children());
2216 /* Does "id" refer to a nested access?
2218 static bool is_nested_parameter(__isl_keep isl_id *id)
2220 return id && isl_id_get_user(id) && !isl_id_get_name(id);
2223 /* Does parameter "pos" of "space" refer to a nested access?
2225 static bool is_nested_parameter(__isl_keep isl_space *space, int pos)
2227 bool nested;
2228 isl_id *id;
2230 id = isl_space_get_dim_id(space, isl_dim_param, pos);
2231 nested = is_nested_parameter(id);
2232 isl_id_free(id);
2234 return nested;
2237 /* Does parameter "pos" of "map" refer to a nested access?
2239 static bool is_nested_parameter(__isl_keep isl_map *map, int pos)
2241 bool nested;
2242 isl_id *id;
2244 id = isl_map_get_dim_id(map, isl_dim_param, pos);
2245 nested = is_nested_parameter(id);
2246 isl_id_free(id);
2248 return nested;
2251 /* How many parameters of "space" refer to nested accesses, i.e., have no name?
2253 static int n_nested_parameter(__isl_keep isl_space *space)
2255 int n = 0;
2256 int nparam;
2258 nparam = isl_space_dim(space, isl_dim_param);
2259 for (int i = 0; i < nparam; ++i)
2260 if (is_nested_parameter(space, i))
2261 ++n;
2263 return n;
2266 /* How many parameters of "map" refer to nested accesses, i.e., have no name?
2268 static int n_nested_parameter(__isl_keep isl_map *map)
2270 isl_space *space;
2271 int n;
2273 space = isl_map_get_space(map);
2274 n = n_nested_parameter(space);
2275 isl_space_free(space);
2277 return n;
2280 /* For each nested access parameter in "space",
2281 * construct a corresponding pet_expr, place it in args and
2282 * record its position in "param2pos".
2283 * "n_arg" is the number of elements that are already in args.
2284 * The position recorded in "param2pos" takes this number into account.
2285 * If the pet_expr corresponding to a parameter is identical to
2286 * the pet_expr corresponding to an earlier parameter, then these two
2287 * parameters are made to refer to the same element in args.
2289 * Return the final number of elements in args or -1 if an error has occurred.
2291 int PetScan::extract_nested(__isl_keep isl_space *space,
2292 int n_arg, struct pet_expr **args, std::map<int,int> &param2pos)
2294 int nparam;
2296 nparam = isl_space_dim(space, isl_dim_param);
2297 for (int i = 0; i < nparam; ++i) {
2298 int j;
2299 isl_id *id = isl_space_get_dim_id(space, isl_dim_param, i);
2300 Expr *nested;
2302 if (!is_nested_parameter(id)) {
2303 isl_id_free(id);
2304 continue;
2307 nested = (Expr *) isl_id_get_user(id);
2308 args[n_arg] = extract_expr(nested);
2309 if (!args[n_arg])
2310 return -1;
2312 for (j = 0; j < n_arg; ++j)
2313 if (pet_expr_is_equal(args[j], args[n_arg]))
2314 break;
2316 if (j < n_arg) {
2317 pet_expr_free(args[n_arg]);
2318 args[n_arg] = NULL;
2319 param2pos[i] = j;
2320 } else
2321 param2pos[i] = n_arg++;
2323 isl_id_free(id);
2326 return n_arg;
2329 /* For each nested access parameter in the access relations in "expr",
2330 * construct a corresponding pet_expr, place it in expr->args and
2331 * record its position in "param2pos".
2332 * n is the number of nested access parameters.
2334 struct pet_expr *PetScan::extract_nested(struct pet_expr *expr, int n,
2335 std::map<int,int> &param2pos)
2337 isl_space *space;
2339 expr->args = isl_calloc_array(ctx, struct pet_expr *, n);
2340 expr->n_arg = n;
2341 if (!expr->args)
2342 goto error;
2344 space = isl_map_get_space(expr->acc.access);
2345 n = extract_nested(space, 0, expr->args, param2pos);
2346 isl_space_free(space);
2348 if (n < 0)
2349 goto error;
2351 expr->n_arg = n;
2352 return expr;
2353 error:
2354 pet_expr_free(expr);
2355 return NULL;
2358 /* Look for parameters in any access relation in "expr" that
2359 * refer to nested accesses. In particular, these are
2360 * parameters with no name.
2362 * If there are any such parameters, then the domain of the access
2363 * relation, which is still [] at this point, is replaced by
2364 * [[] -> [t_1,...,t_n]], with n the number of these parameters
2365 * (after identifying identical nested accesses).
2366 * The parameters are then equated to the corresponding t dimensions
2367 * and subsequently projected out.
2368 * param2pos maps the position of the parameter to the position
2369 * of the corresponding t dimension.
2371 struct pet_expr *PetScan::resolve_nested(struct pet_expr *expr)
2373 int n;
2374 int nparam;
2375 int n_in;
2376 isl_space *dim;
2377 isl_map *map;
2378 std::map<int,int> param2pos;
2380 if (!expr)
2381 return expr;
2383 for (int i = 0; i < expr->n_arg; ++i) {
2384 expr->args[i] = resolve_nested(expr->args[i]);
2385 if (!expr->args[i]) {
2386 pet_expr_free(expr);
2387 return NULL;
2391 if (expr->type != pet_expr_access)
2392 return expr;
2394 n = n_nested_parameter(expr->acc.access);
2395 if (n == 0)
2396 return expr;
2398 expr = extract_nested(expr, n, param2pos);
2399 if (!expr)
2400 return NULL;
2402 n = expr->n_arg;
2403 nparam = isl_map_dim(expr->acc.access, isl_dim_param);
2404 n_in = isl_map_dim(expr->acc.access, isl_dim_in);
2405 dim = isl_map_get_space(expr->acc.access);
2406 dim = isl_space_domain(dim);
2407 dim = isl_space_from_domain(dim);
2408 dim = isl_space_add_dims(dim, isl_dim_out, n);
2409 map = isl_map_universe(dim);
2410 map = isl_map_domain_map(map);
2411 map = isl_map_reverse(map);
2412 expr->acc.access = isl_map_apply_domain(expr->acc.access, map);
2414 for (int i = nparam - 1; i >= 0; --i) {
2415 isl_id *id = isl_map_get_dim_id(expr->acc.access,
2416 isl_dim_param, i);
2417 if (!is_nested_parameter(id)) {
2418 isl_id_free(id);
2419 continue;
2422 expr->acc.access = isl_map_equate(expr->acc.access,
2423 isl_dim_param, i, isl_dim_in,
2424 n_in + param2pos[i]);
2425 expr->acc.access = isl_map_project_out(expr->acc.access,
2426 isl_dim_param, i, 1);
2428 isl_id_free(id);
2431 return expr;
2432 error:
2433 pet_expr_free(expr);
2434 return NULL;
2437 /* Convert a top-level pet_expr to a pet_scop with one statement.
2438 * This mainly involves resolving nested expression parameters
2439 * and setting the name of the iteration space.
2440 * The name is given by "label" if it is non-NULL. Otherwise,
2441 * it is of the form S_<n_stmt>.
2443 struct pet_scop *PetScan::extract(Stmt *stmt, struct pet_expr *expr,
2444 __isl_take isl_id *label)
2446 struct pet_stmt *ps;
2447 SourceLocation loc = stmt->getLocStart();
2448 int line = PP.getSourceManager().getExpansionLineNumber(loc);
2450 expr = resolve_nested(expr);
2451 ps = pet_stmt_from_pet_expr(ctx, line, label, n_stmt++, expr);
2452 return pet_scop_from_pet_stmt(ctx, ps);
2455 /* Check if we can extract an affine expression from "expr".
2456 * Return the expressions as an isl_pw_aff if we can and NULL otherwise.
2457 * We turn on autodetection so that we won't generate any warnings
2458 * and turn off nesting, so that we won't accept any non-affine constructs.
2460 __isl_give isl_pw_aff *PetScan::try_extract_affine(Expr *expr)
2462 isl_pw_aff *pwaff;
2463 int save_autodetect = autodetect;
2464 bool save_nesting = nesting_enabled;
2466 autodetect = 1;
2467 nesting_enabled = false;
2469 pwaff = extract_affine(expr);
2471 autodetect = save_autodetect;
2472 nesting_enabled = save_nesting;
2474 return pwaff;
2477 /* Check whether "expr" is an affine expression.
2479 bool PetScan::is_affine(Expr *expr)
2481 isl_pw_aff *pwaff;
2483 pwaff = try_extract_affine(expr);
2484 isl_pw_aff_free(pwaff);
2486 return pwaff != NULL;
2489 /* Check whether "expr" is an affine constraint.
2490 * We turn on autodetection so that we won't generate any warnings
2491 * and turn off nesting, so that we won't accept any non-affine constructs.
2493 bool PetScan::is_affine_condition(Expr *expr)
2495 isl_pw_aff *cond;
2496 int save_autodetect = autodetect;
2497 bool save_nesting = nesting_enabled;
2499 autodetect = 1;
2500 nesting_enabled = false;
2502 cond = extract_condition(expr);
2503 isl_pw_aff_free(cond);
2505 autodetect = save_autodetect;
2506 nesting_enabled = save_nesting;
2508 return cond != NULL;
2511 /* Check if we can extract a condition from "expr".
2512 * Return the condition as an isl_pw_aff if we can and NULL otherwise.
2513 * If allow_nested is set, then the condition may involve parameters
2514 * corresponding to nested accesses.
2515 * We turn on autodetection so that we won't generate any warnings.
2517 __isl_give isl_pw_aff *PetScan::try_extract_nested_condition(Expr *expr)
2519 isl_pw_aff *cond;
2520 int save_autodetect = autodetect;
2521 bool save_nesting = nesting_enabled;
2523 autodetect = 1;
2524 nesting_enabled = allow_nested;
2525 cond = extract_condition(expr);
2527 autodetect = save_autodetect;
2528 nesting_enabled = save_nesting;
2530 return cond;
2533 /* If the top-level expression of "stmt" is an assignment, then
2534 * return that assignment as a BinaryOperator.
2535 * Otherwise return NULL.
2537 static BinaryOperator *top_assignment_or_null(Stmt *stmt)
2539 BinaryOperator *ass;
2541 if (!stmt)
2542 return NULL;
2543 if (stmt->getStmtClass() != Stmt::BinaryOperatorClass)
2544 return NULL;
2546 ass = cast<BinaryOperator>(stmt);
2547 if(ass->getOpcode() != BO_Assign)
2548 return NULL;
2550 return ass;
2553 /* Check if the given if statement is a conditional assignement
2554 * with a non-affine condition. If so, construct a pet_scop
2555 * corresponding to this conditional assignment. Otherwise return NULL.
2557 * In particular we check if "stmt" is of the form
2559 * if (condition)
2560 * a = f(...);
2561 * else
2562 * a = g(...);
2564 * where a is some array or scalar access.
2565 * The constructed pet_scop then corresponds to the expression
2567 * a = condition ? f(...) : g(...)
2569 * All access relations in f(...) are intersected with condition
2570 * while all access relation in g(...) are intersected with the complement.
2572 struct pet_scop *PetScan::extract_conditional_assignment(IfStmt *stmt)
2574 BinaryOperator *ass_then, *ass_else;
2575 isl_map *write_then, *write_else;
2576 isl_set *cond, *comp;
2577 isl_map *map;
2578 isl_pw_aff *pa;
2579 int equal;
2580 struct pet_expr *pe_cond, *pe_then, *pe_else, *pe, *pe_write;
2581 bool save_nesting = nesting_enabled;
2583 ass_then = top_assignment_or_null(stmt->getThen());
2584 ass_else = top_assignment_or_null(stmt->getElse());
2586 if (!ass_then || !ass_else)
2587 return NULL;
2589 if (is_affine_condition(stmt->getCond()))
2590 return NULL;
2592 write_then = extract_access(ass_then->getLHS());
2593 write_else = extract_access(ass_else->getLHS());
2595 equal = isl_map_is_equal(write_then, write_else);
2596 isl_map_free(write_else);
2597 if (equal < 0 || !equal) {
2598 isl_map_free(write_then);
2599 return NULL;
2602 nesting_enabled = allow_nested;
2603 pa = extract_condition(stmt->getCond());
2604 nesting_enabled = save_nesting;
2605 cond = isl_pw_aff_non_zero_set(isl_pw_aff_copy(pa));
2606 comp = isl_pw_aff_zero_set(isl_pw_aff_copy(pa));
2607 map = isl_map_from_range(isl_set_from_pw_aff(pa));
2609 pe_cond = pet_expr_from_access(map);
2611 pe_then = extract_expr(ass_then->getRHS());
2612 pe_then = pet_expr_restrict(pe_then, cond);
2613 pe_else = extract_expr(ass_else->getRHS());
2614 pe_else = pet_expr_restrict(pe_else, comp);
2616 pe = pet_expr_new_ternary(ctx, pe_cond, pe_then, pe_else);
2617 pe_write = pet_expr_from_access(write_then);
2618 if (pe_write) {
2619 pe_write->acc.write = 1;
2620 pe_write->acc.read = 0;
2622 pe = pet_expr_new_binary(ctx, pet_op_assign, pe_write, pe);
2623 return extract(stmt, pe);
2626 /* Create an access to a virtual array representing the result
2627 * of a condition.
2628 * Unlike other accessed data, the id of the array is NULL as
2629 * there is no ValueDecl in the program corresponding to the virtual
2630 * array.
2631 * The array starts out as a scalar, but grows along with the
2632 * statement writing to the array in pet_scop_embed.
2634 static __isl_give isl_map *create_test_access(isl_ctx *ctx, int test_nr)
2636 isl_space *dim = isl_space_alloc(ctx, 0, 0, 0);
2637 isl_id *id;
2638 char name[50];
2640 snprintf(name, sizeof(name), "__pet_test_%d", test_nr);
2641 id = isl_id_alloc(ctx, name, NULL);
2642 dim = isl_space_set_tuple_id(dim, isl_dim_out, id);
2643 return isl_map_universe(dim);
2646 /* Create a pet_scop with a single statement evaluating "cond"
2647 * and writing the result to a virtual scalar, as expressed by
2648 * "access".
2650 struct pet_scop *PetScan::extract_non_affine_condition(Expr *cond,
2651 __isl_take isl_map *access)
2653 struct pet_expr *expr, *write;
2654 struct pet_stmt *ps;
2655 SourceLocation loc = cond->getLocStart();
2656 int line = PP.getSourceManager().getExpansionLineNumber(loc);
2658 write = pet_expr_from_access(access);
2659 if (write) {
2660 write->acc.write = 1;
2661 write->acc.read = 0;
2663 expr = extract_expr(cond);
2664 expr = pet_expr_new_binary(ctx, pet_op_assign, write, expr);
2665 ps = pet_stmt_from_pet_expr(ctx, line, NULL, n_stmt++, expr);
2666 return pet_scop_from_pet_stmt(ctx, ps);
2669 /* Add an array with the given extent ("access") to the list
2670 * of arrays in "scop" and return the extended pet_scop.
2671 * The array is marked as attaining values 0 and 1 only.
2673 static struct pet_scop *scop_add_array(struct pet_scop *scop,
2674 __isl_keep isl_map *access, clang::ASTContext &ast_ctx)
2676 isl_ctx *ctx = isl_map_get_ctx(access);
2677 isl_space *dim;
2678 struct pet_array **arrays;
2679 struct pet_array *array;
2681 if (!scop)
2682 return NULL;
2683 if (!ctx)
2684 goto error;
2686 arrays = isl_realloc_array(ctx, scop->arrays, struct pet_array *,
2687 scop->n_array + 1);
2688 if (!arrays)
2689 goto error;
2690 scop->arrays = arrays;
2692 array = isl_calloc_type(ctx, struct pet_array);
2693 if (!array)
2694 goto error;
2696 array->extent = isl_map_range(isl_map_copy(access));
2697 dim = isl_space_params_alloc(ctx, 0);
2698 array->context = isl_set_universe(dim);
2699 dim = isl_space_set_alloc(ctx, 0, 1);
2700 array->value_bounds = isl_set_universe(dim);
2701 array->value_bounds = isl_set_lower_bound_si(array->value_bounds,
2702 isl_dim_set, 0, 0);
2703 array->value_bounds = isl_set_upper_bound_si(array->value_bounds,
2704 isl_dim_set, 0, 1);
2705 array->element_type = strdup("int");
2706 array->element_size = ast_ctx.getTypeInfo(ast_ctx.IntTy).first / 8;
2708 scop->arrays[scop->n_array] = array;
2709 scop->n_array++;
2711 if (!array->extent || !array->context)
2712 goto error;
2714 return scop;
2715 error:
2716 pet_scop_free(scop);
2717 return NULL;
2720 extern "C" {
2721 static __isl_give isl_map *embed_access(__isl_take isl_map *access,
2722 void *user);
2725 /* Apply the map pointed to by "user" to the domain of the access
2726 * relation, thereby embedding it in the range of the map.
2727 * The domain of both relations is the zero-dimensional domain.
2729 static __isl_give isl_map *embed_access(__isl_take isl_map *access, void *user)
2731 isl_map *map = (isl_map *) user;
2733 return isl_map_apply_domain(access, isl_map_copy(map));
2736 /* Apply "map" to all access relations in "expr".
2738 static struct pet_expr *embed(struct pet_expr *expr, __isl_keep isl_map *map)
2740 return pet_expr_foreach_access(expr, &embed_access, map);
2743 /* How many parameters of "set" refer to nested accesses, i.e., have no name?
2745 static int n_nested_parameter(__isl_keep isl_set *set)
2747 isl_space *space;
2748 int n;
2750 space = isl_set_get_space(set);
2751 n = n_nested_parameter(space);
2752 isl_space_free(space);
2754 return n;
2757 /* Remove all parameters from "map" that refer to nested accesses.
2759 static __isl_give isl_map *remove_nested_parameters(__isl_take isl_map *map)
2761 int nparam;
2762 isl_space *space;
2764 space = isl_map_get_space(map);
2765 nparam = isl_space_dim(space, isl_dim_param);
2766 for (int i = nparam - 1; i >= 0; --i)
2767 if (is_nested_parameter(space, i))
2768 map = isl_map_project_out(map, isl_dim_param, i, 1);
2769 isl_space_free(space);
2771 return map;
2774 extern "C" {
2775 static __isl_give isl_map *access_remove_nested_parameters(
2776 __isl_take isl_map *access, void *user);
2779 static __isl_give isl_map *access_remove_nested_parameters(
2780 __isl_take isl_map *access, void *user)
2782 return remove_nested_parameters(access);
2785 /* Remove all nested access parameters from the schedule and all
2786 * accesses of "stmt".
2787 * There is no need to remove them from the domain as these parameters
2788 * have already been removed from the domain when this function is called.
2790 static struct pet_stmt *remove_nested_parameters(struct pet_stmt *stmt)
2792 if (!stmt)
2793 return NULL;
2794 stmt->schedule = remove_nested_parameters(stmt->schedule);
2795 stmt->body = pet_expr_foreach_access(stmt->body,
2796 &access_remove_nested_parameters, NULL);
2797 if (!stmt->schedule || !stmt->body)
2798 goto error;
2799 for (int i = 0; i < stmt->n_arg; ++i) {
2800 stmt->args[i] = pet_expr_foreach_access(stmt->args[i],
2801 &access_remove_nested_parameters, NULL);
2802 if (!stmt->args[i])
2803 goto error;
2806 return stmt;
2807 error:
2808 pet_stmt_free(stmt);
2809 return NULL;
2812 /* For each nested access parameter in the domain of "stmt",
2813 * construct a corresponding pet_expr, place it in stmt->args and
2814 * record its position in "param2pos".
2815 * n is the number of nested access parameters.
2817 struct pet_stmt *PetScan::extract_nested(struct pet_stmt *stmt, int n,
2818 std::map<int,int> &param2pos)
2820 isl_space *space;
2821 unsigned n_arg;
2822 struct pet_expr **args;
2824 n_arg = stmt->n_arg;
2825 args = isl_realloc_array(ctx, stmt->args, struct pet_expr *, n_arg + n);
2826 if (!args)
2827 goto error;
2828 stmt->args = args;
2829 stmt->n_arg += n;
2831 space = isl_set_get_space(stmt->domain);
2832 n = extract_nested(space, n_arg, stmt->args, param2pos);
2833 isl_space_free(space);
2835 if (n < 0)
2836 goto error;
2838 stmt->n_arg = n;
2839 return stmt;
2840 error:
2841 pet_stmt_free(stmt);
2842 return NULL;
2845 /* Look for parameters in the iteration domain of "stmt" that
2846 * refer to nested accesses. In particular, these are
2847 * parameters with no name.
2849 * If there are any such parameters, then as many extra variables
2850 * (after identifying identical nested accesses) are added to the
2851 * range of the map wrapped inside the domain.
2852 * If the original domain is not a wrapped map, then a new wrapped
2853 * map is created with zero output dimensions.
2854 * The parameters are then equated to the corresponding output dimensions
2855 * and subsequently projected out, from the iteration domain,
2856 * the schedule and the access relations.
2857 * For each of the output dimensions, a corresponding argument
2858 * expression is added. Initially they are created with
2859 * a zero-dimensional domain, so they have to be embedded
2860 * in the current iteration domain.
2861 * param2pos maps the position of the parameter to the position
2862 * of the corresponding output dimension in the wrapped map.
2864 struct pet_stmt *PetScan::resolve_nested(struct pet_stmt *stmt)
2866 int n;
2867 int nparam;
2868 unsigned n_arg;
2869 isl_map *map;
2870 std::map<int,int> param2pos;
2872 if (!stmt)
2873 return NULL;
2875 n = n_nested_parameter(stmt->domain);
2876 if (n == 0)
2877 return stmt;
2879 n_arg = stmt->n_arg;
2880 stmt = extract_nested(stmt, n, param2pos);
2881 if (!stmt)
2882 return NULL;
2884 n = stmt->n_arg - n_arg;
2885 nparam = isl_set_dim(stmt->domain, isl_dim_param);
2886 if (isl_set_is_wrapping(stmt->domain))
2887 map = isl_set_unwrap(stmt->domain);
2888 else
2889 map = isl_map_from_domain(stmt->domain);
2890 map = isl_map_add_dims(map, isl_dim_out, n);
2892 for (int i = nparam - 1; i >= 0; --i) {
2893 isl_id *id;
2895 if (!is_nested_parameter(map, i))
2896 continue;
2898 id = isl_map_get_tuple_id(stmt->args[param2pos[i]]->acc.access,
2899 isl_dim_out);
2900 map = isl_map_set_dim_id(map, isl_dim_out, param2pos[i], id);
2901 map = isl_map_equate(map, isl_dim_param, i, isl_dim_out,
2902 param2pos[i]);
2903 map = isl_map_project_out(map, isl_dim_param, i, 1);
2906 stmt->domain = isl_map_wrap(map);
2908 map = isl_set_unwrap(isl_set_copy(stmt->domain));
2909 map = isl_map_from_range(isl_map_domain(map));
2910 for (int pos = n_arg; pos < stmt->n_arg; ++pos)
2911 stmt->args[pos] = embed(stmt->args[pos], map);
2912 isl_map_free(map);
2914 stmt = remove_nested_parameters(stmt);
2916 return stmt;
2917 error:
2918 pet_stmt_free(stmt);
2919 return NULL;
2922 /* For each statement in "scop", move the parameters that correspond
2923 * to nested access into the ranges of the domains and create
2924 * corresponding argument expressions.
2926 struct pet_scop *PetScan::resolve_nested(struct pet_scop *scop)
2928 if (!scop)
2929 return NULL;
2931 for (int i = 0; i < scop->n_stmt; ++i) {
2932 scop->stmts[i] = resolve_nested(scop->stmts[i]);
2933 if (!scop->stmts[i])
2934 goto error;
2937 return scop;
2938 error:
2939 pet_scop_free(scop);
2940 return NULL;
2943 /* Does "space" involve any parameters that refer to nested
2944 * accesses, i.e., parameters with no name?
2946 static bool has_nested(__isl_keep isl_space *space)
2948 int nparam;
2950 nparam = isl_space_dim(space, isl_dim_param);
2951 for (int i = 0; i < nparam; ++i)
2952 if (is_nested_parameter(space, i))
2953 return true;
2955 return false;
2958 /* Does "pa" involve any parameters that refer to nested
2959 * accesses, i.e., parameters with no name?
2961 static bool has_nested(__isl_keep isl_pw_aff *pa)
2963 isl_space *space;
2964 bool nested;
2966 space = isl_pw_aff_get_space(pa);
2967 nested = has_nested(space);
2968 isl_space_free(space);
2970 return nested;
2973 /* Given an access expression "expr", is the variable accessed by
2974 * "expr" assigned anywhere inside "scop"?
2976 static bool is_assigned(pet_expr *expr, pet_scop *scop)
2978 bool assigned = false;
2979 isl_id *id;
2981 id = isl_map_get_tuple_id(expr->acc.access, isl_dim_out);
2982 assigned = pet_scop_writes(scop, id);
2983 isl_id_free(id);
2985 return assigned;
2988 /* Are all nested access parameters in "pa" allowed given "scop".
2989 * In particular, is none of them written by anywhere inside "scop".
2991 bool PetScan::is_nested_allowed(__isl_keep isl_pw_aff *pa, pet_scop *scop)
2993 int nparam;
2995 nparam = isl_pw_aff_dim(pa, isl_dim_param);
2996 for (int i = 0; i < nparam; ++i) {
2997 Expr *nested;
2998 isl_id *id = isl_pw_aff_get_dim_id(pa, isl_dim_param, i);
2999 pet_expr *expr;
3000 bool allowed;
3002 if (!is_nested_parameter(id)) {
3003 isl_id_free(id);
3004 continue;
3007 nested = (Expr *) isl_id_get_user(id);
3008 expr = extract_expr(nested);
3009 allowed = expr && expr->type == pet_expr_access &&
3010 !is_assigned(expr, scop);
3012 pet_expr_free(expr);
3013 isl_id_free(id);
3015 if (!allowed)
3016 return false;
3019 return true;
3022 /* Construct a pet_scop for an if statement.
3024 * If the condition fits the pattern of a conditional assignment,
3025 * then it is handled by extract_conditional_assignment.
3026 * Otherwise, we do the following.
3028 * If the condition is affine, then the condition is added
3029 * to the iteration domains of the then branch, while the
3030 * opposite of the condition in added to the iteration domains
3031 * of the else branch, if any.
3032 * We allow the condition to be dynamic, i.e., to refer to
3033 * scalars or array elements that may be written to outside
3034 * of the given if statement. These nested accesses are then represented
3035 * as output dimensions in the wrapping iteration domain.
3036 * If it also written _inside_ the then or else branch, then
3037 * we treat the condition as non-affine.
3038 * As explained below, this will introduce an extra statement.
3039 * For aesthetic reasons, we want this statement to have a statement
3040 * number that is lower than those of the then and else branches.
3041 * In order to evaluate if will need such a statement, however, we
3042 * first construct scops for the then and else branches.
3043 * We therefore reserve a statement number if we might have to
3044 * introduce such an extra statement.
3046 * If the condition is not affine, then we create a separate
3047 * statement that writes the result of the condition to a virtual scalar.
3048 * A constraint requiring the value of this virtual scalar to be one
3049 * is added to the iteration domains of the then branch.
3050 * Similarly, a constraint requiring the value of this virtual scalar
3051 * to be zero is added to the iteration domains of the else branch, if any.
3052 * We adjust the schedules to ensure that the virtual scalar is written
3053 * before it is read.
3055 struct pet_scop *PetScan::extract(IfStmt *stmt)
3057 struct pet_scop *scop_then, *scop_else, *scop;
3058 assigned_value_cache cache(assigned_value);
3059 isl_map *test_access = NULL;
3060 isl_pw_aff *cond;
3061 int stmt_id;
3063 scop = extract_conditional_assignment(stmt);
3064 if (scop)
3065 return scop;
3067 cond = try_extract_nested_condition(stmt->getCond());
3068 if (allow_nested && (!cond || has_nested(cond)))
3069 stmt_id = n_stmt++;
3071 scop_then = extract(stmt->getThen());
3073 if (stmt->getElse()) {
3074 scop_else = extract(stmt->getElse());
3075 if (autodetect) {
3076 if (scop_then && !scop_else) {
3077 partial = true;
3078 isl_pw_aff_free(cond);
3079 return scop_then;
3081 if (!scop_then && scop_else) {
3082 partial = true;
3083 isl_pw_aff_free(cond);
3084 return scop_else;
3089 if (cond &&
3090 (!is_nested_allowed(cond, scop_then) ||
3091 (stmt->getElse() && !is_nested_allowed(cond, scop_else)))) {
3092 isl_pw_aff_free(cond);
3093 cond = NULL;
3095 if (allow_nested && !cond) {
3096 int save_n_stmt = n_stmt;
3097 test_access = create_test_access(ctx, n_test++);
3098 n_stmt = stmt_id;
3099 scop = extract_non_affine_condition(stmt->getCond(),
3100 isl_map_copy(test_access));
3101 n_stmt = save_n_stmt;
3102 scop = scop_add_array(scop, test_access, ast_context);
3103 if (!scop) {
3104 pet_scop_free(scop_then);
3105 pet_scop_free(scop_else);
3106 isl_map_free(test_access);
3107 return NULL;
3111 if (!scop) {
3112 isl_set *set;
3113 isl_set *valid;
3115 if (!cond)
3116 cond = extract_condition(stmt->getCond());
3117 valid = isl_pw_aff_domain(isl_pw_aff_copy(cond));
3118 set = isl_pw_aff_non_zero_set(cond);
3119 scop = pet_scop_restrict(scop_then, isl_set_copy(set));
3121 if (stmt->getElse()) {
3122 set = isl_set_subtract(isl_set_copy(valid), set);
3123 scop_else = pet_scop_restrict(scop_else, set);
3124 scop = pet_scop_add(ctx, scop, scop_else);
3125 } else
3126 isl_set_free(set);
3127 scop = resolve_nested(scop);
3128 scop = pet_scop_restrict_context(scop, valid);
3129 } else {
3130 scop = pet_scop_prefix(scop, 0);
3131 scop_then = pet_scop_prefix(scop_then, 1);
3132 scop_then = pet_scop_filter(scop_then,
3133 isl_map_copy(test_access), 1);
3134 scop = pet_scop_add(ctx, scop, scop_then);
3135 if (stmt->getElse()) {
3136 scop_else = pet_scop_prefix(scop_else, 1);
3137 scop_else = pet_scop_filter(scop_else, test_access, 0);
3138 scop = pet_scop_add(ctx, scop, scop_else);
3139 } else
3140 isl_map_free(test_access);
3143 return scop;
3146 /* Try and construct a pet_scop for a label statement.
3147 * We currently only allow labels on expression statements.
3149 struct pet_scop *PetScan::extract(LabelStmt *stmt)
3151 isl_id *label;
3152 Stmt *sub;
3154 sub = stmt->getSubStmt();
3155 if (!isa<Expr>(sub)) {
3156 unsupported(stmt);
3157 return NULL;
3160 label = isl_id_alloc(ctx, stmt->getName(), NULL);
3162 return extract(sub, extract_expr(cast<Expr>(sub)), label);
3165 /* Try and construct a pet_scop corresponding to "stmt".
3167 struct pet_scop *PetScan::extract(Stmt *stmt)
3169 if (isa<Expr>(stmt))
3170 return extract(stmt, extract_expr(cast<Expr>(stmt)));
3172 switch (stmt->getStmtClass()) {
3173 case Stmt::WhileStmtClass:
3174 return extract(cast<WhileStmt>(stmt));
3175 case Stmt::ForStmtClass:
3176 return extract_for(cast<ForStmt>(stmt));
3177 case Stmt::IfStmtClass:
3178 return extract(cast<IfStmt>(stmt));
3179 case Stmt::CompoundStmtClass:
3180 return extract(cast<CompoundStmt>(stmt));
3181 case Stmt::LabelStmtClass:
3182 return extract(cast<LabelStmt>(stmt));
3183 default:
3184 unsupported(stmt);
3187 return NULL;
3190 /* Try and construct a pet_scop corresponding to (part of)
3191 * a sequence of statements.
3193 struct pet_scop *PetScan::extract(StmtRange stmt_range)
3195 pet_scop *scop;
3196 StmtIterator i;
3197 int j;
3198 bool partial_range = false;
3200 scop = pet_scop_empty(ctx);
3201 for (i = stmt_range.first, j = 0; i != stmt_range.second; ++i, ++j) {
3202 Stmt *child = *i;
3203 struct pet_scop *scop_i;
3204 scop_i = extract(child);
3205 if (scop && partial) {
3206 pet_scop_free(scop_i);
3207 break;
3209 scop_i = pet_scop_prefix(scop_i, j);
3210 if (autodetect) {
3211 if (scop_i)
3212 scop = pet_scop_add(ctx, scop, scop_i);
3213 else
3214 partial_range = true;
3215 if (scop->n_stmt != 0 && !scop_i)
3216 partial = true;
3217 } else {
3218 scop = pet_scop_add(ctx, scop, scop_i);
3220 if (partial)
3221 break;
3224 if (scop && partial_range)
3225 partial = true;
3227 return scop;
3230 /* Check if the scop marked by the user is exactly this Stmt
3231 * or part of this Stmt.
3232 * If so, return a pet_scop corresponding to the marked region.
3233 * Otherwise, return NULL.
3235 struct pet_scop *PetScan::scan(Stmt *stmt)
3237 SourceManager &SM = PP.getSourceManager();
3238 unsigned start_off, end_off;
3240 start_off = SM.getFileOffset(stmt->getLocStart());
3241 end_off = SM.getFileOffset(stmt->getLocEnd());
3243 if (start_off > loc.end)
3244 return NULL;
3245 if (end_off < loc.start)
3246 return NULL;
3247 if (start_off >= loc.start && end_off <= loc.end) {
3248 return extract(stmt);
3251 StmtIterator start;
3252 for (start = stmt->child_begin(); start != stmt->child_end(); ++start) {
3253 Stmt *child = *start;
3254 if (!child)
3255 continue;
3256 start_off = SM.getFileOffset(child->getLocStart());
3257 end_off = SM.getFileOffset(child->getLocEnd());
3258 if (start_off < loc.start && end_off > loc.end)
3259 return scan(child);
3260 if (start_off >= loc.start)
3261 break;
3264 StmtIterator end;
3265 for (end = start; end != stmt->child_end(); ++end) {
3266 Stmt *child = *end;
3267 start_off = SM.getFileOffset(child->getLocStart());
3268 if (start_off >= loc.end)
3269 break;
3272 return extract(StmtRange(start, end));
3275 /* Set the size of index "pos" of "array" to "size".
3276 * In particular, add a constraint of the form
3278 * i_pos < size
3280 * to array->extent and a constraint of the form
3282 * size >= 0
3284 * to array->context.
3286 static struct pet_array *update_size(struct pet_array *array, int pos,
3287 __isl_take isl_pw_aff *size)
3289 isl_set *valid;
3290 isl_set *univ;
3291 isl_set *bound;
3292 isl_space *dim;
3293 isl_aff *aff;
3294 isl_pw_aff *index;
3295 isl_id *id;
3297 valid = isl_pw_aff_nonneg_set(isl_pw_aff_copy(size));
3298 array->context = isl_set_intersect(array->context, valid);
3300 dim = isl_set_get_space(array->extent);
3301 aff = isl_aff_zero_on_domain(isl_local_space_from_space(dim));
3302 aff = isl_aff_add_coefficient_si(aff, isl_dim_in, pos, 1);
3303 univ = isl_set_universe(isl_aff_get_domain_space(aff));
3304 index = isl_pw_aff_alloc(univ, aff);
3306 size = isl_pw_aff_add_dims(size, isl_dim_in,
3307 isl_set_dim(array->extent, isl_dim_set));
3308 id = isl_set_get_tuple_id(array->extent);
3309 size = isl_pw_aff_set_tuple_id(size, isl_dim_in, id);
3310 bound = isl_pw_aff_lt_set(index, size);
3312 array->extent = isl_set_intersect(array->extent, bound);
3314 if (!array->context || !array->extent)
3315 goto error;
3317 return array;
3318 error:
3319 pet_array_free(array);
3320 return NULL;
3323 /* Figure out the size of the array at position "pos" and all
3324 * subsequent positions from "type" and update "array" accordingly.
3326 struct pet_array *PetScan::set_upper_bounds(struct pet_array *array,
3327 const Type *type, int pos)
3329 const ArrayType *atype;
3330 isl_pw_aff *size;
3332 if (!array)
3333 return NULL;
3335 if (type->isPointerType()) {
3336 type = type->getPointeeType().getTypePtr();
3337 return set_upper_bounds(array, type, pos + 1);
3339 if (!type->isArrayType())
3340 return array;
3342 type = type->getCanonicalTypeInternal().getTypePtr();
3343 atype = cast<ArrayType>(type);
3345 if (type->isConstantArrayType()) {
3346 const ConstantArrayType *ca = cast<ConstantArrayType>(atype);
3347 size = extract_affine(ca->getSize());
3348 array = update_size(array, pos, size);
3349 } else if (type->isVariableArrayType()) {
3350 const VariableArrayType *vla = cast<VariableArrayType>(atype);
3351 size = extract_affine(vla->getSizeExpr());
3352 array = update_size(array, pos, size);
3355 type = atype->getElementType().getTypePtr();
3357 return set_upper_bounds(array, type, pos + 1);
3360 /* Construct and return a pet_array corresponding to the variable "decl".
3361 * In particular, initialize array->extent to
3363 * { name[i_1,...,i_d] : i_1,...,i_d >= 0 }
3365 * and then call set_upper_bounds to set the upper bounds on the indices
3366 * based on the type of the variable.
3368 struct pet_array *PetScan::extract_array(isl_ctx *ctx, ValueDecl *decl)
3370 struct pet_array *array;
3371 QualType qt = decl->getType();
3372 const Type *type = qt.getTypePtr();
3373 int depth = array_depth(type);
3374 QualType base = base_type(qt);
3375 string name;
3376 isl_id *id;
3377 isl_space *dim;
3379 array = isl_calloc_type(ctx, struct pet_array);
3380 if (!array)
3381 return NULL;
3383 id = isl_id_alloc(ctx, decl->getName().str().c_str(), decl);
3384 dim = isl_space_set_alloc(ctx, 0, depth);
3385 dim = isl_space_set_tuple_id(dim, isl_dim_set, id);
3387 array->extent = isl_set_nat_universe(dim);
3389 dim = isl_space_params_alloc(ctx, 0);
3390 array->context = isl_set_universe(dim);
3392 array = set_upper_bounds(array, type, 0);
3393 if (!array)
3394 return NULL;
3396 name = base.getAsString();
3397 array->element_type = strdup(name.c_str());
3398 array->element_size = decl->getASTContext().getTypeInfo(base).first / 8;
3400 return array;
3403 /* Construct a list of pet_arrays, one for each array (or scalar)
3404 * accessed inside "scop" add this list to "scop" and return the result.
3406 * The context of "scop" is updated with the intesection of
3407 * the contexts of all arrays, i.e., constraints on the parameters
3408 * that ensure that the arrays have a valid (non-negative) size.
3410 struct pet_scop *PetScan::scan_arrays(struct pet_scop *scop)
3412 int i;
3413 set<ValueDecl *> arrays;
3414 set<ValueDecl *>::iterator it;
3415 int n_array;
3416 struct pet_array **scop_arrays;
3418 if (!scop)
3419 return NULL;
3421 pet_scop_collect_arrays(scop, arrays);
3422 if (arrays.size() == 0)
3423 return scop;
3425 n_array = scop->n_array;
3427 scop_arrays = isl_realloc_array(ctx, scop->arrays, struct pet_array *,
3428 n_array + arrays.size());
3429 if (!scop_arrays)
3430 goto error;
3431 scop->arrays = scop_arrays;
3433 for (it = arrays.begin(), i = 0; it != arrays.end(); ++it, ++i) {
3434 struct pet_array *array;
3435 scop->arrays[n_array + i] = array = extract_array(ctx, *it);
3436 if (!scop->arrays[n_array + i])
3437 goto error;
3438 scop->n_array++;
3439 scop->context = isl_set_intersect(scop->context,
3440 isl_set_copy(array->context));
3441 if (!scop->context)
3442 goto error;
3445 return scop;
3446 error:
3447 pet_scop_free(scop);
3448 return NULL;
3451 /* Bound all parameters in scop->context to the possible values
3452 * of the corresponding C variable.
3454 static struct pet_scop *add_parameter_bounds(struct pet_scop *scop)
3456 int n;
3458 if (!scop)
3459 return NULL;
3461 n = isl_set_dim(scop->context, isl_dim_param);
3462 for (int i = 0; i < n; ++i) {
3463 isl_id *id;
3464 ValueDecl *decl;
3466 id = isl_set_get_dim_id(scop->context, isl_dim_param, i);
3467 decl = (ValueDecl *) isl_id_get_user(id);
3468 isl_id_free(id);
3470 scop->context = set_parameter_bounds(scop->context, i, decl);
3472 if (!scop->context)
3473 goto error;
3476 return scop;
3477 error:
3478 pet_scop_free(scop);
3479 return NULL;
3482 /* Construct a pet_scop from the given function.
3484 struct pet_scop *PetScan::scan(FunctionDecl *fd)
3486 pet_scop *scop;
3487 Stmt *stmt;
3489 stmt = fd->getBody();
3491 if (autodetect)
3492 scop = extract(stmt);
3493 else
3494 scop = scan(stmt);
3495 scop = pet_scop_detect_parameter_accesses(scop);
3496 scop = scan_arrays(scop);
3497 scop = add_parameter_bounds(scop);
3498 scop = pet_scop_gist(scop, value_bounds);
3500 return scop;