Converted documentation to doxygen.
[libfirm] / ir / ir / irgraph.c
index 249fdb5..c4d6c20 100644 (file)
@@ -1,24 +1,54 @@
 /* Copyright (C) 1998 - 2000 by Universitaet Karlsruhe
-** All rights reserved.
-**
-** Authors: Martin Trapp, Christian Schaefer
-**
-**
+* All rights reserved.
+*
+* Authors: Martin Trapp, Christian Schaefer
+*
+*
 */
 
+/* $Id$ */
+
+#ifdef HAVE_CONFIG_H
+# include <config.h>
+#endif
+
+# include <string.h>
+
 # include "ircons.h"
 # include "irgraph_t.h"
-# include "irprog.h"
+# include "irprog_t.h"
 # include "iropt_t.h"
 # include "array.h"
 # include "irgmod.h"
+# include "mangle.h"
 
 ir_graph *current_ir_graph;
+INLINE ir_graph *get_current_ir_graph(void) {
+  return current_ir_graph;
+}
+INLINE void set_current_ir_graph(ir_graph *graph) {
+  current_ir_graph = graph;
+}
 
-#if USE_EXPICIT_PHI_IN_STACK
+
+bool interprocedural_view = false;
+INLINE bool get_interprocedural_view(void) {
+  return interprocedural_view;
+}
+INLINE void set_interprocedural_view(bool state) {
+  interprocedural_view = state;
+}
+
+static ident* frame_type_suffix = NULL;
+void init_irgraph(void) {
+  frame_type_suffix = id_from_str(FRAME_TP_SUFFIX, strlen(FRAME_TP_SUFFIX));
+}
+
+#if USE_EXPLICIT_PHI_IN_STACK
 /* really defined in ircons.c */
 typedef struct Phi_in_stack Phi_in_stack;
 Phi_in_stack *new_Phi_in_stack();
+void free_Phi_in_stack(Phi_in_stack *s);
 #endif
 
 /* Allocates a list of nodes:
@@ -41,16 +71,25 @@ new_ir_graph (entity *ent, int n_loc)
   current_ir_graph = res;
   add_irp_irg(res);          /* remember this graph global. */
 
-  /** Internal information for graph construction either held in the graph or
-  *** initialized for each graph. **/
+/**
+  * initialized for each graph. **/
+#if PRECISE_EXC_CONTEXT
+  res->n_loc = n_loc + 1 + 1; /* number of local variables that are never
+                                 dereferenced in this graph plus one for
+                                the store plus one for links to fragile
+                                operations.  n_loc is not the number of
+                                parameters to the procedure!  */
+#else
   res->n_loc = n_loc + 1;  /* number of local variables that are never
-                                dereferenced in this graph plus one for
-                               the store. This is not the number of parameters
-                                to the procedure!  */
+                              dereferenced in this graph plus one for
+                             the store. This is not the number of parameters
+                              to the procedure!  */
+#endif
+
   res->visited = 0;     /* visited flag, for the ir walker */
   res->block_visited=0; /* visited flag, for the 'block'-walker */
 
-#if USE_EXPICIT_PHI_IN_STACK
+#if USE_EXPLICIT_PHI_IN_STACK
   res->Phi_in_stack = new_Phi_in_stack();  /* A stack needed for automatic Phi
                                 generation */
 #endif
@@ -59,31 +98,49 @@ new_ir_graph (entity *ent, int n_loc)
   res->value_table = new_identities (); /* value table for global value
                                           numbering for optimizing use in
                                           iropt.c */
+  res->outs = NULL;
+
+  res->phase_state = phase_building;
+  res->pinned = pinned;
+  res->outs_state = no_outs;
+  res->dom_state = no_dom;
 
-  /** Type inforamtion for the procedure of the graph **/
+  /** Type information for the procedure of the graph **/
   res->ent = ent;
   set_entity_irg(ent, res);
 
+/**
+      contain "inner" methods as in Pascal. **/
+  res->frame_type = new_type_class(mangle(get_entity_ident(ent), frame_type_suffix));
+  /* Remove type from type list.  Must be treated differently than other types. */
+  remove_irp_type_from_list(res->frame_type);
+
   /** Nodes needed in every graph **/
   res->end_block = new_immBlock ();
   res->end       = new_End ();
 
   res->start_block = new_immBlock ();
   res->start   = new_Start ();
-  res->bad     = new_ir_node (res, res->start_block, op_Bad, mode_T, 0, NULL);
+  res->bad     = new_ir_node (NULL, res, res->start_block, op_Bad, mode_T, 0, NULL);
+  res->unknown = new_ir_node (NULL, res, res->start_block, op_Unknown, mode_T, 0, NULL);
 
   /* Proj results of start node */
   projX        = new_Proj (res->start, mode_X, pns_initial_exec);
   set_store (new_Proj (res->start, mode_M, pns_global_store));
-  res->frame   = new_Proj (res->start, mode_p, pns_frame_base);
-  res->globals = new_Proj (res->start, mode_p, pns_globals);
+  res->frame   = new_Proj (res->start, mode_P, pns_frame_base);
+  res->globals = new_Proj (res->start, mode_P, pns_globals);
   res->args    = new_Proj (res->start, mode_T, pns_args);
+#ifdef DEBUG_libfirm
+  res->graph_nr = get_irp_new_node_nr();
+#endif
 
-  add_in_edge(res->start_block, projX);
-  // The code generation needs it. leave it in now.
-  // Use of this edge is matter of discussion, unresolved. Also possible:
-  // add_in_edge(res->start_block, res->start_block), but invalid typed.
 
+  add_in_edge(res->start_block, projX);
+  /*
+   * The code generation needs it. leave it in now.
+   * Use of this edge is matter of discussion, unresolved. Also possible:
+   * add_in_edge(res->start_block, res->start_block), but invalid typed.
+   */
   mature_block (res->current_block);
 
   /** Make a block to start with **/
@@ -93,11 +150,84 @@ new_ir_graph (entity *ent, int n_loc)
   return res;
 }
 
+
+/* Make a rudimentary ir graph for the constant code.
+   Must look like a correct irg, spare everything else. */
+ir_graph *new_const_code_irg() {
+  ir_graph *res;
+  ir_node *projX;
+
+  res = (ir_graph *) malloc (sizeof (ir_graph));
+  current_ir_graph = res;
+  res->n_loc = 1;      /* Only the memory. */
+  res->visited = 0;     /* visited flag, for the ir walker */
+  res->block_visited=0; /* visited flag, for the 'block'-walker */
+#if USE_EXPLICIT_PHI_IN_STACK
+  res->Phi_in_stack = NULL;
+#endif
+  res->obst      = (struct obstack *) xmalloc (sizeof (struct obstack));
+  obstack_init (res->obst);
+  res->phase_state = phase_building;
+  res->pinned = pinned;
+  res->value_table = new_identities (); /* value table for global value
+                                          numbering for optimizing use in
+                                          iropt.c */
+  res->ent = NULL;
+  res->frame_type = NULL;
+  res->start_block = new_immBlock ();
+  res->end_block = new_immBlock ();
+  res->end       = new_End ();
+  mature_block(get_cur_block());
+  res->bad = new_ir_node (NULL, res, res->start_block, op_Bad, mode_T, 0, NULL);
+  res->unknown = new_ir_node (NULL, res, res->start_block, op_Unknown, mode_T, 0, NULL);
+  res->start   = new_Start ();
+  /* Proj results of start node */
+  projX        = new_Proj (res->start, mode_X, pns_initial_exec);
+  set_store (new_Proj (res->start, mode_M, pns_global_store));
+  add_in_edge(res->start_block, projX);
+  mature_block (res->current_block);
+  add_in_edge (new_immBlock (), projX);
+  mature_block(get_cur_block());
+  /* Set the visited flag high enough that the block will never be visited. */
+  set_irn_visited(get_cur_block(), -1);
+  set_Block_block_visited(get_cur_block(), -1);
+  set_Block_block_visited(res->start_block, -1);
+  return res;
+}
+
+/* Frees the passed irgraph.
+   Deallocates all nodes in this graph and the ir_graph structure.
+   Sets the field irgraph in the corresponding entity to NULL.
+   Does not remove the irgraph from the list in irprog (requires
+   inefficient search, call remove_irp_irg by hand).
+   Does not free types, entities or modes that are used only by this
+   graph, nor the entity standing for this graph. */
+void free_ir_graph (ir_graph *irg) {
+  set_entity_irg(irg->ent, NULL);
+  free(irg->obst);
+#if USE_EXPLICIT_PHI_IN_STACK
+  free_Phi_in_stack(irg->Phi_in_stack);
+#endif
+  free(irg);
+}
+
 /* access routines for all ir_graph attributes:
    templates:
    {attr type} get_irg_{attribute name} (ir_graph *irg);
    void set_irg_{attr name} (ir_graph *irg, {attr type} {attr}); */
 
+/* Outputs a unique number for this node */
+
+INLINE long
+get_irg_graph_nr(ir_graph *irg) {
+  assert(irg);
+#ifdef DEBUG_libfirm
+  return irg->graph_nr;
+#else
+  return 0;
+#endif
+}
+
 ir_node *
 get_irg_start_block (ir_graph *irg)
 {
@@ -206,6 +336,18 @@ set_irg_bad (ir_graph *irg, ir_node *node)
   irg->bad = node;
 }
 
+ir_node *
+get_irg_unknown (ir_graph *irg)
+{
+  return irg->unknown;
+}
+
+void
+set_irg_unknown (ir_graph *irg, ir_node *node)
+{
+  irg->unknown = node;
+}
+
 ir_node *
 get_irg_current_block (ir_graph *irg)
 {
@@ -231,18 +373,129 @@ set_irg_ent (ir_graph *irg, entity *ent)
   irg->ent = ent;
 }
 
+type *
+get_irg_frame_type (ir_graph *irg)
+{
+  assert(irg && irg->frame_type);
+  return irg->frame_type;
+}
+
+void
+set_irg_frame_type (ir_graph *irg, type *ftp)
+{
+  irg->frame_type = ftp;
+}
+
+
+/* To test for a frame type */
 int
-get_irg_n_loc (ir_graph *irg)
+is_frame_type(type *ftp) {
+  return ((is_class_type(ftp) || is_struct_type(ftp)) &&
+         id_is_suffix(id_from_str(FRAME_TP_SUFFIX, strlen(FRAME_TP_SUFFIX)),
+                      get_type_ident(ftp)));
+}
+
+int
+get_irg_n_locs (ir_graph *irg)
 {
-  return irg->n_loc;
+#if PRECISE_EXC_CONTEXT
+  return irg->n_loc - 1 - 1;
+#else
+  return irg->n_loc - 1;
+#endif
 }
 
 void
 set_irg_n_loc (ir_graph *irg, int n_loc)
 {
-  irg->n_loc = n_loc;
+#if PRECISE_EXC_CONTEXT
+  irg->n_loc = n_loc + 1 + 1;
+#else
+  irg->n_loc = n_loc + 1;
+#endif
+}
+
+
+
+/* Returns the obstack associated with the graph. */
+struct obstack *get_irg_obstack(ir_graph *irg) {
+  return irg->obst;
+}
+
+/*
+ * Returns true if the node n is allocated on the storage of graph irg.
+ *
+ * Implementation is GLIBC specific as is uses the internal _obstack_chunk implementation.
+ */
+int node_is_in_irgs_storage(ir_graph *irg, ir_node *n)
+{
+  struct _obstack_chunk        *p;
+
+  /*
+   * checks wheater the ir_node pointer i on the obstack.
+   * A more sophisticated chaeck would test the "whole" ir_node
+   */
+  for (p = irg->obst->chunk; p; p = p->prev) {
+    if (((char *)p->contents <= (char *)n) && ((char *)n < (char *)p->limit))
+      return 1;
+  }
+
+  return 0;
+}
+
+irg_phase_state
+get_irg_phase_state (ir_graph *irg) {
+  return irg->phase_state;
 }
 
+void
+set_irg_phase_low(ir_graph *irg) {
+  irg->phase_state = phase_low;
+}
+
+op_pinned
+get_irg_pinned (ir_graph *irg) {
+  return irg->pinned;
+}
+
+irg_outs_state
+get_irg_outs_state(ir_graph *irg) {
+  return irg->outs_state;
+}
+
+void
+set_irg_outs_inconsistent(ir_graph *irg) {
+  irg->outs_state = outs_inconsistent;
+}
+
+irg_dom_state
+get_irg_dom_state(ir_graph *irg) {
+  return irg->dom_state;
+}
+
+void
+set_irg_dom_inconsistent(ir_graph *irg) {
+  irg->dom_state = dom_inconsistent;
+}
+
+INLINE void
+set_irg_pinned (ir_graph *irg, op_pinned p) {
+  irg->pinned = p;
+}
+
+INLINE void
+set_irg_link (ir_graph *irg, void *thing) {
+  irg->link = thing;
+}
+
+INLINE void *
+get_irg_link (ir_graph *irg) {
+  return irg->link;
+}
+
+/* maximum visited flag content of all ir_graph visited fields. */
+static int max_irg_visited = 0;
+
 unsigned long
 get_irg_visited (ir_graph *irg)
 {
@@ -253,12 +506,40 @@ void
 set_irg_visited (ir_graph *irg, unsigned long visited)
 {
   irg->visited = visited;
+  if (irg->visited > max_irg_visited) {
+    max_irg_visited = irg->visited;
+  }
 }
 
 void
 inc_irg_visited (ir_graph *irg)
 {
-  irg->visited = irg->visited++;
+  if (++irg->visited > max_irg_visited) {
+    max_irg_visited = irg->visited;
+  }
+}
+
+unsigned long
+get_max_irg_visited(void)
+{
+  //int i;
+  //for(i = 0; i < get_irp_n_irgs(); i++)
+  //  assert(max_irg_visited >= get_irg_visited(get_irp_irg(i)));
+  return max_irg_visited;
+}
+
+void set_max_irg_visited(int val) {
+  max_irg_visited = val;
+}
+
+unsigned long
+inc_max_irg_visited(void)
+{
+  //int i;
+  //  for(i = 0; i < get_irp_n_irgs(); i++)
+  //assert(max_irg_visited >= get_irg_visited(get_irp_irg(i)));
+  max_irg_visited++;
+  return max_irg_visited;
 }
 
 unsigned long
@@ -276,5 +557,5 @@ set_irg_block_visited (ir_graph *irg, unsigned long visited)
 void
 inc_irg_block_visited (ir_graph *irg)
 {
-  irg->block_visited = irg->block_visited++;
+  ++irg->block_visited;
 }