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

   1 /*
   2  * Project:     libFIRM
   3  * File name:   ir/ir/irgraph.c
   4  * Purpose:     Entry point to the representation of procedure code -- internal header.
   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_t.h
  15 *
  16 * ir graph construction.
  17 *
  18 * @author Martin Trapp, Christian Schaefer
  19 */
  20
  21
  22 # ifndef _IRGRAPH_T_H_
  23 # define _IRGRAPH_T_H_
  24 # include "obst.h"
  25 # include "pset.h"
  26 # include "irgraph.h"
  27 # include "firm_common_t.h"
  28 # include "irtypeinfo.h"
  29
  30 #define FRAME_TP_SUFFIX "frame_tp"
  31
  32 /** ir_graph holds all information for a procedure */
  33 struct ir_graph {
  34   firm_kind         kind;            /**<  always set to k_ir_graph*/
  35   /* --  Basics of the representation -- */
  36   struct entity  *ent;               /**< The entity of this procedure, i.e.,
  37                                         the type of the procedure and the
  38                                         class it belongs to. */
  39   struct type    *frame_type;        /**< A class type representing the stack frame.
  40                                         Can include "inner" methods. */
  41   struct ir_node *start_block;       /**< block the start node will belong to */
  42   struct ir_node *start;             /**< start node of this ir_graph */
  43   struct ir_node *end_block;         /**< block the end node will belong to */
  44   struct ir_node *end;               /**< end node of this ir_graph */
  45   struct ir_node *cstore;            /**< constant store -- no more needed!! */
  46   struct ir_node *frame;             /**< method's frame */
  47   struct ir_node *globals;           /**< pointer to the data segment containing all
  48                                         globals as well as global procedures. */
  49   struct ir_node *args;              /**< methods arguments */
  50   struct ir_node *bad;               /**< bad node of this ir_graph, the one and
  51                                         only in this graph */
  52   struct ir_node *unknown;           /**< unknown node of this ir_graph */
  53   struct obstack *obst;              /**< obstack where all of the ir_nodes live */
  54   struct ir_node *current_block;     /**< block for newly gen_*()-erated
  55                                         ir_nodes */
  56
  57   /* -- Fields indicating different states of irgraph -- */
  58   irg_phase_state phase_state;       /**< compiler phase */
  59   op_pinned pinned;                  /**< Flag for status of nodes */
  60   irg_outs_state outs_state;         /**< Out edges. */
  61   irg_dom_state dom_state;           /**< Dominator information */
  62   irg_typeinfo_state typeinfo_state; /**< Validity of type inforamtion */
  63
  64   /* -- Fields for construction -- */
  65 #if USE_EXPLICIT_PHI_IN_STACK
  66   struct Phi_in_stack *Phi_in_stack; /**< needed for automatic Phi construction */
  67 #endif
  68   int n_loc;                         /**< number of local variable in this
  69                                         procedure including procedure parameters. */
  70
  71   /* -- Fields for optimizations / analysis information -- */
  72   pset *value_table;                 /**< hash table for global value numbering (cse)
  73                                         for optimizing use in iropt.c */
  74   struct ir_node **outs;             /**< Space for the out arrays. */
  75   struct ir_loop *loop;              /**< The outermost loop */
  76   void *link;                        /**< A void* field to link any information to
  77                                         the node. */
  78
  79   /* -- Fields for Walking the graph -- */
  80   unsigned long visited;             /**< this flag is an identifier for
  81                                         ir walk. it will be incremented
  82                                         every time someone walks through
  83                                         the graph */
  84   unsigned long block_visited;       /**< same as visited, for a complete block */
  85 #ifdef DEBUG_libfirm
  86   int graph_nr;             /**< a unique graph number for each graph to make output
  87                               readable. */
  88 #endif
  89 };
  90
  91 void init_irgraph(void);
  92
  93 /** Make a rudimentary ir graph for the constant code.
  94    Must look like a correct irg, spare everything else. */
  95 ir_graph *new_const_code_irg(void);
  96
  97 /**
  98  * Set the pinned state of a graph.
  99  *
 100  * @irg         the IR graph
 101  * @p           new pin state
 102  */
 103 INLINE void
 104 set_irg_pinned (ir_graph *irg, op_pinned p);
 105
 106 /** Returns the obstack associated with the graph. */
 107 struct obstack *get_irg_obstack(ir_graph *irg);
 108
 109 /**
 110  * Returns true if the node n is allocated on the storage of graph irg.
 111  *
 112  * @param irg   the IR graph
 113  * @param n     the IR node
 114  */
 115 int node_is_in_irgs_storage(ir_graph *irg, ir_node *n);
 116
 117 # endif /* _IRGRAPH_T_H_ */