2 * Copyright (C) 1995-2008 University of Karlsruhe. All right reserved.
4 * This file is part of libFirm.
6 * This file may be distributed and/or modified under the terms of the
7 * GNU General Public License version 2 as published by the Free Software
8 * Foundation and appearing in the file LICENSE.GPL included in the
9 * packaging of this file.
11 * Licensees holding valid libFirm Professional Edition licenses may use
12 * this file in accordance with the libFirm Commercial License.
13 * Agreement provided with the Software.
15 * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
16 * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22 * @brief Implements the Firm interface to debug information.
23 * @author Goetz Lindenmaier, Michael Beck
26 #ifndef FIRM_DEBUG_DBGINFO_H
27 #define FIRM_DEBUG_DBGINFO_H
30 #include "firm_types.h"
35 * @defgroup dbg_info Source References
36 * Firm requires a debugging module fulfilling this interface, else no
37 * debugging information is passed to the backend.
38 * The interface requires a datatype representing the debugging
39 * information. Firm supports administrating a reference to the debug
40 * information in every Firm node. Further Firm optimizations call
41 * routines to propagate debug information from old nodes to new nodes
42 * if the optimization replaces the old ones by the new ones.
49 * An abstract data type containing information for
52 * This opaque data type is not defined anywhere in the Firm library,
53 * but pointers to this type can be stored in Firm nodes.
57 * An enumeration indicating the action performed by a transformation.
61 dbg_opt_ssa, /**< Optimization of the SSA representation, e.g. removal of superfluent Phi nodes. */
62 dbg_opt_auxnode, /**< Removal of unnecessary auxiliary nodes. */
63 dbg_const_eval, /**< A Firm subgraph was evaluated to a single constant. */
64 dbg_opt_cse, /**< A Firm node was replaced due to common subexpression elimination. */
65 dbg_straightening, /**< A Firm subgraph was replaced by a single, existing block. */
66 dbg_if_simplification, /**< The control flow of an if is changed as either the
67 else, the then or both blocks are empty. */
68 dbg_algebraic_simplification, /**< A Firm subgraph was replaced because of an algebraic
70 dbg_write_after_write, /**< A Firm subgraph was replaced because of a write
71 after write optimization. */
72 dbg_write_after_read, /**< A Firm subgraph was replaced because of a write
73 after read optimization. */
74 dbg_read_after_write, /**< A Firm subgraph was replaced because of a read
75 after write optimization. */
76 dbg_read_after_read, /**< A Firm subgraph was replaced because of a read
77 after read optimization. */
78 dbg_read_a_const, /**< A Firm subgraph was replaced because of a read
79 a constant optimization. */
80 dbg_rem_poly_call, /**< Remove polymorphic call. */
81 dbg_dead_code, /**< Removing unreachable code, i.e. blocks that are never executed. */
82 dbg_opt_confirm, /**< A Firm subgraph was replace because of a Confirmation. */
83 dbg_gvn_pre, /**< A Firm node was replace because of the GVN-PRE algorithm. */
84 dbg_combo, /**< A Firm node was replace because of the combo algorithm. */
85 dbg_jumpthreading, /**< A Firm node was replace because of the jumpthreading algorithm. */
86 dbg_backend, /**< A Firm subgraph was replaced because of a Backend transformation */
87 dbg_max /**< Maximum value. */
91 * Converts a debug_action into a string.
93 * @param a the debug action
95 FIRM_API const char *dbg_action_2_str(dbg_action a);
98 * The type of the debug info merge function.
100 * @param new_node the new ir node
101 * @param old_node the old ir node
102 * @param action the action that triggers the merge
106 typedef void merge_pair_func(ir_node *new_node, ir_node *old_node, dbg_action action);
109 * The type of the debug info merge sets function.
111 * @param new_node_array array of new nodes
112 * @param new_num_entries number of entries in new_node_array
113 * @param old_node_array array of old nodes
114 * @param old_num_entries number of entries in old_node_array
115 * @param action the action that triggers the merge
119 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);
122 * Initializes the debug support.
124 * This function takes pointers to two functions that merge the
125 * debug information when a
126 * transformation of a Firm graph is performed.
127 * Firm transformations call one of these functions.
129 * - dbg_info_merge_pair() is called in the following situation:
130 * The optimization replaced the old node by the new one. The new node
131 * might be a recent allocated node not containing any debug information,
132 * or just another node from somewhere in the graph with the same
134 * - dbg_info_merge_sets() is called in the following situation:
135 * The optimization replaced a subgraph by another subgraph. There is no
136 * obviously mapping between single nodes in both subgraphs. The optimization
137 * simply passes two lists to the debug module, one containing the nodes in
138 * the old subgraph, the other containing the nodes in the new subgraph.
139 * The same node can be in both lists.
141 * Further both functions pass an enumeration indicating the action
142 * performed by the transformation, e.g. the kind of optimization performed.
144 FIRM_API void dbg_init(merge_pair_func *dbg_info_merge_pair,
145 merge_sets_func *dbg_info_merge_sets);
148 * The type of the debug info retriever function.
149 * When given a dbg_info returns the name (usually the filename) of the
150 * compilation unit defining it. @p line is set to the line number of the
153 typedef const char *(*retrieve_dbg_func)(const dbg_info *dbg, unsigned *line);
156 * Sets a debug info retriever.
158 * @param func the debug retriever function.
160 FIRM_API void ir_set_debug_retrieve(retrieve_dbg_func func);
163 * The type of the type debug info retrieve function.
164 * Prints a human readable source representation of a type to an obstack.
165 * (Used for generating debug info like stabs or dwarf)
167 typedef void (*retrieve_type_dbg_func)(char *buffer, size_t buffer_size,
168 const type_dbg_info *tdbgi);
171 * Sets global print_type_dbg_info function in firm
173 FIRM_API void ir_set_type_debug_retrieve(retrieve_type_dbg_func func);
176 * Retrieve the debug info.
178 FIRM_API const char *ir_retrieve_dbg_info(const dbg_info *dbg, unsigned *line);
181 * Retrieve type debug info
183 FIRM_API void ir_retrieve_type_dbg_info(char *buffer, size_t buffer_size,
184 const type_dbg_info *tdbgi);