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 "context" field is valid when type is isl_schedule_node_context
  25  * and represents constraints on the flat product of the outer band nodes,
  26  * possibly introducing additional parameters.
  27  * The "domain" field is valid when type is isl_schedule_node_domain
  28  * and introduces the statement instances scheduled by the tree.
  29  *
  30  * The "contraction" and "expansion" fields are valid when type
  31  * is isl_schedule_node_expansion.
  32  * "expansion" expands the reaching domain elements to one or more
  33  * domain elements for the subtree.
  34  * "contraction" maps these elements back to the corresponding
  35  * reaching domain element.  It does not involve any domain constraints.
  36  *
  37  * The "filter" field is valid when type is isl_schedule_node_filter
  38  * and represents the statement instances selected by the node.
  39  *
  40  * The "children" field is valid for all types except
  41  * isl_schedule_node_leaf.  This field is NULL if there are
  42  * no children (except for the implicit leaves).
  43  *
  44  * anchored is set if the node or any of its descendants depends
  45  * on its position in the schedule tree.
  46  */
  47 struct isl_schedule_tree {
  48         int ref;
  49         isl_ctx *ctx;
  50         int anchored;
  51         enum isl_schedule_node_type type;
  52         union {
  53                 isl_schedule_band *band;
  54                 isl_set *context;
  55                 isl_union_set *domain;
  56                 struct {
  57                         isl_union_pw_multi_aff *contraction;
  58                         isl_union_map *expansion;
  59                 };
  60                 isl_union_set *filter;
  61         };
  62         isl_schedule_tree_list *children;
  63 };
  64
  65 isl_ctx *isl_schedule_tree_get_ctx(__isl_keep isl_schedule_tree *tree);
  66 enum isl_schedule_node_type isl_schedule_tree_get_type(
  67         __isl_keep isl_schedule_tree *tree);
  68
  69 __isl_give isl_schedule_tree *isl_schedule_tree_leaf(isl_ctx *ctx);
  70 int isl_schedule_tree_is_leaf(__isl_keep isl_schedule_tree *tree);
  71
  72 int isl_schedule_tree_plain_is_equal(__isl_keep isl_schedule_tree *tree1,
  73         __isl_keep isl_schedule_tree *tree2);
  74
  75 __isl_give isl_schedule_tree *isl_schedule_tree_copy(
  76         __isl_keep isl_schedule_tree *tree);
  77 __isl_null isl_schedule_tree *isl_schedule_tree_free(
  78         __isl_take isl_schedule_tree *tree);
  79
  80 __isl_give isl_schedule_tree *isl_schedule_tree_from_band(
  81         __isl_take isl_schedule_band *band);
  82 __isl_give isl_schedule_tree *isl_schedule_tree_from_context(
  83         __isl_take isl_set *context);
  84 __isl_give isl_schedule_tree *isl_schedule_tree_from_domain(
  85         __isl_take isl_union_set *domain);
  86 __isl_give isl_schedule_tree *isl_schedule_tree_from_expansion(
  87         __isl_take isl_union_pw_multi_aff *contraction,
  88         __isl_take isl_union_map *expansion);
  89 __isl_give isl_schedule_tree *isl_schedule_tree_from_filter(
  90         __isl_take isl_union_set *filter);
  91 __isl_give isl_schedule_tree *isl_schedule_tree_from_children(
  92         enum isl_schedule_node_type type,
  93         __isl_take isl_schedule_tree_list *list);
  94 __isl_give isl_schedule_tree *isl_schedule_tree_from_pair(
  95         enum isl_schedule_node_type type, __isl_take isl_schedule_tree *tree1,
  96         __isl_take isl_schedule_tree *tree2);
  97
  98 int isl_schedule_tree_is_subtree_anchored(__isl_keep isl_schedule_tree *tree);
  99
 100 __isl_give isl_space *isl_schedule_tree_band_get_space(
 101         __isl_keep isl_schedule_tree *tree);
 102 __isl_give isl_multi_union_pw_aff *isl_schedule_tree_band_get_partial_schedule(
 103         __isl_keep isl_schedule_tree *tree);
 104 enum isl_ast_loop_type isl_schedule_tree_band_member_get_ast_loop_type(
 105         __isl_keep isl_schedule_tree *tree, int pos);
 106 __isl_give isl_schedule_tree *isl_schedule_tree_band_member_set_ast_loop_type(
 107         __isl_take isl_schedule_tree *tree, int pos,
 108         enum isl_ast_loop_type type);
 109 enum isl_ast_loop_type isl_schedule_tree_band_member_get_isolate_ast_loop_type(
 110         __isl_keep isl_schedule_tree *tree, int pos);
 111 __isl_give isl_schedule_tree *
 112 isl_schedule_tree_band_member_set_isolate_ast_loop_type(
 113         __isl_take isl_schedule_tree *tree, int pos,
 114         enum isl_ast_loop_type type);
 115 __isl_give isl_union_set *isl_schedule_tree_band_get_ast_build_options(
 116         __isl_keep isl_schedule_tree *tree);
 117 __isl_give isl_schedule_tree *isl_schedule_tree_band_set_ast_build_options(
 118         __isl_take isl_schedule_tree *tree, __isl_take isl_union_set *options);
 119 __isl_give isl_set *isl_schedule_tree_context_get_context(
 120         __isl_keep isl_schedule_tree *tree);
 121 __isl_give isl_union_set *isl_schedule_tree_domain_get_domain(
 122         __isl_keep isl_schedule_tree *tree);
 123 __isl_give isl_schedule_tree *isl_schedule_tree_domain_set_domain(
 124         __isl_take isl_schedule_tree *tree, __isl_take isl_union_set *domain);
 125 __isl_give isl_union_pw_multi_aff *isl_schedule_tree_expansion_get_contraction(
 126         __isl_keep isl_schedule_tree *tree);
 127 __isl_give isl_union_map *isl_schedule_tree_expansion_get_expansion(
 128         __isl_keep isl_schedule_tree *tree);
 129 __isl_give isl_schedule_tree *
 130 isl_schedule_tree_expansion_set_contraction_and_expansion(
 131         __isl_take isl_schedule_tree *tree,
 132         __isl_take isl_union_pw_multi_aff *contraction,
 133         __isl_take isl_union_map *expansion);
 134 __isl_give isl_union_set *isl_schedule_tree_filter_get_filter(
 135         __isl_keep isl_schedule_tree *tree);
 136 __isl_give isl_schedule_tree *isl_schedule_tree_filter_set_filter(
 137         __isl_take isl_schedule_tree *tree, __isl_take isl_union_set *filter);
 138
 139 __isl_give isl_schedule_tree *isl_schedule_tree_first_schedule_descendant(
 140         __isl_take isl_schedule_tree *tree, __isl_keep isl_schedule_tree *leaf);
 141 __isl_give isl_union_map *isl_schedule_tree_get_subtree_schedule_union_map(
 142         __isl_keep isl_schedule_tree *tree);
 143
 144 unsigned isl_schedule_tree_band_n_member(__isl_keep isl_schedule_tree *tree);
 145
 146 int isl_schedule_tree_band_member_get_coincident(
 147         __isl_keep isl_schedule_tree *tree, int pos);
 148 __isl_give isl_schedule_tree *isl_schedule_tree_band_member_set_coincident(
 149         __isl_take isl_schedule_tree *tree, int pos, int coincident);
 150 int isl_schedule_tree_band_get_permutable(__isl_keep isl_schedule_tree *tree);
 151 __isl_give isl_schedule_tree *isl_schedule_tree_band_set_permutable(
 152         __isl_take isl_schedule_tree *tree, int permutable);
 153
 154 int isl_schedule_tree_has_children(__isl_keep isl_schedule_tree *tree);
 155 int isl_schedule_tree_n_children(__isl_keep isl_schedule_tree *tree);
 156 __isl_give isl_schedule_tree *isl_schedule_tree_get_child(
 157         __isl_keep isl_schedule_tree *tree, int pos);
 158
 159 __isl_give isl_schedule_tree *isl_schedule_tree_insert_band(
 160         __isl_take isl_schedule_tree *tree, __isl_take isl_schedule_band *band);
 161 __isl_give isl_schedule_tree *isl_schedule_tree_insert_context(
 162         __isl_take isl_schedule_tree *tree, __isl_take isl_set *context);
 163 __isl_give isl_schedule_tree *isl_schedule_tree_insert_domain(
 164         __isl_take isl_schedule_tree *tree, __isl_take isl_union_set *domain);
 165 __isl_give isl_schedule_tree *isl_schedule_tree_insert_expansion(
 166         __isl_take isl_schedule_tree *tree,
 167         __isl_take isl_union_pw_multi_aff *contraction,
 168         __isl_take isl_union_map *expansion);
 169 __isl_give isl_schedule_tree *isl_schedule_tree_insert_filter(
 170         __isl_take isl_schedule_tree *tree, __isl_take isl_union_set *filter);
 171 __isl_give isl_schedule_tree *isl_schedule_tree_children_insert_filter(
 172         __isl_take isl_schedule_tree *tree, __isl_take isl_union_set *filter);
 173
 174 __isl_give isl_schedule_tree *isl_schedule_tree_append_to_leaves(
 175         __isl_take isl_schedule_tree *tree1,
 176         __isl_take isl_schedule_tree *tree2);
 177
 178 __isl_give isl_schedule_tree *isl_schedule_tree_band_scale(
 179         __isl_take isl_schedule_tree *tree, __isl_take isl_multi_val *mv);
 180 __isl_give isl_schedule_tree *isl_schedule_tree_band_scale_down(
 181         __isl_take isl_schedule_tree *tree, __isl_take isl_multi_val *mv);
 182 __isl_give isl_schedule_tree *isl_schedule_tree_band_tile(
 183         __isl_take isl_schedule_tree *tree, __isl_take isl_multi_val *sizes);
 184 __isl_give isl_schedule_tree *isl_schedule_tree_band_split(
 185         __isl_take isl_schedule_tree *tree, int pos);
 186 __isl_give isl_schedule_tree *isl_schedule_tree_band_gist(
 187         __isl_take isl_schedule_tree *tree, __isl_take isl_union_set *context);
 188
 189 __isl_give isl_schedule_tree *isl_schedule_tree_child(
 190         __isl_take isl_schedule_tree *tree, int pos);
 191 __isl_give isl_schedule_tree *isl_schedule_tree_reset_children(
 192         __isl_take isl_schedule_tree *tree);
 193 __isl_give isl_schedule_tree *isl_schedule_tree_drop_child(
 194         __isl_take isl_schedule_tree *tree, int pos);
 195 __isl_give isl_schedule_tree *isl_schedule_tree_replace_child(
 196         __isl_take isl_schedule_tree *tree, int pos,
 197         __isl_take isl_schedule_tree *new_child);
 198
 199 __isl_give isl_schedule_tree *isl_schedule_tree_reset_user(
 200         __isl_take isl_schedule_tree *tree);
 201 __isl_give isl_schedule_tree *isl_schedule_tree_align_params(
 202         __isl_take isl_schedule_tree *tree, __isl_take isl_space *space);
 203 __isl_give isl_schedule_tree *isl_schedule_tree_pullback_union_pw_multi_aff(
 204         __isl_take isl_schedule_tree *tree,
 205         __isl_take isl_union_pw_multi_aff *upma);
 206
 207 __isl_give isl_printer *isl_printer_print_schedule_tree(
 208         __isl_take isl_printer *p, __isl_keep isl_schedule_tree *tree);
 209 __isl_give isl_printer *isl_printer_print_schedule_tree_mark(
 210         __isl_take isl_printer *p, __isl_keep isl_schedule_tree *tree,
 211         int n_ancestor, int *child_pos);
 212
 213 #endif