include/pet.h

   1 #ifndef PET_H
   2 #define PET_H
   3
   4 #include <isl/aff.h>
   5 #include <isl/arg.h>
   6 #include <isl/ast_build.h>
   7 #include <isl/set.h>
   8 #include <isl/map.h>
   9 #include <isl/union_map.h>
  10 #include <isl/printer.h>
  11 #include <isl/id_to_ast_expr.h>
  12
  13 #if defined(__cplusplus)
  14 extern "C" {
  15 #endif
  16
  17 struct pet_options;
  18 ISL_ARG_DECL(pet_options, struct pet_options, pet_options_args)
  19
  20 /* If autodetect is set, any valid scop is extracted.
  21  * Otherwise, the scop needs to be delimited by pragmas.
  22  */
  23 int pet_options_set_autodetect(isl_ctx *ctx, int val);
  24 int pet_options_get_autodetect(isl_ctx *ctx);
  25
  26 #define PET_OVERFLOW_AVOID      0
  27 #define PET_OVERFLOW_IGNORE     1
  28 int pet_options_set_signed_overflow(isl_ctx *ctx, int val);
  29 int pet_options_get_signed_overflow(isl_ctx *ctx);
  30
  31 enum pet_expr_type {
  32         pet_expr_access,
  33         pet_expr_call,
  34         pet_expr_cast,
  35         pet_expr_double,
  36         pet_expr_unary,
  37         pet_expr_binary,
  38         pet_expr_ternary
  39 };
  40
  41 enum pet_op_type {
  42         /* only compound assignments operators before assignment */
  43         pet_op_add_assign,
  44         pet_op_sub_assign,
  45         pet_op_mul_assign,
  46         pet_op_div_assign,
  47         pet_op_assign,
  48         pet_op_add,
  49         pet_op_sub,
  50         pet_op_mul,
  51         pet_op_div,
  52         pet_op_mod,
  53         pet_op_eq,
  54         pet_op_le,
  55         pet_op_lt,
  56         pet_op_gt,
  57         pet_op_minus,
  58         pet_op_post_inc,
  59         pet_op_post_dec,
  60         pet_op_pre_inc,
  61         pet_op_pre_dec,
  62         pet_op_address_of,
  63         pet_op_kill,
  64         pet_op_last
  65 };
  66
  67 /* Index into the pet_expr->args array when pet_expr->type == pet_expr_unary
  68  */
  69 enum pet_un_arg_type {
  70         pet_un_arg
  71 };
  72
  73 /* Indices into the pet_expr->args array when
  74  * pet_expr->type == pet_expr_binary
  75  */
  76 enum pet_bin_arg_type {
  77         pet_bin_lhs,
  78         pet_bin_rhs
  79 };
  80
  81 /* Indices into the pet_expr->args array when
  82  * pet_expr->type == pet_expr_ternary
  83  */
  84 enum pet_ter_arg_type {
  85         pet_ter_cond,
  86         pet_ter_true,
  87         pet_ter_false
  88 };
  89
  90 /* d is valid when type == pet_expr_double
  91  * acc is valid when type == pet_expr_access
  92  * name is valid when type == pet_expr_call
  93  * type is valid when type == pet_expr_cast
  94  * op is valid otherwise
  95  *
  96  * For each access expression inside the body of a statement, acc.ref_id
  97  * is a unique reference identifier.
  98  * acc.index represents the index expression, while acc.access
  99  * represents the corresponding access relation.
 100  * The output dimension of the index expression may be smaller
 101  * than the number of dimensions of the accessed array.
 102  * The target space of the access relation, on the other hand,
 103  * is equal to the array space.
 104  * Both acc.index and acc.access usually map an iteration space
 105  * to a (partial) data space.
 106  * If the access has arguments, however, then the domain of the
 107  * mapping is a wrapped mapping from the iteration space
 108  * to a space of dimensionality equal to the number of arguments.
 109  * Each dimension in this space corresponds to the value of the
 110  * corresponding argument.
 111  *
 112  * The ranges of the index expressions and access relations may
 113  * also be wrapped relations, in which case the expression represents
 114  * a member access, with the structure represented by the domain
 115  * of this wrapped relation and the member represented by the range.
 116  * In case of nested member accesses, the domain is itself a wrapped
 117  * relation.
 118  *
 119  * If the data space is unnamed (and 1D), then it represents
 120  * the set of integers.  That is, the access represents a value that
 121  * is equal to the index.
 122  *
 123  * A double is represented as both an (approximate) value "val" and
 124  * a string representation "s".
 125  */
 126 struct pet_expr {
 127         enum pet_expr_type type;
 128
 129         unsigned n_arg;
 130         struct pet_expr **args;
 131
 132         union {
 133                 struct {
 134                         isl_id *ref_id;
 135                         isl_map *access;
 136                         isl_multi_pw_aff *index;
 137                         int read;
 138                         int write;
 139                 } acc;
 140                 enum pet_op_type op;
 141                 char *name;
 142                 char *type_name;
 143                 struct {
 144                         double val;
 145                         char *s;
 146                 } d;
 147         };
 148 };
 149
 150 /* Return the potential read access relation of access expression "expr". */
 151 __isl_give isl_map *pet_expr_access_get_may_access(struct pet_expr *expr);
 152 /* Return the tagged potential read access relation of access "expr". */
 153 __isl_give isl_map *pet_expr_access_get_tagged_may_access(
 154         struct pet_expr *expr);
 155
 156 /* If the statement has arguments, i.e., n_arg != 0, then
 157  * "domain" is a wrapped map, mapping the iteration domain
 158  * to the values of the arguments for which this statement
 159  * is executed.
 160  * Otherwise, it is simply the iteration domain.
 161  *
 162  * If one of the arguments is an access expression that accesses
 163  * more than one element for a given iteration, then the constraints
 164  * on the value of this argument (encoded in "domain") should be satisfied
 165  * for all of those accessed elements.
 166  */
 167 struct pet_stmt {
 168         int line;
 169         isl_set *domain;
 170         isl_map *schedule;
 171         struct pet_expr *body;
 172
 173         unsigned n_arg;
 174         struct pet_expr **args;
 175 };
 176
 177 /* Construct an associative array from reference identifiers of
 178  * access expressions in "stmt" to the corresponding isl_ast_expr.
 179  * Each index expression is first transformed through "fn_index"
 180  * (if not NULL).  Then an AST expression is generated using "build".
 181  * Finally, the AST expression is transformed using "fn_expr"
 182  * (if not NULL).
 183  */
 184 __isl_give isl_id_to_ast_expr *pet_stmt_build_ast_exprs(struct pet_stmt *stmt,
 185         __isl_keep isl_ast_build *build,
 186         __isl_give isl_multi_pw_aff *(*fn_index)(
 187                 __isl_take isl_multi_pw_aff *mpa, __isl_keep isl_id *id,
 188                 void *user), void *user_index,
 189         __isl_give isl_ast_expr *(*fn_expr)(__isl_take isl_ast_expr *expr,
 190                 __isl_keep isl_id *id, void *user), void *user_expr);
 191
 192 /* Print "stmt" to "p".
 193  *
 194  * The access expressions in "stmt" are replaced by the isl_ast_expr
 195  * associated to its reference identifier in "ref2expr".
 196  */
 197 __isl_give isl_printer *pet_stmt_print_body(struct pet_stmt *stmt,
 198         __isl_take isl_printer *p, __isl_keep isl_id_to_ast_expr *ref2expr);
 199
 200 /* This structure represents a defined type.
 201  * "name" is the name of the type, while "definition" is a string
 202  * representation of its definition.
 203  */
 204 struct pet_type {
 205         char *name;
 206         char *definition;
 207 };
 208
 209 /* context holds constraints on the parameter that ensure that
 210  * this array has a valid (i.e., non-negative) size
 211  *
 212  * extent holds constraints on the indices
 213  *
 214  * value_bounds holds constraints on the elements of the array
 215  * and may be NULL if no such constraints were specified by the user
 216  *
 217  * element_size is the size in bytes of each array element
 218  * element_type is the type of the array elements.
 219  * element_is_record is set if this type is a record type.
 220  *
 221  * live_out is set if the array appears in a live-out pragma
 222  *
 223  * if uniquely_defined is set then the array is written by a single access
 224  * such that any element that is ever read
 225  * is known to be assigned exactly once before the read
 226  *
 227  * declared is set if the array was declared somewhere inside the scop.
 228  * exposed is set if the declared array is visible outside the scop.
 229  */
 230 struct pet_array {
 231         isl_set *context;
 232         isl_set *extent;
 233         isl_set *value_bounds;
 234         char *element_type;
 235         int element_is_record;
 236         int element_size;
 237         int live_out;
 238         int uniquely_defined;
 239         int declared;
 240         int exposed;
 241 };
 242
 243 /* This structure represents an implication on a boolean filter.
 244  * In particular, if the filter value of an element in the domain
 245  * of "extension" is equal to "satisfied", then the filter values
 246  * of the corresponding images in "extension" are also equal
 247  * to "satisfied".
 248  */
 249 struct pet_implication {
 250         int satisfied;
 251         isl_map *extension;
 252 };
 253
 254 /* The start and end fields contain the offsets in the input file
 255  * of the scop, where end points to the first character after the scop.
 256  * If the scop was detected based on scop and endscop pragmas, then
 257  * the lines containing these pragmas are included in this range.
 258  * Internally, end may be zero to indicate that no offset information is
 259  * available (yet).
 260  * The context describes the set of parameter values for which
 261  * the scop can be executed.
 262  * context_value describes assignments to the parameters (if any)
 263  * outside of the scop.
 264  *
 265  * The n_type types define types that may be referenced from by the arrays.
 266  *
 267  * The n_implication implications describe implications on boolean filters.
 268  */
 269 struct pet_scop {
 270         unsigned start;
 271         unsigned end;
 272
 273         isl_set *context;
 274         isl_set *context_value;
 275
 276         int n_type;
 277         struct pet_type **types;
 278
 279         int n_array;
 280         struct pet_array **arrays;
 281
 282         int n_stmt;
 283         struct pet_stmt **stmts;
 284
 285         int n_implication;
 286         struct pet_implication **implications;
 287 };
 288
 289 /* Return a textual representation of the operator. */
 290 const char *pet_op_str(enum pet_op_type op);
 291 int pet_op_is_inc_dec(enum pet_op_type op);
 292
 293 /* Extract a pet_scop from a C source file.
 294  * If function is not NULL, then the pet_scop is extracted from
 295  * a function with that name.
 296  */
 297 struct pet_scop *pet_scop_extract_from_C_source(isl_ctx *ctx,
 298         const char *filename, const char *function);
 299
 300 /* Transform the C source file "input" by rewriting each scop
 301  * When autodetecting scops, at most one scop per function is rewritten.
 302  * The transformed C code is written to "output".
 303  */
 304 int pet_transform_C_source(isl_ctx *ctx, const char *input, FILE *output,
 305         __isl_give isl_printer *(*transform)(__isl_take isl_printer *p,
 306                 struct pet_scop *scop, void *user), void *user);
 307 /* Given a scop and a printer passed to a pet_transform_C_source callback,
 308  * print the original corresponding code to the printer.
 309  */
 310 __isl_give isl_printer *pet_scop_print_original(struct pet_scop *scop,
 311         __isl_take isl_printer *p);
 312
 313 /* Update all isl_sets and isl_maps such that they all have the same
 314  * parameters in the same order.
 315  */
 316 struct pet_scop *pet_scop_align_params(struct pet_scop *scop);
 317
 318 /* Does "scop" contain any data dependent accesses? */
 319 int pet_scop_has_data_dependent_accesses(struct pet_scop *scop);
 320 /* Does "scop" contain any data dependent conditions? */
 321 int pet_scop_has_data_dependent_conditions(struct pet_scop *scop);
 322
 323 void pet_scop_dump(struct pet_scop *scop);
 324 struct pet_scop *pet_scop_free(struct pet_scop *scop);
 325
 326 __isl_give isl_union_set *pet_scop_collect_domains(struct pet_scop *scop);
 327 /* Collect all potential read access relations. */
 328 __isl_give isl_union_map *pet_scop_collect_may_reads(struct pet_scop *scop);
 329 /* Collect all tagged potential read access relations. */
 330 __isl_give isl_union_map *pet_scop_collect_tagged_may_reads(
 331         struct pet_scop *scop);
 332 /* Collect all potential write access relations. */
 333 __isl_give isl_union_map *pet_scop_collect_may_writes(struct pet_scop *scop);
 334 /* Collect all definite write access relations. */
 335 __isl_give isl_union_map *pet_scop_collect_must_writes(struct pet_scop *scop);
 336 /* Collect all tagged potential write access relations. */
 337 __isl_give isl_union_map *pet_scop_collect_tagged_may_writes(
 338         struct pet_scop *scop);
 339 /* Collect all tagged definite write access relations. */
 340 __isl_give isl_union_map *pet_scop_collect_tagged_must_writes(
 341         struct pet_scop *scop);
 342 /* Collect all definite kill access relations. */
 343 __isl_give isl_union_map *pet_scop_collect_must_kills(struct pet_scop *scop);
 344 /* Collect all tagged definite kill access relations. */
 345 __isl_give isl_union_map *pet_scop_collect_tagged_must_kills(
 346         struct pet_scop *scop);
 347 __isl_give isl_union_map *pet_scop_collect_schedule(struct pet_scop *scop);
 348
 349 #if defined(__cplusplus)
 350 }
 351 #endif
 352
 353 #endif