nsz Git - libfirm/blob - ir/ir/irgraph.h

   1 /* Copyright (C) 1998 - 2000 by Universitaet Karlsruhe
   2 ** All rights reserved.
   3 **
   4 ** Authors: Martin Trapp, Christian Schaefer
   5 **
   6 ** irgraph.h: ir graph construction
   7 */
   8
   9 /* $Id$ */
  10
  11 #include "irop.h"
  12
  13 # ifndef _IRGRAPH_H_
  14 # define _IRGRAPH_H_
  15 # include "tv.h"
  16
  17 /* to resolve recursion between irnode.h and irgraph.h */
  18 #ifndef _IR_NODE_TYPEDEF_
  19 #define _IR_NODE_TYPEDEF_
  20 typedef struct ir_node ir_node;
  21 #endif
  22
  23 /* to resolve recursion between entity.h and irgraph.h */
  24 #ifndef _IR_GRAPH_TYPEDEF_
  25 #define _IR_GRAPH_TYPEDEF_
  26 typedef struct ir_graph ir_graph;
  27 #endif
  28
  29 /***** irgraph/irgraph
  30  *
  31  * NAME  Datastructure that holds central information about a procedure
  32  *
  33  * NOTE
  34  **    ir_graph *new_ir_graph (entity *ent, int params);
  35  *    -------------------------------------------------
  36  *
  37  *    This constructor generates the basic infrastructure needed to
  38  *    represent a procedure in FIRM.
  39  *
  40  *    The parameters of new_ir_graph are:
  41  *
  42  *      *ent             A pointer to an entity representing the procedure.
  43  *
  44  *      params           An integer giving the number of local variables in the
  45  *                       procedure.
  46  *
  47  *    It allocates an ir_graph and sets current_ir_graph to point to this
  48  *    graph.  Further it allocates the following nodes needed for every
  49  *    procedure:
  50  *
  51  *    * The start block containing a start node and Proj nodes for it's
  52  *      five results (X, M, P, P, T).
  53  *    * The end block containing an end node. This block is not matured
  54  *      after executing new_ir_graph as predecessors need to be added to it.
  55  *      (Maturing a block means fixing it's number of predecessors.)
  56  *    * The current block, which is empty and also not matured.
  57  *
  58  *    Further it enters the global store into the datastructure of the start
  59  *    block that contanis all valid values in this block (set_store()).  This
  60  *    datastructure is used to build the Phi nodes and removed after
  61  *    completion of the graph.  There is no path from end to start in the
  62  *    graph after calling ir_graph.
  63  * FIELDS
  64  *   pinned    set to "pinned" if no global cse was performed on the graph.
  65  *             set to "floats" if global cse was performed (and during construction:
  66  *             did actually change something).  Code placement is necessary.
  67  * SOURCE
  68  */
  69
  70 /* Global variable holding the current_ir_graph.  This global variable
  71    is used by the ir construction interface in ircons and by the
  72    optimizations. */
  73 extern ir_graph *current_ir_graph;
  74
  75 /* This flag indicate the current view. The behaviour of some methods
  76  * (get_irn_*, set_irn_*) is influenced by this flag. */
  77 extern bool interprocedural_view;
  78
  79 /* Create a new ir graph to built ir for a procedure.
  80    ent is the entity representing this procedure, i.e., the type of the
  81    entity must be of a method type.  The constructor automatically sets the
  82    field irg of the entity as well as current_ir_graph to the new ir graph.
  83    n_loc is the number of local variables in this procedure including
  84    the procedure parameters.
  85    The state of the ir graph is:  phase_building, pinned, no_outs. */
  86 ir_graph *new_ir_graph (entity *ent, int n_loc);
  87
  88 /* Frees the passed irgraph.
  89    Deallocates all nodes in this graph and the ir_graph structure.
  90    Sets the field irgraph in the corresponding entity to NULL.
  91    Does not remove the irgraph from the list in irprog (requires
  92    inefficient search, call remove_irp_irg by hand).
  93    Does not free types, entities or modes that are used only by this
  94    graph, nor the entity standing for this graph. */
  95 void free_ir_graph (ir_graph *irg);
  96
  97 /** access routines for all ir_graph attributes **/
  98 entity  *get_irg_ent (ir_graph *irg);
  99 void     set_irg_ent (ir_graph *irg, entity *ent);
 100
 101 type    *get_irg_frame_type (ir_graph *irg);
 102 void     set_irg_frame_type (ir_graph *irg, type *ftp);
 103 /* To test for a frame type */
 104 int      is_frame_type(type *ftp);
 105
 106 ir_node *get_irg_start_block (ir_graph *irg);
 107 void     set_irg_start_block (ir_graph *irg, ir_node *node);
 108
 109 ir_node *get_irg_start (ir_graph *irg);
 110 void     set_irg_start (ir_graph *irg, ir_node *node);
 111
 112 ir_node *get_irg_end_block (ir_graph *irg);
 113 void     set_irg_end_block (ir_graph *irg, ir_node *node);
 114
 115 ir_node *get_irg_end (ir_graph *irg);
 116 void     set_irg_end (ir_graph *irg, ir_node *node);
 117
 118 /* @@@ oblivious, no more supported. */
 119 ir_node *get_irg_cstore (ir_graph *irg);
 120 void     set_irg_cstore (ir_graph *irg, ir_node *node);
 121
 122 ir_node *get_irg_frame (ir_graph *irg);
 123 void     set_irg_frame (ir_graph *irg, ir_node *node);
 124
 125 ir_node *get_irg_globals (ir_graph *irg);
 126 void     set_irg_globals (ir_graph *irg, ir_node *node);
 127
 128 ir_node *get_irg_args (ir_graph *irg);
 129 void     set_irg_args (ir_graph *irg, ir_node *node);
 130
 131 ir_node *get_irg_current_block (ir_graph *irg);
 132 void     set_irg_current_block (ir_graph *irg, ir_node *node);
 133
 134 /* Use new_Bad() instead!! */
 135 ir_node *get_irg_bad (ir_graph *irg);
 136 void     set_irg_bad (ir_graph *irg, ir_node *node);
 137
 138 /* Use new_Unknown() instead!! */
 139 ir_node *get_irg_unknown (ir_graph *irg);
 140 void     set_irg_unknown (ir_graph *irg, ir_node *node);
 141
 142 int      get_irg_n_locs (ir_graph *irg);
 143
 144 /********************************************************************************/
 145 /* States of an ir_graph.                                                       */
 146 /********************************************************************************/
 147
 148 /** An ir_graph can have different states.  These states represent the analysis
 149    information associated with the graph.  Optimizations invalidate these
 150    states.  **/
 151
 152 /* state: phase values: phase_building, phase_high, phase_low.
 153    The irg is in phase_building during construction of the irgraph.  It is in
 154    phase_high after construction.  All nodes are allowed.  To get the irgraph
 155    into phase_low all Sel nodes must be removed and replaced by explicit
 156    address computations.  SymConst size and typetag nodes must be removed (@@@
 157    really?).  Initialization of memory allocated by Alloc must be explicit.
 158    @@@ More conditions? */
 159 typedef enum {
 160   phase_building,
 161   phase_high,
 162   phase_low
 163 } irg_phase_state;
 164 irg_phase_state get_irg_phase_state (ir_graph *irg);
 165 void set_irg_phase_low(ir_graph *irg);
 166
 167 /* state: pinned
 168    The graph is "pinned" if all nodes are associated with a basic block.
 169    It is in state "floats" if nodes are in arbitrary blocks.  In state
 170    "floats" the block predecessor is set in all nodes, but this can be an
 171    invalid block, i.e., the block is not a dominator of all the uses of
 172    the node.
 173    The enum op_pinned is defined in irop.h. */
 174 op_pinned get_irg_pinned (ir_graph *irg);
 175
 176 /* state: outs_state
 177    Outs are the back edges or def-use edges.
 178    Values:  no_outs, outs_consistent, outs_inconsistent
 179    no_outs: outs are not computed, no memory is allocated.
 180    outs_consistent:  outs are computed and correct,
 181    outs_inconsistent: outs have been computed, memory is still allocated,
 182    but the graph has been changed since. */
 183 typedef enum {
 184   no_outs,
 185   outs_consistent,
 186   outs_inconsistent
 187 } irg_outs_state;
 188 irg_outs_state get_irg_outs_state(ir_graph *irg);
 189 void set_irg_outs_inconsistent(ir_graph *irg);
 190
 191 /* state: dom_state
 192    Signals the state of the dominator infomation.
 193    Values:  no_dom, dom_consistent, dom_inconsistent
 194    no_dom: doms are not computed, no memory is allocated.  The access routines
 195    may not be used.
 196    dom_consistent:  dominator information is computed and correct,
 197    dom_inconsistent: dominator information is computed, memory is still allocated,
 198    but the graph has been changed since. Using the access routines is possible,
 199    obtained information may be incorrect. */
 200 typedef enum {
 201   no_dom,
 202   dom_consistent,
 203   dom_inconsistent
 204 } irg_dom_state;
 205 irg_dom_state get_irg_dom_state(ir_graph *irg);
 206 void set_irg_dom_inconsistent(ir_graph *irg);
 207
 208 /* state: loopinfo_state
 209    Loop information describes the loops within the control and
 210    data flow of the procedure.
 211 typedef enum {
 212   no_loopinfo,
 213   loopinfo_consistent,
 214   loopinfo_inconsistent
 215 } irg_loopinfo_state;
 216 irg_loopinfo_state get_irg_loopinfo_state(ir_graph *irg);
 217 void set_irg_loopinfo_inconsistent(ir_graph *irg);
 218 */
 219
 220 /* A void * field to link arbritary information to the node. */
 221 void set_irg_link (ir_graph *irg, void *thing);
 222 void *get_irg_link (ir_graph *irg);
 223
 224 /* increments visited by one */
 225 void     inc_irg_visited(ir_graph *irg);
 226 unsigned long get_irg_visited (ir_graph *irg);
 227 void     set_irg_visited(ir_graph *irg, unsigned long i);
 228 unsigned long get_max_irg_visited(void);
 229 unsigned long inc_max_irg_visited(void);
 230
 231 /* increments block_visited by one */
 232 void     inc_irg_block_visited(ir_graph *irg);
 233 unsigned long get_irg_block_visited (ir_graph *irg);
 234 void     set_irg_block_visited(ir_graph *irg, unsigned long i);
 235 /*****/
 236
 237 # endif /* _IRGRAPH_H_ */