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

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