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 "bearch.h"
  36
  37 typedef enum {
  38         be_lv_state_in  = 1,
  39         be_lv_state_end = 2,
  40         be_lv_state_out = 4,
  41 } be_lv_state_t;
  42
  43 typedef struct _be_lv_t be_lv_t;
  44
  45 typedef struct _be_lv_info_t be_lv_info_t;
  46
  47 /**
  48  * Compute the inter block liveness for a graph.
  49  * @param irg The graph.
  50  */
  51 be_lv_t *be_liveness(ir_graph *irg);
  52
  53 /**
  54  * Check the given liveness information against a freshly computed one.
  55  */
  56 void be_liveness_check(be_lv_t *lv);
  57
  58 /**
  59  * Free the liveness information.
  60  */
  61 void be_liveness_free(be_lv_t *lv);
  62
  63 /**
  64  * Recompute the complete liveness information.
  65  */
  66 void be_liveness_recompute(be_lv_t *lv);
  67
  68 /**
  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().
  74  */
  75 void be_liveness_update(be_lv_t *lv, ir_node *irn);
  76
  77 /**
  78  * Remove a node from the liveness information.
  79  */
  80 void be_liveness_remove(be_lv_t *lv, ir_node *irn);
  81
  82 /**
  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.
  87  */
  88 void be_liveness_introduce(be_lv_t *lv, ir_node *irn);
  89
  90 /**
  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.
  94  */
  95 void be_liveness_add_missing(be_lv_t *lv);
  96
  97 /**
  98  * Dump the liveness information for a graph.
  99  * @param f The output.
 100  * @param irg The graph.
 101  */
 102 void be_liveness_dump(const be_lv_t *lv, FILE *f);
 103
 104 /**
 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.
 108  */
 109 void be_liveness_dumpto(const be_lv_t *lv, const char *cls_name);
 110
 111 /**
 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.
 116  */
 117 int (be_is_live_in)(const be_lv_t *lv, const ir_node *block, const ir_node *irn);
 118
 119 /**
 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.
 124  */
 125 int (be_is_live_out)(const be_lv_t *lv, const ir_node *block, const ir_node *irn);
 126
 127 /**
 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.
 132  */
 133 int (be_is_live_end)(const be_lv_t *lv, const ir_node *block, const ir_node *irn);
 134
 135 /**
 136  * Check, if the SSA dominance property is fulfilled.
 137  * @param irg The graph.
 138  * @return   1 if dominance property is fulfilled, 0 otherwise
 139  */
 140 int be_check_dominance(ir_graph *irg);
 141
 142 /**
 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 arch_env The architecture environment.
 147  * @param cls      The register class to consider.
 148  * @param irn      The node at which liveness should be computed.
 149  * @param live     The set of nodes live before @p irn. This set gets modified by updating it to
 150  *                 the nodes live after irn.
 151  * @return live.
 152  */
 153 pset *be_liveness_transfer(const arch_env_t *arch_env, const arch_register_class_t *cls, ir_node *irn, pset *live);
 154
 155 /**
 156  * Put all node live at the end of a block into a set.
 157  * @param arch_env The architecture environment.
 158  * @param cls      The register class to consider.
 159  * @param bl       The block.
 160  * @param live     The set to put them into.
 161  * @return live.
 162  */
 163 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);
 164
 165 /**
 166  * Compute a set of nodes which are live at another node.
 167  * BEWARE: This is the liveness immediately after the node,
 168  *         so the node itself is alive but it's operands maybe not.
 169  * @param arch_env The architecture environment.
 170  * @param cls      The register class to consider.
 171  * @param pos      The node.
 172  * @param live     The set to put them into.
 173  * @return live.
 174  */
 175 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);
 176
 177 /**
 178  * Compute a set of nodes which are live at another node.
 179  * BEWARE: This is the liveness immediately before the node,
 180  *         so the node itself is not alive but it's operands are.
 181  * @param arch_env The architecture environment.
 182  * @param cls      The register class to consider.
 183  * @param pos      The node.
 184  * @param live     The set to put them into.
 185  * @return live.
 186  */
 187 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);
 188
 189 #endif /* FIRM_BE_BELIVE_H */