Removed ANNOUNCE macro
[libfirm] / ir / ir / irgraph_t.h
index 9b2dd1a..ef1f544 100644 (file)
@@ -3,22 +3,18 @@
  * File name:   ir/ir/irgraph.c
  * Purpose:     Entry point to the representation of procedure code -- internal header.
  * Author:      Martin Trapp, Christian Schaefer
- * Modified by: Goetz Lindenmaier
+ * Modified by: Goetz Lindenmaier, Michael Beck
  * Created:
  * CVS-ID:      $Id$
- * Copyright:   (c) 1998-2003 Universität Karlsruhe
+ * Copyright:   (c) 1998-2007 Universität Karlsruhe
  * Licence:     This file protected by GPL -  GNU GENERAL PUBLIC LICENSE.
  */
 
 /**
  * @file irgraph_t.h
  *
- * ir graph construction.
- *
- * @author Martin Trapp, Christian Schaefer
+ * IR graph construction.
  */
-
-
 #ifndef _IRGRAPH_T_H_
 #define _IRGRAPH_T_H_
 
@@ -33,6 +29,8 @@
 #include "entity_t.h"
 #include "typegmod.h"
 #include "tr_inheritance.h"
+#include "iredgekinds.h"
+#include "irmemory.h"
 
 #include "irloop.h"
 #include "execution_frequency.h"
 #include "pset.h"
 #include "set.h"
 
+/** Prefix that is added to every frame type. */
 #define FRAME_TP_SUFFIX "frame_tp"
 
 /**
  * Edge info to put into an irg.
  */
 typedef struct _irg_edge_info_t {
-       set *edges;
-       unsigned activated : 1;
+  set      *edges;         /**< a set containing all edges of a graph. */
+  unsigned activated : 1;  /**< set if edges are activated for the graph. */
 } irg_edge_info_t;
 
+typedef irg_edge_info_t irg_edges_info_t[EDGE_KIND_LAST];
+
 /**
  * Index constants for nodes that can be accessed through the graph itself.
  */
@@ -75,66 +76,78 @@ enum irg_anchors {
   anchor_max
 };
 
-/** ir_graph holds all information for a procedure */
+/** A callgraph entry for callees. */
+typedef struct cg_callee_entry {
+       ir_graph  *irg;        /**< The called irg. */
+       ir_node  **call_list;  /**< The list of all calls to the irg. */
+       int        max_depth;  /**< Maximum depth of all Call nodes to irg. */
+} cg_callee_entry;
+
+/**
+ * An ir_graph holds all information for a procedure.
+ */
 struct ir_graph {
-  firm_kind         kind;            /**<  always set to k_ir_graph*/
+  firm_kind         kind;        /**< Always set to k_ir_graph. */
   /* --  Basics of the representation -- */
-  entity  *ent;           /**< The entity of this procedure, i.e.,
-                    the type of the procedure and the
-                    class it belongs to. */
+  ir_entity  *ent;               /**< The entity of this procedure, i.e.,
+                                      the type of the procedure and the
+                                      class it belongs to. */
   ir_type *frame_type;           /**< A class type representing the stack frame.
                                       Can include "inner" methods. */
-  ir_node *anchors[anchor_max];  /**< anchor nodes */
-  ir_node **proj_args;           /**< projs of the methods arguments */
-  struct obstack *obst;          /**< obstack where all of the ir_nodes live */
-  ir_node *current_block;        /**< block for newly gen_*()-erated ir_nodes */
-  struct obstack *extbb_obst;    /**< obstack for extended basic block info */
+  ir_node *anchors[anchor_max];  /**< List of anchor nodes. */
+  ir_node **proj_args;           /**< Projs of the methods arguments. */
+  struct obstack *obst;          /**< The obstack where all of the ir_nodes live. */
+  ir_node *current_block;        /**< Current block for newly gen_*()-erated ir_nodes. */
+  struct obstack *extbb_obst;    /**< The obstack for extended basic block info. */
 
-  unsigned last_node_idx;        /**< last IR node index for this graph */
+  unsigned last_node_idx;        /**< The last IR node index for this graph. */
 
   /* -- Fields for graph properties -- */
   irg_inline_property inline_property;     /**< How to handle inlineing. */
-  unsigned additional_properties;          /**< additional graph properties. */
+  unsigned additional_properties;          /**< Additional graph properties. */
 
   /* -- Fields indicating different states of irgraph -- */
-  irg_phase_state phase_state;       /**< compiler phase */
-  op_pin_state irg_pinned_state;     /**< Flag for status of nodes */
+  irg_phase_state phase_state;       /**< Compiler phase. */
+  op_pin_state irg_pinned_state;     /**< Flag for status of nodes. */
   irg_outs_state outs_state;         /**< Out edges. */
-  irg_dom_state dom_state;           /**< Dominator state information */
-  irg_dom_state pdom_state;          /**< Post Dominator state information */
-  ir_typeinfo_state typeinfo_state;        /**< Validity of type information */
-  irg_callee_info_state callee_info_state; /**< Validity of callee information */
-  irg_loopinfo_state loopinfo_state;       /**< state of loop information */
-  exec_freq_state   execfreq_state;        /**< state of execution frequency information */
-  ir_class_cast_state class_cast_state;    /**< kind of cast operations in code. */
-  irg_extblk_info_state extblk_state;      /**< state of extended basic block info */
+  irg_dom_state dom_state;           /**< Dominator state information. */
+  irg_dom_state pdom_state;          /**< Post Dominator state information. */
+  ir_typeinfo_state typeinfo_state;        /**< Validity of type information. */
+  irg_callee_info_state callee_info_state; /**< Validity of callee information. */
+  irg_loopinfo_state loopinfo_state;       /**< State of loop information. */
+  ir_class_cast_state class_cast_state;    /**< Kind of cast operations in code. */
+  irg_extblk_info_state extblk_state;      /**< State of extended basic block info. */
+  exec_freq_state execfreq_state;          /**< Execution frequency state. */
+  ir_address_taken_computed_state adr_taken_state;  /**< Address taken state. */
+  unsigned mem_disambig_opt;               /**< Options for the memory disambiguator. */
+  unsigned fp_model;                       /**< floating point model of the graph. */
 
   /* -- Fields for construction -- */
 #if USE_EXPLICIT_PHI_IN_STACK
-  struct Phi_in_stack *Phi_in_stack; /**< needed for automatic Phi construction */
+  struct Phi_in_stack *Phi_in_stack; /**< Needed for automatic Phi construction. */
 #endif
-  int n_loc;                         /**< number of local variable in this
+  int n_loc;                         /**< Number of local variables in this
                                           procedure including procedure parameters. */
-  void **loc_descriptions;           /**< storage for local variable descriptions */
+  void **loc_descriptions;           /**< Storage for local variable descriptions. */
 
   /* -- Fields for optimizations / analysis information -- */
-  pset *value_table;                 /**< hash table for global value numbering (cse)
-                    for optimizing use in iropt.c */
+  pset *value_table;                 /**< Hash table for global value numbering (cse)
+                                          for optimizing use in iropt.c */
   ir_node **outs;                    /**< Space for the out arrays. */
 
-  ir_loop *loop;                     /**< The outermost loop */
+  ir_loop *loop;                     /**< The outermost loop for this graph. */
   void *link;                        /**< A void* field to link any information to
-                    the node. */
+                                          the node. */
 
-  ir_graph **callers;                /**< For callgraph analysis. */
+  ir_graph **callers;                /**< For callgraph analysis: list of caller graphs. */
   unsigned char *caller_isbe;        /**< For callgraph analysis: set if backedge. */
-  ir_graph **callees;                /**< For callgraph analysis. */
+  cg_callee_entry **callees;         /**< For callgraph analysis: list of callee calls */
   unsigned char *callee_isbe;        /**< For callgraph analysis: set if backedge. */
   int        callgraph_loop_depth;         /**< For callgraph analysis */
   int        callgraph_recursion_depth;    /**< For callgraph analysis */
   double     method_execution_frequency;   /**< For callgraph analysis */
 
-  ir_loop   *l;
+  ir_loop   *l;                            /**< For callgraph analysis. */
 
   /* -- Fields for Walking the graph -- */
   unsigned long visited;             /**< this flag is an identifier for
@@ -142,15 +155,22 @@ struct ir_graph {
                     every time someone walks through
                     the graph */
   unsigned long block_visited;       /**< same as visited, for a complete block */
+
+#ifndef NDEBUG
+  unsigned using_visited        : 1; /**< set to 1 if we are currently using the visited flag */
+  unsigned using_block_visited : 1;  /**< set to 1 if we are currently using the block_visited flag */
+  unsigned using_irn_link      : 1;  /**< set to 1 if we are currently using the irn_link fields */
+#endif
+
   unsigned estimated_node_count;     /**< estimated number of nodes in this graph,
                                           updated after every walk */
-  irg_edge_info_t edge_info;         /**< edge info for automatic outs */
+  irg_edges_info_t edge_info;        /**< edge info for automatic outs */
   ir_node **idx_irn_map;             /**< Array mapping node indexes to nodes. */
 
 #ifdef DEBUG_libfirm
   int             n_outs;            /**< Size wasted for outs */
-  long graph_nr;              /**< a unique graph number for each graph to make output
-                   readable. */
+  long graph_nr;                     /**< a unique graph number for each graph to make output
+                                          readable. */
 #endif
 
 };
@@ -161,7 +181,7 @@ struct ir_graph {
 void firm_init_irgraph(void);
 
 /* Internal constructor that does not add to irp_irgs or the like. */
-ir_graph *new_r_ir_graph (entity *ent, int n_loc);
+ir_graph *new_r_ir_graph (ir_entity *ent, int n_loc);
 
 /** Make a rudimentary ir graph for the constant code.
    Must look like a correct irg, spare everything else. */
@@ -353,14 +373,14 @@ _set_irg_current_block(ir_graph *irg, ir_node *node) {
   irg->current_block = node;
 }
 
-static INLINE entity *
+static INLINE ir_entity *
 _get_irg_entity(const ir_graph *irg) {
   assert(irg && irg->ent);
   return irg->ent;
 }
 
 static INLINE void
-_set_irg_entity(ir_graph *irg, entity *ent) {
+_set_irg_entity(ir_graph *irg, ir_entity *ent) {
   irg->ent = ent;
 }
 
@@ -547,6 +567,12 @@ _get_irg_estimated_node_cnt(const ir_graph *irg) {
   return irg->estimated_node_count;
 }
 
+/* Return the floating point model of this graph. */
+static INLINE unsigned
+_get_irg_fp_model(const ir_graph *irg) {
+       return irg->fp_model;
+}
+
 /**
  * Allocates a new idx in the irg for the node and adds the irn to the idx -> irn map.
  * @param irg The graph.
@@ -654,5 +680,6 @@ get_idx_irn(ir_graph *irg, unsigned idx) {
 #define inc_irg_block_visited(irg)            _inc_irg_block_visited(irg)
 #define dec_irg_block_visited(irg)            _dec_irg_block_visited(irg)
 #define get_irg_estimated_node_cnt(irg)       _get_irg_estimated_node_cnt(irg)
+#define get_irg_fp_model(irg)                 _get_irg_fp_model(irg)
 
 # endif /* _IRGRAPH_T_H_ */