gcc/debug.h

   1 /* Debug hooks for GCC.
   2    Copyright (C) 2001, 2002, 2003, 2004, 2005, 2007, 2008
   3    Free Software Foundation, Inc.
   4
   5    This program is free software; you can redistribute it and/or modify it
   6    under the terms of the GNU General Public License as published by the
   7    Free Software Foundation; either version 3, or (at your option) any
   8    later version.
   9
  10    This program is distributed in the hope that it will be useful,
  11    but WITHOUT ANY WARRANTY; without even the implied warranty of
  12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13    GNU General Public License for more details.
  14
  15    You should have received a copy of the GNU General Public License
  16    along with this program; see the file COPYING3.  If not see
  17    <http://www.gnu.org/licenses/>.  */
  18
  19 #ifndef GCC_DEBUG_H
  20 #define GCC_DEBUG_H
  21
  22 /* This structure contains hooks for the debug information output
  23    functions, accessed through the global instance debug_hooks set in
  24    toplev.c according to command line options.  */
  25 struct gcc_debug_hooks
  26 {
  27   /* Initialize debug output.  MAIN_FILENAME is the name of the main
  28      input file.  */
  29   void (* init) (const char *main_filename);
  30
  31   /* Output debug symbols.  */
  32   void (* finish) (const char *main_filename);
  33
  34   /* Macro defined on line LINE with name and expansion TEXT.  */
  35   void (* define) (unsigned int line, const char *text);
  36
  37   /* MACRO undefined on line LINE.  */
  38   void (* undef) (unsigned int line, const char *macro);
  39
  40   /* Record the beginning of a new source file FILE from LINE number
  41      in the previous one.  */
  42   void (* start_source_file) (unsigned int line, const char *file);
  43
  44   /* Record the resumption of a source file.  LINE is the line number
  45      in the source file we are returning to.  */
  46   void (* end_source_file) (unsigned int line);
  47
  48   /* Record the beginning of block N, counting from 1 and not
  49      including the function-scope block, at LINE.  */
  50   void (* begin_block) (unsigned int line, unsigned int n);
  51
  52   /* Record the end of a block.  Arguments as for begin_block.  */
  53   void (* end_block) (unsigned int line, unsigned int n);
  54
  55   /* Returns nonzero if it is appropriate not to emit any debugging
  56      information for BLOCK, because it doesn't contain any
  57      instructions.  This may not be the case for blocks containing
  58      nested functions, since we may actually call such a function even
  59      though the BLOCK information is messed up.  Defaults to true.  */
  60   bool (* ignore_block) (const_tree);
  61
  62   /* Record a source file location at (FILE, LINE, DISCRIMINATOR).  */
  63   void (* source_line) (unsigned int line, const char *file,
  64                         int discriminator);
  65
  66   /* Called at start of prologue code.  LINE is the first line in the
  67      function.  This has been given the same prototype as source_line,
  68      so that the source_line hook can be substituted if appropriate.  */
  69   void (* begin_prologue) (unsigned int line, const char *file);
  70
  71   /* Called at end of prologue code.  LINE is the first line in the
  72      function.  */
  73   void (* end_prologue) (unsigned int line, const char *file);
  74
  75   /* Record end of epilogue code.  */
  76   void (* end_epilogue) (unsigned int line, const char *file);
  77
  78   /* Called at start of function DECL, before it is declared.  */
  79   void (* begin_function) (tree decl);
  80
  81   /* Record end of function.  LINE is highest line number in function.  */
  82   void (* end_function) (unsigned int line);
  83
  84   /* Debug information for a function DECL.  This might include the
  85      function name (a symbol), its parameters, and the block that
  86      makes up the function's body, and the local variables of the
  87      function.  */
  88   void (* function_decl) (tree decl);
  89
  90   /* Debug information for a global DECL.  Called from toplev.c after
  91      compilation proper has finished.  */
  92   void (* global_decl) (tree decl);
  93
  94   /* Debug information for a type DECL.  Called from toplev.c after
  95      compilation proper, also from various language front ends to
  96      record built-in types.  The second argument is properly a
  97      boolean, which indicates whether or not the type is a "local"
  98      type as determined by the language.  (It's not a boolean for
  99      legacy reasons.)  */
 100   void (* type_decl) (tree decl, int local);
 101
 102   /* Debug information for imported modules and declarations.  */
 103   void (* imported_module_or_decl) (tree decl, tree name,
 104                                     tree context, bool child);
 105
 106   /* DECL is an inline function, whose body is present, but which is
 107      not being output at this point.  */
 108   void (* deferred_inline_function) (tree decl);
 109
 110   /* DECL is an inline function which is about to be emitted out of
 111      line.  The hook is useful to, e.g., emit abstract debug info for
 112      the inline before it gets mangled by optimization.  */
 113   void (* outlining_inline_function) (tree decl);
 114
 115   /* Called from final_scan_insn for any CODE_LABEL insn whose
 116      LABEL_NAME is non-null.  */
 117   void (* label) (rtx);
 118
 119   /* Called after the start and before the end of writing a PCH file.
 120      The parameter is 0 if after the start, 1 if before the end.  */
 121   void (* handle_pch) (unsigned int);
 122
 123   /* Called from final_scan_insn for any NOTE_INSN_VAR_LOCATION note.  */
 124   void (* var_location) (rtx);
 125
 126   /* Called from final_scan_insn if there is a switch between hot and cold
 127      text sections.  */
 128   void (* switch_text_section) (void);
 129
 130   /* Called from grokdeclarator.  Replaces the anonymous name with the
 131      type name.  */
 132   void (* set_name) (tree, tree);
 133
 134   /* This is 1 if the debug writer wants to see start and end commands for the
 135      main source files, and 0 otherwise.  */
 136   int start_end_main_source_file;
 137 };
 138
 139 extern const struct gcc_debug_hooks *debug_hooks;
 140
 141 /* The do-nothing hooks.  */
 142 extern void debug_nothing_void (void);
 143 extern void debug_nothing_charstar (const char *);
 144 extern void debug_nothing_int_charstar (unsigned int, const char *);
 145 extern void debug_nothing_int_charstar_int (unsigned int, const char *, int);
 146 extern void debug_nothing_int (unsigned int);
 147 extern void debug_nothing_int_int (unsigned int, unsigned int);
 148 extern void debug_nothing_tree (tree);
 149 extern void debug_nothing_tree_tree (tree, tree);
 150 extern void debug_nothing_tree_int (tree, int);
 151 extern void debug_nothing_tree_tree_tree_bool (tree, tree, tree, bool);
 152 extern bool debug_true_const_tree (const_tree);
 153 extern void debug_nothing_rtx (rtx);
 154
 155 /* Hooks for various debug formats.  */
 156 extern const struct gcc_debug_hooks do_nothing_debug_hooks;
 157 extern const struct gcc_debug_hooks dbx_debug_hooks;
 158 extern const struct gcc_debug_hooks sdb_debug_hooks;
 159 extern const struct gcc_debug_hooks xcoff_debug_hooks;
 160 extern const struct gcc_debug_hooks dwarf2_debug_hooks;
 161 extern const struct gcc_debug_hooks vmsdbg_debug_hooks;
 162
 163 /* Dwarf2 frame information.  */
 164
 165 extern void dwarf2out_begin_prologue (unsigned int, const char *);
 166 extern void dwarf2out_end_epilogue (unsigned int, const char *);
 167 extern void dwarf2out_frame_init (void);
 168 extern void dwarf2out_frame_finish (void);
 169 /* Decide whether we want to emit frame unwind information for the current
 170    translation unit.  */
 171 extern int dwarf2out_do_frame (void);
 172 extern int dwarf2out_do_cfi_asm (void);
 173 extern void dwarf2out_switch_text_section (void);
 174
 175 extern void debug_flush_symbol_queue (void);
 176 extern void debug_queue_symbol (tree);
 177 extern void debug_free_queue (void);
 178 extern int debug_nesting;
 179 extern int symbol_queue_index;
 180
 181 const char *remap_debug_filename (const char *);
 182 void add_debug_prefix_map (const char *);
 183
 184 #endif /* !GCC_DEBUG_H  */