fixed doxygen comments, removed initialization for description entities
[libfirm] / ir / ana / rta.c
index b521c78..11dfbc1 100644 (file)
  */
 
 /**
- * Intraprozedurale Analyse zur Abschätzung der Aufrufrelation. Es
+ * Intraprozedurale Analyse zur Abschätzung der Aufrufrelation. Es wird
  * die Menge der instantiierten Klassen bestimmt, und daraus eine Abschätzung
- * der aufgerufenen Methoden bestimmt.
+ * der aufgerufenen Methoden.
+ *
+ * Voraussetzung ist, dass das Programm keine Methodenzeiger handhaben kann.
+ * In diesem Fall koennten Methoden verloren gehen.  Oder wir muessen nach
+ * allen "freien" Methoden suchen (siehe cgana).
+ *
+ * @@@ Die Analyse sollte wissen, von welchen Klassen Instanzen ausserhalb
+ * der Uebersetzungseinheit alloziert werden koennen.  Diese muessen in
+ * die initiale Menge allozierter Klassen aufgenommern werden.
  */
 
 #ifdef HAVE_CONFIG_H
@@ -27,7 +35,7 @@
 #include <stdlib.h>
 
 #include "irnode_t.h"
-#include "irprog.h"
+#include "irprog_t.h"
 
 #include "eset.h"
 #include "irgwalk.h"
 # define TRUE 1
 # define FALSE 0
 
+/* flags */
+static int verbose     = 0;
+
+
 /* base data */
 static eset *_live_classes   = NULL;
 
 /* cache computed results */
 static eset *_live_graphs    = NULL;
 
-static int whole_world = 0;
-static int verbose     = 0;
-
 /**
    Given a method, find the firm graph that implements that method.
 */
 static ir_graph *get_implementing_graph (entity *method)
 {
+#if 0
   ir_graph *graph = get_entity_irg ((entity*) method);
 
+  /* Search upwards in the overwrites graph. */
+  /* GL: this will not work for multiple inheritance */
   if (NULL == graph) {
     int i;
     int n_over = get_entity_n_overwrites ((entity*) method);
@@ -64,11 +76,23 @@ static ir_graph *get_implementing_graph (entity *method)
     }
   }
 
+  /* GL   this is not valid in our remove irg algorithm ... which we removed by now ...  */
+  assert(get_entity_peculiarity(method) == peculiarity_description
+        || graph == get_entity_irg(get_SymConst_entity(get_atomic_ent_value(method))));
+
   /* we *must* always return a graph != NULL, *except* when we're used
      inside remove_irg or force_description */
   /* assert (graph && "no graph"); */
 
   return (graph);
+#else
+  ir_graph *graph = NULL;
+
+  if (get_entity_peculiarity(method) != peculiarity_description)
+    graph = get_entity_irg(get_SymConst_entity(get_atomic_ent_value(method)));
+
+  return graph;
+#endif
 }
 
 static int add_graph (ir_graph *graph)
@@ -76,7 +100,7 @@ static int add_graph (ir_graph *graph)
   if (!eset_contains (_live_graphs, graph)) {
     if (verbose > 1) {
       fprintf(stdout, "RTA:        new graph of ");
-      DDMEO(get_irg_ent (graph));
+      DDMEO(get_irg_entity (graph));
     }
 
     eset_insert (_live_graphs, graph);
@@ -89,10 +113,10 @@ static int add_graph (ir_graph *graph)
 static int add_class (type *clazz)
 {
   if (!eset_contains (_live_classes, clazz)) {
-  if (verbose > 1) {
-    fprintf(stdout, "RTA:        new class: ");
-    DDMT(clazz);
-  }
+    if (verbose > 1) {
+      fprintf(stdout, "RTA:        new class: ");
+      DDMT(clazz);
+    }
 
     eset_insert (_live_classes, clazz);
     return (TRUE);
@@ -101,10 +125,10 @@ static int add_class (type *clazz)
   return (FALSE);
 }
 
-/**
  Given an entity, add all implementing graphs that belong to live classes to _live_graphs.
-
-   Iff additions occurred, return TRUE, else FALSE.
+/** Given an entity, add all implementing graphs that belong to live classes
 to _live_graphs.
+ *
*  Iff additions occurred, return TRUE, else FALSE.
 */
 static int add_implementing_graphs (entity *method)
 {
@@ -136,12 +160,11 @@ static int add_implementing_graphs (entity *method)
   return (change);
 }
 
-/**
-   Enter all method accesses and all class allocations into
-   our tables.
-
-   Set *(int*)env to true iff (possibly) new graphs have been found.
-*/
+/** Enter all method accesses and all class allocations into
+ *  our tables.
+ *
+ *  Set *(int*)env to true iff (possibly) new graphs have been found.
+ */
 static void rta_act (ir_node *node, void *env)
 {
   int *change = (int*) env;
@@ -153,41 +176,41 @@ static void rta_act (ir_node *node, void *env)
 
     ir_node *ptr = get_Call_ptr (node);
 
-    if (iro_Sel == get_irn_opcode (ptr)) { /* CALL SEL */
+    /* CALL SEL */
+    if (iro_Sel == get_irn_opcode (ptr)) {
       ent = get_Sel_entity (ptr);
-      *change = add_implementing_graphs (ent);
-    } else if (iro_Const == get_irn_opcode (ptr)) { /* CALL CONST */
-      ent = get_tarval_entity (get_Const_tarval (ptr));
-      ir_graph *graph = get_entity_irg (ent);
-      /* don't use get_implementing_graph on a Const! */
-      if (graph) {
-        *change = add_graph (graph);
-      } else {
-        /* it's an externally allocated thing. */
-      }
-    } else if (iro_SymConst == get_irn_opcode (ptr)) { /* CALL SYMCONST */
+      *change |= add_implementing_graphs (ent);
+
+    /* CALL SYMCONST */
+    } else if (iro_SymConst == get_irn_opcode (ptr)) {
       if (get_SymConst_kind(ptr) == symconst_addr_ent) {
        ent = get_SymConst_entity (ptr);
        ir_graph *graph = get_entity_irg (ent);
-       /* don't use get_implementing_graph on a Const! */
        if (graph) {
-         *change = add_graph (graph);
+         *change |= add_graph (graph);
        } else {
-         /* it's an externally allocated thing. */
+         /* it's an external allocated thing. */
        }
       } else if (get_SymConst_kind(ptr) == symconst_addr_name) {
-      /* If this SymConst refers to a method the method is external_visible
-         and therefore must be considered live anyways. */
-      /* assert (ent && "couldn't determine entity of call to symConst"); */
+       /* If this SymConst refers to a method the method is external_visible
+          and therefore must be considered live anyways. */
+       if (get_SymConst_name(ptr) != new_id_from_str("iro_Catch"))
+         assert (ent && "couldn't determine entity of call to symConst");
       } else {
        /* other symconst. */
+       assert(0 && "This SymConst can not be an address for a method call.");
       }
 
+    /* STRANGE */
+    } else {
+      DDMN(ptr);
+      assert(0 && "Unexpected address expression: can not analyse, therefore can not do correct rta!");
     }
+
   } else if (iro_Alloc == op) { /* ALLOC */
     type *type = get_Alloc_type (node);
 
-    *change = add_class (type);
+    *change |= add_class (type);
   }
 }
 
@@ -201,16 +224,15 @@ static int rta_fill_graph (ir_graph* graph)
 
   current_ir_graph = graph;
 
-  irg_walk (get_irg_end (graph), rta_act, NULL, &change);
+  irg_walk_graph (graph, rta_act, NULL, &change);
 
   return (change);
 }
 
-/**
-   Traverse all graphs to collect method accesses and object allocations.
-
-   @param rerun Whether to rely on is_alive in a second run
-*/
+/** Traverse all graphs to collect method accesses and object allocations.
+ *
+ *  @param rerun Whether to rely on is_alive in a second run
+ */
 static int rta_fill_incremental (void)
 {
   int i;
@@ -229,10 +251,10 @@ static int rta_fill_incremental (void)
     ir_graph *graph = get_irp_irg (i);
     entity *ent = get_irg_entity (graph);
 
-    if (((!whole_world) &&
-         (visibility_external_visible == get_entity_visibility (ent))) ||
+    if ((visibility_external_visible == get_entity_visibility (ent)) ||
         (stickyness_sticky == get_entity_stickyness (ent))) {
       eset_insert (_live_graphs, graph);
+      // printf("external visible: "); DDMG(graph);
     }
   }
 
@@ -251,14 +273,13 @@ static int rta_fill_incremental (void)
     eset_insert_all (_live_graphs, live_graphs);
 
     rerun = FALSE;
-
     for (graph = eset_first (live_graphs);
          graph;
          graph = eset_next (live_graphs)) {
 
       if (verbose > 1) {
         fprintf(stdout, "RTA: RUN %i: considering graph of ", n_runs);
-        DDMEO(get_irg_ent (graph));
+        DDMEO(get_irg_entity (graph));
       }
 
       rerun |= rta_fill_graph (graph);
@@ -331,72 +352,33 @@ static void force_description (entity *ent, entity *addr)
   }
 }
 
-/* remove a graph, part II */
-/*
-   Note: get_implementing_graph is not well defined here (graph->ent
-   could overwrite more than one superclass implementation (graph).
-   Since we *know* that this entity will not be called, this is OK.
-*/
-static void remove_irg (ir_graph *graph)
-{
-  entity *ent = get_irg_entity (graph);
-  peculiarity pec = get_entity_peculiarity (ent);
-
-  /*   DDMEO (get_irg_ent(graph)); */
-
-  /* delete the ir_graph data */
-  set_entity_peculiarity (ent, peculiarity_description);
-  remove_irp_irg (graph);
-  /* remove_irp_irg also removes the entities' reference to the graph */
-  /*
-    if (NULL != get_entity_irg (ent)) {
-    set_entity_irg (ent, NULL);
-    }
-  */
-  set_entity_peculiarity (ent, pec);
-
-  /* find the implementation (graph) from *some* superclass: */
-  graph = get_implementing_graph (ent);
-
-  if (TRUE || (NULL == graph)) { /* always pretend to be 'abstract'; let the others figure this out */
-    /* nothing to inherit!  pretend we're abstract */
-    force_description (ent, ent);
-  } else {
-    /* pretend that we inherit the implementation (graph) from some superclass: */
-    set_entity_peculiarity (ent, peculiarity_inherited);
-
-    exchange (get_atomic_ent_value (ent),
-              get_atomic_ent_value (get_irg_ent(graph)));
-  }
-}
-
 /**
    Initialise the static data structures.
 */
 static void init_tables (void)
 {
-  _live_classes   = eset_create ();
+  int i, n_globs = get_class_n_members(get_glob_type());
 
-  _live_graphs = eset_create ();
+  _live_classes = eset_create ();
+  _live_graphs  = eset_create ();
 
   if (get_irp_main_irg ()) {
     eset_insert (_live_graphs, get_irp_main_irg ());
   }
 
-  /* Adding the GlobalType is pointless, since its methods are always
-     called via a constant */
-  /*
-  if (get_glob_type ()) {
-    eset_insert (_live_classes, get_glob_type ());
+  /* Find static allocated classes */
+  for (i = 0; i < n_globs; ++i) {
+    type *member_type = get_entity_type(get_class_member(get_glob_type(), i));
+    if (is_class_type(member_type))
+      eset_insert(_live_classes, member_type);
   }
-  */
 }
 
-/* Initialise the RTA data structures, and perform RTA.
-   @param   do_verbose If == 1, print statistics, if > 1, chatter about every detail
-   @param   do_whole_world Iff != 0, assume whole-world
-*/
-void rta_init (int do_verbose, int do_whole_world)
+/*
+ * Initialise the RTA data structures, and perform RTA.
+ * do_verbose If == 1, print statistics, if > 1, chatter about every detail
+ */
+void rta_init (int do_verbose)
 {
   int n_runs = 0;
 
@@ -408,7 +390,6 @@ void rta_init (int do_verbose, int do_whole_world)
   tr_vrfy ();
 # endif /* defined DEBUG_libfirm */
 
-  whole_world = do_whole_world;
   verbose = do_verbose;
 
   init_tables ();
@@ -418,9 +399,6 @@ void rta_init (int do_verbose, int do_whole_world)
   if (verbose) {
     int n_live_graphs = stats ();
 
-    if (whole_world) {
-      printf ("RTA: whole-world assumption\n");
-    }
     printf ("RTA: n_graphs      = %i\n", get_irp_n_irgs ());
     printf ("RTA: n_live_graphs = %i\n", n_live_graphs);
     printf ("RTA: n_runs        = %i\n", n_runs);
@@ -434,6 +412,28 @@ void rta_init (int do_verbose, int do_whole_world)
 # endif /* defined DEBUG_libfirm */
 }
 
+/**
+ * walker for all types and entities
+ *
+ * Changes the peculiarity of entities that represents
+ * dead graphs to peculiarity_description.
+ */
+static void make_entity_to_description(type_or_ent *tore, void *env) {
+  if (get_kind(tore) == k_entity) {
+    entity *ent = (entity *)tore;
+
+    if ((is_method_type(get_entity_type(ent)))                        &&
+       (get_entity_peculiarity(ent) != peculiarity_description)      &&
+       (get_entity_visibility(ent)  != visibility_external_allocated)   ) {
+      ir_graph *irg = get_entity_irg(get_SymConst_entity(get_atomic_ent_value(ent)));
+      if (!eset_contains (_live_graphs, irg)) {
+       set_entity_peculiarity(ent, peculiarity_description);
+       set_entity_irg(ent, NULL);
+      }
+    }
+  }
+}
+
 /* Delete all graphs that we have found to be dead from the program
    If verbose == 1, print statistics, if > 1, chatter about every detail
 */
@@ -446,7 +446,7 @@ void rta_delete_dead_graphs (void)
 
   if (!get_optimize() || !get_opt_dead_method_elimination()) return;
 
-  eset *dead_graphs = eset_create ();
+  ir_graph *dead_graphs[get_irp_n_irgs()];
 
   for (i = 0; i < n_graphs; i++) {
     graph = get_irp_irg(i);
@@ -456,26 +456,17 @@ void rta_delete_dead_graphs (void)
     } else {
 # ifdef DEBUG_libfirm
       entity *ent = get_irg_entity (graph);
-      assert (whole_world ||
-              (visibility_external_visible != get_entity_visibility (ent)));
+      assert (visibility_external_visible != get_entity_visibility (ent));
 # endif /* defined DEBUG_libfirm */
 
+      dead_graphs[n_dead_graphs] = graph;
       n_dead_graphs ++;
-      eset_insert (dead_graphs, graph);
     }
   }
 
-  /* now delete the graphs. */
-  for (graph = eset_first (dead_graphs);
-       graph;
-       graph = (ir_graph*) eset_next (dead_graphs)) {
-
-    if ((verbose > 1) || get_opt_dead_method_elimination_verbose ()) {
-      fprintf(stdout, "RTA: removing graph of ");
-      DDMEO(get_irg_ent (graph));
-    }
-
-    remove_irg (graph);
+  type_walk(make_entity_to_description, NULL, NULL);
+  for (i = 0; i < n_dead_graphs; ++i) {
+    remove_irp_irg (dead_graphs[i]);
   }
 
   if (verbose) {
@@ -514,11 +505,7 @@ int  rta_is_alive_class  (type   *clazz)
 /* Say whether this graph might be run at any time in the program: */
 int  rta_is_alive_graph (ir_graph *graph)
 {
-  if (eset_contains (_live_graphs, graph)) {
-    return (TRUE);
-  }
-
-  return (FALSE);
+  return eset_contains (_live_graphs, graph);
 }
 
 /* dump our opinion */
@@ -536,7 +523,7 @@ void rta_report (void)
   for (i = 0; i < get_irp_n_irgs(); i++) {
     if (rta_is_alive_graph (get_irp_irg(i))) {
       fprintf(stdout, "RTA: considered called: graph of ");
-      DDMEO(get_irg_ent (get_irp_irg(i)));
+      DDMEO(get_irg_entity (get_irp_irg(i)));
     }
   }
 }
@@ -544,6 +531,23 @@ void rta_report (void)
 
 /*
  * $Log$
+ * Revision 1.24  2004/09/24 13:59:04  beck
+ * fixed doxygen comments, removed initialization for description entities
+ *
+ * Revision 1.23  2004/08/19 16:51:02  goetz
+ * fixed some errors, pushed closer to inteded firm semantics
+ *
+ * Revision 1.22  2004/08/13 08:57:15  beyhan
+ * normalized names of functions, enums ...
+ * added suffix as argument to dumpers, removed global variable
+ * removed support for tarval/Const
+ *
+ * Revision 1.21  2004/07/08 15:50:56  goetz
+ * firmstat added
+ *
+ * Revision 1.20  2004/07/08 11:17:40  goetz
+ * *** empty log message ***
+ *
  * Revision 1.19  2004/07/06 12:30:37  beyhan
  * new SymConst semantics
  *