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  *
  93  *  ent is the entity representing this procedure, i.e., the type of the
  94  *  entity must be of a method type.  The constructor automatically sets the
  95  *  field irg of the entity as well as current_ir_graph to the new ir graph.
  96  *  n_loc is the number of local variables in this procedure including
  97  *  the procedure parameters.
  98  *  The constructor adds the new irgraph to the list in ir_prog.
  99  *  The state of the ir graph is:  phase_building, pinned, no_outs. */
 100 ir_graph *new_ir_graph (entity *ent, int n_loc);
 101
 102 /** Frees the passed irgraph.
 103    Deallocates all nodes in this graph and the ir_graph structure.
 104    Sets the field irgraph in the corresponding entity to NULL.
 105    Does not remove the irgraph from the list in irprog (requires
 106    inefficient search, call remove_irp_irg by hand).
 107    Does not free types, entities or modes that are used only by this
 108    graph, nor the entity standing for this graph. */
 109 void free_ir_graph (ir_graph *irg);
 110
 111 /* --- access routines for all ir_graph attributes --- */
 112
 113 /**
 114  *   Checks whether a pointer points to a ir graph.
 115  *
 116  *   @param thing     an arbitrary pointer
 117  *
 118  *   @return
 119  *       true if the thing is a ir graph, else false
 120  */
 121 int
 122 is_ir_graph(void *thing);
 123
 124 #define get_irg_entity get_irg_ent
 125 #define set_irg_entity set_irg_ent
 126 entity  *get_irg_ent (ir_graph *irg);
 127 void     set_irg_ent (ir_graph *irg, entity *ent);
 128
 129 type    *get_irg_frame_type (ir_graph *irg);
 130 void     set_irg_frame_type (ir_graph *irg, type *ftp);
 131 /* To test for a frame type. O(#irgs) if ftp is class type.  */
 132 int      is_frame_type (type *ftp);
 133
 134 ir_node *get_irg_start_block (ir_graph *irg);
 135 void     set_irg_start_block (ir_graph *irg, ir_node *node);
 136
 137 ir_node *get_irg_start (ir_graph *irg);
 138 void     set_irg_start (ir_graph *irg, ir_node *node);
 139
 140 ir_node *get_irg_end_block (ir_graph *irg);
 141 void     set_irg_end_block (ir_graph *irg, ir_node *node);
 142
 143 ir_node *get_irg_end (ir_graph *irg);
 144 void     set_irg_end (ir_graph *irg, ir_node *node);
 145
 146 /* The fields end_reg and end_except contain the end nodes of the
 147    interprocedural view.  If the view is not constructed they contain
 148    the nomal end node. */
 149 ir_node *get_irg_end_reg (ir_graph *irg);
 150 void     set_irg_end_reg (ir_graph *irg, ir_node *node);
 151
 152 ir_node *get_irg_end_except (ir_graph *irg);
 153 void     set_irg_end_except (ir_graph *irg, ir_node *node);
 154
 155
 156 /* @@@ oblivious, no more supported. */
 157 ir_node *get_irg_cstore (ir_graph *irg);
 158 void     set_irg_cstore (ir_graph *irg, ir_node *node);
 159 /* end oblivious */
 160
 161 /* node that represents frame pointer */
 162 ir_node *get_irg_frame (ir_graph *irg);
 163 void     set_irg_frame (ir_graph *irg, ir_node *node);
 164
 165 /* node that represents global pointer */
 166 ir_node *get_irg_globals (ir_graph *irg);
 167 void     set_irg_globals (ir_graph *irg, ir_node *node);
 168
 169 ir_node *get_irg_args (ir_graph *irg);
 170 void     set_irg_args (ir_graph *irg, ir_node *node);
 171
 172 ir_node *get_irg_current_block (ir_graph *irg);
 173 void     set_irg_current_block (ir_graph *irg, ir_node *node);
 174
 175 /* Use new_Bad() instead!! */
 176 ir_node *get_irg_bad (ir_graph *irg);
 177 void     set_irg_bad (ir_graph *irg, ir_node *node);
 178
 179 /* Use new_Unknown() instead!! */
 180 /* GL removed: we need unknown with mode for analyses.
 181 ir_node *get_irg_unknown (ir_graph *irg);
 182 void     set_irg_unknown (ir_graph *irg, ir_node *node);
 183 */
 184
 185 int      get_irg_n_locs (ir_graph *irg);
 186
 187 long     get_irg_graph_nr(ir_graph *irg);
 188
 189 /********************************************************************************/
 190 /* States of an ir_graph.                                                       */
 191 /********************************************************************************/
 192
 193 /*
 194    information associated with the graph.  Optimizations invalidate these
 195    states.  */
 196
 197 /** state: phase values: phase_building, phase_high, phase_low.
 198    The irg is in phase_building during construction of the irgraph.  It is in
 199    phase_high after construction.  All nodes are allowed.  To get the irgraph
 200    into phase_low all Sel nodes must be removed and replaced by explicit
 201    address computations.  SymConst size and typetag nodes must be removed (@@@
 202    really?).  Initialization of memory allocated by Alloc must be explicit.
 203    @@@ More conditions? */
 204 typedef enum {
 205   phase_building,
 206   phase_high,
 207   phase_low
 208 } irg_phase_state;
 209
 210 irg_phase_state get_irg_phase_state (ir_graph *irg);
 211 void set_irg_phase_low(ir_graph *irg);
 212
 213 /* state: pinned
 214    The graph is "pinned" if all nodes are associated with a basic block.
 215    It is in state "floats" if nodes are in arbitrary blocks.  In state
 216    "floats" the block predecessor is set in all nodes, but this can be an
 217    invalid block, i.e., the block is not a dominator of all the uses of
 218    the node.
 219    The enum op_pinned is defined in irop.h. */
 220 op_pinned get_irg_pinned (ir_graph *irg);
 221
 222 /** state: outs_state
 223    Outs are the back edges or def-use edges.
 224    Values:  no_outs, outs_consistent, outs_inconsistent
 225    no_outs: outs are not computed, no memory is allocated.
 226    outs_consistent:  outs are computed and correct,
 227    outs_inconsistent: outs have been computed, memory is still allocated,
 228    but the graph has been changed since. */
 229 typedef enum {
 230   no_outs,
 231   outs_consistent,
 232   outs_inconsistent
 233 } irg_outs_state;
 234 irg_outs_state get_irg_outs_state(ir_graph *irg);
 235 void set_irg_outs_inconsistent(ir_graph *irg);
 236
 237 /** state: dom_state
 238    Signals the state of the dominator infomation.
 239    Values:  no_dom, dom_consistent, dom_inconsistent
 240    no_dom: doms are not computed, no memory is allocated.  The access routines
 241    may not be used.
 242    dom_consistent:  dominator information is computed and correct,
 243    dom_inconsistent: dominator information is computed, memory is still allocated,
 244    but the graph has been changed since. Using the access routines is possible,
 245    obtained information may be incorrect. */
 246 typedef enum {
 247   no_dom,
 248   dom_consistent,
 249   dom_inconsistent
 250 } irg_dom_state;
 251 irg_dom_state get_irg_dom_state(ir_graph *irg);
 252 void set_irg_dom_inconsistent(ir_graph *irg);
 253
 254 /* state: loopinfo_state
 255    Loop information describes the loops within the control and
 256    data flow of the procedure.  */
 257 typedef enum {
 258   loopinfo_none,            /**< No loop information is constructed. Default. */
 259   loopinfo_consistent,      /**< IntRAprocedural loop information constructed and valid. */
 260   loopinfo_inconsistent,    /**< IntRAprocedural loop information constructed and invalid. */
 261   loopinfo_ip_consistent,   /**< IntERprocedural loop information constructed and valid. */
 262   loopinfo_ip_inconsistent, /**< IntERprocedural loop information constructed and invalid. */
 263   loopinfo_cf_consistent,      /**< IntRAprocedural control loop information constructed and valid. */
 264   loopinfo_cf_inconsistent,    /**< IntRAprocedural control loop information constructed and invalid. */
 265   loopinfo_cf_ip_consistent,   /**< IntERprocedural control loop information constructed and valid. */
 266   loopinfo_cf_ip_inconsistent  /**< IntERprocedural control loop information constructed and invalid. */
 267 } irg_loopinfo_state;
 268 irg_loopinfo_state get_irg_loopinfo_state(ir_graph *irg);
 269 void set_irg_loopinfo_state(ir_graph *irg, irg_loopinfo_state s);
 270 /* Sets the loopinformation state to the appropriate inconsistent state.
 271    If state is 'none' does not change. */
 272 void set_irg_loopinfo_inconsistent(ir_graph *irg);
 273
 274
 275 /** state: callee_information_state
 276  *  Call nodes contain a list of possible callees.  This list must be
 277  *  computed by an anlyses.  */
 278 typedef enum {
 279   irg_callee_info_none,
 280   irg_callee_info_consistent,
 281   irg_callee_info_inconsistent
 282 } irg_callee_info_state;
 283 irg_callee_info_state get_irg_callee_info_state(ir_graph *irg);
 284 void set_irg_callee_info_state(ir_graph *irg, irg_callee_info_state s);
 285
 286 /** property:
 287  *  Tells how to handle an ir graph in inlineing.
 288  */
 289 typedef enum {
 290   irg_inline_any,         /**< No restriction on inlineing. Default. */
 291   irg_inline_forbidden,   /**< The graph may not be inlined. */
 292   irg_inline_recomended,  /**< The graph should be inlined. */
 293   irg_inline_forced       /**< The graph must be inlined. */
 294 } irg_inline_property;
 295 irg_inline_property get_irg_inline_property(ir_graph *irg);
 296 void set_irg_inline_property(ir_graph *irg, irg_inline_property s);
 297
 298 /* A void * field to link arbritary information to the node. */
 299 void  set_irg_link (ir_graph *irg, void *thing);
 300 void *get_irg_link (ir_graph *irg);
 301
 302 /* increments visited by one */
 303 void          inc_irg_visited (ir_graph *irg);
 304 unsigned long get_irg_visited (ir_graph *irg);
 305 void          set_irg_visited (ir_graph *irg, unsigned long i);
 306 unsigned long get_max_irg_visited (void);
 307 void          set_max_irg_visited (int val);
 308 unsigned long inc_max_irg_visited (void);
 309
 310 /* increments block_visited by one */
 311 void          inc_irg_block_visited (ir_graph *irg);
 312 unsigned long get_irg_block_visited (ir_graph *irg);
 313 void          set_irg_block_visited (ir_graph *irg, unsigned long i);
 314
 315 # endif /* _IRGRAPH_H_ */