Blame isl-0.16.1/isl_schedule_tree.h

Packit fb9d21
#ifndef ISL_SCHEDLUE_TREE_H
Packit fb9d21
#define ISL_SCHEDLUE_TREE_H
Packit fb9d21
Packit fb9d21
#include <isl_schedule_band.h>
Packit fb9d21
#include <isl/schedule.h>
Packit fb9d21
#include <isl/set.h>
Packit fb9d21
#include <isl/union_set.h>
Packit fb9d21
Packit fb9d21
struct isl_schedule_tree;
Packit fb9d21
typedef struct isl_schedule_tree isl_schedule_tree;
Packit fb9d21
Packit fb9d21
ISL_DECLARE_LIST(schedule_tree)
Packit fb9d21
Packit fb9d21
/* A schedule (sub)tree.
Packit fb9d21
 *
Packit fb9d21
 * The leaves of a tree are not explicitly represented inside
Packit fb9d21
 * the isl_schedule_tree.  If a tree consists of only a leaf,
Packit fb9d21
 * then it is equal to the static object isl_schedule_tree_empty.
Packit fb9d21
 *
Packit fb9d21
 * ctx may be NULL if type is isl_schedule_node_leaf.
Packit fb9d21
 * In this case, ref has a negative value.
Packit fb9d21
 *
Packit fb9d21
 * The "band" field is valid when type is isl_schedule_node_band.
Packit fb9d21
 * The "context" field is valid when type is isl_schedule_node_context
Packit fb9d21
 * and represents constraints on the flat product of the outer band nodes,
Packit fb9d21
 * possibly introducing additional parameters.
Packit fb9d21
 * The "domain" field is valid when type is isl_schedule_node_domain
Packit fb9d21
 * and introduces the statement instances scheduled by the tree.
Packit fb9d21
 *
Packit fb9d21
 * The "contraction" and "expansion" fields are valid when type
Packit fb9d21
 * is isl_schedule_node_expansion.
Packit fb9d21
 * "expansion" expands the reaching domain elements to one or more
Packit fb9d21
 * domain elements for the subtree.
Packit fb9d21
 * "contraction" maps these elements back to the corresponding
Packit fb9d21
 * reaching domain element.  It does not involve any domain constraints.
Packit fb9d21
 *
Packit fb9d21
 * The "extension" field is valid when the is isl_schedule_node_extension
Packit fb9d21
 * maps outer schedule dimenions (the flat product of the outer band nodes)
Packit fb9d21
 * to additional iteration domains.
Packit fb9d21
 *
Packit fb9d21
 * The "filter" field is valid when type is isl_schedule_node_filter
Packit fb9d21
 * and represents the statement instances selected by the node.
Packit fb9d21
 *
Packit fb9d21
 * The "guard" field is valid when type is isl_schedule_node_guard
Packit fb9d21
 * and represents constraints on the flat product of the outer band nodes
Packit fb9d21
 * that need to be enforced by the outer nodes in the generated AST.
Packit fb9d21
 *
Packit fb9d21
 * The "mark" field is valid when type is isl_schedule_node_mark and
Packit fb9d21
 * identifies the mark.
Packit fb9d21
 *
Packit fb9d21
 * The "children" field is valid for all types except
Packit fb9d21
 * isl_schedule_node_leaf.  This field is NULL if there are
Packit fb9d21
 * no children (except for the implicit leaves).
Packit fb9d21
 *
Packit fb9d21
 * anchored is set if the node or any of its descendants depends
Packit fb9d21
 * on its position in the schedule tree.
Packit fb9d21
 */
Packit fb9d21
struct isl_schedule_tree {
Packit fb9d21
	int ref;
Packit fb9d21
	isl_ctx *ctx;
Packit fb9d21
	int anchored;
Packit fb9d21
	enum isl_schedule_node_type type;
Packit fb9d21
	union {
Packit fb9d21
		isl_schedule_band *band;
Packit fb9d21
		isl_set *context;
Packit fb9d21
		isl_union_set *domain;
Packit fb9d21
		struct {
Packit fb9d21
			isl_union_pw_multi_aff *contraction;
Packit fb9d21
			isl_union_map *expansion;
Packit fb9d21
		};
Packit fb9d21
		isl_union_map *extension;
Packit fb9d21
		isl_union_set *filter;
Packit fb9d21
		isl_set *guard;
Packit fb9d21
		isl_id *mark;
Packit fb9d21
	};
Packit fb9d21
	isl_schedule_tree_list *children;
Packit fb9d21
};
Packit fb9d21
Packit fb9d21
isl_ctx *isl_schedule_tree_get_ctx(__isl_keep isl_schedule_tree *tree);
Packit fb9d21
enum isl_schedule_node_type isl_schedule_tree_get_type(
Packit fb9d21
	__isl_keep isl_schedule_tree *tree);
Packit fb9d21
Packit fb9d21
__isl_give isl_schedule_tree *isl_schedule_tree_leaf(isl_ctx *ctx);
Packit fb9d21
int isl_schedule_tree_is_leaf(__isl_keep isl_schedule_tree *tree);
Packit fb9d21
Packit fb9d21
isl_bool isl_schedule_tree_plain_is_equal(__isl_keep isl_schedule_tree *tree1,
Packit fb9d21
	__isl_keep isl_schedule_tree *tree2);
Packit fb9d21
Packit fb9d21
__isl_give isl_schedule_tree *isl_schedule_tree_copy(
Packit fb9d21
	__isl_keep isl_schedule_tree *tree);
Packit fb9d21
__isl_null isl_schedule_tree *isl_schedule_tree_free(
Packit fb9d21
	__isl_take isl_schedule_tree *tree);
Packit fb9d21
Packit fb9d21
__isl_give isl_schedule_tree *isl_schedule_tree_from_band(
Packit fb9d21
	__isl_take isl_schedule_band *band);
Packit fb9d21
__isl_give isl_schedule_tree *isl_schedule_tree_from_context(
Packit fb9d21
	__isl_take isl_set *context);
Packit fb9d21
__isl_give isl_schedule_tree *isl_schedule_tree_from_domain(
Packit fb9d21
	__isl_take isl_union_set *domain);
Packit fb9d21
__isl_give isl_schedule_tree *isl_schedule_tree_from_expansion(
Packit fb9d21
	__isl_take isl_union_pw_multi_aff *contraction,
Packit fb9d21
	__isl_take isl_union_map *expansion);
Packit fb9d21
__isl_give isl_schedule_tree *isl_schedule_tree_from_extension(
Packit fb9d21
	__isl_take isl_union_map *extension);
Packit fb9d21
__isl_give isl_schedule_tree *isl_schedule_tree_from_filter(
Packit fb9d21
	__isl_take isl_union_set *filter);
Packit fb9d21
__isl_give isl_schedule_tree *isl_schedule_tree_from_guard(
Packit fb9d21
	__isl_take isl_set *guard);
Packit fb9d21
__isl_give isl_schedule_tree *isl_schedule_tree_from_children(
Packit fb9d21
	enum isl_schedule_node_type type,
Packit fb9d21
	__isl_take isl_schedule_tree_list *list);
Packit fb9d21
__isl_give isl_schedule_tree *isl_schedule_tree_from_pair(
Packit fb9d21
	enum isl_schedule_node_type type, __isl_take isl_schedule_tree *tree1,
Packit fb9d21
	__isl_take isl_schedule_tree *tree2);
Packit fb9d21
__isl_give isl_schedule_tree *isl_schedule_tree_sequence_pair(
Packit fb9d21
	__isl_take isl_schedule_tree *tree1,
Packit fb9d21
	__isl_take isl_schedule_tree *tree2);
Packit fb9d21
Packit fb9d21
isl_bool isl_schedule_tree_is_subtree_anchored(
Packit fb9d21
	__isl_keep isl_schedule_tree *tree);
Packit fb9d21
Packit fb9d21
__isl_give isl_space *isl_schedule_tree_band_get_space(
Packit fb9d21
	__isl_keep isl_schedule_tree *tree);
Packit fb9d21
__isl_give isl_schedule_tree *isl_schedule_tree_band_intersect_domain(
Packit fb9d21
	__isl_take isl_schedule_tree *tree, __isl_take isl_union_set *domain);
Packit fb9d21
__isl_give isl_multi_union_pw_aff *isl_schedule_tree_band_get_partial_schedule(
Packit fb9d21
	__isl_keep isl_schedule_tree *tree);
Packit fb9d21
__isl_give isl_schedule_tree *isl_schedule_tree_band_set_partial_schedule(
Packit fb9d21
	__isl_take isl_schedule_tree *tree,
Packit fb9d21
	__isl_take isl_multi_union_pw_aff *schedule);
Packit fb9d21
enum isl_ast_loop_type isl_schedule_tree_band_member_get_ast_loop_type(
Packit fb9d21
	__isl_keep isl_schedule_tree *tree, int pos);
Packit fb9d21
__isl_give isl_schedule_tree *isl_schedule_tree_band_member_set_ast_loop_type(
Packit fb9d21
	__isl_take isl_schedule_tree *tree, int pos,
Packit fb9d21
	enum isl_ast_loop_type type);
Packit fb9d21
enum isl_ast_loop_type isl_schedule_tree_band_member_get_isolate_ast_loop_type(
Packit fb9d21
	__isl_keep isl_schedule_tree *tree, int pos);
Packit fb9d21
__isl_give isl_schedule_tree *
Packit fb9d21
isl_schedule_tree_band_member_set_isolate_ast_loop_type(
Packit fb9d21
	__isl_take isl_schedule_tree *tree, int pos,
Packit fb9d21
	enum isl_ast_loop_type type);
Packit fb9d21
__isl_give isl_union_set *isl_schedule_tree_band_get_ast_build_options(
Packit fb9d21
	__isl_keep isl_schedule_tree *tree);
Packit fb9d21
__isl_give isl_schedule_tree *isl_schedule_tree_band_set_ast_build_options(
Packit fb9d21
	__isl_take isl_schedule_tree *tree, __isl_take isl_union_set *options);
Packit fb9d21
__isl_give isl_set *isl_schedule_tree_context_get_context(
Packit fb9d21
	__isl_keep isl_schedule_tree *tree);
Packit fb9d21
__isl_give isl_union_set *isl_schedule_tree_domain_get_domain(
Packit fb9d21
	__isl_keep isl_schedule_tree *tree);
Packit fb9d21
__isl_give isl_schedule_tree *isl_schedule_tree_domain_set_domain(
Packit fb9d21
	__isl_take isl_schedule_tree *tree, __isl_take isl_union_set *domain);
Packit fb9d21
__isl_give isl_union_pw_multi_aff *isl_schedule_tree_expansion_get_contraction(
Packit fb9d21
	__isl_keep isl_schedule_tree *tree);
Packit fb9d21
__isl_give isl_union_map *isl_schedule_tree_expansion_get_expansion(
Packit fb9d21
	__isl_keep isl_schedule_tree *tree);
Packit fb9d21
__isl_give isl_schedule_tree *
Packit fb9d21
isl_schedule_tree_expansion_set_contraction_and_expansion(
Packit fb9d21
	__isl_take isl_schedule_tree *tree,
Packit fb9d21
	__isl_take isl_union_pw_multi_aff *contraction,
Packit fb9d21
	__isl_take isl_union_map *expansion);
Packit fb9d21
__isl_give isl_union_map *isl_schedule_tree_extension_get_extension(
Packit fb9d21
	__isl_keep isl_schedule_tree *tree);
Packit fb9d21
__isl_give isl_schedule_tree *isl_schedule_tree_extension_set_extension(
Packit fb9d21
	__isl_take isl_schedule_tree *tree,
Packit fb9d21
	__isl_take isl_union_map *extension);
Packit fb9d21
__isl_give isl_union_set *isl_schedule_tree_filter_get_filter(
Packit fb9d21
	__isl_keep isl_schedule_tree *tree);
Packit fb9d21
__isl_give isl_schedule_tree *isl_schedule_tree_filter_set_filter(
Packit fb9d21
	__isl_take isl_schedule_tree *tree, __isl_take isl_union_set *filter);
Packit fb9d21
__isl_give isl_set *isl_schedule_tree_guard_get_guard(
Packit fb9d21
	__isl_keep isl_schedule_tree *tree);
Packit fb9d21
__isl_give isl_id *isl_schedule_tree_mark_get_id(
Packit fb9d21
	__isl_keep isl_schedule_tree *tree);
Packit fb9d21
Packit fb9d21
__isl_give isl_schedule_tree *isl_schedule_tree_first_schedule_descendant(
Packit fb9d21
	__isl_take isl_schedule_tree *tree, __isl_keep isl_schedule_tree *leaf);
Packit fb9d21
__isl_give isl_union_map *isl_schedule_tree_get_subtree_schedule_union_map(
Packit fb9d21
	__isl_keep isl_schedule_tree *tree);
Packit fb9d21
Packit fb9d21
unsigned isl_schedule_tree_band_n_member(__isl_keep isl_schedule_tree *tree);
Packit fb9d21
Packit fb9d21
isl_bool isl_schedule_tree_band_member_get_coincident(
Packit fb9d21
	__isl_keep isl_schedule_tree *tree, int pos);
Packit fb9d21
__isl_give isl_schedule_tree *isl_schedule_tree_band_member_set_coincident(
Packit fb9d21
	__isl_take isl_schedule_tree *tree, int pos, int coincident);
Packit fb9d21
isl_bool isl_schedule_tree_band_get_permutable(
Packit fb9d21
	__isl_keep isl_schedule_tree *tree);
Packit fb9d21
__isl_give isl_schedule_tree *isl_schedule_tree_band_set_permutable(
Packit fb9d21
	__isl_take isl_schedule_tree *tree, int permutable);
Packit fb9d21
Packit fb9d21
int isl_schedule_tree_has_children(__isl_keep isl_schedule_tree *tree);
Packit fb9d21
int isl_schedule_tree_n_children(__isl_keep isl_schedule_tree *tree);
Packit fb9d21
__isl_give isl_schedule_tree *isl_schedule_tree_get_child(
Packit fb9d21
	__isl_keep isl_schedule_tree *tree, int pos);
Packit fb9d21
Packit fb9d21
__isl_give isl_schedule_tree *isl_schedule_tree_insert_band(
Packit fb9d21
	__isl_take isl_schedule_tree *tree, __isl_take isl_schedule_band *band);
Packit fb9d21
__isl_give isl_schedule_tree *isl_schedule_tree_insert_context(
Packit fb9d21
	__isl_take isl_schedule_tree *tree, __isl_take isl_set *context);
Packit fb9d21
__isl_give isl_schedule_tree *isl_schedule_tree_insert_domain(
Packit fb9d21
	__isl_take isl_schedule_tree *tree, __isl_take isl_union_set *domain);
Packit fb9d21
__isl_give isl_schedule_tree *isl_schedule_tree_insert_expansion(
Packit fb9d21
	__isl_take isl_schedule_tree *tree,
Packit fb9d21
	__isl_take isl_union_pw_multi_aff *contraction,
Packit fb9d21
	__isl_take isl_union_map *expansion);
Packit fb9d21
__isl_give isl_schedule_tree *isl_schedule_tree_insert_extension(
Packit fb9d21
	__isl_take isl_schedule_tree *tree,
Packit fb9d21
	__isl_take isl_union_map *extension);
Packit fb9d21
__isl_give isl_schedule_tree *isl_schedule_tree_insert_filter(
Packit fb9d21
	__isl_take isl_schedule_tree *tree, __isl_take isl_union_set *filter);
Packit fb9d21
__isl_give isl_schedule_tree *isl_schedule_tree_children_insert_filter(
Packit fb9d21
	__isl_take isl_schedule_tree *tree, __isl_take isl_union_set *filter);
Packit fb9d21
__isl_give isl_schedule_tree *isl_schedule_tree_insert_guard(
Packit fb9d21
	__isl_take isl_schedule_tree *tree, __isl_take isl_set *guard);
Packit fb9d21
__isl_give isl_schedule_tree *isl_schedule_tree_insert_mark(
Packit fb9d21
	__isl_take isl_schedule_tree *tree, __isl_take isl_id *mark);
Packit fb9d21
Packit fb9d21
__isl_give isl_schedule_tree *isl_schedule_tree_append_to_leaves(
Packit fb9d21
	__isl_take isl_schedule_tree *tree1,
Packit fb9d21
	__isl_take isl_schedule_tree *tree2);
Packit fb9d21
Packit fb9d21
__isl_give isl_schedule_tree *isl_schedule_tree_band_scale(
Packit fb9d21
	__isl_take isl_schedule_tree *tree, __isl_take isl_multi_val *mv);
Packit fb9d21
__isl_give isl_schedule_tree *isl_schedule_tree_band_scale_down(
Packit fb9d21
	__isl_take isl_schedule_tree *tree, __isl_take isl_multi_val *mv);
Packit fb9d21
__isl_give isl_schedule_tree *isl_schedule_tree_band_mod(
Packit fb9d21
	__isl_take isl_schedule_tree *tree, __isl_take isl_multi_val *mv);
Packit fb9d21
__isl_give isl_schedule_tree *isl_schedule_tree_band_tile(
Packit fb9d21
	__isl_take isl_schedule_tree *tree, __isl_take isl_multi_val *sizes);
Packit fb9d21
__isl_give isl_schedule_tree *isl_schedule_tree_band_shift(
Packit fb9d21
	__isl_take isl_schedule_tree *tree,
Packit fb9d21
	__isl_take isl_multi_union_pw_aff *shift);
Packit fb9d21
__isl_give isl_schedule_tree *isl_schedule_tree_band_split(
Packit fb9d21
	__isl_take isl_schedule_tree *tree, int pos);
Packit fb9d21
__isl_give isl_schedule_tree *isl_schedule_tree_band_gist(
Packit fb9d21
	__isl_take isl_schedule_tree *tree, __isl_take isl_union_set *context);
Packit fb9d21
Packit fb9d21
__isl_give isl_schedule_tree *isl_schedule_tree_child(
Packit fb9d21
	__isl_take isl_schedule_tree *tree, int pos);
Packit fb9d21
__isl_give isl_schedule_tree *isl_schedule_tree_reset_children(
Packit fb9d21
	__isl_take isl_schedule_tree *tree);
Packit fb9d21
__isl_give isl_schedule_tree *isl_schedule_tree_drop_child(
Packit fb9d21
	__isl_take isl_schedule_tree *tree, int pos);
Packit fb9d21
__isl_give isl_schedule_tree *isl_schedule_tree_replace_child(
Packit fb9d21
	__isl_take isl_schedule_tree *tree, int pos,
Packit fb9d21
	__isl_take isl_schedule_tree *new_child);
Packit fb9d21
__isl_give isl_schedule_tree *isl_schedule_tree_sequence_splice(
Packit fb9d21
	__isl_take isl_schedule_tree *tree, int pos,
Packit fb9d21
	__isl_take isl_schedule_tree *child);
Packit fb9d21
Packit fb9d21
__isl_give isl_schedule_tree *isl_schedule_tree_reset_user(
Packit fb9d21
	__isl_take isl_schedule_tree *tree);
Packit fb9d21
__isl_give isl_schedule_tree *isl_schedule_tree_align_params(
Packit fb9d21
	__isl_take isl_schedule_tree *tree, __isl_take isl_space *space);
Packit fb9d21
__isl_give isl_schedule_tree *isl_schedule_tree_pullback_union_pw_multi_aff(
Packit fb9d21
	__isl_take isl_schedule_tree *tree,
Packit fb9d21
	__isl_take isl_union_pw_multi_aff *upma);
Packit fb9d21
Packit fb9d21
__isl_give isl_printer *isl_printer_print_schedule_tree(
Packit fb9d21
	__isl_take isl_printer *p, __isl_keep isl_schedule_tree *tree);
Packit fb9d21
__isl_give isl_printer *isl_printer_print_schedule_tree_mark(
Packit fb9d21
	__isl_take isl_printer *p, __isl_keep isl_schedule_tree *tree,
Packit fb9d21
	int n_ancestor, int *child_pos);
Packit fb9d21
Packit fb9d21
#endif