Handle error conditions returned by level_before in isl_flow
[isl.git] / isl_schedule_node.c
blob6f696d23e9c059a4c0f7ac7d9f0369b21c499968
1 /*
2 * Copyright 2013-2014 Ecole Normale Superieure
3 * Copyright 2014 INRIA Rocquencourt
4 * Copyright 2016 Sven Verdoolaege
6 * Use of this software is governed by the MIT license
8 * Written by Sven Verdoolaege,
9 * Ecole Normale Superieure, 45 rue d'Ulm, 75230 Paris, France
10 * and Inria Paris - Rocquencourt, Domaine de Voluceau - Rocquencourt,
11 * B.P. 105 - 78153 Le Chesnay, France
14 #include <isl/set.h>
15 #include <isl_schedule_band.h>
16 #include <isl_schedule_private.h>
17 #include <isl_schedule_node_private.h>
19 /* Create a new schedule node in the given schedule, point at the given
20 * tree with given ancestors and child positions.
21 * "child_pos" may be NULL if there are no ancestors.
23 __isl_give isl_schedule_node *isl_schedule_node_alloc(
24 __isl_take isl_schedule *schedule, __isl_take isl_schedule_tree *tree,
25 __isl_take isl_schedule_tree_list *ancestors, int *child_pos)
27 isl_ctx *ctx;
28 isl_schedule_node *node;
29 int i, n;
31 if (!schedule || !tree || !ancestors)
32 goto error;
33 n = isl_schedule_tree_list_n_schedule_tree(ancestors);
34 if (n > 0 && !child_pos)
35 goto error;
36 ctx = isl_schedule_get_ctx(schedule);
37 node = isl_calloc_type(ctx, isl_schedule_node);
38 if (!node)
39 goto error;
40 node->ref = 1;
41 node->schedule = schedule;
42 node->tree = tree;
43 node->ancestors = ancestors;
44 node->child_pos = isl_alloc_array(ctx, int, n);
45 if (n && !node->child_pos)
46 return isl_schedule_node_free(node);
47 for (i = 0; i < n; ++i)
48 node->child_pos[i] = child_pos[i];
50 return node;
51 error:
52 isl_schedule_free(schedule);
53 isl_schedule_tree_free(tree);
54 isl_schedule_tree_list_free(ancestors);
55 return NULL;
58 /* Return a pointer to the root of a schedule tree with as single
59 * node a domain node with the given domain.
61 __isl_give isl_schedule_node *isl_schedule_node_from_domain(
62 __isl_take isl_union_set *domain)
64 isl_schedule *schedule;
65 isl_schedule_node *node;
67 schedule = isl_schedule_from_domain(domain);
68 node = isl_schedule_get_root(schedule);
69 isl_schedule_free(schedule);
71 return node;
74 /* Return a pointer to the root of a schedule tree with as single
75 * node a extension node with the given extension.
77 __isl_give isl_schedule_node *isl_schedule_node_from_extension(
78 __isl_take isl_union_map *extension)
80 isl_ctx *ctx;
81 isl_schedule *schedule;
82 isl_schedule_tree *tree;
83 isl_schedule_node *node;
85 if (!extension)
86 return NULL;
88 ctx = isl_union_map_get_ctx(extension);
89 tree = isl_schedule_tree_from_extension(extension);
90 schedule = isl_schedule_from_schedule_tree(ctx, tree);
91 node = isl_schedule_get_root(schedule);
92 isl_schedule_free(schedule);
94 return node;
97 /* Return the isl_ctx to which "node" belongs.
99 isl_ctx *isl_schedule_node_get_ctx(__isl_keep isl_schedule_node *node)
101 return node ? isl_schedule_get_ctx(node->schedule) : NULL;
104 /* Return a pointer to the leaf of the schedule into which "node" points.
106 __isl_keep isl_schedule_tree *isl_schedule_node_peek_leaf(
107 __isl_keep isl_schedule_node *node)
109 return node ? isl_schedule_peek_leaf(node->schedule) : NULL;
112 /* Return a copy of the leaf of the schedule into which "node" points.
114 __isl_give isl_schedule_tree *isl_schedule_node_get_leaf(
115 __isl_keep isl_schedule_node *node)
117 return isl_schedule_tree_copy(isl_schedule_node_peek_leaf(node));
120 /* Return the type of the node or isl_schedule_node_error on error.
122 enum isl_schedule_node_type isl_schedule_node_get_type(
123 __isl_keep isl_schedule_node *node)
125 return node ? isl_schedule_tree_get_type(node->tree)
126 : isl_schedule_node_error;
129 /* Return the type of the parent of "node" or isl_schedule_node_error on error.
131 enum isl_schedule_node_type isl_schedule_node_get_parent_type(
132 __isl_keep isl_schedule_node *node)
134 int pos;
135 int has_parent;
136 isl_schedule_tree *parent;
137 enum isl_schedule_node_type type;
139 if (!node)
140 return isl_schedule_node_error;
141 has_parent = isl_schedule_node_has_parent(node);
142 if (has_parent < 0)
143 return isl_schedule_node_error;
144 if (!has_parent)
145 isl_die(isl_schedule_node_get_ctx(node), isl_error_invalid,
146 "node has no parent", return isl_schedule_node_error);
148 pos = isl_schedule_tree_list_n_schedule_tree(node->ancestors) - 1;
149 parent = isl_schedule_tree_list_get_schedule_tree(node->ancestors, pos);
150 type = isl_schedule_tree_get_type(parent);
151 isl_schedule_tree_free(parent);
153 return type;
156 /* Return a copy of the subtree that this node points to.
158 __isl_give isl_schedule_tree *isl_schedule_node_get_tree(
159 __isl_keep isl_schedule_node *node)
161 if (!node)
162 return NULL;
164 return isl_schedule_tree_copy(node->tree);
167 /* Return a copy of the schedule into which "node" points.
169 __isl_give isl_schedule *isl_schedule_node_get_schedule(
170 __isl_keep isl_schedule_node *node)
172 if (!node)
173 return NULL;
174 return isl_schedule_copy(node->schedule);
177 /* Return a fresh copy of "node".
179 __isl_take isl_schedule_node *isl_schedule_node_dup(
180 __isl_keep isl_schedule_node *node)
182 if (!node)
183 return NULL;
185 return isl_schedule_node_alloc(isl_schedule_copy(node->schedule),
186 isl_schedule_tree_copy(node->tree),
187 isl_schedule_tree_list_copy(node->ancestors),
188 node->child_pos);
191 /* Return an isl_schedule_node that is equal to "node" and that has only
192 * a single reference.
194 __isl_give isl_schedule_node *isl_schedule_node_cow(
195 __isl_take isl_schedule_node *node)
197 if (!node)
198 return NULL;
200 if (node->ref == 1)
201 return node;
202 node->ref--;
203 return isl_schedule_node_dup(node);
206 /* Return a new reference to "node".
208 __isl_give isl_schedule_node *isl_schedule_node_copy(
209 __isl_keep isl_schedule_node *node)
211 if (!node)
212 return NULL;
214 node->ref++;
215 return node;
218 /* Free "node" and return NULL.
220 __isl_null isl_schedule_node *isl_schedule_node_free(
221 __isl_take isl_schedule_node *node)
223 if (!node)
224 return NULL;
225 if (--node->ref > 0)
226 return NULL;
228 isl_schedule_tree_list_free(node->ancestors);
229 free(node->child_pos);
230 isl_schedule_tree_free(node->tree);
231 isl_schedule_free(node->schedule);
232 free(node);
234 return NULL;
237 /* Do "node1" and "node2" point to the same position in the same
238 * schedule?
240 isl_bool isl_schedule_node_is_equal(__isl_keep isl_schedule_node *node1,
241 __isl_keep isl_schedule_node *node2)
243 int i, n1, n2;
245 if (!node1 || !node2)
246 return isl_bool_error;
247 if (node1 == node2)
248 return isl_bool_true;
249 if (node1->schedule != node2->schedule)
250 return isl_bool_false;
252 n1 = isl_schedule_node_get_tree_depth(node1);
253 n2 = isl_schedule_node_get_tree_depth(node2);
254 if (n1 != n2)
255 return isl_bool_false;
256 for (i = 0; i < n1; ++i)
257 if (node1->child_pos[i] != node2->child_pos[i])
258 return isl_bool_false;
260 return isl_bool_true;
263 /* Return the number of outer schedule dimensions of "node"
264 * in its schedule tree.
266 * Return -1 on error.
268 int isl_schedule_node_get_schedule_depth(__isl_keep isl_schedule_node *node)
270 int i, n;
271 int depth = 0;
273 if (!node)
274 return -1;
276 n = isl_schedule_tree_list_n_schedule_tree(node->ancestors);
277 for (i = n - 1; i >= 0; --i) {
278 isl_schedule_tree *tree;
280 tree = isl_schedule_tree_list_get_schedule_tree(
281 node->ancestors, i);
282 if (!tree)
283 return -1;
284 if (tree->type == isl_schedule_node_band)
285 depth += isl_schedule_tree_band_n_member(tree);
286 isl_schedule_tree_free(tree);
289 return depth;
292 /* Internal data structure for
293 * isl_schedule_node_get_prefix_schedule_union_pw_multi_aff
295 * "initialized" is set if the filter field has been initialized.
296 * If "universe_domain" is not set, then the collected filter is intersected
297 * with the the domain of the root domain node.
298 * "universe_filter" is set if we are only collecting the universes of filters
299 * "collect_prefix" is set if we are collecting prefixes.
300 * "filter" collects all outer filters and is NULL until "initialized" is set.
301 * "prefix" collects all outer band partial schedules (if "collect_prefix"
302 * is set). If it is used, then it is initialized by the caller
303 * of collect_filter_prefix to a zero-dimensional function.
305 struct isl_schedule_node_get_filter_prefix_data {
306 int initialized;
307 int universe_domain;
308 int universe_filter;
309 int collect_prefix;
310 isl_union_set *filter;
311 isl_multi_union_pw_aff *prefix;
314 static int collect_filter_prefix(__isl_keep isl_schedule_tree_list *list,
315 int n, struct isl_schedule_node_get_filter_prefix_data *data);
317 /* Update the filter and prefix information in "data" based on the first "n"
318 * elements in "list" and the expansion tree root "tree".
320 * We first collect the information from the elements in "list",
321 * initializing the filter based on the domain of the expansion.
322 * Then we map the results to the expanded space and combined them
323 * with the results already in "data".
325 static int collect_filter_prefix_expansion(__isl_take isl_schedule_tree *tree,
326 __isl_keep isl_schedule_tree_list *list, int n,
327 struct isl_schedule_node_get_filter_prefix_data *data)
329 struct isl_schedule_node_get_filter_prefix_data contracted;
330 isl_union_pw_multi_aff *c;
331 isl_union_map *exp, *universe;
332 isl_union_set *filter;
334 c = isl_schedule_tree_expansion_get_contraction(tree);
335 exp = isl_schedule_tree_expansion_get_expansion(tree);
337 contracted.initialized = 1;
338 contracted.universe_domain = data->universe_domain;
339 contracted.universe_filter = data->universe_filter;
340 contracted.collect_prefix = data->collect_prefix;
341 universe = isl_union_map_universe(isl_union_map_copy(exp));
342 filter = isl_union_map_domain(universe);
343 if (data->collect_prefix) {
344 isl_space *space = isl_union_set_get_space(filter);
345 space = isl_space_set_from_params(space);
346 contracted.prefix = isl_multi_union_pw_aff_zero(space);
348 contracted.filter = filter;
350 if (collect_filter_prefix(list, n, &contracted) < 0)
351 contracted.filter = isl_union_set_free(contracted.filter);
352 if (data->collect_prefix) {
353 isl_multi_union_pw_aff *prefix;
355 prefix = contracted.prefix;
356 prefix =
357 isl_multi_union_pw_aff_pullback_union_pw_multi_aff(prefix,
358 isl_union_pw_multi_aff_copy(c));
359 data->prefix = isl_multi_union_pw_aff_flat_range_product(
360 prefix, data->prefix);
362 filter = contracted.filter;
363 if (data->universe_domain)
364 filter = isl_union_set_preimage_union_pw_multi_aff(filter,
365 isl_union_pw_multi_aff_copy(c));
366 else
367 filter = isl_union_set_apply(filter, isl_union_map_copy(exp));
368 if (!data->initialized)
369 data->filter = filter;
370 else
371 data->filter = isl_union_set_intersect(filter, data->filter);
372 data->initialized = 1;
374 isl_union_pw_multi_aff_free(c);
375 isl_union_map_free(exp);
376 isl_schedule_tree_free(tree);
378 return 0;
381 /* Update the filter information in "data" based on the first "n"
382 * elements in "list" and the extension tree root "tree", in case
383 * data->universe_domain is set and data->collect_prefix is not.
385 * We collect the universe domain of the elements in "list" and
386 * add it to the universe range of the extension (intersected
387 * with the already collected filter, if any).
389 static int collect_universe_domain_extension(__isl_take isl_schedule_tree *tree,
390 __isl_keep isl_schedule_tree_list *list, int n,
391 struct isl_schedule_node_get_filter_prefix_data *data)
393 struct isl_schedule_node_get_filter_prefix_data data_outer;
394 isl_union_map *extension;
395 isl_union_set *filter;
397 data_outer.initialized = 0;
398 data_outer.universe_domain = 1;
399 data_outer.universe_filter = data->universe_filter;
400 data_outer.collect_prefix = 0;
401 data_outer.filter = NULL;
402 data_outer.prefix = NULL;
404 if (collect_filter_prefix(list, n, &data_outer) < 0)
405 data_outer.filter = isl_union_set_free(data_outer.filter);
407 extension = isl_schedule_tree_extension_get_extension(tree);
408 extension = isl_union_map_universe(extension);
409 filter = isl_union_map_range(extension);
410 if (data_outer.initialized)
411 filter = isl_union_set_union(filter, data_outer.filter);
412 if (data->initialized)
413 filter = isl_union_set_intersect(filter, data->filter);
415 data->filter = filter;
417 isl_schedule_tree_free(tree);
419 return 0;
422 /* Update "data" based on the tree node "tree" in case "data" has
423 * not been initialized yet.
425 * Return 0 on success and -1 on error.
427 * If "tree" is a filter, then we set data->filter to this filter
428 * (or its universe).
429 * If "tree" is a domain, then this means we have reached the root
430 * of the schedule tree without being able to extract any information.
431 * We therefore initialize data->filter to the universe of the domain,
432 * or the domain itself if data->universe_domain is not set.
433 * If "tree" is a band with at least one member, then we set data->filter
434 * to the universe of the schedule domain and replace the zero-dimensional
435 * data->prefix by the band schedule (if data->collect_prefix is set).
437 static int collect_filter_prefix_init(__isl_keep isl_schedule_tree *tree,
438 struct isl_schedule_node_get_filter_prefix_data *data)
440 enum isl_schedule_node_type type;
441 isl_multi_union_pw_aff *mupa;
442 isl_union_set *filter;
444 type = isl_schedule_tree_get_type(tree);
445 switch (type) {
446 case isl_schedule_node_error:
447 return -1;
448 case isl_schedule_node_expansion:
449 isl_die(isl_schedule_tree_get_ctx(tree), isl_error_internal,
450 "should be handled by caller", return -1);
451 case isl_schedule_node_extension:
452 isl_die(isl_schedule_tree_get_ctx(tree), isl_error_invalid,
453 "cannot handle extension nodes", return -1);
454 case isl_schedule_node_context:
455 case isl_schedule_node_leaf:
456 case isl_schedule_node_guard:
457 case isl_schedule_node_mark:
458 case isl_schedule_node_sequence:
459 case isl_schedule_node_set:
460 return 0;
461 case isl_schedule_node_domain:
462 filter = isl_schedule_tree_domain_get_domain(tree);
463 if (data->universe_domain)
464 filter = isl_union_set_universe(filter);
465 data->filter = filter;
466 break;
467 case isl_schedule_node_band:
468 if (isl_schedule_tree_band_n_member(tree) == 0)
469 return 0;
470 mupa = isl_schedule_tree_band_get_partial_schedule(tree);
471 if (data->collect_prefix) {
472 isl_multi_union_pw_aff_free(data->prefix);
473 mupa = isl_multi_union_pw_aff_reset_tuple_id(mupa,
474 isl_dim_set);
475 data->prefix = isl_multi_union_pw_aff_copy(mupa);
477 filter = isl_multi_union_pw_aff_domain(mupa);
478 filter = isl_union_set_universe(filter);
479 data->filter = filter;
480 break;
481 case isl_schedule_node_filter:
482 filter = isl_schedule_tree_filter_get_filter(tree);
483 if (data->universe_filter)
484 filter = isl_union_set_universe(filter);
485 data->filter = filter;
486 break;
489 if ((data->collect_prefix && !data->prefix) || !data->filter)
490 return -1;
492 data->initialized = 1;
494 return 0;
497 /* Update "data" based on the tree node "tree" in case "data" has
498 * already been initialized.
500 * Return 0 on success and -1 on error.
502 * If "tree" is a domain and data->universe_domain is not set, then
503 * intersect data->filter with the domain.
504 * If "tree" is a filter, then we intersect data->filter with this filter
505 * (or its universe).
506 * If "tree" is a band with at least one member and data->collect_prefix
507 * is set, then we extend data->prefix with the band schedule.
508 * If "tree" is an extension, then we make sure that we are not collecting
509 * information on any extended domain elements.
511 static int collect_filter_prefix_update(__isl_keep isl_schedule_tree *tree,
512 struct isl_schedule_node_get_filter_prefix_data *data)
514 enum isl_schedule_node_type type;
515 isl_multi_union_pw_aff *mupa;
516 isl_union_set *filter;
517 isl_union_map *extension;
518 int empty;
520 type = isl_schedule_tree_get_type(tree);
521 switch (type) {
522 case isl_schedule_node_error:
523 return -1;
524 case isl_schedule_node_expansion:
525 isl_die(isl_schedule_tree_get_ctx(tree), isl_error_internal,
526 "should be handled by caller", return -1);
527 case isl_schedule_node_extension:
528 extension = isl_schedule_tree_extension_get_extension(tree);
529 extension = isl_union_map_intersect_range(extension,
530 isl_union_set_copy(data->filter));
531 empty = isl_union_map_is_empty(extension);
532 isl_union_map_free(extension);
533 if (empty < 0)
534 return -1;
535 if (empty)
536 break;
537 isl_die(isl_schedule_tree_get_ctx(tree), isl_error_invalid,
538 "cannot handle extension nodes", return -1);
539 case isl_schedule_node_context:
540 case isl_schedule_node_leaf:
541 case isl_schedule_node_guard:
542 case isl_schedule_node_mark:
543 case isl_schedule_node_sequence:
544 case isl_schedule_node_set:
545 break;
546 case isl_schedule_node_domain:
547 if (data->universe_domain)
548 break;
549 filter = isl_schedule_tree_domain_get_domain(tree);
550 data->filter = isl_union_set_intersect(data->filter, filter);
551 break;
552 case isl_schedule_node_band:
553 if (isl_schedule_tree_band_n_member(tree) == 0)
554 break;
555 if (!data->collect_prefix)
556 break;
557 mupa = isl_schedule_tree_band_get_partial_schedule(tree);
558 data->prefix = isl_multi_union_pw_aff_flat_range_product(mupa,
559 data->prefix);
560 if (!data->prefix)
561 return -1;
562 break;
563 case isl_schedule_node_filter:
564 filter = isl_schedule_tree_filter_get_filter(tree);
565 if (data->universe_filter)
566 filter = isl_union_set_universe(filter);
567 data->filter = isl_union_set_intersect(data->filter, filter);
568 if (!data->filter)
569 return -1;
570 break;
573 return 0;
576 /* Collect filter and/or prefix information from the first "n"
577 * elements in "list" (which represent the ancestors of a node).
578 * Store the results in "data".
580 * Extension nodes are only supported if they do not affect the outcome,
581 * i.e., if we are collecting information on non-extended domain elements,
582 * or if we are collecting the universe domain (without prefix).
584 * Return 0 on success and -1 on error.
586 * We traverse the list from innermost ancestor (last element)
587 * to outermost ancestor (first element), calling collect_filter_prefix_init
588 * on each node as long as we have not been able to extract any information
589 * yet and collect_filter_prefix_update afterwards.
590 * If we come across an expansion node, then we interrupt the traversal
591 * and call collect_filter_prefix_expansion to restart the traversal
592 * over the remaining ancestors and to combine the results with those
593 * that have already been collected.
594 * If we come across an extension node and we are only computing
595 * the universe domain, then we interrupt the traversal and call
596 * collect_universe_domain_extension to restart the traversal
597 * over the remaining ancestors and to combine the results with those
598 * that have already been collected.
599 * On successful return, data->initialized will be set since the outermost
600 * ancestor is a domain node, which always results in an initialization.
602 static int collect_filter_prefix(__isl_keep isl_schedule_tree_list *list,
603 int n, struct isl_schedule_node_get_filter_prefix_data *data)
605 int i;
607 if (!list)
608 return -1;
610 for (i = n - 1; i >= 0; --i) {
611 isl_schedule_tree *tree;
612 enum isl_schedule_node_type type;
613 int r;
615 tree = isl_schedule_tree_list_get_schedule_tree(list, i);
616 if (!tree)
617 return -1;
618 type = isl_schedule_tree_get_type(tree);
619 if (type == isl_schedule_node_expansion)
620 return collect_filter_prefix_expansion(tree, list, i,
621 data);
622 if (type == isl_schedule_node_extension &&
623 data->universe_domain && !data->collect_prefix)
624 return collect_universe_domain_extension(tree, list, i,
625 data);
626 if (!data->initialized)
627 r = collect_filter_prefix_init(tree, data);
628 else
629 r = collect_filter_prefix_update(tree, data);
630 isl_schedule_tree_free(tree);
631 if (r < 0)
632 return -1;
635 return 0;
638 /* Return the concatenation of the partial schedules of all outer band
639 * nodes of "node" interesected with all outer filters
640 * as an isl_multi_union_pw_aff.
641 * None of the ancestors of "node" may be an extension node, unless
642 * there is also a filter ancestor that filters out all the extended
643 * domain elements.
645 * If "node" is pointing at the root of the schedule tree, then
646 * there are no domain elements reaching the current node, so
647 * we return an empty result.
649 * We collect all the filters and partial schedules in collect_filter_prefix
650 * and intersect the domain of the combined schedule with the combined filter.
652 __isl_give isl_multi_union_pw_aff *
653 isl_schedule_node_get_prefix_schedule_multi_union_pw_aff(
654 __isl_keep isl_schedule_node *node)
656 int n;
657 isl_space *space;
658 struct isl_schedule_node_get_filter_prefix_data data;
660 if (!node)
661 return NULL;
663 space = isl_schedule_get_space(node->schedule);
664 space = isl_space_set_from_params(space);
665 if (node->tree == node->schedule->root)
666 return isl_multi_union_pw_aff_zero(space);
668 data.initialized = 0;
669 data.universe_domain = 1;
670 data.universe_filter = 0;
671 data.collect_prefix = 1;
672 data.filter = NULL;
673 data.prefix = isl_multi_union_pw_aff_zero(space);
675 n = isl_schedule_tree_list_n_schedule_tree(node->ancestors);
676 if (collect_filter_prefix(node->ancestors, n, &data) < 0)
677 data.prefix = isl_multi_union_pw_aff_free(data.prefix);
679 data.prefix = isl_multi_union_pw_aff_intersect_domain(data.prefix,
680 data.filter);
682 return data.prefix;
685 /* Return the concatenation of the partial schedules of all outer band
686 * nodes of "node" interesected with all outer filters
687 * as an isl_union_pw_multi_aff.
688 * None of the ancestors of "node" may be an extension node, unless
689 * there is also a filter ancestor that filters out all the extended
690 * domain elements.
692 * If "node" is pointing at the root of the schedule tree, then
693 * there are no domain elements reaching the current node, so
694 * we return an empty result.
696 * We collect all the filters and partial schedules in collect_filter_prefix.
697 * The partial schedules are collected as an isl_multi_union_pw_aff.
698 * If this isl_multi_union_pw_aff is zero-dimensional, then it does not
699 * contain any domain information, so we construct the isl_union_pw_multi_aff
700 * result as a zero-dimensional function on the collected filter.
701 * Otherwise, we convert the isl_multi_union_pw_aff to
702 * an isl_multi_union_pw_aff and intersect the domain with the filter.
704 __isl_give isl_union_pw_multi_aff *
705 isl_schedule_node_get_prefix_schedule_union_pw_multi_aff(
706 __isl_keep isl_schedule_node *node)
708 int n;
709 isl_space *space;
710 isl_union_pw_multi_aff *prefix;
711 struct isl_schedule_node_get_filter_prefix_data data;
713 if (!node)
714 return NULL;
716 space = isl_schedule_get_space(node->schedule);
717 if (node->tree == node->schedule->root)
718 return isl_union_pw_multi_aff_empty(space);
720 space = isl_space_set_from_params(space);
721 data.initialized = 0;
722 data.universe_domain = 1;
723 data.universe_filter = 0;
724 data.collect_prefix = 1;
725 data.filter = NULL;
726 data.prefix = isl_multi_union_pw_aff_zero(space);
728 n = isl_schedule_tree_list_n_schedule_tree(node->ancestors);
729 if (collect_filter_prefix(node->ancestors, n, &data) < 0)
730 data.prefix = isl_multi_union_pw_aff_free(data.prefix);
732 if (data.prefix &&
733 isl_multi_union_pw_aff_dim(data.prefix, isl_dim_set) == 0) {
734 isl_multi_union_pw_aff_free(data.prefix);
735 prefix = isl_union_pw_multi_aff_from_domain(data.filter);
736 } else {
737 prefix =
738 isl_union_pw_multi_aff_from_multi_union_pw_aff(data.prefix);
739 prefix = isl_union_pw_multi_aff_intersect_domain(prefix,
740 data.filter);
743 return prefix;
746 /* Return the concatenation of the partial schedules of all outer band
747 * nodes of "node" interesected with all outer filters
748 * as an isl_union_map.
750 __isl_give isl_union_map *isl_schedule_node_get_prefix_schedule_union_map(
751 __isl_keep isl_schedule_node *node)
753 isl_union_pw_multi_aff *upma;
755 upma = isl_schedule_node_get_prefix_schedule_union_pw_multi_aff(node);
756 return isl_union_map_from_union_pw_multi_aff(upma);
759 /* Return the concatenation of the partial schedules of all outer band
760 * nodes of "node" intersected with all outer domain constraints.
761 * None of the ancestors of "node" may be an extension node, unless
762 * there is also a filter ancestor that filters out all the extended
763 * domain elements.
765 * Essentially, this function intersects the domain of the output
766 * of isl_schedule_node_get_prefix_schedule_union_map with the output
767 * of isl_schedule_node_get_domain, except that it only traverses
768 * the ancestors of "node" once.
770 __isl_give isl_union_map *isl_schedule_node_get_prefix_schedule_relation(
771 __isl_keep isl_schedule_node *node)
773 int n;
774 isl_space *space;
775 isl_union_map *prefix;
776 struct isl_schedule_node_get_filter_prefix_data data;
778 if (!node)
779 return NULL;
781 space = isl_schedule_get_space(node->schedule);
782 if (node->tree == node->schedule->root)
783 return isl_union_map_empty(space);
785 space = isl_space_set_from_params(space);
786 data.initialized = 0;
787 data.universe_domain = 0;
788 data.universe_filter = 0;
789 data.collect_prefix = 1;
790 data.filter = NULL;
791 data.prefix = isl_multi_union_pw_aff_zero(space);
793 n = isl_schedule_tree_list_n_schedule_tree(node->ancestors);
794 if (collect_filter_prefix(node->ancestors, n, &data) < 0)
795 data.prefix = isl_multi_union_pw_aff_free(data.prefix);
797 if (data.prefix &&
798 isl_multi_union_pw_aff_dim(data.prefix, isl_dim_set) == 0) {
799 isl_multi_union_pw_aff_free(data.prefix);
800 prefix = isl_union_map_from_domain(data.filter);
801 } else {
802 prefix = isl_union_map_from_multi_union_pw_aff(data.prefix);
803 prefix = isl_union_map_intersect_domain(prefix, data.filter);
806 return prefix;
809 /* Return the domain elements that reach "node".
811 * If "node" is pointing at the root of the schedule tree, then
812 * there are no domain elements reaching the current node, so
813 * we return an empty result.
814 * None of the ancestors of "node" may be an extension node, unless
815 * there is also a filter ancestor that filters out all the extended
816 * domain elements.
818 * Otherwise, we collect all filters reaching the node,
819 * intersected with the root domain in collect_filter_prefix.
821 __isl_give isl_union_set *isl_schedule_node_get_domain(
822 __isl_keep isl_schedule_node *node)
824 int n;
825 struct isl_schedule_node_get_filter_prefix_data data;
827 if (!node)
828 return NULL;
830 if (node->tree == node->schedule->root) {
831 isl_space *space;
833 space = isl_schedule_get_space(node->schedule);
834 return isl_union_set_empty(space);
837 data.initialized = 0;
838 data.universe_domain = 0;
839 data.universe_filter = 0;
840 data.collect_prefix = 0;
841 data.filter = NULL;
842 data.prefix = NULL;
844 n = isl_schedule_tree_list_n_schedule_tree(node->ancestors);
845 if (collect_filter_prefix(node->ancestors, n, &data) < 0)
846 data.filter = isl_union_set_free(data.filter);
848 return data.filter;
851 /* Return the union of universe sets of the domain elements that reach "node".
853 * If "node" is pointing at the root of the schedule tree, then
854 * there are no domain elements reaching the current node, so
855 * we return an empty result.
857 * Otherwise, we collect the universes of all filters reaching the node
858 * in collect_filter_prefix.
860 __isl_give isl_union_set *isl_schedule_node_get_universe_domain(
861 __isl_keep isl_schedule_node *node)
863 int n;
864 struct isl_schedule_node_get_filter_prefix_data data;
866 if (!node)
867 return NULL;
869 if (node->tree == node->schedule->root) {
870 isl_space *space;
872 space = isl_schedule_get_space(node->schedule);
873 return isl_union_set_empty(space);
876 data.initialized = 0;
877 data.universe_domain = 1;
878 data.universe_filter = 1;
879 data.collect_prefix = 0;
880 data.filter = NULL;
881 data.prefix = NULL;
883 n = isl_schedule_tree_list_n_schedule_tree(node->ancestors);
884 if (collect_filter_prefix(node->ancestors, n, &data) < 0)
885 data.filter = isl_union_set_free(data.filter);
887 return data.filter;
890 /* Return the subtree schedule of "node".
892 * Since isl_schedule_tree_get_subtree_schedule_union_map does not handle
893 * trees that do not contain any schedule information, we first
894 * move down to the first relevant descendant and handle leaves ourselves.
896 * If the subtree rooted at "node" contains any expansion nodes, then
897 * the returned subtree schedule is formulated in terms of the expanded
898 * domains.
899 * The subtree is not allowed to contain any extension nodes.
901 __isl_give isl_union_map *isl_schedule_node_get_subtree_schedule_union_map(
902 __isl_keep isl_schedule_node *node)
904 isl_schedule_tree *tree, *leaf;
905 isl_union_map *umap;
907 tree = isl_schedule_node_get_tree(node);
908 leaf = isl_schedule_node_peek_leaf(node);
909 tree = isl_schedule_tree_first_schedule_descendant(tree, leaf);
910 if (!tree)
911 return NULL;
912 if (tree == leaf) {
913 isl_union_set *domain;
914 domain = isl_schedule_node_get_universe_domain(node);
915 isl_schedule_tree_free(tree);
916 return isl_union_map_from_domain(domain);
919 umap = isl_schedule_tree_get_subtree_schedule_union_map(tree);
920 isl_schedule_tree_free(tree);
921 return umap;
924 /* Return the number of ancestors of "node" in its schedule tree.
926 int isl_schedule_node_get_tree_depth(__isl_keep isl_schedule_node *node)
928 if (!node)
929 return -1;
930 return isl_schedule_tree_list_n_schedule_tree(node->ancestors);
933 /* Does "node" have a parent?
935 * That is, does it point to any node of the schedule other than the root?
937 isl_bool isl_schedule_node_has_parent(__isl_keep isl_schedule_node *node)
939 if (!node)
940 return isl_bool_error;
941 if (!node->ancestors)
942 return isl_bool_error;
944 return isl_schedule_tree_list_n_schedule_tree(node->ancestors) != 0;
947 /* Return the position of "node" among the children of its parent.
949 int isl_schedule_node_get_child_position(__isl_keep isl_schedule_node *node)
951 int n;
952 int has_parent;
954 if (!node)
955 return -1;
956 has_parent = isl_schedule_node_has_parent(node);
957 if (has_parent < 0)
958 return -1;
959 if (!has_parent)
960 isl_die(isl_schedule_node_get_ctx(node), isl_error_invalid,
961 "node has no parent", return -1);
963 n = isl_schedule_tree_list_n_schedule_tree(node->ancestors);
964 return node->child_pos[n - 1];
967 /* Does the parent (if any) of "node" have any children with a smaller child
968 * position than this one?
970 isl_bool isl_schedule_node_has_previous_sibling(
971 __isl_keep isl_schedule_node *node)
973 int n;
974 isl_bool has_parent;
976 if (!node)
977 return isl_bool_error;
978 has_parent = isl_schedule_node_has_parent(node);
979 if (has_parent < 0 || !has_parent)
980 return has_parent;
982 n = isl_schedule_tree_list_n_schedule_tree(node->ancestors);
984 return node->child_pos[n - 1] > 0;
987 /* Does the parent (if any) of "node" have any children with a greater child
988 * position than this one?
990 isl_bool isl_schedule_node_has_next_sibling(__isl_keep isl_schedule_node *node)
992 int n, n_child;
993 isl_bool has_parent;
994 isl_schedule_tree *tree;
996 if (!node)
997 return isl_bool_error;
998 has_parent = isl_schedule_node_has_parent(node);
999 if (has_parent < 0 || !has_parent)
1000 return has_parent;
1002 n = isl_schedule_tree_list_n_schedule_tree(node->ancestors);
1003 tree = isl_schedule_tree_list_get_schedule_tree(node->ancestors, n - 1);
1004 if (!tree)
1005 return isl_bool_error;
1006 n_child = isl_schedule_tree_list_n_schedule_tree(tree->children);
1007 isl_schedule_tree_free(tree);
1009 return node->child_pos[n - 1] + 1 < n_child;
1012 /* Does "node" have any children?
1014 * Any node other than the leaf nodes is considered to have at least
1015 * one child, even if the corresponding isl_schedule_tree does not
1016 * have any children.
1018 isl_bool isl_schedule_node_has_children(__isl_keep isl_schedule_node *node)
1020 if (!node)
1021 return isl_bool_error;
1022 return !isl_schedule_tree_is_leaf(node->tree);
1025 /* Return the number of children of "node"?
1027 * Any node other than the leaf nodes is considered to have at least
1028 * one child, even if the corresponding isl_schedule_tree does not
1029 * have any children. That is, the number of children of "node" is
1030 * only zero if its tree is the explicit empty tree. Otherwise,
1031 * if the isl_schedule_tree has any children, then it is equal
1032 * to the number of children of "node". If it has zero children,
1033 * then "node" still has a leaf node as child.
1035 int isl_schedule_node_n_children(__isl_keep isl_schedule_node *node)
1037 int n;
1039 if (!node)
1040 return -1;
1042 if (isl_schedule_tree_is_leaf(node->tree))
1043 return 0;
1045 n = isl_schedule_tree_n_children(node->tree);
1046 if (n == 0)
1047 return 1;
1049 return n;
1052 /* Move the "node" pointer to the ancestor of the given generation
1053 * of the node it currently points to, where generation 0 is the node
1054 * itself and generation 1 is its parent.
1056 __isl_give isl_schedule_node *isl_schedule_node_ancestor(
1057 __isl_take isl_schedule_node *node, int generation)
1059 int n;
1060 isl_schedule_tree *tree;
1062 if (!node)
1063 return NULL;
1064 if (generation == 0)
1065 return node;
1066 n = isl_schedule_node_get_tree_depth(node);
1067 if (n < 0)
1068 return isl_schedule_node_free(node);
1069 if (generation < 0 || generation > n)
1070 isl_die(isl_schedule_node_get_ctx(node), isl_error_invalid,
1071 "generation out of bounds",
1072 return isl_schedule_node_free(node));
1073 node = isl_schedule_node_cow(node);
1074 if (!node)
1075 return NULL;
1077 tree = isl_schedule_tree_list_get_schedule_tree(node->ancestors,
1078 n - generation);
1079 isl_schedule_tree_free(node->tree);
1080 node->tree = tree;
1081 node->ancestors = isl_schedule_tree_list_drop(node->ancestors,
1082 n - generation, generation);
1083 if (!node->ancestors || !node->tree)
1084 return isl_schedule_node_free(node);
1086 return node;
1089 /* Move the "node" pointer to the parent of the node it currently points to.
1091 __isl_give isl_schedule_node *isl_schedule_node_parent(
1092 __isl_take isl_schedule_node *node)
1094 if (!node)
1095 return NULL;
1096 if (!isl_schedule_node_has_parent(node))
1097 isl_die(isl_schedule_node_get_ctx(node), isl_error_invalid,
1098 "node has no parent",
1099 return isl_schedule_node_free(node));
1100 return isl_schedule_node_ancestor(node, 1);
1103 /* Move the "node" pointer to the root of its schedule tree.
1105 __isl_give isl_schedule_node *isl_schedule_node_root(
1106 __isl_take isl_schedule_node *node)
1108 int n;
1110 if (!node)
1111 return NULL;
1112 n = isl_schedule_node_get_tree_depth(node);
1113 if (n < 0)
1114 return isl_schedule_node_free(node);
1115 return isl_schedule_node_ancestor(node, n);
1118 /* Move the "node" pointer to the child at position "pos" of the node
1119 * it currently points to.
1121 __isl_give isl_schedule_node *isl_schedule_node_child(
1122 __isl_take isl_schedule_node *node, int pos)
1124 int n;
1125 isl_ctx *ctx;
1126 isl_schedule_tree *tree;
1127 int *child_pos;
1129 node = isl_schedule_node_cow(node);
1130 if (!node)
1131 return NULL;
1132 if (!isl_schedule_node_has_children(node))
1133 isl_die(isl_schedule_node_get_ctx(node), isl_error_invalid,
1134 "node has no children",
1135 return isl_schedule_node_free(node));
1137 ctx = isl_schedule_node_get_ctx(node);
1138 n = isl_schedule_tree_list_n_schedule_tree(node->ancestors);
1139 child_pos = isl_realloc_array(ctx, node->child_pos, int, n + 1);
1140 if (!child_pos)
1141 return isl_schedule_node_free(node);
1142 node->child_pos = child_pos;
1143 node->child_pos[n] = pos;
1145 node->ancestors = isl_schedule_tree_list_add(node->ancestors,
1146 isl_schedule_tree_copy(node->tree));
1147 tree = node->tree;
1148 if (isl_schedule_tree_has_children(tree))
1149 tree = isl_schedule_tree_get_child(tree, pos);
1150 else
1151 tree = isl_schedule_node_get_leaf(node);
1152 isl_schedule_tree_free(node->tree);
1153 node->tree = tree;
1155 if (!node->tree || !node->ancestors)
1156 return isl_schedule_node_free(node);
1158 return node;
1161 /* Move the "node" pointer to the first child of the node
1162 * it currently points to.
1164 __isl_give isl_schedule_node *isl_schedule_node_first_child(
1165 __isl_take isl_schedule_node *node)
1167 return isl_schedule_node_child(node, 0);
1170 /* Move the "node" pointer to the child of this node's parent in
1171 * the previous child position.
1173 __isl_give isl_schedule_node *isl_schedule_node_previous_sibling(
1174 __isl_take isl_schedule_node *node)
1176 int n;
1177 isl_schedule_tree *parent, *tree;
1179 node = isl_schedule_node_cow(node);
1180 if (!node)
1181 return NULL;
1182 if (!isl_schedule_node_has_previous_sibling(node))
1183 isl_die(isl_schedule_node_get_ctx(node), isl_error_invalid,
1184 "node has no previous sibling",
1185 return isl_schedule_node_free(node));
1187 n = isl_schedule_tree_list_n_schedule_tree(node->ancestors);
1188 parent = isl_schedule_tree_list_get_schedule_tree(node->ancestors,
1189 n - 1);
1190 if (!parent)
1191 return isl_schedule_node_free(node);
1192 node->child_pos[n - 1]--;
1193 tree = isl_schedule_tree_list_get_schedule_tree(parent->children,
1194 node->child_pos[n - 1]);
1195 isl_schedule_tree_free(parent);
1196 if (!tree)
1197 return isl_schedule_node_free(node);
1198 isl_schedule_tree_free(node->tree);
1199 node->tree = tree;
1201 return node;
1204 /* Move the "node" pointer to the child of this node's parent in
1205 * the next child position.
1207 __isl_give isl_schedule_node *isl_schedule_node_next_sibling(
1208 __isl_take isl_schedule_node *node)
1210 int n;
1211 isl_schedule_tree *parent, *tree;
1213 node = isl_schedule_node_cow(node);
1214 if (!node)
1215 return NULL;
1216 if (!isl_schedule_node_has_next_sibling(node))
1217 isl_die(isl_schedule_node_get_ctx(node), isl_error_invalid,
1218 "node has no next sibling",
1219 return isl_schedule_node_free(node));
1221 n = isl_schedule_tree_list_n_schedule_tree(node->ancestors);
1222 parent = isl_schedule_tree_list_get_schedule_tree(node->ancestors,
1223 n - 1);
1224 if (!parent)
1225 return isl_schedule_node_free(node);
1226 node->child_pos[n - 1]++;
1227 tree = isl_schedule_tree_list_get_schedule_tree(parent->children,
1228 node->child_pos[n - 1]);
1229 isl_schedule_tree_free(parent);
1230 if (!tree)
1231 return isl_schedule_node_free(node);
1232 isl_schedule_tree_free(node->tree);
1233 node->tree = tree;
1235 return node;
1238 /* Return a copy to the child at position "pos" of "node".
1240 __isl_give isl_schedule_node *isl_schedule_node_get_child(
1241 __isl_keep isl_schedule_node *node, int pos)
1243 return isl_schedule_node_child(isl_schedule_node_copy(node), pos);
1246 /* Traverse the descendant of "node" in depth-first order, including
1247 * "node" itself. Call "enter" whenever a node is entered and "leave"
1248 * whenever a node is left. The callback "enter" is responsible
1249 * for moving to the deepest initial subtree of its argument that
1250 * should be traversed.
1252 static __isl_give isl_schedule_node *traverse(
1253 __isl_take isl_schedule_node *node,
1254 __isl_give isl_schedule_node *(*enter)(
1255 __isl_take isl_schedule_node *node, void *user),
1256 __isl_give isl_schedule_node *(*leave)(
1257 __isl_take isl_schedule_node *node, void *user),
1258 void *user)
1260 int depth;
1262 if (!node)
1263 return NULL;
1265 depth = isl_schedule_node_get_tree_depth(node);
1266 do {
1267 node = enter(node, user);
1268 node = leave(node, user);
1269 while (node && isl_schedule_node_get_tree_depth(node) > depth &&
1270 !isl_schedule_node_has_next_sibling(node)) {
1271 node = isl_schedule_node_parent(node);
1272 node = leave(node, user);
1274 if (node && isl_schedule_node_get_tree_depth(node) > depth)
1275 node = isl_schedule_node_next_sibling(node);
1276 } while (node && isl_schedule_node_get_tree_depth(node) > depth);
1278 return node;
1281 /* Internal data structure for isl_schedule_node_foreach_descendant_top_down.
1283 * "fn" is the user-specified callback function.
1284 * "user" is the user-specified argument for the callback.
1286 struct isl_schedule_node_preorder_data {
1287 isl_bool (*fn)(__isl_keep isl_schedule_node *node, void *user);
1288 void *user;
1291 /* Callback for "traverse" to enter a node and to move
1292 * to the deepest initial subtree that should be traversed
1293 * for use in a preorder visit.
1295 * If the user callback returns a negative value, then we abort
1296 * the traversal. If this callback returns zero, then we skip
1297 * the subtree rooted at the current node. Otherwise, we move
1298 * down to the first child and repeat the process until a leaf
1299 * is reached.
1301 static __isl_give isl_schedule_node *preorder_enter(
1302 __isl_take isl_schedule_node *node, void *user)
1304 struct isl_schedule_node_preorder_data *data = user;
1306 if (!node)
1307 return NULL;
1309 do {
1310 isl_bool r;
1312 r = data->fn(node, data->user);
1313 if (r < 0)
1314 return isl_schedule_node_free(node);
1315 if (r == isl_bool_false)
1316 return node;
1317 } while (isl_schedule_node_has_children(node) &&
1318 (node = isl_schedule_node_first_child(node)) != NULL);
1320 return node;
1323 /* Callback for "traverse" to leave a node
1324 * for use in a preorder visit.
1325 * Since we already visited the node when we entered it,
1326 * we do not need to do anything here.
1328 static __isl_give isl_schedule_node *preorder_leave(
1329 __isl_take isl_schedule_node *node, void *user)
1331 return node;
1334 /* Traverse the descendants of "node" (including the node itself)
1335 * in depth first preorder.
1337 * If "fn" returns -1 on any of the nodes, then the traversal is aborted.
1338 * If "fn" returns 0 on any of the nodes, then the subtree rooted
1339 * at that node is skipped.
1341 * Return 0 on success and -1 on failure.
1343 isl_stat isl_schedule_node_foreach_descendant_top_down(
1344 __isl_keep isl_schedule_node *node,
1345 isl_bool (*fn)(__isl_keep isl_schedule_node *node, void *user),
1346 void *user)
1348 struct isl_schedule_node_preorder_data data = { fn, user };
1350 node = isl_schedule_node_copy(node);
1351 node = traverse(node, &preorder_enter, &preorder_leave, &data);
1352 isl_schedule_node_free(node);
1354 return node ? isl_stat_ok : isl_stat_error;
1357 /* Internal data structure for isl_schedule_node_map_descendant_bottom_up.
1359 * "fn" is the user-specified callback function.
1360 * "user" is the user-specified argument for the callback.
1362 struct isl_schedule_node_postorder_data {
1363 __isl_give isl_schedule_node *(*fn)(__isl_take isl_schedule_node *node,
1364 void *user);
1365 void *user;
1368 /* Callback for "traverse" to enter a node and to move
1369 * to the deepest initial subtree that should be traversed
1370 * for use in a postorder visit.
1372 * Since we are performing a postorder visit, we only need
1373 * to move to the deepest initial leaf here.
1375 static __isl_give isl_schedule_node *postorder_enter(
1376 __isl_take isl_schedule_node *node, void *user)
1378 while (node && isl_schedule_node_has_children(node))
1379 node = isl_schedule_node_first_child(node);
1381 return node;
1384 /* Callback for "traverse" to leave a node
1385 * for use in a postorder visit.
1387 * Since we are performing a postorder visit, we need
1388 * to call the user callback here.
1390 static __isl_give isl_schedule_node *postorder_leave(
1391 __isl_take isl_schedule_node *node, void *user)
1393 struct isl_schedule_node_postorder_data *data = user;
1395 return data->fn(node, data->user);
1398 /* Traverse the descendants of "node" (including the node itself)
1399 * in depth first postorder, allowing the user to modify the visited node.
1400 * The traversal continues from the node returned by the callback function.
1401 * It is the responsibility of the user to ensure that this does not
1402 * lead to an infinite loop. It is safest to always return a pointer
1403 * to the same position (same ancestors and child positions) as the input node.
1405 __isl_give isl_schedule_node *isl_schedule_node_map_descendant_bottom_up(
1406 __isl_take isl_schedule_node *node,
1407 __isl_give isl_schedule_node *(*fn)(__isl_take isl_schedule_node *node,
1408 void *user), void *user)
1410 struct isl_schedule_node_postorder_data data = { fn, user };
1412 return traverse(node, &postorder_enter, &postorder_leave, &data);
1415 /* Traverse the ancestors of "node" from the root down to and including
1416 * the parent of "node", calling "fn" on each of them.
1418 * If "fn" returns -1 on any of the nodes, then the traversal is aborted.
1420 * Return 0 on success and -1 on failure.
1422 isl_stat isl_schedule_node_foreach_ancestor_top_down(
1423 __isl_keep isl_schedule_node *node,
1424 isl_stat (*fn)(__isl_keep isl_schedule_node *node, void *user),
1425 void *user)
1427 int i, n;
1429 if (!node)
1430 return isl_stat_error;
1432 n = isl_schedule_node_get_tree_depth(node);
1433 for (i = 0; i < n; ++i) {
1434 isl_schedule_node *ancestor;
1435 isl_stat r;
1437 ancestor = isl_schedule_node_copy(node);
1438 ancestor = isl_schedule_node_ancestor(ancestor, n - i);
1439 r = fn(ancestor, user);
1440 isl_schedule_node_free(ancestor);
1441 if (r < 0)
1442 return isl_stat_error;
1445 return isl_stat_ok;
1448 /* Is any node in the subtree rooted at "node" anchored?
1449 * That is, do any of these nodes reference the outer band nodes?
1451 isl_bool isl_schedule_node_is_subtree_anchored(
1452 __isl_keep isl_schedule_node *node)
1454 if (!node)
1455 return isl_bool_error;
1456 return isl_schedule_tree_is_subtree_anchored(node->tree);
1459 /* Return the number of members in the given band node.
1461 unsigned isl_schedule_node_band_n_member(__isl_keep isl_schedule_node *node)
1463 return node ? isl_schedule_tree_band_n_member(node->tree) : 0;
1466 /* Is the band member at position "pos" of the band node "node"
1467 * marked coincident?
1469 isl_bool isl_schedule_node_band_member_get_coincident(
1470 __isl_keep isl_schedule_node *node, int pos)
1472 if (!node)
1473 return isl_bool_error;
1474 return isl_schedule_tree_band_member_get_coincident(node->tree, pos);
1477 /* Mark the band member at position "pos" the band node "node"
1478 * as being coincident or not according to "coincident".
1480 __isl_give isl_schedule_node *isl_schedule_node_band_member_set_coincident(
1481 __isl_take isl_schedule_node *node, int pos, int coincident)
1483 int c;
1484 isl_schedule_tree *tree;
1486 if (!node)
1487 return NULL;
1488 c = isl_schedule_node_band_member_get_coincident(node, pos);
1489 if (c == coincident)
1490 return node;
1492 tree = isl_schedule_tree_copy(node->tree);
1493 tree = isl_schedule_tree_band_member_set_coincident(tree, pos,
1494 coincident);
1495 node = isl_schedule_node_graft_tree(node, tree);
1497 return node;
1500 /* Is the band node "node" marked permutable?
1502 isl_bool isl_schedule_node_band_get_permutable(
1503 __isl_keep isl_schedule_node *node)
1505 if (!node)
1506 return isl_bool_error;
1508 return isl_schedule_tree_band_get_permutable(node->tree);
1511 /* Mark the band node "node" permutable or not according to "permutable"?
1513 __isl_give isl_schedule_node *isl_schedule_node_band_set_permutable(
1514 __isl_take isl_schedule_node *node, int permutable)
1516 isl_schedule_tree *tree;
1518 if (!node)
1519 return NULL;
1520 if (isl_schedule_node_band_get_permutable(node) == permutable)
1521 return node;
1523 tree = isl_schedule_tree_copy(node->tree);
1524 tree = isl_schedule_tree_band_set_permutable(tree, permutable);
1525 node = isl_schedule_node_graft_tree(node, tree);
1527 return node;
1530 /* Return the schedule space of the band node.
1532 __isl_give isl_space *isl_schedule_node_band_get_space(
1533 __isl_keep isl_schedule_node *node)
1535 if (!node)
1536 return NULL;
1538 return isl_schedule_tree_band_get_space(node->tree);
1541 /* Return the schedule of the band node in isolation.
1543 __isl_give isl_multi_union_pw_aff *isl_schedule_node_band_get_partial_schedule(
1544 __isl_keep isl_schedule_node *node)
1546 if (!node)
1547 return NULL;
1549 return isl_schedule_tree_band_get_partial_schedule(node->tree);
1552 /* Return the schedule of the band node in isolation in the form of
1553 * an isl_union_map.
1555 * If the band does not have any members, then we construct a universe map
1556 * with the universe of the domain elements reaching the node as domain.
1557 * Otherwise, we extract an isl_multi_union_pw_aff representation and
1558 * convert that to an isl_union_map.
1560 __isl_give isl_union_map *isl_schedule_node_band_get_partial_schedule_union_map(
1561 __isl_keep isl_schedule_node *node)
1563 isl_multi_union_pw_aff *mupa;
1565 if (!node)
1566 return NULL;
1568 if (isl_schedule_node_get_type(node) != isl_schedule_node_band)
1569 isl_die(isl_schedule_node_get_ctx(node), isl_error_invalid,
1570 "not a band node", return NULL);
1571 if (isl_schedule_node_band_n_member(node) == 0) {
1572 isl_union_set *domain;
1574 domain = isl_schedule_node_get_universe_domain(node);
1575 return isl_union_map_from_domain(domain);
1578 mupa = isl_schedule_node_band_get_partial_schedule(node);
1579 return isl_union_map_from_multi_union_pw_aff(mupa);
1582 /* Return the loop AST generation type for the band member of band node "node"
1583 * at position "pos".
1585 enum isl_ast_loop_type isl_schedule_node_band_member_get_ast_loop_type(
1586 __isl_keep isl_schedule_node *node, int pos)
1588 if (!node)
1589 return isl_ast_loop_error;
1591 return isl_schedule_tree_band_member_get_ast_loop_type(node->tree, pos);
1594 /* Set the loop AST generation type for the band member of band node "node"
1595 * at position "pos" to "type".
1597 __isl_give isl_schedule_node *isl_schedule_node_band_member_set_ast_loop_type(
1598 __isl_take isl_schedule_node *node, int pos,
1599 enum isl_ast_loop_type type)
1601 isl_schedule_tree *tree;
1603 if (!node)
1604 return NULL;
1606 tree = isl_schedule_tree_copy(node->tree);
1607 tree = isl_schedule_tree_band_member_set_ast_loop_type(tree, pos, type);
1608 return isl_schedule_node_graft_tree(node, tree);
1611 /* Return the loop AST generation type for the band member of band node "node"
1612 * at position "pos" for the isolated part.
1614 enum isl_ast_loop_type isl_schedule_node_band_member_get_isolate_ast_loop_type(
1615 __isl_keep isl_schedule_node *node, int pos)
1617 if (!node)
1618 return isl_ast_loop_error;
1620 return isl_schedule_tree_band_member_get_isolate_ast_loop_type(
1621 node->tree, pos);
1624 /* Set the loop AST generation type for the band member of band node "node"
1625 * at position "pos" for the isolated part to "type".
1627 __isl_give isl_schedule_node *
1628 isl_schedule_node_band_member_set_isolate_ast_loop_type(
1629 __isl_take isl_schedule_node *node, int pos,
1630 enum isl_ast_loop_type type)
1632 isl_schedule_tree *tree;
1634 if (!node)
1635 return NULL;
1637 tree = isl_schedule_tree_copy(node->tree);
1638 tree = isl_schedule_tree_band_member_set_isolate_ast_loop_type(tree,
1639 pos, type);
1640 return isl_schedule_node_graft_tree(node, tree);
1643 /* Return the AST build options associated to band node "node".
1645 __isl_give isl_union_set *isl_schedule_node_band_get_ast_build_options(
1646 __isl_keep isl_schedule_node *node)
1648 if (!node)
1649 return NULL;
1651 return isl_schedule_tree_band_get_ast_build_options(node->tree);
1654 /* Replace the AST build options associated to band node "node" by "options".
1656 __isl_give isl_schedule_node *isl_schedule_node_band_set_ast_build_options(
1657 __isl_take isl_schedule_node *node, __isl_take isl_union_set *options)
1659 isl_schedule_tree *tree;
1661 if (!node || !options)
1662 goto error;
1664 tree = isl_schedule_tree_copy(node->tree);
1665 tree = isl_schedule_tree_band_set_ast_build_options(tree, options);
1666 return isl_schedule_node_graft_tree(node, tree);
1667 error:
1668 isl_schedule_node_free(node);
1669 isl_union_set_free(options);
1670 return NULL;
1673 /* Return the "isolate" option associated to band node "node".
1675 __isl_give isl_set *isl_schedule_node_band_get_ast_isolate_option(
1676 __isl_keep isl_schedule_node *node)
1678 int depth;
1680 if (!node)
1681 return NULL;
1683 depth = isl_schedule_node_get_schedule_depth(node);
1684 return isl_schedule_tree_band_get_ast_isolate_option(node->tree, depth);
1687 /* Make sure that that spaces of "node" and "mv" are the same.
1688 * Return -1 on error, reporting the error to the user.
1690 static int check_space_multi_val(__isl_keep isl_schedule_node *node,
1691 __isl_keep isl_multi_val *mv)
1693 isl_space *node_space, *mv_space;
1694 int equal;
1696 node_space = isl_schedule_node_band_get_space(node);
1697 mv_space = isl_multi_val_get_space(mv);
1698 equal = isl_space_tuple_is_equal(node_space, isl_dim_set,
1699 mv_space, isl_dim_set);
1700 isl_space_free(mv_space);
1701 isl_space_free(node_space);
1702 if (equal < 0)
1703 return -1;
1704 if (!equal)
1705 isl_die(isl_schedule_node_get_ctx(node), isl_error_invalid,
1706 "spaces don't match", return -1);
1708 return 0;
1711 /* Multiply the partial schedule of the band node "node"
1712 * with the factors in "mv".
1714 __isl_give isl_schedule_node *isl_schedule_node_band_scale(
1715 __isl_take isl_schedule_node *node, __isl_take isl_multi_val *mv)
1717 isl_schedule_tree *tree;
1718 int anchored;
1720 if (!node || !mv)
1721 goto error;
1722 if (check_space_multi_val(node, mv) < 0)
1723 goto error;
1724 anchored = isl_schedule_node_is_subtree_anchored(node);
1725 if (anchored < 0)
1726 goto error;
1727 if (anchored)
1728 isl_die(isl_schedule_node_get_ctx(node), isl_error_invalid,
1729 "cannot scale band node with anchored subtree",
1730 goto error);
1732 tree = isl_schedule_node_get_tree(node);
1733 tree = isl_schedule_tree_band_scale(tree, mv);
1734 return isl_schedule_node_graft_tree(node, tree);
1735 error:
1736 isl_multi_val_free(mv);
1737 isl_schedule_node_free(node);
1738 return NULL;
1741 /* Divide the partial schedule of the band node "node"
1742 * by the factors in "mv".
1744 __isl_give isl_schedule_node *isl_schedule_node_band_scale_down(
1745 __isl_take isl_schedule_node *node, __isl_take isl_multi_val *mv)
1747 isl_schedule_tree *tree;
1748 int anchored;
1750 if (!node || !mv)
1751 goto error;
1752 if (check_space_multi_val(node, mv) < 0)
1753 goto error;
1754 anchored = isl_schedule_node_is_subtree_anchored(node);
1755 if (anchored < 0)
1756 goto error;
1757 if (anchored)
1758 isl_die(isl_schedule_node_get_ctx(node), isl_error_invalid,
1759 "cannot scale down band node with anchored subtree",
1760 goto error);
1762 tree = isl_schedule_node_get_tree(node);
1763 tree = isl_schedule_tree_band_scale_down(tree, mv);
1764 return isl_schedule_node_graft_tree(node, tree);
1765 error:
1766 isl_multi_val_free(mv);
1767 isl_schedule_node_free(node);
1768 return NULL;
1771 /* Reduce the partial schedule of the band node "node"
1772 * modulo the factors in "mv".
1774 __isl_give isl_schedule_node *isl_schedule_node_band_mod(
1775 __isl_take isl_schedule_node *node, __isl_take isl_multi_val *mv)
1777 isl_schedule_tree *tree;
1778 isl_bool anchored;
1780 if (!node || !mv)
1781 goto error;
1782 if (check_space_multi_val(node, mv) < 0)
1783 goto error;
1784 anchored = isl_schedule_node_is_subtree_anchored(node);
1785 if (anchored < 0)
1786 goto error;
1787 if (anchored)
1788 isl_die(isl_schedule_node_get_ctx(node), isl_error_invalid,
1789 "cannot perform mod on band node with anchored subtree",
1790 goto error);
1792 tree = isl_schedule_node_get_tree(node);
1793 tree = isl_schedule_tree_band_mod(tree, mv);
1794 return isl_schedule_node_graft_tree(node, tree);
1795 error:
1796 isl_multi_val_free(mv);
1797 isl_schedule_node_free(node);
1798 return NULL;
1801 /* Make sure that that spaces of "node" and "mupa" are the same.
1802 * Return isl_stat_error on error, reporting the error to the user.
1804 static isl_stat check_space_multi_union_pw_aff(
1805 __isl_keep isl_schedule_node *node,
1806 __isl_keep isl_multi_union_pw_aff *mupa)
1808 isl_space *node_space, *mupa_space;
1809 isl_bool equal;
1811 node_space = isl_schedule_node_band_get_space(node);
1812 mupa_space = isl_multi_union_pw_aff_get_space(mupa);
1813 equal = isl_space_tuple_is_equal(node_space, isl_dim_set,
1814 mupa_space, isl_dim_set);
1815 isl_space_free(mupa_space);
1816 isl_space_free(node_space);
1817 if (equal < 0)
1818 return isl_stat_error;
1819 if (!equal)
1820 isl_die(isl_schedule_node_get_ctx(node), isl_error_invalid,
1821 "spaces don't match", return isl_stat_error);
1823 return isl_stat_ok;
1826 /* Shift the partial schedule of the band node "node" by "shift".
1828 __isl_give isl_schedule_node *isl_schedule_node_band_shift(
1829 __isl_take isl_schedule_node *node,
1830 __isl_take isl_multi_union_pw_aff *shift)
1832 isl_schedule_tree *tree;
1833 int anchored;
1835 if (!node || !shift)
1836 goto error;
1837 if (check_space_multi_union_pw_aff(node, shift) < 0)
1838 goto error;
1839 anchored = isl_schedule_node_is_subtree_anchored(node);
1840 if (anchored < 0)
1841 goto error;
1842 if (anchored)
1843 isl_die(isl_schedule_node_get_ctx(node), isl_error_invalid,
1844 "cannot shift band node with anchored subtree",
1845 goto error);
1847 tree = isl_schedule_node_get_tree(node);
1848 tree = isl_schedule_tree_band_shift(tree, shift);
1849 return isl_schedule_node_graft_tree(node, tree);
1850 error:
1851 isl_multi_union_pw_aff_free(shift);
1852 isl_schedule_node_free(node);
1853 return NULL;
1856 /* Tile "node" with tile sizes "sizes".
1858 * The current node is replaced by two nested nodes corresponding
1859 * to the tile dimensions and the point dimensions.
1861 * Return a pointer to the outer (tile) node.
1863 * If any of the descendants of "node" depend on the set of outer band nodes,
1864 * then we refuse to tile the node.
1866 * If the scale tile loops option is set, then the tile loops
1867 * are scaled by the tile sizes. If the shift point loops option is set,
1868 * then the point loops are shifted to start at zero.
1869 * In particular, these options affect the tile and point loop schedules
1870 * as follows
1872 * scale shift original tile point
1874 * 0 0 i floor(i/s) i
1875 * 1 0 i s * floor(i/s) i
1876 * 0 1 i floor(i/s) i - s * floor(i/s)
1877 * 1 1 i s * floor(i/s) i - s * floor(i/s)
1879 __isl_give isl_schedule_node *isl_schedule_node_band_tile(
1880 __isl_take isl_schedule_node *node, __isl_take isl_multi_val *sizes)
1882 isl_schedule_tree *tree;
1883 int anchored;
1885 if (!node || !sizes)
1886 goto error;
1887 anchored = isl_schedule_node_is_subtree_anchored(node);
1888 if (anchored < 0)
1889 goto error;
1890 if (anchored)
1891 isl_die(isl_schedule_node_get_ctx(node), isl_error_invalid,
1892 "cannot tile band node with anchored subtree",
1893 goto error);
1895 if (check_space_multi_val(node, sizes) < 0)
1896 goto error;
1898 tree = isl_schedule_node_get_tree(node);
1899 tree = isl_schedule_tree_band_tile(tree, sizes);
1900 return isl_schedule_node_graft_tree(node, tree);
1901 error:
1902 isl_multi_val_free(sizes);
1903 isl_schedule_node_free(node);
1904 return NULL;
1907 /* Move the band node "node" down to all the leaves in the subtree
1908 * rooted at "node".
1909 * Return a pointer to the node in the resulting tree that is in the same
1910 * position as the node pointed to by "node" in the original tree.
1912 * If the node only has a leaf child, then nothing needs to be done.
1913 * Otherwise, the child of the node is removed and the result is
1914 * appended to all the leaves in the subtree rooted at the original child.
1915 * Since the node is moved to the leaves, it needs to be expanded
1916 * according to the expansion, if any, defined by that subtree.
1917 * In the end, the original node is replaced by the result of
1918 * attaching copies of the expanded node to the leaves.
1920 * If any of the nodes in the subtree rooted at "node" depend on
1921 * the set of outer band nodes then we refuse to sink the band node.
1923 __isl_give isl_schedule_node *isl_schedule_node_band_sink(
1924 __isl_take isl_schedule_node *node)
1926 enum isl_schedule_node_type type;
1927 isl_schedule_tree *tree, *child;
1928 isl_union_pw_multi_aff *contraction;
1929 int anchored;
1931 if (!node)
1932 return NULL;
1934 type = isl_schedule_node_get_type(node);
1935 if (type != isl_schedule_node_band)
1936 isl_die(isl_schedule_node_get_ctx(node), isl_error_invalid,
1937 "not a band node", return isl_schedule_node_free(node));
1938 anchored = isl_schedule_node_is_subtree_anchored(node);
1939 if (anchored < 0)
1940 return isl_schedule_node_free(node);
1941 if (anchored)
1942 isl_die(isl_schedule_node_get_ctx(node), isl_error_invalid,
1943 "cannot sink band node in anchored subtree",
1944 return isl_schedule_node_free(node));
1945 if (isl_schedule_tree_n_children(node->tree) == 0)
1946 return node;
1948 contraction = isl_schedule_node_get_subtree_contraction(node);
1950 tree = isl_schedule_node_get_tree(node);
1951 child = isl_schedule_tree_get_child(tree, 0);
1952 tree = isl_schedule_tree_reset_children(tree);
1953 tree = isl_schedule_tree_pullback_union_pw_multi_aff(tree, contraction);
1954 tree = isl_schedule_tree_append_to_leaves(child, tree);
1956 return isl_schedule_node_graft_tree(node, tree);
1959 /* Split "node" into two nested band nodes, one with the first "pos"
1960 * dimensions and one with the remaining dimensions.
1961 * The schedules of the two band nodes live in anonymous spaces.
1962 * The loop AST generation type options and the isolate option
1963 * are split over the the two band nodes.
1965 __isl_give isl_schedule_node *isl_schedule_node_band_split(
1966 __isl_take isl_schedule_node *node, int pos)
1968 int depth;
1969 isl_schedule_tree *tree;
1971 depth = isl_schedule_node_get_schedule_depth(node);
1972 tree = isl_schedule_node_get_tree(node);
1973 tree = isl_schedule_tree_band_split(tree, pos, depth);
1974 return isl_schedule_node_graft_tree(node, tree);
1977 /* Return the context of the context node "node".
1979 __isl_give isl_set *isl_schedule_node_context_get_context(
1980 __isl_keep isl_schedule_node *node)
1982 if (!node)
1983 return NULL;
1985 return isl_schedule_tree_context_get_context(node->tree);
1988 /* Return the domain of the domain node "node".
1990 __isl_give isl_union_set *isl_schedule_node_domain_get_domain(
1991 __isl_keep isl_schedule_node *node)
1993 if (!node)
1994 return NULL;
1996 return isl_schedule_tree_domain_get_domain(node->tree);
1999 /* Return the expansion map of expansion node "node".
2001 __isl_give isl_union_map *isl_schedule_node_expansion_get_expansion(
2002 __isl_keep isl_schedule_node *node)
2004 if (!node)
2005 return NULL;
2007 return isl_schedule_tree_expansion_get_expansion(node->tree);
2010 /* Return the contraction of expansion node "node".
2012 __isl_give isl_union_pw_multi_aff *isl_schedule_node_expansion_get_contraction(
2013 __isl_keep isl_schedule_node *node)
2015 if (!node)
2016 return NULL;
2018 return isl_schedule_tree_expansion_get_contraction(node->tree);
2021 /* Replace the contraction and the expansion of the expansion node "node"
2022 * by "contraction" and "expansion".
2024 __isl_give isl_schedule_node *
2025 isl_schedule_node_expansion_set_contraction_and_expansion(
2026 __isl_take isl_schedule_node *node,
2027 __isl_take isl_union_pw_multi_aff *contraction,
2028 __isl_take isl_union_map *expansion)
2030 isl_schedule_tree *tree;
2032 if (!node || !contraction || !expansion)
2033 goto error;
2035 tree = isl_schedule_tree_copy(node->tree);
2036 tree = isl_schedule_tree_expansion_set_contraction_and_expansion(tree,
2037 contraction, expansion);
2038 return isl_schedule_node_graft_tree(node, tree);
2039 error:
2040 isl_schedule_node_free(node);
2041 isl_union_pw_multi_aff_free(contraction);
2042 isl_union_map_free(expansion);
2043 return NULL;
2046 /* Return the extension of the extension node "node".
2048 __isl_give isl_union_map *isl_schedule_node_extension_get_extension(
2049 __isl_keep isl_schedule_node *node)
2051 if (!node)
2052 return NULL;
2054 return isl_schedule_tree_extension_get_extension(node->tree);
2057 /* Replace the extension of extension node "node" by "extension".
2059 __isl_give isl_schedule_node *isl_schedule_node_extension_set_extension(
2060 __isl_take isl_schedule_node *node, __isl_take isl_union_map *extension)
2062 isl_schedule_tree *tree;
2064 if (!node || !extension)
2065 goto error;
2067 tree = isl_schedule_tree_copy(node->tree);
2068 tree = isl_schedule_tree_extension_set_extension(tree, extension);
2069 return isl_schedule_node_graft_tree(node, tree);
2070 error:
2071 isl_schedule_node_free(node);
2072 isl_union_map_free(extension);
2073 return NULL;
2076 /* Return the filter of the filter node "node".
2078 __isl_give isl_union_set *isl_schedule_node_filter_get_filter(
2079 __isl_keep isl_schedule_node *node)
2081 if (!node)
2082 return NULL;
2084 return isl_schedule_tree_filter_get_filter(node->tree);
2087 /* Replace the filter of filter node "node" by "filter".
2089 __isl_give isl_schedule_node *isl_schedule_node_filter_set_filter(
2090 __isl_take isl_schedule_node *node, __isl_take isl_union_set *filter)
2092 isl_schedule_tree *tree;
2094 if (!node || !filter)
2095 goto error;
2097 tree = isl_schedule_tree_copy(node->tree);
2098 tree = isl_schedule_tree_filter_set_filter(tree, filter);
2099 return isl_schedule_node_graft_tree(node, tree);
2100 error:
2101 isl_schedule_node_free(node);
2102 isl_union_set_free(filter);
2103 return NULL;
2106 /* Intersect the filter of filter node "node" with "filter".
2108 * If the filter of the node is already a subset of "filter",
2109 * then leave the node unchanged.
2111 __isl_give isl_schedule_node *isl_schedule_node_filter_intersect_filter(
2112 __isl_take isl_schedule_node *node, __isl_take isl_union_set *filter)
2114 isl_union_set *node_filter = NULL;
2115 isl_bool subset;
2117 if (!node || !filter)
2118 goto error;
2120 node_filter = isl_schedule_node_filter_get_filter(node);
2121 subset = isl_union_set_is_subset(node_filter, filter);
2122 if (subset < 0)
2123 goto error;
2124 if (subset) {
2125 isl_union_set_free(node_filter);
2126 isl_union_set_free(filter);
2127 return node;
2129 node_filter = isl_union_set_intersect(node_filter, filter);
2130 node = isl_schedule_node_filter_set_filter(node, node_filter);
2131 return node;
2132 error:
2133 isl_schedule_node_free(node);
2134 isl_union_set_free(node_filter);
2135 isl_union_set_free(filter);
2136 return NULL;
2139 /* Return the guard of the guard node "node".
2141 __isl_give isl_set *isl_schedule_node_guard_get_guard(
2142 __isl_keep isl_schedule_node *node)
2144 if (!node)
2145 return NULL;
2147 return isl_schedule_tree_guard_get_guard(node->tree);
2150 /* Return the mark identifier of the mark node "node".
2152 __isl_give isl_id *isl_schedule_node_mark_get_id(
2153 __isl_keep isl_schedule_node *node)
2155 if (!node)
2156 return NULL;
2158 return isl_schedule_tree_mark_get_id(node->tree);
2161 /* Replace the child at position "pos" of the sequence node "node"
2162 * by the children of sequence root node of "tree".
2164 __isl_give isl_schedule_node *isl_schedule_node_sequence_splice(
2165 __isl_take isl_schedule_node *node, int pos,
2166 __isl_take isl_schedule_tree *tree)
2168 isl_schedule_tree *node_tree;
2170 if (!node || !tree)
2171 goto error;
2172 if (isl_schedule_node_get_type(node) != isl_schedule_node_sequence)
2173 isl_die(isl_schedule_node_get_ctx(node), isl_error_invalid,
2174 "not a sequence node", goto error);
2175 if (isl_schedule_tree_get_type(tree) != isl_schedule_node_sequence)
2176 isl_die(isl_schedule_node_get_ctx(node), isl_error_invalid,
2177 "not a sequence node", goto error);
2178 node_tree = isl_schedule_node_get_tree(node);
2179 node_tree = isl_schedule_tree_sequence_splice(node_tree, pos, tree);
2180 node = isl_schedule_node_graft_tree(node, node_tree);
2182 return node;
2183 error:
2184 isl_schedule_node_free(node);
2185 isl_schedule_tree_free(tree);
2186 return NULL;
2189 /* Given a sequence node "node", with a child at position "pos" that
2190 * is also a sequence node, attach the children of that node directly
2191 * as children of "node" at that position, replacing the original child.
2193 * The filters of these children are intersected with the filter
2194 * of the child at position "pos".
2196 __isl_give isl_schedule_node *isl_schedule_node_sequence_splice_child(
2197 __isl_take isl_schedule_node *node, int pos)
2199 int i, n;
2200 isl_union_set *filter;
2201 isl_schedule_node *child;
2202 isl_schedule_tree *tree;
2204 if (!node)
2205 return NULL;
2206 if (isl_schedule_node_get_type(node) != isl_schedule_node_sequence)
2207 isl_die(isl_schedule_node_get_ctx(node), isl_error_invalid,
2208 "not a sequence node",
2209 return isl_schedule_node_free(node));
2210 node = isl_schedule_node_child(node, pos);
2211 node = isl_schedule_node_child(node, 0);
2212 if (isl_schedule_node_get_type(node) != isl_schedule_node_sequence)
2213 isl_die(isl_schedule_node_get_ctx(node), isl_error_invalid,
2214 "not a sequence node",
2215 return isl_schedule_node_free(node));
2216 child = isl_schedule_node_copy(node);
2217 node = isl_schedule_node_parent(node);
2218 filter = isl_schedule_node_filter_get_filter(node);
2219 n = isl_schedule_node_n_children(child);
2220 for (i = 0; i < n; ++i) {
2221 child = isl_schedule_node_child(child, i);
2222 child = isl_schedule_node_filter_intersect_filter(child,
2223 isl_union_set_copy(filter));
2224 child = isl_schedule_node_parent(child);
2226 isl_union_set_free(filter);
2227 tree = isl_schedule_node_get_tree(child);
2228 isl_schedule_node_free(child);
2229 node = isl_schedule_node_parent(node);
2230 node = isl_schedule_node_sequence_splice(node, pos, tree);
2232 return node;
2235 /* Update the ancestors of "node" to point to the tree that "node"
2236 * now points to.
2237 * That is, replace the child in the original parent that corresponds
2238 * to the current tree position by node->tree and continue updating
2239 * the ancestors in the same way until the root is reached.
2241 * If "fn" is not NULL, then it is called on each ancestor as we move up
2242 * the tree so that it can modify the ancestor before it is added
2243 * to the list of ancestors of the modified node.
2244 * The additional "pos" argument records the position
2245 * of the "tree" argument in the original schedule tree.
2247 * If "node" originally points to a leaf of the schedule tree, then make sure
2248 * that in the end it points to a leaf in the updated schedule tree.
2250 static __isl_give isl_schedule_node *update_ancestors(
2251 __isl_take isl_schedule_node *node,
2252 __isl_give isl_schedule_tree *(*fn)(__isl_take isl_schedule_tree *tree,
2253 __isl_keep isl_schedule_node *pos, void *user), void *user)
2255 int i, n;
2256 int is_leaf;
2257 isl_ctx *ctx;
2258 isl_schedule_tree *tree;
2259 isl_schedule_node *pos = NULL;
2261 if (fn)
2262 pos = isl_schedule_node_copy(node);
2264 node = isl_schedule_node_cow(node);
2265 if (!node)
2266 return isl_schedule_node_free(pos);
2268 ctx = isl_schedule_node_get_ctx(node);
2269 n = isl_schedule_tree_list_n_schedule_tree(node->ancestors);
2270 tree = isl_schedule_tree_copy(node->tree);
2272 for (i = n - 1; i >= 0; --i) {
2273 isl_schedule_tree *parent;
2275 parent = isl_schedule_tree_list_get_schedule_tree(
2276 node->ancestors, i);
2277 parent = isl_schedule_tree_replace_child(parent,
2278 node->child_pos[i], tree);
2279 if (fn) {
2280 pos = isl_schedule_node_parent(pos);
2281 parent = fn(parent, pos, user);
2283 node->ancestors = isl_schedule_tree_list_set_schedule_tree(
2284 node->ancestors, i, isl_schedule_tree_copy(parent));
2286 tree = parent;
2289 if (fn)
2290 isl_schedule_node_free(pos);
2292 is_leaf = isl_schedule_tree_is_leaf(node->tree);
2293 node->schedule = isl_schedule_set_root(node->schedule, tree);
2294 if (is_leaf) {
2295 isl_schedule_tree_free(node->tree);
2296 node->tree = isl_schedule_node_get_leaf(node);
2299 if (!node->schedule || !node->ancestors)
2300 return isl_schedule_node_free(node);
2302 return node;
2305 /* Replace the subtree that "pos" points to by "tree", updating
2306 * the ancestors to maintain a consistent state.
2308 __isl_give isl_schedule_node *isl_schedule_node_graft_tree(
2309 __isl_take isl_schedule_node *pos, __isl_take isl_schedule_tree *tree)
2311 if (!tree || !pos)
2312 goto error;
2313 if (pos->tree == tree) {
2314 isl_schedule_tree_free(tree);
2315 return pos;
2318 pos = isl_schedule_node_cow(pos);
2319 if (!pos)
2320 goto error;
2322 isl_schedule_tree_free(pos->tree);
2323 pos->tree = tree;
2325 return update_ancestors(pos, NULL, NULL);
2326 error:
2327 isl_schedule_node_free(pos);
2328 isl_schedule_tree_free(tree);
2329 return NULL;
2332 /* Make sure we can insert a node between "node" and its parent.
2333 * Return -1 on error, reporting the reason why we cannot insert a node.
2335 static int check_insert(__isl_keep isl_schedule_node *node)
2337 int has_parent;
2338 enum isl_schedule_node_type type;
2340 has_parent = isl_schedule_node_has_parent(node);
2341 if (has_parent < 0)
2342 return -1;
2343 if (!has_parent)
2344 isl_die(isl_schedule_node_get_ctx(node), isl_error_invalid,
2345 "cannot insert node outside of root", return -1);
2347 type = isl_schedule_node_get_parent_type(node);
2348 if (type == isl_schedule_node_error)
2349 return -1;
2350 if (type == isl_schedule_node_set || type == isl_schedule_node_sequence)
2351 isl_die(isl_schedule_node_get_ctx(node), isl_error_invalid,
2352 "cannot insert node between set or sequence node "
2353 "and its filter children", return -1);
2355 return 0;
2358 /* Insert a band node with partial schedule "mupa" between "node" and
2359 * its parent.
2360 * Return a pointer to the new band node.
2362 * If any of the nodes in the subtree rooted at "node" depend on
2363 * the set of outer band nodes then we refuse to insert the band node.
2365 __isl_give isl_schedule_node *isl_schedule_node_insert_partial_schedule(
2366 __isl_take isl_schedule_node *node,
2367 __isl_take isl_multi_union_pw_aff *mupa)
2369 int anchored;
2370 isl_schedule_band *band;
2371 isl_schedule_tree *tree;
2373 if (check_insert(node) < 0)
2374 node = isl_schedule_node_free(node);
2375 anchored = isl_schedule_node_is_subtree_anchored(node);
2376 if (anchored < 0)
2377 goto error;
2378 if (anchored)
2379 isl_die(isl_schedule_node_get_ctx(node), isl_error_invalid,
2380 "cannot insert band node in anchored subtree",
2381 goto error);
2383 tree = isl_schedule_node_get_tree(node);
2384 band = isl_schedule_band_from_multi_union_pw_aff(mupa);
2385 tree = isl_schedule_tree_insert_band(tree, band);
2386 node = isl_schedule_node_graft_tree(node, tree);
2388 return node;
2389 error:
2390 isl_schedule_node_free(node);
2391 isl_multi_union_pw_aff_free(mupa);
2392 return NULL;
2395 /* Insert a context node with context "context" between "node" and its parent.
2396 * Return a pointer to the new context node.
2398 __isl_give isl_schedule_node *isl_schedule_node_insert_context(
2399 __isl_take isl_schedule_node *node, __isl_take isl_set *context)
2401 isl_schedule_tree *tree;
2403 if (check_insert(node) < 0)
2404 node = isl_schedule_node_free(node);
2406 tree = isl_schedule_node_get_tree(node);
2407 tree = isl_schedule_tree_insert_context(tree, context);
2408 node = isl_schedule_node_graft_tree(node, tree);
2410 return node;
2413 /* Insert an expansion node with the given "contraction" and "expansion"
2414 * between "node" and its parent.
2415 * Return a pointer to the new expansion node.
2417 * Typically the domain and range spaces of the expansion are different.
2418 * This means that only one of them can refer to the current domain space
2419 * in a consistent tree. It is up to the caller to ensure that the tree
2420 * returns to a consistent state.
2422 __isl_give isl_schedule_node *isl_schedule_node_insert_expansion(
2423 __isl_take isl_schedule_node *node,
2424 __isl_take isl_union_pw_multi_aff *contraction,
2425 __isl_take isl_union_map *expansion)
2427 isl_schedule_tree *tree;
2429 if (check_insert(node) < 0)
2430 node = isl_schedule_node_free(node);
2432 tree = isl_schedule_node_get_tree(node);
2433 tree = isl_schedule_tree_insert_expansion(tree, contraction, expansion);
2434 node = isl_schedule_node_graft_tree(node, tree);
2436 return node;
2439 /* Insert an extension node with extension "extension" between "node" and
2440 * its parent.
2441 * Return a pointer to the new extension node.
2443 __isl_give isl_schedule_node *isl_schedule_node_insert_extension(
2444 __isl_take isl_schedule_node *node,
2445 __isl_take isl_union_map *extension)
2447 isl_schedule_tree *tree;
2449 tree = isl_schedule_node_get_tree(node);
2450 tree = isl_schedule_tree_insert_extension(tree, extension);
2451 node = isl_schedule_node_graft_tree(node, tree);
2453 return node;
2456 /* Insert a filter node with filter "filter" between "node" and its parent.
2457 * Return a pointer to the new filter node.
2459 __isl_give isl_schedule_node *isl_schedule_node_insert_filter(
2460 __isl_take isl_schedule_node *node, __isl_take isl_union_set *filter)
2462 isl_schedule_tree *tree;
2464 if (check_insert(node) < 0)
2465 node = isl_schedule_node_free(node);
2467 tree = isl_schedule_node_get_tree(node);
2468 tree = isl_schedule_tree_insert_filter(tree, filter);
2469 node = isl_schedule_node_graft_tree(node, tree);
2471 return node;
2474 /* Insert a guard node with guard "guard" between "node" and its parent.
2475 * Return a pointer to the new guard node.
2477 __isl_give isl_schedule_node *isl_schedule_node_insert_guard(
2478 __isl_take isl_schedule_node *node, __isl_take isl_set *guard)
2480 isl_schedule_tree *tree;
2482 if (check_insert(node) < 0)
2483 node = isl_schedule_node_free(node);
2485 tree = isl_schedule_node_get_tree(node);
2486 tree = isl_schedule_tree_insert_guard(tree, guard);
2487 node = isl_schedule_node_graft_tree(node, tree);
2489 return node;
2492 /* Insert a mark node with mark identifier "mark" between "node" and
2493 * its parent.
2494 * Return a pointer to the new mark node.
2496 __isl_give isl_schedule_node *isl_schedule_node_insert_mark(
2497 __isl_take isl_schedule_node *node, __isl_take isl_id *mark)
2499 isl_schedule_tree *tree;
2501 if (check_insert(node) < 0)
2502 node = isl_schedule_node_free(node);
2504 tree = isl_schedule_node_get_tree(node);
2505 tree = isl_schedule_tree_insert_mark(tree, mark);
2506 node = isl_schedule_node_graft_tree(node, tree);
2508 return node;
2511 /* Attach the current subtree of "node" to a sequence of filter tree nodes
2512 * with filters described by "filters", attach this sequence
2513 * of filter tree nodes as children to a new tree of type "type" and
2514 * replace the original subtree of "node" by this new tree.
2515 * Each copy of the original subtree is simplified with respect
2516 * to the corresponding filter.
2518 static __isl_give isl_schedule_node *isl_schedule_node_insert_children(
2519 __isl_take isl_schedule_node *node,
2520 enum isl_schedule_node_type type,
2521 __isl_take isl_union_set_list *filters)
2523 int i, n;
2524 isl_ctx *ctx;
2525 isl_schedule_tree *tree;
2526 isl_schedule_tree_list *list;
2528 if (check_insert(node) < 0)
2529 node = isl_schedule_node_free(node);
2531 if (!node || !filters)
2532 goto error;
2534 ctx = isl_schedule_node_get_ctx(node);
2535 n = isl_union_set_list_n_union_set(filters);
2536 list = isl_schedule_tree_list_alloc(ctx, n);
2537 for (i = 0; i < n; ++i) {
2538 isl_schedule_node *node_i;
2539 isl_schedule_tree *tree;
2540 isl_union_set *filter;
2542 filter = isl_union_set_list_get_union_set(filters, i);
2543 node_i = isl_schedule_node_copy(node);
2544 node_i = isl_schedule_node_gist(node_i,
2545 isl_union_set_copy(filter));
2546 tree = isl_schedule_node_get_tree(node_i);
2547 isl_schedule_node_free(node_i);
2548 tree = isl_schedule_tree_insert_filter(tree, filter);
2549 list = isl_schedule_tree_list_add(list, tree);
2551 tree = isl_schedule_tree_from_children(type, list);
2552 node = isl_schedule_node_graft_tree(node, tree);
2554 isl_union_set_list_free(filters);
2555 return node;
2556 error:
2557 isl_union_set_list_free(filters);
2558 isl_schedule_node_free(node);
2559 return NULL;
2562 /* Insert a sequence node with child filters "filters" between "node" and
2563 * its parent. That is, the tree that "node" points to is attached
2564 * to each of the child nodes of the filter nodes.
2565 * Return a pointer to the new sequence node.
2567 __isl_give isl_schedule_node *isl_schedule_node_insert_sequence(
2568 __isl_take isl_schedule_node *node,
2569 __isl_take isl_union_set_list *filters)
2571 return isl_schedule_node_insert_children(node,
2572 isl_schedule_node_sequence, filters);
2575 /* Insert a set node with child filters "filters" between "node" and
2576 * its parent. That is, the tree that "node" points to is attached
2577 * to each of the child nodes of the filter nodes.
2578 * Return a pointer to the new set node.
2580 __isl_give isl_schedule_node *isl_schedule_node_insert_set(
2581 __isl_take isl_schedule_node *node,
2582 __isl_take isl_union_set_list *filters)
2584 return isl_schedule_node_insert_children(node,
2585 isl_schedule_node_set, filters);
2588 /* Remove "node" from its schedule tree and return a pointer
2589 * to the leaf at the same position in the updated schedule tree.
2591 * It is not allowed to remove the root of a schedule tree or
2592 * a child of a set or sequence node.
2594 __isl_give isl_schedule_node *isl_schedule_node_cut(
2595 __isl_take isl_schedule_node *node)
2597 isl_schedule_tree *leaf;
2598 enum isl_schedule_node_type parent_type;
2600 if (!node)
2601 return NULL;
2602 if (!isl_schedule_node_has_parent(node))
2603 isl_die(isl_schedule_node_get_ctx(node), isl_error_invalid,
2604 "cannot cut root", return isl_schedule_node_free(node));
2606 parent_type = isl_schedule_node_get_parent_type(node);
2607 if (parent_type == isl_schedule_node_set ||
2608 parent_type == isl_schedule_node_sequence)
2609 isl_die(isl_schedule_node_get_ctx(node), isl_error_invalid,
2610 "cannot cut child of set or sequence",
2611 return isl_schedule_node_free(node));
2613 leaf = isl_schedule_node_get_leaf(node);
2614 return isl_schedule_node_graft_tree(node, leaf);
2617 /* Remove a single node from the schedule tree, attaching the child
2618 * of "node" directly to its parent.
2619 * Return a pointer to this former child or to the leaf the position
2620 * of the original node if there was no child.
2621 * It is not allowed to remove the root of a schedule tree,
2622 * a set or sequence node, a child of a set or sequence node or
2623 * a band node with an anchored subtree.
2625 __isl_give isl_schedule_node *isl_schedule_node_delete(
2626 __isl_take isl_schedule_node *node)
2628 int n;
2629 isl_schedule_tree *tree;
2630 enum isl_schedule_node_type type;
2632 if (!node)
2633 return NULL;
2635 if (isl_schedule_node_get_tree_depth(node) == 0)
2636 isl_die(isl_schedule_node_get_ctx(node), isl_error_invalid,
2637 "cannot delete root node",
2638 return isl_schedule_node_free(node));
2639 n = isl_schedule_node_n_children(node);
2640 if (n != 1)
2641 isl_die(isl_schedule_node_get_ctx(node), isl_error_invalid,
2642 "can only delete node with a single child",
2643 return isl_schedule_node_free(node));
2644 type = isl_schedule_node_get_parent_type(node);
2645 if (type == isl_schedule_node_sequence || type == isl_schedule_node_set)
2646 isl_die(isl_schedule_node_get_ctx(node), isl_error_invalid,
2647 "cannot delete child of set or sequence",
2648 return isl_schedule_node_free(node));
2649 if (isl_schedule_node_get_type(node) == isl_schedule_node_band) {
2650 int anchored;
2652 anchored = isl_schedule_node_is_subtree_anchored(node);
2653 if (anchored < 0)
2654 return isl_schedule_node_free(node);
2655 if (anchored)
2656 isl_die(isl_schedule_node_get_ctx(node),
2657 isl_error_invalid,
2658 "cannot delete band node with anchored subtree",
2659 return isl_schedule_node_free(node));
2662 tree = isl_schedule_node_get_tree(node);
2663 if (!tree || isl_schedule_tree_has_children(tree)) {
2664 tree = isl_schedule_tree_child(tree, 0);
2665 } else {
2666 isl_schedule_tree_free(tree);
2667 tree = isl_schedule_node_get_leaf(node);
2669 node = isl_schedule_node_graft_tree(node, tree);
2671 return node;
2674 /* Internal data structure for the group_ancestor callback.
2676 * If "finished" is set, then we no longer need to modify
2677 * any further ancestors.
2679 * "contraction" and "expansion" represent the expansion
2680 * that reflects the grouping.
2682 * "domain" contains the domain elements that reach the position
2683 * where the grouping is performed. That is, it is the range
2684 * of the resulting expansion.
2685 * "domain_universe" is the universe of "domain".
2686 * "group" is the set of group elements, i.e., the domain
2687 * of the resulting expansion.
2688 * "group_universe" is the universe of "group".
2690 * "sched" is the schedule for the group elements, in pratice
2691 * an identity mapping on "group_universe".
2692 * "dim" is the dimension of "sched".
2694 struct isl_schedule_group_data {
2695 int finished;
2697 isl_union_map *expansion;
2698 isl_union_pw_multi_aff *contraction;
2700 isl_union_set *domain;
2701 isl_union_set *domain_universe;
2702 isl_union_set *group;
2703 isl_union_set *group_universe;
2705 int dim;
2706 isl_multi_aff *sched;
2709 /* Is domain covered by data->domain within data->domain_universe?
2711 static int locally_covered_by_domain(__isl_keep isl_union_set *domain,
2712 struct isl_schedule_group_data *data)
2714 int is_subset;
2715 isl_union_set *test;
2717 test = isl_union_set_copy(domain);
2718 test = isl_union_set_intersect(test,
2719 isl_union_set_copy(data->domain_universe));
2720 is_subset = isl_union_set_is_subset(test, data->domain);
2721 isl_union_set_free(test);
2723 return is_subset;
2726 /* Update the band tree root "tree" to refer to the group instances
2727 * in data->group rather than the original domain elements in data->domain.
2728 * "pos" is the position in the original schedule tree where the modified
2729 * "tree" will be attached.
2731 * Add the part of the identity schedule on the group instances data->sched
2732 * that corresponds to this band node to the band schedule.
2733 * If the domain elements that reach the node and that are part
2734 * of data->domain_universe are all elements of data->domain (and therefore
2735 * replaced by the group instances) then this data->domain_universe
2736 * is removed from the domain of the band schedule.
2738 static __isl_give isl_schedule_tree *group_band(
2739 __isl_take isl_schedule_tree *tree, __isl_keep isl_schedule_node *pos,
2740 struct isl_schedule_group_data *data)
2742 isl_union_set *domain;
2743 isl_multi_aff *ma;
2744 isl_multi_union_pw_aff *mupa, *partial;
2745 int is_covered;
2746 int depth, n, has_id;
2748 domain = isl_schedule_node_get_domain(pos);
2749 is_covered = locally_covered_by_domain(domain, data);
2750 if (is_covered >= 0 && is_covered) {
2751 domain = isl_union_set_universe(domain);
2752 domain = isl_union_set_subtract(domain,
2753 isl_union_set_copy(data->domain_universe));
2754 tree = isl_schedule_tree_band_intersect_domain(tree, domain);
2755 } else
2756 isl_union_set_free(domain);
2757 if (is_covered < 0)
2758 return isl_schedule_tree_free(tree);
2759 depth = isl_schedule_node_get_schedule_depth(pos);
2760 n = isl_schedule_tree_band_n_member(tree);
2761 ma = isl_multi_aff_copy(data->sched);
2762 ma = isl_multi_aff_drop_dims(ma, isl_dim_out, 0, depth);
2763 ma = isl_multi_aff_drop_dims(ma, isl_dim_out, n, data->dim - depth - n);
2764 mupa = isl_multi_union_pw_aff_from_multi_aff(ma);
2765 partial = isl_schedule_tree_band_get_partial_schedule(tree);
2766 has_id = isl_multi_union_pw_aff_has_tuple_id(partial, isl_dim_set);
2767 if (has_id < 0) {
2768 partial = isl_multi_union_pw_aff_free(partial);
2769 } else if (has_id) {
2770 isl_id *id;
2771 id = isl_multi_union_pw_aff_get_tuple_id(partial, isl_dim_set);
2772 mupa = isl_multi_union_pw_aff_set_tuple_id(mupa,
2773 isl_dim_set, id);
2775 partial = isl_multi_union_pw_aff_union_add(partial, mupa);
2776 tree = isl_schedule_tree_band_set_partial_schedule(tree, partial);
2778 return tree;
2781 /* Drop the parameters in "uset" that are not also in "space".
2782 * "n" is the number of parameters in "space".
2784 static __isl_give isl_union_set *union_set_drop_extra_params(
2785 __isl_take isl_union_set *uset, __isl_keep isl_space *space, int n)
2787 int n2;
2789 uset = isl_union_set_align_params(uset, isl_space_copy(space));
2790 n2 = isl_union_set_dim(uset, isl_dim_param);
2791 uset = isl_union_set_project_out(uset, isl_dim_param, n, n2 - n);
2793 return uset;
2796 /* Update the context tree root "tree" to refer to the group instances
2797 * in data->group rather than the original domain elements in data->domain.
2798 * "pos" is the position in the original schedule tree where the modified
2799 * "tree" will be attached.
2801 * We do not actually need to update "tree" since a context node only
2802 * refers to the schedule space. However, we may need to update "data"
2803 * to not refer to any parameters introduced by the context node.
2805 static __isl_give isl_schedule_tree *group_context(
2806 __isl_take isl_schedule_tree *tree, __isl_keep isl_schedule_node *pos,
2807 struct isl_schedule_group_data *data)
2809 isl_space *space;
2810 isl_union_set *domain;
2811 int n1, n2;
2812 int involves;
2814 if (isl_schedule_node_get_tree_depth(pos) == 1)
2815 return tree;
2817 domain = isl_schedule_node_get_universe_domain(pos);
2818 space = isl_union_set_get_space(domain);
2819 isl_union_set_free(domain);
2821 n1 = isl_space_dim(space, isl_dim_param);
2822 data->expansion = isl_union_map_align_params(data->expansion, space);
2823 n2 = isl_union_map_dim(data->expansion, isl_dim_param);
2825 if (!data->expansion)
2826 return isl_schedule_tree_free(tree);
2827 if (n1 == n2)
2828 return tree;
2830 involves = isl_union_map_involves_dims(data->expansion,
2831 isl_dim_param, n1, n2 - n1);
2832 if (involves < 0)
2833 return isl_schedule_tree_free(tree);
2834 if (involves)
2835 isl_die(isl_schedule_node_get_ctx(pos), isl_error_invalid,
2836 "grouping cannot only refer to global parameters",
2837 return isl_schedule_tree_free(tree));
2839 data->expansion = isl_union_map_project_out(data->expansion,
2840 isl_dim_param, n1, n2 - n1);
2841 space = isl_union_map_get_space(data->expansion);
2843 data->contraction = isl_union_pw_multi_aff_align_params(
2844 data->contraction, isl_space_copy(space));
2845 n2 = isl_union_pw_multi_aff_dim(data->contraction, isl_dim_param);
2846 data->contraction = isl_union_pw_multi_aff_drop_dims(data->contraction,
2847 isl_dim_param, n1, n2 - n1);
2849 data->domain = union_set_drop_extra_params(data->domain, space, n1);
2850 data->domain_universe =
2851 union_set_drop_extra_params(data->domain_universe, space, n1);
2852 data->group = union_set_drop_extra_params(data->group, space, n1);
2853 data->group_universe =
2854 union_set_drop_extra_params(data->group_universe, space, n1);
2856 data->sched = isl_multi_aff_align_params(data->sched,
2857 isl_space_copy(space));
2858 n2 = isl_multi_aff_dim(data->sched, isl_dim_param);
2859 data->sched = isl_multi_aff_drop_dims(data->sched,
2860 isl_dim_param, n1, n2 - n1);
2862 isl_space_free(space);
2864 return tree;
2867 /* Update the domain tree root "tree" to refer to the group instances
2868 * in data->group rather than the original domain elements in data->domain.
2869 * "pos" is the position in the original schedule tree where the modified
2870 * "tree" will be attached.
2872 * We first double-check that all grouped domain elements are actually
2873 * part of the root domain and then replace those elements by the group
2874 * instances.
2876 static __isl_give isl_schedule_tree *group_domain(
2877 __isl_take isl_schedule_tree *tree, __isl_keep isl_schedule_node *pos,
2878 struct isl_schedule_group_data *data)
2880 isl_union_set *domain;
2881 int is_subset;
2883 domain = isl_schedule_tree_domain_get_domain(tree);
2884 is_subset = isl_union_set_is_subset(data->domain, domain);
2885 isl_union_set_free(domain);
2886 if (is_subset < 0)
2887 return isl_schedule_tree_free(tree);
2888 if (!is_subset)
2889 isl_die(isl_schedule_tree_get_ctx(tree), isl_error_internal,
2890 "grouped domain should be part of outer domain",
2891 return isl_schedule_tree_free(tree));
2892 domain = isl_schedule_tree_domain_get_domain(tree);
2893 domain = isl_union_set_subtract(domain,
2894 isl_union_set_copy(data->domain));
2895 domain = isl_union_set_union(domain, isl_union_set_copy(data->group));
2896 tree = isl_schedule_tree_domain_set_domain(tree, domain);
2898 return tree;
2901 /* Update the expansion tree root "tree" to refer to the group instances
2902 * in data->group rather than the original domain elements in data->domain.
2903 * "pos" is the position in the original schedule tree where the modified
2904 * "tree" will be attached.
2906 * Let G_1 -> D_1 be the expansion of "tree" and G_2 -> D_2 the newly
2907 * introduced expansion in a descendant of "tree".
2908 * We first double-check that D_2 is a subset of D_1.
2909 * Then we remove D_2 from the range of G_1 -> D_1 and add the mapping
2910 * G_1 -> D_1 . D_2 -> G_2.
2911 * Simmilarly, we restrict the domain of the contraction to the universe
2912 * of the range of the updated expansion and add G_2 -> D_2 . D_1 -> G_1,
2913 * attempting to remove the domain constraints of this additional part.
2915 static __isl_give isl_schedule_tree *group_expansion(
2916 __isl_take isl_schedule_tree *tree, __isl_keep isl_schedule_node *pos,
2917 struct isl_schedule_group_data *data)
2919 isl_union_set *domain;
2920 isl_union_map *expansion, *umap;
2921 isl_union_pw_multi_aff *contraction, *upma;
2922 int is_subset;
2924 expansion = isl_schedule_tree_expansion_get_expansion(tree);
2925 domain = isl_union_map_range(expansion);
2926 is_subset = isl_union_set_is_subset(data->domain, domain);
2927 isl_union_set_free(domain);
2928 if (is_subset < 0)
2929 return isl_schedule_tree_free(tree);
2930 if (!is_subset)
2931 isl_die(isl_schedule_tree_get_ctx(tree), isl_error_internal,
2932 "grouped domain should be part "
2933 "of outer expansion domain",
2934 return isl_schedule_tree_free(tree));
2935 expansion = isl_schedule_tree_expansion_get_expansion(tree);
2936 umap = isl_union_map_from_union_pw_multi_aff(
2937 isl_union_pw_multi_aff_copy(data->contraction));
2938 umap = isl_union_map_apply_range(expansion, umap);
2939 expansion = isl_schedule_tree_expansion_get_expansion(tree);
2940 expansion = isl_union_map_subtract_range(expansion,
2941 isl_union_set_copy(data->domain));
2942 expansion = isl_union_map_union(expansion, umap);
2943 umap = isl_union_map_universe(isl_union_map_copy(expansion));
2944 domain = isl_union_map_range(umap);
2945 contraction = isl_schedule_tree_expansion_get_contraction(tree);
2946 umap = isl_union_map_from_union_pw_multi_aff(contraction);
2947 umap = isl_union_map_apply_range(isl_union_map_copy(data->expansion),
2948 umap);
2949 upma = isl_union_pw_multi_aff_from_union_map(umap);
2950 contraction = isl_schedule_tree_expansion_get_contraction(tree);
2951 contraction = isl_union_pw_multi_aff_intersect_domain(contraction,
2952 domain);
2953 domain = isl_union_pw_multi_aff_domain(
2954 isl_union_pw_multi_aff_copy(upma));
2955 upma = isl_union_pw_multi_aff_gist(upma, domain);
2956 contraction = isl_union_pw_multi_aff_union_add(contraction, upma);
2957 tree = isl_schedule_tree_expansion_set_contraction_and_expansion(tree,
2958 contraction, expansion);
2960 return tree;
2963 /* Update the tree root "tree" to refer to the group instances
2964 * in data->group rather than the original domain elements in data->domain.
2965 * "pos" is the position in the original schedule tree where the modified
2966 * "tree" will be attached.
2968 * If we have come across a domain or expansion node before (data->finished
2969 * is set), then we no longer need perform any modifications.
2971 * If "tree" is a filter, then we add data->group_universe to the filter.
2972 * We also remove data->domain_universe from the filter if all the domain
2973 * elements in this universe that reach the filter node are part of
2974 * the elements that are being grouped by data->expansion.
2975 * If "tree" is a band, domain or expansion, then it is handled
2976 * in a separate function.
2978 static __isl_give isl_schedule_tree *group_ancestor(
2979 __isl_take isl_schedule_tree *tree, __isl_keep isl_schedule_node *pos,
2980 void *user)
2982 struct isl_schedule_group_data *data = user;
2983 isl_union_set *domain;
2984 int is_covered;
2986 if (!tree || !pos)
2987 return isl_schedule_tree_free(tree);
2989 if (data->finished)
2990 return tree;
2992 switch (isl_schedule_tree_get_type(tree)) {
2993 case isl_schedule_node_error:
2994 return isl_schedule_tree_free(tree);
2995 case isl_schedule_node_extension:
2996 isl_die(isl_schedule_tree_get_ctx(tree), isl_error_unsupported,
2997 "grouping not allowed in extended tree",
2998 return isl_schedule_tree_free(tree));
2999 case isl_schedule_node_band:
3000 tree = group_band(tree, pos, data);
3001 break;
3002 case isl_schedule_node_context:
3003 tree = group_context(tree, pos, data);
3004 break;
3005 case isl_schedule_node_domain:
3006 tree = group_domain(tree, pos, data);
3007 data->finished = 1;
3008 break;
3009 case isl_schedule_node_filter:
3010 domain = isl_schedule_node_get_domain(pos);
3011 is_covered = locally_covered_by_domain(domain, data);
3012 isl_union_set_free(domain);
3013 if (is_covered < 0)
3014 return isl_schedule_tree_free(tree);
3015 domain = isl_schedule_tree_filter_get_filter(tree);
3016 if (is_covered)
3017 domain = isl_union_set_subtract(domain,
3018 isl_union_set_copy(data->domain_universe));
3019 domain = isl_union_set_union(domain,
3020 isl_union_set_copy(data->group_universe));
3021 tree = isl_schedule_tree_filter_set_filter(tree, domain);
3022 break;
3023 case isl_schedule_node_expansion:
3024 tree = group_expansion(tree, pos, data);
3025 data->finished = 1;
3026 break;
3027 case isl_schedule_node_leaf:
3028 case isl_schedule_node_guard:
3029 case isl_schedule_node_mark:
3030 case isl_schedule_node_sequence:
3031 case isl_schedule_node_set:
3032 break;
3035 return tree;
3038 /* Group the domain elements that reach "node" into instances
3039 * of a single statement with identifier "group_id".
3040 * In particular, group the domain elements according to their
3041 * prefix schedule.
3043 * That is, introduce an expansion node with as contraction
3044 * the prefix schedule (with the target space replaced by "group_id")
3045 * and as expansion the inverse of this contraction (with its range
3046 * intersected with the domain elements that reach "node").
3047 * The outer nodes are then modified to refer to the group instances
3048 * instead of the original domain elements.
3050 * No instance of "group_id" is allowed to reach "node" prior
3051 * to the grouping.
3052 * No ancestor of "node" is allowed to be an extension node.
3054 * Return a pointer to original node in tree, i.e., the child
3055 * of the newly introduced expansion node.
3057 __isl_give isl_schedule_node *isl_schedule_node_group(
3058 __isl_take isl_schedule_node *node, __isl_take isl_id *group_id)
3060 struct isl_schedule_group_data data = { 0 };
3061 isl_space *space;
3062 isl_union_set *domain;
3063 isl_union_pw_multi_aff *contraction;
3064 isl_union_map *expansion;
3065 int disjoint;
3067 if (!node || !group_id)
3068 goto error;
3069 if (check_insert(node) < 0)
3070 goto error;
3072 domain = isl_schedule_node_get_domain(node);
3073 data.domain = isl_union_set_copy(domain);
3074 data.domain_universe = isl_union_set_copy(domain);
3075 data.domain_universe = isl_union_set_universe(data.domain_universe);
3077 data.dim = isl_schedule_node_get_schedule_depth(node);
3078 if (data.dim == 0) {
3079 isl_ctx *ctx;
3080 isl_set *set;
3081 isl_union_set *group;
3082 isl_union_map *univ;
3084 ctx = isl_schedule_node_get_ctx(node);
3085 space = isl_space_set_alloc(ctx, 0, 0);
3086 space = isl_space_set_tuple_id(space, isl_dim_set, group_id);
3087 set = isl_set_universe(isl_space_copy(space));
3088 group = isl_union_set_from_set(set);
3089 expansion = isl_union_map_from_domain_and_range(domain, group);
3090 univ = isl_union_map_universe(isl_union_map_copy(expansion));
3091 contraction = isl_union_pw_multi_aff_from_union_map(univ);
3092 expansion = isl_union_map_reverse(expansion);
3093 } else {
3094 isl_multi_union_pw_aff *prefix;
3095 isl_union_set *univ;
3097 prefix =
3098 isl_schedule_node_get_prefix_schedule_multi_union_pw_aff(node);
3099 prefix = isl_multi_union_pw_aff_set_tuple_id(prefix,
3100 isl_dim_set, group_id);
3101 space = isl_multi_union_pw_aff_get_space(prefix);
3102 contraction = isl_union_pw_multi_aff_from_multi_union_pw_aff(
3103 prefix);
3104 univ = isl_union_set_universe(isl_union_set_copy(domain));
3105 contraction =
3106 isl_union_pw_multi_aff_intersect_domain(contraction, univ);
3107 expansion = isl_union_map_from_union_pw_multi_aff(
3108 isl_union_pw_multi_aff_copy(contraction));
3109 expansion = isl_union_map_reverse(expansion);
3110 expansion = isl_union_map_intersect_range(expansion, domain);
3112 space = isl_space_map_from_set(space);
3113 data.sched = isl_multi_aff_identity(space);
3114 data.group = isl_union_map_domain(isl_union_map_copy(expansion));
3115 data.group = isl_union_set_coalesce(data.group);
3116 data.group_universe = isl_union_set_copy(data.group);
3117 data.group_universe = isl_union_set_universe(data.group_universe);
3118 data.expansion = isl_union_map_copy(expansion);
3119 data.contraction = isl_union_pw_multi_aff_copy(contraction);
3120 node = isl_schedule_node_insert_expansion(node, contraction, expansion);
3122 disjoint = isl_union_set_is_disjoint(data.domain_universe,
3123 data.group_universe);
3125 node = update_ancestors(node, &group_ancestor, &data);
3127 isl_union_set_free(data.domain);
3128 isl_union_set_free(data.domain_universe);
3129 isl_union_set_free(data.group);
3130 isl_union_set_free(data.group_universe);
3131 isl_multi_aff_free(data.sched);
3132 isl_union_map_free(data.expansion);
3133 isl_union_pw_multi_aff_free(data.contraction);
3135 node = isl_schedule_node_child(node, 0);
3137 if (!node || disjoint < 0)
3138 return isl_schedule_node_free(node);
3139 if (!disjoint)
3140 isl_die(isl_schedule_node_get_ctx(node), isl_error_invalid,
3141 "group instances already reach node",
3142 return isl_schedule_node_free(node));
3144 return node;
3145 error:
3146 isl_schedule_node_free(node);
3147 isl_id_free(group_id);
3148 return NULL;
3151 /* Compute the gist of the given band node with respect to "context".
3153 __isl_give isl_schedule_node *isl_schedule_node_band_gist(
3154 __isl_take isl_schedule_node *node, __isl_take isl_union_set *context)
3156 isl_schedule_tree *tree;
3158 tree = isl_schedule_node_get_tree(node);
3159 tree = isl_schedule_tree_band_gist(tree, context);
3160 return isl_schedule_node_graft_tree(node, tree);
3163 /* Internal data structure for isl_schedule_node_gist.
3164 * "n_expansion" is the number of outer expansion nodes
3165 * with respect to the current position
3166 * "filters" contains an element for each outer filter, expansion or
3167 * extension node with respect to the current position, each representing
3168 * the intersection of the previous element and the filter on the filter node
3169 * or the expansion/extension of the previous element.
3170 * The first element in the original context passed to isl_schedule_node_gist.
3172 struct isl_node_gist_data {
3173 int n_expansion;
3174 isl_union_set_list *filters;
3177 /* Enter the expansion node "node" during a isl_schedule_node_gist traversal.
3179 * In particular, add an extra element to data->filters containing
3180 * the expansion of the previous element and replace the expansion
3181 * and contraction on "node" by the gist with respect to these filters.
3182 * Also keep track of the fact that we have entered another expansion.
3184 static __isl_give isl_schedule_node *gist_enter_expansion(
3185 __isl_take isl_schedule_node *node, struct isl_node_gist_data *data)
3187 int n;
3188 isl_union_set *inner;
3189 isl_union_map *expansion;
3190 isl_union_pw_multi_aff *contraction;
3192 data->n_expansion++;
3194 n = isl_union_set_list_n_union_set(data->filters);
3195 inner = isl_union_set_list_get_union_set(data->filters, n - 1);
3196 expansion = isl_schedule_node_expansion_get_expansion(node);
3197 inner = isl_union_set_apply(inner, expansion);
3199 contraction = isl_schedule_node_expansion_get_contraction(node);
3200 contraction = isl_union_pw_multi_aff_gist(contraction,
3201 isl_union_set_copy(inner));
3203 data->filters = isl_union_set_list_add(data->filters, inner);
3205 inner = isl_union_set_list_get_union_set(data->filters, n - 1);
3206 expansion = isl_schedule_node_expansion_get_expansion(node);
3207 expansion = isl_union_map_gist_domain(expansion, inner);
3208 node = isl_schedule_node_expansion_set_contraction_and_expansion(node,
3209 contraction, expansion);
3211 return node;
3214 /* Leave the expansion node "node" during a isl_schedule_node_gist traversal.
3216 * In particular, remove the element in data->filters that was added by
3217 * gist_enter_expansion and decrement the number of outer expansions.
3219 * The expansion has already been simplified in gist_enter_expansion.
3220 * If this simplification results in an identity expansion, then
3221 * it is removed here.
3223 static __isl_give isl_schedule_node *gist_leave_expansion(
3224 __isl_take isl_schedule_node *node, struct isl_node_gist_data *data)
3226 int n;
3227 isl_bool identity;
3228 isl_union_map *expansion;
3230 expansion = isl_schedule_node_expansion_get_expansion(node);
3231 identity = isl_union_map_is_identity(expansion);
3232 isl_union_map_free(expansion);
3234 if (identity < 0)
3235 node = isl_schedule_node_free(node);
3236 else if (identity)
3237 node = isl_schedule_node_delete(node);
3239 n = isl_union_set_list_n_union_set(data->filters);
3240 data->filters = isl_union_set_list_drop(data->filters, n - 1, 1);
3242 data->n_expansion--;
3244 return node;
3247 /* Enter the extension node "node" during a isl_schedule_node_gist traversal.
3249 * In particular, add an extra element to data->filters containing
3250 * the union of the previous element with the additional domain elements
3251 * introduced by the extension.
3253 static __isl_give isl_schedule_node *gist_enter_extension(
3254 __isl_take isl_schedule_node *node, struct isl_node_gist_data *data)
3256 int n;
3257 isl_union_set *inner, *extra;
3258 isl_union_map *extension;
3260 n = isl_union_set_list_n_union_set(data->filters);
3261 inner = isl_union_set_list_get_union_set(data->filters, n - 1);
3262 extension = isl_schedule_node_extension_get_extension(node);
3263 extra = isl_union_map_range(extension);
3264 inner = isl_union_set_union(inner, extra);
3266 data->filters = isl_union_set_list_add(data->filters, inner);
3268 return node;
3271 /* Can we finish gisting at this node?
3272 * That is, is the filter on the current filter node a subset of
3273 * the original context passed to isl_schedule_node_gist?
3274 * If we have gone through any expansions, then we cannot perform
3275 * this test since the current domain elements are incomparable
3276 * to the domain elements in the original context.
3278 static int gist_done(__isl_keep isl_schedule_node *node,
3279 struct isl_node_gist_data *data)
3281 isl_union_set *filter, *outer;
3282 int subset;
3284 if (data->n_expansion != 0)
3285 return 0;
3287 filter = isl_schedule_node_filter_get_filter(node);
3288 outer = isl_union_set_list_get_union_set(data->filters, 0);
3289 subset = isl_union_set_is_subset(filter, outer);
3290 isl_union_set_free(outer);
3291 isl_union_set_free(filter);
3293 return subset;
3296 /* Callback for "traverse" to enter a node and to move
3297 * to the deepest initial subtree that should be traversed
3298 * by isl_schedule_node_gist.
3300 * The "filters" list is extended by one element each time
3301 * we come across a filter node by the result of intersecting
3302 * the last element in the list with the filter on the filter node.
3304 * If the filter on the current filter node is a subset of
3305 * the original context passed to isl_schedule_node_gist,
3306 * then there is no need to go into its subtree since it cannot
3307 * be further simplified by the context. The "filters" list is
3308 * still extended for consistency, but the actual value of the
3309 * added element is immaterial since it will not be used.
3311 * Otherwise, the filter on the current filter node is replaced by
3312 * the gist of the original filter with respect to the intersection
3313 * of the original context with the intermediate filters.
3315 * If the new element in the "filters" list is empty, then no elements
3316 * can reach the descendants of the current filter node. The subtree
3317 * underneath the filter node is therefore removed.
3319 * Each expansion node we come across is handled by
3320 * gist_enter_expansion.
3322 * Each extension node we come across is handled by
3323 * gist_enter_extension.
3325 static __isl_give isl_schedule_node *gist_enter(
3326 __isl_take isl_schedule_node *node, void *user)
3328 struct isl_node_gist_data *data = user;
3330 do {
3331 isl_union_set *filter, *inner;
3332 int done, empty;
3333 int n;
3335 switch (isl_schedule_node_get_type(node)) {
3336 case isl_schedule_node_error:
3337 return isl_schedule_node_free(node);
3338 case isl_schedule_node_expansion:
3339 node = gist_enter_expansion(node, data);
3340 continue;
3341 case isl_schedule_node_extension:
3342 node = gist_enter_extension(node, data);
3343 continue;
3344 case isl_schedule_node_band:
3345 case isl_schedule_node_context:
3346 case isl_schedule_node_domain:
3347 case isl_schedule_node_guard:
3348 case isl_schedule_node_leaf:
3349 case isl_schedule_node_mark:
3350 case isl_schedule_node_sequence:
3351 case isl_schedule_node_set:
3352 continue;
3353 case isl_schedule_node_filter:
3354 break;
3356 done = gist_done(node, data);
3357 filter = isl_schedule_node_filter_get_filter(node);
3358 if (done < 0 || done) {
3359 data->filters = isl_union_set_list_add(data->filters,
3360 filter);
3361 if (done < 0)
3362 return isl_schedule_node_free(node);
3363 return node;
3365 n = isl_union_set_list_n_union_set(data->filters);
3366 inner = isl_union_set_list_get_union_set(data->filters, n - 1);
3367 filter = isl_union_set_gist(filter, isl_union_set_copy(inner));
3368 node = isl_schedule_node_filter_set_filter(node,
3369 isl_union_set_copy(filter));
3370 filter = isl_union_set_intersect(filter, inner);
3371 empty = isl_union_set_is_empty(filter);
3372 data->filters = isl_union_set_list_add(data->filters, filter);
3373 if (empty < 0)
3374 return isl_schedule_node_free(node);
3375 if (!empty)
3376 continue;
3377 node = isl_schedule_node_child(node, 0);
3378 node = isl_schedule_node_cut(node);
3379 node = isl_schedule_node_parent(node);
3380 return node;
3381 } while (isl_schedule_node_has_children(node) &&
3382 (node = isl_schedule_node_first_child(node)) != NULL);
3384 return node;
3387 /* Callback for "traverse" to leave a node for isl_schedule_node_gist.
3389 * In particular, if the current node is a filter node, then we remove
3390 * the element on the "filters" list that was added when we entered
3391 * the node. There is no need to compute any gist here, since we
3392 * already did that when we entered the node.
3394 * Expansion nodes are handled by gist_leave_expansion.
3396 * If the current node is an extension, then remove the element
3397 * in data->filters that was added by gist_enter_extension.
3399 * If the current node is a band node, then we compute the gist of
3400 * the band node with respect to the intersection of the original context
3401 * and the intermediate filters.
3403 * If the current node is a sequence or set node, then some of
3404 * the filter children may have become empty and so they are removed.
3405 * If only one child is left, then the set or sequence node along with
3406 * the single remaining child filter is removed. The filter can be
3407 * removed because the filters on a sequence or set node are supposed
3408 * to partition the incoming domain instances.
3409 * In principle, it should then be impossible for there to be zero
3410 * remaining children, but should this happen, we replace the entire
3411 * subtree with an empty filter.
3413 static __isl_give isl_schedule_node *gist_leave(
3414 __isl_take isl_schedule_node *node, void *user)
3416 struct isl_node_gist_data *data = user;
3417 isl_schedule_tree *tree;
3418 int i, n;
3419 isl_union_set *filter;
3421 switch (isl_schedule_node_get_type(node)) {
3422 case isl_schedule_node_error:
3423 return isl_schedule_node_free(node);
3424 case isl_schedule_node_expansion:
3425 node = gist_leave_expansion(node, data);
3426 break;
3427 case isl_schedule_node_extension:
3428 case isl_schedule_node_filter:
3429 n = isl_union_set_list_n_union_set(data->filters);
3430 data->filters = isl_union_set_list_drop(data->filters,
3431 n - 1, 1);
3432 break;
3433 case isl_schedule_node_band:
3434 n = isl_union_set_list_n_union_set(data->filters);
3435 filter = isl_union_set_list_get_union_set(data->filters, n - 1);
3436 node = isl_schedule_node_band_gist(node, filter);
3437 break;
3438 case isl_schedule_node_set:
3439 case isl_schedule_node_sequence:
3440 tree = isl_schedule_node_get_tree(node);
3441 n = isl_schedule_tree_n_children(tree);
3442 for (i = n - 1; i >= 0; --i) {
3443 isl_schedule_tree *child;
3444 isl_union_set *filter;
3445 int empty;
3447 child = isl_schedule_tree_get_child(tree, i);
3448 filter = isl_schedule_tree_filter_get_filter(child);
3449 empty = isl_union_set_is_empty(filter);
3450 isl_union_set_free(filter);
3451 isl_schedule_tree_free(child);
3452 if (empty < 0)
3453 tree = isl_schedule_tree_free(tree);
3454 else if (empty)
3455 tree = isl_schedule_tree_drop_child(tree, i);
3457 n = isl_schedule_tree_n_children(tree);
3458 node = isl_schedule_node_graft_tree(node, tree);
3459 if (n == 1) {
3460 node = isl_schedule_node_delete(node);
3461 node = isl_schedule_node_delete(node);
3462 } else if (n == 0) {
3463 isl_space *space;
3465 filter =
3466 isl_union_set_list_get_union_set(data->filters, 0);
3467 space = isl_union_set_get_space(filter);
3468 isl_union_set_free(filter);
3469 filter = isl_union_set_empty(space);
3470 node = isl_schedule_node_cut(node);
3471 node = isl_schedule_node_insert_filter(node, filter);
3473 break;
3474 case isl_schedule_node_context:
3475 case isl_schedule_node_domain:
3476 case isl_schedule_node_guard:
3477 case isl_schedule_node_leaf:
3478 case isl_schedule_node_mark:
3479 break;
3482 return node;
3485 /* Compute the gist of the subtree at "node" with respect to
3486 * the reaching domain elements in "context".
3487 * In particular, compute the gist of all band and filter nodes
3488 * in the subtree with respect to "context". Children of set or sequence
3489 * nodes that end up with an empty filter are removed completely.
3491 * We keep track of the intersection of "context" with all outer filters
3492 * of the current node within the subtree in the final element of "filters".
3493 * Initially, this list contains the single element "context" and it is
3494 * extended or shortened each time we enter or leave a filter node.
3496 __isl_give isl_schedule_node *isl_schedule_node_gist(
3497 __isl_take isl_schedule_node *node, __isl_take isl_union_set *context)
3499 struct isl_node_gist_data data;
3501 data.n_expansion = 0;
3502 data.filters = isl_union_set_list_from_union_set(context);
3503 node = traverse(node, &gist_enter, &gist_leave, &data);
3504 isl_union_set_list_free(data.filters);
3505 return node;
3508 /* Intersect the domain of domain node "node" with "domain".
3510 * If the domain of "node" is already a subset of "domain",
3511 * then nothing needs to be changed.
3513 * Otherwise, we replace the domain of the domain node by the intersection
3514 * and simplify the subtree rooted at "node" with respect to this intersection.
3516 __isl_give isl_schedule_node *isl_schedule_node_domain_intersect_domain(
3517 __isl_take isl_schedule_node *node, __isl_take isl_union_set *domain)
3519 isl_schedule_tree *tree;
3520 isl_union_set *uset;
3521 int is_subset;
3523 if (!node || !domain)
3524 goto error;
3526 uset = isl_schedule_tree_domain_get_domain(node->tree);
3527 is_subset = isl_union_set_is_subset(uset, domain);
3528 isl_union_set_free(uset);
3529 if (is_subset < 0)
3530 goto error;
3531 if (is_subset) {
3532 isl_union_set_free(domain);
3533 return node;
3536 tree = isl_schedule_tree_copy(node->tree);
3537 uset = isl_schedule_tree_domain_get_domain(tree);
3538 uset = isl_union_set_intersect(uset, domain);
3539 tree = isl_schedule_tree_domain_set_domain(tree,
3540 isl_union_set_copy(uset));
3541 node = isl_schedule_node_graft_tree(node, tree);
3543 node = isl_schedule_node_child(node, 0);
3544 node = isl_schedule_node_gist(node, uset);
3545 node = isl_schedule_node_parent(node);
3547 return node;
3548 error:
3549 isl_schedule_node_free(node);
3550 isl_union_set_free(domain);
3551 return NULL;
3554 /* Replace the domain of domain node "node" with the gist
3555 * of the original domain with respect to the parameter domain "context".
3557 __isl_give isl_schedule_node *isl_schedule_node_domain_gist_params(
3558 __isl_take isl_schedule_node *node, __isl_take isl_set *context)
3560 isl_union_set *domain;
3561 isl_schedule_tree *tree;
3563 if (!node || !context)
3564 goto error;
3566 tree = isl_schedule_tree_copy(node->tree);
3567 domain = isl_schedule_tree_domain_get_domain(node->tree);
3568 domain = isl_union_set_gist_params(domain, context);
3569 tree = isl_schedule_tree_domain_set_domain(tree, domain);
3570 node = isl_schedule_node_graft_tree(node, tree);
3572 return node;
3573 error:
3574 isl_schedule_node_free(node);
3575 isl_set_free(context);
3576 return NULL;
3579 /* Internal data structure for isl_schedule_node_get_subtree_expansion.
3580 * "expansions" contains a list of accumulated expansions
3581 * for each outer expansion, set or sequence node. The first element
3582 * in the list is an identity mapping on the reaching domain elements.
3583 * "res" collects the results.
3585 struct isl_subtree_expansion_data {
3586 isl_union_map_list *expansions;
3587 isl_union_map *res;
3590 /* Callback for "traverse" to enter a node and to move
3591 * to the deepest initial subtree that should be traversed
3592 * by isl_schedule_node_get_subtree_expansion.
3594 * Whenever we come across an expansion node, the last element
3595 * of data->expansions is combined with the expansion
3596 * on the expansion node.
3598 * Whenever we come across a filter node that is the child
3599 * of a set or sequence node, data->expansions is extended
3600 * with a new element that restricts the previous element
3601 * to the elements selected by the filter.
3602 * The previous element can then be reused while backtracking.
3604 static __isl_give isl_schedule_node *subtree_expansion_enter(
3605 __isl_take isl_schedule_node *node, void *user)
3607 struct isl_subtree_expansion_data *data = user;
3609 do {
3610 enum isl_schedule_node_type type;
3611 isl_union_set *filter;
3612 isl_union_map *inner, *expansion;
3613 int n;
3615 switch (isl_schedule_node_get_type(node)) {
3616 case isl_schedule_node_error:
3617 return isl_schedule_node_free(node);
3618 case isl_schedule_node_filter:
3619 type = isl_schedule_node_get_parent_type(node);
3620 if (type != isl_schedule_node_set &&
3621 type != isl_schedule_node_sequence)
3622 break;
3623 filter = isl_schedule_node_filter_get_filter(node);
3624 n = isl_union_map_list_n_union_map(data->expansions);
3625 inner =
3626 isl_union_map_list_get_union_map(data->expansions,
3627 n - 1);
3628 inner = isl_union_map_intersect_range(inner, filter);
3629 data->expansions =
3630 isl_union_map_list_add(data->expansions, inner);
3631 break;
3632 case isl_schedule_node_expansion:
3633 n = isl_union_map_list_n_union_map(data->expansions);
3634 expansion =
3635 isl_schedule_node_expansion_get_expansion(node);
3636 inner =
3637 isl_union_map_list_get_union_map(data->expansions,
3638 n - 1);
3639 inner = isl_union_map_apply_range(inner, expansion);
3640 data->expansions =
3641 isl_union_map_list_set_union_map(data->expansions,
3642 n - 1, inner);
3643 break;
3644 case isl_schedule_node_band:
3645 case isl_schedule_node_context:
3646 case isl_schedule_node_domain:
3647 case isl_schedule_node_extension:
3648 case isl_schedule_node_guard:
3649 case isl_schedule_node_leaf:
3650 case isl_schedule_node_mark:
3651 case isl_schedule_node_sequence:
3652 case isl_schedule_node_set:
3653 break;
3655 } while (isl_schedule_node_has_children(node) &&
3656 (node = isl_schedule_node_first_child(node)) != NULL);
3658 return node;
3661 /* Callback for "traverse" to leave a node for
3662 * isl_schedule_node_get_subtree_expansion.
3664 * If we come across a filter node that is the child
3665 * of a set or sequence node, then we remove the element
3666 * of data->expansions that was added in subtree_expansion_enter.
3668 * If we reach a leaf node, then the accumulated expansion is
3669 * added to data->res.
3671 static __isl_give isl_schedule_node *subtree_expansion_leave(
3672 __isl_take isl_schedule_node *node, void *user)
3674 struct isl_subtree_expansion_data *data = user;
3675 int n;
3676 isl_union_map *inner;
3677 enum isl_schedule_node_type type;
3679 switch (isl_schedule_node_get_type(node)) {
3680 case isl_schedule_node_error:
3681 return isl_schedule_node_free(node);
3682 case isl_schedule_node_filter:
3683 type = isl_schedule_node_get_parent_type(node);
3684 if (type != isl_schedule_node_set &&
3685 type != isl_schedule_node_sequence)
3686 break;
3687 n = isl_union_map_list_n_union_map(data->expansions);
3688 data->expansions = isl_union_map_list_drop(data->expansions,
3689 n - 1, 1);
3690 break;
3691 case isl_schedule_node_leaf:
3692 n = isl_union_map_list_n_union_map(data->expansions);
3693 inner = isl_union_map_list_get_union_map(data->expansions,
3694 n - 1);
3695 data->res = isl_union_map_union(data->res, inner);
3696 break;
3697 case isl_schedule_node_band:
3698 case isl_schedule_node_context:
3699 case isl_schedule_node_domain:
3700 case isl_schedule_node_expansion:
3701 case isl_schedule_node_extension:
3702 case isl_schedule_node_guard:
3703 case isl_schedule_node_mark:
3704 case isl_schedule_node_sequence:
3705 case isl_schedule_node_set:
3706 break;
3709 return node;
3712 /* Return a mapping from the domain elements that reach "node"
3713 * to the corresponding domain elements in the leaves of the subtree
3714 * rooted at "node" obtained by composing the intermediate expansions.
3716 * We start out with an identity mapping between the domain elements
3717 * that reach "node" and compose it with all the expansions
3718 * on a path from "node" to a leaf while traversing the subtree.
3719 * Within the children of an a sequence or set node, the
3720 * accumulated expansion is restricted to the elements selected
3721 * by the filter child.
3723 __isl_give isl_union_map *isl_schedule_node_get_subtree_expansion(
3724 __isl_keep isl_schedule_node *node)
3726 struct isl_subtree_expansion_data data;
3727 isl_space *space;
3728 isl_union_set *domain;
3729 isl_union_map *expansion;
3731 if (!node)
3732 return NULL;
3734 domain = isl_schedule_node_get_universe_domain(node);
3735 space = isl_union_set_get_space(domain);
3736 expansion = isl_union_set_identity(domain);
3737 data.res = isl_union_map_empty(space);
3738 data.expansions = isl_union_map_list_from_union_map(expansion);
3740 node = isl_schedule_node_copy(node);
3741 node = traverse(node, &subtree_expansion_enter,
3742 &subtree_expansion_leave, &data);
3743 if (!node)
3744 data.res = isl_union_map_free(data.res);
3745 isl_schedule_node_free(node);
3747 isl_union_map_list_free(data.expansions);
3749 return data.res;
3752 /* Internal data structure for isl_schedule_node_get_subtree_contraction.
3753 * "contractions" contains a list of accumulated contractions
3754 * for each outer expansion, set or sequence node. The first element
3755 * in the list is an identity mapping on the reaching domain elements.
3756 * "res" collects the results.
3758 struct isl_subtree_contraction_data {
3759 isl_union_pw_multi_aff_list *contractions;
3760 isl_union_pw_multi_aff *res;
3763 /* Callback for "traverse" to enter a node and to move
3764 * to the deepest initial subtree that should be traversed
3765 * by isl_schedule_node_get_subtree_contraction.
3767 * Whenever we come across an expansion node, the last element
3768 * of data->contractions is combined with the contraction
3769 * on the expansion node.
3771 * Whenever we come across a filter node that is the child
3772 * of a set or sequence node, data->contractions is extended
3773 * with a new element that restricts the previous element
3774 * to the elements selected by the filter.
3775 * The previous element can then be reused while backtracking.
3777 static __isl_give isl_schedule_node *subtree_contraction_enter(
3778 __isl_take isl_schedule_node *node, void *user)
3780 struct isl_subtree_contraction_data *data = user;
3782 do {
3783 enum isl_schedule_node_type type;
3784 isl_union_set *filter;
3785 isl_union_pw_multi_aff *inner, *contraction;
3786 int n;
3788 switch (isl_schedule_node_get_type(node)) {
3789 case isl_schedule_node_error:
3790 return isl_schedule_node_free(node);
3791 case isl_schedule_node_filter:
3792 type = isl_schedule_node_get_parent_type(node);
3793 if (type != isl_schedule_node_set &&
3794 type != isl_schedule_node_sequence)
3795 break;
3796 filter = isl_schedule_node_filter_get_filter(node);
3797 n = isl_union_pw_multi_aff_list_n_union_pw_multi_aff(
3798 data->contractions);
3799 inner =
3800 isl_union_pw_multi_aff_list_get_union_pw_multi_aff(
3801 data->contractions, n - 1);
3802 inner = isl_union_pw_multi_aff_intersect_domain(inner,
3803 filter);
3804 data->contractions =
3805 isl_union_pw_multi_aff_list_add(data->contractions,
3806 inner);
3807 break;
3808 case isl_schedule_node_expansion:
3809 n = isl_union_pw_multi_aff_list_n_union_pw_multi_aff(
3810 data->contractions);
3811 contraction =
3812 isl_schedule_node_expansion_get_contraction(node);
3813 inner =
3814 isl_union_pw_multi_aff_list_get_union_pw_multi_aff(
3815 data->contractions, n - 1);
3816 inner =
3817 isl_union_pw_multi_aff_pullback_union_pw_multi_aff(
3818 inner, contraction);
3819 data->contractions =
3820 isl_union_pw_multi_aff_list_set_union_pw_multi_aff(
3821 data->contractions, n - 1, inner);
3822 break;
3823 case isl_schedule_node_band:
3824 case isl_schedule_node_context:
3825 case isl_schedule_node_domain:
3826 case isl_schedule_node_extension:
3827 case isl_schedule_node_guard:
3828 case isl_schedule_node_leaf:
3829 case isl_schedule_node_mark:
3830 case isl_schedule_node_sequence:
3831 case isl_schedule_node_set:
3832 break;
3834 } while (isl_schedule_node_has_children(node) &&
3835 (node = isl_schedule_node_first_child(node)) != NULL);
3837 return node;
3840 /* Callback for "traverse" to leave a node for
3841 * isl_schedule_node_get_subtree_contraction.
3843 * If we come across a filter node that is the child
3844 * of a set or sequence node, then we remove the element
3845 * of data->contractions that was added in subtree_contraction_enter.
3847 * If we reach a leaf node, then the accumulated contraction is
3848 * added to data->res.
3850 static __isl_give isl_schedule_node *subtree_contraction_leave(
3851 __isl_take isl_schedule_node *node, void *user)
3853 struct isl_subtree_contraction_data *data = user;
3854 int n;
3855 isl_union_pw_multi_aff *inner;
3856 enum isl_schedule_node_type type;
3858 switch (isl_schedule_node_get_type(node)) {
3859 case isl_schedule_node_error:
3860 return isl_schedule_node_free(node);
3861 case isl_schedule_node_filter:
3862 type = isl_schedule_node_get_parent_type(node);
3863 if (type != isl_schedule_node_set &&
3864 type != isl_schedule_node_sequence)
3865 break;
3866 n = isl_union_pw_multi_aff_list_n_union_pw_multi_aff(
3867 data->contractions);
3868 data->contractions =
3869 isl_union_pw_multi_aff_list_drop(data->contractions,
3870 n - 1, 1);
3871 break;
3872 case isl_schedule_node_leaf:
3873 n = isl_union_pw_multi_aff_list_n_union_pw_multi_aff(
3874 data->contractions);
3875 inner = isl_union_pw_multi_aff_list_get_union_pw_multi_aff(
3876 data->contractions, n - 1);
3877 data->res = isl_union_pw_multi_aff_union_add(data->res, inner);
3878 break;
3879 case isl_schedule_node_band:
3880 case isl_schedule_node_context:
3881 case isl_schedule_node_domain:
3882 case isl_schedule_node_expansion:
3883 case isl_schedule_node_extension:
3884 case isl_schedule_node_guard:
3885 case isl_schedule_node_mark:
3886 case isl_schedule_node_sequence:
3887 case isl_schedule_node_set:
3888 break;
3891 return node;
3894 /* Return a mapping from the domain elements in the leaves of the subtree
3895 * rooted at "node" to the corresponding domain elements that reach "node"
3896 * obtained by composing the intermediate contractions.
3898 * We start out with an identity mapping between the domain elements
3899 * that reach "node" and compose it with all the contractions
3900 * on a path from "node" to a leaf while traversing the subtree.
3901 * Within the children of an a sequence or set node, the
3902 * accumulated contraction is restricted to the elements selected
3903 * by the filter child.
3905 __isl_give isl_union_pw_multi_aff *isl_schedule_node_get_subtree_contraction(
3906 __isl_keep isl_schedule_node *node)
3908 struct isl_subtree_contraction_data data;
3909 isl_space *space;
3910 isl_union_set *domain;
3911 isl_union_pw_multi_aff *contraction;
3913 if (!node)
3914 return NULL;
3916 domain = isl_schedule_node_get_universe_domain(node);
3917 space = isl_union_set_get_space(domain);
3918 contraction = isl_union_set_identity_union_pw_multi_aff(domain);
3919 data.res = isl_union_pw_multi_aff_empty(space);
3920 data.contractions =
3921 isl_union_pw_multi_aff_list_from_union_pw_multi_aff(contraction);
3923 node = isl_schedule_node_copy(node);
3924 node = traverse(node, &subtree_contraction_enter,
3925 &subtree_contraction_leave, &data);
3926 if (!node)
3927 data.res = isl_union_pw_multi_aff_free(data.res);
3928 isl_schedule_node_free(node);
3930 isl_union_pw_multi_aff_list_free(data.contractions);
3932 return data.res;
3935 /* Do the nearest "n" ancestors of "node" have the types given in "types"
3936 * (starting at the parent of "node")?
3938 static int has_ancestors(__isl_keep isl_schedule_node *node,
3939 int n, enum isl_schedule_node_type *types)
3941 int i, n_ancestor;
3943 if (!node)
3944 return -1;
3946 n_ancestor = isl_schedule_tree_list_n_schedule_tree(node->ancestors);
3947 if (n_ancestor < n)
3948 return 0;
3950 for (i = 0; i < n; ++i) {
3951 isl_schedule_tree *tree;
3952 int correct_type;
3954 tree = isl_schedule_tree_list_get_schedule_tree(node->ancestors,
3955 n_ancestor - 1 - i);
3956 if (!tree)
3957 return -1;
3958 correct_type = isl_schedule_tree_get_type(tree) == types[i];
3959 isl_schedule_tree_free(tree);
3960 if (!correct_type)
3961 return 0;
3964 return 1;
3967 /* Given a node "node" that appears in an extension (i.e., it is the child
3968 * of a filter in a sequence inside an extension node), are the spaces
3969 * of the extension specified by "extension" disjoint from those
3970 * of both the original extension and the domain elements that reach
3971 * that original extension?
3973 static int is_disjoint_extension(__isl_keep isl_schedule_node *node,
3974 __isl_keep isl_union_map *extension)
3976 isl_union_map *old;
3977 isl_union_set *domain;
3978 int empty;
3980 node = isl_schedule_node_copy(node);
3981 node = isl_schedule_node_parent(node);
3982 node = isl_schedule_node_parent(node);
3983 node = isl_schedule_node_parent(node);
3984 old = isl_schedule_node_extension_get_extension(node);
3985 domain = isl_schedule_node_get_universe_domain(node);
3986 isl_schedule_node_free(node);
3987 old = isl_union_map_universe(old);
3988 domain = isl_union_set_union(domain, isl_union_map_range(old));
3989 extension = isl_union_map_copy(extension);
3990 extension = isl_union_map_intersect_range(extension, domain);
3991 empty = isl_union_map_is_empty(extension);
3992 isl_union_map_free(extension);
3994 return empty;
3997 /* Given a node "node" that is governed by an extension node, extend
3998 * that extension node with "extension".
4000 * In particular, "node" is the child of a filter in a sequence that
4001 * is in turn a child of an extension node. Extend that extension node
4002 * with "extension".
4004 * Return a pointer to the parent of the original node (i.e., a filter).
4006 static __isl_give isl_schedule_node *extend_extension(
4007 __isl_take isl_schedule_node *node, __isl_take isl_union_map *extension)
4009 int pos;
4010 int disjoint;
4011 isl_union_map *node_extension;
4013 node = isl_schedule_node_parent(node);
4014 pos = isl_schedule_node_get_child_position(node);
4015 node = isl_schedule_node_parent(node);
4016 node = isl_schedule_node_parent(node);
4017 node_extension = isl_schedule_node_extension_get_extension(node);
4018 disjoint = isl_union_map_is_disjoint(extension, node_extension);
4019 extension = isl_union_map_union(extension, node_extension);
4020 node = isl_schedule_node_extension_set_extension(node, extension);
4021 node = isl_schedule_node_child(node, 0);
4022 node = isl_schedule_node_child(node, pos);
4024 if (disjoint < 0)
4025 return isl_schedule_node_free(node);
4026 if (!node)
4027 return NULL;
4028 if (!disjoint)
4029 isl_die(isl_schedule_node_get_ctx(node), isl_error_invalid,
4030 "extension domain should be disjoint from earlier "
4031 "extensions", return isl_schedule_node_free(node));
4033 return node;
4036 /* Return the universe of "uset" if this universe is disjoint from "ref".
4037 * Otherwise, return "uset".
4039 * Also check if "uset" itself is disjoint from "ref", reporting
4040 * an error if it is not.
4042 static __isl_give isl_union_set *replace_by_universe_if_disjoint(
4043 __isl_take isl_union_set *uset, __isl_keep isl_union_set *ref)
4045 int disjoint;
4046 isl_union_set *universe;
4048 disjoint = isl_union_set_is_disjoint(uset, ref);
4049 if (disjoint < 0)
4050 return isl_union_set_free(uset);
4051 if (!disjoint)
4052 isl_die(isl_union_set_get_ctx(uset), isl_error_invalid,
4053 "extension domain should be disjoint from "
4054 "current domain", return isl_union_set_free(uset));
4056 universe = isl_union_set_universe(isl_union_set_copy(uset));
4057 disjoint = isl_union_set_is_disjoint(universe, ref);
4058 if (disjoint >= 0 && disjoint) {
4059 isl_union_set_free(uset);
4060 return universe;
4062 isl_union_set_free(universe);
4064 if (disjoint < 0)
4065 return isl_union_set_free(uset);
4066 return uset;
4069 /* Insert an extension node on top of "node" with extension "extension".
4070 * In addition, insert a filter that separates node from the extension
4071 * between the extension node and "node".
4072 * Return a pointer to the inserted filter node.
4074 * If "node" already appears in an extension (i.e., if it is the child
4075 * of a filter in a sequence inside an extension node), then extend that
4076 * extension with "extension" instead.
4077 * In this case, a pointer to the original filter node is returned.
4078 * Note that if some of the elements in the new extension live in the
4079 * same space as those of the original extension or the domain elements
4080 * reaching the original extension, then we insert a new extension anyway.
4081 * Otherwise, we would have to adjust the filters in the sequence child
4082 * of the extension to ensure that the elements in the new extension
4083 * are filtered out.
4085 static __isl_give isl_schedule_node *insert_extension(
4086 __isl_take isl_schedule_node *node, __isl_take isl_union_map *extension)
4088 enum isl_schedule_node_type ancestors[] =
4089 { isl_schedule_node_filter, isl_schedule_node_sequence,
4090 isl_schedule_node_extension };
4091 isl_union_set *domain;
4092 isl_union_set *filter;
4093 int in_ext;
4095 in_ext = has_ancestors(node, 3, ancestors);
4096 if (in_ext < 0)
4097 goto error;
4098 if (in_ext) {
4099 int disjoint;
4101 disjoint = is_disjoint_extension(node, extension);
4102 if (disjoint < 0)
4103 goto error;
4104 if (disjoint)
4105 return extend_extension(node, extension);
4108 filter = isl_schedule_node_get_domain(node);
4109 domain = isl_union_map_range(isl_union_map_copy(extension));
4110 filter = replace_by_universe_if_disjoint(filter, domain);
4111 isl_union_set_free(domain);
4113 node = isl_schedule_node_insert_filter(node, filter);
4114 node = isl_schedule_node_insert_extension(node, extension);
4115 node = isl_schedule_node_child(node, 0);
4116 return node;
4117 error:
4118 isl_schedule_node_free(node);
4119 isl_union_map_free(extension);
4120 return NULL;
4123 /* Replace the subtree that "node" points to by "tree" (which has
4124 * a sequence root with two children), except if the parent of "node"
4125 * is a sequence as well, in which case "tree" is spliced at the position
4126 * of "node" in its parent.
4127 * Return a pointer to the child of the "tree_pos" (filter) child of "tree"
4128 * in the updated schedule tree.
4130 static __isl_give isl_schedule_node *graft_or_splice(
4131 __isl_take isl_schedule_node *node, __isl_take isl_schedule_tree *tree,
4132 int tree_pos)
4134 int pos;
4136 if (isl_schedule_node_get_parent_type(node) ==
4137 isl_schedule_node_sequence) {
4138 pos = isl_schedule_node_get_child_position(node);
4139 node = isl_schedule_node_parent(node);
4140 node = isl_schedule_node_sequence_splice(node, pos, tree);
4141 } else {
4142 pos = 0;
4143 node = isl_schedule_node_graft_tree(node, tree);
4145 node = isl_schedule_node_child(node, pos + tree_pos);
4146 node = isl_schedule_node_child(node, 0);
4148 return node;
4151 /* Insert a node "graft" into the schedule tree of "node" such that it
4152 * is executed before (if "before" is set) or after (if "before" is not set)
4153 * the node that "node" points to.
4154 * The root of "graft" is an extension node.
4155 * Return a pointer to the node that "node" pointed to.
4157 * We first insert an extension node on top of "node" (or extend
4158 * the extension node if there already is one), with a filter on "node"
4159 * separating it from the extension.
4160 * We then insert a filter in the graft to separate it from the original
4161 * domain elements and combine the original and new tree in a sequence.
4162 * If we have extended an extension node, then the children of this
4163 * sequence are spliced in the sequence of the extended extension
4164 * at the position where "node" appears in the original extension.
4165 * Otherwise, the sequence pair is attached to the new extension node.
4167 static __isl_give isl_schedule_node *graft_extension(
4168 __isl_take isl_schedule_node *node, __isl_take isl_schedule_node *graft,
4169 int before)
4171 isl_union_map *extension;
4172 isl_union_set *graft_domain;
4173 isl_union_set *node_domain;
4174 isl_schedule_tree *tree, *tree_graft;
4176 extension = isl_schedule_node_extension_get_extension(graft);
4177 graft_domain = isl_union_map_range(isl_union_map_copy(extension));
4178 node_domain = isl_schedule_node_get_universe_domain(node);
4179 node = insert_extension(node, extension);
4181 graft_domain = replace_by_universe_if_disjoint(graft_domain,
4182 node_domain);
4183 isl_union_set_free(node_domain);
4185 tree = isl_schedule_node_get_tree(node);
4186 if (!isl_schedule_node_has_children(graft)) {
4187 tree_graft = isl_schedule_tree_from_filter(graft_domain);
4188 } else {
4189 graft = isl_schedule_node_child(graft, 0);
4190 tree_graft = isl_schedule_node_get_tree(graft);
4191 tree_graft = isl_schedule_tree_insert_filter(tree_graft,
4192 graft_domain);
4194 if (before)
4195 tree = isl_schedule_tree_sequence_pair(tree_graft, tree);
4196 else
4197 tree = isl_schedule_tree_sequence_pair(tree, tree_graft);
4198 node = graft_or_splice(node, tree, before);
4200 isl_schedule_node_free(graft);
4202 return node;
4205 /* Replace the root domain node of "node" by an extension node suitable
4206 * for insertion at "pos".
4207 * That is, create an extension node that maps the outer band nodes
4208 * at "pos" to the domain of the root node of "node" and attach
4209 * the child of this root node to the extension node.
4211 static __isl_give isl_schedule_node *extension_from_domain(
4212 __isl_take isl_schedule_node *node, __isl_keep isl_schedule_node *pos)
4214 isl_union_set *universe;
4215 isl_union_set *domain;
4216 isl_union_map *ext;
4217 int depth;
4218 int anchored;
4219 isl_space *space;
4220 isl_schedule_node *res;
4221 isl_schedule_tree *tree;
4223 anchored = isl_schedule_node_is_subtree_anchored(node);
4224 if (anchored < 0)
4225 return isl_schedule_node_free(node);
4226 if (anchored)
4227 isl_die(isl_schedule_node_get_ctx(node), isl_error_unsupported,
4228 "cannot graft anchored tree with domain root",
4229 return isl_schedule_node_free(node));
4231 depth = isl_schedule_node_get_schedule_depth(pos);
4232 domain = isl_schedule_node_domain_get_domain(node);
4233 space = isl_union_set_get_space(domain);
4234 space = isl_space_set_from_params(space);
4235 space = isl_space_add_dims(space, isl_dim_set, depth);
4236 universe = isl_union_set_from_set(isl_set_universe(space));
4237 ext = isl_union_map_from_domain_and_range(universe, domain);
4238 res = isl_schedule_node_from_extension(ext);
4239 node = isl_schedule_node_child(node, 0);
4240 if (!node)
4241 return isl_schedule_node_free(res);
4242 if (!isl_schedule_tree_is_leaf(node->tree)) {
4243 tree = isl_schedule_node_get_tree(node);
4244 res = isl_schedule_node_child(res, 0);
4245 res = isl_schedule_node_graft_tree(res, tree);
4246 res = isl_schedule_node_parent(res);
4248 isl_schedule_node_free(node);
4250 return res;
4253 /* Insert a node "graft" into the schedule tree of "node" such that it
4254 * is executed before (if "before" is set) or after (if "before" is not set)
4255 * the node that "node" points to.
4256 * The root of "graft" may be either a domain or an extension node.
4257 * In the latter case, the domain of the extension needs to correspond
4258 * to the outer band nodes of "node".
4259 * The elements of the domain or the range of the extension may not
4260 * intersect with the domain elements that reach "node".
4261 * The schedule tree of "graft" may not be anchored.
4263 * The schedule tree of "node" is modified to include an extension node
4264 * corresponding to the root node of "graft" as a child of the original
4265 * parent of "node". The original node that "node" points to and the
4266 * child of the root node of "graft" are attached to this extension node
4267 * through a sequence, with appropriate filters and with the child
4268 * of "graft" appearing before or after the original "node".
4270 * If "node" already appears inside a sequence that is the child of
4271 * an extension node and if the spaces of the new domain elements
4272 * do not overlap with those of the original domain elements,
4273 * then that extension node is extended with the new extension
4274 * rather than introducing a new segment of extension and sequence nodes.
4276 * Return a pointer to the same node in the modified tree that
4277 * "node" pointed to in the original tree.
4279 static __isl_give isl_schedule_node *isl_schedule_node_graft_before_or_after(
4280 __isl_take isl_schedule_node *node, __isl_take isl_schedule_node *graft,
4281 int before)
4283 if (!node || !graft)
4284 goto error;
4285 if (check_insert(node) < 0)
4286 goto error;
4288 if (isl_schedule_node_get_type(graft) == isl_schedule_node_domain)
4289 graft = extension_from_domain(graft, node);
4291 if (isl_schedule_node_get_type(graft) != isl_schedule_node_extension)
4292 isl_die(isl_schedule_node_get_ctx(node), isl_error_invalid,
4293 "expecting domain or extension as root of graft",
4294 goto error);
4296 return graft_extension(node, graft, before);
4297 error:
4298 isl_schedule_node_free(node);
4299 isl_schedule_node_free(graft);
4300 return NULL;
4303 /* Insert a node "graft" into the schedule tree of "node" such that it
4304 * is executed before the node that "node" points to.
4305 * The root of "graft" may be either a domain or an extension node.
4306 * In the latter case, the domain of the extension needs to correspond
4307 * to the outer band nodes of "node".
4308 * The elements of the domain or the range of the extension may not
4309 * intersect with the domain elements that reach "node".
4310 * The schedule tree of "graft" may not be anchored.
4312 * Return a pointer to the same node in the modified tree that
4313 * "node" pointed to in the original tree.
4315 __isl_give isl_schedule_node *isl_schedule_node_graft_before(
4316 __isl_take isl_schedule_node *node, __isl_take isl_schedule_node *graft)
4318 return isl_schedule_node_graft_before_or_after(node, graft, 1);
4321 /* Insert a node "graft" into the schedule tree of "node" such that it
4322 * is executed after the node that "node" points to.
4323 * The root of "graft" may be either a domain or an extension node.
4324 * In the latter case, the domain of the extension needs to correspond
4325 * to the outer band nodes of "node".
4326 * The elements of the domain or the range of the extension may not
4327 * intersect with the domain elements that reach "node".
4328 * The schedule tree of "graft" may not be anchored.
4330 * Return a pointer to the same node in the modified tree that
4331 * "node" pointed to in the original tree.
4333 __isl_give isl_schedule_node *isl_schedule_node_graft_after(
4334 __isl_take isl_schedule_node *node,
4335 __isl_take isl_schedule_node *graft)
4337 return isl_schedule_node_graft_before_or_after(node, graft, 0);
4340 /* Split the domain elements that reach "node" into those that satisfy
4341 * "filter" and those that do not. Arrange for the first subset to be
4342 * executed before or after the second subset, depending on the value
4343 * of "before".
4344 * Return a pointer to the tree corresponding to the second subset,
4345 * except when this subset is empty in which case the original pointer
4346 * is returned.
4347 * If both subsets are non-empty, then a sequence node is introduced
4348 * to impose the order. If the grandparent of the original node was
4349 * itself a sequence, then the original child is replaced by two children
4350 * in this sequence instead.
4351 * The children in the sequence are copies of the original subtree,
4352 * simplified with respect to their filters.
4354 static __isl_give isl_schedule_node *isl_schedule_node_order_before_or_after(
4355 __isl_take isl_schedule_node *node, __isl_take isl_union_set *filter,
4356 int before)
4358 enum isl_schedule_node_type ancestors[] =
4359 { isl_schedule_node_filter, isl_schedule_node_sequence };
4360 isl_union_set *node_domain, *node_filter = NULL, *parent_filter;
4361 isl_schedule_node *node2;
4362 isl_schedule_tree *tree1, *tree2;
4363 int empty1, empty2;
4364 int in_seq;
4366 if (!node || !filter)
4367 goto error;
4368 if (check_insert(node) < 0)
4369 goto error;
4371 in_seq = has_ancestors(node, 2, ancestors);
4372 if (in_seq < 0)
4373 goto error;
4374 node_domain = isl_schedule_node_get_domain(node);
4375 filter = isl_union_set_gist(filter, isl_union_set_copy(node_domain));
4376 node_filter = isl_union_set_copy(node_domain);
4377 node_filter = isl_union_set_subtract(node_filter,
4378 isl_union_set_copy(filter));
4379 node_filter = isl_union_set_gist(node_filter, node_domain);
4380 empty1 = isl_union_set_is_empty(filter);
4381 empty2 = isl_union_set_is_empty(node_filter);
4382 if (empty1 < 0 || empty2 < 0)
4383 goto error;
4384 if (empty1 || empty2) {
4385 isl_union_set_free(filter);
4386 isl_union_set_free(node_filter);
4387 return node;
4390 if (in_seq) {
4391 node = isl_schedule_node_parent(node);
4392 parent_filter = isl_schedule_node_filter_get_filter(node);
4393 node_filter = isl_union_set_intersect(node_filter,
4394 isl_union_set_copy(parent_filter));
4395 filter = isl_union_set_intersect(filter, parent_filter);
4398 node2 = isl_schedule_node_copy(node);
4399 node = isl_schedule_node_gist(node, isl_union_set_copy(node_filter));
4400 node2 = isl_schedule_node_gist(node2, isl_union_set_copy(filter));
4401 tree1 = isl_schedule_node_get_tree(node);
4402 tree2 = isl_schedule_node_get_tree(node2);
4403 tree1 = isl_schedule_tree_insert_filter(tree1, node_filter);
4404 tree2 = isl_schedule_tree_insert_filter(tree2, filter);
4405 isl_schedule_node_free(node2);
4407 if (before) {
4408 tree1 = isl_schedule_tree_sequence_pair(tree2, tree1);
4409 node = graft_or_splice(node, tree1, 1);
4410 } else {
4411 tree1 = isl_schedule_tree_sequence_pair(tree1, tree2);
4412 node = graft_or_splice(node, tree1, 0);
4415 return node;
4416 error:
4417 isl_schedule_node_free(node);
4418 isl_union_set_free(filter);
4419 isl_union_set_free(node_filter);
4420 return NULL;
4423 /* Split the domain elements that reach "node" into those that satisfy
4424 * "filter" and those that do not. Arrange for the first subset to be
4425 * executed before the second subset.
4426 * Return a pointer to the tree corresponding to the second subset,
4427 * except when this subset is empty in which case the original pointer
4428 * is returned.
4430 __isl_give isl_schedule_node *isl_schedule_node_order_before(
4431 __isl_take isl_schedule_node *node, __isl_take isl_union_set *filter)
4433 return isl_schedule_node_order_before_or_after(node, filter, 1);
4436 /* Split the domain elements that reach "node" into those that satisfy
4437 * "filter" and those that do not. Arrange for the first subset to be
4438 * executed after the second subset.
4439 * Return a pointer to the tree corresponding to the second subset,
4440 * except when this subset is empty in which case the original pointer
4441 * is returned.
4443 __isl_give isl_schedule_node *isl_schedule_node_order_after(
4444 __isl_take isl_schedule_node *node, __isl_take isl_union_set *filter)
4446 return isl_schedule_node_order_before_or_after(node, filter, 0);
4449 /* Reset the user pointer on all identifiers of parameters and tuples
4450 * in the schedule node "node".
4452 __isl_give isl_schedule_node *isl_schedule_node_reset_user(
4453 __isl_take isl_schedule_node *node)
4455 isl_schedule_tree *tree;
4457 tree = isl_schedule_node_get_tree(node);
4458 tree = isl_schedule_tree_reset_user(tree);
4459 node = isl_schedule_node_graft_tree(node, tree);
4461 return node;
4464 /* Align the parameters of the schedule node "node" to those of "space".
4466 __isl_give isl_schedule_node *isl_schedule_node_align_params(
4467 __isl_take isl_schedule_node *node, __isl_take isl_space *space)
4469 isl_schedule_tree *tree;
4471 tree = isl_schedule_node_get_tree(node);
4472 tree = isl_schedule_tree_align_params(tree, space);
4473 node = isl_schedule_node_graft_tree(node, tree);
4475 return node;
4478 /* Compute the pullback of schedule node "node"
4479 * by the function represented by "upma".
4480 * In other words, plug in "upma" in the iteration domains
4481 * of schedule node "node".
4482 * We currently do not handle expansion nodes.
4484 * Note that this is only a helper function for
4485 * isl_schedule_pullback_union_pw_multi_aff. In order to maintain consistency,
4486 * this function should not be called on a single node without also
4487 * calling it on all the other nodes.
4489 __isl_give isl_schedule_node *isl_schedule_node_pullback_union_pw_multi_aff(
4490 __isl_take isl_schedule_node *node,
4491 __isl_take isl_union_pw_multi_aff *upma)
4493 isl_schedule_tree *tree;
4495 tree = isl_schedule_node_get_tree(node);
4496 tree = isl_schedule_tree_pullback_union_pw_multi_aff(tree, upma);
4497 node = isl_schedule_node_graft_tree(node, tree);
4499 return node;
4502 /* Internal data structure for isl_schedule_node_expand.
4503 * "tree" is the tree that needs to be plugged in in all the leaves.
4504 * "domain" is the set of domain elements in the original leaves
4505 * to which the tree applies.
4507 struct isl_schedule_expand_data {
4508 isl_schedule_tree *tree;
4509 isl_union_set *domain;
4512 /* If "node" is a leaf, then plug in data->tree, simplifying it
4513 * within its new context.
4515 * If there are any domain elements at the leaf where the tree
4516 * should not be plugged in (i.e., there are elements not in data->domain)
4517 * then first extend the tree to only apply to the elements in data->domain
4518 * by constructing a set node that selects data->tree for elements
4519 * in data->domain and a leaf for the other elements.
4521 static __isl_give isl_schedule_node *expand(__isl_take isl_schedule_node *node,
4522 void *user)
4524 struct isl_schedule_expand_data *data = user;
4525 isl_schedule_tree *tree, *leaf;
4526 isl_union_set *domain, *left;
4527 isl_bool empty;
4529 if (isl_schedule_node_get_type(node) != isl_schedule_node_leaf)
4530 return node;
4532 domain = isl_schedule_node_get_domain(node);
4533 tree = isl_schedule_tree_copy(data->tree);
4535 left = isl_union_set_copy(domain);
4536 left = isl_union_set_subtract(left, isl_union_set_copy(data->domain));
4537 empty = isl_union_set_is_empty(left);
4538 if (empty >= 0 && !empty) {
4539 leaf = isl_schedule_node_get_leaf(node);
4540 leaf = isl_schedule_tree_insert_filter(leaf, left);
4541 left = isl_union_set_copy(data->domain);
4542 tree = isl_schedule_tree_insert_filter(tree, left);
4543 tree = isl_schedule_tree_set_pair(tree, leaf);
4544 } else {
4545 if (empty < 0)
4546 node = isl_schedule_node_free(node);
4547 isl_union_set_free(left);
4550 node = isl_schedule_node_graft_tree(node, tree);
4551 node = isl_schedule_node_gist(node, domain);
4553 return node;
4556 /* Expand the tree rooted at "node" by extending all leaves
4557 * with an expansion node with as child "tree".
4558 * The expansion is determined by "contraction" and "domain".
4559 * That is, the elements of "domain" are contracted according
4560 * to "contraction". The expansion relation is then the inverse
4561 * of "contraction" with its range intersected with "domain".
4563 * Insert the appropriate expansion node on top of "tree" and
4564 * then plug in the result in all leaves of "node".
4566 __isl_give isl_schedule_node *isl_schedule_node_expand(
4567 __isl_take isl_schedule_node *node,
4568 __isl_take isl_union_pw_multi_aff *contraction,
4569 __isl_take isl_union_set *domain,
4570 __isl_take isl_schedule_tree *tree)
4572 struct isl_schedule_expand_data data;
4573 isl_union_map *expansion;
4574 isl_union_pw_multi_aff *copy;
4576 if (!node || !contraction || !tree)
4577 node = isl_schedule_node_free(node);
4579 copy = isl_union_pw_multi_aff_copy(contraction);
4580 expansion = isl_union_map_from_union_pw_multi_aff(copy);
4581 expansion = isl_union_map_reverse(expansion);
4582 expansion = isl_union_map_intersect_range(expansion, domain);
4583 data.domain = isl_union_map_domain(isl_union_map_copy(expansion));
4585 tree = isl_schedule_tree_insert_expansion(tree, contraction, expansion);
4586 data.tree = tree;
4588 node = isl_schedule_node_map_descendant_bottom_up(node, &expand, &data);
4589 isl_union_set_free(data.domain);
4590 isl_schedule_tree_free(data.tree);
4591 return node;
4594 /* Return the position of the subtree containing "node" among the children
4595 * of "ancestor". "node" is assumed to be a descendant of "ancestor".
4596 * In particular, both nodes should point to the same schedule tree.
4598 * Return -1 on error.
4600 int isl_schedule_node_get_ancestor_child_position(
4601 __isl_keep isl_schedule_node *node,
4602 __isl_keep isl_schedule_node *ancestor)
4604 int n1, n2;
4605 isl_schedule_tree *tree;
4607 if (!node || !ancestor)
4608 return -1;
4610 if (node->schedule != ancestor->schedule)
4611 isl_die(isl_schedule_node_get_ctx(node), isl_error_invalid,
4612 "not a descendant", return -1);
4614 n1 = isl_schedule_node_get_tree_depth(ancestor);
4615 n2 = isl_schedule_node_get_tree_depth(node);
4617 if (n1 >= n2)
4618 isl_die(isl_schedule_node_get_ctx(node), isl_error_invalid,
4619 "not a descendant", return -1);
4620 tree = isl_schedule_tree_list_get_schedule_tree(node->ancestors, n1);
4621 isl_schedule_tree_free(tree);
4622 if (tree != ancestor->tree)
4623 isl_die(isl_schedule_node_get_ctx(node), isl_error_invalid,
4624 "not a descendant", return -1);
4626 return node->child_pos[n1];
4629 /* Given two nodes that point to the same schedule tree, return their
4630 * closest shared ancestor.
4632 * Since the two nodes point to the same schedule, they share at least
4633 * one ancestor, the root of the schedule. We move down from the root
4634 * to the first ancestor where the respective children have a different
4635 * child position. This is the requested ancestor.
4636 * If there is no ancestor where the children have a different position,
4637 * then one node is an ancestor of the other and then this node is
4638 * the requested ancestor.
4640 __isl_give isl_schedule_node *isl_schedule_node_get_shared_ancestor(
4641 __isl_keep isl_schedule_node *node1,
4642 __isl_keep isl_schedule_node *node2)
4644 int i, n1, n2;
4646 if (!node1 || !node2)
4647 return NULL;
4648 if (node1->schedule != node2->schedule)
4649 isl_die(isl_schedule_node_get_ctx(node1), isl_error_invalid,
4650 "not part of same schedule", return NULL);
4651 n1 = isl_schedule_node_get_tree_depth(node1);
4652 n2 = isl_schedule_node_get_tree_depth(node2);
4653 if (n2 < n1)
4654 return isl_schedule_node_get_shared_ancestor(node2, node1);
4655 if (n1 == 0)
4656 return isl_schedule_node_copy(node1);
4657 if (isl_schedule_node_is_equal(node1, node2))
4658 return isl_schedule_node_copy(node1);
4660 for (i = 0; i < n1; ++i)
4661 if (node1->child_pos[i] != node2->child_pos[i])
4662 break;
4664 node1 = isl_schedule_node_copy(node1);
4665 return isl_schedule_node_ancestor(node1, n1 - i);
4668 /* Print "node" to "p".
4670 __isl_give isl_printer *isl_printer_print_schedule_node(
4671 __isl_take isl_printer *p, __isl_keep isl_schedule_node *node)
4673 if (!node)
4674 return isl_printer_free(p);
4675 return isl_printer_print_schedule_tree_mark(p, node->schedule->root,
4676 isl_schedule_tree_list_n_schedule_tree(node->ancestors),
4677 node->child_pos);
4680 void isl_schedule_node_dump(__isl_keep isl_schedule_node *node)
4682 isl_ctx *ctx;
4683 isl_printer *printer;
4685 if (!node)
4686 return;
4688 ctx = isl_schedule_node_get_ctx(node);
4689 printer = isl_printer_to_file(ctx, stderr);
4690 printer = isl_printer_set_yaml_style(printer, ISL_YAML_STYLE_BLOCK);
4691 printer = isl_printer_print_schedule_node(printer, node);
4693 isl_printer_free(printer);
4696 /* Return a string representation of "node".
4697 * Print the schedule node in block format as it would otherwise
4698 * look identical to the entire schedule.
4700 __isl_give char *isl_schedule_node_to_str(__isl_keep isl_schedule_node *node)
4702 isl_printer *printer;
4703 char *s;
4705 if (!node)
4706 return NULL;
4708 printer = isl_printer_to_str(isl_schedule_node_get_ctx(node));
4709 printer = isl_printer_set_yaml_style(printer, ISL_YAML_STYLE_BLOCK);
4710 printer = isl_printer_print_schedule_node(printer, node);
4711 s = isl_printer_get_str(printer);
4712 isl_printer_free(printer);
4714 return s;