2 * Copyright (C) 1995-2007 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
44 typedef struct _be_lv_t be_lv_t;
46 typedef struct _be_lv_info_t be_lv_info_t;
49 * Compute the inter block liveness for a graph.
50 * @param irg The graph.
52 be_lv_t *be_liveness(ir_graph *irg);
55 * Check the given liveness information against a freshly computed one.
57 void be_liveness_check(be_lv_t *lv);
60 * Free the liveness information.
62 void be_liveness_free(be_lv_t *lv);
65 * Recompute the complete liveness information.
67 void be_liveness_recompute(be_lv_t *lv);
70 * Update the liveness information for a single node.
71 * It is irrelevant if there is liveness information present for the node.
72 * The liveness information for the node is firstly deleted and then recomputed.
73 * If the node is fresh and never recorded inf the liveness information before,
74 * it is more efficient to call be_liveness_introduce().
76 void be_liveness_update(be_lv_t *lv, ir_node *irn);
79 * Remove a node from the liveness information.
81 void be_liveness_remove(be_lv_t *lv, ir_node *irn);
84 * Introduce a new node to the liveness information.
85 * The new irn is not deleted from any block's liveness information, so it must be fresh!
86 * @param lv The liveness info.
87 * @param irn The node.
89 void be_liveness_introduce(be_lv_t *lv, ir_node *irn);
92 * Add all nodes which are missing in the current liveness data.
93 * The liveness data of the already existing nodes (in the liveness data) is not touched.
94 * @param The liveness info.
96 void be_liveness_add_missing(be_lv_t *lv);
99 * Dump the liveness information for a graph.
100 * @param f The output.
101 * @param irg The graph.
103 void be_liveness_dump(const be_lv_t *lv, FILE *f);
106 * Dump the liveness information for a graph.
107 * @param irg The graph.
108 * @param cls_name A string used as substring in the filename.
110 void be_liveness_dumpto(const be_lv_t *lv, const char *cls_name);
113 * Check, if a node is live in at a block.
114 * @param block The block.
115 * @param irn The node to check for.
116 * @return 1, if @p irn is live at the entrance of @p block, 0 if not.
118 int (be_is_live_in)(const be_lv_t *lv, const ir_node *block, const ir_node *irn);
121 * Check, if a node is live out at a block.
122 * @param block The block.
123 * @param irn The node to check for.
124 * @return 1, if @p irn is live at the exit of @p block, 0 if not.
126 int (be_is_live_out)(const be_lv_t *lv, const ir_node *block, const ir_node *irn);
129 * Check, if a node is live at the end of a block.
130 * @param block The block.
131 * @param irn The node to check for.
132 * @return 1, if @p irn is live at the end of the block, 0 if not.
134 int (be_is_live_end)(const be_lv_t *lv, const ir_node *block, const ir_node *irn);
137 * Check, if the SSA dominance property is fulfilled.
138 * @param irg The graph.
139 * @return 1 if dominance property is fulfilled, 0 otherwise
141 int be_check_dominance(ir_graph *irg);
144 * The liveness transfer function.
145 * Updates a live set over a single step from a given node to its predecessor.
146 * Everything defined at the node is removed from the set, the uses of the node get inserted.
147 * @param arch_env The architecture environment.
148 * @param cls The register class to consider.
149 * @param irn The node at which liveness should be computed.
150 * @param live The set of nodes live before @p irn. This set gets modified by updating it to
151 * the nodes live after irn.
154 pset *be_liveness_transfer(const arch_env_t *arch_env, const arch_register_class_t *cls, ir_node *irn, pset *live);
157 * Put all node live at the end of a block into a set.
158 * @param arch_env The architecture environment.
159 * @param cls The register class to consider.
160 * @param bl The block.
161 * @param live The set to put them into.
164 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);
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 it's operands maybe not.
170 * @param arch_env The architecture environment.
171 * @param cls The register class to consider.
172 * @param pos The node.
173 * @param live The set to put them into.
176 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);
179 * Compute a set of nodes which are live at another node.
180 * BEWARE: This is the liveness immediately before the node,
181 * so the node itself is not alive but it's operands are.
182 * @param arch_env The architecture environment.
183 * @param cls The register class to consider.
184 * @param pos The node.
185 * @param live The set to put them into.
188 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);
190 #endif /* FIRM_BE_BELIVE_H */