nsz Git - libfirm/blob - ir/debug/dbginfo.h

   1 /*
   2  * Project:     libFIRM
   3  * File name:   ir/debug/dbginfo.h
   4  * Purpose:     Implements the Firm interface to debug information.
   5  * Author:      Goetz Lindenmaier
   6  * Modified by: Michael Beck
   7  * Created:     2001
   8  * CVS-ID:      $Id$
   9  * Copyright:   (c) 2001-2003 Universität Karlsruhe
  10  * Licence:     This file protected by GPL -  GNU GENERAL PUBLIC LICENSE.
  11  */
  12
  13 /**
  14  * @file  dbginfo.h
  15  *
  16  *  This is the Firm interface to debugging support.
  17  *
  18  *  @author Goetz Lindenmaier
  19  *
  20  *  Firm requires a debugging module fulfilling this interface, else no
  21  *  debugging information is passed to the backend.
  22  *  The interface requires a datatype representing the debugging
  23  *  information.  Firm supports administrating a reference to the debug
  24  *  information in every firm node.  Further Firm optimizations call
  25  *  routines to propagate debug information from old nodes to new nodes
  26  *  if the optimization replaces the old ones by the new ones.
  27  *
  28  */
  29
  30 #ifndef _DBGINFO_H_
  31 #define _DBGINFO_H_
  32
  33 #include "firm_types.h"
  34 #include "ident.h"
  35
  36 #ifdef __cplusplus
  37 extern "C" {
  38 #endif
  39
  40 /**
  41  * @defgroup debug    The Firm interface to debugging support.
  42  *
  43  * @{
  44  */
  45
  46 /**
  47  * An abstract data type containing information for
  48  * debugging support.
  49  *
  50  * This opaque data type is not defined anywhere in the firm library,
  51  * but pointers to this type can be stored in firm nodes.
  52  */
  53 typedef struct dbg_info dbg_info;
  54
  55 /**
  56  * Sets the debug information of a node.
  57  */
  58 void set_irn_dbg_info(ir_node *n, dbg_info *db);
  59
  60 /**
  61  * Returns the debug information of an node.
  62  */
  63 dbg_info *get_irn_dbg_info(ir_node *n);
  64
  65 /**
  66  * Sets the debug information of an entity.
  67  */
  68 void set_entity_dbg_info(entity *ent, dbg_info *db);
  69
  70 /**
  71  * Returns the debug information of an entity.
  72  */
  73 dbg_info *get_entity_dbg_info(entity *ent);
  74
  75 /**
  76  * Sets the debug information of a type.
  77  */
  78 void set_type_dbg_info(type *tp, dbg_info *db);
  79
  80 /**
  81  * Returns the debug information of a type.
  82  */
  83 dbg_info *get_type_dbg_info(type *tp);
  84
  85 /**
  86  * An enumeration indicating the action performed by a transformation.
  87  */
  88 typedef enum {
  89   dbg_error = 0,
  90   dbg_opt_ssa,           /**< Optimization of the SSA representation, e.g., removal of superfluent phi nodes. */
  91   dbg_opt_auxnode,       /**< Removal of unnecessary auxiliary nodes. */
  92   dbg_const_eval,        /**< A Firm subgraph was evaluated to a single constant. */
  93   dbg_opt_cse,           /**< A Firm node was replaced due to common subexpression elimination. */
  94   dbg_straightening,     /**< A Firm subgraph was replaced by a single, existing block. */
  95   dbg_if_simplification, /**< The control flow of an if is changed as either the
  96                                     else, the then or both blocks are empty. */
  97   dbg_algebraic_simplification, /**< A Firm subgraph was replaced because of an algebraic
  98                                      simplification. */
  99   dbg_write_after_write,        /**< A Firm subgraph was replaced because of a write
 100                                      after write optimization. */
 101   dbg_write_after_read,         /**< A Firm subgraph was replaced because of a write
 102                                      after read optimization. */
 103   dbg_read_after_write,         /**< A Firm subgraph was replaced because of a read
 104                                      after write optimization. */
 105   dbg_read_after_read,          /**< A Firm subgraph was replaced because of a read
 106                                      after read optimization. */
 107   dbg_read_a_const,             /**< A Firm subgraph was replaced because of a read
 108                                      a constant optimization. */
 109   dbg_rem_poly_call,            /**< Remove polymorphic call. */
 110   dbg_dead_code,                /**< Removing unreachable code, I.e. blocks that are never executed. */
 111   dbg_opt_confirm,              /**< A Firm subgraph was replace because of a Confirmation */
 112   dbg_max                       /**< Maximum value. */
 113 } dbg_action;
 114
 115 /**
 116  * Converts a debug_action into a string.
 117  *
 118  * @param a  the debug action
 119  */
 120 const char *dbg_action_2_str(dbg_action a);
 121
 122 /**
 123  * The type of the debug info merge function.
 124  *
 125  * @param new_node    the new ir node
 126  * @param old_node    the old ir node
 127  * @param action      the action that triggers the merge
 128  *
 129  * @see dbg_init()
 130  */
 131 typedef void merge_pair_func(ir_node *new_node, ir_node *old_node, dbg_action action);
 132
 133 /**
 134  * The type of the debug info merge sets function.
 135  *
 136  * @param new_node_array    array of new nodes
 137  * @param new_num_entries   number of entries in new_node_array
 138  * @param old_node_array    array of old nodes
 139  * @param old_num_entries   number of entries in old_node_array
 140  * @param action            the action that triggers the merge
 141  *
 142  * @see dbg_init()
 143  */
 144 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);
 145
 146 /**
 147  * The type of the debug info to human readable string function.
 148  *
 149  * @param buf    pointer to a buffer that will hold the info
 150  * @param len    length of the buffer
 151  * @param dbg    the debug info
 152  *
 153  * @return  Number of written characters to the buffer.
 154  *
 155  * @see dbg_init()
 156  */
 157 typedef unsigned snprint_dbg_func(char *buf, unsigned len, const dbg_info *dbg);
 158
 159 /**
 160  *  Initializes the debug support.
 161  *
 162  *  @param dbg_info_merge_pair   see function description
 163  *  @param dbg_info_merge_sets   see function description
 164  *  @param snprint_dbg           see function description
 165  *
 166  *  This function takes Pointers to two functions that merge the
 167  *  debug information when a
 168  *  transformation of a firm graph is performed.
 169  *  Firm transformations call one of these functions.
 170  *
 171  *   - dbg_info_merge_pair() is called in the following situation:
 172  *     The optimization replaced the old node by the new one.  The new node
 173  *     might be a recent allocated node not containing any debug information,
 174  *     or just another node from somewhere in the graph with the same
 175  *     semantics.
 176  *   - dbg_info_merge_sets() is called in the following situation:
 177  *     The optimization replaced a subgraph by another subgraph.  There is no
 178  *     obviously mapping between single nodes in both subgraphs.  The optimization
 179  *     simply passes two lists to the debug module, one containing the nodes in
 180  *     the old subgraph, the other containing the nodes in the new subgraph.
 181  *     The same node can be in both lists.
 182  *
 183  *   Further both functions pass an enumeration indicating the action
 184  *   performed by the transformation, e.g. the kind of optimization performed.
 185  *
 186  * The third argument snprint_dbg is called to convert a debug info into a human readable string.
 187  * This string is the dumped in the dumper functions.
 188  *
 189  * Note that if NULL is passed for dbg_info_merge_pair or dbg_info_merge_sets, the default
 190  * implementations default_dbg_info_merge_pair() and default_dbg_info_merge_sets() are used.
 191  * NULL passed for snprint_dbg means no output.
 192  */
 193 void dbg_init(merge_pair_func *dbg_info_merge_pair, merge_sets_func *dbg_info_merge_sets, snprint_dbg_func *snprint_dbg);
 194
 195 /** @} */
 196
 197 /**
 198  * The default merge_pair_func implementation, simply copies the debug info
 199  * from old to new.
 200  */
 201 void default_dbg_info_merge_pair(ir_node *nw, ir_node *old, dbg_action info);
 202
 203 /**
 204  * The default merge_sets_func implementation, does nothing
 205  */
 206 void default_dbg_info_merge_sets(ir_node **new_nodes, int n_new_nodes,
 207                             ir_node **old_nodes, int n_old_nodes,
 208                             dbg_action info);
 209
 210 #ifdef __cplusplus
 211 }
 212 #endif
 213
 214 #endif /* _DBGINFO_H_ */