/*
-** Copyright (C) 2001 by Universitaet Karlsruhe
-** All rights reserved.
-**
-** Authors: Goetz Lindenmaier
-**
-** dbginfo: This is the Firm interface to debugging support. Firm requires
-** a debugging module fulfilling this interface.
-** The interface requires a datatype representing the debugging information.
-** Firm supports administrating a reference to the debug information
-** in every firm node. Further Firm optimizations call routines to
-** propagate debug information from old nodes to new nodes if the optimization
-** replaces the old ones by the new ones.
-**
-** This file does not belong to the interface of the firm library.
+* Copyright (C) 2001 by Universitaet Karlsruhe
+* All rights reserved.
+*/
+
+/**
+* @file dbginfo.h
+*
+* This is the Firm interface to debugging support.
+*
+* @author Goetz Lindenmaier
+*
+* 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.
+* Firm supports administrating a reference to the debug information
+* in every firm node. Further Firm optimizations call routines to
+* propagate debug information from old nodes to new nodes if the optimization
+* replaces the old ones by the new ones.
+*
*/
/* $Id$ */
typedef struct ir_node ir_node;
#endif
-/* A datastructure containing information for debugging. */
+/* to resolve recursion between entity.h and type.h */
+#ifndef _ENTITY_TYPEDEF_
+#define _ENTITY_TYPEDEF_
+typedef struct entity entity;
+#endif
+
+#ifndef _TYPE_TYPEDEF_
+#define _TYPE_TYPEDEF_
+typedef struct type type;
+#endif
+
+/**
+ * @defgroup debug The Firm interface to debugging support.
+ *
+ * @{
+ */
+
+/**
+ * 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.
+ */
typedef struct dbg_info dbg_info;
-/* 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);
-inline dbg_info *get_irn_dbg_info(ir_node *n);
+/**
+ * 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 **new_node_array, int new_num_entries, ir_node **old_node_array, int old_num_entries, dbg_action action);
+/**
+ * Initializes the debug support.
+ *
+ * @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.
+ *
+ * - 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.
+ * 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.
+ */
+void dbg_init(merge_pair_func *dbg_info_merge_pair, merge_sets_func *dbg_info_merge_sets);
+/** @} */
#endif /* _DBGINFO_H_ */
projects / libfirm / blobdiff