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

   1 /**
   2  * Interblock liveness analysis.
   3  * @author Sebastian Hack
   4  * @date 6.12.2004
   5  */
   6
   7 #ifndef _BELIVE_H
   8 #define _BELIVE_H
   9
  10 #include "firm_types.h"
  11 #include "pset.h"
  12 #include "bearch_t.h"
  13
  14 #include <stdio.h>
  15
  16 typedef enum {
  17         be_lv_state_in  = 1,
  18         be_lv_state_end = 2,
  19         be_lv_state_out = 4,
  20 } be_lv_state_t;
  21
  22 typedef struct _be_lv_t be_lv_t;
  23
  24 typedef struct _be_lv_info_t be_lv_info_t;
  25
  26
  27 /**
  28  * Compute the inter block liveness for a graph.
  29  * @param irg The graph.
  30  */
  31 be_lv_t *be_liveness(ir_graph *irg);
  32
  33 /**
  34  * Check the given liveness information against a freshly computed one.
  35  */
  36 void be_liveness_check(be_lv_t *lv);
  37
  38 /**
  39  * Free the liveness information.
  40  */
  41 void be_liveness_free(be_lv_t *lv);
  42
  43 /**
  44  * Recompute the complete liveness information.
  45  */
  46 void be_liveness_recompute(be_lv_t *lv);
  47
  48 /**
  49  * Update the liveness information for a single node.
  50  * It is irrelevant if there is liveness information present for the node.
  51  * The liveness information for the node is firstly deleted and then recompute.
  52  * So, if the node is fresh and never recorded inf the liveness information
  53  * before, it is more efficient to call be_liveness_introduce().
  54  */
  55 void be_liveness_update(be_lv_t *lv, ir_node *irn);
  56
  57 /**
  58  * Remove a node from the liveness information.
  59  */
  60 void be_liveness_remove(be_lv_t *lv, ir_node *irn);
  61
  62 /**
  63  * Introduce a new node to the liveness information.
  64  * The new irn is not deleted from any block's liveness information, so it must be fresh!
  65  * @param lv The liveness info.
  66  * @param irn The node.
  67  */
  68 void be_liveness_introduce(be_lv_t *lv, ir_node *irn);
  69
  70 /**
  71  * Dump the liveness information for a graph.
  72  * @param f The output.
  73  * @param irg The graph.
  74  */
  75 void be_liveness_dump(const be_lv_t *lv, FILE *f);
  76
  77 /**
  78  * Dump the liveness information for a graph.
  79  * @param irg The graph.
  80  * @param cls_name A string used as substring in the filename.
  81  */
  82 void be_liveness_dumpto(const be_lv_t *lv, const char *cls_name);
  83
  84 /**
  85  * Check, if a node is live in at a block.
  86  * @param block The block.
  87  * @param irn The node to check for.
  88  * @return 1, if @p irn is live at the entrance of @p block, 0 if not.
  89  */
  90 int (be_is_live_in)(const be_lv_t *lv, const ir_node *block, const ir_node *irn);
  91
  92 /**
  93  * Check, if a node is live out at a block.
  94  * @param block The block.
  95  * @param irn The node to check for.
  96  * @return 1, if @p irn is live at the exit of @p block, 0 if not.
  97  */
  98 int (be_is_live_out)(const be_lv_t *lv, const ir_node *block, const ir_node *irn);
  99
 100 /**
 101  * Check, if a node is live at the end of a block.
 102  * @param block The block.
 103  * @param irn The node to check for.
 104  * @return 1, if @p irn is live at the end of the block, 0 if not.
 105  */
 106 int (be_is_live_end)(const be_lv_t *lv, const ir_node *block, const ir_node *irn);
 107
 108 /**
 109  * Check, if the SSA dominance property is fulfilled.
 110  * @param irg The graph.
 111  */
 112 void be_check_dominance(ir_graph *irg);
 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 arch_env The architecture environment.
 119  * @param cls      The register class to consider.
 120  * @param irn      The node at which liveness should be computed.
 121  * @param live     The set of nodes live before @p irn. This set gets modified by updating it to
 122  *                 the nodes live after irn.
 123  * @return live.
 124  */
 125 pset *be_liveness_transfer(const arch_env_t *arch_env, const arch_register_class_t *cls, ir_node *irn, pset *live);
 126
 127 /**
 128  * Put all node live at the end of a block into a set.
 129  * @param arch_env The architecture environment.
 130  * @param cls      The register class to consider.
 131  * @param bl       The block.
 132  * @param live     The set to put them into.
 133  * @return live.
 134  */
 135 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);
 136
 137 /**
 138  * Compute a set of nodes which are live at another node.
 139  * @param arch_env The architecture environment.
 140  * @param cls      The register class to consider.
 141  * @param pos      The node.
 142  * @param live     The set to put them into.
 143  * @return live.
 144  */
 145 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);
 146
 147 #endif /* _BELIVE_H */