2 * Copyright (C) 1995-2008 University of Karlsruhe. All right reserved.
4 * This file is part of libFirm.
6 * This file may be distributed and/or modified under the terms of the
7 * GNU General Public License version 2 as published by the Free Software
8 * Foundation and appearing in the file LICENSE.GPL included in the
9 * packaging of this file.
11 * Licensees holding valid libFirm Professional Edition licenses may use
12 * this file in accordance with the libFirm Commercial License.
13 * Agreement provided with the Software.
15 * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
16 * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22 * @brief Interblock liveness analysis.
23 * @author Sebastian Hack
27 #ifndef FIRM_BE_BELIVE_H
28 #define FIRM_BE_BELIVE_H
34 #include "firm_types.h"
37 #include "irlivechk.h"
39 #include "irnodeset.h"
48 * Compute the inter block liveness for a graph.
49 * @param irg The graph.
51 be_lv_t *be_liveness(ir_graph *irg);
54 * Check the given liveness information against a freshly computed one.
56 void be_liveness_check(be_lv_t *lv);
59 * Free the liveness information.
61 void be_liveness_free(be_lv_t *lv);
64 * Recompute the complete liveness information.
66 void be_liveness_recompute(be_lv_t *lv);
69 * Update the liveness information for a single node.
70 * It is irrelevant if there is liveness information present for the node.
71 * The liveness information for the node is firstly deleted and then recomputed.
72 * If the node is fresh and never recorded inf the liveness information before,
73 * it is more efficient to call be_liveness_introduce().
75 void be_liveness_update(be_lv_t *lv, ir_node *irn);
78 * Remove a node from the liveness information.
80 void be_liveness_remove(be_lv_t *lv, const ir_node *irn);
83 * Introduce a new node to the liveness information.
84 * The new irn is not deleted from any block's liveness information, so it must be fresh!
85 * @param lv The liveness info.
86 * @param irn The node.
88 void be_liveness_introduce(be_lv_t *lv, ir_node *irn);
91 * Add all nodes which are missing in the current liveness data.
92 * The liveness data of the already existing nodes (in the liveness data) is not touched.
93 * @param The liveness info.
95 void be_liveness_add_missing(be_lv_t *lv);
98 * Dump the liveness information for a graph.
99 * @param f The output.
100 * @param irg The graph.
102 void be_liveness_dump(const be_lv_t *lv, FILE *f);
105 * Dump the liveness information for a graph.
106 * @param irg The graph.
107 * @param cls_name A string used as substring in the filename.
109 void be_liveness_dumpto(const be_lv_t *lv, const char *cls_name);
112 * Check, if a node is live in at a block.
113 * @param block The block.
114 * @param irn The node to check for.
115 * @return 1, if @p irn is live at the entrance of @p block, 0 if not.
117 int (be_is_live_in)(const be_lv_t *lv, const ir_node *block, const ir_node *irn);
120 * Check, if a node is live out at a block.
121 * @param block The block.
122 * @param irn The node to check for.
123 * @return 1, if @p irn is live at the exit of @p block, 0 if not.
125 int (be_is_live_out)(const be_lv_t *lv, const ir_node *block, const ir_node *irn);
128 * Check, if a node is live at the end of a block.
129 * @param block The block.
130 * @param irn The node to check for.
131 * @return 1, if @p irn is live at the end of the block, 0 if not.
133 int (be_is_live_end)(const be_lv_t *lv, const ir_node *block, const ir_node *irn);
136 * Check, if the SSA dominance property is fulfilled.
137 * @param irg The graph.
138 * @return 1 if dominance property is fulfilled, 0 otherwise
140 int be_check_dominance(ir_graph *irg);
143 * The liveness transfer function.
144 * Updates a live set over a single step from a given node to its predecessor.
145 * Everything defined at the node is removed from the set, the uses of the node get inserted.
146 * @param cls The register class to consider.
147 * @param irn The node at which liveness should be computed.
148 * @param live The set of nodes live before @p irn. This set gets modified by updating it to
149 * the nodes live after irn.
152 void be_liveness_transfer(const arch_register_class_t *cls, ir_node *node,
153 ir_nodeset_t *nodeset);
156 * Put all node live at the end of a block into a set.
157 * @param cls The register class to consider.
158 * @param bl The block.
159 * @param live The set to put them into.
162 void be_liveness_end_of_block(const be_lv_t *lv,
163 const arch_register_class_t *cls,
164 const ir_node *bl, ir_nodeset_t *nodeset);
167 * Compute a set of nodes which are live at another node.
168 * BEWARE: This is the liveness immediately after the node,
169 * so the node itself is alive but its operands maybe not.
170 * @param cls The register class to consider.
171 * @param pos The node.
172 * @param live The set to put them into.
174 void be_liveness_nodes_live_at(const be_lv_t *lv,
175 const arch_register_class_t *cls,
176 const ir_node *pos, ir_nodeset_t *live);
179 * Make sure the live sets are computed.
180 * @param lv The liveness information.
182 void be_liveness_assure_sets(be_lv_t *lv);
185 * Make sure all information needed for liveness checks is available.
186 * @param lv The liveness information.
188 void be_liveness_assure_chk(be_lv_t *lv);
191 * Invalidate the liveness information.
192 * You must call this if you modify the program and do not
193 * update the liveness with the be_liveness_{update,remove,introduce}
195 * @param lv The liveness info.
197 void be_liveness_invalidate(be_lv_t *lv);
199 #endif /* FIRM_BE_BELIVE_H */