analyses polymorphic calls if callee info is available
[libfirm] / ir / ana / cgana.c
index b31d070..84b2791 100644 (file)
@@ -54,8 +54,7 @@
 
 
 
-/* Eindeutige Adresse zur Markierung von besuchten Knoten und zur
- * Darstellung der unbekannten Methode. */
+/* unambiguous address used as a mark. */
 static void *MARK = &MARK;
 
 static eset *entities = NULL;
@@ -75,8 +74,8 @@ static eset *entities = NULL;
 static entity *get_inherited_methods_implementation(entity *inh_meth) {
   assert(get_atomic_ent_value(inh_meth) && "constant entity without value");
   assert((get_irn_op(get_atomic_ent_value(inh_meth)) == op_SymConst) &&
-        (get_SymConst_kind(get_atomic_ent_value(inh_meth)) == symconst_addr_ent) &&
-        "Complex constant values not supported -- address of method should be straight constant!");
+         (get_SymConst_kind(get_atomic_ent_value(inh_meth)) == symconst_addr_ent) &&
+         "Complex constant values not supported -- address of method should be straight constant!");
 
   return get_SymConst_entity(get_atomic_ent_value(inh_meth));
 }
@@ -98,45 +97,15 @@ static void collect_impls(entity *method, eset *set, int *size, bool *open) {
   int i;
   entity *impl;
 
-  /* Only the assertions: */
-  if (get_entity_peculiarity(method) == peculiarity_existent) {
-    if ((get_entity_visibility(method) == visibility_external_allocated)
-       && (NULL == get_entity_irg(method))) {
-    } else {
-      assert(get_entity_irg(method) != NULL);
-    }
-  }
-  if (get_entity_peculiarity(method) == peculiarity_inherited) {
-    entity *impl_ent = get_inherited_methods_implementation(method);
-    if (get_entity_visibility(impl_ent) == visibility_external_allocated) {
-      assert(get_entity_irg(impl_ent) == NULL);
-    } else {
-      assert(get_entity_irg(impl_ent) != NULL);
-    }
-  }
-
   /* Add the implementation to the set if it contains an irg, else
      remember that there are more methods called. */
-  /* @@@ We could also add unknown_entity, or the entities with the
-     unknown irgs.  The first case would result in the exact same
-     behavior: all unknown irgs are represented by the one and only
-     unknown entity. If we add all entities, we known the number of
-     entities possibly called, and whether there are real unknown
-     entities, i.e, such not represented in the type description.
-     This would be better for an analysis: it could rule out more
-     cases. */
   impl = method;
   if (get_entity_peculiarity(method) == peculiarity_inherited)
     impl = get_inherited_methods_implementation(method);
 
   if (get_entity_peculiarity(method) != peculiarity_description) {
-    //if (get_entity_irg(impl)) {
     eset_insert(set, impl);
     ++(*size);
-      //} else {
-      /* GL: better: eset_insert(set, unknown_entity); */
-      //*open = true;
-      //}
   }
 
   /*- recursive descent -*/
@@ -186,27 +155,32 @@ static entity ** get_impl_methods(entity * method) {
 /** Analyze address computations.
  *
  *  Compute for all Sel nodes the set of methods that can be selected.
+ *  For each entity we store the set of subentities in the link field.
  *
  *  Further do some optimizations:
  *  - Call standard optimizations for Sel nodes: this removes polymorphic
  *    calls.
  *  - If the node is a SymConst(name) replace it by SymConst(ent) if possible.
- *    For this we precomputed a map name->entity.
+ *    For this we precomputed a map name->entity.  Nowadays, we no more support
+ *    this and assert.
  *  - If the node is a Sel:
- *     If we found only a single method that can be called, replace the Sel
- *     by a SymConst.  This is more powerful than the analysis in opt_polymorphy,
- *     as here we walk the typegraph.  In opt_polymorphy we only apply a local
- *     pattern.
+ *    If we found only a single method that can be called, replace the Sel
+ *    by a SymConst.  This is more powerful than the analysis in opt_polymorphy,
+ *    as here we walk the type graph.  In opt_polymorphy we only apply a local
+ *    pattern.
  *
  *  @param node The node to analyze
  *  @param env  A map that maps names of entities to the entities.
  */
 static void sel_methods_walker(ir_node * node, void *env) {
   pmap *ldname_map = env;
+  entity **arr;
 
+  /* Call standard optimizations */
   if (get_irn_op(node) == op_Sel) {
     ir_node *new_node = optimize_in_place(node);
-    if (node != new_node) exchange(node, new_node);
+    if (node != new_node)
+      exchange(node, new_node);
   }
 
   /* replace SymConst(name)-operations by SymConst(ent) */
@@ -214,92 +188,77 @@ static void sel_methods_walker(ir_node * node, void *env) {
     if (get_SymConst_kind(node) == symconst_addr_name) {
       pmap_entry * entry = pmap_find(ldname_map, (void *) get_SymConst_name(node));
       if (entry != NULL) { /* Method is declared in the compiled code */
-       assert(0 && "There should not be a SymConst[addr_name] addressing a method with an implementation"
-              "in this compilation unit.  Use a SymConst[addr_ent].");
-#if 0
-       entity * ent = entry->value;
-       if (get_opt_normalize() &&
-           (get_entity_visibility(ent) != visibility_external_allocated)) { /* Meth. is defined */
-          ir_node *new_node;
-
-         set_irg_current_block(current_ir_graph, get_nodes_block(node));
-         new_node = copy_const_value(get_atomic_ent_value(ent));
-
-         DBG_OPT_CSTEVAL(node, new_node);
-
-         assert(get_entity_irg(ent));
-         DDMN(new_node);
-         exchange(node, new_node);
-       }
-#endif
+        assert(0 && "There should not be a SymConst[addr_name] addressing a method with an implementation"
+                    "in this compilation unit.  Use a SymConst[addr_ent].");
       }
     }
   }
   else if (get_irn_op(node) == op_Sel &&
-          is_Method_type(get_entity_type(get_Sel_entity(node)))) {
-    entity * ent = get_Sel_entity(node);
+           is_Method_type(get_entity_type(get_Sel_entity(node)))) {
+    entity * ent = get_SymConst_entity(get_atomic_ent_value(get_Sel_entity(node)));
     assert(get_entity_peculiarity(ent) != peculiarity_inherited);
 
     if (!eset_contains(entities, ent)) {
-      /* Entity noch nicht behandelt. Alle (intern oder extern)
-       * implementierten Methoden suchen, die diese Entity
-       * überschreiben. Die Menge an entity.link speichern. */
+      /* Entity not yet handled. Find all (internal or external)
+       * implemented methods that overwrites this entity.
+       * This set is stored in the entity link. */
       set_entity_link(ent, get_impl_methods(ent));
       eset_insert(entities, ent);
     }
 
     /* -- As an add on we get an optimization that removes polymorphic calls.
-       This optimization is more powerful than that in transform_node_Sel.  -- */
-    if (get_entity_link(ent) == NULL) {
-      /* Die Sel-Operation kann nie einen Zeiger auf eine aufrufbare
-       * Methode zurückgeben. Damit ist sie insbesondere nicht
-       * ausführbar und nicht erreichbar. */
-      /* Gib eine Warnung aus wenn die Entitaet eine Beschreibung ist
-        fuer die es keine Implementierung gibt. */
-      if (get_entity_peculiarity(ent) == peculiarity_description) {
-       /* This is possible:  We call a method in a dead part of the program. */
-      } else {
-       DDMN(node);
-       assert(0);  /* Why should this happen ??? */
-       //exchange(node, new_Bad());
-      }
-    } else {
-      entity ** arr = get_entity_link(ent);
-      if (get_opt_optimize() && get_opt_dyn_meth_dispatch() &&
-         (ARR_LEN(arr) == 1 && arr[0] != NULL)) {
-       ir_node *new_node;
-       /* Die Sel-Operation kann immer nur _einen_ Wert auf eine
-        * interne Methode zurückgeben. Wir können daher die
-        * Sel-Operation durch eine Const- bzw. SymConst-Operation
-        * ersetzen. */
-       set_irg_current_block(current_ir_graph, get_nodes_block(node));
-       assert(get_entity_peculiarity(get_SymConst_entity(get_atomic_ent_value(arr[0]))) ==
-              peculiarity_existent);
-       new_node = copy_const_value(get_atomic_ent_value(arr[0]));
-       DBG_OPT_POLY(node, new_node);
-       exchange (node, new_node);
-      }
+       This optimization is more powerful than that in transform_node_Sel().  -- */
+    arr = get_entity_link(ent);
+    if (arr == NULL) {
+      /*
+       * The Sel node never returns a pointer to a usable method.
+       * We could not call it, but it may be description:
+       * We call a method in a dead part of the program.
+       */
+      assert (get_entity_peculiarity(ent) == peculiarity_description);
+    }
+    else if (get_opt_optimize() && get_opt_dyn_meth_dispatch() &&
+        (ARR_LEN(arr) == 1 && arr[0] != NULL)) {
+      ir_node *new_node;
+
+      /*
+       * The Sel node returns only one possible method.
+       * So we could replace the Sel node by a SymConst.
+       * This method must exists.
+       */
+      set_irg_current_block(current_ir_graph, get_nodes_block(node));
+      assert(get_entity_peculiarity(get_SymConst_entity(get_atomic_ent_value(arr[0]))) ==
+             peculiarity_existent);
+      new_node = copy_const_value(get_irn_dbg_info(node), get_atomic_ent_value(arr[0]));
+      DBG_OPT_POLY(node, new_node);
+      exchange(node, new_node);
     }
   }
 }
 
-/** Datenstruktur initialisieren. Zusätzlich werden alle
- *  SymConst(name)-Operationen, die auf interne Methoden verweisen, durch
- *  SymConst(entity)-Operationen ersetzt. */
+/** Initialize auxiliary data structures.
+ *
+ *  Computes a set of entities that overwrite an entity and contain
+ *  an implementation. The set is stored in the entity's link field.
+ *
+ *  Further replaces Sel nodes where this set contains exactly one
+ *  method by SymConst nodes.
+ *  Finally asserts if there is a SymConst(name) if there could be a
+ *  SymConst(ent). */
 static void sel_methods_init(void) {
   int i;
   pmap * ldname_map = pmap_create();   /* Map entity names to entities: to replace
-                                         SymConst(name) by SymConst(ent). */
+                                          SymConst(name) by SymConst(ent). */
   assert(entities == NULL);
   entities = eset_create();
   for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
     entity * ent = get_irg_entity(get_irp_irg(i));
-    /* Nur extern sichtbare Methoden können überhaupt mit SymConst_ptr_name
-     * aufgerufen werden. */
+    /* only external visible methods are allowed to call by a SymConst_ptr_name */
     if (get_entity_visibility(ent) != visibility_local) {
       pmap_insert(ldname_map, (void *) get_entity_ld_ident(ent), ent);
     }
   }
+
   all_irg_walk(sel_methods_walker, NULL, ldname_map);
   pmap_destroy(ldname_map);
 }
@@ -314,6 +273,8 @@ static void sel_methods_init(void) {
 /**
  * Returns an array of all methods that could be called at a Sel node.
  * This array contains every entry only once.
+ *
+ * @param sel  the Sel node
  */
 static entity ** get_Sel_arr(ir_node * sel) {
   static entity ** NULL_ARRAY = NULL;
@@ -322,6 +283,8 @@ static entity ** get_Sel_arr(ir_node * sel) {
 
   assert(sel && get_irn_op(sel) == op_Sel);
   ent = get_Sel_entity(sel);
+  ent = get_inherited_methods_implementation(ent);
+
   assert(is_Method_type(get_entity_type(ent))); /* what else? */
   arr = get_entity_link(ent);
   if (arr) {
@@ -338,6 +301,8 @@ static entity ** get_Sel_arr(ir_node * sel) {
 
 /**
  * Returns the number of possible called methods at a Sel node.
+ *
+ * @param sel  the Sel node
  */
 static int get_Sel_n_methods(ir_node * sel) {
   return ARR_LEN(get_Sel_arr(sel));
@@ -386,7 +351,7 @@ static void free_mark_proj(ir_node * node, long n, eset * set) {
   case iro_Start:
   case iro_Alloc:
   case iro_Load:
-    /* nothing: Die Operationen werden in "free_ana_walker" selbst
+    /* nothing: Die Operationen werden in free_ana_walker() selbst
      * behandelt. */
     break;
 
@@ -397,14 +362,25 @@ static void free_mark_proj(ir_node * node, long n, eset * set) {
   set_irn_link(node, NULL);
 }
 
-
-static void free_mark(ir_node * node, eset * set) {
+/**
+ * Called for predecessors nodes of "interesting" ones.
+ * Interesting ones include all nodes that can somehow make
+ * a method visible.
+ *
+ * If a method (or a set of methods in case of polymorph calls) gets visible,
+ * add it to the set of 'free' methods
+ *
+ * @param node  the current visited node
+ * @param set   the set of all free methods
+ */
+static void free_mark(ir_node *node, eset * set) {
   int i;
 
-  if (get_irn_link(node) == MARK) {
+  if (get_irn_link(node) == MARK)
     return; /* already visited */
-  }
+
   set_irn_link(node, MARK);
+
   switch (get_irn_opcode(node)) {
   case iro_Sel: {
     entity * ent = get_Sel_entity(node);
@@ -445,11 +421,15 @@ static void free_mark(ir_node * node, eset * set) {
   set_irn_link(node, NULL);
 }
 
-
-static void free_ana_walker(ir_node * node, eset * set) {
+/**
+ * post-walker. Find method addresses.
+ */
+static void free_ana_walker(ir_node *node, void *env) {
+  eset *set = env;
   int i;
+
   if (get_irn_link(node) == MARK) {
-    /* bereits in einem Zyklus besucht. */
+    /* already visited */
     return;
   }
   switch (get_irn_opcode(node)) {
@@ -467,8 +447,8 @@ static void free_ana_walker(ir_node * node, eset * set) {
    * Verräter ist. */
   case iro_Call:
     set_irn_link(node, MARK);
-    for (i = get_Call_arity(node) - 1; i >= 0; --i) {
-      ir_node * pred = get_Call_param(node, i);
+    for (i = get_Call_n_params(node) - 1; i >= 0; --i) {
+      ir_node *pred = get_Call_param(node, i);
       if (mode_is_reference(get_irn_mode(pred))) {
         free_mark(pred, set);
       }
@@ -489,49 +469,120 @@ static void free_ana_walker(ir_node * node, eset * set) {
   set_irn_link(node, NULL);
 }
 
-/* Die Datenstrukturen für sel-Methoden (sel_methods) muß vor dem
+/**
+ * Add all method addresses in global initializers to the set.
+ *
+ * @note
+ * We do NOT check the type here, just it it's an entity address.
+ * The reason for this is code like:
+ *
+ * void *p = function;
+ *
+ * which is sometimes used to anchor functions.
+ */
+static void add_method_address(entity *ent, eset *set)
+{
+  ir_node *n;
+  type *tp;
+  int i;
+
+  /* do not check uninitialized values */
+  if (get_entity_variability(ent) == variability_uninitialized)
+    return;
+
+  if (is_atomic_entity(ent)) {
+    tp = get_entity_type(ent);
+
+    /* ignore methods: these of course reference it's address */
+    if (is_Method_type(tp))
+      return;
+
+    /* let's check if it's the address of a function */
+    n = get_atomic_ent_value(ent);
+    if (get_irn_op(n) == op_SymConst) {
+      if (get_SymConst_kind(n) == symconst_addr_ent) {
+        ent = get_SymConst_entity(n);
+
+        if (is_Method_type(get_entity_type(ent)))
+          eset_insert(set, ent);
+      }
+    }
+  }
+  else {
+    for (i = get_compound_ent_n_values(ent) - 1; i >= 0; --i) {
+      n = get_compound_ent_value(ent, i);
+
+      /* let's check if it's the address of a function */
+      if (get_irn_op(n) == op_SymConst) {
+        if (get_SymConst_kind(n) == symconst_addr_ent) {
+          entity *ent = get_SymConst_entity(n);
+
+          if (is_Method_type(get_entity_type(ent)))
+            eset_insert(set, ent);
+        }
+      }
+    }
+  }
+}
+
+/**
+ * returns a list of 'free' methods, i.e., the methods that can be called
+ * from external or via function pointers.
+ *
+ * Die Datenstrukturen für sel-Methoden (sel_methods) muß vor dem
  * Aufruf von "get_free_methods" aufgebaut sein. Die (internen)
  * SymConst(name)-Operationen müssen in passende SymConst(ent)-Operationen
  * umgewandelt worden sein, d.h. SymConst-Operationen verweisen immer
- * auf eine echt externe Methode. */
+ * auf eine echt externe Methode.
+ */
 static entity ** get_free_methods(void)
 {
-  eset * set = eset_create();
+  eset *free_set = eset_create();
   int i;
-  entity ** arr = NEW_ARR_F(entity *, 0);
-  entity * ent;
+  entity **arr = NEW_ARR_F(entity *, 0);
+  entity *ent;
+  ir_graph *irg;
+  type *glob;
 
   for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
-    ir_graph * irg = get_irp_irg(i);
-    entity * ent = get_irg_entity(irg);
+    irg = get_irp_irg(i);
+    ent = get_irg_entity(irg);
     /* insert "external visible" methods. */
     if (get_entity_visibility(ent) != visibility_local) {
-      eset_insert(set, ent);
+      eset_insert(free_set, ent);
     }
     /* Finde alle Methoden die in dieser Methode extern sichtbar werden,
        z.B. da die Adresse einer Methode abgespeichert wird. */
-    irg_walk_graph(irg, NULL, (irg_walk_func *) free_ana_walker, set);
+    irg_walk_graph(irg, NULL, free_ana_walker, free_set);
   }
 
   /* insert sticky methods, too */
   for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
-    entity * ent = get_irg_entity(get_irp_irg(i));
-    /* insert "external visible" methods. */
+    ent = get_irg_entity(get_irp_irg(i));
+    /* insert "sticky" methods. */
     if (get_entity_stickyness (ent) == stickyness_sticky) {
-      eset_insert(set, ent);
+      eset_insert(free_set, ent);
     }
   }
 
-  /* Hauptprogramm ist auch dann frei, wenn es nicht "external
-   * visible" ist. */
-  if (get_irp_main_irg()) {
-    eset_insert(set, get_irg_entity(get_irp_main_irg()));
+  /* insert all methods the initializes global variables */
+  glob = get_glob_type();
+  for (i = get_class_n_members(glob) - 1; i >= 0; --i) {
+    ent = get_class_member(glob, i);
+
+    add_method_address(ent, free_set);
   }
-  /* Wandle Menge in Feld um.  Effizienter. */
-  for (ent = eset_first(set); ent; ent = eset_next(set)) {
+
+  /* the main program is even then "free", if it's not external visible. */
+  irg = get_irp_main_irg();
+  if (irg)
+    eset_insert(free_set, get_irg_entity(irg));
+
+  /* Finally, transform the set into an array. */
+  for (ent = eset_first(free_set); ent; ent = eset_next(free_set)) {
     ARR_APP1(entity *, arr, ent);
   }
-  eset_destroy(set);
+  eset_destroy(free_set);
 
   return arr;
 }
@@ -656,7 +707,7 @@ static void callee_ana_node(ir_node * node, eset * methods) {
   set_irn_link(node, NULL);
 }
 
-
+/* */
 static void callee_walker(ir_node * call, void * env) {
   if (get_irn_op(call) == op_Call) {
     eset * methods = eset_create();
@@ -669,11 +720,11 @@ static void callee_walker(ir_node * call, void * env) {
     }
     for (ent = eset_first(methods); ent; ent = eset_next(methods)) {
       if (ent != MARK) {
-       ARR_APP1(entity *, arr, ent);
+        ARR_APP1(entity *, arr, ent);
       }
     }
 #if 0  /* This generates Bad nodes when we don't want it.
-         Call it with a check for valid cgana information in local_optimize. */
+          Call it with a check for valid cgana information in local_optimize. */
     if (ARR_LEN(arr) == 0 && get_opt_optimize() && get_opt_dyn_meth_dispatch()) {
       /* Kann vorkommen, wenn der Vorgänger beispielsweise eine
        * Sel-Operation war, die keine Methoden zurückgeben
@@ -691,12 +742,6 @@ static void callee_walker(ir_node * call, void * env) {
     } else
 #endif
     {
-      /* remove, what we repaired. */
-      int i;
-      for (i = 0; i < ARR_LEN(arr); ++i) {
-       assert(arr[i]);
-      }
-
       set_Call_callee_arr(call, ARR_LEN(arr), arr);
     }
     DEL_ARR_F(arr);
@@ -764,6 +809,7 @@ static void destruct_walker(ir_node * node, void * env) {
 void cgana(int *length, entity ***free_methods) {
   entity ** free_meths, **p;
 
+  /* Optimize Sel/SymConst nodes and compute all methods that implement an entity. */
   sel_methods_init();
   free_meths = get_free_methods();
   callee_ana();
@@ -785,18 +831,25 @@ void free_callee_info(ir_graph *irg) {
   set_irg_callee_info_state(irg, irg_callee_info_none);
 }
 
+void free_irp_callee_info(void) {
+  int i;
+  for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
+    free_callee_info(get_irp_irg(i));
+  }
+}
+
 /* Optimize the address expressions passed to call nodes.
  *
  * This optimization performs the following transformations for
  * all ir graphs:
  * - All SymConst operations that refer to intern methods are replaced
- *   by Const operations refering to the corresponding entity.
+ *   by Const operations referring to the corresponding entity.
  * - Sel nodes, that select entities that are not overwritten are
- *   replaced by Const nodes refering to the selected entity.
+ *   replaced by Const nodes referring to the selected entity.
  * - Sel nodes, for which no method exists at all are replaced by Bad
  *   nodes.
  * - Sel nodes with a pointer input that is an Alloc node are replaced
- *   by Const nodes refering to the entity that implements the method in
+ *   by Const nodes referring to the entity that implements the method in
  *   the type given by the Alloc node.
  */
 void opt_call_addrs(void) {