1/* Debug hooks for GCC.
2 Copyright (C) 2001-2017 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. */
24struct 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 /* Run cleanups necessary after early debug generation. */
34 void (* early_finish) (const char *main_filename);
35
36 /* Called from cgraph_optimize before starting to assemble
37 functions/variables/toplevel asms. */
38 void (* assembly_start) (void);
39
40 /* Macro defined on line LINE with name and expansion TEXT. */
41 void (* define) (unsigned int line, const char *text);
42
43 /* MACRO undefined on line LINE. */
44 void (* undef) (unsigned int line, const char *macro);
45
46 /* Record the beginning of a new source file FILE from LINE number
47 in the previous one. */
48 void (* start_source_file) (unsigned int line, const char *file);
49
50 /* Record the resumption of a source file. LINE is the line number
51 in the source file we are returning to. */
52 void (* end_source_file) (unsigned int line);
53
54 /* Record the beginning of block N, counting from 1 and not
55 including the function-scope block, at LINE. */
56 void (* begin_block) (unsigned int line, unsigned int n);
57
58 /* Record the end of a block. Arguments as for begin_block. */
59 void (* end_block) (unsigned int line, unsigned int n);
60
61 /* Returns nonzero if it is appropriate not to emit any debugging
62 information for BLOCK, because it doesn't contain any
63 instructions. This may not be the case for blocks containing
64 nested functions, since we may actually call such a function even
65 though the BLOCK information is messed up. Defaults to true. */
66 bool (* ignore_block) (const_tree);
67
68 /* Record a source file location at (FILE, LINE, COLUMN, DISCRIMINATOR). */
69 void (* source_line) (unsigned int line, unsigned int column,
70 const char *file, int discriminator, bool is_stmt);
71
72 /* Called at start of prologue code. LINE is the first line in the
73 function. */
74 void (* begin_prologue) (unsigned int line, unsigned int column,
75 const char *file);
76
77 /* Called at end of prologue code. LINE is the first line in the
78 function. */
79 void (* end_prologue) (unsigned int line, const char *file);
80
81 /* Called at beginning of epilogue code. */
82 void (* begin_epilogue) (unsigned int line, const char *file);
83
84 /* Record end of epilogue code. */
85 void (* end_epilogue) (unsigned int line, const char *file);
86
87 /* Called at start of function DECL, before it is declared. */
88 void (* begin_function) (tree decl);
89
90 /* Record end of function. LINE is highest line number in function. */
91 void (* end_function) (unsigned int line);
92
93 /* Register UNIT as the main translation unit. Called from front-ends when
94 they create their main translation unit. */
95 void (* register_main_translation_unit) (tree);
96
97 /* Debug information for a function DECL. This might include the
98 function name (a symbol), its parameters, and the block that
99 makes up the function's body, and the local variables of the
100 function.
101
102 This is only called for FUNCTION_DECLs. It is part of the late
103 debug pass and is called from rest_of_handle_final.
104
105 Location information is available at this point.
106
107 See the documentation for early_global_decl and late_global_decl
108 for other entry points into the debugging back-ends for DECLs. */
109 void (* function_decl) (tree decl);
110
111 /* Debug information for a global DECL. Called from the parser
112 after the parsing process has finished.
113
114 This gets called for both variables and functions.
115
116 Location information is not available at this point, but it is a
117 good probe point to get access to symbols before they get
118 optimized away.
119
120 This hook may be called on VAR_DECLs or FUNCTION_DECLs. It is up
121 to the hook to use what it needs. */
122 void (* early_global_decl) (tree decl);
123
124 /* Augment debug information generated by early_global_decl with
125 more complete debug info (if applicable). Called from toplev.c
126 after the compilation proper has finished and cgraph information
127 is available.
128
129 This gets called for both variables and functions.
130
131 Location information is usually available at this point, unless
132 the hook is being called for a decl that has been optimized away.
133
134 This hook may be called on VAR_DECLs or FUNCTION_DECLs. It is up
135 to the hook to use what it needs. */
136 void (* late_global_decl) (tree decl);
137
138 /* Debug information for a type DECL. Called from toplev.c after
139 compilation proper, also from various language front ends to
140 record built-in types. The second argument is properly a
141 boolean, which indicates whether or not the type is a "local"
142 type as determined by the language. (It's not a boolean for
143 legacy reasons.) */
144 void (* type_decl) (tree decl, int local);
145
146 /* Debug information for imported modules and declarations. */
147 void (* imported_module_or_decl) (tree decl, tree name,
148 tree context, bool child,
149 bool implicit);
150
151 /* Return true if a DIE for the tree is available and return a symbol
152 and offset that can be used to refer to it externally. */
153 bool (* die_ref_for_decl) (tree, const char **, unsigned HOST_WIDE_INT *);
154
155 /* Early debug information for the tree is available at symbol plus
156 offset externally. */
157 void (* register_external_die) (tree, const char *, unsigned HOST_WIDE_INT);
158
159 /* DECL is an inline function, whose body is present, but which is
160 not being output at this point. */
161 void (* deferred_inline_function) (tree decl);
162
163 /* DECL is an inline function which is about to be emitted out of
164 line. The hook is useful to, e.g., emit abstract debug info for
165 the inline before it gets mangled by optimization. */
166 void (* outlining_inline_function) (tree decl);
167
168 /* Called from final_scan_insn for any CODE_LABEL insn whose
169 LABEL_NAME is non-null. */
170 void (* label) (rtx_code_label *);
171
172 /* Called after the start and before the end of writing a PCH file.
173 The parameter is 0 if after the start, 1 if before the end. */
174 void (* handle_pch) (unsigned int);
175
176 /* Called from final_scan_insn for any NOTE_INSN_VAR_LOCATION note. */
177 void (* var_location) (rtx_insn *);
178
179 /* Called from final_scan_insn for any NOTE_INSN_INLINE_ENTRY note. */
180 void (* inline_entry) (tree block);
181
182 /* Called from finalize_size_functions for size functions so that their body
183 can be encoded in the debug info to describe the layout of variable-length
184 structures. */
185 void (* size_function) (tree decl);
186
187 /* Called from final_scan_insn if there is a switch between hot and cold
188 text sections. */
189 void (* switch_text_section) (void);
190
191 /* Called from grokdeclarator. Replaces the anonymous name with the
192 type name. */
193 void (* set_name) (tree, tree);
194
195 /* This is 1 if the debug writer wants to see start and end commands for the
196 main source files, and 0 otherwise. */
197 int start_end_main_source_file;
198
199 /* The type of symtab field used by these debug hooks. This is one
200 of the TYPE_SYMTAB_IS_xxx values defined in tree.h. */
201 int tree_type_symtab_field;
202};
203
204extern const struct gcc_debug_hooks *debug_hooks;
205
206/* The do-nothing hooks. */
207extern void debug_nothing_void (void);
208extern void debug_nothing_charstar (const char *);
209extern void debug_nothing_int_int_charstar (unsigned int, unsigned int,
210 const char *);
211extern void debug_nothing_int_charstar (unsigned int, const char *);
212extern void debug_nothing_int_int_charstar_int_bool (unsigned int,
213 unsigned int,
214 const char *,
215 int, bool);
216extern void debug_nothing_int (unsigned int);
217extern void debug_nothing_int_int (unsigned int, unsigned int);
218extern void debug_nothing_tree (tree);
219extern void debug_nothing_tree_tree (tree, tree);
220extern void debug_nothing_tree_int (tree, int);
221extern void debug_nothing_tree_tree_tree_bool_bool (tree, tree, tree,
222 bool, bool);
223extern bool debug_true_const_tree (const_tree);
224extern void debug_nothing_rtx_insn (rtx_insn *);
225extern void debug_nothing_rtx_code_label (rtx_code_label *);
226extern bool debug_false_tree_charstarstar_uhwistar (tree, const char **,
227 unsigned HOST_WIDE_INT *);
228extern void debug_nothing_tree_charstar_uhwi (tree, const char *,
229 unsigned HOST_WIDE_INT);
230
231/* Hooks for various debug formats. */
232extern const struct gcc_debug_hooks do_nothing_debug_hooks;
233extern const struct gcc_debug_hooks dbx_debug_hooks;
234extern const struct gcc_debug_hooks xcoff_debug_hooks;
235extern const struct gcc_debug_hooks dwarf2_debug_hooks;
236extern const struct gcc_debug_hooks dwarf2_lineno_debug_hooks;
237extern const struct gcc_debug_hooks vmsdbg_debug_hooks;
238
239/* Dwarf2 frame information. */
240
241extern void dwarf2out_begin_prologue (unsigned int, unsigned int,
242 const char *);
243extern void dwarf2out_vms_end_prologue (unsigned int, const char *);
244extern void dwarf2out_vms_begin_epilogue (unsigned int, const char *);
245extern void dwarf2out_end_epilogue (unsigned int, const char *);
246extern void dwarf2out_frame_finish (void);
247extern bool dwarf2out_do_eh_frame (void);
248extern bool dwarf2out_do_frame (void);
249extern bool dwarf2out_do_cfi_asm (void);
250extern void dwarf2out_switch_text_section (void);
251
252const char *remap_debug_filename (const char *);
253void add_debug_prefix_map (const char *);
254
255/* For -fdump-go-spec. */
256
257extern const struct gcc_debug_hooks *
258dump_go_spec_init (const char *, const struct gcc_debug_hooks *);
259
260#endif /* !GCC_DEBUG_H */
261