expr.h

   1 #ifndef PET_EXPR_H
   2 #define PET_EXPR_H
   3
   4 #include <pet.h>
   5
   6 #include "context.h"
   7
   8 #if defined(__cplusplus)
   9 extern "C" {
  10 #endif
  11
  12 /* d is valid when type == pet_expr_double
  13  * i isl valid when type == pet_expr_int
  14  * acc is valid when type == pet_expr_access
  15  * name is valid when type == pet_expr_call
  16  * type is valid when type == pet_expr_cast
  17  * op is valid otherwise
  18  *
  19  * If type_size is not zero, then the expression is of an integer type
  20  * and type_size represents the size of the type in bits.
  21  * If type_size is greater than zero, then the type is unsigned
  22  * and the number of bits is equal to type_size.
  23  * If type_size is less than zero, then the type is signed
  24  * and the number of bits is equal to -type_size.
  25  * type_size may also be zero if the size is (still) unknown.
  26  *
  27  * For each access expression inside the body of a statement, acc.ref_id
  28  * is a unique reference identifier.
  29  * acc.index represents the index expression, while acc.access
  30  * represents the corresponding access relation.
  31  * The output dimension of the index expression may be smaller
  32  * than the number of dimensions of the accessed array (recorded
  33  * in acc.depth).
  34  * The target space of the access relation, on the other hand,
  35  * is equal to the array space.
  36  * acc.access may be NULL if it can be derived directly from
  37  * acc.index and acc.depth in construct_access_relation.
  38  * That is, acc.access may be NULL if there are no additional
  39  * constraints on the access relations.
  40  * Both acc.index and acc.access usually map an iteration space
  41  * to a (partial) data space.
  42  * If the access has arguments, however, then the domain of the
  43  * mapping is a wrapped mapping from the iteration space
  44  * to a space of dimensionality equal to the number of arguments.
  45  * Each dimension in this space corresponds to the value of the
  46  * corresponding argument.
  47  *
  48  * The ranges of the index expressions and access relations may
  49  * also be wrapped relations, in which case the expression represents
  50  * a member access, with the structure represented by the domain
  51  * of this wrapped relation and the member represented by the range.
  52  * In case of nested member accesses, the domain is itself a wrapped
  53  * relation.
  54  *
  55  * If the data space is unnamed (and 1D), then it represents
  56  * the set of integers.  That is, the access represents a value that
  57  * is equal to the index.
  58  *
  59  * An access expresssion is marked "read" if it represents a read and
  60  * marked "write" if it represents a write.  A single access expression
  61  * may be marked both read and write.
  62  * Alternatively, the expression may be marked "kill", in which case it
  63  * is the argument of a kill operation and represents the set of
  64  * killed array elements.  Such accesses are marked neither read nor write.
  65  *
  66  * A double is represented as both an (approximate) value "val" and
  67  * a string representation "s".
  68  */
  69 struct pet_expr {
  70         int ref;
  71         isl_ctx *ctx;
  72
  73         enum pet_expr_type type;
  74
  75         int type_size;
  76
  77         unsigned n_arg;
  78         pet_expr **args;
  79
  80         union {
  81                 struct {
  82                         isl_id *ref_id;
  83                         isl_map *access;
  84                         isl_multi_pw_aff *index;
  85                         int depth;
  86                         unsigned read : 1;
  87                         unsigned write : 1;
  88                         unsigned kill : 1;
  89                 } acc;
  90                 enum pet_op_type op;
  91                 char *name;
  92                 char *type_name;
  93                 struct {
  94                         double val;
  95                         char *s;
  96                 } d;
  97                 isl_val *i;
  98         };
  99 };
 100
 101 const char *pet_type_str(enum pet_expr_type type);
 102 enum pet_expr_type pet_str_type(const char *str);
 103
 104 enum pet_op_type pet_str_op(const char *str);
 105
 106 __isl_give pet_expr *pet_expr_alloc(isl_ctx *ctx, enum pet_expr_type type);
 107 __isl_give pet_expr *pet_expr_kill_from_access_and_index(
 108         __isl_take isl_map *access, __isl_take isl_multi_pw_aff *index);
 109 __isl_give pet_expr *pet_expr_new_unary(enum pet_op_type op,
 110         __isl_take pet_expr *arg);
 111 __isl_give pet_expr *pet_expr_new_binary(int type_size, enum pet_op_type op,
 112         __isl_take pet_expr *lhs, __isl_take pet_expr *rhs);
 113 __isl_give pet_expr *pet_expr_new_ternary(__isl_take pet_expr *cond,
 114         __isl_take pet_expr *lhs, __isl_take pet_expr *rhs);
 115 __isl_give pet_expr *pet_expr_new_call(isl_ctx *ctx, const char *name,
 116         unsigned n_arg);
 117 __isl_give pet_expr *pet_expr_new_cast(const char *type_name,
 118         __isl_take pet_expr *arg);
 119 __isl_give pet_expr *pet_expr_new_double(isl_ctx *ctx, double d, const char *s);
 120 __isl_give pet_expr *pet_expr_new_int(__isl_take isl_val *v);
 121
 122 __isl_give pet_expr *pet_expr_cow(__isl_take pet_expr *expr);
 123
 124 __isl_give isl_pw_aff *pet_expr_extract_affine_condition(
 125         __isl_keep pet_expr *expr, __isl_keep pet_context *pc);
 126 __isl_give isl_pw_aff *pet_expr_extract_comparison(enum pet_op_type op,
 127         __isl_keep pet_expr *lhs, __isl_keep pet_expr *rhs,
 128         __isl_keep pet_context *pc);
 129 __isl_give pet_expr *pet_expr_resolve_assume(__isl_take pet_expr *expr,
 130         __isl_keep pet_context *pc);
 131
 132 int pet_expr_is_assume(__isl_keep pet_expr *expr);
 133 int pet_expr_is_boolean(__isl_keep pet_expr *expr);
 134 int pet_expr_is_comparison(__isl_keep pet_expr *expr);
 135 int pet_expr_is_min(__isl_keep pet_expr *expr);
 136 int pet_expr_is_max(__isl_keep pet_expr *expr);
 137 int pet_expr_is_scalar_access(__isl_keep pet_expr *expr);
 138 int pet_expr_is_equal(__isl_keep pet_expr *expr1, __isl_keep pet_expr *expr2);
 139
 140 __isl_give isl_space *pet_expr_access_get_parameter_space(
 141         __isl_take pet_expr *expr);
 142 __isl_give isl_space *pet_expr_access_get_domain_space(
 143         __isl_keep pet_expr *expr);
 144 __isl_give isl_space *pet_expr_access_get_data_space(__isl_keep pet_expr *expr);
 145
 146 __isl_give isl_map *pet_expr_access_get_may_access(__isl_keep pet_expr *expr);
 147
 148 __isl_give pet_expr *pet_expr_map_access(__isl_take pet_expr *expr,
 149         __isl_give pet_expr *(*fn)(__isl_take pet_expr *expr, void *user),
 150         void *user);
 151
 152 __isl_give pet_expr *pet_expr_access_set_access(__isl_take pet_expr *expr,
 153         __isl_take isl_map *access);
 154 __isl_give pet_expr *pet_expr_access_set_index(__isl_take pet_expr *expr,
 155         __isl_take isl_multi_pw_aff *index);
 156
 157 int pet_expr_is_sub_access(__isl_keep pet_expr *expr1,
 158         __isl_keep pet_expr *expr2, int n_arg);
 159
 160 int pet_expr_writes(__isl_keep pet_expr *expr, __isl_keep isl_id *id);
 161
 162 __isl_give pet_expr *pet_expr_access_move_dims(__isl_take pet_expr *expr,
 163         enum isl_dim_type dst_type, unsigned dst_pos,
 164         enum isl_dim_type src_type, unsigned src_pos, unsigned n);
 165 __isl_give pet_expr *pet_expr_access_pullback_multi_aff(
 166         __isl_take pet_expr *expr, __isl_take isl_multi_aff *ma);
 167 __isl_give pet_expr *pet_expr_access_pullback_multi_pw_aff(
 168         __isl_take pet_expr *expr, __isl_take isl_multi_pw_aff *mpa);
 169 __isl_give pet_expr *pet_expr_access_align_params(__isl_take pet_expr *expr);
 170 __isl_give pet_expr *pet_expr_restrict(__isl_take pet_expr *expr,
 171         __isl_take isl_set *cond);
 172 __isl_give pet_expr *pet_expr_access_update_domain(__isl_take pet_expr *expr,
 173         __isl_keep isl_multi_pw_aff *update);
 174 __isl_give pet_expr *pet_expr_update_domain(__isl_take pet_expr *expr,
 175         __isl_take isl_multi_pw_aff *update);
 176 __isl_give pet_expr *pet_expr_align_params(__isl_take pet_expr *expr,
 177         __isl_take isl_space *space);
 178 __isl_give pet_expr *pet_expr_filter(__isl_take pet_expr *expr,
 179         __isl_take isl_multi_pw_aff *test, int satisfied);
 180 __isl_give pet_expr *pet_expr_add_ref_ids(__isl_take pet_expr *expr,
 181         int *n_ref);
 182 __isl_give pet_expr *pet_expr_anonymize(__isl_take pet_expr *expr);
 183 __isl_give pet_expr *pet_expr_gist(__isl_take pet_expr *expr,
 184         __isl_keep isl_set *context, __isl_keep isl_union_map *value_bounds);
 185
 186 __isl_give isl_union_map *pet_expr_tag_access(__isl_keep pet_expr *expr,
 187         __isl_take isl_union_map *access);
 188
 189 __isl_give pet_expr *pet_expr_access_subscript(__isl_take pet_expr *base,
 190         __isl_take pet_expr *index);
 191 __isl_give pet_expr *pet_expr_access_member(__isl_take pet_expr *base,
 192         __isl_take isl_id *member);
 193
 194 int pet_expr_get_type_size(__isl_keep pet_expr *expr);
 195 __isl_give pet_expr *pet_expr_set_type_size(__isl_take pet_expr *expr,
 196         int type_size);
 197 __isl_give pet_expr *pet_expr_access_set_depth(__isl_take pet_expr *expr,
 198         int depth);
 199
 200 __isl_give pet_expr *pet_expr_insert_domain(__isl_take pet_expr *expr,
 201         __isl_take isl_space *space);
 202
 203 void pet_expr_dump_with_indent(__isl_keep pet_expr *expr, int indent);
 204
 205 #if defined(__cplusplus)
 206 }
 207 #endif
 208
 209 #endif