scan.cc: fix typos in comments
[pet.git] / scan.h
blobc4d5ff869881acde39816e028803486fef5370da
1 #include <map>
3 #include <clang/Basic/SourceManager.h>
4 #include <clang/AST/Decl.h>
5 #include <clang/AST/Stmt.h>
6 #include <clang/Lex/Preprocessor.h>
8 #include <isl/ctx.h>
9 #include <isl/map.h>
10 #include <isl/val.h>
12 #include "scop.h"
14 /* The location of the scop, as delimited by scop and endscop
15 * pragmas by the user.
17 struct ScopLoc {
18 ScopLoc() : end(0) {}
20 unsigned start;
21 unsigned end;
24 struct PetScan {
25 clang::Preprocessor &PP;
26 clang::ASTContext &ast_context;
27 /* If autodetect is false, then loc contains the location
28 * of the scop to be extracted.
30 ScopLoc &loc;
31 isl_ctx *ctx;
32 pet_options *options;
33 /* The sequence number of the next statement. */
34 int n_stmt;
35 /* The sequence number of the next virtual scalar. */
36 int n_test;
37 /* Set if the pet_scop returned by an extract method only
38 * represents part of the input tree.
40 bool partial;
41 /* Set is nested accesses are allowed in general.
42 * This currently defaults to true.
44 bool allow_nested;
45 /* Set if nested accesses are allowed in that part of the tree
46 * that is currently under investigation.
48 bool nesting_enabled;
49 /* Maps identifiers to the last value that was assigned to them.
50 * If an identifier is mapped to NULL, then something may have
51 * been assigned, but we don't know what.
52 * assigned_value does not take a reference to the isl_pw_aff
53 * object, so each such isl_pw_aff needs to be stored in
54 * the set of "expressions".
56 std::map<clang::ValueDecl *, isl_pw_aff *> assigned_value;
57 /* A collection of isl_pw_affs used in assigned_value or other
58 * temporary maps. expressions holds a reference for each
59 * isl_pw_aff, which is freed in the destructor of PetScan.
61 std::set<isl_pw_aff *> expressions;
63 /* A union of mappings of the form
64 * { identifier[] -> [i] : lower_bound <= i <= upper_bound }
66 isl_union_map *value_bounds;
68 PetScan(clang::Preprocessor &PP,
69 clang::ASTContext &ast_context, ScopLoc &loc,
70 pet_options *options, __isl_take isl_union_map *value_bounds) :
71 ctx(isl_union_map_get_ctx(value_bounds)), PP(PP),
72 ast_context(ast_context), loc(loc),
73 options(options), value_bounds(value_bounds),
74 n_stmt(0), n_test(0), partial(0), allow_nested(true),
75 nesting_enabled(false) { }
77 ~PetScan();
79 struct pet_scop *scan(clang::FunctionDecl *fd);
81 static __isl_give isl_val *extract_int(isl_ctx *ctx,
82 clang::IntegerLiteral *expr);
83 private:
84 void assign(struct pet_expr *lhs, clang::Expr *rhs);
86 __isl_give isl_pw_aff *signed_overflow(__isl_take isl_pw_aff *pa,
87 unsigned width);
88 void insert_expression(__isl_take isl_pw_aff *expr);
89 struct pet_scop *scan(clang::Stmt *stmt);
91 struct pet_scop *scan_arrays(struct pet_scop *scop);
92 struct pet_array *extract_array(isl_ctx *ctx, clang::ValueDecl *decl);
93 struct pet_array *set_upper_bounds(struct pet_array *array,
94 const clang::Type *type, int pos);
96 struct pet_scop *extract_non_affine_condition(clang::Expr *cond,
97 __isl_take isl_map *access);
99 struct pet_scop *extract_conditional_assignment(clang::IfStmt *stmt);
100 struct pet_scop *extract_non_affine_if(clang::Expr *cond,
101 struct pet_scop *scop_then, struct pet_scop *scop_else,
102 bool have_else, int stmt_id);
104 struct pet_scop *kill(clang::Stmt *stmt, struct pet_array *array);
106 struct pet_scop *extract(clang::Stmt *stmt,
107 bool skip_declarations = false);
108 struct pet_scop *extract(clang::StmtRange stmt_range, bool block,
109 bool skip_declarations);
110 struct pet_scop *extract(clang::IfStmt *stmt);
111 struct pet_scop *extract(clang::WhileStmt *stmt);
112 struct pet_scop *extract(clang::CompoundStmt *stmt,
113 bool skip_declarations = false);
114 struct pet_scop *extract(clang::LabelStmt *stmt);
115 struct pet_scop *extract(clang::ContinueStmt *stmt);
116 struct pet_scop *extract(clang::BreakStmt *stmt);
117 struct pet_scop *extract(clang::DeclStmt *expr);
119 struct pet_scop *extract(clang::Stmt *stmt, struct pet_expr *expr,
120 __isl_take isl_id *label = NULL);
121 struct pet_stmt *extract_kill(struct pet_scop *scop);
123 clang::BinaryOperator *initialization_assignment(clang::Stmt *init);
124 clang::Decl *initialization_declaration(clang::Stmt *init);
125 clang::ValueDecl *extract_induction_variable(clang::BinaryOperator *stmt);
126 clang::VarDecl *extract_induction_variable(clang::Stmt *init,
127 clang::Decl *stmt);
128 __isl_give isl_pw_aff *extract_unary_increment(clang::UnaryOperator *op,
129 clang::ValueDecl *iv);
130 __isl_give isl_pw_aff *extract_binary_increment(
131 clang::BinaryOperator *op,
132 clang::ValueDecl *iv);
133 __isl_give isl_pw_aff *extract_compound_increment(
134 clang::CompoundAssignOperator *op,
135 clang::ValueDecl *iv);
136 __isl_give isl_pw_aff *extract_increment(clang::ForStmt *stmt,
137 clang::ValueDecl *iv);
138 struct pet_scop *extract_for(clang::ForStmt *stmt);
139 struct pet_scop *extract_infinite_loop(clang::Stmt *body);
140 struct pet_scop *extract_infinite_for(clang::ForStmt *stmt);
141 struct pet_scop *extract_affine_while(__isl_take isl_pw_aff *pa,
142 clang::Stmt *body);
144 void mark_write(struct pet_expr *access);
145 struct pet_expr *extract_expr(clang::Expr *expr);
146 struct pet_expr *extract_expr(clang::UnaryOperator *expr);
147 struct pet_expr *extract_expr(clang::BinaryOperator *expr);
148 struct pet_expr *extract_expr(clang::ImplicitCastExpr *expr);
149 struct pet_expr *extract_expr(clang::FloatingLiteral *expr);
150 struct pet_expr *extract_expr(clang::ParenExpr *expr);
151 struct pet_expr *extract_expr(clang::ConditionalOperator *expr);
152 struct pet_expr *extract_expr(clang::CallExpr *expr);
153 struct pet_expr *extract_expr(clang::CStyleCastExpr *expr);
155 int extract_nested(__isl_keep isl_space *space,
156 int n_arg, struct pet_expr **args,
157 std::map<int,int> &param2pos);
158 struct pet_expr *extract_nested(struct pet_expr *expr, int n,
159 std::map<int,int> &param2pos);
160 struct pet_stmt *extract_nested(struct pet_stmt *stmt, int n,
161 std::map<int,int> &param2pos);
162 struct pet_expr *resolve_nested(struct pet_expr *expr);
163 struct pet_scop *resolve_nested(struct pet_scop *scop);
164 struct pet_stmt *resolve_nested(struct pet_stmt *stmt);
165 struct pet_expr *extract_access_expr(clang::Expr *expr);
167 __isl_give isl_map *extract_access(clang::ArraySubscriptExpr *expr);
168 __isl_give isl_map *extract_access(clang::Expr *expr);
169 __isl_give isl_map *extract_access(clang::ImplicitCastExpr *expr);
170 __isl_give isl_map *extract_access(clang::DeclRefExpr *expr);
171 __isl_give isl_map *extract_access(clang::ValueDecl *decl);
172 __isl_give isl_map *extract_access(clang::IntegerLiteral *expr);
174 __isl_give isl_val *extract_int(clang::Expr *expr);
175 __isl_give isl_val *extract_int(clang::ParenExpr *expr);
177 __isl_give isl_pw_aff *extract_affine_add(clang::BinaryOperator *expr);
178 __isl_give isl_pw_aff *extract_affine_div(clang::BinaryOperator *expr);
179 __isl_give isl_pw_aff *extract_affine_mod(clang::BinaryOperator *expr);
180 __isl_give isl_pw_aff *extract_affine_mul(clang::BinaryOperator *expr);
182 isl_pw_aff *nested_access(clang::Expr *expr);
184 __isl_give isl_pw_aff *try_extract_affine(clang::Expr *expr);
185 bool is_affine(clang::Expr *expr);
186 __isl_give isl_pw_aff *try_extract_affine_condition(clang::Expr *expr);
187 bool is_affine_condition(clang::Expr *expr);
188 __isl_give isl_pw_aff *try_extract_nested_condition(clang::Expr *expr);
189 bool is_nested_allowed(__isl_keep isl_pw_aff *pa, pet_scop *scop);
191 __isl_give isl_pw_aff *extract_affine(const llvm::APInt &val);
192 __isl_give isl_pw_aff *extract_affine(clang::Expr *expr);
193 __isl_give isl_pw_aff *extract_affine(clang::IntegerLiteral *expr);
194 __isl_give isl_pw_aff *extract_affine(clang::ImplicitCastExpr *expr);
195 __isl_give isl_pw_aff *extract_affine(clang::DeclRefExpr *expr);
196 __isl_give isl_pw_aff *extract_affine(clang::BinaryOperator *expr);
197 __isl_give isl_pw_aff *extract_affine(clang::UnaryOperator *expr);
198 __isl_give isl_pw_aff *extract_affine(clang::ParenExpr *expr);
199 __isl_give isl_pw_aff *extract_affine(clang::CallExpr *expr);
200 __isl_give isl_pw_aff *extract_affine(clang::ArraySubscriptExpr *expr);
201 __isl_give isl_pw_aff *extract_affine(clang::ConditionalOperator *expr);
203 __isl_give isl_pw_aff *extract_implicit_condition(clang::Expr *expr);
205 __isl_give isl_pw_aff *extract_condition(clang::UnaryOperator *expr);
206 __isl_give isl_pw_aff *extract_condition(clang::Expr *expr);
207 __isl_give isl_pw_aff *extract_comparison(clang::BinaryOperator *expr);
208 __isl_give isl_pw_aff *extract_comparison(clang::BinaryOperatorKind op,
209 clang::Expr *LHS, clang::Expr *RHS, clang::Stmt *comp);
210 __isl_give isl_pw_aff *extract_boolean(clang::BinaryOperator *expr);
211 __isl_give isl_pw_aff *extract_boolean(clang::UnaryOperator *expr);
213 void unsupported(clang::Stmt *stmt, const char *msg = NULL);