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>
12 #include <isl/id_to_pw_aff.h>
14 #if defined(__cplusplus)
19 ISL_ARG_DECL(pet_options
, struct pet_options
, pet_options_args
)
21 /* If autodetect is set, any valid scop is extracted.
22 * Otherwise, the scop needs to be delimited by pragmas.
24 int pet_options_set_autodetect(isl_ctx
*ctx
, int val
);
25 int pet_options_get_autodetect(isl_ctx
*ctx
);
27 int pet_options_set_detect_conditional_assignment(isl_ctx
*ctx
, int val
);
28 int pet_options_get_detect_conditional_assignment(isl_ctx
*ctx
);
30 /* If encapsulate-dynamic-control is set, then any dynamic control
31 * in the input program will be encapsulated in macro statements.
32 * This means in particular that no statements with arguments
35 int pet_options_set_encapsulate_dynamic_control(isl_ctx
*ctx
, int val
);
36 int pet_options_get_encapsulate_dynamic_control(isl_ctx
*ctx
);
38 #define PET_OVERFLOW_AVOID 0
39 #define PET_OVERFLOW_IGNORE 1
40 int pet_options_set_signed_overflow(isl_ctx
*ctx
, int val
);
41 int pet_options_get_signed_overflow(isl_ctx
*ctx
);
44 typedef struct pet_loc pet_loc
;
46 /* Return an additional reference to "loc". */
47 __isl_give pet_loc
*pet_loc_copy(__isl_keep pet_loc
*loc
);
48 /* Free a reference to "loc". */
49 pet_loc
*pet_loc_free(__isl_take pet_loc
*loc
);
51 /* Return the offset in the input file of the start of "loc". */
52 unsigned pet_loc_get_start(__isl_keep pet_loc
*loc
);
53 /* Return the offset in the input file of the character after "loc". */
54 unsigned pet_loc_get_end(__isl_keep pet_loc
*loc
);
55 /* Return the line number of a line within the "loc" region. */
56 int pet_loc_get_line(__isl_keep pet_loc
*loc
);
57 /* Return the indentation of the "loc" region. */
58 __isl_keep
const char *pet_loc_get_indent(__isl_keep pet_loc
*loc
);
71 /* only compound assignments operators before assignment */
109 /* Index into the pet_expr->args array when pet_expr->type == pet_expr_unary
111 enum pet_un_arg_type
{
115 /* Indices into the pet_expr->args array when
116 * pet_expr->type == pet_expr_binary
118 enum pet_bin_arg_type
{
123 /* Indices into the pet_expr->args array when
124 * pet_expr->type == pet_expr_ternary
126 enum pet_ter_arg_type
{
133 typedef struct pet_expr pet_expr
;
135 /* Return an additional reference to "expr". */
136 __isl_give pet_expr
*pet_expr_copy(__isl_keep pet_expr
*expr
);
137 /* Free a reference to "expr". */
138 __isl_null pet_expr
*pet_expr_free(__isl_take pet_expr
*expr
);
140 /* Return the isl_ctx in which "expr" was created. */
141 isl_ctx
*pet_expr_get_ctx(__isl_keep pet_expr
*expr
);
143 /* Return the type of "expr". */
144 enum pet_expr_type
pet_expr_get_type(__isl_keep pet_expr
*expr
);
145 /* Return the number of arguments of "expr". */
146 int pet_expr_get_n_arg(__isl_keep pet_expr
*expr
);
147 /* Set the number of arguments of "expr" to "n". */
148 __isl_give pet_expr
*pet_expr_set_n_arg(__isl_take pet_expr
*expr
, int n
);
149 /* Return the argument of "expr" at position "pos". */
150 __isl_give pet_expr
*pet_expr_get_arg(__isl_keep pet_expr
*expr
, int pos
);
151 /* Replace the argument of "expr" at position "pos" by "arg". */
152 __isl_give pet_expr
*pet_expr_set_arg(__isl_take pet_expr
*expr
, int pos
,
153 __isl_take pet_expr
*arg
);
155 /* Return the operation type of operation expression "expr". */
156 enum pet_op_type
pet_expr_op_get_type(__isl_keep pet_expr
*expr
);
157 /* Replace the operation type of operation expression "expr" by "type". */
158 __isl_give pet_expr
*pet_expr_op_set_type(__isl_take pet_expr
*expr
,
159 enum pet_op_type type
);
161 /* Construct a (read) access pet_expr from an index expression. */
162 __isl_give pet_expr
*pet_expr_from_index(__isl_take isl_multi_pw_aff
*index
);
164 /* Does "expr" represent an affine expression? */
165 int pet_expr_is_affine(__isl_keep pet_expr
*expr
);
166 /* Does the access expression "expr" read the accessed elements? */
167 int pet_expr_access_is_read(__isl_keep pet_expr
*expr
);
168 /* Does the access expression "expr" write to the accessed elements? */
169 int pet_expr_access_is_write(__isl_keep pet_expr
*expr
);
170 /* Mark "expr" as a read dependening on "read". */
171 __isl_give pet_expr
*pet_expr_access_set_read(__isl_take pet_expr
*expr
,
173 /* Mark "expr" as a write dependening on "write". */
174 __isl_give pet_expr
*pet_expr_access_set_write(__isl_take pet_expr
*expr
,
176 /* Mark "expr" as a kill dependening on "kill". */
177 __isl_give pet_expr
*pet_expr_access_set_kill(__isl_take pet_expr
*expr
,
179 /* Return the reference identifier of access expression "expr". */
180 __isl_give isl_id
*pet_expr_access_get_ref_id(__isl_keep pet_expr
*expr
);
181 /* Replace the reference identifier of access expression "expr" by "ref_id". */
182 __isl_give pet_expr
*pet_expr_access_set_ref_id(__isl_take pet_expr
*expr
,
183 __isl_take isl_id
*ref_id
);
184 /* Return the identifier of the outer array accessed by "expr". */
185 __isl_give isl_id
*pet_expr_access_get_id(__isl_keep pet_expr
*expr
);
186 /* Return the index expression of access expression "expr". */
187 __isl_give isl_multi_pw_aff
*pet_expr_access_get_index(
188 __isl_keep pet_expr
*expr
);
190 /* Return the potential read access relation of access expression "expr". */
191 __isl_give isl_union_map
*pet_expr_access_get_may_read(
192 __isl_keep pet_expr
*expr
);
193 /* Return the potential write access relation of access expression "expr". */
194 __isl_give isl_union_map
*pet_expr_access_get_may_write(
195 __isl_keep pet_expr
*expr
);
196 /* Return the definite write access relation of access expression "expr". */
197 __isl_give isl_union_map
*pet_expr_access_get_must_write(
198 __isl_keep pet_expr
*expr
);
199 /* Return the argument dependent potential read access relation of "expr". */
200 __isl_give isl_union_map
*pet_expr_access_get_dependent_may_read(
201 __isl_keep pet_expr
*expr
);
202 /* Return the argument dependent potential write access relation of "expr". */
203 __isl_give isl_union_map
*pet_expr_access_get_dependent_may_write(
204 __isl_keep pet_expr
*expr
);
205 /* Return the argument dependent definite write access relation of "expr". */
206 __isl_give isl_union_map
*pet_expr_access_get_dependent_must_write(
207 __isl_keep pet_expr
*expr
);
208 /* Return the tagged potential read access relation of access "expr". */
209 __isl_give isl_union_map
*pet_expr_access_get_tagged_may_read(
210 __isl_keep pet_expr
*expr
);
211 /* Return the tagged potential write access relation of access "expr". */
212 __isl_give isl_union_map
*pet_expr_access_get_tagged_may_write(
213 __isl_keep pet_expr
*expr
);
215 /* Return the name of the function called by "expr". */
216 __isl_keep
const char *pet_expr_call_get_name(__isl_keep pet_expr
*expr
);
217 /* Replace the name of the function called by "expr" by "name". */
218 __isl_give pet_expr
*pet_expr_call_set_name(__isl_take pet_expr
*expr
,
219 __isl_keep
const char *name
);
221 /* Replace the type of the cast performed by "expr" by "name". */
222 __isl_give pet_expr
*pet_expr_cast_set_type_name(__isl_take pet_expr
*expr
,
223 __isl_keep
const char *name
);
225 /* Return the value of the integer represented by "expr". */
226 __isl_give isl_val
*pet_expr_int_get_val(__isl_keep pet_expr
*expr
);
227 /* Replace the value of the integer represented by "expr" by "v". */
228 __isl_give pet_expr
*pet_expr_int_set_val(__isl_take pet_expr
*expr
,
229 __isl_take isl_val
*v
);
231 /* Return a string representation of the double expression "expr". */
232 __isl_give
char *pet_expr_double_get_str(__isl_keep pet_expr
*expr
);
233 /* Replace value and string representation of the double expression "expr" */
234 __isl_give pet_expr
*pet_expr_double_set(__isl_take pet_expr
*expr
,
235 double d
, __isl_keep
const char *s
);
237 /* Call "fn" on each of the subexpressions of "expr" of type pet_expr_access. */
238 int pet_expr_foreach_access_expr(__isl_keep pet_expr
*expr
,
239 int (*fn
)(__isl_keep pet_expr
*expr
, void *user
), void *user
);
240 /* Call "fn" on each of the subexpressions of "expr" of type pet_expr_call. */
241 int pet_expr_foreach_call_expr(__isl_keep pet_expr
*expr
,
242 int (*fn
)(__isl_keep pet_expr
*expr
, void *user
), void *user
);
245 typedef struct pet_context pet_context
;
247 /* Create a context with the given domain. */
248 __isl_give pet_context
*pet_context_alloc(__isl_take isl_set
*domain
);
249 /* Return an additional reference to "pc". */
250 __isl_give pet_context
*pet_context_copy(__isl_keep pet_context
*pc
);
251 /* Free a reference to "pc". */
252 __isl_null pet_context
*pet_context_free(__isl_take pet_context
*pc
);
254 /* Return the isl_ctx in which "pc" was created. */
255 isl_ctx
*pet_context_get_ctx(__isl_keep pet_context
*pc
);
257 /* Extract an affine expression defined over the domain of "pc" from "expr"
260 __isl_give isl_pw_aff
*pet_expr_extract_affine(__isl_keep pet_expr
*expr
,
261 __isl_keep pet_context
*pc
);
263 void pet_expr_dump(__isl_keep pet_expr
*expr
);
271 pet_tree_decl
, /* A declaration without initialization */
272 pet_tree_decl_init
, /* A declaration with initialization */
273 pet_tree_if
, /* An if without an else branch */
274 pet_tree_if_else
, /* An if with an else branch */
276 pet_tree_infinite_loop
,
281 typedef struct pet_tree pet_tree
;
283 /* Return the isl_ctx in which "tree" was created. */
284 isl_ctx
*pet_tree_get_ctx(__isl_keep pet_tree
*tree
);
286 /* Return an additional reference to "tree". */
287 __isl_give pet_tree
*pet_tree_copy(__isl_keep pet_tree
*tree
);
288 /* Free a reference to "tree". */
289 __isl_null pet_tree
*pet_tree_free(__isl_take pet_tree
*tree
);
291 /* Return the location of "tree". */
292 __isl_give pet_loc
*pet_tree_get_loc(__isl_keep pet_tree
*tree
);
294 /* Return the type of "tree". */
295 enum pet_tree_type
pet_tree_get_type(__isl_keep pet_tree
*tree
);
297 /* Return the expression of the expression tree "tree". */
298 __isl_give pet_expr
*pet_tree_expr_get_expr(__isl_keep pet_tree
*tree
);
300 /* Return the number of children of the block tree "tree". */
301 int pet_tree_block_n_child(__isl_keep pet_tree
*tree
);
302 /* Return child "pos" of the block tree "tree". */
303 __isl_give pet_tree
*pet_tree_block_get_child(__isl_keep pet_tree
*tree
,
306 /* Is "tree" a declaration (with or without initialization)? */
307 int pet_tree_is_decl(__isl_keep pet_tree
*tree
);
308 /* Return the variable declared by the declaration tree "tree". */
309 __isl_give pet_expr
*pet_tree_decl_get_var(__isl_keep pet_tree
*tree
);
310 /* Return the initial value of the pet_tree_decl_init tree "tree". */
311 __isl_give pet_expr
*pet_tree_decl_get_init(__isl_keep pet_tree
*tree
);
313 /* Return the condition of the if tree "tree". */
314 __isl_give pet_expr
*pet_tree_if_get_cond(__isl_keep pet_tree
*tree
);
315 /* Return the then branch of the if tree "tree". */
316 __isl_give pet_tree
*pet_tree_if_get_then(__isl_keep pet_tree
*tree
);
317 /* Return the else branch of the if tree with else branch "tree". */
318 __isl_give pet_tree
*pet_tree_if_get_else(__isl_keep pet_tree
*tree
);
320 /* Is "tree" a for loop, a while loop or an infinite loop? */
321 int pet_tree_is_loop(__isl_keep pet_tree
*tree
);
322 /* Return the induction variable of the for loop "tree" */
323 __isl_give pet_expr
*pet_tree_loop_get_var(__isl_keep pet_tree
*tree
);
324 /* Return the initial value of the induction variable of the for loop "tree" */
325 __isl_give pet_expr
*pet_tree_loop_get_init(__isl_keep pet_tree
*tree
);
326 /* Return the condition of the loop tree "tree" */
327 __isl_give pet_expr
*pet_tree_loop_get_cond(__isl_keep pet_tree
*tree
);
328 /* Return the induction variable of the for loop "tree" */
329 __isl_give pet_expr
*pet_tree_loop_get_inc(__isl_keep pet_tree
*tree
);
330 /* Return the body of the loop tree "tree" */
331 __isl_give pet_tree
*pet_tree_loop_get_body(__isl_keep pet_tree
*tree
);
333 /* Call "fn" on each top-level expression in the nodes of "tree" */
334 int pet_tree_foreach_expr(__isl_keep pet_tree
*tree
,
335 int (*fn
)(__isl_keep pet_expr
*expr
, void *user
), void *user
);
336 /* Call "fn" on each access subexpression in the nodes of "tree" */
337 int pet_tree_foreach_access_expr(__isl_keep pet_tree
*tree
,
338 int (*fn
)(__isl_keep pet_expr
*expr
, void *user
), void *user
);
340 void pet_tree_dump(__isl_keep pet_tree
*tree
);
342 /* "loc" represents the region of the source code that is represented
345 * If the statement has arguments, i.e., n_arg != 0, then
346 * "domain" is a wrapped map, mapping the iteration domain
347 * to the values of the arguments for which this statement
349 * Otherwise, it is simply the iteration domain.
351 * If one of the arguments is an access expression that accesses
352 * more than one element for a given iteration, then the constraints
353 * on the value of this argument (encoded in "domain") should be satisfied
354 * for all of those accessed elements.
366 /* Return the iteration space of "stmt". */
367 __isl_give isl_space
*pet_stmt_get_space(struct pet_stmt
*stmt
);
369 /* Is "stmt" an assignment statement? */
370 int pet_stmt_is_assign(struct pet_stmt
*stmt
);
371 /* Is "stmt" a kill statement? */
372 int pet_stmt_is_kill(struct pet_stmt
*stmt
);
374 /* pet_stmt_build_ast_exprs is currently limited to only handle
375 * some forms of data dependent accesses.
376 * If pet_stmt_can_build_ast_exprs returns 1, then pet_stmt_build_ast_exprs
377 * can safely be called on "stmt".
379 int pet_stmt_can_build_ast_exprs(struct pet_stmt
*stmt
);
380 /* Construct an associative array from reference identifiers of
381 * access expressions in "stmt" to the corresponding isl_ast_expr.
382 * Each index expression is first transformed through "fn_index"
383 * (if not NULL). Then an AST expression is generated using "build".
384 * Finally, the AST expression is transformed using "fn_expr"
387 __isl_give isl_id_to_ast_expr
*pet_stmt_build_ast_exprs(struct pet_stmt
*stmt
,
388 __isl_keep isl_ast_build
*build
,
389 __isl_give isl_multi_pw_aff
*(*fn_index
)(
390 __isl_take isl_multi_pw_aff
*mpa
, __isl_keep isl_id
*id
,
391 void *user
), void *user_index
,
392 __isl_give isl_ast_expr
*(*fn_expr
)(__isl_take isl_ast_expr
*expr
,
393 __isl_keep isl_id
*id
, void *user
), void *user_expr
);
395 /* Print "stmt" to "p".
397 * The access expressions in "stmt" are replaced by the isl_ast_expr
398 * associated to its reference identifier in "ref2expr".
400 __isl_give isl_printer
*pet_stmt_print_body(struct pet_stmt
*stmt
,
401 __isl_take isl_printer
*p
, __isl_keep isl_id_to_ast_expr
*ref2expr
);
403 /* This structure represents a defined type.
404 * "name" is the name of the type, while "definition" is a string
405 * representation of its definition.
412 /* context holds constraints on the parameter that ensure that
413 * this array has a valid (i.e., non-negative) size
415 * extent holds constraints on the indices
417 * value_bounds holds constraints on the elements of the array
418 * and may be NULL if no such constraints were specified by the user
420 * element_size is the size in bytes of each array element
421 * element_type is the type of the array elements.
422 * element_is_record is set if this type is a record type.
424 * live_out is set if the array appears in a live-out pragma
426 * if uniquely_defined is set then the array is written by a single access
427 * such that any element that is ever read
428 * is known to be assigned exactly once before the read
430 * declared is set if the array was declared somewhere inside the scop.
431 * exposed is set if the declared array is visible outside the scop.
436 isl_set
*value_bounds
;
438 int element_is_record
;
441 int uniquely_defined
;
446 /* This structure represents an implication on a boolean filter.
447 * In particular, if the filter value of an element in the domain
448 * of "extension" is equal to "satisfied", then the filter values
449 * of the corresponding images in "extension" are also equal
452 struct pet_implication
{
457 /* This structure represents an independence implied by a for loop
458 * that is marked as independent in the source code.
459 * "filter" contains pairs of statement instances that are guaranteed
460 * not to be dependent on each other based on the independent for loop,
461 * assuming that no dependences carried by this loop are implied
462 * by the variables in "local".
463 * "local" contains the variables that are local to the loop that was
464 * marked independent.
466 struct pet_independence
{
467 isl_union_map
*filter
;
468 isl_union_set
*local
;
471 /* "loc" represents the region of the source code that is represented
473 * If the scop was detected based on scop and endscop pragmas, then
474 * the lines containing these pragmas are included in this region.
475 * In the final result, the context describes the set of parameter values
476 * for which the scop can be executed.
477 * During the construction of the pet_scop, the context lives in a set space
478 * where each dimension refers to an outer loop.
479 * context_value describes assignments to the parameters (if any)
480 * outside of the scop.
482 * The n_type types define types that may be referenced from by the arrays.
484 * The n_implication implications describe implications on boolean filters.
486 * The n_independence independences describe independences implied
487 * by for loops that are marked independent in the source code.
493 isl_set
*context_value
;
496 struct pet_type
**types
;
499 struct pet_array
**arrays
;
502 struct pet_stmt
**stmts
;
505 struct pet_implication
**implications
;
508 struct pet_independence
**independences
;
511 /* Return a textual representation of the operator. */
512 const char *pet_op_str(enum pet_op_type op
);
513 int pet_op_is_inc_dec(enum pet_op_type op
);
515 /* Extract a pet_scop from a C source file.
516 * If function is not NULL, then the pet_scop is extracted from
517 * a function with that name.
519 struct pet_scop
*pet_scop_extract_from_C_source(isl_ctx
*ctx
,
520 const char *filename
, const char *function
);
522 /* Transform the C source file "input" by rewriting each scop
523 * When autodetecting scops, at most one scop per function is rewritten.
524 * The transformed C code is written to "output".
526 int pet_transform_C_source(isl_ctx
*ctx
, const char *input
, FILE *output
,
527 __isl_give isl_printer
*(*transform
)(__isl_take isl_printer
*p
,
528 struct pet_scop
*scop
, void *user
), void *user
);
529 /* Given a scop and a printer passed to a pet_transform_C_source callback,
530 * print the original corresponding code to the printer.
532 __isl_give isl_printer
*pet_scop_print_original(struct pet_scop
*scop
,
533 __isl_take isl_printer
*p
);
535 /* Update all isl_sets and isl_maps such that they all have the same
536 * parameters in the same order.
538 struct pet_scop
*pet_scop_align_params(struct pet_scop
*scop
);
540 /* Does "scop" contain any data dependent accesses? */
541 int pet_scop_has_data_dependent_accesses(struct pet_scop
*scop
);
542 /* Does "scop" contain any data dependent conditions? */
543 int pet_scop_has_data_dependent_conditions(struct pet_scop
*scop
);
544 /* pet_stmt_build_ast_exprs is currently limited to only handle
545 * some forms of data dependent accesses.
546 * If pet_scop_can_build_ast_exprs returns 1, then pet_stmt_build_ast_exprs
547 * can safely be called on all statements in the scop.
549 int pet_scop_can_build_ast_exprs(struct pet_scop
*scop
);
551 void pet_scop_dump(struct pet_scop
*scop
);
552 struct pet_scop
*pet_scop_free(struct pet_scop
*scop
);
554 __isl_give isl_union_set
*pet_scop_collect_domains(struct pet_scop
*scop
);
555 /* Collect all potential read access relations. */
556 __isl_give isl_union_map
*pet_scop_collect_may_reads(struct pet_scop
*scop
);
557 /* Collect all tagged potential read access relations. */
558 __isl_give isl_union_map
*pet_scop_collect_tagged_may_reads(
559 struct pet_scop
*scop
);
560 /* Collect all potential write access relations. */
561 __isl_give isl_union_map
*pet_scop_collect_may_writes(struct pet_scop
*scop
);
562 /* Collect all definite write access relations. */
563 __isl_give isl_union_map
*pet_scop_collect_must_writes(struct pet_scop
*scop
);
564 /* Collect all tagged potential write access relations. */
565 __isl_give isl_union_map
*pet_scop_collect_tagged_may_writes(
566 struct pet_scop
*scop
);
567 /* Collect all tagged definite write access relations. */
568 __isl_give isl_union_map
*pet_scop_collect_tagged_must_writes(
569 struct pet_scop
*scop
);
570 /* Collect all definite kill access relations. */
571 __isl_give isl_union_map
*pet_scop_collect_must_kills(struct pet_scop
*scop
);
572 /* Collect all tagged definite kill access relations. */
573 __isl_give isl_union_map
*pet_scop_collect_tagged_must_kills(
574 struct pet_scop
*scop
);
575 __isl_give isl_union_map
*pet_scop_collect_schedule(struct pet_scop
*scop
);
577 /* Compute a mapping from all outermost arrays (of structs) in scop
578 * to their innermost members.
580 __isl_give isl_union_map
*pet_scop_compute_outer_to_inner(
581 struct pet_scop
*scop
);
582 /* Compute a mapping from all outermost arrays (of structs) in scop
583 * to their members, including the outermost arrays themselves.
585 __isl_give isl_union_map
*pet_scop_compute_outer_to_any(struct pet_scop
*scop
);
587 #if defined(__cplusplus)