2 * Copyright 2012-2013 Ecole Normale Superieure
3 * Copyright 2014 INRIA Rocquencourt
5 * Use of this software is governed by the MIT license
7 * Written by Sven Verdoolaege,
8 * Ecole Normale Superieure, 45 rue d’Ulm, 75230 Paris, France
9 * and Inria Paris - Rocquencourt, Domaine de Voluceau - Rocquencourt,
10 * B.P. 105 - 78153 Le Chesnay, France
14 #include <isl/space.h>
17 #include <isl/constraint.h>
19 #include <isl/union_set.h>
20 #include <isl/union_map.h>
21 #include <isl_ast_build_private.h>
22 #include <isl_ast_private.h>
23 #include <isl_config.h>
25 /* Construct a map that isolates the current dimension.
27 * Essentially, the current dimension of "set" is moved to the single output
28 * dimension in the result, with the current dimension in the domain replaced
29 * by an unconstrained variable.
31 __isl_give isl_map
*isl_ast_build_map_to_iterator(
32 __isl_keep isl_ast_build
*build
, __isl_take isl_set
*set
)
36 map
= isl_map_from_domain(set
);
37 map
= isl_map_add_dims(map
, isl_dim_out
, 1);
40 return isl_map_free(map
);
42 map
= isl_map_equate(map
, isl_dim_in
, build
->depth
, isl_dim_out
, 0);
43 map
= isl_map_eliminate(map
, isl_dim_in
, build
->depth
, 1);
48 /* Initialize the information derived during the AST generation to default
49 * values for a schedule domain in "space".
51 * We also check that the remaining fields are not NULL so that
52 * the calling functions don't have to perform this test.
54 static __isl_give isl_ast_build
*isl_ast_build_init_derived(
55 __isl_take isl_ast_build
*build
, __isl_take isl_space
*space
)
60 build
= isl_ast_build_cow(build
);
61 if (!build
|| !build
->domain
)
64 ctx
= isl_ast_build_get_ctx(build
);
65 strides
= isl_vec_alloc(ctx
, isl_space_dim(space
, isl_dim_set
));
66 strides
= isl_vec_set_si(strides
, 1);
68 isl_vec_free(build
->strides
);
69 build
->strides
= strides
;
71 space
= isl_space_map_from_set(space
);
72 isl_multi_aff_free(build
->offsets
);
73 build
->offsets
= isl_multi_aff_zero(isl_space_copy(space
));
74 isl_multi_aff_free(build
->values
);
75 build
->values
= isl_multi_aff_identity(isl_space_copy(space
));
76 isl_multi_aff_free(build
->internal2input
);
77 build
->internal2input
= isl_multi_aff_identity(space
);
79 if (!build
->iterators
|| !build
->domain
|| !build
->generated
||
80 !build
->pending
|| !build
->values
|| !build
->internal2input
||
81 !build
->strides
|| !build
->offsets
|| !build
->options
)
82 return isl_ast_build_free(build
);
86 isl_space_free(space
);
87 return isl_ast_build_free(build
);
90 /* Return an isl_id called "c%d", with "%d" set to "i".
91 * If an isl_id with such a name already appears among the parameters
92 * in build->domain, then adjust the name to "c%d_%d".
94 static __isl_give isl_id
*generate_name(isl_ctx
*ctx
, int i
,
95 __isl_keep isl_ast_build
*build
)
99 isl_set
*dom
= build
->domain
;
101 snprintf(name
, sizeof(name
), "c%d", i
);
103 while (isl_set_find_dim_by_name(dom
, isl_dim_param
, name
) >= 0)
104 snprintf(name
, sizeof(name
), "c%d_%d", i
, j
++);
105 return isl_id_alloc(ctx
, name
, NULL
);
108 /* Create an isl_ast_build with "set" as domain.
110 * The input set is usually a parameter domain, but we currently allow it to
111 * be any kind of set. We set the domain of the returned isl_ast_build
112 * to "set" and initialize all the other fields to default values.
114 __isl_give isl_ast_build
*isl_ast_build_from_context(__isl_take isl_set
*set
)
119 isl_ast_build
*build
;
121 set
= isl_set_compute_divs(set
);
125 ctx
= isl_set_get_ctx(set
);
127 build
= isl_calloc_type(ctx
, isl_ast_build
);
133 build
->generated
= isl_set_copy(build
->domain
);
134 build
->pending
= isl_set_universe(isl_set_get_space(build
->domain
));
135 build
->options
= isl_union_map_empty(isl_space_params_alloc(ctx
, 0));
136 n
= isl_set_dim(set
, isl_dim_set
);
138 build
->iterators
= isl_id_list_alloc(ctx
, n
);
139 for (i
= 0; i
< n
; ++i
) {
141 if (isl_set_has_dim_id(set
, isl_dim_set
, i
))
142 id
= isl_set_get_dim_id(set
, isl_dim_set
, i
);
144 id
= generate_name(ctx
, i
, build
);
145 build
->iterators
= isl_id_list_add(build
->iterators
, id
);
147 space
= isl_set_get_space(set
);
148 if (isl_space_is_params(space
))
149 space
= isl_space_set_from_params(space
);
151 return isl_ast_build_init_derived(build
, space
);
157 /* Create an isl_ast_build with a universe (parametric) context.
159 __isl_give isl_ast_build
*isl_ast_build_alloc(isl_ctx
*ctx
)
164 space
= isl_space_params_alloc(ctx
, 0);
165 context
= isl_set_universe(space
);
167 return isl_ast_build_from_context(context
);
170 __isl_give isl_ast_build
*isl_ast_build_copy(__isl_keep isl_ast_build
*build
)
179 __isl_give isl_ast_build
*isl_ast_build_dup(__isl_keep isl_ast_build
*build
)
187 ctx
= isl_ast_build_get_ctx(build
);
188 dup
= isl_calloc_type(ctx
, isl_ast_build
);
193 dup
->outer_pos
= build
->outer_pos
;
194 dup
->depth
= build
->depth
;
195 dup
->iterators
= isl_id_list_copy(build
->iterators
);
196 dup
->domain
= isl_set_copy(build
->domain
);
197 dup
->generated
= isl_set_copy(build
->generated
);
198 dup
->pending
= isl_set_copy(build
->pending
);
199 dup
->values
= isl_multi_aff_copy(build
->values
);
200 dup
->internal2input
= isl_multi_aff_copy(build
->internal2input
);
201 dup
->value
= isl_pw_aff_copy(build
->value
);
202 dup
->strides
= isl_vec_copy(build
->strides
);
203 dup
->offsets
= isl_multi_aff_copy(build
->offsets
);
204 dup
->executed
= isl_union_map_copy(build
->executed
);
205 dup
->single_valued
= build
->single_valued
;
206 dup
->options
= isl_union_map_copy(build
->options
);
207 dup
->at_each_domain
= build
->at_each_domain
;
208 dup
->at_each_domain_user
= build
->at_each_domain_user
;
209 dup
->before_each_for
= build
->before_each_for
;
210 dup
->before_each_for_user
= build
->before_each_for_user
;
211 dup
->after_each_for
= build
->after_each_for
;
212 dup
->after_each_for_user
= build
->after_each_for_user
;
213 dup
->before_each_mark
= build
->before_each_mark
;
214 dup
->before_each_mark_user
= build
->before_each_mark_user
;
215 dup
->after_each_mark
= build
->after_each_mark
;
216 dup
->after_each_mark_user
= build
->after_each_mark_user
;
217 dup
->create_leaf
= build
->create_leaf
;
218 dup
->create_leaf_user
= build
->create_leaf_user
;
219 dup
->node
= isl_schedule_node_copy(build
->node
);
220 if (build
->loop_type
) {
224 dup
->loop_type
= isl_alloc_array(ctx
,
225 enum isl_ast_loop_type
, dup
->n
);
226 if (dup
->n
&& !dup
->loop_type
)
227 return isl_ast_build_free(dup
);
228 for (i
= 0; i
< dup
->n
; ++i
)
229 dup
->loop_type
[i
] = build
->loop_type
[i
];
232 if (!dup
->iterators
|| !dup
->domain
|| !dup
->generated
||
233 !dup
->pending
|| !dup
->values
||
234 !dup
->strides
|| !dup
->offsets
|| !dup
->options
||
235 (build
->internal2input
&& !dup
->internal2input
) ||
236 (build
->executed
&& !dup
->executed
) ||
237 (build
->value
&& !dup
->value
) ||
238 (build
->node
&& !dup
->node
))
239 return isl_ast_build_free(dup
);
244 /* Align the parameters of "build" to those of "model", introducing
245 * additional parameters if needed.
247 __isl_give isl_ast_build
*isl_ast_build_align_params(
248 __isl_take isl_ast_build
*build
, __isl_take isl_space
*model
)
250 build
= isl_ast_build_cow(build
);
254 build
->domain
= isl_set_align_params(build
->domain
,
255 isl_space_copy(model
));
256 build
->generated
= isl_set_align_params(build
->generated
,
257 isl_space_copy(model
));
258 build
->pending
= isl_set_align_params(build
->pending
,
259 isl_space_copy(model
));
260 build
->values
= isl_multi_aff_align_params(build
->values
,
261 isl_space_copy(model
));
262 build
->offsets
= isl_multi_aff_align_params(build
->offsets
,
263 isl_space_copy(model
));
264 build
->options
= isl_union_map_align_params(build
->options
,
265 isl_space_copy(model
));
266 if (build
->internal2input
) {
267 build
->internal2input
=
268 isl_multi_aff_align_params(build
->internal2input
,
270 if (!build
->internal2input
)
271 return isl_ast_build_free(build
);
273 isl_space_free(model
);
276 if (!build
->domain
|| !build
->values
|| !build
->offsets
||
278 return isl_ast_build_free(build
);
282 isl_space_free(model
);
286 __isl_give isl_ast_build
*isl_ast_build_cow(__isl_take isl_ast_build
*build
)
294 return isl_ast_build_dup(build
);
297 __isl_null isl_ast_build
*isl_ast_build_free(
298 __isl_take isl_ast_build
*build
)
303 if (--build
->ref
> 0)
306 isl_id_list_free(build
->iterators
);
307 isl_set_free(build
->domain
);
308 isl_set_free(build
->generated
);
309 isl_set_free(build
->pending
);
310 isl_multi_aff_free(build
->values
);
311 isl_multi_aff_free(build
->internal2input
);
312 isl_pw_aff_free(build
->value
);
313 isl_vec_free(build
->strides
);
314 isl_multi_aff_free(build
->offsets
);
315 isl_multi_aff_free(build
->schedule_map
);
316 isl_union_map_free(build
->executed
);
317 isl_union_map_free(build
->options
);
318 isl_schedule_node_free(build
->node
);
319 free(build
->loop_type
);
320 isl_set_free(build
->isolated
);
327 isl_ctx
*isl_ast_build_get_ctx(__isl_keep isl_ast_build
*build
)
329 return build
? isl_set_get_ctx(build
->domain
) : NULL
;
332 /* Replace build->options by "options".
334 __isl_give isl_ast_build
*isl_ast_build_set_options(
335 __isl_take isl_ast_build
*build
, __isl_take isl_union_map
*options
)
337 build
= isl_ast_build_cow(build
);
339 if (!build
|| !options
)
342 isl_union_map_free(build
->options
);
343 build
->options
= options
;
347 isl_union_map_free(options
);
348 return isl_ast_build_free(build
);
351 /* Set the iterators for the next code generation.
353 * If we still have some iterators left from the previous code generation
354 * (if any) or if iterators have already been set by a previous
355 * call to this function, then we remove them first.
357 __isl_give isl_ast_build
*isl_ast_build_set_iterators(
358 __isl_take isl_ast_build
*build
, __isl_take isl_id_list
*iterators
)
362 build
= isl_ast_build_cow(build
);
366 dim
= isl_set_dim(build
->domain
, isl_dim_set
);
367 n_it
= isl_id_list_n_id(build
->iterators
);
369 isl_die(isl_ast_build_get_ctx(build
), isl_error_internal
,
370 "isl_ast_build in inconsistent state", goto error
);
372 build
->iterators
= isl_id_list_drop(build
->iterators
,
374 build
->iterators
= isl_id_list_concat(build
->iterators
, iterators
);
375 if (!build
->iterators
)
376 return isl_ast_build_free(build
);
380 isl_id_list_free(iterators
);
381 return isl_ast_build_free(build
);
384 /* Set the "at_each_domain" callback of "build" to "fn".
386 __isl_give isl_ast_build
*isl_ast_build_set_at_each_domain(
387 __isl_take isl_ast_build
*build
,
388 __isl_give isl_ast_node
*(*fn
)(__isl_take isl_ast_node
*node
,
389 __isl_keep isl_ast_build
*build
, void *user
), void *user
)
391 build
= isl_ast_build_cow(build
);
396 build
->at_each_domain
= fn
;
397 build
->at_each_domain_user
= user
;
402 /* Set the "before_each_for" callback of "build" to "fn".
404 __isl_give isl_ast_build
*isl_ast_build_set_before_each_for(
405 __isl_take isl_ast_build
*build
,
406 __isl_give isl_id
*(*fn
)(__isl_keep isl_ast_build
*build
,
407 void *user
), void *user
)
409 build
= isl_ast_build_cow(build
);
414 build
->before_each_for
= fn
;
415 build
->before_each_for_user
= user
;
420 /* Set the "after_each_for" callback of "build" to "fn".
422 __isl_give isl_ast_build
*isl_ast_build_set_after_each_for(
423 __isl_take isl_ast_build
*build
,
424 __isl_give isl_ast_node
*(*fn
)(__isl_take isl_ast_node
*node
,
425 __isl_keep isl_ast_build
*build
, void *user
), void *user
)
427 build
= isl_ast_build_cow(build
);
432 build
->after_each_for
= fn
;
433 build
->after_each_for_user
= user
;
438 /* Set the "before_each_mark" callback of "build" to "fn".
440 __isl_give isl_ast_build
*isl_ast_build_set_before_each_mark(
441 __isl_take isl_ast_build
*build
,
442 isl_stat (*fn
)(__isl_keep isl_id
*mark
, __isl_keep isl_ast_build
*build
,
443 void *user
), void *user
)
445 build
= isl_ast_build_cow(build
);
450 build
->before_each_mark
= fn
;
451 build
->before_each_mark_user
= user
;
456 /* Set the "after_each_mark" callback of "build" to "fn".
458 __isl_give isl_ast_build
*isl_ast_build_set_after_each_mark(
459 __isl_take isl_ast_build
*build
,
460 __isl_give isl_ast_node
*(*fn
)(__isl_take isl_ast_node
*node
,
461 __isl_keep isl_ast_build
*build
, void *user
), void *user
)
463 build
= isl_ast_build_cow(build
);
468 build
->after_each_mark
= fn
;
469 build
->after_each_mark_user
= user
;
474 /* Set the "create_leaf" callback of "build" to "fn".
476 __isl_give isl_ast_build
*isl_ast_build_set_create_leaf(
477 __isl_take isl_ast_build
*build
,
478 __isl_give isl_ast_node
*(*fn
)(__isl_take isl_ast_build
*build
,
479 void *user
), void *user
)
481 build
= isl_ast_build_cow(build
);
486 build
->create_leaf
= fn
;
487 build
->create_leaf_user
= user
;
492 /* Clear all information that is specific to this code generation
493 * and that is (probably) not meaningful to any nested code generation.
495 __isl_give isl_ast_build
*isl_ast_build_clear_local_info(
496 __isl_take isl_ast_build
*build
)
500 build
= isl_ast_build_cow(build
);
504 space
= isl_union_map_get_space(build
->options
);
505 isl_union_map_free(build
->options
);
506 build
->options
= isl_union_map_empty(space
);
508 build
->at_each_domain
= NULL
;
509 build
->at_each_domain_user
= NULL
;
510 build
->before_each_for
= NULL
;
511 build
->before_each_for_user
= NULL
;
512 build
->after_each_for
= NULL
;
513 build
->after_each_for_user
= NULL
;
514 build
->before_each_mark
= NULL
;
515 build
->before_each_mark_user
= NULL
;
516 build
->after_each_mark
= NULL
;
517 build
->after_each_mark_user
= NULL
;
518 build
->create_leaf
= NULL
;
519 build
->create_leaf_user
= NULL
;
522 return isl_ast_build_free(build
);
527 /* Have any loops been eliminated?
528 * That is, do any of the original schedule dimensions have a fixed
529 * value that has been substituted?
531 static int any_eliminated(isl_ast_build
*build
)
535 for (i
= 0; i
< build
->depth
; ++i
)
536 if (isl_ast_build_has_affine_value(build
, i
))
542 /* Clear build->schedule_map.
543 * This function should be called whenever anything that might affect
544 * the result of isl_ast_build_get_schedule_map_multi_aff changes.
545 * In particular, it should be called when the depth is changed or
546 * when an iterator is determined to have a fixed value.
548 static void isl_ast_build_reset_schedule_map(__isl_keep isl_ast_build
*build
)
552 isl_multi_aff_free(build
->schedule_map
);
553 build
->schedule_map
= NULL
;
556 /* Do we need a (non-trivial) schedule map?
557 * That is, is the internal schedule space different from
558 * the external schedule space?
560 * The internal and external schedule spaces are only the same
561 * if code has been generated for the entire schedule and if none
562 * of the loops have been eliminated.
564 __isl_give
int isl_ast_build_need_schedule_map(__isl_keep isl_ast_build
*build
)
571 dim
= isl_set_dim(build
->domain
, isl_dim_set
);
572 return build
->depth
!= dim
|| any_eliminated(build
);
575 /* Return a mapping from the internal schedule space to the external
576 * schedule space in the form of an isl_multi_aff.
577 * The internal schedule space originally corresponds to that of the
578 * input schedule. This may change during the code generation if
579 * if isl_ast_build_insert_dim is ever called.
580 * The external schedule space corresponds to the
581 * loops that have been generated.
583 * Currently, the only difference between the internal schedule domain
584 * and the external schedule domain is that some dimensions are projected
585 * out in the external schedule domain. In particular, the dimensions
586 * for which no code has been generated yet and the dimensions that correspond
587 * to eliminated loops.
589 * We cache a copy of the schedule_map in build->schedule_map.
590 * The cache is cleared through isl_ast_build_reset_schedule_map
591 * whenever anything changes that might affect the result of this function.
593 __isl_give isl_multi_aff
*isl_ast_build_get_schedule_map_multi_aff(
594 __isl_keep isl_ast_build
*build
)
601 if (build
->schedule_map
)
602 return isl_multi_aff_copy(build
->schedule_map
);
604 space
= isl_ast_build_get_space(build
, 1);
605 space
= isl_space_map_from_set(space
);
606 ma
= isl_multi_aff_identity(space
);
607 if (isl_ast_build_need_schedule_map(build
)) {
609 int dim
= isl_set_dim(build
->domain
, isl_dim_set
);
610 ma
= isl_multi_aff_drop_dims(ma
, isl_dim_out
,
611 build
->depth
, dim
- build
->depth
);
612 for (i
= build
->depth
- 1; i
>= 0; --i
)
613 if (isl_ast_build_has_affine_value(build
, i
))
614 ma
= isl_multi_aff_drop_dims(ma
,
618 build
->schedule_map
= ma
;
619 return isl_multi_aff_copy(build
->schedule_map
);
622 /* Return a mapping from the internal schedule space to the external
623 * schedule space in the form of an isl_map.
625 __isl_give isl_map
*isl_ast_build_get_schedule_map(
626 __isl_keep isl_ast_build
*build
)
630 ma
= isl_ast_build_get_schedule_map_multi_aff(build
);
631 return isl_map_from_multi_aff(ma
);
634 /* Return the position of the dimension in build->domain for which
635 * an AST node is currently being generated.
637 int isl_ast_build_get_depth(__isl_keep isl_ast_build
*build
)
639 return build
? build
->depth
: -1;
642 /* Prepare for generating code for the next level.
643 * In particular, increase the depth and reset any information
644 * that is local to the current depth.
646 __isl_give isl_ast_build
*isl_ast_build_increase_depth(
647 __isl_take isl_ast_build
*build
)
649 build
= isl_ast_build_cow(build
);
653 isl_ast_build_reset_schedule_map(build
);
654 build
->value
= isl_pw_aff_free(build
->value
);
658 void isl_ast_build_dump(__isl_keep isl_ast_build
*build
)
663 fprintf(stderr
, "domain: ");
664 isl_set_dump(build
->domain
);
665 fprintf(stderr
, "generated: ");
666 isl_set_dump(build
->generated
);
667 fprintf(stderr
, "pending: ");
668 isl_set_dump(build
->pending
);
669 fprintf(stderr
, "iterators: ");
670 isl_id_list_dump(build
->iterators
);
671 fprintf(stderr
, "values: ");
672 isl_multi_aff_dump(build
->values
);
674 fprintf(stderr
, "value: ");
675 isl_pw_aff_dump(build
->value
);
677 fprintf(stderr
, "strides: ");
678 isl_vec_dump(build
->strides
);
679 fprintf(stderr
, "offsets: ");
680 isl_multi_aff_dump(build
->offsets
);
681 fprintf(stderr
, "internal2input: ");
682 isl_multi_aff_dump(build
->internal2input
);
685 /* Initialize "build" for AST construction in schedule space "space"
686 * in the case that build->domain is a parameter set.
688 * build->iterators is assumed to have been updated already.
690 static __isl_give isl_ast_build
*isl_ast_build_init(
691 __isl_take isl_ast_build
*build
, __isl_take isl_space
*space
)
695 build
= isl_ast_build_cow(build
);
699 set
= isl_set_universe(isl_space_copy(space
));
700 build
->domain
= isl_set_intersect_params(isl_set_copy(set
),
702 build
->pending
= isl_set_intersect_params(isl_set_copy(set
),
704 build
->generated
= isl_set_intersect_params(set
, build
->generated
);
706 return isl_ast_build_init_derived(build
, space
);
708 isl_ast_build_free(build
);
709 isl_space_free(space
);
713 /* Assign "aff" to *user and return -1, effectively extracting
714 * the first (and presumably only) affine expression in the isl_pw_aff
715 * on which this function is used.
717 static isl_stat
extract_single_piece(__isl_take isl_set
*set
,
718 __isl_take isl_aff
*aff
, void *user
)
725 return isl_stat_error
;
728 /* Intersect "set" with the stride constraint of "build", if any.
730 static __isl_give isl_set
*intersect_stride_constraint(__isl_take isl_set
*set
,
731 __isl_keep isl_ast_build
*build
)
736 return isl_set_free(set
);
737 if (!isl_ast_build_has_stride(build
, build
->depth
))
740 stride
= isl_ast_build_get_stride_constraint(build
);
741 return isl_set_intersect(set
, stride
);
744 /* Check if the given bounds on the current dimension (together with
745 * the stride constraint, if any) imply that
746 * this current dimension attains only a single value (in terms of
747 * parameters and outer dimensions).
748 * If so, we record it in build->value.
749 * If, moreover, this value can be represented as a single affine expression,
750 * then we also update build->values, effectively marking the current
751 * dimension as "eliminated".
753 * When computing the gist of the fixed value that can be represented
754 * as a single affine expression, it is important to only take into
755 * account the domain constraints in the original AST build and
756 * not the domain of the affine expression itself.
757 * Otherwise, a [i/3] is changed into a i/3 because we know that i
758 * is a multiple of 3, but then we end up not expressing anywhere
759 * in the context that i is a multiple of 3.
761 static __isl_give isl_ast_build
*update_values(
762 __isl_take isl_ast_build
*build
, __isl_take isl_basic_set
*bounds
)
765 isl_pw_multi_aff
*pma
;
770 set
= isl_set_from_basic_set(bounds
);
771 set
= isl_set_intersect(set
, isl_set_copy(build
->domain
));
772 set
= intersect_stride_constraint(set
, build
);
773 it_map
= isl_ast_build_map_to_iterator(build
, set
);
775 sv
= isl_map_is_single_valued(it_map
);
777 build
= isl_ast_build_free(build
);
779 isl_map_free(it_map
);
783 pma
= isl_pw_multi_aff_from_map(it_map
);
784 build
->value
= isl_pw_multi_aff_get_pw_aff(pma
, 0);
785 build
->value
= isl_ast_build_compute_gist_pw_aff(build
, build
->value
);
786 build
->value
= isl_pw_aff_coalesce(build
->value
);
787 isl_pw_multi_aff_free(pma
);
790 return isl_ast_build_free(build
);
792 if (isl_pw_aff_n_piece(build
->value
) != 1)
795 isl_pw_aff_foreach_piece(build
->value
, &extract_single_piece
, &aff
);
797 build
->values
= isl_multi_aff_set_aff(build
->values
, build
->depth
, aff
);
799 return isl_ast_build_free(build
);
800 isl_ast_build_reset_schedule_map(build
);
804 /* Update the AST build based on the given loop bounds for
805 * the current dimension and the stride information available in the build.
807 * We first make sure that the bounds do not refer to any iterators
808 * that have already been eliminated.
809 * Then, we check if the bounds imply that the current iterator
811 * If they do and if this fixed value can be expressed as a single
812 * affine expression, we eliminate the iterators from the bounds.
813 * Note that we cannot simply plug in this single value using
814 * isl_basic_set_preimage_multi_aff as the single value may only
815 * be defined on a subset of the domain. Plugging in the value
816 * would restrict the build domain to this subset, while this
817 * restriction may not be reflected in the generated code.
818 * Finally, we intersect build->domain with the updated bounds.
819 * We also add the stride constraint unless we have been able
820 * to find a fixed value expressed as a single affine expression.
822 * Note that the check for a fixed value in update_values requires
823 * us to intersect the bounds with the current build domain.
824 * When we intersect build->domain with the updated bounds in
825 * the final step, we make sure that these updated bounds have
826 * not been intersected with the old build->domain.
827 * Otherwise, we would indirectly intersect the build domain with itself,
828 * which can lead to inefficiencies, in particular if the build domain
829 * contains any unknown divs.
831 * The pending and generated sets are not updated by this function to
832 * match the updated domain.
833 * The caller still needs to call isl_ast_build_set_pending_generated.
835 __isl_give isl_ast_build
*isl_ast_build_set_loop_bounds(
836 __isl_take isl_ast_build
*build
, __isl_take isl_basic_set
*bounds
)
840 build
= isl_ast_build_cow(build
);
844 build
= update_values(build
, isl_basic_set_copy(bounds
));
847 set
= isl_set_from_basic_set(isl_basic_set_copy(bounds
));
848 if (isl_ast_build_has_affine_value(build
, build
->depth
)) {
849 set
= isl_set_eliminate(set
, isl_dim_set
, build
->depth
, 1);
850 set
= isl_set_compute_divs(set
);
851 build
->pending
= isl_set_intersect(build
->pending
,
853 build
->domain
= isl_set_intersect(build
->domain
, set
);
855 build
->domain
= isl_set_intersect(build
->domain
, set
);
856 build
= isl_ast_build_include_stride(build
);
860 isl_basic_set_free(bounds
);
862 if (!build
->domain
|| !build
->pending
|| !build
->generated
)
863 return isl_ast_build_free(build
);
867 isl_ast_build_free(build
);
868 isl_basic_set_free(bounds
);
872 /* Update the pending and generated sets of "build" according to "bounds".
873 * If the build has an affine value at the current depth,
874 * then isl_ast_build_set_loop_bounds has already set the pending set.
875 * Otherwise, do it here.
877 __isl_give isl_ast_build
*isl_ast_build_set_pending_generated(
878 __isl_take isl_ast_build
*build
, __isl_take isl_basic_set
*bounds
)
880 isl_basic_set
*generated
, *pending
;
885 if (isl_ast_build_has_affine_value(build
, build
->depth
)) {
886 isl_basic_set_free(bounds
);
890 build
= isl_ast_build_cow(build
);
894 pending
= isl_basic_set_copy(bounds
);
895 pending
= isl_basic_set_drop_constraints_involving_dims(pending
,
896 isl_dim_set
, build
->depth
, 1);
897 build
->pending
= isl_set_intersect(build
->pending
,
898 isl_set_from_basic_set(pending
));
900 generated
= isl_basic_set_drop_constraints_not_involving_dims(
901 generated
, isl_dim_set
, build
->depth
, 1);
902 build
->generated
= isl_set_intersect(build
->generated
,
903 isl_set_from_basic_set(generated
));
905 if (!build
->pending
|| !build
->generated
)
906 return isl_ast_build_free(build
);
910 isl_ast_build_free(build
);
911 isl_basic_set_free(bounds
);
915 /* Intersect build->domain with "set", where "set" is specified
916 * in terms of the internal schedule domain.
918 static __isl_give isl_ast_build
*isl_ast_build_restrict_internal(
919 __isl_take isl_ast_build
*build
, __isl_take isl_set
*set
)
921 build
= isl_ast_build_cow(build
);
925 set
= isl_set_compute_divs(set
);
926 build
->domain
= isl_set_intersect(build
->domain
, set
);
927 build
->domain
= isl_set_coalesce(build
->domain
);
930 return isl_ast_build_free(build
);
934 isl_ast_build_free(build
);
939 /* Intersect build->generated and build->domain with "set",
940 * where "set" is specified in terms of the internal schedule domain.
942 __isl_give isl_ast_build
*isl_ast_build_restrict_generated(
943 __isl_take isl_ast_build
*build
, __isl_take isl_set
*set
)
945 set
= isl_set_compute_divs(set
);
946 build
= isl_ast_build_restrict_internal(build
, isl_set_copy(set
));
947 build
= isl_ast_build_cow(build
);
951 build
->generated
= isl_set_intersect(build
->generated
, set
);
952 build
->generated
= isl_set_coalesce(build
->generated
);
954 if (!build
->generated
)
955 return isl_ast_build_free(build
);
959 isl_ast_build_free(build
);
964 /* Replace the set of pending constraints by "guard", which is then
965 * no longer considered as pending.
966 * That is, add "guard" to the generated constraints and clear all pending
967 * constraints, making the domain equal to the generated constraints.
969 __isl_give isl_ast_build
*isl_ast_build_replace_pending_by_guard(
970 __isl_take isl_ast_build
*build
, __isl_take isl_set
*guard
)
972 build
= isl_ast_build_restrict_generated(build
, guard
);
973 build
= isl_ast_build_cow(build
);
977 isl_set_free(build
->domain
);
978 build
->domain
= isl_set_copy(build
->generated
);
979 isl_set_free(build
->pending
);
980 build
->pending
= isl_set_universe(isl_set_get_space(build
->domain
));
983 return isl_ast_build_free(build
);
988 /* Intersect build->domain with "set", where "set" is specified
989 * in terms of the external schedule domain.
991 __isl_give isl_ast_build
*isl_ast_build_restrict(
992 __isl_take isl_ast_build
*build
, __isl_take isl_set
*set
)
994 if (isl_set_is_params(set
))
995 return isl_ast_build_restrict_generated(build
, set
);
997 if (isl_ast_build_need_schedule_map(build
)) {
999 ma
= isl_ast_build_get_schedule_map_multi_aff(build
);
1000 set
= isl_set_preimage_multi_aff(set
, ma
);
1002 return isl_ast_build_restrict_generated(build
, set
);
1005 /* Replace build->executed by "executed".
1007 __isl_give isl_ast_build
*isl_ast_build_set_executed(
1008 __isl_take isl_ast_build
*build
, __isl_take isl_union_map
*executed
)
1010 build
= isl_ast_build_cow(build
);
1014 isl_union_map_free(build
->executed
);
1015 build
->executed
= executed
;
1019 isl_ast_build_free(build
);
1020 isl_union_map_free(executed
);
1024 /* Does "build" point to a band node?
1025 * That is, are we currently handling a band node inside a schedule tree?
1027 int isl_ast_build_has_schedule_node(__isl_keep isl_ast_build
*build
)
1031 return build
->node
!= NULL
;
1034 /* Return a copy of the band node that "build" refers to.
1036 __isl_give isl_schedule_node
*isl_ast_build_get_schedule_node(
1037 __isl_keep isl_ast_build
*build
)
1041 return isl_schedule_node_copy(build
->node
);
1044 /* Extract the loop AST generation types for the members of build->node
1045 * and store them in build->loop_type.
1047 static __isl_give isl_ast_build
*extract_loop_types(
1048 __isl_take isl_ast_build
*build
)
1052 isl_schedule_node
*node
;
1056 ctx
= isl_ast_build_get_ctx(build
);
1058 isl_die(ctx
, isl_error_internal
, "missing AST node",
1059 return isl_ast_build_free(build
));
1061 free(build
->loop_type
);
1062 build
->n
= isl_schedule_node_band_n_member(build
->node
);
1063 build
->loop_type
= isl_alloc_array(ctx
,
1064 enum isl_ast_loop_type
, build
->n
);
1065 if (build
->n
&& !build
->loop_type
)
1066 return isl_ast_build_free(build
);
1068 for (i
= 0; i
< build
->n
; ++i
)
1069 build
->loop_type
[i
] =
1070 isl_schedule_node_band_member_get_ast_loop_type(node
, i
);
1075 /* Replace the band node that "build" refers to by "node" and
1076 * extract the corresponding loop AST generation types.
1078 __isl_give isl_ast_build
*isl_ast_build_set_schedule_node(
1079 __isl_take isl_ast_build
*build
,
1080 __isl_take isl_schedule_node
*node
)
1082 build
= isl_ast_build_cow(build
);
1083 if (!build
|| !node
)
1086 isl_schedule_node_free(build
->node
);
1089 build
= extract_loop_types(build
);
1093 isl_ast_build_free(build
);
1094 isl_schedule_node_free(node
);
1098 /* Remove any reference to a band node from "build".
1100 __isl_give isl_ast_build
*isl_ast_build_reset_schedule_node(
1101 __isl_take isl_ast_build
*build
)
1103 build
= isl_ast_build_cow(build
);
1107 isl_schedule_node_free(build
->node
);
1113 /* Return a copy of the current schedule domain.
1115 __isl_give isl_set
*isl_ast_build_get_domain(__isl_keep isl_ast_build
*build
)
1117 return build
? isl_set_copy(build
->domain
) : NULL
;
1120 /* Return a copy of the set of pending constraints.
1122 __isl_give isl_set
*isl_ast_build_get_pending(
1123 __isl_keep isl_ast_build
*build
)
1125 return build
? isl_set_copy(build
->pending
) : NULL
;
1128 /* Return a copy of the set of generated constraints.
1130 __isl_give isl_set
*isl_ast_build_get_generated(
1131 __isl_keep isl_ast_build
*build
)
1133 return build
? isl_set_copy(build
->generated
) : NULL
;
1136 /* Return a copy of the map from the internal schedule domain
1137 * to the original input schedule domain.
1139 __isl_give isl_multi_aff
*isl_ast_build_get_internal2input(
1140 __isl_keep isl_ast_build
*build
)
1142 return build
? isl_multi_aff_copy(build
->internal2input
) : NULL
;
1145 /* Return the number of variables of the given type
1146 * in the (internal) schedule space.
1148 unsigned isl_ast_build_dim(__isl_keep isl_ast_build
*build
,
1149 enum isl_dim_type type
)
1153 return isl_set_dim(build
->domain
, type
);
1156 /* Return the (schedule) space of "build".
1158 * If "internal" is set, then this space is the space of the internal
1159 * representation of the entire schedule, including those parts for
1160 * which no code has been generated yet.
1162 * If "internal" is not set, then this space is the external representation
1163 * of the loops generated so far.
1165 __isl_give isl_space
*isl_ast_build_get_space(__isl_keep isl_ast_build
*build
,
1175 space
= isl_set_get_space(build
->domain
);
1179 if (!isl_ast_build_need_schedule_map(build
))
1182 dim
= isl_set_dim(build
->domain
, isl_dim_set
);
1183 space
= isl_space_drop_dims(space
, isl_dim_set
,
1184 build
->depth
, dim
- build
->depth
);
1185 for (i
= build
->depth
- 1; i
>= 0; --i
)
1186 if (isl_ast_build_has_affine_value(build
, i
))
1187 space
= isl_space_drop_dims(space
, isl_dim_set
, i
, 1);
1192 /* Return the external representation of the schedule space of "build",
1193 * i.e., a space with a dimension for each loop generated so far,
1194 * with the names of the dimensions set to the loop iterators.
1196 __isl_give isl_space
*isl_ast_build_get_schedule_space(
1197 __isl_keep isl_ast_build
*build
)
1205 space
= isl_ast_build_get_space(build
, 0);
1208 for (i
= 0; i
< build
->depth
; ++i
) {
1211 if (isl_ast_build_has_affine_value(build
, i
)) {
1216 id
= isl_ast_build_get_iterator_id(build
, i
);
1217 space
= isl_space_set_dim_id(space
, isl_dim_set
, i
- skip
, id
);
1223 /* Return the current schedule, as stored in build->executed, in terms
1224 * of the external schedule domain.
1226 __isl_give isl_union_map
*isl_ast_build_get_schedule(
1227 __isl_keep isl_ast_build
*build
)
1229 isl_union_map
*executed
;
1230 isl_union_map
*schedule
;
1235 executed
= isl_union_map_copy(build
->executed
);
1236 if (isl_ast_build_need_schedule_map(build
)) {
1237 isl_map
*proj
= isl_ast_build_get_schedule_map(build
);
1238 executed
= isl_union_map_apply_domain(executed
,
1239 isl_union_map_from_map(proj
));
1241 schedule
= isl_union_map_reverse(executed
);
1246 /* Return the iterator attached to the internal schedule dimension "pos".
1248 __isl_give isl_id
*isl_ast_build_get_iterator_id(
1249 __isl_keep isl_ast_build
*build
, int pos
)
1254 return isl_id_list_get_id(build
->iterators
, pos
);
1257 /* Set the stride and offset of the current dimension to the given
1258 * value and expression.
1260 static __isl_give isl_ast_build
*set_stride(__isl_take isl_ast_build
*build
,
1261 __isl_take isl_val
*stride
, __isl_take isl_aff
*offset
)
1265 build
= isl_ast_build_cow(build
);
1266 if (!build
|| !stride
|| !offset
)
1271 build
->strides
= isl_vec_set_element_val(build
->strides
, pos
, stride
);
1272 build
->offsets
= isl_multi_aff_set_aff(build
->offsets
, pos
, offset
);
1273 if (!build
->strides
|| !build
->offsets
)
1274 return isl_ast_build_free(build
);
1278 isl_val_free(stride
);
1279 isl_aff_free(offset
);
1280 return isl_ast_build_free(build
);
1283 /* Return a set expressing the stride constraint at the current depth.
1285 * In particular, if the current iterator (i) is known to attain values
1289 * where f is the offset and s is the stride, then the returned set
1290 * expresses the constraint
1294 __isl_give isl_set
*isl_ast_build_get_stride_constraint(
1295 __isl_keep isl_ast_build
*build
)
1307 if (!isl_ast_build_has_stride(build
, pos
))
1308 return isl_set_universe(isl_ast_build_get_space(build
, 1));
1310 stride
= isl_ast_build_get_stride(build
, pos
);
1311 aff
= isl_ast_build_get_offset(build
, pos
);
1312 aff
= isl_aff_add_coefficient_si(aff
, isl_dim_in
, pos
, -1);
1313 aff
= isl_aff_mod_val(aff
, stride
);
1314 set
= isl_set_from_basic_set(isl_aff_zero_basic_set(aff
));
1319 /* Return the expansion implied by the stride and offset at the current
1322 * That is, return the mapping
1324 * [i_0, ..., i_{d-1}, i_d, i_{d+1}, ...]
1325 * -> [i_0, ..., i_{d-1}, s * i_d + offset(i), i_{d+1}, ...]
1327 * where s is the stride at the current depth d and offset(i) is
1328 * the corresponding offset.
1330 __isl_give isl_multi_aff
*isl_ast_build_get_stride_expansion(
1331 __isl_keep isl_ast_build
*build
)
1336 isl_aff
*aff
, *offset
;
1342 pos
= isl_ast_build_get_depth(build
);
1343 space
= isl_ast_build_get_space(build
, 1);
1344 space
= isl_space_map_from_set(space
);
1345 ma
= isl_multi_aff_identity(space
);
1347 if (!isl_ast_build_has_stride(build
, pos
))
1350 offset
= isl_ast_build_get_offset(build
, pos
);
1351 stride
= isl_ast_build_get_stride(build
, pos
);
1352 aff
= isl_multi_aff_get_aff(ma
, pos
);
1353 aff
= isl_aff_scale_val(aff
, stride
);
1354 aff
= isl_aff_add(aff
, offset
);
1355 ma
= isl_multi_aff_set_aff(ma
, pos
, aff
);
1360 /* Add constraints corresponding to any previously detected
1361 * stride on the current dimension to build->domain.
1363 __isl_give isl_ast_build
*isl_ast_build_include_stride(
1364 __isl_take isl_ast_build
*build
)
1370 if (!isl_ast_build_has_stride(build
, build
->depth
))
1372 build
= isl_ast_build_cow(build
);
1376 set
= isl_ast_build_get_stride_constraint(build
);
1378 build
->domain
= isl_set_intersect(build
->domain
, isl_set_copy(set
));
1379 build
->generated
= isl_set_intersect(build
->generated
, set
);
1380 if (!build
->domain
|| !build
->generated
)
1381 return isl_ast_build_free(build
);
1386 /* Check if the constraints in "set" imply any stride on the current
1387 * dimension and, if so, record the stride information in "build"
1388 * and return the updated "build".
1390 * We assume that inner dimensions have been eliminated from "set"
1391 * by the caller. This is needed because the common stride
1392 * may be imposed by different inner dimensions on different parts of
1394 * The assumption ensures that the lower bound does not depend
1395 * on inner dimensions.
1397 __isl_give isl_ast_build
*isl_ast_build_detect_strides(
1398 __isl_take isl_ast_build
*build
, __isl_take isl_set
*set
)
1404 isl_stride_info
*si
;
1409 pos
= isl_ast_build_get_depth(build
);
1410 si
= isl_set_get_stride_info(set
, pos
);
1411 stride
= isl_stride_info_get_stride(si
);
1412 offset
= isl_stride_info_get_offset(si
);
1413 isl_stride_info_free(si
);
1416 no_stride
= isl_val_is_one(stride
);
1417 if (no_stride
>= 0 && !no_stride
)
1418 return set_stride(build
, stride
, offset
);
1419 isl_val_free(stride
);
1420 isl_aff_free(offset
);
1422 return isl_ast_build_free(build
);
1429 struct isl_ast_build_involves_data
{
1434 /* Check if "map" involves the input dimension data->depth.
1436 static isl_stat
involves_depth(__isl_take isl_map
*map
, void *user
)
1438 struct isl_ast_build_involves_data
*data
= user
;
1440 data
->involves
= isl_map_involves_dims(map
, isl_dim_in
, data
->depth
, 1);
1443 if (data
->involves
< 0 || data
->involves
)
1444 return isl_stat_error
;
1448 /* Do any options depend on the value of the dimension at the current depth?
1450 int isl_ast_build_options_involve_depth(__isl_keep isl_ast_build
*build
)
1452 struct isl_ast_build_involves_data data
;
1457 data
.depth
= build
->depth
;
1460 if (isl_union_map_foreach_map(build
->options
,
1461 &involves_depth
, &data
) < 0) {
1462 if (data
.involves
< 0 || !data
.involves
)
1466 return data
.involves
;
1469 /* Construct the map
1471 * { [i] -> [i] : i < pos; [i] -> [i + 1] : i >= pos }
1473 * with "space" the parameter space of the constructed map.
1475 static __isl_give isl_map
*construct_insertion_map(__isl_take isl_space
*space
,
1479 isl_basic_map
*bmap1
, *bmap2
;
1481 space
= isl_space_set_from_params(space
);
1482 space
= isl_space_add_dims(space
, isl_dim_set
, 1);
1483 space
= isl_space_map_from_set(space
);
1484 c
= isl_constraint_alloc_equality(isl_local_space_from_space(space
));
1485 c
= isl_constraint_set_coefficient_si(c
, isl_dim_in
, 0, 1);
1486 c
= isl_constraint_set_coefficient_si(c
, isl_dim_out
, 0, -1);
1487 bmap1
= isl_basic_map_from_constraint(isl_constraint_copy(c
));
1488 c
= isl_constraint_set_constant_si(c
, 1);
1489 bmap2
= isl_basic_map_from_constraint(c
);
1491 bmap1
= isl_basic_map_upper_bound_si(bmap1
, isl_dim_in
, 0, pos
- 1);
1492 bmap2
= isl_basic_map_lower_bound_si(bmap2
, isl_dim_in
, 0, pos
);
1494 return isl_basic_map_union(bmap1
, bmap2
);
1497 static const char *option_str
[] = {
1498 [isl_ast_loop_atomic
] = "atomic",
1499 [isl_ast_loop_unroll
] = "unroll",
1500 [isl_ast_loop_separate
] = "separate"
1503 /* Update the "options" to reflect the insertion of a dimension
1504 * at position "pos" in the schedule domain space.
1505 * "space" is the original domain space before the insertion and
1506 * may be named and/or structured.
1508 * The (relevant) input options all have "space" as domain, which
1509 * has to be mapped to the extended space.
1510 * The values of the ranges also refer to the schedule domain positions
1511 * and they therefore also need to be adjusted. In particular, values
1512 * smaller than pos do not need to change, while values greater than or
1513 * equal to pos need to be incremented.
1514 * That is, we need to apply the following map.
1516 * { atomic[i] -> atomic[i] : i < pos; [i] -> [i + 1] : i >= pos;
1517 * unroll[i] -> unroll[i] : i < pos; [i] -> [i + 1] : i >= pos;
1518 * separate[i] -> separate[i] : i < pos; [i] -> [i + 1] : i >= pos;
1519 * separation_class[[i] -> [c]]
1520 * -> separation_class[[i] -> [c]] : i < pos;
1521 * separation_class[[i] -> [c]]
1522 * -> separation_class[[i + 1] -> [c]] : i >= pos }
1524 static __isl_give isl_union_map
*options_insert_dim(
1525 __isl_take isl_union_map
*options
, __isl_take isl_space
*space
, int pos
)
1528 isl_union_map
*insertion
;
1529 enum isl_ast_loop_type type
;
1530 const char *name
= "separation_class";
1532 space
= isl_space_map_from_set(space
);
1533 map
= isl_map_identity(space
);
1534 map
= isl_map_insert_dims(map
, isl_dim_out
, pos
, 1);
1535 options
= isl_union_map_apply_domain(options
,
1536 isl_union_map_from_map(map
));
1541 map
= construct_insertion_map(isl_union_map_get_space(options
), pos
);
1543 insertion
= isl_union_map_empty(isl_union_map_get_space(options
));
1545 for (type
= isl_ast_loop_atomic
;
1546 type
<= isl_ast_loop_separate
; ++type
) {
1547 isl_map
*map_type
= isl_map_copy(map
);
1548 const char *name
= option_str
[type
];
1549 map_type
= isl_map_set_tuple_name(map_type
, isl_dim_in
, name
);
1550 map_type
= isl_map_set_tuple_name(map_type
, isl_dim_out
, name
);
1551 insertion
= isl_union_map_add_map(insertion
, map_type
);
1554 map
= isl_map_product(map
, isl_map_identity(isl_map_get_space(map
)));
1555 map
= isl_map_set_tuple_name(map
, isl_dim_in
, name
);
1556 map
= isl_map_set_tuple_name(map
, isl_dim_out
, name
);
1557 insertion
= isl_union_map_add_map(insertion
, map
);
1559 options
= isl_union_map_apply_range(options
, insertion
);
1564 /* If we are generating an AST from a schedule tree (build->node is set),
1565 * then update the loop AST generation types
1566 * to reflect the insertion of a dimension at (global) position "pos"
1567 * in the schedule domain space.
1568 * We do not need to adjust any isolate option since we would not be inserting
1569 * any dimensions if there were any isolate option.
1571 static __isl_give isl_ast_build
*node_insert_dim(
1572 __isl_take isl_ast_build
*build
, int pos
)
1576 enum isl_ast_loop_type
*loop_type
;
1579 build
= isl_ast_build_cow(build
);
1585 ctx
= isl_ast_build_get_ctx(build
);
1586 local_pos
= pos
- build
->outer_pos
;
1587 loop_type
= isl_realloc_array(ctx
, build
->loop_type
,
1588 enum isl_ast_loop_type
, build
->n
+ 1);
1590 return isl_ast_build_free(build
);
1591 build
->loop_type
= loop_type
;
1592 for (i
= build
->n
- 1; i
>= local_pos
; --i
)
1593 loop_type
[i
+ 1] = loop_type
[i
];
1594 loop_type
[local_pos
] = isl_ast_loop_default
;
1600 /* Insert a single dimension in the schedule domain at position "pos".
1601 * The new dimension is given an isl_id with the empty string as name.
1603 * The main difficulty is updating build->options to reflect the
1604 * extra dimension. This is handled in options_insert_dim.
1606 * Note that because of the dimension manipulations, the resulting
1607 * schedule domain space will always be unnamed and unstructured.
1608 * However, the original schedule domain space may be named and/or
1609 * structured, so we have to take this possibility into account
1610 * while performing the transformations.
1612 * Since the inserted schedule dimension is used by the caller
1613 * to differentiate between different domain spaces, there is
1614 * no longer a uniform mapping from the internal schedule space
1615 * to the input schedule space. The internal2input mapping is
1616 * therefore removed.
1618 __isl_give isl_ast_build
*isl_ast_build_insert_dim(
1619 __isl_take isl_ast_build
*build
, int pos
)
1622 isl_space
*space
, *ma_space
;
1626 build
= isl_ast_build_cow(build
);
1630 ctx
= isl_ast_build_get_ctx(build
);
1631 id
= isl_id_alloc(ctx
, "", NULL
);
1633 space
= isl_ast_build_get_space(build
, 1);
1634 build
->iterators
= isl_id_list_insert(build
->iterators
, pos
, id
);
1635 build
->domain
= isl_set_insert_dims(build
->domain
,
1636 isl_dim_set
, pos
, 1);
1637 build
->generated
= isl_set_insert_dims(build
->generated
,
1638 isl_dim_set
, pos
, 1);
1639 build
->pending
= isl_set_insert_dims(build
->pending
,
1640 isl_dim_set
, pos
, 1);
1641 build
->strides
= isl_vec_insert_els(build
->strides
, pos
, 1);
1642 build
->strides
= isl_vec_set_element_si(build
->strides
, pos
, 1);
1643 ma_space
= isl_space_params(isl_multi_aff_get_space(build
->offsets
));
1644 ma_space
= isl_space_set_from_params(ma_space
);
1645 ma_space
= isl_space_add_dims(ma_space
, isl_dim_set
, 1);
1646 ma_space
= isl_space_map_from_set(ma_space
);
1647 ma
= isl_multi_aff_zero(isl_space_copy(ma_space
));
1648 build
->offsets
= isl_multi_aff_splice(build
->offsets
, pos
, pos
, ma
);
1649 ma
= isl_multi_aff_identity(ma_space
);
1650 build
->values
= isl_multi_aff_splice(build
->values
, pos
, pos
, ma
);
1652 build
->options
= options_insert_dim(build
->options
, space
, pos
);
1653 build
->internal2input
= isl_multi_aff_free(build
->internal2input
);
1655 if (!build
->iterators
|| !build
->domain
|| !build
->generated
||
1656 !build
->pending
|| !build
->values
||
1657 !build
->strides
|| !build
->offsets
|| !build
->options
)
1658 return isl_ast_build_free(build
);
1660 build
= node_insert_dim(build
, pos
);
1665 /* Scale down the current dimension by a factor of "m".
1666 * "umap" is an isl_union_map that implements the scaling down.
1667 * That is, it is of the form
1669 * { [.... i ....] -> [.... i' ....] : i = m i' }
1671 * This function is called right after the strides have been
1672 * detected, but before any constraints on the current dimension
1673 * have been included in build->domain.
1674 * We therefore only need to update stride, offset, the options and
1675 * the mapping from internal schedule space to the original schedule
1676 * space, if we are still keeping track of such a mapping.
1677 * The latter mapping is updated by plugging in
1678 * { [... i ...] -> [... m i ... ] }.
1680 __isl_give isl_ast_build
*isl_ast_build_scale_down(
1681 __isl_take isl_ast_build
*build
, __isl_take isl_val
*m
,
1682 __isl_take isl_union_map
*umap
)
1688 build
= isl_ast_build_cow(build
);
1689 if (!build
|| !umap
|| !m
)
1692 depth
= build
->depth
;
1694 if (build
->internal2input
) {
1699 space
= isl_multi_aff_get_space(build
->internal2input
);
1700 space
= isl_space_map_from_set(isl_space_domain(space
));
1701 ma
= isl_multi_aff_identity(space
);
1702 aff
= isl_multi_aff_get_aff(ma
, depth
);
1703 aff
= isl_aff_scale_val(aff
, isl_val_copy(m
));
1704 ma
= isl_multi_aff_set_aff(ma
, depth
, aff
);
1705 build
->internal2input
=
1706 isl_multi_aff_pullback_multi_aff(build
->internal2input
, ma
);
1707 if (!build
->internal2input
)
1711 v
= isl_vec_get_element_val(build
->strides
, depth
);
1712 v
= isl_val_div(v
, isl_val_copy(m
));
1713 build
->strides
= isl_vec_set_element_val(build
->strides
, depth
, v
);
1715 aff
= isl_multi_aff_get_aff(build
->offsets
, depth
);
1716 aff
= isl_aff_scale_down_val(aff
, m
);
1717 build
->offsets
= isl_multi_aff_set_aff(build
->offsets
, depth
, aff
);
1718 build
->options
= isl_union_map_apply_domain(build
->options
, umap
);
1719 if (!build
->strides
|| !build
->offsets
|| !build
->options
)
1720 return isl_ast_build_free(build
);
1725 isl_union_map_free(umap
);
1726 return isl_ast_build_free(build
);
1729 /* Return a list of "n" isl_ids called "c%d", with "%d" starting at "first".
1730 * If an isl_id with such a name already appears among the parameters
1731 * in build->domain, then adjust the name to "c%d_%d".
1733 static __isl_give isl_id_list
*generate_names(isl_ctx
*ctx
, int n
, int first
,
1734 __isl_keep isl_ast_build
*build
)
1739 names
= isl_id_list_alloc(ctx
, n
);
1740 for (i
= 0; i
< n
; ++i
) {
1743 id
= generate_name(ctx
, first
+ i
, build
);
1744 names
= isl_id_list_add(names
, id
);
1750 /* Embed "options" into the given isl_ast_build space.
1752 * This function is called from within a nested call to
1753 * isl_ast_build_node_from_schedule_map.
1754 * "options" refers to the additional schedule,
1755 * while space refers to both the space of the outer isl_ast_build and
1756 * that of the additional schedule.
1757 * Specifically, space is of the form
1761 * while options lives in the space(s)
1769 * and compose this with options, to obtain the new options
1770 * living in the space(s)
1774 static __isl_give isl_union_map
*embed_options(
1775 __isl_take isl_union_map
*options
, __isl_take isl_space
*space
)
1779 map
= isl_map_universe(isl_space_unwrap(space
));
1780 map
= isl_map_range_map(map
);
1782 options
= isl_union_map_apply_range(
1783 isl_union_map_from_map(map
), options
);
1788 /* Update "build" for use in a (possibly nested) code generation. That is,
1789 * extend "build" from an AST build on some domain O to an AST build
1790 * on domain [O -> S], with S corresponding to "space".
1791 * If the original domain is a parameter domain, then the new domain is
1793 * "iterators" is a list of iterators for S, but the number of elements
1794 * may be smaller or greater than the number of set dimensions of S.
1795 * If "keep_iterators" is set, then any extra ids in build->iterators
1796 * are reused for S. Otherwise, these extra ids are dropped.
1798 * We first update build->outer_pos to the current depth.
1799 * This depth is zero in case this is the outermost code generation.
1801 * We then add additional ids such that the number of iterators is at least
1802 * equal to the dimension of the new build domain.
1804 * If the original domain is parametric, then we are constructing
1805 * an isl_ast_build for the outer code generation and we pass control
1806 * to isl_ast_build_init.
1808 * Otherwise, we adjust the fields of "build" to include "space".
1810 __isl_give isl_ast_build
*isl_ast_build_product(
1811 __isl_take isl_ast_build
*build
, __isl_take isl_space
*space
)
1816 isl_multi_aff
*embedding
;
1819 build
= isl_ast_build_cow(build
);
1823 build
->outer_pos
= build
->depth
;
1825 ctx
= isl_ast_build_get_ctx(build
);
1826 dim
= isl_set_dim(build
->domain
, isl_dim_set
);
1827 dim
+= isl_space_dim(space
, isl_dim_set
);
1828 n_it
= isl_id_list_n_id(build
->iterators
);
1831 l
= generate_names(ctx
, dim
- n_it
, n_it
, build
);
1832 build
->iterators
= isl_id_list_concat(build
->iterators
, l
);
1835 if (isl_set_is_params(build
->domain
))
1836 return isl_ast_build_init(build
, space
);
1838 set
= isl_set_universe(isl_space_copy(space
));
1839 build
->domain
= isl_set_product(build
->domain
, isl_set_copy(set
));
1840 build
->pending
= isl_set_product(build
->pending
, isl_set_copy(set
));
1841 build
->generated
= isl_set_product(build
->generated
, set
);
1843 strides
= isl_vec_alloc(ctx
, isl_space_dim(space
, isl_dim_set
));
1844 strides
= isl_vec_set_si(strides
, 1);
1845 build
->strides
= isl_vec_concat(build
->strides
, strides
);
1847 space
= isl_space_map_from_set(space
);
1848 build
->offsets
= isl_multi_aff_align_params(build
->offsets
,
1849 isl_space_copy(space
));
1850 build
->offsets
= isl_multi_aff_product(build
->offsets
,
1851 isl_multi_aff_zero(isl_space_copy(space
)));
1852 build
->values
= isl_multi_aff_align_params(build
->values
,
1853 isl_space_copy(space
));
1854 embedding
= isl_multi_aff_identity(space
);
1855 build
->values
= isl_multi_aff_product(build
->values
,
1856 isl_multi_aff_copy(embedding
));
1857 if (build
->internal2input
) {
1858 build
->internal2input
=
1859 isl_multi_aff_product(build
->internal2input
, embedding
);
1860 build
->internal2input
=
1861 isl_multi_aff_flatten_range(build
->internal2input
);
1862 if (!build
->internal2input
)
1863 return isl_ast_build_free(build
);
1865 isl_multi_aff_free(embedding
);
1868 space
= isl_ast_build_get_space(build
, 1);
1869 build
->options
= embed_options(build
->options
, space
);
1871 if (!build
->iterators
|| !build
->domain
|| !build
->generated
||
1872 !build
->pending
|| !build
->values
||
1873 !build
->strides
|| !build
->offsets
|| !build
->options
)
1874 return isl_ast_build_free(build
);
1878 isl_ast_build_free(build
);
1879 isl_space_free(space
);
1883 /* Does "aff" only attain non-negative values over build->domain?
1884 * That is, does it not attain any negative values?
1886 int isl_ast_build_aff_is_nonneg(__isl_keep isl_ast_build
*build
,
1887 __isl_keep isl_aff
*aff
)
1895 aff
= isl_aff_copy(aff
);
1896 test
= isl_set_from_basic_set(isl_aff_neg_basic_set(aff
));
1897 test
= isl_set_intersect(test
, isl_set_copy(build
->domain
));
1898 empty
= isl_set_is_empty(test
);
1904 /* Does the dimension at (internal) position "pos" have a non-trivial stride?
1906 isl_bool
isl_ast_build_has_stride(__isl_keep isl_ast_build
*build
, int pos
)
1909 isl_bool has_stride
;
1912 return isl_bool_error
;
1914 v
= isl_vec_get_element_val(build
->strides
, pos
);
1915 has_stride
= isl_bool_not(isl_val_is_one(v
));
1921 /* Given that the dimension at position "pos" takes on values
1925 * with a an integer, return s through *stride.
1927 __isl_give isl_val
*isl_ast_build_get_stride(__isl_keep isl_ast_build
*build
,
1933 return isl_vec_get_element_val(build
->strides
, pos
);
1936 /* Given that the dimension at position "pos" takes on values
1940 * with a an integer, return f.
1942 __isl_give isl_aff
*isl_ast_build_get_offset(
1943 __isl_keep isl_ast_build
*build
, int pos
)
1948 return isl_multi_aff_get_aff(build
->offsets
, pos
);
1951 /* Is the dimension at position "pos" known to attain only a single
1952 * value that, moreover, can be described by a single affine expression
1953 * in terms of the outer dimensions and parameters?
1955 * If not, then the corresponding affine expression in build->values
1956 * is set to be equal to the same input dimension.
1957 * Otherwise, it is set to the requested expression in terms of
1958 * outer dimensions and parameters.
1960 int isl_ast_build_has_affine_value(__isl_keep isl_ast_build
*build
,
1969 aff
= isl_multi_aff_get_aff(build
->values
, pos
);
1970 involves
= isl_aff_involves_dims(aff
, isl_dim_in
, pos
, 1);
1979 /* Plug in the known values (fixed affine expressions in terms of
1980 * parameters and outer loop iterators) of all loop iterators
1981 * in the domain of "umap".
1983 * We simply precompose "umap" with build->values.
1985 __isl_give isl_union_map
*isl_ast_build_substitute_values_union_map_domain(
1986 __isl_keep isl_ast_build
*build
, __isl_take isl_union_map
*umap
)
1988 isl_multi_aff
*values
;
1991 return isl_union_map_free(umap
);
1993 values
= isl_multi_aff_copy(build
->values
);
1994 umap
= isl_union_map_preimage_domain_multi_aff(umap
, values
);
1999 /* Is the current dimension known to attain only a single value?
2001 int isl_ast_build_has_value(__isl_keep isl_ast_build
*build
)
2006 return build
->value
!= NULL
;
2009 /* Simplify the basic set "bset" based on what we know about
2010 * the iterators of already generated loops.
2012 * "bset" is assumed to live in the (internal) schedule domain.
2014 __isl_give isl_basic_set
*isl_ast_build_compute_gist_basic_set(
2015 __isl_keep isl_ast_build
*build
, __isl_take isl_basic_set
*bset
)
2020 bset
= isl_basic_set_preimage_multi_aff(bset
,
2021 isl_multi_aff_copy(build
->values
));
2022 bset
= isl_basic_set_gist(bset
,
2023 isl_set_simple_hull(isl_set_copy(build
->domain
)));
2027 isl_basic_set_free(bset
);
2031 /* Simplify the set "set" based on what we know about
2032 * the iterators of already generated loops.
2034 * "set" is assumed to live in the (internal) schedule domain.
2036 __isl_give isl_set
*isl_ast_build_compute_gist(
2037 __isl_keep isl_ast_build
*build
, __isl_take isl_set
*set
)
2042 if (!isl_set_is_params(set
))
2043 set
= isl_set_preimage_multi_aff(set
,
2044 isl_multi_aff_copy(build
->values
));
2045 set
= isl_set_gist(set
, isl_set_copy(build
->domain
));
2053 /* Include information about what we know about the iterators of
2054 * already generated loops to "set".
2056 * We currently only plug in the known affine values of outer loop
2058 * In principle we could also introduce equalities or even other
2059 * constraints implied by the intersection of "set" and build->domain.
2061 __isl_give isl_set
*isl_ast_build_specialize(__isl_keep isl_ast_build
*build
,
2062 __isl_take isl_set
*set
)
2065 return isl_set_free(set
);
2067 return isl_set_preimage_multi_aff(set
,
2068 isl_multi_aff_copy(build
->values
));
2071 /* Plug in the known affine values of outer loop iterators in "bset".
2073 __isl_give isl_basic_set
*isl_ast_build_specialize_basic_set(
2074 __isl_keep isl_ast_build
*build
, __isl_take isl_basic_set
*bset
)
2077 return isl_basic_set_free(bset
);
2079 return isl_basic_set_preimage_multi_aff(bset
,
2080 isl_multi_aff_copy(build
->values
));
2083 /* Simplify the map "map" based on what we know about
2084 * the iterators of already generated loops.
2086 * The domain of "map" is assumed to live in the (internal) schedule domain.
2088 __isl_give isl_map
*isl_ast_build_compute_gist_map_domain(
2089 __isl_keep isl_ast_build
*build
, __isl_take isl_map
*map
)
2094 map
= isl_map_gist_domain(map
, isl_set_copy(build
->domain
));
2102 /* Simplify the affine expression "aff" based on what we know about
2103 * the iterators of already generated loops.
2105 * The domain of "aff" is assumed to live in the (internal) schedule domain.
2107 __isl_give isl_aff
*isl_ast_build_compute_gist_aff(
2108 __isl_keep isl_ast_build
*build
, __isl_take isl_aff
*aff
)
2113 aff
= isl_aff_gist(aff
, isl_set_copy(build
->domain
));
2121 /* Simplify the piecewise affine expression "aff" based on what we know about
2122 * the iterators of already generated loops.
2124 * The domain of "pa" is assumed to live in the (internal) schedule domain.
2126 __isl_give isl_pw_aff
*isl_ast_build_compute_gist_pw_aff(
2127 __isl_keep isl_ast_build
*build
, __isl_take isl_pw_aff
*pa
)
2132 if (!isl_set_is_params(build
->domain
))
2133 pa
= isl_pw_aff_pullback_multi_aff(pa
,
2134 isl_multi_aff_copy(build
->values
));
2135 pa
= isl_pw_aff_gist(pa
, isl_set_copy(build
->domain
));
2139 isl_pw_aff_free(pa
);
2143 /* Simplify the piecewise multi-affine expression "aff" based on what
2144 * we know about the iterators of already generated loops.
2146 * The domain of "pma" is assumed to live in the (internal) schedule domain.
2148 __isl_give isl_pw_multi_aff
*isl_ast_build_compute_gist_pw_multi_aff(
2149 __isl_keep isl_ast_build
*build
, __isl_take isl_pw_multi_aff
*pma
)
2154 pma
= isl_pw_multi_aff_pullback_multi_aff(pma
,
2155 isl_multi_aff_copy(build
->values
));
2156 pma
= isl_pw_multi_aff_gist(pma
, isl_set_copy(build
->domain
));
2160 isl_pw_multi_aff_free(pma
);
2164 /* Extract the schedule domain of the given type from build->options
2165 * at the current depth.
2167 * In particular, find the subset of build->options that is of
2168 * the following form
2170 * schedule_domain -> type[depth]
2172 * and return the corresponding domain, after eliminating inner dimensions
2173 * and divs that depend on the current dimension.
2175 * Note that the domain of build->options has been reformulated
2176 * in terms of the internal build space in embed_options,
2177 * but the position is still that within the current code generation.
2179 __isl_give isl_set
*isl_ast_build_get_option_domain(
2180 __isl_keep isl_ast_build
*build
, enum isl_ast_loop_type type
)
2191 name
= option_str
[type
];
2192 local_pos
= build
->depth
- build
->outer_pos
;
2194 space
= isl_ast_build_get_space(build
, 1);
2195 space
= isl_space_from_domain(space
);
2196 space
= isl_space_add_dims(space
, isl_dim_out
, 1);
2197 space
= isl_space_set_tuple_name(space
, isl_dim_out
, name
);
2199 option
= isl_union_map_extract_map(build
->options
, space
);
2200 option
= isl_map_fix_si(option
, isl_dim_out
, 0, local_pos
);
2202 domain
= isl_map_domain(option
);
2203 domain
= isl_ast_build_eliminate(build
, domain
);
2208 /* How does the user want the current schedule dimension to be generated?
2209 * These choices have been extracted from the schedule node
2210 * in extract_loop_types and stored in build->loop_type.
2211 * They have been updated to reflect any dimension insertion in
2213 * Return isl_ast_domain_error on error.
2215 * If "isolated" is set, then we get the loop AST generation type
2216 * directly from the band node since node_insert_dim cannot have been
2217 * called on a band with the isolate option.
2219 enum isl_ast_loop_type
isl_ast_build_get_loop_type(
2220 __isl_keep isl_ast_build
*build
, int isolated
)
2226 return isl_ast_loop_error
;
2227 ctx
= isl_ast_build_get_ctx(build
);
2229 isl_die(ctx
, isl_error_internal
,
2230 "only works for schedule tree based AST generation",
2231 return isl_ast_loop_error
);
2233 local_pos
= build
->depth
- build
->outer_pos
;
2235 return build
->loop_type
[local_pos
];
2236 return isl_schedule_node_band_member_get_isolate_ast_loop_type(
2237 build
->node
, local_pos
);
2240 /* Extract the isolated set from the isolate option, if any,
2241 * and store in the build.
2242 * If there is no isolate option, then the isolated set is
2243 * set to the empty set.
2245 * The isolate option is of the form
2247 * isolate[[outer bands] -> current_band]
2249 * We flatten this set and then map it back to the internal
2252 * If we have already extracted the isolated set
2253 * or if internal2input is no longer set, then we do not
2254 * need to do anything. In the latter case, we know
2255 * that the current band cannot have any isolate option.
2257 __isl_give isl_ast_build
*isl_ast_build_extract_isolated(
2258 __isl_take isl_ast_build
*build
)
2264 if (!build
->internal2input
)
2266 if (build
->isolated
)
2269 build
= isl_ast_build_cow(build
);
2273 isolated
= isl_schedule_node_band_get_ast_isolate_option(build
->node
);
2274 isolated
= isl_set_flatten(isolated
);
2275 isolated
= isl_set_preimage_multi_aff(isolated
,
2276 isl_multi_aff_copy(build
->internal2input
));
2278 build
->isolated
= isolated
;
2279 if (!build
->isolated
)
2280 return isl_ast_build_free(build
);
2285 /* Does "build" have a non-empty isolated set?
2287 * The caller is assumed to have called isl_ast_build_extract_isolated first.
2289 int isl_ast_build_has_isolated(__isl_keep isl_ast_build
*build
)
2295 if (!build
->internal2input
)
2297 if (!build
->isolated
)
2298 isl_die(isl_ast_build_get_ctx(build
), isl_error_internal
,
2299 "isolated set not extracted yet", return -1);
2301 empty
= isl_set_plain_is_empty(build
->isolated
);
2302 return empty
< 0 ? -1 : !empty
;
2305 /* Return a copy of the isolated set of "build".
2307 * The caller is assume to have called isl_ast_build_has_isolated first,
2308 * with this function returning true.
2309 * In particular, this function should not be called if we are no
2310 * longer keeping track of internal2input (and there therefore could
2311 * not possibly be any isolated set).
2313 __isl_give isl_set
*isl_ast_build_get_isolated(__isl_keep isl_ast_build
*build
)
2317 if (!build
->internal2input
)
2318 isl_die(isl_ast_build_get_ctx(build
), isl_error_internal
,
2319 "build cannot have isolated set", return NULL
);
2321 return isl_set_copy(build
->isolated
);
2324 /* Extract the separation class mapping at the current depth.
2326 * In particular, find and return the subset of build->options that is of
2327 * the following form
2329 * schedule_domain -> separation_class[[depth] -> [class]]
2331 * The caller is expected to eliminate inner dimensions from the domain.
2333 * Note that the domain of build->options has been reformulated
2334 * in terms of the internal build space in embed_options,
2335 * but the position is still that within the current code generation.
2337 __isl_give isl_map
*isl_ast_build_get_separation_class(
2338 __isl_keep isl_ast_build
*build
)
2341 isl_space
*space_sep
, *space
;
2348 local_pos
= build
->depth
- build
->outer_pos
;
2349 ctx
= isl_ast_build_get_ctx(build
);
2350 space_sep
= isl_space_alloc(ctx
, 0, 1, 1);
2351 space_sep
= isl_space_wrap(space_sep
);
2352 space_sep
= isl_space_set_tuple_name(space_sep
, isl_dim_set
,
2353 "separation_class");
2354 space
= isl_ast_build_get_space(build
, 1);
2355 space_sep
= isl_space_align_params(space_sep
, isl_space_copy(space
));
2356 space
= isl_space_map_from_domain_and_range(space
, space_sep
);
2358 res
= isl_union_map_extract_map(build
->options
, space
);
2359 res
= isl_map_fix_si(res
, isl_dim_out
, 0, local_pos
);
2360 res
= isl_map_coalesce(res
);
2365 /* Eliminate dimensions inner to the current dimension.
2367 __isl_give isl_set
*isl_ast_build_eliminate_inner(
2368 __isl_keep isl_ast_build
*build
, __isl_take isl_set
*set
)
2374 return isl_set_free(set
);
2376 dim
= isl_set_dim(set
, isl_dim_set
);
2377 depth
= build
->depth
;
2378 set
= isl_set_detect_equalities(set
);
2379 set
= isl_set_eliminate(set
, isl_dim_set
, depth
+ 1, dim
- (depth
+ 1));
2384 /* Eliminate unknown divs and divs that depend on the current dimension.
2386 * Note that during the elimination of unknown divs, we may discover
2387 * an explicit representation of some other unknown divs, which may
2388 * depend on the current dimension. We therefore need to eliminate
2389 * unknown divs first.
2391 __isl_give isl_set
*isl_ast_build_eliminate_divs(
2392 __isl_keep isl_ast_build
*build
, __isl_take isl_set
*set
)
2397 return isl_set_free(set
);
2399 set
= isl_set_remove_unknown_divs(set
);
2400 depth
= build
->depth
;
2401 set
= isl_set_remove_divs_involving_dims(set
, isl_dim_set
, depth
, 1);
2406 /* Eliminate dimensions inner to the current dimension as well as
2407 * unknown divs and divs that depend on the current dimension.
2408 * The result then consists only of constraints that are independent
2409 * of the current dimension and upper and lower bounds on the current
2412 __isl_give isl_set
*isl_ast_build_eliminate(
2413 __isl_keep isl_ast_build
*build
, __isl_take isl_set
*domain
)
2415 domain
= isl_ast_build_eliminate_inner(build
, domain
);
2416 domain
= isl_ast_build_eliminate_divs(build
, domain
);
2420 /* Replace build->single_valued by "sv".
2422 __isl_give isl_ast_build
*isl_ast_build_set_single_valued(
2423 __isl_take isl_ast_build
*build
, int sv
)
2427 if (build
->single_valued
== sv
)
2429 build
= isl_ast_build_cow(build
);
2432 build
->single_valued
= sv
;