nsz Git - libfirm/blob - ir/be/belive.h

   1 /*
   2  * Copyright (C) 1995-2007 University of Karlsruhe.  All right reserved.
   3  *
   4  * This file is part of libFirm.
   5  *
   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.
  10  *
  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.
  14  *
  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
  17  * PURPOSE.
  18  */
  19
  20 /**
  21  * @file
  22  * @brief       Interblock liveness analysis.
  23  * @author      Sebastian Hack
  24  * @date        06.12.2004
  25  * @version     $Id$
  26  */
  27 #ifndef FIRM_BE_BELIVE_H
  28 #define FIRM_BE_BELIVE_H
  29
  30 #include <stdio.h>
  31
  32 #include "firm_types.h"
  33 #include "pset.h"
  34
  35 #include "irlivechk.h"
  36 #include "bearch.h"
  37 #include "irnodeset.h"
  38
  39 typedef enum {
  40         be_lv_state_in  = 1,
  41         be_lv_state_end = 2,
  42         be_lv_state_out = 4,
  43 } be_lv_state_t;
  44
  45 typedef struct _be_lv_t be_lv_t;
  46
  47 typedef struct _be_lv_info_t be_lv_info_t;
  48
  49 /**
  50  * Compute the inter block liveness for a graph.
  51  * @param irg The graph.
  52  */
  53 be_lv_t *be_liveness(ir_graph *irg);
  54
  55 /**
  56  * Check the given liveness information against a freshly computed one.
  57  */
  58 void be_liveness_check(be_lv_t *lv);
  59
  60 /**
  61  * Free the liveness information.
  62  */
  63 void be_liveness_free(be_lv_t *lv);
  64
  65 /**
  66  * Recompute the complete liveness information.
  67  */
  68 void be_liveness_recompute(be_lv_t *lv);
  69
  70 /**
  71  * Update the liveness information for a single node.
  72  * It is irrelevant if there is liveness information present for the node.
  73  * The liveness information for the node is firstly deleted and then recomputed.
  74  * If the node is fresh and never recorded inf the liveness information before,
  75  * it is more efficient to call be_liveness_introduce().
  76  */
  77 void be_liveness_update(be_lv_t *lv, ir_node *irn);
  78
  79 /**
  80  * Remove a node from the liveness information.
  81  */
  82 void be_liveness_remove(be_lv_t *lv, ir_node *irn);
  83
  84 /**
  85  * Introduce a new node to the liveness information.
  86  * The new irn is not deleted from any block's liveness information, so it must be fresh!
  87  * @param lv The liveness info.
  88  * @param irn The node.
  89  */
  90 void be_liveness_introduce(be_lv_t *lv, ir_node *irn);
  91
  92 /**
  93  * Add all nodes which are missing in the current liveness data.
  94  * The liveness data of the already existing nodes (in the liveness data) is not touched.
  95  * @param The liveness info.
  96  */
  97 void be_liveness_add_missing(be_lv_t *lv);
  98
  99 /**
 100  * Dump the liveness information for a graph.
 101  * @param f The output.
 102  * @param irg The graph.
 103  */
 104 void be_liveness_dump(const be_lv_t *lv, FILE *f);
 105
 106 /**
 107  * Dump the liveness information for a graph.
 108  * @param irg The graph.
 109  * @param cls_name A string used as substring in the filename.
 110  */
 111 void be_liveness_dumpto(const be_lv_t *lv, const char *cls_name);
 112
 113 /**
 114  * Check, if a node is live in at a block.
 115  * @param block The block.
 116  * @param irn The node to check for.
 117  * @return 1, if @p irn is live at the entrance of @p block, 0 if not.
 118  */
 119 int (be_is_live_in)(const be_lv_t *lv, const ir_node *block, const ir_node *irn);
 120
 121 /**
 122  * Check, if a node is live out at a block.
 123  * @param block The block.
 124  * @param irn The node to check for.
 125  * @return 1, if @p irn is live at the exit of @p block, 0 if not.
 126  */
 127 int (be_is_live_out)(const be_lv_t *lv, const ir_node *block, const ir_node *irn);
 128
 129 /**
 130  * Check, if a node is live at the end of a block.
 131  * @param block The block.
 132  * @param irn The node to check for.
 133  * @return 1, if @p irn is live at the end of the block, 0 if not.
 134  */
 135 int (be_is_live_end)(const be_lv_t *lv, const ir_node *block, const ir_node *irn);
 136
 137 /**
 138  * Check, if the SSA dominance property is fulfilled.
 139  * @param irg The graph.
 140  * @return   1 if dominance property is fulfilled, 0 otherwise
 141  */
 142 int be_check_dominance(ir_graph *irg);
 143
 144 /**
 145  * The liveness transfer function.
 146  * Updates a live set over a single step from a given node to its predecessor.
 147  * Everything defined at the node is removed from the set, the uses of the node get inserted.
 148  * @param arch_env The architecture environment.
 149  * @param cls      The register class to consider.
 150  * @param irn      The node at which liveness should be computed.
 151  * @param live     The set of nodes live before @p irn. This set gets modified by updating it to
 152  *                 the nodes live after irn.
 153  * @return live.
 154  */
 155 pset *be_liveness_transfer(const arch_env_t *arch_env, const arch_register_class_t *cls, ir_node *irn, pset *live);
 156
 157 void be_liveness_transfer_ir_nodeset(const arch_env_t *arch_env, const arch_register_class_t *cls, ir_node *node, ir_nodeset_t *nodeset);
 158
 159 /**
 160  * Put all node live at the end of a block into a set.
 161  * @param arch_env The architecture environment.
 162  * @param cls      The register class to consider.
 163  * @param bl       The block.
 164  * @param live     The set to put them into.
 165  * @return live.
 166  */
 167 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);
 168
 169 void be_liveness_end_of_block_ir_nodeset(const be_lv_t *lv, const arch_env_t *arch_env, const arch_register_class_t *cls, const ir_node *bl, ir_nodeset_t *nodeset);
 170
 171 /**
 172  * Compute a set of nodes which are live at another node.
 173  * BEWARE: This is the liveness immediately after the node,
 174  *         so the node itself is alive but it's operands maybe not.
 175  * @param arch_env The architecture environment.
 176  * @param cls      The register class to consider.
 177  * @param pos      The node.
 178  * @param live     The set to put them into.
 179  * @return live.
 180  */
 181 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);
 182
 183 /**
 184  * Compute a set of nodes which are live at another node.
 185  * BEWARE: This is the liveness immediately before the node,
 186  *         so the node itself is not alive but it's operands are.
 187  * @param arch_env The architecture environment.
 188  * @param cls      The register class to consider.
 189  * @param pos      The node.
 190  * @param live     The set to put them into.
 191  * @return live.
 192  */
 193 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);
 194
 195
 196 #endif /* FIRM_BE_BELIVE_H */