add isl_schedule_node_ancestor
[isl.git] / isl_schedule_node.c
blobb769e46617307ae7b1b1b73156df060cbc738da0
1 /*
2 * Copyright 2013 Ecole Normale Superieure
4 * Use of this software is governed by the MIT license
6 * Written by Sven Verdoolaege,
7 * Ecole Normale Superieure, 45 rue d'Ulm, 75230 Paris, France
8 */
10 #include <isl/set.h>
11 #include <isl_schedule_band.h>
12 #include <isl_schedule_private.h>
13 #include <isl_schedule_node_private.h>
15 /* Create a new schedule node in the given schedule, point at the given
16 * tree with given ancestors and child positions.
17 * "child_pos" may be NULL if there are no ancestors.
19 __isl_give isl_schedule_node *isl_schedule_node_alloc(
20 __isl_take isl_schedule *schedule, __isl_take isl_schedule_tree *tree,
21 __isl_take isl_schedule_tree_list *ancestors, int *child_pos)
23 isl_ctx *ctx;
24 isl_schedule_node *node;
25 int i, n;
27 if (!schedule || !tree || !ancestors)
28 goto error;
29 n = isl_schedule_tree_list_n_schedule_tree(ancestors);
30 if (n > 0 && !child_pos)
31 goto error;
32 ctx = isl_schedule_get_ctx(schedule);
33 node = isl_calloc_type(ctx, isl_schedule_node);
34 if (!node)
35 goto error;
36 node->ref = 1;
37 node->schedule = schedule;
38 node->tree = tree;
39 node->ancestors = ancestors;
40 node->child_pos = isl_alloc_array(ctx, int, n);
41 if (n && !node->child_pos)
42 return isl_schedule_node_free(node);
43 for (i = 0; i < n; ++i)
44 node->child_pos[i] = child_pos[i];
46 return node;
47 error:
48 isl_schedule_free(schedule);
49 isl_schedule_tree_free(tree);
50 isl_schedule_tree_list_free(ancestors);
51 return NULL;
54 /* Return a pointer to the root of a schedule tree with as single
55 * node a domain node with the given domain.
57 __isl_give isl_schedule_node *isl_schedule_node_from_domain(
58 __isl_take isl_union_set *domain)
60 isl_schedule *schedule;
61 isl_schedule_node *node;
63 schedule = isl_schedule_from_domain(domain);
64 node = isl_schedule_get_root(schedule);
65 isl_schedule_free(schedule);
67 return node;
70 /* Return the isl_ctx to which "node" belongs.
72 isl_ctx *isl_schedule_node_get_ctx(__isl_keep isl_schedule_node *node)
74 return node ? isl_schedule_get_ctx(node->schedule) : NULL;
77 /* Return a pointer to the leaf of the schedule into which "node" points.
79 * Even though these leaves are not reference counted, we still
80 * indicate that this function does not return a copy.
82 __isl_keep isl_schedule_tree *isl_schedule_node_peek_leaf(
83 __isl_keep isl_schedule_node *node)
85 return node ? isl_schedule_peek_leaf(node->schedule) : NULL;
88 /* Return a pointer to the leaf of the schedule into which "node" points.
90 * Even though these leaves are not reference counted, we still
91 * return a "copy" of the leaf here such that it can still be "freed"
92 * by the user.
94 __isl_give isl_schedule_tree *isl_schedule_node_get_leaf(
95 __isl_keep isl_schedule_node *node)
97 return isl_schedule_tree_copy(isl_schedule_node_peek_leaf(node));
100 /* Return the type of the node or isl_schedule_node_error on error.
102 enum isl_schedule_node_type isl_schedule_node_get_type(
103 __isl_keep isl_schedule_node *node)
105 return node ? isl_schedule_tree_get_type(node->tree)
106 : isl_schedule_node_error;
109 /* Return the type of the parent of "node" or isl_schedule_node_error on error.
111 enum isl_schedule_node_type isl_schedule_node_get_parent_type(
112 __isl_keep isl_schedule_node *node)
114 int pos;
115 int has_parent;
116 isl_schedule_tree *parent;
117 enum isl_schedule_node_type type;
119 if (!node)
120 return isl_schedule_node_error;
121 has_parent = isl_schedule_node_has_parent(node);
122 if (has_parent < 0)
123 return isl_schedule_node_error;
124 if (!has_parent)
125 isl_die(isl_schedule_node_get_ctx(node), isl_error_invalid,
126 "node has no parent", return isl_schedule_node_error);
128 pos = isl_schedule_tree_list_n_schedule_tree(node->ancestors) - 1;
129 parent = isl_schedule_tree_list_get_schedule_tree(node->ancestors, pos);
130 type = isl_schedule_tree_get_type(parent);
131 isl_schedule_tree_free(parent);
133 return type;
136 /* Return a copy of the subtree that this node points to.
138 __isl_give isl_schedule_tree *isl_schedule_node_get_tree(
139 __isl_keep isl_schedule_node *node)
141 if (!node)
142 return NULL;
144 return isl_schedule_tree_copy(node->tree);
147 /* Return a copy of the schedule into which "node" points.
149 __isl_give isl_schedule *isl_schedule_node_get_schedule(
150 __isl_keep isl_schedule_node *node)
152 if (!node)
153 return NULL;
154 return isl_schedule_copy(node->schedule);
157 /* Return a fresh copy of "node".
159 __isl_take isl_schedule_node *isl_schedule_node_dup(
160 __isl_keep isl_schedule_node *node)
162 if (!node)
163 return NULL;
165 return isl_schedule_node_alloc(isl_schedule_copy(node->schedule),
166 isl_schedule_tree_copy(node->tree),
167 isl_schedule_tree_list_copy(node->ancestors),
168 node->child_pos);
171 /* Return an isl_schedule_node that is equal to "node" and that has only
172 * a single reference.
174 __isl_give isl_schedule_node *isl_schedule_node_cow(
175 __isl_take isl_schedule_node *node)
177 if (!node)
178 return NULL;
180 if (node->ref == 1)
181 return node;
182 node->ref--;
183 return isl_schedule_node_dup(node);
186 /* Return a new reference to "node".
188 __isl_give isl_schedule_node *isl_schedule_node_copy(
189 __isl_keep isl_schedule_node *node)
191 if (!node)
192 return NULL;
194 node->ref++;
195 return node;
198 /* Free "node" and return NULL.
200 * Since the node may point to a leaf of its schedule, which
201 * point to a field inside the schedule, we need to make sure
202 * we free the tree before freeing the schedule.
204 __isl_null isl_schedule_node *isl_schedule_node_free(
205 __isl_take isl_schedule_node *node)
207 if (!node)
208 return NULL;
209 if (--node->ref > 0)
210 return NULL;
212 isl_schedule_tree_list_free(node->ancestors);
213 free(node->child_pos);
214 isl_schedule_tree_free(node->tree);
215 isl_schedule_free(node->schedule);
216 free(node);
218 return NULL;
221 /* Do "node1" and "node2" point to the same position in the same
222 * schedule?
224 int isl_schedule_node_is_equal(__isl_keep isl_schedule_node *node1,
225 __isl_keep isl_schedule_node *node2)
227 int i, n1, n2;
229 if (!node1 || !node2)
230 return -1;
231 if (node1 == node2)
232 return 1;
233 if (node1->schedule != node2->schedule)
234 return 0;
236 n1 = isl_schedule_node_get_tree_depth(node1);
237 n2 = isl_schedule_node_get_tree_depth(node2);
238 if (n1 != n2)
239 return 0;
240 for (i = 0; i < n1; ++i)
241 if (node1->child_pos[i] != node2->child_pos[i])
242 return 0;
244 return 1;
247 /* Internal data structure for
248 * isl_schedule_node_get_prefix_schedule_union_pw_multi_aff
250 * "initialized" is set if the filter field has been initialized.
251 * "universe_filter" is set if we are only collecting the universes of filters
252 * "collect_prefix" is set if we are collecting prefixes.
253 * "filter" collects all outer filters and is NULL until "initialized" is set.
254 * "prefix" collects all outer band partial schedules (if "collect_prefix"
255 * is set). If it is used, then it is initialized by the caller
256 * of collect_filter_prefix to a zero-dimensional function.
258 struct isl_schedule_node_get_filter_prefix_data {
259 int initialized;
260 int universe_filter;
261 int collect_prefix;
262 isl_union_set *filter;
263 isl_multi_union_pw_aff *prefix;
266 /* Update "data" based on the tree node "tree" in case "data" has
267 * not been initialized yet.
269 * Return 0 on success and -1 on error.
271 * If "tree" is a filter, then we set data->filter to this filter
272 * (or its universe).
273 * If "tree" is a domain, then this means we have reached the root
274 * of the schedule tree without being able to extract any information.
275 * We therefore initialize data->filter to the universe of the domain.
276 * If "tree" is a band with at least one member, then we set data->filter
277 * to the universe of the schedule domain and replace the zero-dimensional
278 * data->prefix by the band schedule (if data->collect_prefix is set).
280 static int collect_filter_prefix_init(__isl_keep isl_schedule_tree *tree,
281 struct isl_schedule_node_get_filter_prefix_data *data)
283 enum isl_schedule_node_type type;
284 isl_multi_union_pw_aff *mupa;
285 isl_union_set *filter;
287 type = isl_schedule_tree_get_type(tree);
288 switch (type) {
289 case isl_schedule_node_error:
290 return -1;
291 case isl_schedule_node_leaf:
292 case isl_schedule_node_sequence:
293 case isl_schedule_node_set:
294 return 0;
295 case isl_schedule_node_domain:
296 filter = isl_schedule_tree_domain_get_domain(tree);
297 filter = isl_union_set_universe(filter);
298 data->filter = filter;
299 break;
300 case isl_schedule_node_band:
301 if (isl_schedule_tree_band_n_member(tree) == 0)
302 return 0;
303 mupa = isl_schedule_tree_band_get_partial_schedule(tree);
304 if (data->collect_prefix) {
305 isl_multi_union_pw_aff_free(data->prefix);
306 mupa = isl_multi_union_pw_aff_reset_tuple_id(mupa,
307 isl_dim_set);
308 data->prefix = isl_multi_union_pw_aff_copy(mupa);
310 filter = isl_multi_union_pw_aff_domain(mupa);
311 filter = isl_union_set_universe(filter);
312 data->filter = filter;
313 break;
314 case isl_schedule_node_filter:
315 filter = isl_schedule_tree_filter_get_filter(tree);
316 if (data->universe_filter)
317 filter = isl_union_set_universe(filter);
318 data->filter = filter;
319 break;
322 if ((data->collect_prefix && !data->prefix) || !data->filter)
323 return -1;
325 data->initialized = 1;
327 return 0;
330 /* Update "data" based on the tree node "tree" in case "data" has
331 * already been initialized.
333 * Return 0 on success and -1 on error.
335 * If "tree" is a filter, then we intersect data->filter with this filter
336 * (or its universe).
337 * If "tree" is a band with at least one member and data->collect_prefix
338 * is set, then we extend data->prefix with the band schedule.
340 static int collect_filter_prefix_update(__isl_keep isl_schedule_tree *tree,
341 struct isl_schedule_node_get_filter_prefix_data *data)
343 enum isl_schedule_node_type type;
344 isl_multi_union_pw_aff *mupa;
345 isl_union_set *filter;
347 type = isl_schedule_tree_get_type(tree);
348 switch (type) {
349 case isl_schedule_node_error:
350 return -1;
351 case isl_schedule_node_domain:
352 case isl_schedule_node_leaf:
353 case isl_schedule_node_sequence:
354 case isl_schedule_node_set:
355 break;
356 case isl_schedule_node_band:
357 if (isl_schedule_tree_band_n_member(tree) == 0)
358 break;
359 if (!data->collect_prefix)
360 break;
361 mupa = isl_schedule_tree_band_get_partial_schedule(tree);
362 data->prefix = isl_multi_union_pw_aff_flat_range_product(mupa,
363 data->prefix);
364 if (!data->prefix)
365 return -1;
366 break;
367 case isl_schedule_node_filter:
368 filter = isl_schedule_tree_filter_get_filter(tree);
369 if (data->universe_filter)
370 filter = isl_union_set_universe(filter);
371 data->filter = isl_union_set_intersect(data->filter, filter);
372 if (!data->filter)
373 return -1;
374 break;
377 return 0;
380 /* Collect filter and/or prefix information from the elements
381 * in "list" (which represent the ancestors of a node).
382 * Store the results in "data".
384 * Return 0 on success and -1 on error.
386 * We traverse the list from innermost ancestor (last element)
387 * to outermost ancestor (first element), calling collect_filter_prefix_init
388 * on each node as long as we have not been able to extract any information
389 * yet and collect_filter_prefix_update afterwards.
390 * On successful return, data->initialized will be set since the outermost
391 * ancestor is a domain node, which always results in an initialization.
393 static int collect_filter_prefix(__isl_keep isl_schedule_tree_list *list,
394 struct isl_schedule_node_get_filter_prefix_data *data)
396 int i, n;
398 data->initialized = 0;
399 data->filter = NULL;
401 if (!list)
402 return -1;
404 n = isl_schedule_tree_list_n_schedule_tree(list);
405 for (i = n - 1; i >= 0; --i) {
406 isl_schedule_tree *tree;
407 int r;
409 tree = isl_schedule_tree_list_get_schedule_tree(list, i);
410 if (!tree)
411 return -1;
412 if (!data->initialized)
413 r = collect_filter_prefix_init(tree, data);
414 else
415 r = collect_filter_prefix_update(tree, data);
416 isl_schedule_tree_free(tree);
417 if (r < 0)
418 return -1;
421 return 0;
424 /* Return the concatenation of the partial schedules of all outer band
425 * nodes of "node" interesected with all outer filters
426 * as an isl_union_pw_multi_aff.
428 * If "node" is pointing at the root of the schedule tree, then
429 * there are no domain elements reaching the current node, so
430 * we return an empty result.
432 * We collect all the filters and partial schedules in collect_filter_prefix.
433 * The partial schedules are collected as an isl_multi_union_pw_aff.
434 * If this isl_multi_union_pw_aff is zero-dimensional, then it does not
435 * contain any domain information, so we construct the isl_union_pw_multi_aff
436 * result as a zero-dimensional function on the collected filter.
437 * Otherwise, we convert the isl_multi_union_pw_aff to
438 * an isl_multi_union_pw_aff and intersect the domain with the filter.
440 __isl_give isl_union_pw_multi_aff *
441 isl_schedule_node_get_prefix_schedule_union_pw_multi_aff(
442 __isl_keep isl_schedule_node *node)
444 isl_space *space;
445 isl_union_pw_multi_aff *prefix;
446 struct isl_schedule_node_get_filter_prefix_data data;
448 if (!node)
449 return NULL;
451 space = isl_schedule_get_space(node->schedule);
452 if (node->tree == node->schedule->root)
453 return isl_union_pw_multi_aff_empty(space);
455 space = isl_space_set_from_params(space);
456 data.universe_filter = 0;
457 data.collect_prefix = 1;
458 data.prefix = isl_multi_union_pw_aff_zero(space);
460 if (collect_filter_prefix(node->ancestors, &data) < 0)
461 data.prefix = isl_multi_union_pw_aff_free(data.prefix);
463 if (data.prefix &&
464 isl_multi_union_pw_aff_dim(data.prefix, isl_dim_set) == 0) {
465 isl_multi_union_pw_aff_free(data.prefix);
466 prefix = isl_union_pw_multi_aff_from_domain(data.filter);
467 } else {
468 prefix =
469 isl_union_pw_multi_aff_from_multi_union_pw_aff(data.prefix);
470 prefix = isl_union_pw_multi_aff_intersect_domain(prefix,
471 data.filter);
474 return prefix;
477 /* Return the concatenation of the partial schedules of all outer band
478 * nodes of "node" interesected with all outer filters
479 * as an isl_union_map.
481 __isl_give isl_union_map *isl_schedule_node_get_prefix_schedule_union_map(
482 __isl_keep isl_schedule_node *node)
484 isl_union_pw_multi_aff *upma;
486 upma = isl_schedule_node_get_prefix_schedule_union_pw_multi_aff(node);
487 return isl_union_map_from_union_pw_multi_aff(upma);
490 /* Return the union of universe sets of the domain elements that reach "node".
492 * If "node" is pointing at the root of the schedule tree, then
493 * there are no domain elements reaching the current node, so
494 * we return an empty result.
496 * Otherwise, we collect the universes of all filters reaching the node
497 * in collect_filter_prefix.
499 __isl_give isl_union_set *isl_schedule_node_get_universe_domain(
500 __isl_keep isl_schedule_node *node)
502 struct isl_schedule_node_get_filter_prefix_data data;
504 if (!node)
505 return NULL;
507 if (node->tree == node->schedule->root) {
508 isl_space *space;
510 space = isl_schedule_get_space(node->schedule);
511 return isl_union_set_empty(space);
514 data.universe_filter = 1;
515 data.collect_prefix = 0;
516 data.prefix = NULL;
518 if (collect_filter_prefix(node->ancestors, &data) < 0)
519 data.filter = isl_union_set_free(data.filter);
521 return data.filter;
524 /* Return the subtree schedule of "node".
526 * Since isl_schedule_tree_get_subtree_schedule_union_map does not handle
527 * trees that do not contain any schedule information, we first
528 * move down to the first relevant descendant and handle leaves ourselves.
530 __isl_give isl_union_map *isl_schedule_node_get_subtree_schedule_union_map(
531 __isl_keep isl_schedule_node *node)
533 isl_schedule_tree *tree, *leaf;
534 isl_union_map *umap;
536 tree = isl_schedule_node_get_tree(node);
537 leaf = isl_schedule_node_peek_leaf(node);
538 tree = isl_schedule_tree_first_schedule_descendant(tree, leaf);
539 if (!tree)
540 return NULL;
541 if (tree == leaf) {
542 isl_union_set *domain;
543 domain = isl_schedule_node_get_universe_domain(node);
544 isl_schedule_tree_free(tree);
545 return isl_union_map_from_domain(domain);
548 umap = isl_schedule_tree_get_subtree_schedule_union_map(tree);
549 isl_schedule_tree_free(tree);
550 return umap;
553 /* Return the number of ancestors of "node" in its schedule tree.
555 int isl_schedule_node_get_tree_depth(__isl_keep isl_schedule_node *node)
557 if (!node)
558 return -1;
559 return isl_schedule_tree_list_n_schedule_tree(node->ancestors);
562 /* Does "node" have a parent?
564 * That is, does it point to any node of the schedule other than the root?
566 int isl_schedule_node_has_parent(__isl_keep isl_schedule_node *node)
568 if (!node)
569 return -1;
570 if (!node->ancestors)
571 return -1;
573 return isl_schedule_tree_list_n_schedule_tree(node->ancestors) != 0;
576 /* Return the position of "node" among the children of its parent.
578 int isl_schedule_node_get_child_position(__isl_keep isl_schedule_node *node)
580 int n;
581 int has_parent;
583 if (!node)
584 return -1;
585 has_parent = isl_schedule_node_has_parent(node);
586 if (has_parent < 0)
587 return -1;
588 if (!has_parent)
589 isl_die(isl_schedule_node_get_ctx(node), isl_error_invalid,
590 "node has no parent", return -1);
592 n = isl_schedule_tree_list_n_schedule_tree(node->ancestors);
593 return node->child_pos[n - 1];
596 /* Does the parent (if any) of "node" have any children with a smaller child
597 * position than this one?
599 int isl_schedule_node_has_previous_sibling(__isl_keep isl_schedule_node *node)
601 int n;
602 int has_parent;
604 if (!node)
605 return -1;
606 has_parent = isl_schedule_node_has_parent(node);
607 if (has_parent < 0 || !has_parent)
608 return has_parent;
610 n = isl_schedule_tree_list_n_schedule_tree(node->ancestors);
612 return node->child_pos[n - 1] > 0;
615 /* Does the parent (if any) of "node" have any children with a greater child
616 * position than this one?
618 int isl_schedule_node_has_next_sibling(__isl_keep isl_schedule_node *node)
620 int n, n_child;
621 int has_parent;
622 isl_schedule_tree *tree;
624 if (!node)
625 return -1;
626 has_parent = isl_schedule_node_has_parent(node);
627 if (has_parent < 0 || !has_parent)
628 return has_parent;
630 n = isl_schedule_tree_list_n_schedule_tree(node->ancestors);
631 tree = isl_schedule_tree_list_get_schedule_tree(node->ancestors, n - 1);
632 if (!tree)
633 return -1;
634 n_child = isl_schedule_tree_list_n_schedule_tree(tree->children);
635 isl_schedule_tree_free(tree);
637 return node->child_pos[n - 1] + 1 < n_child;
640 /* Does "node" have any children?
642 * Any node other than the leaf nodes is considered to have at least
643 * one child, even if the corresponding isl_schedule_tree does not
644 * have any children.
646 int isl_schedule_node_has_children(__isl_keep isl_schedule_node *node)
648 if (!node)
649 return -1;
650 return !isl_schedule_tree_is_leaf(node->tree);
653 /* Return the number of children of "node"?
655 * Any node other than the leaf nodes is considered to have at least
656 * one child, even if the corresponding isl_schedule_tree does not
657 * have any children. That is, the number of children of "node" is
658 * only zero if its tree is the explicit empty tree. Otherwise,
659 * if the isl_schedule_tree has any children, then it is equal
660 * to the number of children of "node". If it has zero children,
661 * then "node" still has a leaf node as child.
663 int isl_schedule_node_n_children(__isl_keep isl_schedule_node *node)
665 int n;
667 if (!node)
668 return -1;
670 if (isl_schedule_tree_is_leaf(node->tree))
671 return 0;
673 n = isl_schedule_tree_n_children(node->tree);
674 if (n == 0)
675 return 1;
677 return n;
680 /* Move the "node" pointer to the ancestor of the given generation
681 * of the node it currently points to, where generation 0 is the node
682 * itself and generation 1 is its parent.
684 __isl_give isl_schedule_node *isl_schedule_node_ancestor(
685 __isl_take isl_schedule_node *node, int generation)
687 int n;
688 isl_schedule_tree *tree;
690 if (!node)
691 return NULL;
692 if (generation == 0)
693 return node;
694 n = isl_schedule_node_get_tree_depth(node);
695 if (n < 0)
696 return isl_schedule_node_free(node);
697 if (generation < 0 || generation > n)
698 isl_die(isl_schedule_node_get_ctx(node), isl_error_invalid,
699 "generation out of bounds",
700 return isl_schedule_node_free(node));
701 node = isl_schedule_node_cow(node);
702 if (!node)
703 return NULL;
705 tree = isl_schedule_tree_list_get_schedule_tree(node->ancestors,
706 n - generation);
707 isl_schedule_tree_free(node->tree);
708 node->tree = tree;
709 node->ancestors = isl_schedule_tree_list_drop(node->ancestors,
710 n - generation, generation);
711 if (!node->ancestors || !node->tree)
712 return isl_schedule_node_free(node);
714 return node;
717 /* Move the "node" pointer to the parent of the node it currently points to.
719 __isl_give isl_schedule_node *isl_schedule_node_parent(
720 __isl_take isl_schedule_node *node)
722 if (!node)
723 return NULL;
724 if (!isl_schedule_node_has_parent(node))
725 isl_die(isl_schedule_node_get_ctx(node), isl_error_invalid,
726 "node has no parent",
727 return isl_schedule_node_free(node));
728 return isl_schedule_node_ancestor(node, 1);
731 /* Move the "node" pointer to the child at position "pos" of the node
732 * it currently points to.
734 __isl_give isl_schedule_node *isl_schedule_node_child(
735 __isl_take isl_schedule_node *node, int pos)
737 int n;
738 isl_ctx *ctx;
739 isl_schedule_tree *tree;
740 int *child_pos;
742 node = isl_schedule_node_cow(node);
743 if (!node)
744 return NULL;
745 if (!isl_schedule_node_has_children(node))
746 isl_die(isl_schedule_node_get_ctx(node), isl_error_invalid,
747 "node has no children",
748 return isl_schedule_node_free(node));
750 ctx = isl_schedule_node_get_ctx(node);
751 n = isl_schedule_tree_list_n_schedule_tree(node->ancestors);
752 child_pos = isl_realloc_array(ctx, node->child_pos, int, n + 1);
753 if (!child_pos)
754 return isl_schedule_node_free(node);
755 node->child_pos = child_pos;
756 node->child_pos[n] = pos;
758 node->ancestors = isl_schedule_tree_list_add(node->ancestors,
759 isl_schedule_tree_copy(node->tree));
760 tree = node->tree;
761 if (isl_schedule_tree_has_children(tree))
762 tree = isl_schedule_tree_get_child(tree, pos);
763 else
764 tree = isl_schedule_node_get_leaf(node);
765 isl_schedule_tree_free(node->tree);
766 node->tree = tree;
768 if (!node->tree || !node->ancestors)
769 return isl_schedule_node_free(node);
771 return node;
774 /* Move the "node" pointer to the first child of the node
775 * it currently points to.
777 __isl_give isl_schedule_node *isl_schedule_node_first_child(
778 __isl_take isl_schedule_node *node)
780 return isl_schedule_node_child(node, 0);
783 /* Move the "node" pointer to the child of this node's parent in
784 * the previous child position.
786 __isl_give isl_schedule_node *isl_schedule_node_previous_sibling(
787 __isl_take isl_schedule_node *node)
789 int n;
790 isl_schedule_tree *parent, *tree;
792 node = isl_schedule_node_cow(node);
793 if (!node)
794 return NULL;
795 if (!isl_schedule_node_has_previous_sibling(node))
796 isl_die(isl_schedule_node_get_ctx(node), isl_error_invalid,
797 "node has no previous sibling",
798 return isl_schedule_node_free(node));
800 n = isl_schedule_tree_list_n_schedule_tree(node->ancestors);
801 parent = isl_schedule_tree_list_get_schedule_tree(node->ancestors,
802 n - 1);
803 if (!parent)
804 return isl_schedule_node_free(node);
805 node->child_pos[n - 1]--;
806 tree = isl_schedule_tree_list_get_schedule_tree(parent->children,
807 node->child_pos[n - 1]);
808 isl_schedule_tree_free(parent);
809 if (!tree)
810 return isl_schedule_node_free(node);
811 isl_schedule_tree_free(node->tree);
812 node->tree = tree;
814 return node;
817 /* Move the "node" pointer to the child of this node's parent in
818 * the next child position.
820 __isl_give isl_schedule_node *isl_schedule_node_next_sibling(
821 __isl_take isl_schedule_node *node)
823 int n;
824 isl_schedule_tree *parent, *tree;
826 node = isl_schedule_node_cow(node);
827 if (!node)
828 return NULL;
829 if (!isl_schedule_node_has_next_sibling(node))
830 isl_die(isl_schedule_node_get_ctx(node), isl_error_invalid,
831 "node has no next sibling",
832 return isl_schedule_node_free(node));
834 n = isl_schedule_tree_list_n_schedule_tree(node->ancestors);
835 parent = isl_schedule_tree_list_get_schedule_tree(node->ancestors,
836 n - 1);
837 if (!parent)
838 return isl_schedule_node_free(node);
839 node->child_pos[n - 1]++;
840 tree = isl_schedule_tree_list_get_schedule_tree(parent->children,
841 node->child_pos[n - 1]);
842 isl_schedule_tree_free(parent);
843 if (!tree)
844 return isl_schedule_node_free(node);
845 isl_schedule_tree_free(node->tree);
846 node->tree = tree;
848 return node;
851 /* Return a copy to the child at position "pos" of "node".
853 __isl_give isl_schedule_node *isl_schedule_node_get_child(
854 __isl_keep isl_schedule_node *node, int pos)
856 return isl_schedule_node_child(isl_schedule_node_copy(node), pos);
859 /* Traverse the descendant of "node" in depth-first order, including
860 * "node" itself. Call "enter" whenever a node is entered and "leave"
861 * whenever a node is left. The callback "enter" is responsible
862 * for moving to the deepest initial subtree of its argument that
863 * should be traversed.
865 static __isl_give isl_schedule_node *traverse(
866 __isl_take isl_schedule_node *node,
867 __isl_give isl_schedule_node *(*enter)(
868 __isl_take isl_schedule_node *node, void *user),
869 __isl_give isl_schedule_node *(*leave)(
870 __isl_take isl_schedule_node *node, void *user),
871 void *user)
873 int depth;
875 if (!node)
876 return NULL;
878 depth = isl_schedule_node_get_tree_depth(node);
879 do {
880 node = enter(node, user);
881 node = leave(node, user);
882 while (node && isl_schedule_node_get_tree_depth(node) > depth &&
883 !isl_schedule_node_has_next_sibling(node)) {
884 node = isl_schedule_node_parent(node);
885 node = leave(node, user);
887 if (node && isl_schedule_node_get_tree_depth(node) > depth)
888 node = isl_schedule_node_next_sibling(node);
889 } while (node && isl_schedule_node_get_tree_depth(node) > depth);
891 return node;
894 /* Internal data structure for isl_schedule_node_foreach_descendant.
896 * "fn" is the user-specified callback function.
897 * "user" is the user-specified argument for the callback.
899 struct isl_schedule_node_preorder_data {
900 int (*fn)(__isl_keep isl_schedule_node *node, void *user);
901 void *user;
904 /* Callback for "traverse" to enter a node and to move
905 * to the deepest initial subtree that should be traversed
906 * for use in a preorder visit.
908 * If the user callback returns a negative value, then we abort
909 * the traversal. If this callback returns zero, then we skip
910 * the subtree rooted at the current node. Otherwise, we move
911 * down to the first child and repeat the process until a leaf
912 * is reached.
914 static __isl_give isl_schedule_node *preorder_enter(
915 __isl_take isl_schedule_node *node, void *user)
917 struct isl_schedule_node_preorder_data *data = user;
919 if (!node)
920 return NULL;
922 do {
923 int r;
925 r = data->fn(node, data->user);
926 if (r < 0)
927 return isl_schedule_node_free(node);
928 if (r == 0)
929 return node;
930 } while (isl_schedule_node_has_children(node) &&
931 (node = isl_schedule_node_first_child(node)) != NULL);
933 return node;
936 /* Callback for "traverse" to leave a node
937 * for use in a preorder visit.
938 * Since we already visited the node when we entered it,
939 * we do not need to do anything here.
941 static __isl_give isl_schedule_node *preorder_leave(
942 __isl_take isl_schedule_node *node, void *user)
944 return node;
947 /* Traverse the descendants of "node" (including the node itself)
948 * in depth first preorder.
950 * If "fn" returns -1 on any of the nodes, then the traversal is aborted.
951 * If "fn" returns 0 on any of the nodes, then the subtree rooted
952 * at that node is skipped.
954 * Return 0 on success and -1 on failure.
956 int isl_schedule_node_foreach_descendant(__isl_keep isl_schedule_node *node,
957 int (*fn)(__isl_keep isl_schedule_node *node, void *user), void *user)
959 struct isl_schedule_node_preorder_data data = { fn, user };
961 node = isl_schedule_node_copy(node);
962 node = traverse(node, &preorder_enter, &preorder_leave, &data);
963 isl_schedule_node_free(node);
965 return node ? 0 : -1;
968 /* Internal data structure for isl_schedule_node_map_descendant.
970 * "fn" is the user-specified callback function.
971 * "user" is the user-specified argument for the callback.
973 struct isl_schedule_node_postorder_data {
974 __isl_give isl_schedule_node *(*fn)(__isl_take isl_schedule_node *node,
975 void *user);
976 void *user;
979 /* Callback for "traverse" to enter a node and to move
980 * to the deepest initial subtree that should be traversed
981 * for use in a postorder visit.
983 * Since we are performing a postorder visit, we only need
984 * to move to the deepest initial leaf here.
986 static __isl_give isl_schedule_node *postorder_enter(
987 __isl_take isl_schedule_node *node, void *user)
989 while (node && isl_schedule_node_has_children(node))
990 node = isl_schedule_node_first_child(node);
992 return node;
995 /* Callback for "traverse" to leave a node
996 * for use in a postorder visit.
998 * Since we are performing a postorder visit, we need
999 * to call the user callback here.
1001 static __isl_give isl_schedule_node *postorder_leave(
1002 __isl_take isl_schedule_node *node, void *user)
1004 struct isl_schedule_node_postorder_data *data = user;
1006 return data->fn(node, data->user);
1009 /* Traverse the descendants of "node" (including the node itself)
1010 * in depth first postorder, allowing the user to modify the visited node.
1011 * The traversal continues from the node returned by the callback function.
1012 * It is the responsibility of the user to ensure that this does not
1013 * lead to an infinite loop. It is safest to always return a pointer
1014 * to the same position (same ancestors and child positions) as the input node.
1016 __isl_give isl_schedule_node *isl_schedule_node_map_descendant(
1017 __isl_take isl_schedule_node *node,
1018 __isl_give isl_schedule_node *(*fn)(__isl_take isl_schedule_node *node,
1019 void *user), void *user)
1021 struct isl_schedule_node_postorder_data data = { fn, user };
1023 return traverse(node, &postorder_enter, &postorder_leave, &data);
1026 /* Return the number of members in the given band node.
1028 unsigned isl_schedule_node_band_n_member(__isl_keep isl_schedule_node *node)
1030 return node ? isl_schedule_tree_band_n_member(node->tree) : 0;
1033 /* Is the band member at position "pos" of the band node "node"
1034 * marked coincident?
1036 int isl_schedule_node_band_member_get_coincident(
1037 __isl_keep isl_schedule_node *node, int pos)
1039 if (!node)
1040 return -1;
1041 return isl_schedule_tree_band_member_get_coincident(node->tree, pos);
1044 /* Mark the band member at position "pos" the band node "node"
1045 * as being coincident or not according to "coincident".
1047 __isl_give isl_schedule_node *isl_schedule_node_band_member_set_coincident(
1048 __isl_take isl_schedule_node *node, int pos, int coincident)
1050 int c;
1051 isl_schedule_tree *tree;
1053 if (!node)
1054 return NULL;
1055 c = isl_schedule_node_band_member_get_coincident(node, pos);
1056 if (c == coincident)
1057 return node;
1059 tree = isl_schedule_tree_copy(node->tree);
1060 tree = isl_schedule_tree_band_member_set_coincident(tree, pos,
1061 coincident);
1062 node = isl_schedule_node_graft_tree(node, tree);
1064 return node;
1067 /* Is the band node "node" marked permutable?
1069 int isl_schedule_node_band_get_permutable(__isl_keep isl_schedule_node *node)
1071 if (!node)
1072 return -1;
1074 return isl_schedule_tree_band_get_permutable(node->tree);
1077 /* Mark the band node "node" permutable or not according to "permutable"?
1079 __isl_give isl_schedule_node *isl_schedule_node_band_set_permutable(
1080 __isl_take isl_schedule_node *node, int permutable)
1082 isl_schedule_tree *tree;
1084 if (!node)
1085 return NULL;
1086 if (isl_schedule_node_band_get_permutable(node) == permutable)
1087 return node;
1089 tree = isl_schedule_tree_copy(node->tree);
1090 tree = isl_schedule_tree_band_set_permutable(tree, permutable);
1091 node = isl_schedule_node_graft_tree(node, tree);
1093 return node;
1096 /* Return the schedule space of the band node.
1098 __isl_give isl_space *isl_schedule_node_band_get_space(
1099 __isl_keep isl_schedule_node *node)
1101 if (!node)
1102 return NULL;
1104 return isl_schedule_tree_band_get_space(node->tree);
1107 /* Return the schedule of the band node in isolation.
1109 __isl_give isl_multi_union_pw_aff *isl_schedule_node_band_get_partial_schedule(
1110 __isl_keep isl_schedule_node *node)
1112 if (!node)
1113 return NULL;
1115 return isl_schedule_tree_band_get_partial_schedule(node->tree);
1118 /* Return the schedule of the band node in isolation in the form of
1119 * an isl_union_map.
1121 * If the band does not have any members, then we construct a universe map
1122 * with the universe of the domain elements reaching the node as domain.
1123 * Otherwise, we extract an isl_multi_union_pw_aff representation and
1124 * convert that to an isl_union_map.
1126 __isl_give isl_union_map *isl_schedule_node_band_get_partial_schedule_union_map(
1127 __isl_keep isl_schedule_node *node)
1129 isl_multi_union_pw_aff *mupa;
1131 if (!node)
1132 return NULL;
1134 if (isl_schedule_node_get_type(node) != isl_schedule_node_band)
1135 isl_die(isl_schedule_node_get_ctx(node), isl_error_invalid,
1136 "not a band node", return NULL);
1137 if (isl_schedule_node_band_n_member(node) == 0) {
1138 isl_union_set *domain;
1140 domain = isl_schedule_node_get_universe_domain(node);
1141 return isl_union_map_from_domain(domain);
1144 mupa = isl_schedule_node_band_get_partial_schedule(node);
1145 return isl_union_map_from_multi_union_pw_aff(mupa);
1148 /* Make sure that that spaces of "node" and "mv" are the same.
1149 * Return -1 on error, reporting the error to the user.
1151 static int check_space_multi_val(__isl_keep isl_schedule_node *node,
1152 __isl_keep isl_multi_val *mv)
1154 isl_space *node_space, *mv_space;
1155 int equal;
1157 node_space = isl_schedule_node_band_get_space(node);
1158 mv_space = isl_multi_val_get_space(mv);
1159 equal = isl_space_tuple_is_equal(node_space, isl_dim_set,
1160 mv_space, isl_dim_set);
1161 isl_space_free(mv_space);
1162 isl_space_free(node_space);
1163 if (equal < 0)
1164 return -1;
1165 if (!equal)
1166 isl_die(isl_schedule_node_get_ctx(node), isl_error_invalid,
1167 "spaces don't match", return -1);
1169 return 0;
1172 /* Multiply the partial schedule of the band node "node"
1173 * with the factors in "mv".
1175 __isl_give isl_schedule_node *isl_schedule_node_band_scale(
1176 __isl_take isl_schedule_node *node, __isl_take isl_multi_val *mv)
1178 isl_schedule_tree *tree;
1180 if (!node || !mv)
1181 goto error;
1182 if (check_space_multi_val(node, mv) < 0)
1183 goto error;
1185 tree = isl_schedule_node_get_tree(node);
1186 tree = isl_schedule_tree_band_scale(tree, mv);
1187 return isl_schedule_node_graft_tree(node, tree);
1188 error:
1189 isl_multi_val_free(mv);
1190 isl_schedule_node_free(node);
1191 return NULL;
1194 /* Divide the partial schedule of the band node "node"
1195 * by the factors in "mv".
1197 __isl_give isl_schedule_node *isl_schedule_node_band_scale_down(
1198 __isl_take isl_schedule_node *node, __isl_take isl_multi_val *mv)
1200 isl_schedule_tree *tree;
1202 if (!node || !mv)
1203 goto error;
1204 if (check_space_multi_val(node, mv) < 0)
1205 goto error;
1207 tree = isl_schedule_node_get_tree(node);
1208 tree = isl_schedule_tree_band_scale_down(tree, mv);
1209 return isl_schedule_node_graft_tree(node, tree);
1210 error:
1211 isl_multi_val_free(mv);
1212 isl_schedule_node_free(node);
1213 return NULL;
1216 /* Tile "node" with tile sizes "sizes".
1218 * The current node is replaced by two nested nodes corresponding
1219 * to the tile dimensions and the point dimensions.
1221 * Return a pointer to the outer (tile) node.
1223 * If the scale tile loops option is set, then the tile loops
1224 * are scaled by the tile sizes. If the shift point loops option is set,
1225 * then the point loops are shifted to start at zero.
1226 * In particular, these options affect the tile and point loop schedules
1227 * as follows
1229 * scale shift original tile point
1231 * 0 0 i floor(i/s) i
1232 * 1 0 i s * floor(i/s) i
1233 * 0 1 i floor(i/s) i - s * floor(i/s)
1234 * 1 1 i s * floor(i/s) i - s * floor(i/s)
1236 __isl_give isl_schedule_node *isl_schedule_node_band_tile(
1237 __isl_take isl_schedule_node *node, __isl_take isl_multi_val *sizes)
1239 isl_schedule_tree *tree;
1241 if (!node || !sizes)
1242 goto error;
1244 if (check_space_multi_val(node, sizes) < 0)
1245 goto error;
1247 tree = isl_schedule_node_get_tree(node);
1248 tree = isl_schedule_tree_band_tile(tree, sizes);
1249 return isl_schedule_node_graft_tree(node, tree);
1250 error:
1251 isl_multi_val_free(sizes);
1252 isl_schedule_node_free(node);
1253 return NULL;
1256 /* Move the band node "node" down to all the leaves in the subtree
1257 * rooted at "node".
1258 * Return a pointer to the node in the resulting tree that is in the same
1259 * position as the node pointed to by "node" in the original tree.
1261 * If the node only has a leaf child, then nothing needs to be done.
1262 * Otherwise, the child of the node is removed and the result is
1263 * appended to all the leaves in the subtree rooted at the original child.
1264 * The original node is then replaced by the result of this operation.
1266 __isl_give isl_schedule_node *isl_schedule_node_band_sink(
1267 __isl_take isl_schedule_node *node)
1269 enum isl_schedule_node_type type;
1270 isl_schedule_tree *tree, *child;
1272 if (!node)
1273 return NULL;
1275 type = isl_schedule_node_get_type(node);
1276 if (type != isl_schedule_node_band)
1277 isl_die(isl_schedule_node_get_ctx(node), isl_error_invalid,
1278 "not a band node", isl_schedule_node_free(node));
1279 if (isl_schedule_tree_n_children(node->tree) == 0)
1280 return node;
1282 tree = isl_schedule_node_get_tree(node);
1283 child = isl_schedule_tree_get_child(tree, 0);
1284 tree = isl_schedule_tree_reset_children(tree);
1285 tree = isl_schedule_tree_append_to_leaves(child, tree);
1287 return isl_schedule_node_graft_tree(node, tree);
1290 /* Split "node" into two nested band nodes, one with the first "pos"
1291 * dimensions and one with the remaining dimensions.
1292 * The schedules of the two band nodes live in anonymous spaces.
1294 __isl_give isl_schedule_node *isl_schedule_node_band_split(
1295 __isl_take isl_schedule_node *node, int pos)
1297 isl_schedule_tree *tree;
1299 tree = isl_schedule_node_get_tree(node);
1300 tree = isl_schedule_tree_band_split(tree, pos);
1301 return isl_schedule_node_graft_tree(node, tree);
1304 /* Return the domain of the domain node "node".
1306 __isl_give isl_union_set *isl_schedule_node_domain_get_domain(
1307 __isl_keep isl_schedule_node *node)
1309 if (!node)
1310 return NULL;
1312 return isl_schedule_tree_domain_get_domain(node->tree);
1315 /* Return the filter of the filter node "node".
1317 __isl_give isl_union_set *isl_schedule_node_filter_get_filter(
1318 __isl_keep isl_schedule_node *node)
1320 if (!node)
1321 return NULL;
1323 return isl_schedule_tree_filter_get_filter(node->tree);
1326 /* Replace the filter of filter node "node" by "filter".
1328 __isl_give isl_schedule_node *isl_schedule_node_filter_set_filter(
1329 __isl_take isl_schedule_node *node, __isl_take isl_union_set *filter)
1331 isl_schedule_tree *tree;
1333 if (!node || !filter)
1334 goto error;
1336 tree = isl_schedule_tree_copy(node->tree);
1337 tree = isl_schedule_tree_filter_set_filter(tree, filter);
1338 return isl_schedule_node_graft_tree(node, tree);
1339 error:
1340 isl_schedule_node_free(node);
1341 isl_union_set_free(filter);
1342 return NULL;
1345 /* Update the ancestors of "node" to point to the tree that "node"
1346 * now points to.
1347 * That is, replace the child in the original parent that corresponds
1348 * to the current tree position by node->tree and continue updating
1349 * the ancestors in the same way until the root is reached.
1351 * If "node" originally points to a leaf of the schedule tree, then make sure
1352 * that in the end it points to a leaf in the updated schedule tree.
1354 static __isl_give isl_schedule_node *update_ancestors(
1355 __isl_take isl_schedule_node *node)
1357 int i, n;
1358 int is_leaf;
1359 isl_ctx *ctx;
1360 isl_schedule_tree *tree;
1362 node = isl_schedule_node_cow(node);
1363 if (!node)
1364 return NULL;
1366 ctx = isl_schedule_node_get_ctx(node);
1367 n = isl_schedule_tree_list_n_schedule_tree(node->ancestors);
1368 tree = isl_schedule_tree_copy(node->tree);
1370 for (i = n - 1; i >= 0; --i) {
1371 isl_schedule_tree *parent;
1373 parent = isl_schedule_tree_list_get_schedule_tree(
1374 node->ancestors, i);
1375 parent = isl_schedule_tree_replace_child(parent,
1376 node->child_pos[i], tree);
1377 node->ancestors = isl_schedule_tree_list_set_schedule_tree(
1378 node->ancestors, i, isl_schedule_tree_copy(parent));
1380 tree = parent;
1383 is_leaf = isl_schedule_tree_is_leaf(node->tree);
1384 node->schedule = isl_schedule_set_root(node->schedule, tree);
1385 if (is_leaf) {
1386 isl_schedule_tree_free(node->tree);
1387 node->tree = isl_schedule_node_get_leaf(node);
1390 if (!node->schedule || !node->ancestors)
1391 return isl_schedule_node_free(node);
1393 return node;
1396 /* Replace the subtree that "pos" points to by "tree", updating
1397 * the ancestors to maintain a consistent state.
1399 __isl_give isl_schedule_node *isl_schedule_node_graft_tree(
1400 __isl_take isl_schedule_node *pos, __isl_take isl_schedule_tree *tree)
1402 if (!tree || !pos)
1403 goto error;
1404 if (pos->tree == tree) {
1405 isl_schedule_tree_free(tree);
1406 return pos;
1409 pos = isl_schedule_node_cow(pos);
1410 if (!pos)
1411 goto error;
1413 isl_schedule_tree_free(pos->tree);
1414 pos->tree = tree;
1416 return update_ancestors(pos);
1417 error:
1418 isl_schedule_node_free(pos);
1419 isl_schedule_tree_free(tree);
1420 return NULL;
1423 /* Make sure we can insert a node between "node" and its parent.
1424 * Return -1 on error, reporting the reason why we cannot insert a node.
1426 static int check_insert(__isl_keep isl_schedule_node *node)
1428 int has_parent;
1429 enum isl_schedule_node_type type;
1431 has_parent = isl_schedule_node_has_parent(node);
1432 if (has_parent < 0)
1433 return -1;
1434 if (!has_parent)
1435 isl_die(isl_schedule_node_get_ctx(node), isl_error_invalid,
1436 "cannot insert node outside of root", return -1);
1438 type = isl_schedule_node_get_parent_type(node);
1439 if (type == isl_schedule_node_error)
1440 return -1;
1441 if (type == isl_schedule_node_set || type == isl_schedule_node_sequence)
1442 isl_die(isl_schedule_node_get_ctx(node), isl_error_invalid,
1443 "cannot insert node between set or sequence node "
1444 "and its filter children", return -1);
1446 return 0;
1449 /* Insert a band node with partial schedule "mupa" between "node" and
1450 * its parent.
1451 * Return a pointer to the new band node.
1453 __isl_give isl_schedule_node *isl_schedule_node_insert_partial_schedule(
1454 __isl_take isl_schedule_node *node,
1455 __isl_take isl_multi_union_pw_aff *mupa)
1457 isl_schedule_band *band;
1458 isl_schedule_tree *tree;
1460 if (check_insert(node) < 0)
1461 node = isl_schedule_node_free(node);
1463 tree = isl_schedule_node_get_tree(node);
1464 band = isl_schedule_band_from_multi_union_pw_aff(mupa);
1465 tree = isl_schedule_tree_insert_band(tree, band);
1466 node = isl_schedule_node_graft_tree(node, tree);
1468 return node;
1471 /* Insert a filter node with filter "filter" between "node" and its parent.
1472 * Return a pointer to the new filter node.
1474 __isl_give isl_schedule_node *isl_schedule_node_insert_filter(
1475 __isl_take isl_schedule_node *node, __isl_take isl_union_set *filter)
1477 isl_schedule_tree *tree;
1479 if (check_insert(node) < 0)
1480 node = isl_schedule_node_free(node);
1482 tree = isl_schedule_node_get_tree(node);
1483 tree = isl_schedule_tree_insert_filter(tree, filter);
1484 node = isl_schedule_node_graft_tree(node, tree);
1486 return node;
1489 /* Attach the current subtree of "node" to a sequence of filter tree nodes
1490 * with filters described by "filters", attach this sequence
1491 * of filter tree nodes as children to a new tree of type "type" and
1492 * replace the original subtree of "node" by this new tree.
1494 static __isl_give isl_schedule_node *isl_schedule_node_insert_children(
1495 __isl_take isl_schedule_node *node,
1496 enum isl_schedule_node_type type,
1497 __isl_take isl_union_set_list *filters)
1499 int i, n;
1500 isl_ctx *ctx;
1501 isl_schedule_tree *tree;
1502 isl_schedule_tree_list *list;
1504 if (check_insert(node) < 0)
1505 node = isl_schedule_node_free(node);
1507 if (!node || !filters)
1508 goto error;
1510 ctx = isl_schedule_node_get_ctx(node);
1511 n = isl_union_set_list_n_union_set(filters);
1512 list = isl_schedule_tree_list_alloc(ctx, n);
1513 for (i = 0; i < n; ++i) {
1514 isl_schedule_tree *tree;
1515 isl_union_set *filter;
1517 tree = isl_schedule_node_get_tree(node);
1518 filter = isl_union_set_list_get_union_set(filters, i);
1519 tree = isl_schedule_tree_insert_filter(tree, filter);
1520 list = isl_schedule_tree_list_add(list, tree);
1522 tree = isl_schedule_tree_from_children(type, list);
1523 node = isl_schedule_node_graft_tree(node, tree);
1525 isl_union_set_list_free(filters);
1526 return node;
1527 error:
1528 isl_union_set_list_free(filters);
1529 isl_schedule_node_free(node);
1530 return NULL;
1533 /* Insert a sequence node with child filters "filters" between "node" and
1534 * its parent. That is, the tree that "node" points to is attached
1535 * to each of the child nodes of the filter nodes.
1536 * Return a pointer to the new sequence node.
1538 __isl_give isl_schedule_node *isl_schedule_node_insert_sequence(
1539 __isl_take isl_schedule_node *node,
1540 __isl_take isl_union_set_list *filters)
1542 return isl_schedule_node_insert_children(node,
1543 isl_schedule_node_sequence, filters);
1546 /* Insert a set node with child filters "filters" between "node" and
1547 * its parent. That is, the tree that "node" points to is attached
1548 * to each of the child nodes of the filter nodes.
1549 * Return a pointer to the new set node.
1551 __isl_give isl_schedule_node *isl_schedule_node_insert_set(
1552 __isl_take isl_schedule_node *node,
1553 __isl_take isl_union_set_list *filters)
1555 return isl_schedule_node_insert_children(node,
1556 isl_schedule_node_set, filters);
1559 /* Reset the user pointer on all identifiers of parameters and tuples
1560 * in the schedule node "node".
1562 __isl_give isl_schedule_node *isl_schedule_node_reset_user(
1563 __isl_take isl_schedule_node *node)
1565 isl_schedule_tree *tree;
1567 tree = isl_schedule_node_get_tree(node);
1568 tree = isl_schedule_tree_reset_user(tree);
1569 node = isl_schedule_node_graft_tree(node, tree);
1571 return node;
1574 /* Align the parameters of the schedule node "node" to those of "space".
1576 __isl_give isl_schedule_node *isl_schedule_node_align_params(
1577 __isl_take isl_schedule_node *node, __isl_take isl_space *space)
1579 isl_schedule_tree *tree;
1581 tree = isl_schedule_node_get_tree(node);
1582 tree = isl_schedule_tree_align_params(tree, space);
1583 node = isl_schedule_node_graft_tree(node, tree);
1585 return node;
1588 /* Print "node" to "p".
1590 __isl_give isl_printer *isl_printer_print_schedule_node(
1591 __isl_take isl_printer *p, __isl_keep isl_schedule_node *node)
1593 if (!node)
1594 return isl_printer_free(p);
1595 return isl_printer_print_schedule_tree_mark(p, node->schedule->root,
1596 isl_schedule_tree_list_n_schedule_tree(node->ancestors),
1597 node->child_pos);
1600 void isl_schedule_node_dump(__isl_keep isl_schedule_node *node)
1602 isl_ctx *ctx;
1603 isl_printer *printer;
1605 if (!node)
1606 return;
1608 ctx = isl_schedule_node_get_ctx(node);
1609 printer = isl_printer_to_file(ctx, stderr);
1610 printer = isl_printer_set_yaml_style(printer, ISL_YAML_STYLE_BLOCK);
1611 printer = isl_printer_print_schedule_node(printer, node);
1613 isl_printer_free(printer);