-/* Sets the functions called by libfirm when changing the IR.
- The following routines are called by firm optmizations. The optimization
- passes an ident representing a string that describes the optimization
- performed.
- - dbg_info_merge_pair() is called in the following situation:
- The optimization replaced the old node by the new one. The new node
- might be a recent allocated node not containing any debug information,
- or just another node from somewhere in the graph with the same
- 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
- 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.
-*/
-void dbg_init( void (merge_pair)(ir_node *nw, ir_node *old, ident *info),
- void (merge_sets)(ir_node **new_nodes, ir_node **old_nodes,
- ident *info)
- );
-
-/* Every Firm node contains a reference to a dbg_info struct. This reference
- can be accessed by the debug support module by
- dbg_info *get_irn_dbg_info(irnode *n);
- void set_irn_dbg_info(irnode *n, dbg_info *d);.
- The module may not touch or change anything else in the Firm data structure.
-*/
-inline void set_irn_dbg_info(ir_node *n, dbg_info* db);
+/**
+ * Sets the debug information of a node.
+ */
+INLINE void set_irn_dbg_info(ir_node *n, dbg_info* db);
+
+/**
+ * Returns the debug information of an node.
+ */
+INLINE dbg_info *get_irn_dbg_info(ir_node *n);
+
+/**
+ * Sets the debug information of an entity.
+ */
+INLINE void set_entity_dbg_info(entity *ent, dbg_info* db);
+
+/**
+ * Returns the debug information of an entity.
+ */
+INLINE dbg_info *get_entity_dbg_info(entity *ent);
+
+/**
+ * Sets the debug information of a type.
+ */
+INLINE void set_type_dbg_info(type *tp, dbg_info* db);
+
+/**
+ * Returns the debug information of a type.
+ */
+INLINE dbg_info *get_type_dbg_info(type *tp);
+
+/**
+ * An enumeration indicating the action performed by a transformation.
+ */
+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_const_eval, /**< A Firm subgraph was evaluated to a single constant. */
+ 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. */
+ 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_rem_poly_call, /**< Remove polymorphic call. */
+ dbg_max /**< Maximum value. */
+
+} dbg_action;
+
+
+/**
+ * Converts enum values to strings.
+ */
+#ifdef __GNUC__
+INLINE static const char* dbg_action_2_str(dbg_action) __attribute__ ((unused));
+#endif
+
+INLINE static const char* dbg_action_2_str(dbg_action a) {
+ switch(a) {
+ case dbg_error: return "dbg_error"; break;
+ 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_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_rem_poly_call: return "dbg_rem_poly_call"; break;
+ default:
+ if (a <= dbg_max)
+ return "string conversion not implemented";
+ else
+ assert(0);
+ }
+}
+
+/**
+ * The type of the debug info merge function.
+ *
+ * @param new_node the new ir node
+ * @param old_node the old ir node
+ * @param action the action that triggers the merge
+ *
+ * @see dbg_init()
+ */
+typedef void merge_pair_func(ir_node *new_node, ir_node *old_node, dbg_action action);