isl_schedule_tree.h

   1 #ifndef ISL_SCHEDLUE_TREE_H
   2 #define ISL_SCHEDLUE_TREE_H
   3
   4 #include <isl_schedule_band.h>
   5 #include <isl/schedule.h>
   6 #include <isl/set.h>
   7 #include <isl/union_set.h>
   8
   9 struct isl_schedule_tree;
  10 typedef struct isl_schedule_tree isl_schedule_tree;
  11
  12 ISL_DECLARE_LIST(schedule_tree)
  13
  14 /* A schedule (sub)tree.
  15  *
  16  * The leaves of a tree are not explicitly represented inside
  17  * the isl_schedule_tree.  If a tree consists of only a leaf,
  18  * then it is equal to the static object isl_schedule_tree_empty.
  19  *
  20  * ctx may be NULL if type is isl_schedule_node_leaf.
  21  * In this case, ref has a negative value.
  22  *
  23  * The "band" field is valid when type is isl_schedule_node_band.
  24  * The "domain" field is valid when type is isl_schedule_node_domain
  25  * and introduces the statement instances scheduled by the tree.
  26  * The "filter" field is valid when type is isl_schedule_node_filter
  27  * and represents the statement instances selected by the node.
  28  *
  29  * The "children" field is valid for all types except
  30  * isl_schedule_node_leaf.  This field is NULL if there are
  31  * no children (except for the implicit leaves).
  32  *
  33  * anchored is set if the node or any of its descendants depends
  34  * on its position in the schedule tree.
  35  */
  36 struct isl_schedule_tree {
  37         int ref;
  38         isl_ctx *ctx;
  39         int anchored;
  40         enum isl_schedule_node_type type;
  41         union {
  42                 isl_schedule_band *band;
  43                 isl_union_set *domain;
  44                 isl_union_set *filter;
  45         };
  46         isl_schedule_tree_list *children;
  47 };
  48
  49 isl_ctx *isl_schedule_tree_get_ctx(__isl_keep isl_schedule_tree *tree);
  50 enum isl_schedule_node_type isl_schedule_tree_get_type(
  51         __isl_keep isl_schedule_tree *tree);
  52
  53 __isl_give isl_schedule_tree *isl_schedule_tree_leaf(isl_ctx *ctx);
  54 int isl_schedule_tree_is_leaf(__isl_keep isl_schedule_tree *tree);
  55
  56 int isl_schedule_tree_plain_is_equal(__isl_keep isl_schedule_tree *tree1,
  57         __isl_keep isl_schedule_tree *tree2);
  58
  59 __isl_give isl_schedule_tree *isl_schedule_tree_copy(
  60         __isl_keep isl_schedule_tree *tree);
  61 __isl_null isl_schedule_tree *isl_schedule_tree_free(
  62         __isl_take isl_schedule_tree *tree);
  63
  64 __isl_give isl_schedule_tree *isl_schedule_tree_from_band(
  65         __isl_take isl_schedule_band *band);
  66 __isl_give isl_schedule_tree *isl_schedule_tree_from_domain(
  67         __isl_take isl_union_set *domain);
  68 __isl_give isl_schedule_tree *isl_schedule_tree_from_filter(
  69         __isl_take isl_union_set *filter);
  70 __isl_give isl_schedule_tree *isl_schedule_tree_from_children(
  71         enum isl_schedule_node_type type,
  72         __isl_take isl_schedule_tree_list *list);
  73 __isl_give isl_schedule_tree *isl_schedule_tree_from_pair(
  74         enum isl_schedule_node_type type, __isl_take isl_schedule_tree *tree1,
  75         __isl_take isl_schedule_tree *tree2);
  76
  77 int isl_schedule_tree_is_subtree_anchored(__isl_keep isl_schedule_tree *tree);
  78
  79 __isl_give isl_space *isl_schedule_tree_band_get_space(
  80         __isl_keep isl_schedule_tree *tree);
  81 __isl_give isl_multi_union_pw_aff *isl_schedule_tree_band_get_partial_schedule(
  82         __isl_keep isl_schedule_tree *tree);
  83 enum isl_ast_loop_type isl_schedule_tree_band_member_get_ast_loop_type(
  84         __isl_keep isl_schedule_tree *tree, int pos);
  85 __isl_give isl_schedule_tree *isl_schedule_tree_band_member_set_ast_loop_type(
  86         __isl_take isl_schedule_tree *tree, int pos,
  87         enum isl_ast_loop_type type);
  88 enum isl_ast_loop_type isl_schedule_tree_band_member_get_isolate_ast_loop_type(
  89         __isl_keep isl_schedule_tree *tree, int pos);
  90 __isl_give isl_schedule_tree *
  91 isl_schedule_tree_band_member_set_isolate_ast_loop_type(
  92         __isl_take isl_schedule_tree *tree, int pos,
  93         enum isl_ast_loop_type type);
  94 __isl_give isl_union_set *isl_schedule_tree_band_get_ast_build_options(
  95         __isl_keep isl_schedule_tree *tree);
  96 __isl_give isl_schedule_tree *isl_schedule_tree_band_set_ast_build_options(
  97         __isl_take isl_schedule_tree *tree, __isl_take isl_union_set *options);
  98 __isl_give isl_union_set *isl_schedule_tree_domain_get_domain(
  99         __isl_keep isl_schedule_tree *tree);
 100 __isl_give isl_schedule_tree *isl_schedule_tree_domain_set_domain(
 101         __isl_take isl_schedule_tree *tree, __isl_take isl_union_set *domain);
 102 __isl_give isl_union_set *isl_schedule_tree_filter_get_filter(
 103         __isl_keep isl_schedule_tree *tree);
 104 __isl_give isl_schedule_tree *isl_schedule_tree_filter_set_filter(
 105         __isl_take isl_schedule_tree *tree, __isl_take isl_union_set *filter);
 106
 107 __isl_give isl_schedule_tree *isl_schedule_tree_first_schedule_descendant(
 108         __isl_take isl_schedule_tree *tree, __isl_keep isl_schedule_tree *leaf);
 109 __isl_give isl_union_map *isl_schedule_tree_get_subtree_schedule_union_map(
 110         __isl_keep isl_schedule_tree *tree);
 111
 112 unsigned isl_schedule_tree_band_n_member(__isl_keep isl_schedule_tree *tree);
 113
 114 int isl_schedule_tree_band_member_get_coincident(
 115         __isl_keep isl_schedule_tree *tree, int pos);
 116 __isl_give isl_schedule_tree *isl_schedule_tree_band_member_set_coincident(
 117         __isl_take isl_schedule_tree *tree, int pos, int coincident);
 118 int isl_schedule_tree_band_get_permutable(__isl_keep isl_schedule_tree *tree);
 119 __isl_give isl_schedule_tree *isl_schedule_tree_band_set_permutable(
 120         __isl_take isl_schedule_tree *tree, int permutable);
 121
 122 int isl_schedule_tree_has_children(__isl_keep isl_schedule_tree *tree);
 123 int isl_schedule_tree_n_children(__isl_keep isl_schedule_tree *tree);
 124 __isl_give isl_schedule_tree *isl_schedule_tree_get_child(
 125         __isl_keep isl_schedule_tree *tree, int pos);
 126
 127 __isl_give isl_schedule_tree *isl_schedule_tree_insert_band(
 128         __isl_take isl_schedule_tree *tree, __isl_take isl_schedule_band *band);
 129 __isl_give isl_schedule_tree *isl_schedule_tree_insert_domain(
 130         __isl_take isl_schedule_tree *tree, __isl_take isl_union_set *domain);
 131 __isl_give isl_schedule_tree *isl_schedule_tree_insert_filter(
 132         __isl_take isl_schedule_tree *tree, __isl_take isl_union_set *filter);
 133 __isl_give isl_schedule_tree *isl_schedule_tree_children_insert_filter(
 134         __isl_take isl_schedule_tree *tree, __isl_take isl_union_set *filter);
 135
 136 __isl_give isl_schedule_tree *isl_schedule_tree_append_to_leaves(
 137         __isl_take isl_schedule_tree *tree1,
 138         __isl_take isl_schedule_tree *tree2);
 139
 140 __isl_give isl_schedule_tree *isl_schedule_tree_band_scale(
 141         __isl_take isl_schedule_tree *tree, __isl_take isl_multi_val *mv);
 142 __isl_give isl_schedule_tree *isl_schedule_tree_band_scale_down(
 143         __isl_take isl_schedule_tree *tree, __isl_take isl_multi_val *mv);
 144 __isl_give isl_schedule_tree *isl_schedule_tree_band_tile(
 145         __isl_take isl_schedule_tree *tree, __isl_take isl_multi_val *sizes);
 146 __isl_give isl_schedule_tree *isl_schedule_tree_band_split(
 147         __isl_take isl_schedule_tree *tree, int pos);
 148 __isl_give isl_schedule_tree *isl_schedule_tree_band_gist(
 149         __isl_take isl_schedule_tree *tree, __isl_take isl_union_set *context);
 150
 151 __isl_give isl_schedule_tree *isl_schedule_tree_child(
 152         __isl_take isl_schedule_tree *tree, int pos);
 153 __isl_give isl_schedule_tree *isl_schedule_tree_reset_children(
 154         __isl_take isl_schedule_tree *tree);
 155 __isl_give isl_schedule_tree *isl_schedule_tree_drop_child(
 156         __isl_take isl_schedule_tree *tree, int pos);
 157 __isl_give isl_schedule_tree *isl_schedule_tree_replace_child(
 158         __isl_take isl_schedule_tree *tree, int pos,
 159         __isl_take isl_schedule_tree *new_child);
 160
 161 __isl_give isl_schedule_tree *isl_schedule_tree_reset_user(
 162         __isl_take isl_schedule_tree *tree);
 163 __isl_give isl_schedule_tree *isl_schedule_tree_align_params(
 164         __isl_take isl_schedule_tree *tree, __isl_take isl_space *space);
 165 __isl_give isl_schedule_tree *isl_schedule_tree_pullback_union_pw_multi_aff(
 166         __isl_take isl_schedule_tree *tree,
 167         __isl_take isl_union_pw_multi_aff *upma);
 168
 169 __isl_give isl_printer *isl_printer_print_schedule_tree(
 170         __isl_take isl_printer *p, __isl_keep isl_schedule_tree *tree);
 171 __isl_give isl_printer *isl_printer_print_schedule_tree_mark(
 172         __isl_take isl_printer *p, __isl_keep isl_schedule_tree *tree,
 173         int n_ancestor, int *child_pos);
 174
 175 #endif