gcc/debug.h

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