6 #include <isl/ast_build.h>
9 #include <isl/union_map.h>
10 #include <isl/printer.h>
11 #include <isl/id_to_ast_expr.h>
13 #if defined(__cplusplus)
18 ISL_ARG_DECL(pet_options
, struct pet_options
, pet_options_args
)
20 /* If autodetect is set, any valid scop is extracted.
21 * Otherwise, the scop needs to be delimited by pragmas.
23 int pet_options_set_autodetect(isl_ctx
*ctx
, int val
);
24 int pet_options_get_autodetect(isl_ctx
*ctx
);
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
);
42 /* only compound assignments operators before assignment */
67 /* Index into the pet_expr->args array when pet_expr->type == pet_expr_unary
69 enum pet_un_arg_type
{
73 /* Indices into the pet_expr->args array when
74 * pet_expr->type == pet_expr_binary
76 enum pet_bin_arg_type
{
81 /* Indices into the pet_expr->args array when
82 * pet_expr->type == pet_expr_ternary
84 enum pet_ter_arg_type
{
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
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.
112 * If the data space is unnamed (and 1D), then it represents
113 * the set of integers. That is, the access represents a value that
114 * is equal to the index.
116 * A double is represented as both an (approximate) value "val" and
117 * a string representation "s".
120 enum pet_expr_type type
;
123 struct pet_expr
**args
;
129 isl_multi_pw_aff
*index
;
143 /* Return the potential read access relation of access expression "expr". */
144 __isl_give isl_map
*pet_expr_access_get_may_access(struct pet_expr
*expr
);
145 /* Return the tagged potential read access relation of access "expr". */
146 __isl_give isl_map
*pet_expr_access_get_tagged_may_access(
147 struct pet_expr
*expr
);
149 /* If the statement has arguments, i.e., n_arg != 0, then
150 * "domain" is a wrapped map, mapping the iteration domain
151 * to the values of the arguments for which this statement
153 * Otherwise, it is simply the iteration domain.
155 * If one of the arguments is an access expression that accesses
156 * more than one element for a given iteration, then the constraints
157 * on the value of this argument (encoded in "domain") should be satisfied
158 * for all of those accessed elements.
164 struct pet_expr
*body
;
167 struct pet_expr
**args
;
170 /* Construct an associative array from reference identifiers of
171 * access expressions in "stmt" to the corresponding isl_ast_expr.
172 * Each index expression is first transformed through "fn_index"
173 * (if not NULL). Then an AST expression is generated using "build".
174 * Finally, the AST expression is transformed using "fn_expr"
177 __isl_give isl_id_to_ast_expr
*pet_stmt_build_ast_exprs(struct pet_stmt
*stmt
,
178 __isl_keep isl_ast_build
*build
,
179 __isl_give isl_multi_pw_aff
*(*fn_index
)(
180 __isl_take isl_multi_pw_aff
*mpa
, __isl_keep isl_id
*id
,
181 void *user
), void *user_index
,
182 __isl_give isl_ast_expr
*(*fn_expr
)(__isl_take isl_ast_expr
*expr
,
183 __isl_keep isl_id
*id
, void *user
), void *user_expr
);
185 /* Print "stmt" to "p".
187 * The access expressions in "stmt" are replaced by the isl_ast_expr
188 * associated to its reference identifier in "ref2expr".
190 __isl_give isl_printer
*pet_stmt_print_body(struct pet_stmt
*stmt
,
191 __isl_take isl_printer
*p
, __isl_keep isl_id_to_ast_expr
*ref2expr
);
193 /* This structure represents a defined type.
194 * "name" is the name of the type, while "definition" is a string
195 * representation of its definition.
202 /* context holds constraints on the parameter that ensure that
203 * this array has a valid (i.e., non-negative) size
205 * extent holds constraints on the indices
207 * value_bounds holds constraints on the elements of the array
208 * and may be NULL if no such constraints were specified by the user
210 * element_size is the size in bytes of each array element
212 * live_out is set if the array appears in a live-out pragma
214 * if uniquely_defined is set then the array is written by a single access
215 * such that any element that is ever read
216 * is known to be assigned exactly once before the read
218 * declared is set if the array was declared somewhere inside the scop.
219 * exposed is set if the declared array is visible outside the scop.
224 isl_set
*value_bounds
;
228 int uniquely_defined
;
233 /* This structure represents an implication on a boolean filter.
234 * In particular, if the filter value of an element in the domain
235 * of "extension" is equal to "satisfied", then the filter values
236 * of the corresponding images in "extension" are also equal
239 struct pet_implication
{
244 /* The start and end fields contain the offsets in the input file
245 * of the scop, where end points to the first character after the scop.
246 * If the scop was detected based on scop and endscop pragmas, then
247 * the lines containing these pragmas are included in this range.
248 * Internally, end may be zero to indicate that no offset information is
250 * The context describes the set of parameter values for which
251 * the scop can be executed.
252 * context_value describes assignments to the parameters (if any)
253 * outside of the scop.
255 * The n_type types define types that may be referenced from by the arrays.
257 * The n_implication implications describe implications on boolean filters.
264 isl_set
*context_value
;
267 struct pet_type
**types
;
270 struct pet_array
**arrays
;
273 struct pet_stmt
**stmts
;
276 struct pet_implication
**implications
;
279 /* Return a textual representation of the operator. */
280 const char *pet_op_str(enum pet_op_type op
);
281 int pet_op_is_inc_dec(enum pet_op_type op
);
283 /* Extract a pet_scop from a C source file.
284 * If function is not NULL, then the pet_scop is extracted from
285 * a function with that name.
287 struct pet_scop
*pet_scop_extract_from_C_source(isl_ctx
*ctx
,
288 const char *filename
, const char *function
);
290 /* Transform the C source file "input" by rewriting each scop
291 * When autodetecting scops, at most one scop per function is rewritten.
292 * The transformed C code is written to "output".
294 int pet_transform_C_source(isl_ctx
*ctx
, const char *input
, FILE *output
,
295 __isl_give isl_printer
*(*transform
)(__isl_take isl_printer
*p
,
296 struct pet_scop
*scop
, void *user
), void *user
);
297 /* Given a scop and a printer passed to a pet_transform_C_source callback,
298 * print the original corresponding code to the printer.
300 __isl_give isl_printer
*pet_scop_print_original(struct pet_scop
*scop
,
301 __isl_take isl_printer
*p
);
303 /* Update all isl_sets and isl_maps such that they all have the same
304 * parameters in the same order.
306 struct pet_scop
*pet_scop_align_params(struct pet_scop
*scop
);
308 /* Does "scop" contain any data dependent accesses? */
309 int pet_scop_has_data_dependent_accesses(struct pet_scop
*scop
);
310 /* Does "scop" contain any data dependent conditions? */
311 int pet_scop_has_data_dependent_conditions(struct pet_scop
*scop
);
313 void pet_scop_dump(struct pet_scop
*scop
);
314 struct pet_scop
*pet_scop_free(struct pet_scop
*scop
);
316 __isl_give isl_union_set
*pet_scop_collect_domains(struct pet_scop
*scop
);
317 /* Collect all potential read access relations. */
318 __isl_give isl_union_map
*pet_scop_collect_may_reads(struct pet_scop
*scop
);
319 /* Collect all tagged potential read access relations. */
320 __isl_give isl_union_map
*pet_scop_collect_tagged_may_reads(
321 struct pet_scop
*scop
);
322 /* Collect all potential write access relations. */
323 __isl_give isl_union_map
*pet_scop_collect_may_writes(struct pet_scop
*scop
);
324 /* Collect all definite write access relations. */
325 __isl_give isl_union_map
*pet_scop_collect_must_writes(struct pet_scop
*scop
);
326 /* Collect all tagged potential write access relations. */
327 __isl_give isl_union_map
*pet_scop_collect_tagged_may_writes(
328 struct pet_scop
*scop
);
329 /* Collect all tagged definite write access relations. */
330 __isl_give isl_union_map
*pet_scop_collect_tagged_must_writes(
331 struct pet_scop
*scop
);
332 /* Collect all definite kill access relations. */
333 __isl_give isl_union_map
*pet_scop_collect_must_kills(struct pet_scop
*scop
);
334 __isl_give isl_union_map
*pet_scop_collect_schedule(struct pet_scop
*scop
);
336 #if defined(__cplusplus)