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