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

   1 /*
   2  * Copyright (C) 1995-2008 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  */
  26 #ifndef FIRM_BE_BELIVE_H
  27 #define FIRM_BE_BELIVE_H
  28
  29 #include "be_types.h"
  30 #include "irnodeset.h"
  31
  32 typedef enum {
  33         be_lv_state_none = 0,
  34         be_lv_state_in   = 1,
  35         be_lv_state_end  = 2,
  36         be_lv_state_out  = 4,
  37 } be_lv_state_t;
  38 ENUM_BITSET(be_lv_state_t)
  39
  40 /**
  41  * Compute the inter block liveness for a graph.
  42  * @param irg The graph.
  43  */
  44 be_lv_t *be_liveness_new(ir_graph *irg);
  45
  46 /**
  47  * Free the liveness information.
  48  */
  49 void be_liveness_free(be_lv_t *lv);
  50
  51 /**
  52  * (Re)compute the liveness information if necessary.
  53  */
  54 void be_liveness_compute_sets(be_lv_t *lv);
  55 void be_liveness_compute_chk(be_lv_t *lv);
  56
  57 /**
  58  * Invalidate the liveness information.
  59  * You must call this if you modify the program and do not
  60  * update the liveness with the be_liveness_{update,remove,introduce}
  61  * functions.
  62  * @note If changed the control flow then you must also call
  63  *       be_liveness_invalidate_chk()
  64  */
  65 void be_liveness_invalidate_sets(be_lv_t *lv);
  66 void be_liveness_invalidate_chk(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, const 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  * Check, if a node is live in at a block.
  92  * @param block The block.
  93  * @param irn The node to check for.
  94  * @return 1, if @p irn is live at the entrance of @p block, 0 if not.
  95  */
  96 int (be_is_live_in)(const be_lv_t *lv, const ir_node *block, const ir_node *irn);
  97
  98 /**
  99  * Check, if a node is live out at a block.
 100  * @param block The block.
 101  * @param irn The node to check for.
 102  * @return 1, if @p irn is live at the exit of @p block, 0 if not.
 103  */
 104 int (be_is_live_out)(const be_lv_t *lv, const ir_node *block, const ir_node *irn);
 105
 106 /**
 107  * Check, if a node is live at the end of a block.
 108  * @param block The block.
 109  * @param irn The node to check for.
 110  * @return 1, if @p irn is live at the end of the block, 0 if not.
 111  */
 112 int (be_is_live_end)(const be_lv_t *lv, const ir_node *block, const ir_node *irn);
 113
 114 /**
 115  * The liveness transfer function.
 116  * Updates a live set over a single step from a given node to its predecessor.
 117  * Everything defined at the node is removed from the set, the uses of the node get inserted.
 118  * @param cls      The register class to consider.
 119  * @param irn      The node at which liveness should be computed.
 120  * @param live     The set of nodes live before @p irn. This set gets modified by updating it to
 121  *                 the nodes live after irn.
 122  * @return live.
 123  */
 124 void be_liveness_transfer(const arch_register_class_t *cls, ir_node *node,
 125                           ir_nodeset_t *nodeset);
 126
 127 /**
 128  * Put all node live at the end of a block into a set.
 129  * @param cls      The register class to consider.
 130  * @param bl       The block.
 131  * @param live     The set to put them into.
 132  * @return live.
 133  */
 134 void be_liveness_end_of_block(const be_lv_t *lv,
 135                               const arch_register_class_t *cls,
 136                               const ir_node *bl, ir_nodeset_t *nodeset);
 137
 138 /**
 139  * Compute a set of nodes which are live just before the given node.
 140  * @param cls      The register class to consider.
 141  * @param pos      The node.
 142  * @param live     The set to put them into.
 143  */
 144 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);
 145
 146 #endif