isl_schedule_constraints_compute_schedule: optionally avoid loop coalescing
[isl.git] / isl_ast_build.c
blob9418006fd145b42f0da93cd7bc59cb1e804e2be8
1 /*
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
13 #include <isl/map.h>
14 #include <isl/aff.h>
15 #include <isl/constraint.h>
16 #include <isl/map.h>
17 #include <isl/union_set.h>
18 #include <isl/union_map.h>
19 #include <isl_ast_build_private.h>
20 #include <isl_ast_private.h>
21 #include <isl_config.h>
23 /* Construct a map that isolates the current dimension.
25 * Essentially, the current dimension of "set" is moved to the single output
26 * dimension in the result, with the current dimension in the domain replaced
27 * by an unconstrained variable.
29 __isl_give isl_map *isl_ast_build_map_to_iterator(
30 __isl_keep isl_ast_build *build, __isl_take isl_set *set)
32 isl_map *map;
34 map = isl_map_from_domain(set);
35 map = isl_map_add_dims(map, isl_dim_out, 1);
37 if (!build)
38 return isl_map_free(map);
40 map = isl_map_equate(map, isl_dim_in, build->depth, isl_dim_out, 0);
41 map = isl_map_eliminate(map, isl_dim_in, build->depth, 1);
43 return map;
46 /* Initialize the information derived during the AST generation to default
47 * values for a schedule domain in "space".
49 * We also check that the remaining fields are not NULL so that
50 * the calling functions don't have to perform this test.
52 static __isl_give isl_ast_build *isl_ast_build_init_derived(
53 __isl_take isl_ast_build *build, __isl_take isl_space *space)
55 isl_ctx *ctx;
56 isl_vec *strides;
58 build = isl_ast_build_cow(build);
59 if (!build || !build->domain)
60 goto error;
62 ctx = isl_ast_build_get_ctx(build);
63 strides = isl_vec_alloc(ctx, isl_space_dim(space, isl_dim_set));
64 strides = isl_vec_set_si(strides, 1);
66 isl_vec_free(build->strides);
67 build->strides = strides;
69 space = isl_space_map_from_set(space);
70 isl_multi_aff_free(build->offsets);
71 build->offsets = isl_multi_aff_zero(isl_space_copy(space));
72 isl_multi_aff_free(build->values);
73 build->values = isl_multi_aff_identity(isl_space_copy(space));
74 isl_multi_aff_free(build->internal2input);
75 build->internal2input = isl_multi_aff_identity(space);
77 if (!build->iterators || !build->domain || !build->generated ||
78 !build->pending || !build->values || !build->internal2input ||
79 !build->strides || !build->offsets || !build->options)
80 return isl_ast_build_free(build);
82 return build;
83 error:
84 isl_space_free(space);
85 return isl_ast_build_free(build);
88 /* Return an isl_id called "c%d", with "%d" set to "i".
89 * If an isl_id with such a name already appears among the parameters
90 * in build->domain, then adjust the name to "c%d_%d".
92 static __isl_give isl_id *generate_name(isl_ctx *ctx, int i,
93 __isl_keep isl_ast_build *build)
95 int j;
96 char name[16];
97 isl_set *dom = build->domain;
99 snprintf(name, sizeof(name), "c%d", i);
100 j = 0;
101 while (isl_set_find_dim_by_name(dom, isl_dim_param, name) >= 0)
102 snprintf(name, sizeof(name), "c%d_%d", i, j++);
103 return isl_id_alloc(ctx, name, NULL);
106 /* Create an isl_ast_build with "set" as domain.
108 * The input set is usually a parameter domain, but we currently allow it to
109 * be any kind of set. We set the domain of the returned isl_ast_build
110 * to "set" and initialize all the other fields to default values.
112 __isl_give isl_ast_build *isl_ast_build_from_context(__isl_take isl_set *set)
114 int i, n;
115 isl_ctx *ctx;
116 isl_space *space;
117 isl_ast_build *build;
119 set = isl_set_compute_divs(set);
120 if (!set)
121 return NULL;
123 ctx = isl_set_get_ctx(set);
125 build = isl_calloc_type(ctx, isl_ast_build);
126 if (!build)
127 goto error;
129 build->ref = 1;
130 build->domain = set;
131 build->generated = isl_set_copy(build->domain);
132 build->pending = isl_set_universe(isl_set_get_space(build->domain));
133 build->options = isl_union_map_empty(isl_space_params_alloc(ctx, 0));
134 n = isl_set_dim(set, isl_dim_set);
135 build->depth = n;
136 build->iterators = isl_id_list_alloc(ctx, n);
137 for (i = 0; i < n; ++i) {
138 isl_id *id;
139 if (isl_set_has_dim_id(set, isl_dim_set, i))
140 id = isl_set_get_dim_id(set, isl_dim_set, i);
141 else
142 id = generate_name(ctx, i, build);
143 build->iterators = isl_id_list_add(build->iterators, id);
145 space = isl_set_get_space(set);
146 if (isl_space_is_params(space))
147 space = isl_space_set_from_params(space);
149 return isl_ast_build_init_derived(build, space);
150 error:
151 isl_set_free(set);
152 return NULL;
155 /* Create an isl_ast_build with a universe (parametric) context.
157 __isl_give isl_ast_build *isl_ast_build_alloc(isl_ctx *ctx)
159 isl_space *space;
160 isl_set *context;
162 space = isl_space_params_alloc(ctx, 0);
163 context = isl_set_universe(space);
165 return isl_ast_build_from_context(context);
168 __isl_give isl_ast_build *isl_ast_build_copy(__isl_keep isl_ast_build *build)
170 if (!build)
171 return NULL;
173 build->ref++;
174 return build;
177 __isl_give isl_ast_build *isl_ast_build_dup(__isl_keep isl_ast_build *build)
179 isl_ctx *ctx;
180 isl_ast_build *dup;
182 if (!build)
183 return NULL;
185 ctx = isl_ast_build_get_ctx(build);
186 dup = isl_calloc_type(ctx, isl_ast_build);
187 if (!dup)
188 return NULL;
190 dup->ref = 1;
191 dup->outer_pos = build->outer_pos;
192 dup->depth = build->depth;
193 dup->iterators = isl_id_list_copy(build->iterators);
194 dup->domain = isl_set_copy(build->domain);
195 dup->generated = isl_set_copy(build->generated);
196 dup->pending = isl_set_copy(build->pending);
197 dup->values = isl_multi_aff_copy(build->values);
198 dup->internal2input = isl_multi_aff_copy(build->internal2input);
199 dup->value = isl_pw_aff_copy(build->value);
200 dup->strides = isl_vec_copy(build->strides);
201 dup->offsets = isl_multi_aff_copy(build->offsets);
202 dup->executed = isl_union_map_copy(build->executed);
203 dup->single_valued = build->single_valued;
204 dup->options = isl_union_map_copy(build->options);
205 dup->at_each_domain = build->at_each_domain;
206 dup->at_each_domain_user = build->at_each_domain_user;
207 dup->before_each_for = build->before_each_for;
208 dup->before_each_for_user = build->before_each_for_user;
209 dup->after_each_for = build->after_each_for;
210 dup->after_each_for_user = build->after_each_for_user;
211 dup->before_each_mark = build->before_each_mark;
212 dup->before_each_mark_user = build->before_each_mark_user;
213 dup->after_each_mark = build->after_each_mark;
214 dup->after_each_mark_user = build->after_each_mark_user;
215 dup->create_leaf = build->create_leaf;
216 dup->create_leaf_user = build->create_leaf_user;
217 dup->node = isl_schedule_node_copy(build->node);
218 if (build->loop_type) {
219 int i;
221 dup->n = build->n;
222 dup->loop_type = isl_alloc_array(ctx,
223 enum isl_ast_loop_type, dup->n);
224 if (dup->n && !dup->loop_type)
225 return isl_ast_build_free(dup);
226 for (i = 0; i < dup->n; ++i)
227 dup->loop_type[i] = build->loop_type[i];
230 if (!dup->iterators || !dup->domain || !dup->generated ||
231 !dup->pending || !dup->values ||
232 !dup->strides || !dup->offsets || !dup->options ||
233 (build->internal2input && !dup->internal2input) ||
234 (build->executed && !dup->executed) ||
235 (build->value && !dup->value) ||
236 (build->node && !dup->node))
237 return isl_ast_build_free(dup);
239 return dup;
242 /* Align the parameters of "build" to those of "model", introducing
243 * additional parameters if needed.
245 __isl_give isl_ast_build *isl_ast_build_align_params(
246 __isl_take isl_ast_build *build, __isl_take isl_space *model)
248 build = isl_ast_build_cow(build);
249 if (!build)
250 goto error;
252 build->domain = isl_set_align_params(build->domain,
253 isl_space_copy(model));
254 build->generated = isl_set_align_params(build->generated,
255 isl_space_copy(model));
256 build->pending = isl_set_align_params(build->pending,
257 isl_space_copy(model));
258 build->values = isl_multi_aff_align_params(build->values,
259 isl_space_copy(model));
260 build->offsets = isl_multi_aff_align_params(build->offsets,
261 isl_space_copy(model));
262 build->options = isl_union_map_align_params(build->options,
263 isl_space_copy(model));
264 if (build->internal2input) {
265 build->internal2input =
266 isl_multi_aff_align_params(build->internal2input,
267 model);
268 if (!build->internal2input)
269 return isl_ast_build_free(build);
270 } else {
271 isl_space_free(model);
274 if (!build->domain || !build->values || !build->offsets ||
275 !build->options)
276 return isl_ast_build_free(build);
278 return build;
279 error:
280 isl_space_free(model);
281 return NULL;
284 __isl_give isl_ast_build *isl_ast_build_cow(__isl_take isl_ast_build *build)
286 if (!build)
287 return NULL;
289 if (build->ref == 1)
290 return build;
291 build->ref--;
292 return isl_ast_build_dup(build);
295 __isl_null isl_ast_build *isl_ast_build_free(
296 __isl_take isl_ast_build *build)
298 if (!build)
299 return NULL;
301 if (--build->ref > 0)
302 return NULL;
304 isl_id_list_free(build->iterators);
305 isl_set_free(build->domain);
306 isl_set_free(build->generated);
307 isl_set_free(build->pending);
308 isl_multi_aff_free(build->values);
309 isl_multi_aff_free(build->internal2input);
310 isl_pw_aff_free(build->value);
311 isl_vec_free(build->strides);
312 isl_multi_aff_free(build->offsets);
313 isl_multi_aff_free(build->schedule_map);
314 isl_union_map_free(build->executed);
315 isl_union_map_free(build->options);
316 isl_schedule_node_free(build->node);
317 free(build->loop_type);
318 isl_set_free(build->isolated);
320 free(build);
322 return NULL;
325 isl_ctx *isl_ast_build_get_ctx(__isl_keep isl_ast_build *build)
327 return build ? isl_set_get_ctx(build->domain) : NULL;
330 /* Replace build->options by "options".
332 __isl_give isl_ast_build *isl_ast_build_set_options(
333 __isl_take isl_ast_build *build, __isl_take isl_union_map *options)
335 build = isl_ast_build_cow(build);
337 if (!build || !options)
338 goto error;
340 isl_union_map_free(build->options);
341 build->options = options;
343 return build;
344 error:
345 isl_union_map_free(options);
346 return isl_ast_build_free(build);
349 /* Set the iterators for the next code generation.
351 * If we still have some iterators left from the previous code generation
352 * (if any) or if iterators have already been set by a previous
353 * call to this function, then we remove them first.
355 __isl_give isl_ast_build *isl_ast_build_set_iterators(
356 __isl_take isl_ast_build *build, __isl_take isl_id_list *iterators)
358 int dim, n_it;
360 build = isl_ast_build_cow(build);
361 if (!build)
362 goto error;
364 dim = isl_set_dim(build->domain, isl_dim_set);
365 n_it = isl_id_list_n_id(build->iterators);
366 if (n_it < dim)
367 isl_die(isl_ast_build_get_ctx(build), isl_error_internal,
368 "isl_ast_build in inconsistent state", goto error);
369 if (n_it > dim)
370 build->iterators = isl_id_list_drop(build->iterators,
371 dim, n_it - dim);
372 build->iterators = isl_id_list_concat(build->iterators, iterators);
373 if (!build->iterators)
374 return isl_ast_build_free(build);
376 return build;
377 error:
378 isl_id_list_free(iterators);
379 return isl_ast_build_free(build);
382 /* Set the "at_each_domain" callback of "build" to "fn".
384 __isl_give isl_ast_build *isl_ast_build_set_at_each_domain(
385 __isl_take isl_ast_build *build,
386 __isl_give isl_ast_node *(*fn)(__isl_take isl_ast_node *node,
387 __isl_keep isl_ast_build *build, void *user), void *user)
389 build = isl_ast_build_cow(build);
391 if (!build)
392 return NULL;
394 build->at_each_domain = fn;
395 build->at_each_domain_user = user;
397 return build;
400 /* Set the "before_each_for" callback of "build" to "fn".
402 __isl_give isl_ast_build *isl_ast_build_set_before_each_for(
403 __isl_take isl_ast_build *build,
404 __isl_give isl_id *(*fn)(__isl_keep isl_ast_build *build,
405 void *user), void *user)
407 build = isl_ast_build_cow(build);
409 if (!build)
410 return NULL;
412 build->before_each_for = fn;
413 build->before_each_for_user = user;
415 return build;
418 /* Set the "after_each_for" callback of "build" to "fn".
420 __isl_give isl_ast_build *isl_ast_build_set_after_each_for(
421 __isl_take isl_ast_build *build,
422 __isl_give isl_ast_node *(*fn)(__isl_take isl_ast_node *node,
423 __isl_keep isl_ast_build *build, void *user), void *user)
425 build = isl_ast_build_cow(build);
427 if (!build)
428 return NULL;
430 build->after_each_for = fn;
431 build->after_each_for_user = user;
433 return build;
436 /* Set the "before_each_mark" callback of "build" to "fn".
438 __isl_give isl_ast_build *isl_ast_build_set_before_each_mark(
439 __isl_take isl_ast_build *build,
440 isl_stat (*fn)(__isl_keep isl_id *mark, __isl_keep isl_ast_build *build,
441 void *user), void *user)
443 build = isl_ast_build_cow(build);
445 if (!build)
446 return NULL;
448 build->before_each_mark = fn;
449 build->before_each_mark_user = user;
451 return build;
454 /* Set the "after_each_mark" callback of "build" to "fn".
456 __isl_give isl_ast_build *isl_ast_build_set_after_each_mark(
457 __isl_take isl_ast_build *build,
458 __isl_give isl_ast_node *(*fn)(__isl_take isl_ast_node *node,
459 __isl_keep isl_ast_build *build, void *user), void *user)
461 build = isl_ast_build_cow(build);
463 if (!build)
464 return NULL;
466 build->after_each_mark = fn;
467 build->after_each_mark_user = user;
469 return build;
472 /* Set the "create_leaf" callback of "build" to "fn".
474 __isl_give isl_ast_build *isl_ast_build_set_create_leaf(
475 __isl_take isl_ast_build *build,
476 __isl_give isl_ast_node *(*fn)(__isl_take isl_ast_build *build,
477 void *user), void *user)
479 build = isl_ast_build_cow(build);
481 if (!build)
482 return NULL;
484 build->create_leaf = fn;
485 build->create_leaf_user = user;
487 return build;
490 /* Clear all information that is specific to this code generation
491 * and that is (probably) not meaningful to any nested code generation.
493 __isl_give isl_ast_build *isl_ast_build_clear_local_info(
494 __isl_take isl_ast_build *build)
496 isl_space *space;
498 build = isl_ast_build_cow(build);
499 if (!build)
500 return NULL;
502 space = isl_union_map_get_space(build->options);
503 isl_union_map_free(build->options);
504 build->options = isl_union_map_empty(space);
506 build->at_each_domain = NULL;
507 build->at_each_domain_user = NULL;
508 build->before_each_for = NULL;
509 build->before_each_for_user = NULL;
510 build->after_each_for = NULL;
511 build->after_each_for_user = NULL;
512 build->before_each_mark = NULL;
513 build->before_each_mark_user = NULL;
514 build->after_each_mark = NULL;
515 build->after_each_mark_user = NULL;
516 build->create_leaf = NULL;
517 build->create_leaf_user = NULL;
519 if (!build->options)
520 return isl_ast_build_free(build);
522 return build;
525 /* Have any loops been eliminated?
526 * That is, do any of the original schedule dimensions have a fixed
527 * value that has been substituted?
529 static int any_eliminated(isl_ast_build *build)
531 int i;
533 for (i = 0; i < build->depth; ++i)
534 if (isl_ast_build_has_affine_value(build, i))
535 return 1;
537 return 0;
540 /* Clear build->schedule_map.
541 * This function should be called whenever anything that might affect
542 * the result of isl_ast_build_get_schedule_map_multi_aff changes.
543 * In particular, it should be called when the depth is changed or
544 * when an iterator is determined to have a fixed value.
546 static void isl_ast_build_reset_schedule_map(__isl_keep isl_ast_build *build)
548 if (!build)
549 return;
550 isl_multi_aff_free(build->schedule_map);
551 build->schedule_map = NULL;
554 /* Do we need a (non-trivial) schedule map?
555 * That is, is the internal schedule space different from
556 * the external schedule space?
558 * The internal and external schedule spaces are only the same
559 * if code has been generated for the entire schedule and if none
560 * of the loops have been eliminated.
562 __isl_give int isl_ast_build_need_schedule_map(__isl_keep isl_ast_build *build)
564 int dim;
566 if (!build)
567 return -1;
569 dim = isl_set_dim(build->domain, isl_dim_set);
570 return build->depth != dim || any_eliminated(build);
573 /* Return a mapping from the internal schedule space to the external
574 * schedule space in the form of an isl_multi_aff.
575 * The internal schedule space originally corresponds to that of the
576 * input schedule. This may change during the code generation if
577 * if isl_ast_build_insert_dim is ever called.
578 * The external schedule space corresponds to the
579 * loops that have been generated.
581 * Currently, the only difference between the internal schedule domain
582 * and the external schedule domain is that some dimensions are projected
583 * out in the external schedule domain. In particular, the dimensions
584 * for which no code has been generated yet and the dimensions that correspond
585 * to eliminated loops.
587 * We cache a copy of the schedule_map in build->schedule_map.
588 * The cache is cleared through isl_ast_build_reset_schedule_map
589 * whenever anything changes that might affect the result of this function.
591 __isl_give isl_multi_aff *isl_ast_build_get_schedule_map_multi_aff(
592 __isl_keep isl_ast_build *build)
594 isl_space *space;
595 isl_multi_aff *ma;
597 if (!build)
598 return NULL;
599 if (build->schedule_map)
600 return isl_multi_aff_copy(build->schedule_map);
602 space = isl_ast_build_get_space(build, 1);
603 space = isl_space_map_from_set(space);
604 ma = isl_multi_aff_identity(space);
605 if (isl_ast_build_need_schedule_map(build)) {
606 int i;
607 int dim = isl_set_dim(build->domain, isl_dim_set);
608 ma = isl_multi_aff_drop_dims(ma, isl_dim_out,
609 build->depth, dim - build->depth);
610 for (i = build->depth - 1; i >= 0; --i)
611 if (isl_ast_build_has_affine_value(build, i))
612 ma = isl_multi_aff_drop_dims(ma,
613 isl_dim_out, i, 1);
616 build->schedule_map = ma;
617 return isl_multi_aff_copy(build->schedule_map);
620 /* Return a mapping from the internal schedule space to the external
621 * schedule space in the form of an isl_map.
623 __isl_give isl_map *isl_ast_build_get_schedule_map(
624 __isl_keep isl_ast_build *build)
626 isl_multi_aff *ma;
628 ma = isl_ast_build_get_schedule_map_multi_aff(build);
629 return isl_map_from_multi_aff(ma);
632 /* Return the position of the dimension in build->domain for which
633 * an AST node is currently being generated.
635 int isl_ast_build_get_depth(__isl_keep isl_ast_build *build)
637 return build ? build->depth : -1;
640 /* Prepare for generating code for the next level.
641 * In particular, increase the depth and reset any information
642 * that is local to the current depth.
644 __isl_give isl_ast_build *isl_ast_build_increase_depth(
645 __isl_take isl_ast_build *build)
647 build = isl_ast_build_cow(build);
648 if (!build)
649 return NULL;
650 build->depth++;
651 isl_ast_build_reset_schedule_map(build);
652 build->value = isl_pw_aff_free(build->value);
653 return build;
656 void isl_ast_build_dump(__isl_keep isl_ast_build *build)
658 if (!build)
659 return;
661 fprintf(stderr, "domain: ");
662 isl_set_dump(build->domain);
663 fprintf(stderr, "generated: ");
664 isl_set_dump(build->generated);
665 fprintf(stderr, "pending: ");
666 isl_set_dump(build->pending);
667 fprintf(stderr, "iterators: ");
668 isl_id_list_dump(build->iterators);
669 fprintf(stderr, "values: ");
670 isl_multi_aff_dump(build->values);
671 if (build->value) {
672 fprintf(stderr, "value: ");
673 isl_pw_aff_dump(build->value);
675 fprintf(stderr, "strides: ");
676 isl_vec_dump(build->strides);
677 fprintf(stderr, "offsets: ");
678 isl_multi_aff_dump(build->offsets);
679 fprintf(stderr, "internal2input: ");
680 isl_multi_aff_dump(build->internal2input);
683 /* Initialize "build" for AST construction in schedule space "space"
684 * in the case that build->domain is a parameter set.
686 * build->iterators is assumed to have been updated already.
688 static __isl_give isl_ast_build *isl_ast_build_init(
689 __isl_take isl_ast_build *build, __isl_take isl_space *space)
691 isl_set *set;
693 build = isl_ast_build_cow(build);
694 if (!build)
695 goto error;
697 set = isl_set_universe(isl_space_copy(space));
698 build->domain = isl_set_intersect_params(isl_set_copy(set),
699 build->domain);
700 build->pending = isl_set_intersect_params(isl_set_copy(set),
701 build->pending);
702 build->generated = isl_set_intersect_params(set, build->generated);
704 return isl_ast_build_init_derived(build, space);
705 error:
706 isl_ast_build_free(build);
707 isl_space_free(space);
708 return NULL;
711 /* Assign "aff" to *user and return -1, effectively extracting
712 * the first (and presumably only) affine expression in the isl_pw_aff
713 * on which this function is used.
715 static isl_stat extract_single_piece(__isl_take isl_set *set,
716 __isl_take isl_aff *aff, void *user)
718 isl_aff **p = user;
720 *p = aff;
721 isl_set_free(set);
723 return isl_stat_error;
726 /* Intersect "set" with the stride constraint of "build", if any.
728 static __isl_give isl_set *intersect_stride_constraint(__isl_take isl_set *set,
729 __isl_keep isl_ast_build *build)
731 isl_set *stride;
733 if (!build)
734 return isl_set_free(set);
735 if (!isl_ast_build_has_stride(build, build->depth))
736 return set;
738 stride = isl_ast_build_get_stride_constraint(build);
739 return isl_set_intersect(set, stride);
742 /* Check if the given bounds on the current dimension (together with
743 * the stride constraint, if any) imply that
744 * this current dimension attains only a single value (in terms of
745 * parameters and outer dimensions).
746 * If so, we record it in build->value.
747 * If, moreover, this value can be represented as a single affine expression,
748 * then we also update build->values, effectively marking the current
749 * dimension as "eliminated".
751 * When computing the gist of the fixed value that can be represented
752 * as a single affine expression, it is important to only take into
753 * account the domain constraints in the original AST build and
754 * not the domain of the affine expression itself.
755 * Otherwise, a [i/3] is changed into a i/3 because we know that i
756 * is a multiple of 3, but then we end up not expressing anywhere
757 * in the context that i is a multiple of 3.
759 static __isl_give isl_ast_build *update_values(
760 __isl_take isl_ast_build *build, __isl_take isl_basic_set *bounds)
762 int sv;
763 isl_pw_multi_aff *pma;
764 isl_aff *aff = NULL;
765 isl_map *it_map;
766 isl_set *set;
768 set = isl_set_from_basic_set(bounds);
769 set = isl_set_intersect(set, isl_set_copy(build->domain));
770 set = intersect_stride_constraint(set, build);
771 it_map = isl_ast_build_map_to_iterator(build, set);
773 sv = isl_map_is_single_valued(it_map);
774 if (sv < 0)
775 build = isl_ast_build_free(build);
776 if (!build || !sv) {
777 isl_map_free(it_map);
778 return build;
781 pma = isl_pw_multi_aff_from_map(it_map);
782 build->value = isl_pw_multi_aff_get_pw_aff(pma, 0);
783 build->value = isl_ast_build_compute_gist_pw_aff(build, build->value);
784 build->value = isl_pw_aff_coalesce(build->value);
785 isl_pw_multi_aff_free(pma);
787 if (!build->value)
788 return isl_ast_build_free(build);
790 if (isl_pw_aff_n_piece(build->value) != 1)
791 return build;
793 isl_pw_aff_foreach_piece(build->value, &extract_single_piece, &aff);
795 build->values = isl_multi_aff_set_aff(build->values, build->depth, aff);
796 if (!build->values)
797 return isl_ast_build_free(build);
798 isl_ast_build_reset_schedule_map(build);
799 return build;
802 /* Update the AST build based on the given loop bounds for
803 * the current dimension and the stride information available in the build.
805 * We first make sure that the bounds do not refer to any iterators
806 * that have already been eliminated.
807 * Then, we check if the bounds imply that the current iterator
808 * has a fixed value.
809 * If they do and if this fixed value can be expressed as a single
810 * affine expression, we eliminate the iterators from the bounds.
811 * Note that we cannot simply plug in this single value using
812 * isl_basic_set_preimage_multi_aff as the single value may only
813 * be defined on a subset of the domain. Plugging in the value
814 * would restrict the build domain to this subset, while this
815 * restriction may not be reflected in the generated code.
816 * Finally, we intersect build->domain with the updated bounds.
817 * We also add the stride constraint unless we have been able
818 * to find a fixed value expressed as a single affine expression.
820 * Note that the check for a fixed value in update_values requires
821 * us to intersect the bounds with the current build domain.
822 * When we intersect build->domain with the updated bounds in
823 * the final step, we make sure that these updated bounds have
824 * not been intersected with the old build->domain.
825 * Otherwise, we would indirectly intersect the build domain with itself,
826 * which can lead to inefficiencies, in particular if the build domain
827 * contains any unknown divs.
829 * The pending and generated sets are not updated by this function to
830 * match the updated domain.
831 * The caller still needs to call isl_ast_build_set_pending_generated.
833 __isl_give isl_ast_build *isl_ast_build_set_loop_bounds(
834 __isl_take isl_ast_build *build, __isl_take isl_basic_set *bounds)
836 isl_set *set;
838 build = isl_ast_build_cow(build);
839 if (!build)
840 goto error;
842 build = update_values(build, isl_basic_set_copy(bounds));
843 if (!build)
844 goto error;
845 set = isl_set_from_basic_set(bounds);
846 if (isl_ast_build_has_affine_value(build, build->depth)) {
847 set = isl_set_eliminate(set, isl_dim_set, build->depth, 1);
848 set = isl_set_compute_divs(set);
849 build->pending = isl_set_intersect(build->pending,
850 isl_set_copy(set));
851 build->domain = isl_set_intersect(build->domain, set);
852 } else {
853 build->domain = isl_set_intersect(build->domain, set);
854 build = isl_ast_build_include_stride(build);
855 if (!build)
856 goto error;
859 if (!build->domain || !build->pending || !build->generated)
860 return isl_ast_build_free(build);
862 return build;
863 error:
864 isl_ast_build_free(build);
865 isl_basic_set_free(bounds);
866 return NULL;
869 /* Update the pending and generated sets of "build" according to "bounds".
870 * If the build has an affine value at the current depth,
871 * then isl_ast_build_set_loop_bounds has already set the pending set.
872 * Otherwise, do it here.
874 __isl_give isl_ast_build *isl_ast_build_set_pending_generated(
875 __isl_take isl_ast_build *build, __isl_take isl_basic_set *bounds)
877 isl_basic_set *generated, *pending;
879 if (!build)
880 goto error;
882 if (isl_ast_build_has_affine_value(build, build->depth)) {
883 isl_basic_set_free(bounds);
884 return build;
887 build = isl_ast_build_cow(build);
888 if (!build)
889 goto error;
891 pending = isl_basic_set_copy(bounds);
892 pending = isl_basic_set_drop_constraints_involving_dims(pending,
893 isl_dim_set, build->depth, 1);
894 build->pending = isl_set_intersect(build->pending,
895 isl_set_from_basic_set(pending));
896 generated = bounds;
897 generated = isl_basic_set_drop_constraints_not_involving_dims(
898 generated, isl_dim_set, build->depth, 1);
899 build->generated = isl_set_intersect(build->generated,
900 isl_set_from_basic_set(generated));
902 if (!build->pending || !build->generated)
903 return isl_ast_build_free(build);
905 return build;
906 error:
907 isl_ast_build_free(build);
908 isl_basic_set_free(bounds);
909 return NULL;
912 /* Intersect build->domain with "set", where "set" is specified
913 * in terms of the internal schedule domain.
915 static __isl_give isl_ast_build *isl_ast_build_restrict_internal(
916 __isl_take isl_ast_build *build, __isl_take isl_set *set)
918 build = isl_ast_build_cow(build);
919 if (!build)
920 goto error;
922 set = isl_set_compute_divs(set);
923 build->domain = isl_set_intersect(build->domain, set);
924 build->domain = isl_set_coalesce(build->domain);
926 if (!build->domain)
927 return isl_ast_build_free(build);
929 return build;
930 error:
931 isl_ast_build_free(build);
932 isl_set_free(set);
933 return NULL;
936 /* Intersect build->generated and build->domain with "set",
937 * where "set" is specified in terms of the internal schedule domain.
939 __isl_give isl_ast_build *isl_ast_build_restrict_generated(
940 __isl_take isl_ast_build *build, __isl_take isl_set *set)
942 set = isl_set_compute_divs(set);
943 build = isl_ast_build_restrict_internal(build, isl_set_copy(set));
944 build = isl_ast_build_cow(build);
945 if (!build)
946 goto error;
948 build->generated = isl_set_intersect(build->generated, set);
949 build->generated = isl_set_coalesce(build->generated);
951 if (!build->generated)
952 return isl_ast_build_free(build);
954 return build;
955 error:
956 isl_ast_build_free(build);
957 isl_set_free(set);
958 return NULL;
961 /* Replace the set of pending constraints by "guard", which is then
962 * no longer considered as pending.
963 * That is, add "guard" to the generated constraints and clear all pending
964 * constraints, making the domain equal to the generated constraints.
966 __isl_give isl_ast_build *isl_ast_build_replace_pending_by_guard(
967 __isl_take isl_ast_build *build, __isl_take isl_set *guard)
969 build = isl_ast_build_restrict_generated(build, guard);
970 build = isl_ast_build_cow(build);
971 if (!build)
972 return NULL;
974 isl_set_free(build->domain);
975 build->domain = isl_set_copy(build->generated);
976 isl_set_free(build->pending);
977 build->pending = isl_set_universe(isl_set_get_space(build->domain));
979 if (!build->pending)
980 return isl_ast_build_free(build);
982 return build;
985 /* Intersect build->domain with "set", where "set" is specified
986 * in terms of the external schedule domain.
988 __isl_give isl_ast_build *isl_ast_build_restrict(
989 __isl_take isl_ast_build *build, __isl_take isl_set *set)
991 if (isl_set_is_params(set))
992 return isl_ast_build_restrict_generated(build, set);
994 if (isl_ast_build_need_schedule_map(build)) {
995 isl_multi_aff *ma;
996 ma = isl_ast_build_get_schedule_map_multi_aff(build);
997 set = isl_set_preimage_multi_aff(set, ma);
999 return isl_ast_build_restrict_generated(build, set);
1002 /* Replace build->executed by "executed".
1004 __isl_give isl_ast_build *isl_ast_build_set_executed(
1005 __isl_take isl_ast_build *build, __isl_take isl_union_map *executed)
1007 build = isl_ast_build_cow(build);
1008 if (!build)
1009 goto error;
1011 isl_union_map_free(build->executed);
1012 build->executed = executed;
1014 return build;
1015 error:
1016 isl_ast_build_free(build);
1017 isl_union_map_free(executed);
1018 return NULL;
1021 /* Does "build" point to a band node?
1022 * That is, are we currently handling a band node inside a schedule tree?
1024 int isl_ast_build_has_schedule_node(__isl_keep isl_ast_build *build)
1026 if (!build)
1027 return -1;
1028 return build->node != NULL;
1031 /* Return a copy of the band node that "build" refers to.
1033 __isl_give isl_schedule_node *isl_ast_build_get_schedule_node(
1034 __isl_keep isl_ast_build *build)
1036 if (!build)
1037 return NULL;
1038 return isl_schedule_node_copy(build->node);
1041 /* Extract the loop AST generation types for the members of build->node
1042 * and store them in build->loop_type.
1044 static __isl_give isl_ast_build *extract_loop_types(
1045 __isl_take isl_ast_build *build)
1047 int i;
1048 isl_ctx *ctx;
1049 isl_schedule_node *node;
1051 if (!build)
1052 return NULL;
1053 ctx = isl_ast_build_get_ctx(build);
1054 if (!build->node)
1055 isl_die(ctx, isl_error_internal, "missing AST node",
1056 return isl_ast_build_free(build));
1058 free(build->loop_type);
1059 build->n = isl_schedule_node_band_n_member(build->node);
1060 build->loop_type = isl_alloc_array(ctx,
1061 enum isl_ast_loop_type, build->n);
1062 if (build->n && !build->loop_type)
1063 return isl_ast_build_free(build);
1064 node = build->node;
1065 for (i = 0; i < build->n; ++i)
1066 build->loop_type[i] =
1067 isl_schedule_node_band_member_get_ast_loop_type(node, i);
1069 return build;
1072 /* Replace the band node that "build" refers to by "node" and
1073 * extract the corresponding loop AST generation types.
1075 __isl_give isl_ast_build *isl_ast_build_set_schedule_node(
1076 __isl_take isl_ast_build *build,
1077 __isl_take isl_schedule_node *node)
1079 build = isl_ast_build_cow(build);
1080 if (!build || !node)
1081 goto error;
1083 isl_schedule_node_free(build->node);
1084 build->node = node;
1086 build = extract_loop_types(build);
1088 return build;
1089 error:
1090 isl_ast_build_free(build);
1091 isl_schedule_node_free(node);
1092 return NULL;
1095 /* Remove any reference to a band node from "build".
1097 __isl_give isl_ast_build *isl_ast_build_reset_schedule_node(
1098 __isl_take isl_ast_build *build)
1100 build = isl_ast_build_cow(build);
1101 if (!build)
1102 return NULL;
1104 isl_schedule_node_free(build->node);
1105 build->node = NULL;
1107 return build;
1110 /* Return a copy of the current schedule domain.
1112 __isl_give isl_set *isl_ast_build_get_domain(__isl_keep isl_ast_build *build)
1114 return build ? isl_set_copy(build->domain) : NULL;
1117 /* Return a copy of the set of pending constraints.
1119 __isl_give isl_set *isl_ast_build_get_pending(
1120 __isl_keep isl_ast_build *build)
1122 return build ? isl_set_copy(build->pending) : NULL;
1125 /* Return a copy of the set of generated constraints.
1127 __isl_give isl_set *isl_ast_build_get_generated(
1128 __isl_keep isl_ast_build *build)
1130 return build ? isl_set_copy(build->generated) : NULL;
1133 /* Return a copy of the map from the internal schedule domain
1134 * to the original input schedule domain.
1136 __isl_give isl_multi_aff *isl_ast_build_get_internal2input(
1137 __isl_keep isl_ast_build *build)
1139 return build ? isl_multi_aff_copy(build->internal2input) : NULL;
1142 /* Return the number of variables of the given type
1143 * in the (internal) schedule space.
1145 unsigned isl_ast_build_dim(__isl_keep isl_ast_build *build,
1146 enum isl_dim_type type)
1148 if (!build)
1149 return 0;
1150 return isl_set_dim(build->domain, type);
1153 /* Return the (schedule) space of "build".
1155 * If "internal" is set, then this space is the space of the internal
1156 * representation of the entire schedule, including those parts for
1157 * which no code has been generated yet.
1159 * If "internal" is not set, then this space is the external representation
1160 * of the loops generated so far.
1162 __isl_give isl_space *isl_ast_build_get_space(__isl_keep isl_ast_build *build,
1163 int internal)
1165 int i;
1166 int dim;
1167 isl_space *space;
1169 if (!build)
1170 return NULL;
1172 space = isl_set_get_space(build->domain);
1173 if (internal)
1174 return space;
1176 if (!isl_ast_build_need_schedule_map(build))
1177 return space;
1179 dim = isl_set_dim(build->domain, isl_dim_set);
1180 space = isl_space_drop_dims(space, isl_dim_set,
1181 build->depth, dim - build->depth);
1182 for (i = build->depth - 1; i >= 0; --i)
1183 if (isl_ast_build_has_affine_value(build, i))
1184 space = isl_space_drop_dims(space, isl_dim_set, i, 1);
1186 return space;
1189 /* Return the external representation of the schedule space of "build",
1190 * i.e., a space with a dimension for each loop generated so far,
1191 * with the names of the dimensions set to the loop iterators.
1193 __isl_give isl_space *isl_ast_build_get_schedule_space(
1194 __isl_keep isl_ast_build *build)
1196 isl_space *space;
1197 int i, skip;
1199 if (!build)
1200 return NULL;
1202 space = isl_ast_build_get_space(build, 0);
1204 skip = 0;
1205 for (i = 0; i < build->depth; ++i) {
1206 isl_id *id;
1208 if (isl_ast_build_has_affine_value(build, i)) {
1209 skip++;
1210 continue;
1213 id = isl_ast_build_get_iterator_id(build, i);
1214 space = isl_space_set_dim_id(space, isl_dim_set, i - skip, id);
1217 return space;
1220 /* Return the current schedule, as stored in build->executed, in terms
1221 * of the external schedule domain.
1223 __isl_give isl_union_map *isl_ast_build_get_schedule(
1224 __isl_keep isl_ast_build *build)
1226 isl_union_map *executed;
1227 isl_union_map *schedule;
1229 if (!build)
1230 return NULL;
1232 executed = isl_union_map_copy(build->executed);
1233 if (isl_ast_build_need_schedule_map(build)) {
1234 isl_map *proj = isl_ast_build_get_schedule_map(build);
1235 executed = isl_union_map_apply_domain(executed,
1236 isl_union_map_from_map(proj));
1238 schedule = isl_union_map_reverse(executed);
1240 return schedule;
1243 /* Return the iterator attached to the internal schedule dimension "pos".
1245 __isl_give isl_id *isl_ast_build_get_iterator_id(
1246 __isl_keep isl_ast_build *build, int pos)
1248 if (!build)
1249 return NULL;
1251 return isl_id_list_get_id(build->iterators, pos);
1254 /* Set the stride and offset of the current dimension to the given
1255 * value and expression.
1257 * If we had already found a stride before, then the two strides
1258 * are combined into a single stride.
1260 * In particular, if the new stride information is of the form
1262 * i = f + s (...)
1264 * and the old stride information is of the form
1266 * i = f2 + s2 (...)
1268 * then we compute the extended gcd of s and s2
1270 * a s + b s2 = g,
1272 * with g = gcd(s,s2), multiply the first equation with t1 = b s2/g
1273 * and the second with t2 = a s1/g.
1274 * This results in
1276 * i = (b s2 + a s1)/g i = t1 f + t2 f2 + (s s2)/g (...)
1278 * so that t1 f + t2 f2 is the combined offset and (s s2)/g = lcm(s,s2)
1279 * is the combined stride.
1281 static __isl_give isl_ast_build *set_stride(__isl_take isl_ast_build *build,
1282 __isl_take isl_val *stride, __isl_take isl_aff *offset)
1284 int pos;
1286 build = isl_ast_build_cow(build);
1287 if (!build || !stride || !offset)
1288 goto error;
1290 pos = build->depth;
1292 if (isl_ast_build_has_stride(build, pos)) {
1293 isl_val *stride2, *a, *b, *g;
1294 isl_aff *offset2;
1296 stride2 = isl_vec_get_element_val(build->strides, pos);
1297 g = isl_val_gcdext(isl_val_copy(stride), isl_val_copy(stride2),
1298 &a, &b);
1299 a = isl_val_mul(a, isl_val_copy(stride));
1300 a = isl_val_div(a, isl_val_copy(g));
1301 stride2 = isl_val_div(stride2, g);
1302 b = isl_val_mul(b, isl_val_copy(stride2));
1303 stride = isl_val_mul(stride, stride2);
1305 offset2 = isl_multi_aff_get_aff(build->offsets, pos);
1306 offset2 = isl_aff_scale_val(offset2, a);
1307 offset = isl_aff_scale_val(offset, b);
1308 offset = isl_aff_add(offset, offset2);
1311 build->strides = isl_vec_set_element_val(build->strides, pos, stride);
1312 build->offsets = isl_multi_aff_set_aff(build->offsets, pos, offset);
1313 if (!build->strides || !build->offsets)
1314 return isl_ast_build_free(build);
1316 return build;
1317 error:
1318 isl_val_free(stride);
1319 isl_aff_free(offset);
1320 return isl_ast_build_free(build);
1323 /* Return a set expressing the stride constraint at the current depth.
1325 * In particular, if the current iterator (i) is known to attain values
1327 * f + s a
1329 * where f is the offset and s is the stride, then the returned set
1330 * expresses the constraint
1332 * (f - i) mod s = 0
1334 __isl_give isl_set *isl_ast_build_get_stride_constraint(
1335 __isl_keep isl_ast_build *build)
1337 isl_aff *aff;
1338 isl_set *set;
1339 isl_val *stride;
1340 int pos;
1342 if (!build)
1343 return NULL;
1345 pos = build->depth;
1347 if (!isl_ast_build_has_stride(build, pos))
1348 return isl_set_universe(isl_ast_build_get_space(build, 1));
1350 stride = isl_ast_build_get_stride(build, pos);
1351 aff = isl_ast_build_get_offset(build, pos);
1352 aff = isl_aff_add_coefficient_si(aff, isl_dim_in, pos, -1);
1353 aff = isl_aff_mod_val(aff, stride);
1354 set = isl_set_from_basic_set(isl_aff_zero_basic_set(aff));
1356 return set;
1359 /* Return the expansion implied by the stride and offset at the current
1360 * depth.
1362 * That is, return the mapping
1364 * [i_0, ..., i_{d-1}, i_d, i_{d+1}, ...]
1365 * -> [i_0, ..., i_{d-1}, s * i_d + offset(i), i_{d+1}, ...]
1367 * where s is the stride at the current depth d and offset(i) is
1368 * the corresponding offset.
1370 __isl_give isl_multi_aff *isl_ast_build_get_stride_expansion(
1371 __isl_keep isl_ast_build *build)
1373 isl_space *space;
1374 isl_multi_aff *ma;
1375 int pos;
1376 isl_aff *aff, *offset;
1377 isl_val *stride;
1379 if (!build)
1380 return NULL;
1382 pos = isl_ast_build_get_depth(build);
1383 space = isl_ast_build_get_space(build, 1);
1384 space = isl_space_map_from_set(space);
1385 ma = isl_multi_aff_identity(space);
1387 if (!isl_ast_build_has_stride(build, pos))
1388 return ma;
1390 offset = isl_ast_build_get_offset(build, pos);
1391 stride = isl_ast_build_get_stride(build, pos);
1392 aff = isl_multi_aff_get_aff(ma, pos);
1393 aff = isl_aff_scale_val(aff, stride);
1394 aff = isl_aff_add(aff, offset);
1395 ma = isl_multi_aff_set_aff(ma, pos, aff);
1397 return ma;
1400 /* Add constraints corresponding to any previously detected
1401 * stride on the current dimension to build->domain.
1403 __isl_give isl_ast_build *isl_ast_build_include_stride(
1404 __isl_take isl_ast_build *build)
1406 isl_set *set;
1408 if (!build)
1409 return NULL;
1410 if (!isl_ast_build_has_stride(build, build->depth))
1411 return build;
1412 build = isl_ast_build_cow(build);
1413 if (!build)
1414 return NULL;
1416 set = isl_ast_build_get_stride_constraint(build);
1418 build->domain = isl_set_intersect(build->domain, isl_set_copy(set));
1419 build->generated = isl_set_intersect(build->generated, set);
1420 if (!build->domain || !build->generated)
1421 return isl_ast_build_free(build);
1423 return build;
1426 /* Information used inside detect_stride.
1428 * "build" may be updated by detect_stride to include stride information.
1429 * "pos" is equal to build->depth.
1431 struct isl_detect_stride_data {
1432 isl_ast_build *build;
1433 int pos;
1436 /* Check if constraint "c" imposes any stride on dimension data->pos
1437 * and, if so, update the stride information in data->build.
1439 * In order to impose a stride on the dimension, "c" needs to be an equality
1440 * and it needs to involve the dimension. Note that "c" may also be
1441 * a div constraint and thus an inequality that we cannot use.
1443 * Let c be of the form
1445 * h(p) + g * v * i + g * stride * f(alpha) = 0
1447 * with h(p) an expression in terms of the parameters and outer dimensions
1448 * and f(alpha) an expression in terms of the existentially quantified
1449 * variables. Note that the inner dimensions have been eliminated so
1450 * they do not appear in "c".
1452 * If "stride" is not zero and not one, then it represents a non-trivial stride
1453 * on "i". We compute a and b such that
1455 * a v + b stride = 1
1457 * We have
1459 * g v i = -h(p) + g stride f(alpha)
1461 * a g v i = -a h(p) + g stride f(alpha)
1463 * a g v i + b g stride i = -a h(p) + g stride * (...)
1465 * g i = -a h(p) + g stride * (...)
1467 * i = -a h(p)/g + stride * (...)
1469 * The expression "-a h(p)/g" can therefore be used as offset.
1471 static isl_stat detect_stride(__isl_take isl_constraint *c, void *user)
1473 struct isl_detect_stride_data *data = user;
1474 int i, n_div;
1475 isl_ctx *ctx;
1476 isl_val *v, *stride, *m;
1478 if (!isl_constraint_is_equality(c) ||
1479 !isl_constraint_involves_dims(c, isl_dim_set, data->pos, 1)) {
1480 isl_constraint_free(c);
1481 return isl_stat_ok;
1484 ctx = isl_constraint_get_ctx(c);
1485 stride = isl_val_zero(ctx);
1486 n_div = isl_constraint_dim(c, isl_dim_div);
1487 for (i = 0; i < n_div; ++i) {
1488 v = isl_constraint_get_coefficient_val(c, isl_dim_div, i);
1489 stride = isl_val_gcd(stride, v);
1492 v = isl_constraint_get_coefficient_val(c, isl_dim_set, data->pos);
1493 m = isl_val_gcd(isl_val_copy(stride), isl_val_copy(v));
1494 stride = isl_val_div(stride, isl_val_copy(m));
1495 v = isl_val_div(v, isl_val_copy(m));
1497 if (!isl_val_is_zero(stride) && !isl_val_is_one(stride)) {
1498 isl_aff *aff;
1499 isl_val *gcd, *a, *b;
1501 gcd = isl_val_gcdext(v, isl_val_copy(stride), &a, &b);
1502 isl_val_free(gcd);
1503 isl_val_free(b);
1505 aff = isl_constraint_get_aff(c);
1506 for (i = 0; i < n_div; ++i)
1507 aff = isl_aff_set_coefficient_si(aff,
1508 isl_dim_div, i, 0);
1509 aff = isl_aff_set_coefficient_si(aff, isl_dim_in, data->pos, 0);
1510 a = isl_val_neg(a);
1511 aff = isl_aff_scale_val(aff, a);
1512 aff = isl_aff_scale_down_val(aff, m);
1513 data->build = set_stride(data->build, stride, aff);
1514 } else {
1515 isl_val_free(stride);
1516 isl_val_free(m);
1517 isl_val_free(v);
1520 isl_constraint_free(c);
1521 return isl_stat_ok;
1524 /* Check if the constraints in "set" imply any stride on the current
1525 * dimension and, if so, record the stride information in "build"
1526 * and return the updated "build".
1528 * We compute the affine hull and then check if any of the constraints
1529 * in the hull imposes any stride on the current dimension.
1531 * We assume that inner dimensions have been eliminated from "set"
1532 * by the caller. This is needed because the common stride
1533 * may be imposed by different inner dimensions on different parts of
1534 * the domain.
1536 __isl_give isl_ast_build *isl_ast_build_detect_strides(
1537 __isl_take isl_ast_build *build, __isl_take isl_set *set)
1539 isl_basic_set *hull;
1540 struct isl_detect_stride_data data;
1542 if (!build)
1543 goto error;
1545 data.build = build;
1546 data.pos = isl_ast_build_get_depth(build);
1547 hull = isl_set_affine_hull(set);
1549 if (isl_basic_set_foreach_constraint(hull, &detect_stride, &data) < 0)
1550 data.build = isl_ast_build_free(data.build);
1552 isl_basic_set_free(hull);
1553 return data.build;
1554 error:
1555 isl_set_free(set);
1556 return NULL;
1559 struct isl_ast_build_involves_data {
1560 int depth;
1561 int involves;
1564 /* Check if "map" involves the input dimension data->depth.
1566 static isl_stat involves_depth(__isl_take isl_map *map, void *user)
1568 struct isl_ast_build_involves_data *data = user;
1570 data->involves = isl_map_involves_dims(map, isl_dim_in, data->depth, 1);
1571 isl_map_free(map);
1573 if (data->involves < 0 || data->involves)
1574 return isl_stat_error;
1575 return isl_stat_ok;
1578 /* Do any options depend on the value of the dimension at the current depth?
1580 int isl_ast_build_options_involve_depth(__isl_keep isl_ast_build *build)
1582 struct isl_ast_build_involves_data data;
1584 if (!build)
1585 return -1;
1587 data.depth = build->depth;
1588 data.involves = 0;
1590 if (isl_union_map_foreach_map(build->options,
1591 &involves_depth, &data) < 0) {
1592 if (data.involves < 0 || !data.involves)
1593 return -1;
1596 return data.involves;
1599 /* Construct the map
1601 * { [i] -> [i] : i < pos; [i] -> [i + 1] : i >= pos }
1603 * with "space" the parameter space of the constructed map.
1605 static __isl_give isl_map *construct_insertion_map(__isl_take isl_space *space,
1606 int pos)
1608 isl_constraint *c;
1609 isl_basic_map *bmap1, *bmap2;
1611 space = isl_space_set_from_params(space);
1612 space = isl_space_add_dims(space, isl_dim_set, 1);
1613 space = isl_space_map_from_set(space);
1614 c = isl_constraint_alloc_equality(isl_local_space_from_space(space));
1615 c = isl_constraint_set_coefficient_si(c, isl_dim_in, 0, 1);
1616 c = isl_constraint_set_coefficient_si(c, isl_dim_out, 0, -1);
1617 bmap1 = isl_basic_map_from_constraint(isl_constraint_copy(c));
1618 c = isl_constraint_set_constant_si(c, 1);
1619 bmap2 = isl_basic_map_from_constraint(c);
1621 bmap1 = isl_basic_map_upper_bound_si(bmap1, isl_dim_in, 0, pos - 1);
1622 bmap2 = isl_basic_map_lower_bound_si(bmap2, isl_dim_in, 0, pos);
1624 return isl_basic_map_union(bmap1, bmap2);
1627 static const char *option_str[] = {
1628 [isl_ast_loop_atomic] = "atomic",
1629 [isl_ast_loop_unroll] = "unroll",
1630 [isl_ast_loop_separate] = "separate"
1633 /* Update the "options" to reflect the insertion of a dimension
1634 * at position "pos" in the schedule domain space.
1635 * "space" is the original domain space before the insertion and
1636 * may be named and/or structured.
1638 * The (relevant) input options all have "space" as domain, which
1639 * has to be mapped to the extended space.
1640 * The values of the ranges also refer to the schedule domain positions
1641 * and they therefore also need to be adjusted. In particular, values
1642 * smaller than pos do not need to change, while values greater than or
1643 * equal to pos need to be incremented.
1644 * That is, we need to apply the following map.
1646 * { atomic[i] -> atomic[i] : i < pos; [i] -> [i + 1] : i >= pos;
1647 * unroll[i] -> unroll[i] : i < pos; [i] -> [i + 1] : i >= pos;
1648 * separate[i] -> separate[i] : i < pos; [i] -> [i + 1] : i >= pos;
1649 * separation_class[[i] -> [c]]
1650 * -> separation_class[[i] -> [c]] : i < pos;
1651 * separation_class[[i] -> [c]]
1652 * -> separation_class[[i + 1] -> [c]] : i >= pos }
1654 static __isl_give isl_union_map *options_insert_dim(
1655 __isl_take isl_union_map *options, __isl_take isl_space *space, int pos)
1657 isl_map *map;
1658 isl_union_map *insertion;
1659 enum isl_ast_loop_type type;
1660 const char *name = "separation_class";
1662 space = isl_space_map_from_set(space);
1663 map = isl_map_identity(space);
1664 map = isl_map_insert_dims(map, isl_dim_out, pos, 1);
1665 options = isl_union_map_apply_domain(options,
1666 isl_union_map_from_map(map));
1668 if (!options)
1669 return NULL;
1671 map = construct_insertion_map(isl_union_map_get_space(options), pos);
1673 insertion = isl_union_map_empty(isl_union_map_get_space(options));
1675 for (type = isl_ast_loop_atomic;
1676 type <= isl_ast_loop_separate; ++type) {
1677 isl_map *map_type = isl_map_copy(map);
1678 const char *name = option_str[type];
1679 map_type = isl_map_set_tuple_name(map_type, isl_dim_in, name);
1680 map_type = isl_map_set_tuple_name(map_type, isl_dim_out, name);
1681 insertion = isl_union_map_add_map(insertion, map_type);
1684 map = isl_map_product(map, isl_map_identity(isl_map_get_space(map)));
1685 map = isl_map_set_tuple_name(map, isl_dim_in, name);
1686 map = isl_map_set_tuple_name(map, isl_dim_out, name);
1687 insertion = isl_union_map_add_map(insertion, map);
1689 options = isl_union_map_apply_range(options, insertion);
1691 return options;
1694 /* If we are generating an AST from a schedule tree (build->node is set),
1695 * then update the loop AST generation types
1696 * to reflect the insertion of a dimension at (global) position "pos"
1697 * in the schedule domain space.
1698 * We do not need to adjust any isolate option since we would not be inserting
1699 * any dimensions if there were any isolate option.
1701 static __isl_give isl_ast_build *node_insert_dim(
1702 __isl_take isl_ast_build *build, int pos)
1704 int i;
1705 int local_pos;
1706 enum isl_ast_loop_type *loop_type;
1707 isl_ctx *ctx;
1709 build = isl_ast_build_cow(build);
1710 if (!build)
1711 return NULL;
1712 if (!build->node)
1713 return build;
1715 ctx = isl_ast_build_get_ctx(build);
1716 local_pos = pos - build->outer_pos;
1717 loop_type = isl_realloc_array(ctx, build->loop_type,
1718 enum isl_ast_loop_type, build->n + 1);
1719 if (!loop_type)
1720 return isl_ast_build_free(build);
1721 build->loop_type = loop_type;
1722 for (i = build->n - 1; i >= local_pos; --i)
1723 loop_type[i + 1] = loop_type[i];
1724 loop_type[local_pos] = isl_ast_loop_default;
1725 build->n++;
1727 return build;
1730 /* Insert a single dimension in the schedule domain at position "pos".
1731 * The new dimension is given an isl_id with the empty string as name.
1733 * The main difficulty is updating build->options to reflect the
1734 * extra dimension. This is handled in options_insert_dim.
1736 * Note that because of the dimension manipulations, the resulting
1737 * schedule domain space will always be unnamed and unstructured.
1738 * However, the original schedule domain space may be named and/or
1739 * structured, so we have to take this possibility into account
1740 * while performing the transformations.
1742 * Since the inserted schedule dimension is used by the caller
1743 * to differentiate between different domain spaces, there is
1744 * no longer a uniform mapping from the internal schedule space
1745 * to the input schedule space. The internal2input mapping is
1746 * therefore removed.
1748 __isl_give isl_ast_build *isl_ast_build_insert_dim(
1749 __isl_take isl_ast_build *build, int pos)
1751 isl_ctx *ctx;
1752 isl_space *space, *ma_space;
1753 isl_id *id;
1754 isl_multi_aff *ma;
1756 build = isl_ast_build_cow(build);
1757 if (!build)
1758 return NULL;
1760 ctx = isl_ast_build_get_ctx(build);
1761 id = isl_id_alloc(ctx, "", NULL);
1762 if (!build->node)
1763 space = isl_ast_build_get_space(build, 1);
1764 build->iterators = isl_id_list_insert(build->iterators, pos, id);
1765 build->domain = isl_set_insert_dims(build->domain,
1766 isl_dim_set, pos, 1);
1767 build->generated = isl_set_insert_dims(build->generated,
1768 isl_dim_set, pos, 1);
1769 build->pending = isl_set_insert_dims(build->pending,
1770 isl_dim_set, pos, 1);
1771 build->strides = isl_vec_insert_els(build->strides, pos, 1);
1772 build->strides = isl_vec_set_element_si(build->strides, pos, 1);
1773 ma_space = isl_space_params(isl_multi_aff_get_space(build->offsets));
1774 ma_space = isl_space_set_from_params(ma_space);
1775 ma_space = isl_space_add_dims(ma_space, isl_dim_set, 1);
1776 ma_space = isl_space_map_from_set(ma_space);
1777 ma = isl_multi_aff_zero(isl_space_copy(ma_space));
1778 build->offsets = isl_multi_aff_splice(build->offsets, pos, pos, ma);
1779 ma = isl_multi_aff_identity(ma_space);
1780 build->values = isl_multi_aff_splice(build->values, pos, pos, ma);
1781 if (!build->node)
1782 build->options = options_insert_dim(build->options, space, pos);
1783 build->internal2input = isl_multi_aff_free(build->internal2input);
1785 if (!build->iterators || !build->domain || !build->generated ||
1786 !build->pending || !build->values ||
1787 !build->strides || !build->offsets || !build->options)
1788 return isl_ast_build_free(build);
1790 build = node_insert_dim(build, pos);
1792 return build;
1795 /* Scale down the current dimension by a factor of "m".
1796 * "umap" is an isl_union_map that implements the scaling down.
1797 * That is, it is of the form
1799 * { [.... i ....] -> [.... i' ....] : i = m i' }
1801 * This function is called right after the strides have been
1802 * detected, but before any constraints on the current dimension
1803 * have been included in build->domain.
1804 * We therefore only need to update stride, offset, the options and
1805 * the mapping from internal schedule space to the original schedule
1806 * space, if we are still keeping track of such a mapping.
1807 * The latter mapping is updated by plugging in
1808 * { [... i ...] -> [... m i ... ] }.
1810 __isl_give isl_ast_build *isl_ast_build_scale_down(
1811 __isl_take isl_ast_build *build, __isl_take isl_val *m,
1812 __isl_take isl_union_map *umap)
1814 isl_aff *aff;
1815 isl_val *v;
1816 int depth;
1818 build = isl_ast_build_cow(build);
1819 if (!build || !umap || !m)
1820 goto error;
1822 depth = build->depth;
1824 if (build->internal2input) {
1825 isl_space *space;
1826 isl_multi_aff *ma;
1827 isl_aff *aff;
1829 space = isl_multi_aff_get_space(build->internal2input);
1830 space = isl_space_map_from_set(isl_space_domain(space));
1831 ma = isl_multi_aff_identity(space);
1832 aff = isl_multi_aff_get_aff(ma, depth);
1833 aff = isl_aff_scale_val(aff, isl_val_copy(m));
1834 ma = isl_multi_aff_set_aff(ma, depth, aff);
1835 build->internal2input =
1836 isl_multi_aff_pullback_multi_aff(build->internal2input, ma);
1837 if (!build->internal2input)
1838 goto error;
1841 v = isl_vec_get_element_val(build->strides, depth);
1842 v = isl_val_div(v, isl_val_copy(m));
1843 build->strides = isl_vec_set_element_val(build->strides, depth, v);
1845 aff = isl_multi_aff_get_aff(build->offsets, depth);
1846 aff = isl_aff_scale_down_val(aff, m);
1847 build->offsets = isl_multi_aff_set_aff(build->offsets, depth, aff);
1848 build->options = isl_union_map_apply_domain(build->options, umap);
1849 if (!build->strides || !build->offsets || !build->options)
1850 return isl_ast_build_free(build);
1852 return build;
1853 error:
1854 isl_val_free(m);
1855 isl_union_map_free(umap);
1856 return isl_ast_build_free(build);
1859 /* Return a list of "n" isl_ids called "c%d", with "%d" starting at "first".
1860 * If an isl_id with such a name already appears among the parameters
1861 * in build->domain, then adjust the name to "c%d_%d".
1863 static __isl_give isl_id_list *generate_names(isl_ctx *ctx, int n, int first,
1864 __isl_keep isl_ast_build *build)
1866 int i;
1867 isl_id_list *names;
1869 names = isl_id_list_alloc(ctx, n);
1870 for (i = 0; i < n; ++i) {
1871 isl_id *id;
1873 id = generate_name(ctx, first + i, build);
1874 names = isl_id_list_add(names, id);
1877 return names;
1880 /* Embed "options" into the given isl_ast_build space.
1882 * This function is called from within a nested call to
1883 * isl_ast_build_node_from_schedule_map.
1884 * "options" refers to the additional schedule,
1885 * while space refers to both the space of the outer isl_ast_build and
1886 * that of the additional schedule.
1887 * Specifically, space is of the form
1889 * [I -> S]
1891 * while options lives in the space(s)
1893 * S -> *
1895 * We compute
1897 * [I -> S] -> S
1899 * and compose this with options, to obtain the new options
1900 * living in the space(s)
1902 * [I -> S] -> *
1904 static __isl_give isl_union_map *embed_options(
1905 __isl_take isl_union_map *options, __isl_take isl_space *space)
1907 isl_map *map;
1909 map = isl_map_universe(isl_space_unwrap(space));
1910 map = isl_map_range_map(map);
1912 options = isl_union_map_apply_range(
1913 isl_union_map_from_map(map), options);
1915 return options;
1918 /* Update "build" for use in a (possibly nested) code generation. That is,
1919 * extend "build" from an AST build on some domain O to an AST build
1920 * on domain [O -> S], with S corresponding to "space".
1921 * If the original domain is a parameter domain, then the new domain is
1922 * simply S.
1923 * "iterators" is a list of iterators for S, but the number of elements
1924 * may be smaller or greater than the number of set dimensions of S.
1925 * If "keep_iterators" is set, then any extra ids in build->iterators
1926 * are reused for S. Otherwise, these extra ids are dropped.
1928 * We first update build->outer_pos to the current depth.
1929 * This depth is zero in case this is the outermost code generation.
1931 * We then add additional ids such that the number of iterators is at least
1932 * equal to the dimension of the new build domain.
1934 * If the original domain is parametric, then we are constructing
1935 * an isl_ast_build for the outer code generation and we pass control
1936 * to isl_ast_build_init.
1938 * Otherwise, we adjust the fields of "build" to include "space".
1940 __isl_give isl_ast_build *isl_ast_build_product(
1941 __isl_take isl_ast_build *build, __isl_take isl_space *space)
1943 isl_ctx *ctx;
1944 isl_vec *strides;
1945 isl_set *set;
1946 isl_multi_aff *embedding;
1947 int dim, n_it;
1949 build = isl_ast_build_cow(build);
1950 if (!build)
1951 goto error;
1953 build->outer_pos = build->depth;
1955 ctx = isl_ast_build_get_ctx(build);
1956 dim = isl_set_dim(build->domain, isl_dim_set);
1957 dim += isl_space_dim(space, isl_dim_set);
1958 n_it = isl_id_list_n_id(build->iterators);
1959 if (n_it < dim) {
1960 isl_id_list *l;
1961 l = generate_names(ctx, dim - n_it, n_it, build);
1962 build->iterators = isl_id_list_concat(build->iterators, l);
1965 if (isl_set_is_params(build->domain))
1966 return isl_ast_build_init(build, space);
1968 set = isl_set_universe(isl_space_copy(space));
1969 build->domain = isl_set_product(build->domain, isl_set_copy(set));
1970 build->pending = isl_set_product(build->pending, isl_set_copy(set));
1971 build->generated = isl_set_product(build->generated, set);
1973 strides = isl_vec_alloc(ctx, isl_space_dim(space, isl_dim_set));
1974 strides = isl_vec_set_si(strides, 1);
1975 build->strides = isl_vec_concat(build->strides, strides);
1977 space = isl_space_map_from_set(space);
1978 build->offsets = isl_multi_aff_align_params(build->offsets,
1979 isl_space_copy(space));
1980 build->offsets = isl_multi_aff_product(build->offsets,
1981 isl_multi_aff_zero(isl_space_copy(space)));
1982 build->values = isl_multi_aff_align_params(build->values,
1983 isl_space_copy(space));
1984 embedding = isl_multi_aff_identity(space);
1985 build->values = isl_multi_aff_product(build->values,
1986 isl_multi_aff_copy(embedding));
1987 if (build->internal2input) {
1988 build->internal2input =
1989 isl_multi_aff_product(build->internal2input, embedding);
1990 build->internal2input =
1991 isl_multi_aff_flatten_range(build->internal2input);
1992 if (!build->internal2input)
1993 return isl_ast_build_free(build);
1994 } else {
1995 isl_multi_aff_free(embedding);
1998 space = isl_ast_build_get_space(build, 1);
1999 build->options = embed_options(build->options, space);
2001 if (!build->iterators || !build->domain || !build->generated ||
2002 !build->pending || !build->values ||
2003 !build->strides || !build->offsets || !build->options)
2004 return isl_ast_build_free(build);
2006 return build;
2007 error:
2008 isl_ast_build_free(build);
2009 isl_space_free(space);
2010 return NULL;
2013 /* Does "aff" only attain non-negative values over build->domain?
2014 * That is, does it not attain any negative values?
2016 int isl_ast_build_aff_is_nonneg(__isl_keep isl_ast_build *build,
2017 __isl_keep isl_aff *aff)
2019 isl_set *test;
2020 int empty;
2022 if (!build)
2023 return -1;
2025 aff = isl_aff_copy(aff);
2026 test = isl_set_from_basic_set(isl_aff_neg_basic_set(aff));
2027 test = isl_set_intersect(test, isl_set_copy(build->domain));
2028 empty = isl_set_is_empty(test);
2029 isl_set_free(test);
2031 return empty;
2034 /* Does the dimension at (internal) position "pos" have a non-trivial stride?
2036 isl_bool isl_ast_build_has_stride(__isl_keep isl_ast_build *build, int pos)
2038 isl_val *v;
2039 isl_bool has_stride;
2041 if (!build)
2042 return isl_bool_error;
2044 v = isl_vec_get_element_val(build->strides, pos);
2045 has_stride = isl_bool_not(isl_val_is_one(v));
2046 isl_val_free(v);
2048 return has_stride;
2051 /* Given that the dimension at position "pos" takes on values
2053 * f + s a
2055 * with a an integer, return s through *stride.
2057 __isl_give isl_val *isl_ast_build_get_stride(__isl_keep isl_ast_build *build,
2058 int pos)
2060 if (!build)
2061 return NULL;
2063 return isl_vec_get_element_val(build->strides, pos);
2066 /* Given that the dimension at position "pos" takes on values
2068 * f + s a
2070 * with a an integer, return f.
2072 __isl_give isl_aff *isl_ast_build_get_offset(
2073 __isl_keep isl_ast_build *build, int pos)
2075 if (!build)
2076 return NULL;
2078 return isl_multi_aff_get_aff(build->offsets, pos);
2081 /* Is the dimension at position "pos" known to attain only a single
2082 * value that, moreover, can be described by a single affine expression
2083 * in terms of the outer dimensions and parameters?
2085 * If not, then the corresponding affine expression in build->values
2086 * is set to be equal to the same input dimension.
2087 * Otherwise, it is set to the requested expression in terms of
2088 * outer dimensions and parameters.
2090 int isl_ast_build_has_affine_value(__isl_keep isl_ast_build *build,
2091 int pos)
2093 isl_aff *aff;
2094 int involves;
2096 if (!build)
2097 return -1;
2099 aff = isl_multi_aff_get_aff(build->values, pos);
2100 involves = isl_aff_involves_dims(aff, isl_dim_in, pos, 1);
2101 isl_aff_free(aff);
2103 if (involves < 0)
2104 return -1;
2106 return !involves;
2109 /* Plug in the known values (fixed affine expressions in terms of
2110 * parameters and outer loop iterators) of all loop iterators
2111 * in the domain of "umap".
2113 * We simply precompose "umap" with build->values.
2115 __isl_give isl_union_map *isl_ast_build_substitute_values_union_map_domain(
2116 __isl_keep isl_ast_build *build, __isl_take isl_union_map *umap)
2118 isl_multi_aff *values;
2120 if (!build)
2121 return isl_union_map_free(umap);
2123 values = isl_multi_aff_copy(build->values);
2124 umap = isl_union_map_preimage_domain_multi_aff(umap, values);
2126 return umap;
2129 /* Is the current dimension known to attain only a single value?
2131 int isl_ast_build_has_value(__isl_keep isl_ast_build *build)
2133 if (!build)
2134 return -1;
2136 return build->value != NULL;
2139 /* Simplify the basic set "bset" based on what we know about
2140 * the iterators of already generated loops.
2142 * "bset" is assumed to live in the (internal) schedule domain.
2144 __isl_give isl_basic_set *isl_ast_build_compute_gist_basic_set(
2145 __isl_keep isl_ast_build *build, __isl_take isl_basic_set *bset)
2147 if (!build)
2148 goto error;
2150 bset = isl_basic_set_preimage_multi_aff(bset,
2151 isl_multi_aff_copy(build->values));
2152 bset = isl_basic_set_gist(bset,
2153 isl_set_simple_hull(isl_set_copy(build->domain)));
2155 return bset;
2156 error:
2157 isl_basic_set_free(bset);
2158 return NULL;
2161 /* Simplify the set "set" based on what we know about
2162 * the iterators of already generated loops.
2164 * "set" is assumed to live in the (internal) schedule domain.
2166 __isl_give isl_set *isl_ast_build_compute_gist(
2167 __isl_keep isl_ast_build *build, __isl_take isl_set *set)
2169 if (!build)
2170 goto error;
2172 if (!isl_set_is_params(set))
2173 set = isl_set_preimage_multi_aff(set,
2174 isl_multi_aff_copy(build->values));
2175 set = isl_set_gist(set, isl_set_copy(build->domain));
2177 return set;
2178 error:
2179 isl_set_free(set);
2180 return NULL;
2183 /* Include information about what we know about the iterators of
2184 * already generated loops to "set".
2186 * We currently only plug in the known affine values of outer loop
2187 * iterators.
2188 * In principle we could also introduce equalities or even other
2189 * constraints implied by the intersection of "set" and build->domain.
2191 __isl_give isl_set *isl_ast_build_specialize(__isl_keep isl_ast_build *build,
2192 __isl_take isl_set *set)
2194 if (!build)
2195 return isl_set_free(set);
2197 return isl_set_preimage_multi_aff(set,
2198 isl_multi_aff_copy(build->values));
2201 /* Plug in the known affine values of outer loop iterators in "bset".
2203 __isl_give isl_basic_set *isl_ast_build_specialize_basic_set(
2204 __isl_keep isl_ast_build *build, __isl_take isl_basic_set *bset)
2206 if (!build)
2207 return isl_basic_set_free(bset);
2209 return isl_basic_set_preimage_multi_aff(bset,
2210 isl_multi_aff_copy(build->values));
2213 /* Simplify the map "map" based on what we know about
2214 * the iterators of already generated loops.
2216 * The domain of "map" is assumed to live in the (internal) schedule domain.
2218 __isl_give isl_map *isl_ast_build_compute_gist_map_domain(
2219 __isl_keep isl_ast_build *build, __isl_take isl_map *map)
2221 if (!build)
2222 goto error;
2224 map = isl_map_gist_domain(map, isl_set_copy(build->domain));
2226 return map;
2227 error:
2228 isl_map_free(map);
2229 return NULL;
2232 /* Simplify the affine expression "aff" based on what we know about
2233 * the iterators of already generated loops.
2235 * The domain of "aff" is assumed to live in the (internal) schedule domain.
2237 __isl_give isl_aff *isl_ast_build_compute_gist_aff(
2238 __isl_keep isl_ast_build *build, __isl_take isl_aff *aff)
2240 if (!build)
2241 goto error;
2243 aff = isl_aff_gist(aff, isl_set_copy(build->domain));
2245 return aff;
2246 error:
2247 isl_aff_free(aff);
2248 return NULL;
2251 /* Simplify the piecewise affine expression "aff" based on what we know about
2252 * the iterators of already generated loops.
2254 * The domain of "pa" is assumed to live in the (internal) schedule domain.
2256 __isl_give isl_pw_aff *isl_ast_build_compute_gist_pw_aff(
2257 __isl_keep isl_ast_build *build, __isl_take isl_pw_aff *pa)
2259 if (!build)
2260 goto error;
2262 if (!isl_set_is_params(build->domain))
2263 pa = isl_pw_aff_pullback_multi_aff(pa,
2264 isl_multi_aff_copy(build->values));
2265 pa = isl_pw_aff_gist(pa, isl_set_copy(build->domain));
2267 return pa;
2268 error:
2269 isl_pw_aff_free(pa);
2270 return NULL;
2273 /* Simplify the piecewise multi-affine expression "aff" based on what
2274 * we know about the iterators of already generated loops.
2276 * The domain of "pma" is assumed to live in the (internal) schedule domain.
2278 __isl_give isl_pw_multi_aff *isl_ast_build_compute_gist_pw_multi_aff(
2279 __isl_keep isl_ast_build *build, __isl_take isl_pw_multi_aff *pma)
2281 if (!build)
2282 goto error;
2284 pma = isl_pw_multi_aff_pullback_multi_aff(pma,
2285 isl_multi_aff_copy(build->values));
2286 pma = isl_pw_multi_aff_gist(pma, isl_set_copy(build->domain));
2288 return pma;
2289 error:
2290 isl_pw_multi_aff_free(pma);
2291 return NULL;
2294 /* Extract the schedule domain of the given type from build->options
2295 * at the current depth.
2297 * In particular, find the subset of build->options that is of
2298 * the following form
2300 * schedule_domain -> type[depth]
2302 * and return the corresponding domain, after eliminating inner dimensions
2303 * and divs that depend on the current dimension.
2305 * Note that the domain of build->options has been reformulated
2306 * in terms of the internal build space in embed_options,
2307 * but the position is still that within the current code generation.
2309 __isl_give isl_set *isl_ast_build_get_option_domain(
2310 __isl_keep isl_ast_build *build, enum isl_ast_loop_type type)
2312 const char *name;
2313 isl_space *space;
2314 isl_map *option;
2315 isl_set *domain;
2316 int local_pos;
2318 if (!build)
2319 return NULL;
2321 name = option_str[type];
2322 local_pos = build->depth - build->outer_pos;
2324 space = isl_ast_build_get_space(build, 1);
2325 space = isl_space_from_domain(space);
2326 space = isl_space_add_dims(space, isl_dim_out, 1);
2327 space = isl_space_set_tuple_name(space, isl_dim_out, name);
2329 option = isl_union_map_extract_map(build->options, space);
2330 option = isl_map_fix_si(option, isl_dim_out, 0, local_pos);
2332 domain = isl_map_domain(option);
2333 domain = isl_ast_build_eliminate(build, domain);
2335 return domain;
2338 /* How does the user want the current schedule dimension to be generated?
2339 * These choices have been extracted from the schedule node
2340 * in extract_loop_types and stored in build->loop_type.
2341 * They have been updated to reflect any dimension insertion in
2342 * node_insert_dim.
2343 * Return isl_ast_domain_error on error.
2345 * If "isolated" is set, then we get the loop AST generation type
2346 * directly from the band node since node_insert_dim cannot have been
2347 * called on a band with the isolate option.
2349 enum isl_ast_loop_type isl_ast_build_get_loop_type(
2350 __isl_keep isl_ast_build *build, int isolated)
2352 int local_pos;
2353 isl_ctx *ctx;
2355 if (!build)
2356 return isl_ast_loop_error;
2357 ctx = isl_ast_build_get_ctx(build);
2358 if (!build->node)
2359 isl_die(ctx, isl_error_internal,
2360 "only works for schedule tree based AST generation",
2361 return isl_ast_loop_error);
2363 local_pos = build->depth - build->outer_pos;
2364 if (!isolated)
2365 return build->loop_type[local_pos];
2366 return isl_schedule_node_band_member_get_isolate_ast_loop_type(
2367 build->node, local_pos);
2370 /* Extract the isolated set from the isolate option, if any,
2371 * and store in the build.
2372 * If there is no isolate option, then the isolated set is
2373 * set to the empty set.
2375 * The isolate option is of the form
2377 * isolate[[outer bands] -> current_band]
2379 * We flatten this set and then map it back to the internal
2380 * schedule space.
2382 * If we have already extracted the isolated set
2383 * or if internal2input is no longer set, then we do not
2384 * need to do anything. In the latter case, we know
2385 * that the current band cannot have any isolate option.
2387 __isl_give isl_ast_build *isl_ast_build_extract_isolated(
2388 __isl_take isl_ast_build *build)
2390 isl_space *space, *space2;
2391 isl_union_set *options;
2392 int n, n2;
2393 isl_set *isolated;
2395 if (!build)
2396 return NULL;
2397 if (!build->internal2input)
2398 return build;
2399 if (build->isolated)
2400 return build;
2402 build = isl_ast_build_cow(build);
2403 if (!build)
2404 return NULL;
2406 options = isl_schedule_node_band_get_ast_build_options(build->node);
2408 space = isl_multi_aff_get_space(build->internal2input);
2409 space = isl_space_range(space);
2410 space2 = isl_set_get_space(build->domain);
2411 if (isl_space_is_wrapping(space2))
2412 space2 = isl_space_range(isl_space_unwrap(space2));
2413 n2 = isl_space_dim(space2, isl_dim_set);
2414 n = isl_space_dim(space, isl_dim_set);
2415 if (n < n2)
2416 isl_die(isl_ast_build_get_ctx(build), isl_error_internal,
2417 "total input space dimension cannot be smaller "
2418 "than dimension of innermost band",
2419 space = isl_space_free(space));
2420 space = isl_space_drop_dims(space, isl_dim_set, n - n2, n2);
2421 space = isl_space_map_from_domain_and_range(space, space2);
2422 space = isl_space_wrap(space);
2423 space = isl_space_set_tuple_name(space, isl_dim_set, "isolate");
2424 isolated = isl_union_set_extract_set(options, space);
2425 isl_union_set_free(options);
2427 isolated = isl_set_flatten(isolated);
2428 isolated = isl_set_preimage_multi_aff(isolated,
2429 isl_multi_aff_copy(build->internal2input));
2431 build->isolated = isolated;
2432 if (!build->isolated)
2433 return isl_ast_build_free(build);
2435 return build;
2438 /* Does "build" have a non-empty isolated set?
2440 * The caller is assumed to have called isl_ast_build_extract_isolated first.
2442 int isl_ast_build_has_isolated(__isl_keep isl_ast_build *build)
2444 int empty;
2446 if (!build)
2447 return -1;
2448 if (!build->internal2input)
2449 return 0;
2450 if (!build->isolated)
2451 isl_die(isl_ast_build_get_ctx(build), isl_error_internal,
2452 "isolated set not extracted yet", return -1);
2454 empty = isl_set_plain_is_empty(build->isolated);
2455 return empty < 0 ? -1 : !empty;
2458 /* Return a copy of the isolated set of "build".
2460 * The caller is assume to have called isl_ast_build_has_isolated first,
2461 * with this function returning true.
2462 * In particular, this function should not be called if we are no
2463 * longer keeping track of internal2input (and there therefore could
2464 * not possibly be any isolated set).
2466 __isl_give isl_set *isl_ast_build_get_isolated(__isl_keep isl_ast_build *build)
2468 if (!build)
2469 return NULL;
2470 if (!build->internal2input)
2471 isl_die(isl_ast_build_get_ctx(build), isl_error_internal,
2472 "build cannot have isolated set", return NULL);
2474 return isl_set_copy(build->isolated);
2477 /* Extract the separation class mapping at the current depth.
2479 * In particular, find and return the subset of build->options that is of
2480 * the following form
2482 * schedule_domain -> separation_class[[depth] -> [class]]
2484 * The caller is expected to eliminate inner dimensions from the domain.
2486 * Note that the domain of build->options has been reformulated
2487 * in terms of the internal build space in embed_options,
2488 * but the position is still that within the current code generation.
2490 __isl_give isl_map *isl_ast_build_get_separation_class(
2491 __isl_keep isl_ast_build *build)
2493 isl_ctx *ctx;
2494 isl_space *space_sep, *space;
2495 isl_map *res;
2496 int local_pos;
2498 if (!build)
2499 return NULL;
2501 local_pos = build->depth - build->outer_pos;
2502 ctx = isl_ast_build_get_ctx(build);
2503 space_sep = isl_space_alloc(ctx, 0, 1, 1);
2504 space_sep = isl_space_wrap(space_sep);
2505 space_sep = isl_space_set_tuple_name(space_sep, isl_dim_set,
2506 "separation_class");
2507 space = isl_ast_build_get_space(build, 1);
2508 space_sep = isl_space_align_params(space_sep, isl_space_copy(space));
2509 space = isl_space_map_from_domain_and_range(space, space_sep);
2511 res = isl_union_map_extract_map(build->options, space);
2512 res = isl_map_fix_si(res, isl_dim_out, 0, local_pos);
2513 res = isl_map_coalesce(res);
2515 return res;
2518 /* Eliminate dimensions inner to the current dimension.
2520 __isl_give isl_set *isl_ast_build_eliminate_inner(
2521 __isl_keep isl_ast_build *build, __isl_take isl_set *set)
2523 int dim;
2524 int depth;
2526 if (!build)
2527 return isl_set_free(set);
2529 dim = isl_set_dim(set, isl_dim_set);
2530 depth = build->depth;
2531 set = isl_set_detect_equalities(set);
2532 set = isl_set_eliminate(set, isl_dim_set, depth + 1, dim - (depth + 1));
2534 return set;
2537 /* Eliminate unknown divs and divs that depend on the current dimension.
2539 * Note that during the elimination of unknown divs, we may discover
2540 * an explicit representation of some other unknown divs, which may
2541 * depend on the current dimension. We therefore need to eliminate
2542 * unknown divs first.
2544 __isl_give isl_set *isl_ast_build_eliminate_divs(
2545 __isl_keep isl_ast_build *build, __isl_take isl_set *set)
2547 int depth;
2549 if (!build)
2550 return isl_set_free(set);
2552 set = isl_set_remove_unknown_divs(set);
2553 depth = build->depth;
2554 set = isl_set_remove_divs_involving_dims(set, isl_dim_set, depth, 1);
2556 return set;
2559 /* Eliminate dimensions inner to the current dimension as well as
2560 * unknown divs and divs that depend on the current dimension.
2561 * The result then consists only of constraints that are independent
2562 * of the current dimension and upper and lower bounds on the current
2563 * dimension.
2565 __isl_give isl_set *isl_ast_build_eliminate(
2566 __isl_keep isl_ast_build *build, __isl_take isl_set *domain)
2568 domain = isl_ast_build_eliminate_inner(build, domain);
2569 domain = isl_ast_build_eliminate_divs(build, domain);
2570 return domain;
2573 /* Replace build->single_valued by "sv".
2575 __isl_give isl_ast_build *isl_ast_build_set_single_valued(
2576 __isl_take isl_ast_build *build, int sv)
2578 if (!build)
2579 return build;
2580 if (build->single_valued == sv)
2581 return build;
2582 build = isl_ast_build_cow(build);
2583 if (!build)
2584 return build;
2585 build->single_valued = sv;
2587 return build;