nsz Git - libfirm/blob - include/libfirm/dbginfo.h

   1 /*
   2  * Copyright (C) 1995-2008 University of Karlsruhe.  All right reserved.
   3  *
   4  * This file is part of libFirm.
   5  *
   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.
  10  *
  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.
  14  *
  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
  17  * PURPOSE.
  18  */
  19
  20 /**
  21  * @file
  22  * @brief     Implements the Firm interface to debug information.
  23  * @author    Goetz Lindenmaier, Michael Beck
  24  * @date      2001
  25  * @version   $Id$
  26  * @brief
  27  *  Firm requires a debugging module fulfilling this interface, else no
  28  *  debugging information is passed to the backend.
  29  *  The interface requires a datatype representing the debugging
  30  *  information.  Firm supports administrating a reference to the debug
  31  *  information in every Firm node.  Further Firm optimizations call
  32  *  routines to propagate debug information from old nodes to new nodes
  33  *  if the optimization replaces the old ones by the new ones.
  34  */
  35 #ifndef FIRM_DEBUG_DBGINFO_H
  36 #define FIRM_DEBUG_DBGINFO_H
  37
  38 #include "firm_types.h"
  39 #include "ident.h"
  40
  41 /**
  42  * @defgroup debug    The Firm interface to debugging support.
  43  *
  44  * @{
  45  */
  46
  47 /**
  48  * @typedef dbg_info
  49  *
  50  * An abstract data type containing information for
  51  * debugging support.
  52  *
  53  * This opaque data type is not defined anywhere in the Firm library,
  54  * but pointers to this type can be stored in Firm nodes.
  55  */
  56
  57 /**
  58  * An enumeration indicating the action performed by a transformation.
  59  */
  60 typedef enum {
  61         dbg_error = 0,
  62         dbg_opt_ssa,           /**< Optimization of the SSA representation, e.g. removal of superfluent Phi nodes. */
  63         dbg_opt_auxnode,       /**< Removal of unnecessary auxiliary nodes. */
  64         dbg_const_eval,        /**< A Firm subgraph was evaluated to a single constant. */
  65         dbg_opt_cse,           /**< A Firm node was replaced due to common subexpression elimination. */
  66         dbg_straightening,     /**< A Firm subgraph was replaced by a single, existing block. */
  67         dbg_if_simplification, /**< The control flow of an if is changed as either the
  68                                           else, the then or both blocks are empty. */
  69         dbg_algebraic_simplification, /**< A Firm subgraph was replaced because of an algebraic
  70                                            simplification. */
  71         dbg_write_after_write,        /**< A Firm subgraph was replaced because of a write
  72                                            after write optimization. */
  73         dbg_write_after_read,         /**< A Firm subgraph was replaced because of a write
  74                                            after read optimization. */
  75         dbg_read_after_write,         /**< A Firm subgraph was replaced because of a read
  76                                            after write optimization. */
  77         dbg_read_after_read,          /**< A Firm subgraph was replaced because of a read
  78                                            after read optimization. */
  79         dbg_read_a_const,             /**< A Firm subgraph was replaced because of a read
  80                                            a constant optimization. */
  81         dbg_rem_poly_call,            /**< Remove polymorphic call. */
  82         dbg_dead_code,                /**< Removing unreachable code, I.e. blocks that are never executed. */
  83         dbg_opt_confirm,              /**< A Firm subgraph was replace because of a Confirmation. */
  84         dbg_gvn_pre,                  /**< A Firm node was replace because of the GVN-PRE algorithm. */
  85         dbg_combo,                    /**< A Firm node was replace because of the combo algorithm. */
  86         dbg_jumpthreading,            /**< A Firm node was replace because of the jumpthreading algorithm. */
  87         dbg_backend,                  /**< A Firm subgraph was replaced because of a Backend transformation */
  88         dbg_max                       /**< Maximum value. */
  89 } dbg_action;
  90
  91 /**
  92  * Converts a debug_action into a string.
  93  *
  94  * @param a  the debug action
  95  */
  96 const char *dbg_action_2_str(dbg_action a);
  97
  98 /**
  99  * The type of the debug info merge function.
 100  *
 101  * @param new_node    the new ir node
 102  * @param old_node    the old ir node
 103  * @param action      the action that triggers the merge
 104  *
 105  * @see dbg_init()
 106  */
 107 typedef void merge_pair_func(ir_node *new_node, ir_node *old_node, dbg_action action);
 108
 109 /**
 110  * The type of the debug info merge sets function.
 111  *
 112  * @param new_node_array    array of new nodes
 113  * @param new_num_entries   number of entries in new_node_array
 114  * @param old_node_array    array of old nodes
 115  * @param old_num_entries   number of entries in old_node_array
 116  * @param action            the action that triggers the merge
 117  *
 118  * @see dbg_init()
 119  */
 120 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);
 121
 122 /**
 123  *  Initializes the debug support.
 124  *
 125  *  This function takes pointers to two functions that merge the
 126  *  debug information when a
 127  *  transformation of a Firm graph is performed.
 128  *  Firm transformations call one of these functions.
 129  *
 130  *   - dbg_info_merge_pair() is called in the following situation:
 131  *     The optimization replaced the old node by the new one.  The new node
 132  *     might be a recent allocated node not containing any debug information,
 133  *     or just another node from somewhere in the graph with the same
 134  *     semantics.
 135  *   - dbg_info_merge_sets() is called in the following situation:
 136  *     The optimization replaced a subgraph by another subgraph.  There is no
 137  *     obviously mapping between single nodes in both subgraphs.  The optimization
 138  *     simply passes two lists to the debug module, one containing the nodes in
 139  *     the old subgraph, the other containing the nodes in the new subgraph.
 140  *     The same node can be in both lists.
 141  *
 142  *   Further both functions pass an enumeration indicating the action
 143  *   performed by the transformation, e.g. the kind of optimization performed.
 144  */
 145 void dbg_init(merge_pair_func *dbg_info_merge_pair,
 146               merge_sets_func *dbg_info_merge_sets);
 147
 148 /** @} */
 149
 150 /**
 151  * The type of the debug info retriever function.
 152  *  When given a dbg_info returns the name (usually the filename) of the
 153  *  compilation unit defining it. @p line is set to the line number of the
 154  *  definition.
 155  */
 156 typedef const char *(*retrieve_dbg_func)(const dbg_info *dbg, unsigned *line);
 157
 158 /**
 159  * Sets a debug info retriever.
 160  *
 161  * @param func   the debug retriever function.
 162  */
 163 void ir_set_debug_retrieve(retrieve_dbg_func func);
 164
 165 /**
 166  * Retrieve the debug info.
 167  */
 168 const char *ir_retrieve_dbg_info(const dbg_info *dbg, unsigned *line);
 169
 170 #endif