2 * Interblock liveness analysis.
3 * @author Sebastian Hack
10 #include "firm_types.h"
22 typedef struct _be_lv_t be_lv_t;
24 typedef struct _be_lv_info_t be_lv_info_t;
28 * Compute the inter block liveness for a graph.
29 * @param irg The graph.
31 be_lv_t *be_liveness(ir_graph *irg);
34 * Check the given liveness information against a freshly computed one.
36 void be_liveness_check(be_lv_t *lv);
39 * Free the liveness information.
41 void be_liveness_free(be_lv_t *lv);
44 * Recompute the complete liveness information.
46 void be_liveness_recompute(be_lv_t *lv);
49 * Update the liveness information for a single node.
50 * It is irrelevant if there is liveness information present for the node.
51 * The liveness information for the node is firstly deleted and then recomputed.
52 * If the node is fresh and never recorded inf the liveness information before,
53 * it is more efficient to call be_liveness_introduce().
55 void be_liveness_update(be_lv_t *lv, ir_node *irn);
58 * Remove a node from the liveness information.
60 void be_liveness_remove(be_lv_t *lv, ir_node *irn);
63 * Introduce a new node to the liveness information.
64 * The new irn is not deleted from any block's liveness information, so it must be fresh!
65 * @param lv The liveness info.
66 * @param irn The node.
68 void be_liveness_introduce(be_lv_t *lv, ir_node *irn);
71 * Add all nodes which are missing in the current liveness data.
72 * The liveness data of the already existing nodes (in the liveness data) is not touched.
73 * @param The liveness info.
75 void be_liveness_add_missing(be_lv_t *lv);
78 * Dump the liveness information for a graph.
79 * @param f The output.
80 * @param irg The graph.
82 void be_liveness_dump(const be_lv_t *lv, FILE *f);
85 * Dump the liveness information for a graph.
86 * @param irg The graph.
87 * @param cls_name A string used as substring in the filename.
89 void be_liveness_dumpto(const be_lv_t *lv, const char *cls_name);
92 * Check, if a node is live in at a block.
93 * @param block The block.
94 * @param irn The node to check for.
95 * @return 1, if @p irn is live at the entrance of @p block, 0 if not.
97 int (be_is_live_in)(const be_lv_t *lv, const ir_node *block, const ir_node *irn);
100 * Check, if a node is live out at a block.
101 * @param block The block.
102 * @param irn The node to check for.
103 * @return 1, if @p irn is live at the exit of @p block, 0 if not.
105 int (be_is_live_out)(const be_lv_t *lv, const ir_node *block, const ir_node *irn);
108 * Check, if a node is live at the end of a block.
109 * @param block The block.
110 * @param irn The node to check for.
111 * @return 1, if @p irn is live at the end of the block, 0 if not.
113 int (be_is_live_end)(const be_lv_t *lv, const ir_node *block, const ir_node *irn);
116 * Check, if the SSA dominance property is fulfilled.
117 * @param irg The graph.
118 * @return 1 if dominance property is fulfilled, 0 otherwise
120 int be_check_dominance(ir_graph *irg);
123 * The liveness transfer function.
124 * Updates a live set over a single step from a given node to its predecessor.
125 * Everything defined at the node is removed from the set, the uses of the node get inserted.
126 * @param arch_env The architecture environment.
127 * @param cls The register class to consider.
128 * @param irn The node at which liveness should be computed.
129 * @param live The set of nodes live before @p irn. This set gets modified by updating it to
130 * the nodes live after irn.
133 pset *be_liveness_transfer(const arch_env_t *arch_env, const arch_register_class_t *cls, ir_node *irn, pset *live);
136 * Put all node live at the end of a block into a set.
137 * @param arch_env The architecture environment.
138 * @param cls The register class to consider.
139 * @param bl The block.
140 * @param live The set to put them into.
143 pset *be_liveness_end_of_block(const be_lv_t *lv, const arch_env_t *arch_env, const arch_register_class_t *cls, const ir_node *bl, pset *live);
146 * Compute a set of nodes which are live at another node.
147 * BEWARE: This is the liveness immediately after the node,
148 * so the node itself is alive but it's operands maybe not.
149 * @param arch_env The architecture environment.
150 * @param cls The register class to consider.
151 * @param pos The node.
152 * @param live The set to put them into.
155 pset *be_liveness_nodes_live_at(const be_lv_t *lv, const arch_env_t *arch_env, const arch_register_class_t *cls, const ir_node *pos, pset *live);
158 * Compute a set of nodes which are live at another node.
159 * BEWARE: This is the liveness immediately before the node,
160 * so the node itself is not alive but it's operands are.
161 * @param arch_env The architecture environment.
162 * @param cls The register class to consider.
163 * @param pos The node.
164 * @param live The set to put them into.
167 pset *be_liveness_nodes_live_at_input(const be_lv_t *lv, const arch_env_t *arch_env, const arch_register_class_t *cls, const ir_node *pos, pset *live);
171 * FIXME: Need comment
173 void be_liveness_add_missing(be_lv_t *lv);
175 #endif /* _BELIVE_H */