cleaned up doxygen comments

[libfirm] / ir / ir / irgraph_t.h

diff --git a/ir/ir/irgraph_t.h b/ir/ir/irgraph_t.h
index 14af2ff..72a9b8b 100644 (file)
--- a/ir/ir/irgraph_t.h
+++ b/ir/ir/irgraph_t.h
@@ -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-2007 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"
@@ -76,6 +84,13 @@ enum irg_anchors {
   anchor_max
 };
 
+/** 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.
  */
@@ -112,7 +127,7 @@ struct ir_graph {
   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_disamgig_opt;               /**< Options for the memory disambiguator. */
+  unsigned mem_disambig_opt;               /**< Options for the memory disambiguator. */
   unsigned fp_model;                       /**< floating point model of the graph. */
 
   /* -- Fields for construction -- */
@@ -132,15 +147,15 @@ struct ir_graph {
   void *link;                        /**< A void* field to link any information to
                                           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
@@ -148,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 */
@@ -668,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