gcc/debug.h

   1 /* Debug hooks for GCC.
   2    Copyright (C) 2001-2015 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   /* Called from cgraph_optimize before starting to assemble
  34      functions/variables/toplevel asms.  */
  35   void (* assembly_start) (void);
  36
  37   /* Macro defined on line LINE with name and expansion TEXT.  */
  38   void (* define) (unsigned int line, const char *text);
  39
  40   /* MACRO undefined on line LINE.  */
  41   void (* undef) (unsigned int line, const char *macro);
  42
  43   /* Record the beginning of a new source file FILE from LINE number
  44      in the previous one.  */
  45   void (* start_source_file) (unsigned int line, const char *file);
  46
  47   /* Record the resumption of a source file.  LINE is the line number
  48      in the source file we are returning to.  */
  49   void (* end_source_file) (unsigned int line);
  50
  51   /* Record the beginning of block N, counting from 1 and not
  52      including the function-scope block, at LINE.  */
  53   void (* begin_block) (unsigned int line, unsigned int n);
  54
  55   /* Record the end of a block.  Arguments as for begin_block.  */
  56   void (* end_block) (unsigned int line, unsigned int n);
  57
  58   /* Returns nonzero if it is appropriate not to emit any debugging
  59      information for BLOCK, because it doesn't contain any
  60      instructions.  This may not be the case for blocks containing
  61      nested functions, since we may actually call such a function even
  62      though the BLOCK information is messed up.  Defaults to true.  */
  63   bool (* ignore_block) (const_tree);
  64
  65   /* Record a source file location at (FILE, LINE, DISCRIMINATOR).  */
  66   void (* source_line) (unsigned int line, const char *file,
  67                         int discriminator, bool is_stmt);
  68
  69   /* Called at start of prologue code.  LINE is the first line in the
  70      function.  */
  71   void (* begin_prologue) (unsigned int line, const char *file);
  72
  73   /* Called at end of prologue code.  LINE is the first line in the
  74      function.  */
  75   void (* end_prologue) (unsigned int line, const char *file);
  76
  77   /* Called at beginning of epilogue code.  */
  78   void (* begin_epilogue) (unsigned int line, const char *file);
  79
  80   /* Record end of epilogue code.  */
  81   void (* end_epilogue) (unsigned int line, const char *file);
  82
  83   /* Called at start of function DECL, before it is declared.  */
  84   void (* begin_function) (tree decl);
  85
  86   /* Record end of function.  LINE is highest line number in function.  */
  87   void (* end_function) (unsigned int line);
  88
  89   /* Debug information for a function DECL.  This might include the
  90      function name (a symbol), its parameters, and the block that
  91      makes up the function's body, and the local variables of the
  92      function.  */
  93   void (* function_decl) (tree decl);
  94
  95   /* Debug information for a global DECL.  Called from toplev.c after
  96      compilation proper has finished.  */
  97   void (* global_decl) (tree decl);
  98
  99   /* Debug information for a type DECL.  Called from toplev.c after
 100      compilation proper, also from various language front ends to
 101      record built-in types.  The second argument is properly a
 102      boolean, which indicates whether or not the type is a "local"
 103      type as determined by the language.  (It's not a boolean for
 104      legacy reasons.)  */
 105   void (* type_decl) (tree decl, int local);
 106
 107   /* Debug information for imported modules and declarations.  */
 108   void (* imported_module_or_decl) (tree decl, tree name,
 109                                     tree context, bool child);
 110
 111   /* DECL is an inline function, whose body is present, but which is
 112      not being output at this point.  */
 113   void (* deferred_inline_function) (tree decl);
 114
 115   /* DECL is an inline function which is about to be emitted out of
 116      line.  The hook is useful to, e.g., emit abstract debug info for
 117      the inline before it gets mangled by optimization.  */
 118   void (* outlining_inline_function) (tree decl);
 119
 120   /* Called from final_scan_insn for any CODE_LABEL insn whose
 121      LABEL_NAME is non-null.  */
 122   void (* label) (rtx_code_label *);
 123
 124   /* Called after the start and before the end of writing a PCH file.
 125      The parameter is 0 if after the start, 1 if before the end.  */
 126   void (* handle_pch) (unsigned int);
 127
 128   /* Called from final_scan_insn for any NOTE_INSN_VAR_LOCATION note.  */
 129   void (* var_location) (rtx_insn *);
 130
 131   /* Called from final_scan_insn if there is a switch between hot and cold
 132      text sections.  */
 133   void (* switch_text_section) (void);
 134
 135   /* Called from grokdeclarator.  Replaces the anonymous name with the
 136      type name.  */
 137   void (* set_name) (tree, tree);
 138
 139   /* This is 1 if the debug writer wants to see start and end commands for the
 140      main source files, and 0 otherwise.  */
 141   int start_end_main_source_file;
 142
 143   /* The type of symtab field used by these debug hooks.  This is one
 144      of the TYPE_SYMTAB_IS_xxx values defined in tree.h.  */
 145   int tree_type_symtab_field;
 146 };
 147
 148 extern const struct gcc_debug_hooks *debug_hooks;
 149
 150 /* The do-nothing hooks.  */
 151 extern void debug_nothing_void (void);
 152 extern void debug_nothing_charstar (const char *);
 153 extern void debug_nothing_int_charstar (unsigned int, const char *);
 154 extern void debug_nothing_int_charstar_int_bool (unsigned int, const char *,
 155                                                  int, bool);
 156 extern void debug_nothing_int (unsigned int);
 157 extern void debug_nothing_int_int (unsigned int, unsigned int);
 158 extern void debug_nothing_tree (tree);
 159 extern void debug_nothing_tree_tree (tree, tree);
 160 extern void debug_nothing_tree_int (tree, int);
 161 extern void debug_nothing_tree_tree_tree_bool (tree, tree, tree, bool);
 162 extern bool debug_true_const_tree (const_tree);
 163 extern void debug_nothing_rtx_insn (rtx_insn *);
 164 extern void debug_nothing_rtx_code_label (rtx_code_label *);
 165
 166 /* Hooks for various debug formats.  */
 167 extern const struct gcc_debug_hooks do_nothing_debug_hooks;
 168 extern const struct gcc_debug_hooks dbx_debug_hooks;
 169 extern const struct gcc_debug_hooks sdb_debug_hooks;
 170 extern const struct gcc_debug_hooks xcoff_debug_hooks;
 171 extern const struct gcc_debug_hooks dwarf2_debug_hooks;
 172 extern const struct gcc_debug_hooks vmsdbg_debug_hooks;
 173
 174 /* Dwarf2 frame information.  */
 175
 176 extern void dwarf2out_begin_prologue (unsigned int, const char *);
 177 extern void dwarf2out_vms_end_prologue (unsigned int, const char *);
 178 extern void dwarf2out_vms_begin_epilogue (unsigned int, const char *);
 179 extern void dwarf2out_end_epilogue (unsigned int, const char *);
 180 extern void dwarf2out_frame_finish (void);
 181 /* Decide whether we want to emit frame unwind information for the current
 182    translation unit.  */
 183 extern bool dwarf2out_do_frame (void);
 184 extern bool dwarf2out_do_cfi_asm (void);
 185 extern void dwarf2out_switch_text_section (void);
 186
 187 const char *remap_debug_filename (const char *);
 188 void add_debug_prefix_map (const char *);
 189
 190 /* For -fdump-go-spec.  */
 191
 192 extern const struct gcc_debug_hooks *
 193 dump_go_spec_init (const char *, const struct gcc_debug_hooks *);
 194
 195 #endif /* !GCC_DEBUG_H  */