scan.h

   1 #include <map>
   2
   3 #include <clang/Basic/SourceManager.h>
   4 #include <clang/AST/Decl.h>
   5 #include <clang/AST/Stmt.h>
   6 #include <clang/Lex/Preprocessor.h>
   7
   8 #include <isl/ctx.h>
   9 #include <isl/map.h>
  10 #include <isl/val.h>
  11
  12 #include "context.h"
  13 #include "loc.h"
  14 #include "scop.h"
  15 #include "summary.h"
  16 #include "tree.h"
  17
  18 /* The location of the scop, as delimited by scop and endscop
  19  * pragmas by the user.
  20  * "start_line" is the line number of the start position.
  21  */
  22 struct ScopLoc {
  23         ScopLoc() : end(0) {}
  24
  25         unsigned start_line;
  26         unsigned start;
  27         unsigned end;
  28 };
  29
  30 /* The information extracted from a pragma pencil independent.
  31  * We currently only keep track of the line number where
  32  * the pragma appears.
  33  */
  34 struct Independent {
  35         Independent(unsigned line) : line(line) {}
  36
  37         unsigned line;
  38 };
  39
  40 /* Compare two TypeDecl pointers based on their names.
  41  */
  42 struct less_name {
  43         bool operator()(const clang::TypeDecl *x,
  44                         const clang::TypeDecl *y) {
  45                 return x->getNameAsString().compare(y->getNameAsString()) < 0;
  46         }
  47 };
  48
  49 /* The PetTypes structure collects a set of RecordDecl and
  50  * TypedefNameDecl pointers.
  51  * The pointers are sorted using a fixed order.  The actual order
  52  * is not important, only that it is consistent across platforms.
  53  */
  54 struct PetTypes {
  55         std::set<clang::RecordDecl *, less_name> records;
  56         std::set<clang::TypedefNameDecl *, less_name> typedefs;
  57
  58         void insert(clang::RecordDecl *decl) {
  59                 records.insert(decl);
  60         }
  61         void insert(clang::TypedefNameDecl *decl) {
  62                 typedefs.insert(decl);
  63         }
  64 };
  65
  66 struct PetScan {
  67         clang::Preprocessor &PP;
  68         clang::ASTContext &ast_context;
  69         /* The DeclContext of the function containing the scop.
  70          */
  71         clang::DeclContext *decl_context;
  72         /* If autodetect is false, then loc contains the location
  73          * of the scop to be extracted.
  74          */
  75         ScopLoc &loc;
  76         isl_ctx *ctx;
  77         pet_options *options;
  78         /* Set if the pet_scop returned by an extract method only
  79          * represents part of the input tree.
  80          */
  81         bool partial;
  82
  83         /* A cache of size expressions for array types as computed
  84          * by PetScan::get_array_size.
  85          */
  86         std::map<const clang::Type *, pet_expr *> type_size;
  87
  88         /* A cache of funtion summaries for function declarations
  89          * as extracted by PetScan::get_summary.
  90          */
  91         std::map<clang::FunctionDecl *, pet_function_summary *> summary_cache;
  92
  93         /* A union of mappings of the form
  94          *      { identifier[] -> [i] : lower_bound <= i <= upper_bound }
  95          */
  96         isl_union_map *value_bounds;
  97
  98         /* The line number of the previously considered Stmt. */
  99         unsigned last_line;
 100         /* The line number of the Stmt currently being considered. */
 101         unsigned current_line;
 102         /* Information about the independent pragmas in the source code. */
 103         std::vector<Independent> &independent;
 104
 105         /* All variables that have already been declared
 106          * in the current compound statement.
 107          */
 108         std::vector<clang::VarDecl *> declarations;
 109         /* Sequence number of the next rename. */
 110         int n_rename;
 111         /* Have the declared names been collected? */
 112         bool declared_names_collected;
 113         /* The names of the variables declared in decl_context,
 114          * if declared_names_collected is set.
 115          */
 116         std::set<std::string> declared_names;
 117         /* A set of names known to be in use. */
 118         std::set<std::string> used_names;
 119
 120         PetScan(clang::Preprocessor &PP, clang::ASTContext &ast_context,
 121                 clang::DeclContext *decl_context, ScopLoc &loc,
 122                 pet_options *options, __isl_take isl_union_map *value_bounds,
 123                 std::vector<Independent> &independent) :
 124                 ctx(isl_union_map_get_ctx(value_bounds)), PP(PP),
 125                 ast_context(ast_context), decl_context(decl_context), loc(loc),
 126                 options(options), value_bounds(value_bounds),
 127                 partial(false), last_line(0), current_line(0),
 128                 independent(independent), n_rename(0),
 129                 declared_names_collected(false) { }
 130
 131         ~PetScan();
 132
 133         struct pet_scop *scan(clang::FunctionDecl *fd);
 134
 135         static __isl_give isl_val *extract_int(isl_ctx *ctx,
 136                 clang::IntegerLiteral *expr);
 137         __isl_give pet_expr *get_array_size(const clang::Type *type);
 138         struct pet_array *extract_array(__isl_keep isl_id *id,
 139                 PetTypes *types, __isl_keep pet_context *pc);
 140 private:
 141         void set_current_stmt(clang::Stmt *stmt);
 142         bool is_current_stmt_marked_independent();
 143
 144         void collect_declared_names();
 145         void add_new_used_names(const std::set<std::string> &used_names);
 146         bool name_in_use(const std::string &name, clang::Decl *decl);
 147         std::string generate_new_name(const std::string &name);
 148
 149         struct pet_scop *scan(clang::Stmt *stmt);
 150
 151         struct pet_scop *scan_arrays(struct pet_scop *scop,
 152                 __isl_keep pet_context *pc);
 153         struct pet_array *extract_array(clang::ValueDecl *decl,
 154                 PetTypes *types, __isl_keep pet_context *pc);
 155         struct pet_array *extract_array(isl_ctx *ctx,
 156                 std::vector<clang::ValueDecl *> decls,
 157                 PetTypes *types, __isl_keep pet_context *pc);
 158         __isl_give pet_expr *set_upper_bounds(__isl_take pet_expr *expr,
 159                 const clang::Type *type, int pos);
 160         struct pet_array *set_upper_bounds(struct pet_array *array,
 161                 const clang::Type *type, __isl_keep pet_context *pc);
 162
 163         __isl_give pet_tree *insert_initial_declarations(
 164                 __isl_take pet_tree *tree, int n_decl,
 165                 clang::StmtRange stmt_range);
 166         __isl_give pet_tree *extract(clang::Stmt *stmt,
 167                 bool skip_declarations = false);
 168         __isl_give pet_tree *extract(clang::StmtRange stmt_range, bool block,
 169                 bool skip_declarations);
 170         __isl_give pet_tree *extract(clang::IfStmt *stmt);
 171         __isl_give pet_tree *extract(clang::WhileStmt *stmt);
 172         __isl_give pet_tree *extract(clang::CompoundStmt *stmt,
 173                 bool skip_declarations = false);
 174         __isl_give pet_tree *extract(clang::LabelStmt *stmt);
 175         __isl_give pet_tree *extract(clang::Decl *decl);
 176         __isl_give pet_tree *extract(clang::DeclStmt *expr);
 177
 178         __isl_give pet_loc *construct_pet_loc(clang::SourceRange range,
 179                 bool skip_semi);
 180         __isl_give pet_tree *extract(__isl_take pet_expr *expr,
 181                 clang::SourceRange range, bool skip_semi);
 182         __isl_give pet_tree *update_loc(__isl_take pet_tree *tree,
 183                 clang::Stmt *stmt);
 184
 185         struct pet_scop *extract_scop(__isl_take pet_tree *tree);
 186
 187         clang::BinaryOperator *initialization_assignment(clang::Stmt *init);
 188         clang::Decl *initialization_declaration(clang::Stmt *init);
 189         clang::ValueDecl *extract_induction_variable(clang::BinaryOperator *stmt);
 190         clang::VarDecl *extract_induction_variable(clang::Stmt *init,
 191                                 clang::Decl *stmt);
 192         __isl_give pet_expr *extract_unary_increment(clang::UnaryOperator *op,
 193                                 clang::ValueDecl *iv);
 194         __isl_give pet_expr *extract_binary_increment(
 195                                 clang::BinaryOperator *op,
 196                                 clang::ValueDecl *iv);
 197         __isl_give pet_expr *extract_compound_increment(
 198                                 clang::CompoundAssignOperator *op,
 199                                 clang::ValueDecl *iv);
 200         __isl_give pet_expr *extract_increment(clang::ForStmt *stmt,
 201                                 clang::ValueDecl *iv);
 202         __isl_give pet_tree *extract_for(clang::ForStmt *stmt);
 203
 204         __isl_give pet_expr *extract_assume(clang::Expr *expr);
 205         __isl_give pet_function_summary *get_summary(clang::FunctionDecl *fd);
 206         __isl_give pet_expr *set_summary(__isl_take pet_expr *expr,
 207                 clang::FunctionDecl *fd);
 208         __isl_give pet_expr *extract_argument(clang::FunctionDecl *fd, int pos,
 209                 clang::Expr *expr, bool detect_writes);
 210         __isl_give pet_expr *extract_expr(const llvm::APInt &val);
 211         __isl_give pet_expr *extract_expr(clang::Expr *expr);
 212         __isl_give pet_expr *extract_expr(clang::UnaryOperator *expr);
 213         __isl_give pet_expr *extract_expr(clang::BinaryOperator *expr);
 214         __isl_give pet_expr *extract_expr(clang::ImplicitCastExpr *expr);
 215         __isl_give pet_expr *extract_expr(clang::IntegerLiteral *expr);
 216         __isl_give pet_expr *extract_expr(clang::EnumConstantDecl *expr);
 217         __isl_give pet_expr *extract_expr(clang::FloatingLiteral *expr);
 218         __isl_give pet_expr *extract_expr(clang::ParenExpr *expr);
 219         __isl_give pet_expr *extract_expr(clang::ConditionalOperator *expr);
 220         __isl_give pet_expr *extract_expr(clang::CallExpr *expr);
 221         __isl_give pet_expr *extract_expr(clang::CStyleCastExpr *expr);
 222
 223         __isl_give pet_expr *extract_access_expr(clang::QualType qt,
 224                 __isl_take pet_expr *index);
 225         __isl_give pet_expr *extract_access_expr(clang::Expr *expr);
 226         __isl_give pet_expr *extract_access_expr(clang::ValueDecl *decl);
 227
 228         __isl_give pet_expr *extract_index_expr(
 229                 clang::ArraySubscriptExpr *expr);
 230         __isl_give pet_expr *extract_index_expr(clang::Expr *expr);
 231         __isl_give pet_expr *extract_index_expr(clang::ImplicitCastExpr *expr);
 232         __isl_give pet_expr *extract_index_expr(clang::DeclRefExpr *expr);
 233         __isl_give pet_expr *extract_index_expr(clang::ValueDecl *decl);
 234         __isl_give pet_expr *extract_index_expr(clang::MemberExpr *expr);
 235
 236         __isl_give isl_val *extract_int(clang::Expr *expr);
 237         __isl_give isl_val *extract_int(clang::ParenExpr *expr);
 238
 239         clang::FunctionDecl *find_decl_from_name(clang::CallExpr *call,
 240                 std::string name);
 241         clang::FunctionDecl *get_summary_function(clang::CallExpr *call);
 242
 243         void report(clang::Stmt *stmt, unsigned id);
 244         void unsupported(clang::Stmt *stmt);
 245         void report_unsupported_unary_operator(clang::Stmt *stmt);
 246         void report_unsupported_statement_type(clang::Stmt *stmt);
 247         void report_prototype_required(clang::Stmt *stmt);
 248         void report_missing_increment(clang::Stmt *stmt);
 249         void report_missing_summary_function(clang::Stmt *stmt);
 250         void report_missing_summary_function_body(clang::Stmt *stmt);
 251 };