2 * Copyright 2012-2014 Ecole Normale Superieure. All rights reserved.
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above
12 * copyright notice, this list of conditions and the following
13 * disclaimer in the documentation and/or other materials provided
14 * with the distribution.
16 * THIS SOFTWARE IS PROVIDED BY ECOLE NORMALE SUPERIEURE ''AS IS'' AND ANY
17 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
19 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL ECOLE NORMALE SUPERIEURE OR
20 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
21 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
22 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
23 * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
26 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 * The views and conclusions contained in the software and documentation
29 * are those of the authors and should not be interpreted as
30 * representing official policies, either expressed or implied, of
31 * Ecole Normale Superieure.
39 #include <isl/options.h>
41 #include <isl/union_map.h>
42 #include <isl/id_to_pw_aff.h>
46 struct isl_options
*isl
;
47 struct pet_options
*pet
;
52 ISL_ARGS_START(struct options
, options_args
)
53 ISL_ARG_CHILD(struct options
, isl
, "isl", &isl_options_args
, "isl options")
54 ISL_ARG_CHILD(struct options
, pet
, NULL
, &pet_options_args
, "pet options")
55 ISL_ARG_ARG(struct options
, schedule
, "schedule", NULL
)
56 ISL_ARG_ARG(struct options
, code
, "code", NULL
)
59 ISL_ARG_DEF(options
, struct options
, options_args
)
61 static __isl_give isl_pw_aff
*expr_extract_pw_aff(struct pet_expr
*expr
,
62 __isl_keep isl_space
*space
, __isl_keep isl_id_to_pw_aff
*assignments
);
64 /* Extract an affine expression from the call to floord in "expr",
65 * possibly exploiting "assignments".
67 * "space" is the iteration space of the statement containing the expression.
69 static __isl_give isl_pw_aff
*expr_extract_floord(struct pet_expr
*expr
,
70 __isl_keep isl_space
*space
, __isl_keep isl_id_to_pw_aff
*assignments
)
72 isl_pw_aff
*lhs
, *rhs
;
74 lhs
= expr_extract_pw_aff(expr
->args
[0], space
, assignments
);
75 rhs
= expr_extract_pw_aff(expr
->args
[1], space
, assignments
);
76 return isl_pw_aff_floor(isl_pw_aff_div(lhs
, rhs
));
79 /* Extract an affine expression from the call in "expr",
80 * possibly exploiting "assignments".
82 * "space" is the iteration space of the statement containing the expression.
84 * We only support calls to the "floord" function for now.
86 static __isl_give isl_pw_aff
*call_expr_extract_pw_aff(struct pet_expr
*expr
,
87 __isl_keep isl_space
*space
, __isl_keep isl_id_to_pw_aff
*assignments
)
89 assert(!strcmp(expr
->name
, "floord"));
91 return expr_extract_floord(expr
, space
, assignments
);
94 /* Is the variable accessed by "index" assigned in "assignments"?
96 * The assignments map variable identifiers to functions of the form
100 static int is_assigned(__isl_keep isl_multi_pw_aff
*index
,
101 __isl_keep isl_id_to_pw_aff
*assignments
)
106 var
= isl_multi_pw_aff_get_tuple_id(index
, isl_dim_out
);
107 assigned
= isl_id_to_pw_aff_has(assignments
, var
);
113 /* Apply the appropriate assignment in "assignments"
114 * to the index expression "index".
116 * "index" is of the form
118 * { access_domain -> variable }
120 * "assignments" maps variable identifiers to functions of the form
122 * { assignment_domain -> value }
124 * We assume the assignment precedes the access in the code.
125 * In particular, we assume that the loops around the assignment
126 * are the same as the first loops around the access.
130 * { access_domain -> assignment_domain }
132 * equating the iterators of assignment_domain to the corresponding iterators
133 * in access_domain and then plug that into the assigned value, obtaining
135 * { access_domain -> value }
137 static __isl_give isl_pw_aff
*apply_assignment(
138 __isl_take isl_multi_pw_aff
*index
,
139 __isl_keep isl_id_to_pw_aff
*assignments
)
145 isl_space
*space
, *dom_space
;
149 id
= isl_multi_pw_aff_get_tuple_id(index
, isl_dim_out
);
150 dom
= isl_multi_pw_aff_domain(index
);
151 val
= isl_id_to_pw_aff_get(assignments
, id
);
152 space
= isl_pw_aff_get_domain_space(val
);
153 dom_space
= isl_set_get_space(dom
);
154 space
= isl_space_map_from_domain_and_range(dom_space
, space
);
155 ma
= isl_multi_aff_zero(space
);
156 ls
= isl_local_space_from_space(isl_set_get_space(dom
));
157 n
= isl_multi_aff_dim(ma
, isl_dim_out
);
158 for (i
= 0; i
< n
; ++i
) {
161 aff
= isl_aff_var_on_domain(isl_local_space_copy(ls
),
163 ma
= isl_multi_aff_set_aff(ma
, i
, aff
);
165 isl_local_space_free(ls
);
167 val
= isl_pw_aff_pullback_multi_aff(val
, ma
);
168 val
= isl_pw_aff_intersect_domain(val
, dom
);
173 /* Extract an affine expression from the access to a named space in "index",
174 * possibly exploiting "assignments".
176 * If the variable has been assigned a value, we return the corresponding
177 * assignment. Otherwise, we assume we are accessing a 0D space and
178 * we turn that into an expression equal to a parameter of the same name.
180 static __isl_give isl_pw_aff
*resolve_access(__isl_take isl_multi_pw_aff
*index
,
181 __isl_keep isl_id_to_pw_aff
*assignments
)
189 if (is_assigned(index
, assignments
))
190 return apply_assignment(index
, assignments
);
192 id
= isl_multi_pw_aff_get_tuple_id(index
, isl_dim_out
);
193 dom
= isl_multi_pw_aff_domain(index
);
194 dom
= isl_set_insert_dims(dom
, isl_dim_param
, 0, 1);
195 dom
= isl_set_set_dim_id(dom
, isl_dim_param
, 0, id
);
196 ls
= isl_local_space_from_space(isl_set_get_space(dom
));
197 aff
= isl_aff_var_on_domain(ls
, isl_dim_param
, 0);
198 pa
= isl_pw_aff_alloc(dom
, aff
);
203 /* Extract an affine expression from the access expression "expr",
204 * possibly exploiting "assignments".
206 * If we are accessing a (1D) anonymous space, then we are actually
207 * computing an affine expression and we simply return that expression.
208 * Otherwise, we try and convert the access to an affine expression in
211 static __isl_give isl_pw_aff
*access_expr_extract_pw_aff(struct pet_expr
*expr
,
212 __isl_keep isl_id_to_pw_aff
*assignments
)
216 if (isl_multi_pw_aff_has_tuple_id(expr
->acc
.index
, isl_dim_out
)) {
217 isl_multi_pw_aff
*index
;
218 index
= isl_multi_pw_aff_copy(expr
->acc
.index
);
219 pa
= resolve_access(index
, assignments
);
221 pa
= isl_multi_pw_aff_get_pw_aff(expr
->acc
.index
, 0);
225 /* Extract an affine expression from "expr", possibly exploiting "assignments",
226 * in the form of an isl_pw_aff.
228 * "space" is the iteration space of the statement containing the expression.
230 * We only handle the kinds of expressions that we would expect
231 * as arguments to a function call in code generated by isl.
233 static __isl_give isl_pw_aff
*expr_extract_pw_aff(struct pet_expr
*expr
,
234 __isl_keep isl_space
*space
, __isl_keep isl_id_to_pw_aff
*assignments
)
236 isl_pw_aff
*pa
, *pa1
, *pa2
;
238 switch (expr
->type
) {
239 case pet_expr_access
:
240 return access_expr_extract_pw_aff(expr
, assignments
);
242 if (expr
->op
== pet_op_minus
) {
243 pa
= expr_extract_pw_aff(expr
->args
[0], space
,
245 return isl_pw_aff_neg(pa
);
248 case pet_expr_binary
:
249 pa1
= expr_extract_pw_aff(expr
->args
[0], space
, assignments
);
250 pa2
= expr_extract_pw_aff(expr
->args
[1], space
, assignments
);
253 pa
= isl_pw_aff_mul(pa1
, pa2
);
256 pa
= isl_pw_aff_add(pa1
, pa2
);
259 pa
= isl_pw_aff_sub(pa1
, pa2
);
262 pa
= isl_pw_aff_tdiv_q(pa1
, pa2
);
265 pa
= isl_pw_aff_tdiv_r(pa1
, pa2
);
272 return call_expr_extract_pw_aff(expr
, space
, assignments
);
273 case pet_expr_ternary
:
274 pa
= expr_extract_pw_aff(expr
->args
[0], space
, assignments
);
275 pa1
= expr_extract_pw_aff(expr
->args
[1], space
, assignments
);
276 pa2
= expr_extract_pw_aff(expr
->args
[2], space
, assignments
);
277 return isl_pw_aff_cond(pa
, pa1
, pa2
);
279 case pet_expr_double
:
284 /* Extract an affine expression from "expr", possibly exploiting "assignments",
285 * in the form of an isl_map.
287 * "space" is the iteration space of the statement containing the expression.
289 static __isl_give isl_map
*expr_extract_map(struct pet_expr
*expr
,
290 __isl_keep isl_space
*space
, __isl_keep isl_id_to_pw_aff
*assignments
)
294 pa
= expr_extract_pw_aff(expr
, space
, assignments
);
295 return isl_map_from_pw_aff(pa
);
298 /* Extract a call from "stmt", possibly exploiting "assignments".
300 * The returned map is of the form
302 * { domain -> function[arguments] }
304 static __isl_give isl_map
*stmt_extract_call(struct pet_stmt
*stmt
,
305 __isl_keep isl_id_to_pw_aff
*assignments
)
311 domain
= isl_set_copy(stmt
->domain
);
312 call
= isl_map_from_domain(domain
);
314 assert(stmt
->body
->type
== pet_expr_call
);
316 for (i
= 0; i
< stmt
->body
->n_arg
; ++i
) {
320 space
= pet_stmt_get_space(stmt
);
321 arg
= expr_extract_map(stmt
->body
->args
[i
], space
, assignments
);
322 isl_space_free(space
);
323 call
= isl_map_flat_range_product(call
, arg
);
326 call
= isl_map_set_tuple_name(call
, isl_dim_out
, stmt
->body
->name
);
331 /* Add the assignment in "stmt" to "assignments".
333 * We extract the accessed variable identifier "var"
334 * and the assigned value
336 * { domain -> value }
338 * and map "var" to this value in "assignments", replacing
339 * any possible previously assigned value to the same variable.
341 static __isl_give isl_id_to_pw_aff
*add_assignment(
342 __isl_take isl_id_to_pw_aff
*assignments
, struct pet_stmt
*stmt
)
348 assert(stmt
->body
->op
== pet_op_assign
);
349 assert(stmt
->body
->args
[0]->type
== pet_expr_access
);
350 var
= isl_map_get_tuple_id(stmt
->body
->args
[0]->acc
.access
,
352 space
= pet_stmt_get_space(stmt
);
353 val
= expr_extract_pw_aff(stmt
->body
->args
[1], space
, assignments
);
354 isl_space_free(space
);
356 assignments
= isl_id_to_pw_aff_set(assignments
, var
, val
);
361 /* Extract a mapping from the iterations domains of "scop" to
362 * the calls in the corresponding statements.
364 * While scanning "scop", we keep track of assignments to variables
365 * so that we can plug them in in the arguments of the calls.
366 * Note that we do not perform any dependence analysis on the assigned
367 * variables. In code generated by isl, such assignments should only
368 * appear immediately before they are used.
370 * The assignments are kept as an associative array between
371 * variable identifiers and assignments of the form
373 * { domain -> value }
375 * We skip kill statements.
376 * Other than assignments and kill statements, all statements are assumed
377 * to be function calls.
379 static __isl_give isl_union_map
*scop_collect_calls(struct pet_scop
*scop
)
384 isl_id_to_pw_aff
*assignments
;
390 call
= isl_union_map_empty(isl_set_get_space(scop
->context
));
391 ctx
= isl_set_get_ctx(scop
->context
);
392 assignments
= isl_id_to_pw_aff_alloc(ctx
, 0);
394 for (i
= 0; i
< scop
->n_stmt
; ++i
) {
395 struct pet_stmt
*stmt
;
397 stmt
= scop
->stmts
[i
];
398 if (pet_stmt_is_assign(stmt
)) {
399 assignments
= add_assignment(assignments
, stmt
);
402 if (pet_stmt_is_kill(stmt
))
404 call_i
= stmt_extract_call(scop
->stmts
[i
], assignments
);
405 call
= isl_union_map_add_map(call
, call_i
);
408 isl_id_to_pw_aff_free(assignments
);
413 /* Extract a schedule on the original domains from "scop".
414 * The original domain elements appear as calls in "scop".
416 * We first extract a schedule on the code iteration domains
417 * and a mapping from the code iteration domains to the calls
418 * (i.e., the original domain) and then combine the two.
420 static __isl_give isl_union_map
*extract_code_schedule(struct pet_scop
*scop
)
422 isl_union_map
*schedule
;
423 isl_union_map
*calls
;
425 schedule
= pet_scop_collect_schedule(scop
);
427 calls
= scop_collect_calls(scop
);
429 schedule
= isl_union_map_apply_domain(schedule
, calls
);
434 /* Check that schedule and code_schedule have the same domain,
435 * i.e., that they execute the same statement instances.
437 static int check_domain(__isl_keep isl_union_map
*schedule
,
438 __isl_keep isl_union_map
*code_schedule
)
440 isl_union_set
*dom1
, *dom2
;
446 dom1
= isl_union_map_domain(isl_union_map_copy(schedule
));
447 dom2
= isl_union_map_domain(isl_union_map_copy(code_schedule
));
448 equal
= isl_union_set_is_equal(dom1
, dom2
);
453 isl_union_set_dump(dom1
);
454 isl_union_set_dump(dom2
);
455 isl_die(isl_union_map_get_ctx(schedule
), isl_error_unknown
,
456 "domains not identical", r
= -1);
459 isl_union_set_free(dom1
);
460 isl_union_set_free(dom2
);
465 /* Check that the relative order specified by the input schedule is respected
466 * by the schedule extracted from the code, in case the original schedule
469 * In particular, check that there is no pair of statement instances
470 * such that the first should be scheduled _before_ the second,
471 * but is actually scheduled _after_ the second in the code.
473 static int check_order_sv(__isl_keep isl_union_map
*schedule
,
474 __isl_keep isl_union_map
*code_schedule
)
480 t1
= isl_union_map_lex_lt_union_map(isl_union_map_copy(schedule
),
481 isl_union_map_copy(schedule
));
482 t2
= isl_union_map_lex_gt_union_map(isl_union_map_copy(code_schedule
),
483 isl_union_map_copy(code_schedule
));
484 t1
= isl_union_map_intersect(t1
, t2
);
485 empty
= isl_union_map_is_empty(t1
);
486 isl_union_map_free(t1
);
491 isl_die(isl_union_map_get_ctx(schedule
), isl_error_unknown
,
492 "order not respected", return -1);
497 /* Check that the relative order specified by the input schedule is respected
498 * by the schedule extracted from the code, in case the original schedule
499 * is not single valued.
501 * In particular, check that the order imposed by the schedules on pairs
502 * of statement instances is the same.
504 static int check_order_not_sv(__isl_keep isl_union_map
*schedule
,
505 __isl_keep isl_union_map
*code_schedule
)
511 t1
= isl_union_map_lex_lt_union_map(isl_union_map_copy(schedule
),
512 isl_union_map_copy(schedule
));
513 t2
= isl_union_map_lex_lt_union_map(isl_union_map_copy(code_schedule
),
514 isl_union_map_copy(code_schedule
));
515 equal
= isl_union_map_is_equal(t1
, t2
);
516 isl_union_map_free(t1
);
517 isl_union_map_free(t2
);
522 isl_die(isl_union_map_get_ctx(schedule
), isl_error_unknown
,
523 "order not respected", return -1);
528 /* Check that the relative order specified by the input schedule is respected
529 * by the schedule extracted from the code.
531 * "sv" indicated whether the original schedule is single valued.
532 * If so, we use a cheaper test. Otherwise, we fall back on a more
535 static int check_order(__isl_keep isl_union_map
*schedule
,
536 __isl_keep isl_union_map
*code_schedule
, int sv
)
539 return check_order_sv(schedule
, code_schedule
);
541 return check_order_not_sv(schedule
, code_schedule
);
544 /* If the original schedule was single valued ("sv" is set),
545 * then the schedule extracted from the code should be single valued as well.
547 static int check_single_valued(__isl_keep isl_union_map
*code_schedule
, int sv
)
552 sv
= isl_union_map_is_single_valued(code_schedule
);
557 isl_die(isl_union_map_get_ctx(code_schedule
), isl_error_unknown
,
558 "schedule not single valued", return -1);
563 /* Read a schedule and a context from the first argument and
564 * C code from the second argument and check that the C code
565 * corresponds to the schedule on the context.
567 * In particular, check that
568 * - the domains are identical, i.e., the calls in the C code
569 * correspond to the domain elements of the schedule
570 * - no function is called twice with the same arguments, provided
571 * the schedule is single-valued
572 * - the calls are performed in an order that is compatible
575 * If the schedule is not single-valued then we would have to check
576 * that each function with a given set of arguments is called
577 * the same number of times as there are images in the schedule,
578 * but this is considerably more difficult.
580 int main(int argc
, char **argv
)
584 isl_union_map
*schedule
, *code_schedule
;
585 struct pet_scop
*scop
;
586 struct options
*options
;
591 options
= options_new_with_defaults();
593 ctx
= isl_ctx_alloc_with_options(&options_args
, options
);
594 pet_options_set_signed_overflow(ctx
, PET_OVERFLOW_IGNORE
);
595 argc
= options_parse(options
, argc
, argv
, ISL_ARG_ALL
);
597 file
= fopen(options
->schedule
, "r");
599 schedule
= isl_union_map_read_from_file(ctx
, file
);
600 context
= isl_set_read_from_file(ctx
, file
);
603 scop
= pet_scop_extract_from_C_source(ctx
, options
->code
, NULL
);
605 schedule
= isl_union_map_intersect_params(schedule
,
606 isl_set_copy(context
));
607 code_schedule
= extract_code_schedule(scop
);
608 code_schedule
= isl_union_map_intersect_params(code_schedule
, context
);
610 sv
= isl_union_map_is_single_valued(schedule
);
612 check_domain(schedule
, code_schedule
) ||
613 check_single_valued(code_schedule
, sv
) ||
614 check_order(schedule
, code_schedule
, sv
);
617 isl_union_map_free(schedule
);
618 isl_union_map_free(code_schedule
);