Add is_cdep_on
[libfirm] / ir / ana / field_temperature.c
index cc4140e..c179f07 100644 (file)
  * Licence:     This file protected by GPL -  GNU GENERAL PUBLIC LICENSE.
  */
 
+#include <math.h>
+
 #include "field_temperature.h"
 
+#include "trouts.h"
+#include "execution_frequency.h"
+
 #include "irnode_t.h"
 #include "irgraph_t.h"
 #include "irprog_t.h"
 /* initialize, global variables.                                               */
 /* *************************************************************************** */
 
-/* A list of Load and Store operations that have no analyseable address. */
-static ir_node **unrecognized_access = NULL;
-
-static void add_unrecognized_access(ir_node *n) {
-  ARR_APP1(ir_node *, unrecognized_access, n);
-}
-
 /* *************************************************************************** */
-/*   Access routines for entities                                              */
+/*   Access routines for irnodes                                               */
 /* *************************************************************************** */
 
-int get_entity_n_accesses(entity *ent) {
-  assert(ent && is_entity(ent));
-
-  if (!ent->accesses) { ent->accesses = NEW_ARR_F(ir_node *, 0); }
+/* The entities that can be accessed by this Sel node. */
+int get_Sel_n_accessed_entities(ir_node *sel) {
+  return 1;
+}
 
-  return ARR_LEN(ent->accesses);
+entity *get_Sel_accessed_entity(ir_node *sel, int pos) {
+  return get_Sel_entity(sel);
 }
 
-ir_node *get_entity_access(entity *ent, int pos) {
-  assert(0 <= pos && pos < get_entity_n_accesses(ent));
+/* *************************************************************************** */
+/* The heuristic                                                               */
+/* *************************************************************************** */
 
-  return ent->accesses[pos];
+int get_irn_loop_call_depth(ir_node *n) {
+  ir_graph *irg = get_irn_irg(n);
+  return get_irg_loop_depth(irg);
 }
 
-void add_entity_access(entity *ent, ir_node *n) {
-  assert(ent && is_entity(ent));
-  assert(n && is_ir_node(n));
-
-  if (!ent->accesses) ent->accesses = NEW_ARR_F(ir_node *, 0);
+int get_irn_cfloop_depth(ir_node *n) {
+  ir_loop *l = get_irn_loop(get_nodes_block(n));
+  if (l)
+    return get_loop_depth(l);
+  else
+    return 0;
+}
 
-  ARR_APP1(ir_node *, ent->accesses, n);
+int get_irn_recursion_depth(ir_node *n) {
+  ir_graph *irg = get_irn_irg(n);
+  return get_irg_recursion_depth(irg);
 }
 
-void set_entity_access(entity *ent, int pos, ir_node *n) {
-  assert(0 <= pos && pos < get_entity_n_accesses(ent));
-  assert(n && is_ir_node(n));
 
-  ent->accesses[pos] = n;
+/**   @@@ the second version of the heuristic. */
+int get_weighted_loop_depth(ir_node *n) {
+  int loop_call_depth = get_irn_loop_call_depth(n);
+  int loop_depth      = get_irn_cfloop_depth(n);
+  int recursion_depth = get_irn_recursion_depth(n);
+
+  return loop_call_depth + loop_depth + recursion_depth;
 }
 
 
 /* *************************************************************************** */
-/*   Access routines for nodes                                                 */
+/* The 2. heuristic                                                            */
 /* *************************************************************************** */
 
-/* *************************************************************************** */
-/*   Access routines for irnodes                                               */
-/* *************************************************************************** */
+static int default_recursion_weight = 5;
+
+/* The final evaluation of a node.  In this function we can
+   adapt the heuristic.  Combine execution frequency with
+   recursion depth.
+   @@@ the second version of the heuristic.
+
+   Return 0 if the node is neither in a loop nor in a recursion.  */
+double get_irn_final_cost(ir_node *n) {
+  double cost_loop   = get_irn_exec_freq(n);
+  double cost_method = get_irg_method_execution_frequency(get_irn_irg(n));
+  int    rec_depth   = get_irn_recursion_depth(n);
+  double cost_rec    = 0;
+
+#if 0
+  if (get_irn_recursion_depth(n) == 0 &&
+      get_irn_loop_depth(n) == 0 &&
+      get_irg_method_loop_depth(get_irn_irg(n)) == 0)
+    return 0;
+#else
+  if (get_weighted_loop_depth(n) == 0) return 0;
+#endif
+
+  if (rec_depth) cost_rec = pow(default_recursion_weight, rec_depth);
+  return cost_loop*(cost_method + cost_rec);
+}
 
-/* The entities that can be accessed by this Sel node. */
-int get_Sel_n_accessed_entities(ir_node *sel) {
-  return 1;
+double get_type_estimated_n_instances(ir_type *tp) {
+  int i, n_allocs = get_type_n_allocs(tp);
+  double n_instances = 0;
+  for (i = 0; i < n_allocs; ++i) {
+    ir_node *alloc = get_type_alloc(tp, i);
+    n_instances += get_irn_final_cost(alloc);
+  }
+  return n_instances;
 }
 
-entity *get_Sel_accessed_entity(ir_node *sel, int pos) {
-  return get_Sel_entity(sel);
+double get_type_estimated_mem_consumption_bytes(ir_type *tp) {
+  assert(0);
+  return 0.0;
 }
 
-/* An addr node is a SymConst or a Sel. */
-int get_addr_n_entities(ir_node *addr) {
-  int n_ents;
+int get_type_estimated_n_fields(ir_type *tp) {
+  int s = 0;
+  switch(get_type_tpop_code(tp)) {
 
-  switch (get_irn_opcode(addr)) {
-  case iro_Sel:
-    /* Treat jack array sels? */
-    n_ents = get_Sel_n_accessed_entities(addr);
+  case tpo_primitive:
+  case tpo_pointer:
+  case tpo_enumeration:
+    s = 1;
     break;
-  case iro_SymConst:
-    if (get_SymConst_kind(addr) == symconst_addr_ent) {
-      n_ents = 1;
-      break;
+
+  case tpo_class:
+    s = 1; /* dispatch pointer */
+    /* fall through */
+  case tpo_struct: {
+    int i, n_mem = get_compound_n_members(tp);
+    for (i = 0; i < n_mem; ++i) {
+      entity *mem = get_compound_member(tp, i);
+      if (get_entity_allocation(mem) == allocation_automatic) {
+       s += get_type_estimated_n_fields(get_entity_type(mem));
+      }
     }
-  default:
-    //assert(0 && "unexpected address expression");
-    n_ents = 0;
+  } break;
+
+  case tpo_array: {
+    long n_elt = DEFAULT_N_ARRAY_ELEMENTS;
+    assert(get_array_n_dimensions(tp) == 1 && "other not implemented");
+    if ((get_irn_op(get_array_lower_bound(tp, 0)) == op_Const) &&
+       (get_irn_op(get_array_upper_bound(tp, 0)) == op_Const)   ) {
+      n_elt = get_array_upper_bound_int(tp, 0) - get_array_upper_bound_int(tp, 0);
+    }
+    s = n_elt;
+  } break;
+
+  default: DDMT(tp); assert(0);
   }
 
-  return n_ents;
+  return s;
 }
 
-/* An addr node is a SymConst or a Sel. */
-entity *get_addr_entity(ir_node *addr, int pos) {
-  entity *ent;
+int get_type_estimated_size_bytes(ir_type *tp) {
+  int s = 0;
+
+  switch(get_type_tpop_code(tp)) {
 
-  switch (get_irn_opcode(addr)) {
-  case iro_Sel:
-    /* Treat jack array sels? */
-    assert (0 <= pos && pos < get_Sel_n_accessed_entities(addr));
-    ent = get_Sel_accessed_entity(addr, pos);
+  case tpo_primitive:
+  case tpo_pointer:
+  case tpo_enumeration:
+    s = get_mode_size_bytes(get_type_mode(tp));
     break;
-  case iro_SymConst:
-    if (get_SymConst_kind(addr) == symconst_addr_ent) {
-      assert(pos == 0);
-      ent = get_SymConst_entity(addr);
-      break;
+
+  case tpo_class:
+    s = get_mode_size_bytes(mode_P_data); /* dispatch pointer */
+    /* fall through */
+  case tpo_struct: {
+    int i, n_mem = get_compound_n_members(tp);
+    for (i = 0; i < n_mem; ++i) {
+      entity *mem = get_compound_member(tp, i);
+      s += get_type_estimated_size_bytes(get_entity_type(mem));
+
+      if (get_entity_allocation(mem) == allocation_automatic) {
+      } /* allocation_automatic */
+    }
+  } break;
+
+  case tpo_array: {
+    int elt_s = get_type_estimated_size_bytes(get_array_element_type(tp));
+    long n_elt = DEFAULT_N_ARRAY_ELEMENTS;
+    assert(get_array_n_dimensions(tp) == 1 && "other not implemented");
+    if ((get_irn_op(get_array_lower_bound(tp, 0)) == op_Const) &&
+       (get_irn_op(get_array_upper_bound(tp, 0)) == op_Const)   ) {
+      n_elt = get_array_upper_bound_int(tp, 0) - get_array_lower_bound_int(tp, 0);
     }
-  default:
-    ent = NULL;
+    s = n_elt * elt_s;
+    break;
   }
 
-  return ent;
-}
-
-
-int get_irn_loop_call_depth(ir_node *n) {
-  ir_graph *irg = get_irn_irg(n);
-  return get_irg_loop_depth(irg);
-}
+  default: DDMT(tp); assert(0);
+  }
 
-int get_irn_loop_depth(ir_node *n) {
-  get_loop_depth(get_irn_loop(get_nodes_block(n)));
+  return s;
 }
 
-int get_irn_recursion_depth(ir_node *n) {
-  ir_graph *irg = get_irn_irg(n);
-  return get_irg_recursion_depth(irg);
+double get_type_estimated_n_casts(ir_type *tp) {
+  int i, n_casts = get_type_n_casts(tp);
+  double n_instances = 0;
+  for (i = 0; i < n_casts; ++i) {
+    ir_node *cast = get_type_cast(tp, i);
+    n_instances += get_irn_final_cost(cast);
+  }
+  return n_instances;
 }
 
+double get_class_estimated_n_upcasts(ir_type *clss) {
+  double n_instances = 0;
+  int i, j, n_casts, n_pointertypes;
 
-/* *************************************************************************** */
-/* The heuristic                                                               */
-/* *************************************************************************** */
-
-int get_weighted_loop_depth(ir_node *n) {
-  int loop_call_depth = get_irn_loop_call_depth(n);
-  int loop_depth      = get_irn_loop_depth(n);
-  int recursion_depth = get_irn_recursion_depth(n);
+  n_casts = get_type_n_casts(clss);
+  for (i = 0; i < n_casts; ++i) {
+    ir_node *cast = get_type_cast(clss, i);
+    if (get_irn_opcode(cast) != iro_Cast) continue;  /* Could be optimized away. */
 
-  return loop_call_depth + loop_depth + recursion_depth;
-}
+    if (is_Cast_upcast(cast))
+      n_instances += get_irn_final_cost(cast);
+  }
 
-/* *************************************************************************** */
-/* The analyses                                                                */
-/* *************************************************************************** */
+  n_pointertypes = get_type_n_pointertypes_to(clss);
+  for (j = 0; j < n_pointertypes; ++j) {
+    n_instances += get_class_estimated_n_upcasts(get_type_pointertype_to(clss, j));
+  }
 
-void init_field_temperature(void) {
-  assert(!unrecognized_access);
-  unrecognized_access = NEW_ARR_F(ir_node *, 0);
+  return n_instances;
 }
 
+double get_class_estimated_n_downcasts(ir_type *clss) {
+  double n_instances = 0;
+  int i, j, n_casts, n_pointertypes;
 
-void chain_accesses(ir_node *n, void *env) {
-  int i, n_ents;
-  ir_node *addr;
+  n_casts = get_type_n_casts(clss);
+  for (i = 0; i < n_casts; ++i) {
+    ir_node *cast = get_type_cast(clss, i);
+    if (get_irn_opcode(cast) != iro_Cast) continue;  /* Could be optimized away. */
 
-  if (is_memop(n)) {
-    addr = get_memop_ptr(n);
-  } else {
-    return;
+    if (is_Cast_downcast(cast))
+      n_instances += get_irn_final_cost(cast);
   }
 
-  n_ents = get_addr_n_entities(addr);
-  for (i = 0; i < n_ents; ++i) {
-    entity *ent = get_addr_entity(addr, i);
-    if (ent)
-      add_entity_access(ent, n);
-    else
-      add_unrecognized_access(n);
+  n_pointertypes = get_type_n_pointertypes_to(clss);
+  for (j = 0; j < n_pointertypes; ++j) {
+    n_instances += get_class_estimated_n_downcasts(get_type_pointertype_to(clss, j));
   }
+
+  return n_instances;
 }
 
 
-/* compute the field temperature. */
-void compute_field_temperature(void) {
+double get_class_estimated_dispatch_writes(ir_type *clss) {
+  return get_type_estimated_n_instances(clss);
+}
+
+/** Returns the number of reads of the dispatch pointer. */
+double get_class_estimated_dispatch_reads (ir_type *clss) {
+  int i, n_mems = get_class_n_members(clss);
+  double n_calls = 0;
+  for (i = 0; i < n_mems; ++i) {
+    entity *mem = get_class_member(clss, i);
+    n_calls += get_entity_estimated_n_dyncalls(mem);
+  }
+  return n_calls;
+}
 
-  int i, n_irgs = get_irp_n_irgs();
+double get_class_estimated_n_dyncalls(ir_type *clss) {
+  return get_class_estimated_dispatch_reads(clss) +
+         get_class_estimated_dispatch_writes(clss);
+}
 
-  init_field_temperature();
+double get_entity_estimated_n_loads(entity *ent) {
+  int i, n_acc = get_entity_n_accesses(ent);
+  double n_loads = 0;
+  for (i = 0; i < n_acc; ++i) {
+    ir_node *acc = get_entity_access(ent, i);
+    if (get_irn_op(acc) == op_Load) {
+      n_loads += get_irn_final_cost(acc);
+    }
+  }
+  return n_loads;
+}
 
-  for (i=0; i < n_irgs; i++) {
-    current_ir_graph = get_irp_irg(i);
-    irg_walk_graph(current_ir_graph, NULL, chain_accesses, NULL);
+double get_entity_estimated_n_stores(entity *ent) {
+  int i, n_acc = get_entity_n_accesses(ent);
+  double n_stores = 0;
+  for (i = 0; i < n_acc; ++i) {
+    ir_node *acc = get_entity_access(ent, i);
+    if (get_irn_op(acc) == op_Store)
+      n_stores += get_irn_final_cost(acc);
   }
+  return n_stores;
 }
 
-/* free occupied memory, reset */
-void free_field_temperature(void) {
-  DEL_ARR_F(unrecognized_access);
-  unrecognized_access = NULL;
+/* @@@ Should we evaluate the callee array?  */
+double get_entity_estimated_n_calls(entity *ent) {
+  int i, n_acc = get_entity_n_accesses(ent);
+  double n_calls = 0;
+  for (i = 0; i < n_acc; ++i) {
+    ir_node *acc = get_entity_access(ent, i);
+    if (get_irn_op(acc) == op_Call)
+
+      n_calls += get_irn_final_cost(acc);
+  }
+  return n_calls;
 }
 
+double get_entity_estimated_n_dyncalls(entity *ent) {
+  int i, n_acc = get_entity_n_accesses(ent);
+  double n_calls = 0;
+  for (i = 0; i < n_acc; ++i) {
+    ir_node *acc = get_entity_access(ent, i);
+
+    /* Call->Sel(ent) combination */
+    if (is_Call(acc) && is_Sel(get_Call_ptr(acc))) {
+      n_calls += get_irn_final_cost(acc);
+
+    /* MemOp->Sel combination for static, overwritten entities */
+    } else if (is_memop(acc) && is_Sel(get_memop_ptr(acc))) {
+      entity *ent = get_Sel_entity(get_memop_ptr(acc));
+      if (is_Class_type(get_entity_owner(ent))) {
+        /* We might call this for inner entities in compounds. */
+        if (get_entity_n_overwrites(ent) > 0 ||
+            get_entity_n_overwrittenby(ent) > 0) {
+          n_calls += get_irn_final_cost(acc);
+        }
+      }
+    }
 
+  }
+  return n_calls;
+}
 
-/* *************************************************************************** */
-/* Auxiliary                                                                   */
-/* *************************************************************************** */
+/* ------------------------------------------------------------------------- */
+/* Auxiliary                                                                 */
+/* ------------------------------------------------------------------------- */
 
+int is_jack_rts_name(ident *name) {
+  if (id_is_suffix(new_id_from_str("Exception"), name)) return 1;
+  if (id_is_suffix(new_id_from_str("Throwable"), name)) return 1;
+  if (id_is_suffix(new_id_from_str("Error"),     name)) return 1;
 
-int is_jack_rts_class(type *t) {
-  ident *name = get_type_ident(t);
+  return  0;
 
   if (id_is_prefix(new_id_from_str("java/"), name)) return 1;
-  if (id_is_prefix(new_id_from_str("["), name)) return 1;
-  if (id_is_prefix(new_id_from_str("gnu/"), name)) return 1;
+  if (id_is_prefix(new_id_from_str("["),     name)) return 1;
+  if (id_is_prefix(new_id_from_str("gnu/"),  name)) return 1;
   if (id_is_prefix(new_id_from_str("java/"), name)) return 1;
+  if (id_is_prefix(new_id_from_str("CStringToCoreString"), name)) return 1;
 
   return 0;
 }
+
+
+int is_jack_rts_class(ir_type *t) {
+  ident *name = get_type_ident(t);
+  return is_jack_rts_name(name);
+}
+
+#include "entity_t.h"  // for the assertion.
+
+int is_jack_rts_entity(entity *e) {
+  ident *name;
+
+  assert(e->ld_name);
+  name = get_entity_ld_ident(e);
+
+  return is_jack_rts_name(name);
+}