* 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.
/**
* 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.
/**
* 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.
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. */
dbg_if_simplification, /**< The control flow of an if is changed as either the
- else, the then or both blocks are empty. */
+ else, the then or both blocks are empty. */
dbg_algebraic_simplification, /**< A Firm subgraph was replaced because of an algebraic
simplification. */
dbg_write_after_write, /**< A Firm subgraph was replaced because of a write
after write optimization. */
dbg_write_after_read, /**< A Firm subgraph was replaced because of a write
after read optimization. */
+ dbg_read_after_write, /**< A Firm subgraph was replaced because of a read
+ after write optimization. */
+ dbg_read_after_read, /**< A Firm subgraph was replaced because of a read
+ after read optimization. */
+ dbg_read_a_const, /**< A Firm subgraph was replaced because of a read
+ 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;
case dbg_opt_ssa: return "dbg_opt_ssa"; break;
case dbg_opt_auxnode: return "dbg_opt_auxnode"; break;
case dbg_const_eval: return "dbg_const_eval"; break;
+ case dbg_opt_cse: return "dbg_opt_cse"; break;
case dbg_straightening: return "dbg_straightening"; break;
case dbg_if_simplification: return "dbg_if_simplification"; break;
case dbg_algebraic_simplification:
return "dbg_algebraic_simplification"; break;
case dbg_write_after_write: return "dbg_write_after_write"; break;
case dbg_write_after_read: return "dbg_write_after_read"; break;
+ case dbg_read_after_write: return "dbg_read_after_write"; break;
+ 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";
*/
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
* 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_ */