/*
* Copyright (C) 2001 by Universitaet Karlsruhe
* All rights reserved.
+*/
+
+/**
+* @file dbginfo.h
+*
+* This is the Firm interface to debugging support.
*
-* Authors: Goetz Lindenmaier
+* @author Goetz Lindenmaier
*
-* dbginfo: This is the Firm interface to debugging support. Firm requires
+* Firm requires
* a debugging module fulfilling this interface, else no debugging information
* is passed to the backend.
* The interface requires a datatype representing the debugging information.
#endif
/**
+ * @defgroup debug The Firm interface to debugging support.
+ *
+ * @{
+ */
+
+/**
+ * An abstract data type containing information for
+ * debugging support.
*
- * An abstract data type containing information for
- * debugging support.
- * This datatype is not defined in the firm library, but pointers
- * to this type can be stored in firm nodes.
+ * This datatype is not defined anywere in the firm library, but pointers
+ * to this type can be stored in firm nodes.
*/
typedef struct dbg_info dbg_info;
-/* Routines to access the field of an ir node containing the
- debugging information. */
+
+/**
+ * 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);
-/* Routines to access the field of an entity containing the
- debugging information. */
+
+/**
+ * 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);
-/* Routines to access the field of a type containing the
- debugging information. */
+
+/**
+ * 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);
/**
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,
- dbg_write_after_write,
- dbg_write_after_read,
- dbg_max
+ 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
+ * Converts enum values to strings.
*/
-static const char* dbg_action_2_str(dbg_action a) {
+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;
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";
/**
* 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 *, ir_node *, dbg_action);
+typedef void merge_pair_func(ir_node *new_node, ir_node *old_node, dbg_action action);
/**
- * The type of the debug info merge function.
+ * The type of the debug info merge sets function.
+ *
+ * @param new_node_array array of new nodes
+ * @param new_num_entries number of entries in new_node_array
+ * @param old_node_array array of old nodes
+ * @param old_num_entries number of entries in old_node_array
+ * @param action the action that triggers the merge
*
* @see dbg_init()
*/
-typedef void merge_sets_func(ir_node **, int, ir_node **, int, dbg_action);
+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);
/**
- * Initializes the debug support.
+ * Initializes the debug support.
*
- * @param dbg_info_merge_pair see function description
- * @param dbg_info_merge_sets see function description
+ * @param dbg_info_merge_pair see function description
+ * @param dbg_info_merge_sets see function description
*
- * This function takes Pointers to two functions that merge the debug information when a
- * transformation of a firm graph is performed.
- * Firm transformations call one of these functions.
+ * This function takes Pointers to two functions that merge the
+ * debug information when a
+ * transformation of a firm graph is performed.
+ * Firm transformations call one of these functions.
*
* - dbg_info_merge_pair() is called in the following situation:
* The optimization replaced the old node by the new one. The new node
*
* Further both functions pass an enumeration indicating the action
* performed by the transformation, e.g. the kind of optimization performed.
- *
- * @return No result.
- *
*/
void dbg_init(merge_pair_func *dbg_info_merge_pair, merge_sets_func *dbg_info_merge_sets);
+/** @} */
#endif /* _DBGINFO_H_ */
projects / libfirm / blobdiff