Add is_Conv().
[libfirm] / ir / ir / irgraph_t.h
index 8c57cea..72a9b8b 100644 (file)
@@ -1,26 +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
- * Created:
- * CVS-ID:      $Id$
- * Copyright:   (c) 1998-2003 Universität Karlsruhe
- * Licence:     This file protected by GPL -  GNU GENERAL PUBLIC LICENSE.
- */
-
-/**
- * @file irgraph_t.h
+ * Copyright (C) 1995-2007 University of Karlsruhe.  All right reserved.
  *
- * ir graph construction.
+ * This file is part of libFirm.
  *
- * @author Martin Trapp, Christian Schaefer
+ * 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.
  */
 
-
-#ifndef _IRGRAPH_T_H_
-#define _IRGRAPH_T_H_
+/**
+ * @file
+ * @brief    Entry point to the representation of procedure code -- internal header.
+ * @author   Martin Trapp, Christian Schaefer, Goetz Lindenmaier, Michael Beck
+ * @version  $Id$
+ */
+#ifndef FIRM_IR_IRGRAPH_T_H
+#define FIRM_IR_IRGRAPH_T_H
 
 #include "firm_types.h"
 #include "irgraph.h"
@@ -33,6 +37,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.
  */
 enum irg_anchors {
-  anchor_start_block = 0, /**< block the start node will belong to */
-  anchor_start,           /**< start node of this ir_graph */
-  anchor_end_block,       /**< block the end node will belong to */
-  anchor_end,             /**< end node of this ir_graph */
-  anchor_end_reg,         /**< end node of this ir_graph */
-  anchor_end_except,      /**< end node of this ir_graph */
-  anchor_frame,           /**< method's frame */
-  anchor_globals,         /**< pointer to the data segment containing all
-                               globals as well as global procedures. */
-  anchor_initial_mem,     /**< initial memory of this graph */
-  anchor_args,            /**< methods arguments */
-  anchor_bad,             /**< bad node of this ir_graph, the one and
-                               only in this graph */
-  anchor_no_mem,          /**< NoMem node of this ir_graph, the one and only in this graph */
+  anchor_start_block = 0,  /**< block the start node will belong to */
+  anchor_start,            /**< start node of this ir_graph */
+  anchor_end_block,        /**< block the end node will belong to */
+  anchor_end,              /**< end node of this ir_graph */
+  anchor_end_reg,          /**< end node of this ir_graph */
+  anchor_end_except,       /**< end node of this ir_graph */
+  anchor_frame,            /**< method's frame */
+  anchor_globals,          /**< pointer to the data segment containing all
+                                globals as well as global procedures. */
+  anchor_tls,              /**< pointer to the thread local storage containing all
+                                thread local data. */
+  anchor_initial_mem,      /**< initial memory of this graph */
+  anchor_args,             /**< methods arguments */
+  anchor_value_param_base, /**< method value param base */
+  anchor_bad,              /**< bad node of this ir_graph, the one and
+                                only in this graph */
+  anchor_no_mem,           /**< NoMem node of this ir_graph, the one and only in this graph */
   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 desriptions */
+  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. */
 
-#ifdef DEBUG_libfirm
-  int             n_outs;            /**< Size wasted for outs */
-#endif /* defined DEBUG_libfirm */
-  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,14 +163,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 */
-#if FIRM_EDGES_INPLACE
-  irg_edge_info_t edge_info;  /**< edge info for automatic outs */
-#endif
+  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
-  long graph_nr;              /**< a unique graph number for each graph to make output
-                   readable. */
+  int             n_outs;            /**< Size wasted for outs */
+  long graph_nr;                     /**< a unique graph number for each graph to make output
+                                          readable. */
 #endif
 
 };
@@ -160,7 +189,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. */
@@ -273,6 +302,16 @@ _set_irg_globals(ir_graph *irg, ir_node *node) {
   irg->anchors[anchor_globals] = node;
 }
 
+static INLINE ir_node *
+_get_irg_tls(const ir_graph *irg) {
+  return irg->anchors[anchor_tls];
+}
+
+static INLINE void
+_set_irg_tls(ir_graph *irg, ir_node *node) {
+  irg->anchors[anchor_tls] = node;
+}
+
 static INLINE ir_node *
 _get_irg_initial_mem(const ir_graph *irg) {
   return irg->anchors[anchor_initial_mem];
@@ -293,6 +332,16 @@ _set_irg_args(ir_graph *irg, ir_node *node) {
   irg->anchors[anchor_args] = node;
 }
 
+static INLINE ir_node *
+_get_irg_value_param_base(const ir_graph *irg) {
+  return irg->anchors[anchor_value_param_base];
+}
+
+static INLINE void
+_set_irg_value_param_base(ir_graph *irg, ir_node *node) {
+  irg->anchors[anchor_value_param_base] = node;
+}
+
 static INLINE ir_node **
 _get_irg_proj_args(const ir_graph *irg) {
   return irg->proj_args;
@@ -332,14 +381,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;
 }
 
@@ -526,12 +575,27 @@ _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;
+}
+
 /**
- * Returns the next IR node index for the given graph.
+ * Allocates a new idx in the irg for the node and adds the irn to the idx -> irn map.
+ * @param irg The graph.
+ * @param irn The node.
+ * @return    The index allocated for the node.
  */
 static INLINE unsigned
-get_irg_next_node_idx(ir_graph *irg) {
-  return irg->last_node_idx++;
+irg_register_node_idx(ir_graph *irg, ir_node *irn)
+{
+       unsigned idx = irg->last_node_idx++;
+       if(idx >= (unsigned) ARR_LEN(irg->idx_irn_map))
+               ARR_RESIZE(ir_node *, irg->idx_irn_map, idx + 1);
+
+       irg->idx_irn_map[idx] = irn;
+       return idx;
 }
 
 /**
@@ -540,9 +604,24 @@ get_irg_next_node_idx(ir_graph *irg) {
  */
 static INLINE void
 irg_kill_node(ir_graph *irg, ir_node *n) {
-  if (get_irn_idx(n) + 1 == irg->last_node_idx)
-    --irg->last_node_idx;
-  obstack_free(irg->obst, n);
+       unsigned idx = get_irn_idx(n);
+       if (idx + 1 == irg->last_node_idx)
+               --irg->last_node_idx;
+       irg->idx_irn_map[idx] = NULL;
+       obstack_free(irg->obst, n);
+}
+
+/**
+ * Get the node for an index.
+ * @param irg The graph.
+ * @param idx The index you want the node for.
+ * @return    The node with that index or NULL, if there is no node with that index.
+ * @note      The node you got might be dead.
+ */
+static INLINE ir_node *
+get_idx_irn(ir_graph *irg, unsigned idx) {
+       assert(idx < (unsigned) ARR_LEN(irg->idx_irn_map));
+       return irg->idx_irn_map[idx];
 }
 
 #define get_interprocedural_view()            _get_interprocedural_view()
@@ -561,10 +640,14 @@ irg_kill_node(ir_graph *irg, ir_node *n) {
 #define set_irg_frame(irg, node)              _set_irg_frame(irg, node)
 #define get_irg_globals(irg)                  _get_irg_globals(irg)
 #define set_irg_globals(irg, node)            _set_irg_globals(irg, node)
+#define get_irg_tls(irg)                      _get_irg_tls(irg)
+#define set_irg_tls(irg, node)                _set_irg_tls(irg, node)
 #define get_irg_initial_mem(irg)              _get_irg_initial_mem(irg)
 #define set_irg_initial_mem(irg, node)        _set_irg_initial_mem(irg, node)
 #define get_irg_args(irg)                     _get_irg_args(irg)
 #define set_irg_args(irg, node)               _set_irg_args(irg, node)
+#define get_irg_value_param_base(irg)         _get_irg_value_param_base(irg)
+#define set_irg_value_param_base(irg, node)   _set_irg_value_param_base(irg, node)
 #define get_irg_bad(irg)                      _get_irg_bad(irg)
 #define set_irg_bad(irg, node)                _set_irg_bad(irg, node)
 #define get_irg_no_mem(irg)                   _get_irg_no_mem(irg)
@@ -605,5 +688,6 @@ irg_kill_node(ir_graph *irg, ir_node *n) {
 #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_ */
+#endif