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