X-Git-Url: http://nsz.repo.hu/git/?a=blobdiff_plain;f=ir%2Fdebug%2Fdbginfo.h;h=9d79b5b546e5fbbcdb2f0da6c0a8822e2fc9bef7;hb=f4579da31ae88bc566bc7b147cf8401a66455355;hp=5a08d83be5b8dee0406b368bcd435b0f45642cc8;hpb=55d7e87141737f39ee497737e1b2997b3be4e9b9;p=libfirm

diff --git a/ir/debug/dbginfo.h b/ir/debug/dbginfo.h
index 5a08d83be..9d79b5b54 100644
--- a/ir/debug/dbginfo.h
+++ b/ir/debug/dbginfo.h
@@ -58,15 +58,15 @@ typedef struct type type;
  * An abstract data type containing information for
  * debugging support.
  *
- * This datatype is not defined anywere in the firm library, but pointers
- * to this type can be stored in firm nodes.
+ * This opaque data type is not defined anywhere in the firm library,
+ * but pointers to this type can be stored in firm nodes.
  */
 typedef struct dbg_info dbg_info;
 
 /**
  * Sets the debug information of a node.
  */
-void set_irn_dbg_info(ir_node *n, dbg_info* db);
+void set_irn_dbg_info(ir_node *n, dbg_info *db);
 
 /**
  * Returns the debug information of an node.
@@ -76,7 +76,7 @@ dbg_info *get_irn_dbg_info(ir_node *n);
 /**
  * Sets the debug information of an entity.
  */
-void set_entity_dbg_info(entity *ent, dbg_info* db);
+void set_entity_dbg_info(entity *ent, dbg_info *db);
 
 /**
  * Returns the debug information of an entity.
@@ -86,7 +86,7 @@ dbg_info *get_entity_dbg_info(entity *ent);
 /**
  * Sets the debug information of a type.
  */
-void set_type_dbg_info(type *tp, dbg_info* db);
+void set_type_dbg_info(type *tp, dbg_info *db);
 
 /**
  * Returns the debug information of a type.
@@ -99,7 +99,7 @@ dbg_info *get_type_dbg_info(type *tp);
 typedef enum {
   dbg_error = 0,
   dbg_opt_ssa,           /**< Optimization of the SSA representation, e.g., removal of superfluent phi nodes. */
-  dbg_opt_auxnode,       /**< Removal of unnecessary auxilliary nodes. */
+  dbg_opt_auxnode,       /**< Removal of unnecessary auxiliary nodes. */
   dbg_const_eval,        /**< A Firm subgraph was evaluated to a single constant. */
   dbg_opt_cse,           /**< A Firm node was replaced due to common subexpression elimination. */
   dbg_straightening,     /**< A Firm subgraph was replaced by a single, existing block. */
@@ -119,6 +119,7 @@ typedef enum {
                                      a constant optimization. */
   dbg_rem_poly_call,            /**< Remove polymorphic call. */
   dbg_dead_code,                /**< Removing unreachable code, I.e. blocks that are never executed. */
+  dbg_opt_confirm,              /**< A Firm subgraph was replace because of a Confirmation */
   dbg_max                       /**< Maximum value. */
 
 } dbg_action;
@@ -148,6 +149,7 @@ static const char* dbg_action_2_str(dbg_action a) {
   case dbg_read_after_read: return "dbg_read_after_read"; break;
   case dbg_read_a_const: return "dbg_read_a_const"; break;
   case dbg_rem_poly_call: return "dbg_rem_poly_call"; break;
+  case dbg_opt_confirm: return "dbg_opt_confirm"; break;
   default:
     if (a <= dbg_max)
       return "string conversion not implemented";
@@ -181,11 +183,25 @@ typedef void merge_pair_func(ir_node *new_node, ir_node *old_node, dbg_action ac
  */
 typedef void merge_sets_func(ir_node **new_node_array, int new_num_entries, ir_node **old_node_array, int old_num_entries, dbg_action action);
 
+/**
+ * The type of the debug info to human readable string function.
+ *
+ * @param buf    pointer to a buffer that will hold the info
+ * @param len    length of the buffer
+ * @param dbg    the debug info
+ *
+ * @return  Number of written characters to the buffer.
+ *
+ * @see dbg_init()
+ */
+typedef unsigned snprint_dbg_func(char *buf, unsigned len, const dbg_info *dbg);
+
 /**
  *  Initializes the debug support.
  *
  *  @param dbg_info_merge_pair   see function description
  *  @param dbg_info_merge_sets   see function description
+ *  @param snprint_dbg           see function description
  *
  *  This function takes Pointers to two functions that merge the
  *  debug information when a
@@ -199,16 +215,36 @@ typedef void merge_sets_func(ir_node **new_node_array, int new_num_entries, ir_n
  *     semantics.
  *   - dbg_info_merge_sets() is called in the following situation:
  *     The optimization replaced a subgraph by another subgraph.  There is no
- *     obviouse mapping between single nodes in both subgraphs.  The optimization
+ *     obviously mapping between single nodes in both subgraphs.  The optimization
  *     simply passes two lists to the debug module, one containing the nodes in
  *     the old subgraph, the other containing the nodes in the new subgraph.
  *     The same node can be in both lists.
  *
  *   Further both functions pass an enumeration indicating the action
  *   performed by the transformation, e.g. the kind of optimization performed.
+ *
+ * The third argument snprint_dbg is called to convert a debug info into a human readable string.
+ * This string is the dumped in the dumper functions.
+ *
+ * Note that if NULL is passed for dbg_info_merge_pair or dbg_info_merge_sets, the default
+ * implementations default_dbg_info_merge_pair() and default_dbg_info_merge_sets() are used.
+ * NULL passed for snprint_dbg means no output.
  */
-void dbg_init(merge_pair_func *dbg_info_merge_pair, merge_sets_func *dbg_info_merge_sets);
+void dbg_init(merge_pair_func *dbg_info_merge_pair, merge_sets_func *dbg_info_merge_sets, snprint_dbg_func *snprint_dbg);
 
 /** @} */
 
+/**
+ * The default merge_pair_func implementation, simply copies the debug info
+ * from old to new.
+ */
+void default_dbg_info_merge_pair(ir_node *nw, ir_node *old, dbg_action info);
+
+/**
+ * The default merge_sets_func implementation, does nothing
+ */
+void default_dbg_info_merge_sets(ir_node **new_nodes, int n_new_nodes,
+                            ir_node **old_nodes, int n_old_nodes,
+                            dbg_action info);
+
 #endif /* _DBGINFO_H_ */