fixed CRLF
[libfirm] / ir / ana / field_temperature.h
index 3cfc7ba..50e990d 100644 (file)
 /**
  * @file field_temperature.h
  *
+ *  @author Goetz Lindenmaier
+ *
  *  Watch it! This is highly java dependent.
  *
  * - All Sel nodes get an array with possibly accessed entities.
  *   (resolve polymorphy on base of inherited entities.)
  *   (the mentioned entity in first approximation.)
  *
- * - Each entity gets all SymConst/Sel nodes, that reference the
- *   entity (Sel: references as accessed entity.)
- *
  * - We compute a value for the entity based on the Sel nodes.
  */
 
-#include "irnode.h"
-#include "entity.h"
+#include "firm_types.h"
 
+/* The number of array elements we assume if not both bounds are given. */
+#define DEFAULT_N_ARRAY_ELEMENTS 1
 
 
-/** The entities that can be accessed by this Sel node. */
+/** The entities that can be accessed by this Sel node. *
 int     get_Sel_n_accessed_entities(ir_node *sel);
 entity *get_Sel_accessed_entity    (ir_node *sel, int pos);
+*/
 
-
-/** Number of Load/Store nodes that possibly access this entity. */
-int get_entity_n_accesses(entity *ent);
-/** Load/Store node that possibly access this entity. */
-ir_node *get_entity_access(entity *ent, int pos);
-
-/** Number of Alloc nodes that create an instance of this type */
-int get_type_n_allocations(type *tp);
-/** Alloc node that create an instance of this type */
-ir_node *get_type_allocation(type *tp, int pos);
-
+int get_irn_loop_call_depth(ir_node *n);
+/** Return loop depth of node.
+ *
+ *  Returns the loop depth of n in the control flow.  I.e., we
+ *  go from the node to the block to the loop the block is in,
+ *  and return its depth.  */
+int get_irn_cfloop_depth(ir_node *n);
+int get_irn_recursion_depth(ir_node *n);
 
 /** Get the weighted interprocedural loop depth of the node.
-    The depth is estimated by a heuristic. */
+    The depth is estimated by a heuristic. The heuristic consideres
+    loop and recursion depth. */
 int get_weighted_loop_depth(ir_node *n);
 
+/** Heuristic merging recursion and loop depth. */
+double get_irn_final_cost(ir_node *n);
 
-
-
-/** compute the field temperature. */
-void compute_field_temperature(void);
-
-/** free occupied memory, reset */
-void free_field_temperature(void);
-
-
-
-
+/** Get accumulated(really?) execution frequencies.
+ *  A heuristic weights the recursions. */
+double get_type_estimated_n_instances(ir_type *clss);
+double get_type_estimated_mem_consumption_bytes(ir_type *tp);
+/** Estimates the size of an object.
+ *
+ *  The heuristic mainly affects array sizes.
+ *  Further this ignores padding for alignment, especially of small fields. */
+int    get_type_estimated_size_bytes(ir_type *tp);
+/** Estimates the number of fields of a single Object.
+ *  The heuristic mainly affects array sizes.
+ *  @@@ Misses inherited fields! */
+int    get_type_estimated_n_fields(ir_type *tp);
+double get_type_estimated_n_casts(ir_type *clss);
+
+double get_class_estimated_n_upcasts(ir_type *clss);
+double get_class_estimated_n_downcasts(ir_type *clss);
+/** Returns the number of accesses to the dispatch table.
+ *
+ *  This includes the initialization of the pointer field, and accesses
+ *  to virtual fields (as instance marker in Java).  Certainly this
+ *  includes virtual method calls. */
+double get_class_estimated_n_dyncalls(ir_type *clss);
+/** Returns the number of writes to the dispatch pointer.
+ *  This is the same as the number of allocations. */
+double get_class_estimated_dispatch_writes(ir_type *clss);
+/** Returns the number of reads of the dispatch pointer. */
+double get_class_estimated_dispatch_reads (ir_type *clss);
+
+double get_entity_estimated_n_loads(entity *ent);
+double get_entity_estimated_n_stores(entity *ent);
+double get_entity_estimated_n_calls(entity *ent);
+/** The number of accesses to dynamically called methods and
+ *  to other static fields that overwrite/are overwritten. */
+double get_entity_estimated_n_dyncalls(entity *ent);
+
+/* ------------------------------------------------------------------------- */
+/* Accumulate information in the type hierarchy.                             */
+/* ------------------------------------------------------------------------- */
+
+typedef enum {
+  temperature_none,
+  temperature_consistent,
+  temperature_inconsistent
+} irp_temperature_state;
 
 /** An auxiliary/temporary function */
-int is_jack_rts_class(type *t);
+int is_jack_rts_class(ir_type *t);
+int is_jack_rts_entity(entity *e);
 
 #endif /* _FIELD_TEMPERATURE_H_ */