cleaned up doxygen comments
[libfirm] / ir / ir / irgraph_t.h
index 39ea3a8..72a9b8b 100644 (file)
@@ -1,22 +1,30 @@
 /*
- * Project:     libFIRM
- * 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, Michael Beck
- * Created:
- * CVS-ID:      $Id$
- * Copyright:   (c) 1998-2003 Universität Karlsruhe
- * Licence:     This file protected by GPL -  GNU GENERAL PUBLIC LICENSE.
+ * Copyright (C) 1995-2007 University of Karlsruhe.  All right reserved.
+ *
+ * This file is part of libFirm.
+ *
+ * This file may be distributed and/or modified under the terms of the
+ * GNU General Public License version 2 as published by the Free Software
+ * Foundation and appearing in the file LICENSE.GPL included in the
+ * packaging of this file.
+ *
+ * Licensees holding valid libFirm Professional Edition licenses may use
+ * this file in accordance with the libFirm Commercial License.
+ * Agreement provided with the Software.
+ *
+ * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
+ * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+ * PURPOSE.
  */
 
 /**
- * @file irgraph_t.h
- *
- * IR graph construction.
+ * @file
+ * @brief    Entry point to the representation of procedure code -- internal header.
+ * @author   Martin Trapp, Christian Schaefer, Goetz Lindenmaier, Michael Beck
+ * @version  $Id$
  */
-#ifndef _IRGRAPH_T_H_
-#define _IRGRAPH_T_H_
+#ifndef FIRM_IR_IRGRAPH_T_H
+#define FIRM_IR_IRGRAPH_T_H
 
 #include "firm_types.h"
 #include "irgraph.h"
@@ -30,6 +38,7 @@
 #include "typegmod.h"
 #include "tr_inheritance.h"
 #include "iredgekinds.h"
+#include "irmemory.h"
 
 #include "irloop.h"
 #include "execution_frequency.h"
@@ -75,26 +84,35 @@ 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 -- */
   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. */
@@ -108,34 +126,36 @@ struct ir_graph {
   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
@@ -143,6 +163,13 @@ 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_edges_info_t edge_info;        /**< edge info for automatic outs */
@@ -150,8 +177,8 @@ struct ir_graph {
 
 #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
 
 };
@@ -663,4 +690,4 @@ get_idx_irn(ir_graph *irg, unsigned idx) {
 #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_ */
+#endif