2 * Copyright 2012 Ecole Normale Superieure
4 * Use of this software is governed by the MIT license
6 * Written by Sven Verdoolaege,
7 * Ecole Normale Superieure, 45 rue d’Ulm, 75230 Paris, France
13 #include <isl_ast_build_private.h>
14 #include <isl_ast_private.h>
16 /* Construct a map that isolates the current dimension.
18 * Essentially, the current dimension of "set" is moved to the single output
19 * dimension in the result, with the current dimension in the domain replaced
20 * by an unconstrained variable.
22 __isl_give isl_map *isl_ast_build_map_to_iterator(
23 __isl_keep isl_ast_build *build, __isl_take isl_set *set)
27 map = isl_map_from_domain(set);
28 map = isl_map_add_dims(map, isl_dim_out, 1);
31 return isl_map_free(map);
33 map = isl_map_equate(map, isl_dim_in, build->depth, isl_dim_out, 0);
34 map = isl_map_eliminate(map, isl_dim_in, build->depth, 1);
39 /* Initialize the information derived during the AST generation to default
40 * values for a schedule domain in "space".
42 * We also check that the remaining fields are not NULL so that
43 * the calling functions don't have to perform this test.
45 static __isl_give isl_ast_build *isl_ast_build_init_derived(
46 __isl_take isl_ast_build *build, __isl_take isl_space *space)
51 build = isl_ast_build_cow(build);
52 if (!build || !build->domain)
55 ctx = isl_ast_build_get_ctx(build);
56 strides = isl_vec_alloc(ctx, isl_space_dim(space, isl_dim_set));
57 strides = isl_vec_set_si(strides, 1);
59 isl_vec_free(build->strides);
60 build->strides = strides;
62 space = isl_space_map_from_set(space);
63 isl_multi_aff_free(build->offsets);
64 build->offsets = isl_multi_aff_zero(isl_space_copy(space));
65 isl_multi_aff_free(build->values);
66 build->values = isl_multi_aff_identity(space);
68 if (!build->iterators || !build->domain || !build->generated ||
69 !build->pending || !build->values ||
70 !build->strides || !build->offsets || !build->options)
71 return isl_ast_build_free(build);
75 isl_space_free(space);
76 return isl_ast_build_free(build);
79 /* Return an isl_id called "c%d", with "%d" set to "i".
80 * If an isl_id with such a name already appears among the parameters
81 * in build->domain, then adjust the name to "c%d_%d".
83 static __isl_give isl_id *generate_name(isl_ctx *ctx, int i,
84 __isl_keep isl_ast_build *build)
88 isl_set *dom = build->domain;
90 snprintf(name, sizeof(name), "c%d", i);
92 while (isl_set_find_dim_by_name(dom, isl_dim_param, name) >= 0)
93 snprintf(name, sizeof(name), "c%d_%d", i, j++);
94 return isl_id_alloc(ctx, name, NULL);
97 /* Create an isl_ast_build with "set" as domain.
99 * The input set is usually a parameter domain, but we currently allow it to
100 * be any kind of set. We set the domain of the returned isl_ast_build
101 * to "set" and initialize all the other field to default values.
103 __isl_give isl_ast_build *isl_ast_build_from_context(__isl_take isl_set *set)
108 isl_ast_build *build;
110 set = isl_set_compute_divs(set);
114 ctx = isl_set_get_ctx(set);
116 build = isl_calloc_type(ctx, isl_ast_build);
122 build->generated = isl_set_copy(build->domain);
123 build->pending = isl_set_universe(isl_set_get_space(build->domain));
124 build->options = isl_union_map_empty(isl_space_params_alloc(ctx, 0));
125 n = isl_set_dim(set, isl_dim_set);
127 build->iterators = isl_id_list_alloc(ctx, n);
128 for (i = 0; i < n; ++i) {
130 if (isl_set_has_dim_id(set, isl_dim_set, i))
131 id = isl_set_get_dim_id(set, isl_dim_set, i);
133 id = generate_name(ctx, i, build);
134 build->iterators = isl_id_list_add(build->iterators, id);
136 space = isl_set_get_space(set);
137 if (isl_space_is_params(space))
138 space = isl_space_set_from_params(space);
140 return isl_ast_build_init_derived(build, space);
146 __isl_give isl_ast_build *isl_ast_build_copy(__isl_keep isl_ast_build *build)
155 __isl_give isl_ast_build *isl_ast_build_dup(__isl_keep isl_ast_build *build)
163 ctx = isl_ast_build_get_ctx(build);
164 dup = isl_calloc_type(ctx, isl_ast_build);
169 dup->outer_pos = build->outer_pos;
170 dup->depth = build->depth;
171 dup->iterators = isl_id_list_copy(build->iterators);
172 dup->domain = isl_set_copy(build->domain);
173 dup->generated = isl_set_copy(build->generated);
174 dup->pending = isl_set_copy(build->pending);
175 dup->values = isl_multi_aff_copy(build->values);
176 dup->value = isl_pw_aff_copy(build->value);
177 dup->strides = isl_vec_copy(build->strides);
178 dup->offsets = isl_multi_aff_copy(build->offsets);
179 dup->executed = isl_union_map_copy(build->executed);
180 dup->options = isl_union_map_copy(build->options);
181 dup->at_each_domain = build->at_each_domain;
182 dup->at_each_domain_user = build->at_each_domain_user;
183 dup->before_each_for = build->before_each_for;
184 dup->before_each_for_user = build->before_each_for_user;
185 dup->after_each_for = build->after_each_for;
186 dup->after_each_for_user = build->after_each_for_user;
187 dup->create_leaf = build->create_leaf;
188 dup->create_leaf_user = build->create_leaf_user;
190 if (!dup->iterators || !dup->domain || !dup->generated ||
191 !dup->pending || !dup->values ||
192 !dup->strides || !dup->offsets || !dup->options ||
193 (build->executed && !dup->executed) ||
194 (build->value && !dup->value))
195 return isl_ast_build_free(dup);
200 /* Align the parameters of "build" to those of "model", introducing
201 * additional parameters if needed.
203 __isl_give isl_ast_build *isl_ast_build_align_params(
204 __isl_take isl_ast_build *build, __isl_take isl_space *model)
206 build = isl_ast_build_cow(build);
210 build->domain = isl_set_align_params(build->domain,
211 isl_space_copy(model));
212 build->generated = isl_set_align_params(build->generated,
213 isl_space_copy(model));
214 build->pending = isl_set_align_params(build->pending,
215 isl_space_copy(model));
216 build->values = isl_multi_aff_align_params(build->values,
217 isl_space_copy(model));
218 build->offsets = isl_multi_aff_align_params(build->offsets,
219 isl_space_copy(model));
220 build->options = isl_union_map_align_params(build->options,
221 isl_space_copy(model));
222 isl_space_free(model);
224 if (!build->domain || !build->values || !build->offsets ||
226 return isl_ast_build_free(build);
230 isl_space_free(model);
234 __isl_give isl_ast_build *isl_ast_build_cow(__isl_take isl_ast_build *build)
242 return isl_ast_build_dup(build);
245 void *isl_ast_build_free(__isl_take isl_ast_build *build)
250 if (--build->ref > 0)
253 isl_id_list_free(build->iterators);
254 isl_set_free(build->domain);
255 isl_set_free(build->generated);
256 isl_set_free(build->pending);
257 isl_multi_aff_free(build->values);
258 isl_pw_aff_free(build->value);
259 isl_vec_free(build->strides);
260 isl_multi_aff_free(build->offsets);
261 isl_multi_aff_free(build->schedule_map);
262 isl_union_map_free(build->executed);
263 isl_union_map_free(build->options);
270 isl_ctx *isl_ast_build_get_ctx(__isl_keep isl_ast_build *build)
272 return build ? isl_set_get_ctx(build->domain) : NULL;
275 /* Replace build->options by "options".
277 __isl_give isl_ast_build *isl_ast_build_set_options(
278 __isl_take isl_ast_build *build, __isl_take isl_union_map *options)
280 build = isl_ast_build_cow(build);
282 if (!build || !options)
285 isl_union_map_free(build->options);
286 build->options = options;
290 isl_union_map_free(options);
291 return isl_ast_build_free(build);
294 /* Set the iterators for the next code generation.
296 * If we still have some iterators left from the previous code generation
297 * (if any) or if iterators have already been set by a previous
298 * call to this function, then we remove them first.
300 __isl_give isl_ast_build *isl_ast_build_set_iterators(
301 __isl_take isl_ast_build *build, __isl_take isl_id_list *iterators)
305 build = isl_ast_build_cow(build);
309 dim = isl_set_dim(build->domain, isl_dim_set);
310 n_it = isl_id_list_n_id(build->iterators);
312 isl_die(isl_ast_build_get_ctx(build), isl_error_internal,
313 "isl_ast_build in inconsistent state", goto error);
315 build->iterators = isl_id_list_drop(build->iterators,
317 build->iterators = isl_id_list_concat(build->iterators, iterators);
318 if (!build->iterators)
319 return isl_ast_build_free(build);
323 isl_id_list_free(iterators);
324 return isl_ast_build_free(build);
327 /* Set the "at_each_domain" callback of "build" to "fn".
329 __isl_give isl_ast_build *isl_ast_build_set_at_each_domain(
330 __isl_take isl_ast_build *build,
331 __isl_give isl_ast_node *(*fn)(__isl_take isl_ast_node *node,
332 __isl_keep isl_ast_build *build, void *user), void *user)
334 build = isl_ast_build_cow(build);
339 build->at_each_domain = fn;
340 build->at_each_domain_user = user;
345 /* Set the "before_each_for" callback of "build" to "fn".
347 __isl_give isl_ast_build *isl_ast_build_set_before_each_for(
348 __isl_take isl_ast_build *build,
349 __isl_give isl_id *(*fn)(__isl_keep isl_ast_build *build,
350 void *user), void *user)
352 build = isl_ast_build_cow(build);
357 build->before_each_for = fn;
358 build->before_each_for_user = user;
363 /* Set the "after_each_for" callback of "build" to "fn".
365 __isl_give isl_ast_build *isl_ast_build_set_after_each_for(
366 __isl_take isl_ast_build *build,
367 __isl_give isl_ast_node *(*fn)(__isl_take isl_ast_node *node,
368 __isl_keep isl_ast_build *build, void *user), void *user)
370 build = isl_ast_build_cow(build);
375 build->after_each_for = fn;
376 build->after_each_for_user = user;
381 /* Set the "create_leaf" callback of "build" to "fn".
383 __isl_give isl_ast_build *isl_ast_build_set_create_leaf(
384 __isl_take isl_ast_build *build,
385 __isl_give isl_ast_node *(*fn)(__isl_take isl_ast_build *build,
386 void *user), void *user)
388 build = isl_ast_build_cow(build);
393 build->create_leaf = fn;
394 build->create_leaf_user = user;
399 /* Clear all information that is specific to this code generation
400 * and that is (probably) not meaningful to any nested code generation.
402 __isl_give isl_ast_build *isl_ast_build_clear_local_info(
403 __isl_take isl_ast_build *build)
407 build = isl_ast_build_cow(build);
411 space = isl_union_map_get_space(build->options);
412 isl_union_map_free(build->options);
413 build->options = isl_union_map_empty(space);
415 build->at_each_domain = NULL;
416 build->at_each_domain_user = NULL;
417 build->before_each_for = NULL;
418 build->before_each_for_user = NULL;
419 build->after_each_for = NULL;
420 build->after_each_for_user = NULL;
421 build->create_leaf = NULL;
422 build->create_leaf_user = NULL;
425 return isl_ast_build_free(build);
430 /* Have any loops been eliminated?
431 * That is, do any of the original schedule dimensions have a fixed
432 * value that has been substituted?
434 static int any_eliminated(isl_ast_build *build)
438 for (i = 0; i < build->depth; ++i)
439 if (isl_ast_build_has_affine_value(build, i))
445 /* Clear build->schedule_map.
446 * This function should be called whenever anything that might affect
447 * the result of isl_ast_build_get_schedule_map_multi_aff changes.
448 * In particular, it should be called when the depth is changed or
449 * when an iterator is determined to have a fixed value.
451 static void isl_ast_build_reset_schedule_map(__isl_keep isl_ast_build *build)
455 isl_multi_aff_free(build->schedule_map);
456 build->schedule_map = NULL;
459 /* Do we need a (non-trivial) schedule map?
460 * That is, is the internal schedule space different from
461 * the external schedule space?
463 * The internal and external schedule spaces are only the same
464 * if code has been generated for the entire schedule and if none
465 * of the loops have been eliminated.
467 __isl_give int isl_ast_build_need_schedule_map(__isl_keep isl_ast_build *build)
474 dim = isl_set_dim(build->domain, isl_dim_set);
475 return build->depth != dim || any_eliminated(build);
478 /* Return a mapping from the internal schedule space to the external
479 * schedule space in the form of an isl_multi_aff.
480 * The internal schedule space originally corresponds to that of the
481 * input schedule. This may change during the code generation if
482 * if isl_ast_build_insert_dim is ever called.
483 * The external schedule space corresponds to the
484 * loops that have been generated.
486 * Currently, the only difference between the internal schedule domain
487 * and the external schedule domain is that some dimensions are projected
488 * out in the external schedule domain. In particular, the dimensions
489 * for which no code has been generated yet and the dimensions that correspond
490 * to eliminated loops.
492 * We cache a copy of the schedule_map in build->schedule_map.
493 * The cache is cleared through isl_ast_build_reset_schedule_map
494 * whenever anything changes that might affect the result of this function.
496 __isl_give isl_multi_aff *isl_ast_build_get_schedule_map_multi_aff(
497 __isl_keep isl_ast_build *build)
504 if (build->schedule_map)
505 return isl_multi_aff_copy(build->schedule_map);
507 space = isl_ast_build_get_space(build, 1);
508 space = isl_space_map_from_set(space);
509 ma = isl_multi_aff_identity(space);
510 if (isl_ast_build_need_schedule_map(build)) {
512 int dim = isl_set_dim(build->domain, isl_dim_set);
513 ma = isl_multi_aff_drop_dims(ma, isl_dim_out,
514 build->depth, dim - build->depth);
515 for (i = build->depth - 1; i >= 0; --i)
516 if (isl_ast_build_has_affine_value(build, i))
517 ma = isl_multi_aff_drop_dims(ma,
521 build->schedule_map = ma;
522 return isl_multi_aff_copy(build->schedule_map);
525 /* Return a mapping from the internal schedule space to the external
526 * schedule space in the form of an isl_map.
528 __isl_give isl_map *isl_ast_build_get_schedule_map(
529 __isl_keep isl_ast_build *build)
533 ma = isl_ast_build_get_schedule_map_multi_aff(build);
534 return isl_map_from_multi_aff(ma);
537 /* Return the position of the dimension in build->domain for which
538 * an AST node is currently being generated.
540 int isl_ast_build_get_depth(__isl_keep isl_ast_build *build)
542 return build ? build->depth : -1;
545 /* Prepare for generating code for the next level.
546 * In particular, increase the depth and reset any information
547 * that is local to the current depth.
549 __isl_give isl_ast_build *isl_ast_build_increase_depth(
550 __isl_take isl_ast_build *build)
552 build = isl_ast_build_cow(build);
556 isl_ast_build_reset_schedule_map(build);
557 build->value = isl_pw_aff_free(build->value);
561 void isl_ast_build_dump(__isl_keep isl_ast_build *build)
566 fprintf(stderr, "domain: ");
567 isl_set_dump(build->domain);
568 fprintf(stderr, "generated: ");
569 isl_set_dump(build->generated);
570 fprintf(stderr, "pending: ");
571 isl_set_dump(build->pending);
572 fprintf(stderr, "iterators: ");
573 isl_id_list_dump(build->iterators);
574 fprintf(stderr, "values: ");
575 isl_multi_aff_dump(build->values);
577 fprintf(stderr, "value: ");
578 isl_pw_aff_dump(build->value);
580 fprintf(stderr, "strides: ");
581 isl_vec_dump(build->strides);
582 fprintf(stderr, "offsets: ");
583 isl_multi_aff_dump(build->offsets);
586 /* Initialize "build" for AST construction in schedule space "space"
587 * in the case that build->domain is a parameter set.
589 * build->iterators is assumed to have been updated already.
591 static __isl_give isl_ast_build *isl_ast_build_init(
592 __isl_take isl_ast_build *build, __isl_take isl_space *space)
596 build = isl_ast_build_cow(build);
600 set = isl_set_universe(isl_space_copy(space));
601 build->domain = isl_set_intersect_params(isl_set_copy(set),
603 build->pending = isl_set_intersect_params(isl_set_copy(set),
605 build->generated = isl_set_intersect_params(set, build->generated);
607 return isl_ast_build_init_derived(build, space);
609 isl_ast_build_free(build);
610 isl_space_free(space);
614 /* Assign "aff" to *user and return -1, effectively extracting
615 * the first (and presumably only) affine expression in the isl_pw_aff
616 * on which this function is used.
618 static int extract_single_piece(__isl_take isl_set *set,
619 __isl_take isl_aff *aff, void *user)
629 /* Check if the given bounds on the current dimension imply that
630 * this current dimension attains only a single value (in terms of
631 * parameters and outer dimensions).
632 * If so, we record it in build->value.
633 * If, moreover, this value can be represented as a single affine expression,
634 * then we also update build->values, effectively marking the current
635 * dimension as "eliminated".
637 * When computing the gist of the fixed value that can be represented
638 * as a single affine expression, it is important to only take into
639 * account the domain constraints in the original AST build and
640 * not the domain of the affine expression itself.
641 * Otherwise, a [i/3] is changed into a i/3 because we know that i
642 * is a multiple of 3, but then we end up not expressing anywhere
643 * in the context that i is a multiple of 3.
645 static __isl_give isl_ast_build *update_values(
646 __isl_take isl_ast_build *build, __isl_take isl_basic_set *bounds)
649 isl_pw_multi_aff *pma;
654 set = isl_set_from_basic_set(bounds);
655 set = isl_set_intersect(set, isl_set_copy(build->domain));
656 it_map = isl_ast_build_map_to_iterator(build, set);
658 sv = isl_map_is_single_valued(it_map);
660 build = isl_ast_build_free(build);
662 isl_map_free(it_map);
666 pma = isl_pw_multi_aff_from_map(it_map);
667 build->value = isl_pw_multi_aff_get_pw_aff(pma, 0);
668 build->value = isl_ast_build_compute_gist_pw_aff(build, build->value);
669 build->value = isl_pw_aff_coalesce(build->value);
670 isl_pw_multi_aff_free(pma);
673 return isl_ast_build_free(build);
675 if (isl_pw_aff_n_piece(build->value) != 1)
678 isl_pw_aff_foreach_piece(build->value, &extract_single_piece, &aff);
680 build->values = isl_multi_aff_set_aff(build->values, build->depth, aff);
682 return isl_ast_build_free(build);
683 isl_ast_build_reset_schedule_map(build);
687 /* Update the AST build based on the given loop bounds for
688 * the current dimension.
690 * We first make sure that the bounds do not refer to any iterators
691 * that have already been eliminated.
692 * Then, we check if the bounds imply that the current iterator
694 * If they do and if this fixed value can be expressed as a single
695 * affine expression, we eliminate the iterators from the bounds.
696 * Note that we cannot simply plug in this single value using
697 * isl_basic_set_preimage_multi_aff as the single value may only
698 * be defined on a subset of the domain. Plugging in the value
699 * would restrict the build domain to this subset, while this
700 * restriction may not be reflected in the generated code.
701 * build->domain may, however, already refer to the current dimension
702 * due an earlier call to isl_ast_build_include_stride. If so, we need
703 * to eliminate the dimension so that we do not introduce it in any other sets.
704 * Finally, we intersect build->domain with the updated bounds.
706 * Note that the check for a fixed value in update_values requires
707 * us to intersect the bounds with the current build domain.
708 * When we intersect build->domain with the updated bounds in
709 * the final step, we make sure that these updated bounds have
710 * not been intersected with the old build->domain.
711 * Otherwise, we would indirectly intersect the build domain with itself,
712 * which can lead to inefficiencies, in particular if the build domain
713 * contains any unknown divs.
715 __isl_give isl_ast_build *isl_ast_build_set_loop_bounds(
716 __isl_take isl_ast_build *build, __isl_take isl_basic_set *bounds)
720 build = isl_ast_build_cow(build);
724 bounds = isl_basic_set_preimage_multi_aff(bounds,
725 isl_multi_aff_copy(build->values));
726 build = update_values(build, isl_basic_set_copy(bounds));
729 set = isl_set_from_basic_set(isl_basic_set_copy(bounds));
730 if (isl_ast_build_has_affine_value(build, build->depth)) {
731 set = isl_set_eliminate(set, isl_dim_set, build->depth, 1);
732 set = isl_set_compute_divs(set);
733 build->pending = isl_set_intersect(build->pending,
735 if (isl_ast_build_has_stride(build, build->depth))
736 build->domain = isl_set_eliminate(build->domain,
737 isl_dim_set, build->depth, 1);
739 isl_basic_set *generated, *pending;
741 pending = isl_basic_set_copy(bounds);
742 pending = isl_basic_set_drop_constraints_involving_dims(pending,
743 isl_dim_set, build->depth, 1);
744 build->pending = isl_set_intersect(build->pending,
745 isl_set_from_basic_set(pending));
746 generated = isl_basic_set_copy(bounds);
747 generated = isl_basic_set_drop_constraints_not_involving_dims(
748 generated, isl_dim_set, build->depth, 1);
749 build->generated = isl_set_intersect(build->generated,
750 isl_set_from_basic_set(generated));
752 isl_basic_set_free(bounds);
754 build->domain = isl_set_intersect(build->domain, set);
755 if (!build->domain || !build->pending || !build->generated)
756 return isl_ast_build_free(build);
760 isl_ast_build_free(build);
761 isl_basic_set_free(bounds);
765 /* Update build->domain based on the constraints enforced by inner loops.
767 * The constraints in build->pending may end up not getting generated
768 * if they are implied by "enforced". We therefore reconstruct
769 * build->domain from build->generated and build->pending, dropping
770 * those constraint in build->pending that may not get generated.
772 __isl_give isl_ast_build *isl_ast_build_set_enforced(
773 __isl_take isl_ast_build *build, __isl_take isl_basic_set *enforced)
777 build = isl_ast_build_cow(build);
781 set = isl_set_from_basic_set(enforced);
782 set = isl_set_gist(isl_set_copy(build->pending), set);
783 set = isl_set_intersect(isl_set_copy(build->generated), set);
785 isl_set_free(build->domain);
789 return isl_ast_build_free(build);
793 isl_basic_set_free(enforced);
794 return isl_ast_build_free(build);
797 /* Intersect build->domain with "set", where "set" is specified
798 * in terms of the internal schedule domain.
800 static __isl_give isl_ast_build *isl_ast_build_restrict_internal(
801 __isl_take isl_ast_build *build, __isl_take isl_set *set)
803 build = isl_ast_build_cow(build);
807 set = isl_set_compute_divs(set);
808 build->domain = isl_set_intersect(build->domain, set);
809 build->domain = isl_set_coalesce(build->domain);
812 return isl_ast_build_free(build);
816 isl_ast_build_free(build);
821 /* Intersect build->generated and build->domain with "set",
822 * where "set" is specified in terms of the internal schedule domain.
824 __isl_give isl_ast_build *isl_ast_build_restrict_generated(
825 __isl_take isl_ast_build *build, __isl_take isl_set *set)
827 set = isl_set_compute_divs(set);
828 build = isl_ast_build_restrict_internal(build, isl_set_copy(set));
829 build = isl_ast_build_cow(build);
833 build->generated = isl_set_intersect(build->generated, set);
834 build->generated = isl_set_coalesce(build->generated);
836 if (!build->generated)
837 return isl_ast_build_free(build);
841 isl_ast_build_free(build);
846 /* Intersect build->pending and build->domain with "set",
847 * where "set" is specified in terms of the internal schedule domain.
849 __isl_give isl_ast_build *isl_ast_build_restrict_pending(
850 __isl_take isl_ast_build *build, __isl_take isl_set *set)
852 set = isl_set_compute_divs(set);
853 build = isl_ast_build_restrict_internal(build, isl_set_copy(set));
854 build = isl_ast_build_cow(build);
858 build->pending = isl_set_intersect(build->pending, set);
859 build->pending = isl_set_coalesce(build->pending);
862 return isl_ast_build_free(build);
866 isl_ast_build_free(build);
871 /* Intersect build->domain with "set", where "set" is specified
872 * in terms of the external schedule domain.
874 __isl_give isl_ast_build *isl_ast_build_restrict(
875 __isl_take isl_ast_build *build, __isl_take isl_set *set)
877 if (isl_set_is_params(set))
878 return isl_ast_build_restrict_generated(build, set);
880 if (isl_ast_build_need_schedule_map(build)) {
882 ma = isl_ast_build_get_schedule_map_multi_aff(build);
883 set = isl_set_preimage_multi_aff(set, ma);
885 return isl_ast_build_restrict_generated(build, set);
888 /* Replace build->executed by "executed".
890 __isl_give isl_ast_build *isl_ast_build_set_executed(
891 __isl_take isl_ast_build *build, __isl_take isl_union_map *executed)
893 build = isl_ast_build_cow(build);
897 isl_union_map_free(build->executed);
898 build->executed = executed;
902 isl_ast_build_free(build);
903 isl_union_map_free(executed);
907 /* Return a copy of the current schedule domain.
909 __isl_give isl_set *isl_ast_build_get_domain(__isl_keep isl_ast_build *build)
911 return build ? isl_set_copy(build->domain) : NULL;
914 /* Return the (schedule) space of "build".
916 * If "internal" is set, then this space is the space of the internal
917 * representation of the entire schedule, including those parts for
918 * which no code has been generated yet.
920 * If "internal" is not set, then this space is the external representation
921 * of the loops generated so far.
923 __isl_give isl_space *isl_ast_build_get_space(__isl_keep isl_ast_build *build,
933 space = isl_set_get_space(build->domain);
937 if (!isl_ast_build_need_schedule_map(build))
940 dim = isl_set_dim(build->domain, isl_dim_set);
941 space = isl_space_drop_dims(space, isl_dim_set,
942 build->depth, dim - build->depth);
943 for (i = build->depth - 1; i >= 0; --i)
944 if (isl_ast_build_has_affine_value(build, i))
945 space = isl_space_drop_dims(space, isl_dim_set, i, 1);
950 /* Return the external representation of the schedule space of "build",
951 * i.e., a space with a dimension for each loop generated so far,
952 * with the names of the dimensions set to the loop iterators.
954 __isl_give isl_space *isl_ast_build_get_schedule_space(
955 __isl_keep isl_ast_build *build)
963 space = isl_ast_build_get_space(build, 0);
966 for (i = 0; i < build->depth; ++i) {
969 if (isl_ast_build_has_affine_value(build, i)) {
974 id = isl_ast_build_get_iterator_id(build, i);
975 space = isl_space_set_dim_id(space, isl_dim_set, i - skip, id);
981 /* Return the current schedule, as stored in build->executed, in terms
982 * of the external schedule domain.
984 __isl_give isl_union_map *isl_ast_build_get_schedule(
985 __isl_keep isl_ast_build *build)
987 isl_union_map *executed;
988 isl_union_map *schedule;
993 executed = isl_union_map_copy(build->executed);
994 if (isl_ast_build_need_schedule_map(build)) {
995 isl_map *proj = isl_ast_build_get_schedule_map(build);
996 executed = isl_union_map_apply_domain(executed,
997 isl_union_map_from_map(proj));
999 schedule = isl_union_map_reverse(executed);
1004 /* Return the iterator attached to the internal schedule dimension "pos".
1006 __isl_give isl_id *isl_ast_build_get_iterator_id(
1007 __isl_keep isl_ast_build *build, int pos)
1012 return isl_id_list_get_id(build->iterators, pos);
1015 /* Set the stride and offset of the current dimension to the given
1016 * value and expression.
1018 static __isl_give isl_ast_build *set_stride(__isl_take isl_ast_build *build,
1019 isl_int stride, __isl_take isl_aff *offset)
1023 build = isl_ast_build_cow(build);
1024 if (!build || !offset)
1028 build->strides = isl_vec_set_element(build->strides, pos, stride);
1029 build->offsets = isl_multi_aff_set_aff(build->offsets, pos, offset);
1030 if (!build->strides || !build->offsets)
1031 return isl_ast_build_free(build);
1035 isl_aff_free(offset);
1036 return isl_ast_build_free(build);
1039 /* Return a set expressing the stride constraint at the current depth.
1041 * In particular, if the current iterator (i) is known to attain values
1045 * where f is the offset and s is the stride, then the returned set
1046 * expresses the constraint
1050 __isl_give isl_set *isl_ast_build_get_stride_constraint(
1051 __isl_keep isl_ast_build *build)
1063 if (!isl_ast_build_has_stride(build, pos))
1064 return isl_set_universe(isl_ast_build_get_space(build, 1));
1066 isl_int_init(stride);
1068 isl_ast_build_get_stride(build, pos, &stride);
1069 aff = isl_ast_build_get_offset(build, pos);
1070 aff = isl_aff_add_coefficient_si(aff, isl_dim_in, pos, -1);
1071 aff = isl_aff_mod(aff, stride);
1072 set = isl_set_from_basic_set(isl_aff_zero_basic_set(aff));
1074 isl_int_clear(stride);
1079 /* Return the expansion implied by the stride and offset at the current
1082 * That is, return the mapping
1084 * [i_0, ..., i_{d-1}, i_d, i_{d+1}, ...]
1085 * -> [i_0, ..., i_{d-1}, s * i_d + offset(i), i_{d+1}, ...]
1087 * where s is the stride at the current depth d and offset(i) is
1088 * the corresponding offset.
1090 __isl_give isl_multi_aff *isl_ast_build_get_stride_expansion(
1091 __isl_keep isl_ast_build *build)
1096 isl_aff *aff, *offset;
1102 pos = isl_ast_build_get_depth(build);
1103 space = isl_ast_build_get_space(build, 1);
1104 space = isl_space_map_from_set(space);
1105 ma = isl_multi_aff_identity(space);
1107 if (!isl_ast_build_has_stride(build, pos))
1110 isl_int_init(stride);
1111 offset = isl_ast_build_get_offset(build, pos);
1112 isl_ast_build_get_stride(build, pos, &stride);
1113 aff = isl_multi_aff_get_aff(ma, pos);
1114 aff = isl_aff_scale(aff, stride);
1115 aff = isl_aff_add(aff, offset);
1116 ma = isl_multi_aff_set_aff(ma, pos, aff);
1117 isl_int_clear(stride);
1122 /* Add constraints corresponding to any previously detected
1123 * stride on the current dimension to build->domain.
1125 __isl_give isl_ast_build *isl_ast_build_include_stride(
1126 __isl_take isl_ast_build *build)
1132 if (!isl_ast_build_has_stride(build, build->depth))
1134 build = isl_ast_build_cow(build);
1138 set = isl_ast_build_get_stride_constraint(build);
1140 build->domain = isl_set_intersect(build->domain, isl_set_copy(set));
1141 build->generated = isl_set_intersect(build->generated, set);
1142 if (!build->domain || !build->generated)
1143 return isl_ast_build_free(build);
1148 /* Compute x, y and g such that g = gcd(a,b) and a*x+b*y = g */
1149 static void euclid(isl_int a, isl_int b, isl_int *x, isl_int *y, isl_int *g)
1151 isl_int c, d, e, f, tmp;
1160 isl_int_set_si(e, 1);
1161 isl_int_set_si(f, 0);
1162 while (isl_int_is_pos(d)) {
1163 isl_int_tdiv_q(tmp, c, d);
1164 isl_int_mul(tmp, tmp, f);
1165 isl_int_sub(e, e, tmp);
1166 isl_int_tdiv_q(tmp, c, d);
1167 isl_int_mul(tmp, tmp, d);
1168 isl_int_sub(c, c, tmp);
1173 if (isl_int_is_zero(a))
1174 isl_int_set_si(*x, 0);
1175 else if (isl_int_is_pos(a))
1179 if (isl_int_is_zero(b))
1180 isl_int_set_si(*y, 0);
1182 isl_int_mul(tmp, a, *x);
1183 isl_int_sub(tmp, c, tmp);
1184 isl_int_divexact(*y, tmp, b);
1193 /* Information used inside detect_stride.
1195 * "build" may be updated by detect_stride to include stride information.
1196 * "pos" is equal to build->depth.
1198 struct isl_detect_stride_data {
1199 isl_ast_build *build;
1203 /* Check if constraint "c" imposes any stride on dimension data->pos
1204 * and, if so, update the stride information in data->build.
1206 * In order to impose a stride on the dimension, "c" needs to be an equality
1207 * and it needs to involve the dimension. Note that "c" may also be
1208 * a div constraint and thus an inequality that we cannot use.
1210 * Let c be of the form
1212 * h(p) + g * v * i + g * stride * f(alpha) = 0
1214 * with h(p) an expression in terms of the parameters and outer dimensions
1215 * and f(alpha) an expression in terms of the existentially quantified
1216 * variables. Note that the inner dimensions have been eliminated so
1217 * they do not appear in "c".
1219 * If "stride" is not zero and not one, then it represents a non-trivial stride
1220 * on "i". We compute a and b such that
1222 * a v + b stride = 1
1226 * g v i = -h(p) + g stride f(alpha)
1228 * a g v i = -a h(p) + g stride f(alpha)
1230 * a g v i + b g stride i = -a h(p) + g stride * (...)
1232 * g i = -a h(p) + g stride * (...)
1234 * i = -a h(p)/g + stride * (...)
1236 * The expression "-a h(p)/g" can therefore be used as offset.
1238 static int detect_stride(__isl_take isl_constraint *c, void *user)
1240 struct isl_detect_stride_data *data = user;
1242 isl_int v, gcd, stride, a, b, m;
1244 if (!isl_constraint_is_equality(c) ||
1245 !isl_constraint_involves_dims(c, isl_dim_set, data->pos, 1)) {
1246 isl_constraint_free(c);
1255 isl_int_init(stride);
1257 isl_int_set_si(gcd, 0);
1258 n_div = isl_constraint_dim(c, isl_dim_div);
1259 for (i = 0; i < n_div; ++i) {
1260 isl_constraint_get_coefficient(c, isl_dim_div, i, &v);
1261 isl_int_gcd(gcd, gcd, v);
1264 isl_constraint_get_coefficient(c, isl_dim_set, data->pos, &v);
1265 isl_int_gcd(m, v, gcd);
1266 isl_int_divexact(stride, gcd, m);
1267 isl_int_divexact(v, v, m);
1269 if (!isl_int_is_zero(stride) && !isl_int_is_one(stride)) {
1272 euclid(v, stride, &a, &b, &gcd);
1274 aff = isl_constraint_get_aff(c);
1275 for (i = 0; i < n_div; ++i)
1276 aff = isl_aff_set_coefficient_si(aff,
1278 aff = isl_aff_set_coefficient_si(aff, isl_dim_in, data->pos, 0);
1280 aff = isl_aff_scale(aff, a);
1281 aff = isl_aff_scale_down(aff, m);
1282 data->build = set_stride(data->build, stride, aff);
1285 isl_int_clear(stride);
1292 isl_constraint_free(c);
1296 /* Check if the constraints in "set" imply any stride on the current
1297 * dimension and, if so, record the stride information in "build"
1298 * and return the updated "build".
1300 * We compute the affine hull and then check if any of the constraints
1301 * in the hull imposes any stride on the current dimension.
1303 * We assume that inner dimensions have been eliminated from "set"
1304 * by the caller. This is needed because the common stride
1305 * may be imposed by different inner dimensions on different parts of
1308 __isl_give isl_ast_build *isl_ast_build_detect_strides(
1309 __isl_take isl_ast_build *build, __isl_take isl_set *set)
1311 isl_basic_set *hull;
1312 struct isl_detect_stride_data data;
1318 data.pos = isl_ast_build_get_depth(build);
1319 hull = isl_set_affine_hull(set);
1321 if (isl_basic_set_foreach_constraint(hull, &detect_stride, &data) < 0)
1322 data.build = isl_ast_build_free(data.build);
1324 isl_basic_set_free(hull);
1331 struct isl_ast_build_involves_data {
1336 /* Check if "map" involves the input dimension data->depth.
1338 static int involves_depth(__isl_take isl_map *map, void *user)
1340 struct isl_ast_build_involves_data *data = user;
1342 data->involves = isl_map_involves_dims(map, isl_dim_in, data->depth, 1);
1345 if (data->involves < 0 || data->involves)
1350 /* Do any options depend on the value of the dimension at the current depth?
1352 int isl_ast_build_options_involve_depth(__isl_keep isl_ast_build *build)
1354 struct isl_ast_build_involves_data data;
1359 data.depth = build->depth;
1362 if (isl_union_map_foreach_map(build->options,
1363 &involves_depth, &data) < 0) {
1364 if (data.involves < 0 || !data.involves)
1368 return data.involves;
1371 /* Construct the map
1373 * { [i] -> [i] : i < pos; [i] -> [i + 1] : i >= pos }
1375 * with "space" the parameter space of the constructed map.
1377 static __isl_give isl_map *construct_insertion_map(__isl_take isl_space *space,
1381 isl_basic_map *bmap1, *bmap2;
1383 space = isl_space_set_from_params(space);
1384 space = isl_space_add_dims(space, isl_dim_set, 1);
1385 space = isl_space_map_from_set(space);
1386 c = isl_equality_alloc(isl_local_space_from_space(space));
1387 c = isl_constraint_set_coefficient_si(c, isl_dim_in, 0, 1);
1388 c = isl_constraint_set_coefficient_si(c, isl_dim_out, 0, -1);
1389 bmap1 = isl_basic_map_from_constraint(isl_constraint_copy(c));
1390 c = isl_constraint_set_constant_si(c, 1);
1391 bmap2 = isl_basic_map_from_constraint(c);
1393 bmap1 = isl_basic_map_upper_bound_si(bmap1, isl_dim_in, 0, pos - 1);
1394 bmap2 = isl_basic_map_lower_bound_si(bmap2, isl_dim_in, 0, pos);
1396 return isl_basic_map_union(bmap1, bmap2);
1399 static const char *option_str[] = {
1400 [atomic] = "atomic",
1401 [unroll] = "unroll",
1402 [separate] = "separate"
1405 /* Update the "options" to reflect the insertion of a dimension
1406 * at position "pos" in the schedule domain space.
1407 * "space" is the original domain space before the insertion and
1408 * may be named and/or structured.
1410 * The (relevant) input options all have "space" as domain, which
1411 * has to be mapped to the extended space.
1412 * The values of the ranges also refer to the schedule domain positions
1413 * and they therefore also need to be adjusted. In particular, values
1414 * smaller than pos do not need to change, while values greater than or
1415 * equal to pos need to be incremented.
1416 * That is, we need to apply the following map.
1418 * { atomic[i] -> atomic[i] : i < pos; [i] -> [i + 1] : i >= pos;
1419 * unroll[i] -> unroll[i] : i < pos; [i] -> [i + 1] : i >= pos;
1420 * separate[i] -> separate[i] : i < pos; [i] -> [i + 1] : i >= pos;
1421 * separation_class[[i] -> [c]]
1422 * -> separation_class[[i] -> [c]] : i < pos;
1423 * separation_class[[i] -> [c]]
1424 * -> separation_class[[i + 1] -> [c]] : i >= pos }
1426 static __isl_give isl_union_map *options_insert_dim(
1427 __isl_take isl_union_map *options, __isl_take isl_space *space, int pos)
1430 isl_union_map *insertion;
1431 enum isl_ast_build_domain_type type;
1432 const char *name = "separation_class";
1434 space = isl_space_map_from_set(space);
1435 map = isl_map_identity(space);
1436 map = isl_map_insert_dims(map, isl_dim_out, pos, 1);
1437 options = isl_union_map_apply_domain(options,
1438 isl_union_map_from_map(map));
1443 map = construct_insertion_map(isl_union_map_get_space(options), pos);
1445 insertion = isl_union_map_empty(isl_union_map_get_space(options));
1447 for (type = atomic; type <= separate; ++type) {
1448 isl_map *map_type = isl_map_copy(map);
1449 const char *name = option_str[type];
1450 map_type = isl_map_set_tuple_name(map_type, isl_dim_in, name);
1451 map_type = isl_map_set_tuple_name(map_type, isl_dim_out, name);
1452 insertion = isl_union_map_add_map(insertion, map_type);
1455 map = isl_map_product(map, isl_map_identity(isl_map_get_space(map)));
1456 map = isl_map_set_tuple_name(map, isl_dim_in, name);
1457 map = isl_map_set_tuple_name(map, isl_dim_out, name);
1458 insertion = isl_union_map_add_map(insertion, map);
1460 options = isl_union_map_apply_range(options, insertion);
1465 /* Insert a single dimension in the schedule domain at position "pos".
1466 * The new dimension is given an isl_id with the empty string as name.
1468 * The main difficulty is updating build->options to reflect the
1469 * extra dimension. This is handled in options_insert_dim.
1471 * Note that because of the dimension manipulations, the resulting
1472 * schedule domain space will always be unnamed and unstructured.
1473 * However, the original schedule domain space may be named and/or
1474 * structured, so we have to take this possibility into account
1475 * while performing the transformations.
1477 __isl_give isl_ast_build *isl_ast_build_insert_dim(
1478 __isl_take isl_ast_build *build, int pos)
1481 isl_space *space, *ma_space;
1485 build = isl_ast_build_cow(build);
1489 ctx = isl_ast_build_get_ctx(build);
1490 id = isl_id_alloc(ctx, "", NULL);
1491 space = isl_ast_build_get_space(build, 1);
1492 build->iterators = isl_id_list_insert(build->iterators, pos, id);
1493 build->domain = isl_set_insert_dims(build->domain,
1494 isl_dim_set, pos, 1);
1495 build->generated = isl_set_insert_dims(build->generated,
1496 isl_dim_set, pos, 1);
1497 build->pending = isl_set_insert_dims(build->pending,
1498 isl_dim_set, pos, 1);
1499 build->strides = isl_vec_insert_els(build->strides, pos, 1);
1500 build->strides = isl_vec_set_element_si(build->strides, pos, 1);
1501 ma_space = isl_space_params(isl_multi_aff_get_space(build->offsets));
1502 ma_space = isl_space_set_from_params(ma_space);
1503 ma_space = isl_space_add_dims(ma_space, isl_dim_set, 1);
1504 ma_space = isl_space_map_from_set(ma_space);
1505 ma = isl_multi_aff_zero(isl_space_copy(ma_space));
1506 build->offsets = isl_multi_aff_splice(build->offsets, pos, pos, ma);
1507 ma = isl_multi_aff_identity(ma_space);
1508 build->values = isl_multi_aff_splice(build->values, pos, pos, ma);
1509 build->options = options_insert_dim(build->options, space, pos);
1511 if (!build->iterators || !build->domain || !build->generated ||
1512 !build->pending || !build->values ||
1513 !build->strides || !build->offsets || !build->options)
1514 return isl_ast_build_free(build);
1519 /* Scale down the current dimension by a factor of "m".
1520 * "umap" is an isl_union_map that implements the scaling down.
1521 * That is, it is of the form
1523 * { [.... i ....] -> [.... i' ....] : i = m i' }
1525 * This function is called right after the strides have been
1526 * detected, but before any constraints on the current dimension
1527 * have been included in build->domain.
1528 * We therefore only need to update stride, offset and the options.
1530 __isl_give isl_ast_build *isl_ast_build_scale_down(
1531 __isl_take isl_ast_build *build, isl_int m,
1532 __isl_take isl_union_map *umap)
1538 build = isl_ast_build_cow(build);
1539 if (!build || !umap)
1542 depth = build->depth;
1545 if (isl_vec_get_element(build->strides, depth, &v) < 0)
1546 build->strides = isl_vec_free(build->strides);
1547 isl_int_divexact(v, v, m);
1548 build->strides = isl_vec_set_element(build->strides, depth, v);
1551 aff = isl_multi_aff_get_aff(build->offsets, depth);
1552 aff = isl_aff_scale_down(aff, m);
1553 build->offsets = isl_multi_aff_set_aff(build->offsets, depth, aff);
1554 build->options = isl_union_map_apply_domain(build->options, umap);
1555 if (!build->strides || !build->offsets || !build->options)
1556 return isl_ast_build_free(build);
1560 isl_union_map_free(umap);
1561 return isl_ast_build_free(build);
1564 /* Return a list of "n" isl_ids called "c%d", with "%d" starting at "first".
1565 * If an isl_id with such a name already appears among the parameters
1566 * in build->domain, then adjust the name to "c%d_%d".
1568 static __isl_give isl_id_list *generate_names(isl_ctx *ctx, int n, int first,
1569 __isl_keep isl_ast_build *build)
1574 names = isl_id_list_alloc(ctx, n);
1575 for (i = 0; i < n; ++i) {
1578 id = generate_name(ctx, first + i, build);
1579 names = isl_id_list_add(names, id);
1585 /* Embed "options" into the given isl_ast_build space.
1587 * This function is called from within a nested call to
1588 * isl_ast_build_ast_from_schedule.
1589 * "options" refers to the additional schedule,
1590 * while space refers to both the space of the outer isl_ast_build and
1591 * that of the additional schedule.
1592 * Specifically, space is of the form
1596 * while options lives in the space(s)
1604 * and compose this with options, to obtain the new options
1605 * living in the space(s)
1609 static __isl_give isl_union_map *embed_options(
1610 __isl_take isl_union_map *options, __isl_take isl_space *space)
1614 map = isl_map_universe(isl_space_unwrap(space));
1615 map = isl_map_range_map(map);
1617 options = isl_union_map_apply_range(
1618 isl_union_map_from_map(map), options);
1623 /* Update "build" for use in a (possibly nested) code generation. That is,
1624 * extend "build" from an AST build on some domain O to an AST build
1625 * on domain [O -> S], with S corresponding to "space".
1626 * If the original domain is a parameter domain, then the new domain is
1628 * "iterators" is a list of iterators for S, but the number of elements
1629 * may be smaller or greater than the number of set dimensions of S.
1630 * If "keep_iterators" is set, then any extra ids in build->iterators
1631 * are reused for S. Otherwise, these extra ids are dropped.
1633 * We first update build->outer_pos to the current depth.
1634 * This depth is zero in case this is the outermost code generation.
1636 * We then add additional ids such that the number of iterators is at least
1637 * equal to the dimension of the new build domain.
1639 * If the original domain is parametric, then we are constructing
1640 * an isl_ast_build for the outer code generation and we pass control
1641 * to isl_ast_build_init.
1643 * Otherwise, we adjust the fields of "build" to include "space".
1645 __isl_give isl_ast_build *isl_ast_build_product(
1646 __isl_take isl_ast_build *build, __isl_take isl_space *space)
1651 isl_multi_aff *embedding;
1654 build = isl_ast_build_cow(build);
1658 build->outer_pos = build->depth;
1660 ctx = isl_ast_build_get_ctx(build);
1661 dim = isl_set_dim(build->domain, isl_dim_set);
1662 dim += isl_space_dim(space, isl_dim_set);
1663 n_it = isl_id_list_n_id(build->iterators);
1666 l = generate_names(ctx, dim - n_it, n_it, build);
1667 build->iterators = isl_id_list_concat(build->iterators, l);
1670 if (isl_set_is_params(build->domain))
1671 return isl_ast_build_init(build, space);
1673 set = isl_set_universe(isl_space_copy(space));
1674 build->domain = isl_set_product(build->domain, isl_set_copy(set));
1675 build->pending = isl_set_product(build->pending, isl_set_copy(set));
1676 build->generated = isl_set_product(build->generated, set);
1678 strides = isl_vec_alloc(ctx, isl_space_dim(space, isl_dim_set));
1679 strides = isl_vec_set_si(strides, 1);
1680 build->strides = isl_vec_concat(build->strides, strides);
1682 space = isl_space_map_from_set(space);
1683 build->offsets = isl_multi_aff_align_params(build->offsets,
1684 isl_space_copy(space));
1685 build->offsets = isl_multi_aff_product(build->offsets,
1686 isl_multi_aff_zero(isl_space_copy(space)));
1687 build->values = isl_multi_aff_align_params(build->values,
1688 isl_space_copy(space));
1689 embedding = isl_multi_aff_identity(space);
1690 build->values = isl_multi_aff_product(build->values, embedding);
1692 space = isl_ast_build_get_space(build, 1);
1693 build->options = embed_options(build->options, space);
1695 if (!build->iterators || !build->domain || !build->generated ||
1696 !build->pending || !build->values ||
1697 !build->strides || !build->offsets || !build->options)
1698 return isl_ast_build_free(build);
1702 isl_ast_build_free(build);
1703 isl_space_free(space);
1707 /* Does "aff" only attain non-negative values over build->domain?
1708 * That is, does it not attain any negative values?
1710 int isl_ast_build_aff_is_nonneg(__isl_keep isl_ast_build *build,
1711 __isl_keep isl_aff *aff)
1719 aff = isl_aff_copy(aff);
1720 test = isl_set_from_basic_set(isl_aff_neg_basic_set(aff));
1721 test = isl_set_intersect(test, isl_set_copy(build->domain));
1722 empty = isl_set_is_empty(test);
1728 /* Does the dimension at (internal) position "pos" have a non-trivial stride?
1730 int isl_ast_build_has_stride(__isl_keep isl_ast_build *build, int pos)
1739 isl_vec_get_element(build->strides, pos, &v);
1740 has_stride = !isl_int_is_one(v);
1746 /* Given that the dimension at position "pos" takes on values
1750 * with a an integer, return s through *stride.
1752 int isl_ast_build_get_stride(__isl_keep isl_ast_build *build, int pos,
1758 isl_vec_get_element(build->strides, pos, stride);
1763 /* Given that the dimension at position "pos" takes on values
1767 * with a an integer, return f.
1769 __isl_give isl_aff *isl_ast_build_get_offset(
1770 __isl_keep isl_ast_build *build, int pos)
1775 return isl_multi_aff_get_aff(build->offsets, pos);
1778 /* Is the dimension at position "pos" known to attain only a single
1779 * value that, moreover, can be described by a single affine expression
1780 * in terms of the outer dimensions and parameters?
1782 * If not, then the correponding affine expression in build->values
1783 * is set to be equal to the same input dimension.
1784 * Otherwise, it is set to the requested expression in terms of
1785 * outer dimensions and parameters.
1787 int isl_ast_build_has_affine_value(__isl_keep isl_ast_build *build,
1796 aff = isl_multi_aff_get_aff(build->values, pos);
1797 involves = isl_aff_involves_dims(aff, isl_dim_in, pos, 1);
1806 /* Is the current dimension known to attain only a single value?
1808 int isl_ast_build_has_value(__isl_keep isl_ast_build *build)
1813 return build->value != NULL;
1816 /* Simplify the basic set "bset" based on what we know about
1817 * the iterators of already generated loops.
1819 * "bset" is assumed to live in the (internal) schedule domain.
1821 __isl_give isl_basic_set *isl_ast_build_compute_gist_basic_set(
1822 __isl_keep isl_ast_build *build, __isl_take isl_basic_set *bset)
1827 bset = isl_basic_set_preimage_multi_aff(bset,
1828 isl_multi_aff_copy(build->values));
1829 bset = isl_basic_set_gist(bset,
1830 isl_set_simple_hull(isl_set_copy(build->domain)));
1834 isl_basic_set_free(bset);
1838 /* Simplify the set "set" based on what we know about
1839 * the iterators of already generated loops.
1841 * "set" is assumed to live in the (internal) schedule domain.
1843 __isl_give isl_set *isl_ast_build_compute_gist(
1844 __isl_keep isl_ast_build *build, __isl_take isl_set *set)
1849 set = isl_set_preimage_multi_aff(set,
1850 isl_multi_aff_copy(build->values));
1851 set = isl_set_gist(set, isl_set_copy(build->domain));
1859 /* Simplify the map "map" based on what we know about
1860 * the iterators of already generated loops.
1862 * The domain of "map" is assumed to live in the (internal) schedule domain.
1864 __isl_give isl_map *isl_ast_build_compute_gist_map_domain(
1865 __isl_keep isl_ast_build *build, __isl_take isl_map *map)
1870 map = isl_map_gist_domain(map, isl_set_copy(build->domain));
1878 /* Simplify the affine expression "aff" based on what we know about
1879 * the iterators of already generated loops.
1881 * The domain of "aff" is assumed to live in the (internal) schedule domain.
1883 __isl_give isl_aff *isl_ast_build_compute_gist_aff(
1884 __isl_keep isl_ast_build *build, __isl_take isl_aff *aff)
1889 aff = isl_aff_gist(aff, isl_set_copy(build->domain));
1897 /* Simplify the piecewise affine expression "aff" based on what we know about
1898 * the iterators of already generated loops.
1900 * The domain of "pa" is assumed to live in the (internal) schedule domain.
1902 __isl_give isl_pw_aff *isl_ast_build_compute_gist_pw_aff(
1903 __isl_keep isl_ast_build *build, __isl_take isl_pw_aff *pa)
1908 pa = isl_pw_aff_pullback_multi_aff(pa,
1909 isl_multi_aff_copy(build->values));
1910 pa = isl_pw_aff_gist(pa, isl_set_copy(build->domain));
1914 isl_pw_aff_free(pa);
1918 /* Simplify the piecewise multi-affine expression "aff" based on what
1919 * we know about the iterators of already generated loops.
1921 * The domain of "pma" is assumed to live in the (internal) schedule domain.
1923 __isl_give isl_pw_multi_aff *isl_ast_build_compute_gist_pw_multi_aff(
1924 __isl_keep isl_ast_build *build, __isl_take isl_pw_multi_aff *pma)
1929 pma = isl_pw_multi_aff_pullback_multi_aff(pma,
1930 isl_multi_aff_copy(build->values));
1931 pma = isl_pw_multi_aff_gist(pma, isl_set_copy(build->domain));
1935 isl_pw_multi_aff_free(pma);
1939 /* Extract the schedule domain of the given type from build->options
1940 * at the current depth.
1942 * In particular, find the subset of build->options that is of
1943 * the following form
1945 * schedule_domain -> type[depth]
1947 * and return the corresponding domain, after eliminating inner dimensions
1948 * and divs that depend on the current dimension.
1950 * Note that the domain of build->options has been reformulated
1951 * in terms of the internal build space in embed_options,
1952 * but the position is still that within the current code generation.
1954 __isl_give isl_set *isl_ast_build_get_option_domain(
1955 __isl_keep isl_ast_build *build,
1956 enum isl_ast_build_domain_type type)
1967 name = option_str[type];
1968 local_pos = build->depth - build->outer_pos;
1970 space = isl_ast_build_get_space(build, 1);
1971 space = isl_space_from_domain(space);
1972 space = isl_space_add_dims(space, isl_dim_out, 1);
1973 space = isl_space_set_tuple_name(space, isl_dim_out, name);
1975 option = isl_union_map_extract_map(build->options, space);
1976 option = isl_map_fix_si(option, isl_dim_out, 0, local_pos);
1978 domain = isl_map_domain(option);
1979 domain = isl_ast_build_eliminate(build, domain);
1984 /* Extract the separation class mapping at the current depth.
1986 * In particular, find and return the subset of build->options that is of
1987 * the following form
1989 * schedule_domain -> separation_class[[depth] -> [class]]
1991 * The caller is expected to eliminate inner dimensions from the domain.
1993 * Note that the domain of build->options has been reformulated
1994 * in terms of the internal build space in embed_options,
1995 * but the position is still that within the current code generation.
1997 __isl_give isl_map *isl_ast_build_get_separation_class(
1998 __isl_keep isl_ast_build *build)
2001 isl_space *space_sep, *space;
2008 local_pos = build->depth - build->outer_pos;
2009 ctx = isl_ast_build_get_ctx(build);
2010 space_sep = isl_space_alloc(ctx, 0, 1, 1);
2011 space_sep = isl_space_wrap(space_sep);
2012 space_sep = isl_space_set_tuple_name(space_sep, isl_dim_set,
2013 "separation_class");
2014 space = isl_ast_build_get_space(build, 1);
2015 space_sep = isl_space_align_params(space_sep, isl_space_copy(space));
2016 space = isl_space_map_from_domain_and_range(space, space_sep);
2018 res = isl_union_map_extract_map(build->options, space);
2019 res = isl_map_fix_si(res, isl_dim_out, 0, local_pos);
2020 res = isl_map_coalesce(res);
2025 /* Eliminate dimensions inner to the current dimension.
2027 __isl_give isl_set *isl_ast_build_eliminate_inner(
2028 __isl_keep isl_ast_build *build, __isl_take isl_set *set)
2034 return isl_set_free(set);
2036 dim = isl_set_dim(set, isl_dim_set);
2037 depth = build->depth;
2038 set = isl_set_detect_equalities(set);
2039 set = isl_set_eliminate(set, isl_dim_set, depth + 1, dim - (depth + 1));
2044 /* Eliminate unknown divs and divs that depend on the current dimension.
2046 * Note that during the elimination of unknown divs, we may discover
2047 * an explicit representation of some other unknown divs, which may
2048 * depend on the current dimension. We therefore need to eliminate
2049 * unknown divs first.
2051 __isl_give isl_set *isl_ast_build_eliminate_divs(
2052 __isl_keep isl_ast_build *build, __isl_take isl_set *set)
2057 return isl_set_free(set);
2059 set = isl_set_remove_unknown_divs(set);
2060 depth = build->depth;
2061 set = isl_set_remove_divs_involving_dims(set, isl_dim_set, depth, 1);
2066 /* Eliminate dimensions inner to the current dimension as well as
2067 * unknown divs and divs that depend on the current dimension.
2068 * The result then consists only of constraints that are independent
2069 * of the current dimension and upper and lower bounds on the current
2072 __isl_give isl_set *isl_ast_build_eliminate(
2073 __isl_keep isl_ast_build *build, __isl_take isl_set *domain)
2075 domain = isl_ast_build_eliminate_inner(build, domain);
2076 domain = isl_ast_build_eliminate_divs(build, domain);