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
26 #ifndef FIRM_BE_BELIVE_H
27 #define FIRM_BE_BELIVE_H
30 #include "irnodeset.h"
39 * Compute the inter block liveness for a graph.
40 * @param irg The graph.
42 be_lv_t *be_liveness_new(ir_graph *irg);
45 * Free the liveness information.
47 void be_liveness_free(be_lv_t *lv);
50 * (Re)compute the liveness information if necessary.
52 void be_liveness_compute_sets(be_lv_t *lv);
53 void be_liveness_compute_chk(be_lv_t *lv);
56 * Invalidate the liveness information.
57 * You must call this if you modify the program and do not
58 * update the liveness with the be_liveness_{update,remove,introduce}
60 * @note If changed the control flow then you must also call
61 * be_liveness_invalidate_chk()
63 void be_liveness_invalidate_sets(be_lv_t *lv);
64 void be_liveness_invalidate_chk(be_lv_t *lv);
67 * Update the liveness information for a single node.
68 * It is irrelevant if there is liveness information present for the node.
69 * The liveness information for the node is firstly deleted and then recomputed.
70 * If the node is fresh and never recorded inf the liveness information before,
71 * it is more efficient to call be_liveness_introduce().
73 void be_liveness_update(be_lv_t *lv, ir_node *irn);
76 * Remove a node from the liveness information.
78 void be_liveness_remove(be_lv_t *lv, const ir_node *irn);
81 * Introduce a new node to the liveness information.
82 * The new irn is not deleted from any block's liveness information, so it must be fresh!
83 * @param lv The liveness info.
84 * @param irn The node.
86 void be_liveness_introduce(be_lv_t *lv, ir_node *irn);
89 * Add all nodes which are missing in the current liveness data.
90 * The liveness data of the already existing nodes (in the liveness data) is not touched.
91 * @param The liveness info.
93 void be_liveness_add_missing(be_lv_t *lv);
96 * Check, if a node is live in at a block.
97 * @param block The block.
98 * @param irn The node to check for.
99 * @return 1, if @p irn is live at the entrance of @p block, 0 if not.
101 int (be_is_live_in)(const be_lv_t *lv, const ir_node *block, const ir_node *irn);
104 * Check, if a node is live out at a block.
105 * @param block The block.
106 * @param irn The node to check for.
107 * @return 1, if @p irn is live at the exit of @p block, 0 if not.
109 int (be_is_live_out)(const be_lv_t *lv, const ir_node *block, const ir_node *irn);
112 * Check, if a node is live at the end of 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 end of the block, 0 if not.
117 int (be_is_live_end)(const be_lv_t *lv, const ir_node *block, const ir_node *irn);
120 * The liveness transfer function.
121 * Updates a live set over a single step from a given node to its predecessor.
122 * Everything defined at the node is removed from the set, the uses of the node get inserted.
123 * @param cls The register class to consider.
124 * @param irn The node at which liveness should be computed.
125 * @param live The set of nodes live before @p irn. This set gets modified by updating it to
126 * the nodes live after irn.
129 void be_liveness_transfer(const arch_register_class_t *cls, ir_node *node,
130 ir_nodeset_t *nodeset);
133 * Put all node live at the end of a block into a set.
134 * @param cls The register class to consider.
135 * @param bl The block.
136 * @param live The set to put them into.
139 void be_liveness_end_of_block(const be_lv_t *lv,
140 const arch_register_class_t *cls,
141 const ir_node *bl, ir_nodeset_t *nodeset);
144 * Compute a set of nodes which are live just before the given node.
145 * @param cls The register class to consider.
146 * @param pos The node.
147 * @param live The set to put them into.
149 void be_liveness_nodes_live_before(be_lv_t const *lv, arch_register_class_t const *cls, ir_node const *pos, ir_nodeset_t *live);