/* Debug hooks for GCC.
|
/* Debug hooks for GCC.
|
Copyright (C) 2001, 2002, 2003, 2004, 2005, 2007, 2008
|
Copyright (C) 2001, 2002, 2003, 2004, 2005, 2007, 2008
|
Free Software Foundation, Inc.
|
Free Software Foundation, Inc.
|
|
|
This program is free software; you can redistribute it and/or modify it
|
This program is free software; you can redistribute it and/or modify it
|
under the terms of the GNU General Public License as published by the
|
under the terms of the GNU General Public License as published by the
|
Free Software Foundation; either version 3, or (at your option) any
|
Free Software Foundation; either version 3, or (at your option) any
|
later version.
|
later version.
|
|
|
This program is distributed in the hope that it will be useful,
|
This program is distributed in the hope that it will be useful,
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
GNU General Public License for more details.
|
GNU General Public License for more details.
|
|
|
You should have received a copy of the GNU General Public License
|
You should have received a copy of the GNU General Public License
|
along with this program; see the file COPYING3. If not see
|
along with this program; see the file COPYING3. If not see
|
<http://www.gnu.org/licenses/>. */
|
<http://www.gnu.org/licenses/>. */
|
|
|
#ifndef GCC_DEBUG_H
|
#ifndef GCC_DEBUG_H
|
#define GCC_DEBUG_H
|
#define GCC_DEBUG_H
|
|
|
/* This structure contains hooks for the debug information output
|
/* This structure contains hooks for the debug information output
|
functions, accessed through the global instance debug_hooks set in
|
functions, accessed through the global instance debug_hooks set in
|
toplev.c according to command line options. */
|
toplev.c according to command line options. */
|
struct gcc_debug_hooks
|
struct gcc_debug_hooks
|
{
|
{
|
/* Initialize debug output. MAIN_FILENAME is the name of the main
|
/* Initialize debug output. MAIN_FILENAME is the name of the main
|
input file. */
|
input file. */
|
void (* init) (const char *main_filename);
|
void (* init) (const char *main_filename);
|
|
|
/* Output debug symbols. */
|
/* Output debug symbols. */
|
void (* finish) (const char *main_filename);
|
void (* finish) (const char *main_filename);
|
|
|
/* Called from cgraph_optimize before starting to assemble
|
/* Called from cgraph_optimize before starting to assemble
|
functions/variables/toplevel asms. */
|
functions/variables/toplevel asms. */
|
void (* assembly_start) (void);
|
void (* assembly_start) (void);
|
|
|
/* Macro defined on line LINE with name and expansion TEXT. */
|
/* Macro defined on line LINE with name and expansion TEXT. */
|
void (* define) (unsigned int line, const char *text);
|
void (* define) (unsigned int line, const char *text);
|
|
|
/* MACRO undefined on line LINE. */
|
/* MACRO undefined on line LINE. */
|
void (* undef) (unsigned int line, const char *macro);
|
void (* undef) (unsigned int line, const char *macro);
|
|
|
/* Record the beginning of a new source file FILE from LINE number
|
/* Record the beginning of a new source file FILE from LINE number
|
in the previous one. */
|
in the previous one. */
|
void (* start_source_file) (unsigned int line, const char *file);
|
void (* start_source_file) (unsigned int line, const char *file);
|
|
|
/* Record the resumption of a source file. LINE is the line number
|
/* Record the resumption of a source file. LINE is the line number
|
in the source file we are returning to. */
|
in the source file we are returning to. */
|
void (* end_source_file) (unsigned int line);
|
void (* end_source_file) (unsigned int line);
|
|
|
/* Record the beginning of block N, counting from 1 and not
|
/* Record the beginning of block N, counting from 1 and not
|
including the function-scope block, at LINE. */
|
including the function-scope block, at LINE. */
|
void (* begin_block) (unsigned int line, unsigned int n);
|
void (* begin_block) (unsigned int line, unsigned int n);
|
|
|
/* Record the end of a block. Arguments as for begin_block. */
|
/* Record the end of a block. Arguments as for begin_block. */
|
void (* end_block) (unsigned int line, unsigned int n);
|
void (* end_block) (unsigned int line, unsigned int n);
|
|
|
/* Returns nonzero if it is appropriate not to emit any debugging
|
/* Returns nonzero if it is appropriate not to emit any debugging
|
information for BLOCK, because it doesn't contain any
|
information for BLOCK, because it doesn't contain any
|
instructions. This may not be the case for blocks containing
|
instructions. This may not be the case for blocks containing
|
nested functions, since we may actually call such a function even
|
nested functions, since we may actually call such a function even
|
though the BLOCK information is messed up. Defaults to true. */
|
though the BLOCK information is messed up. Defaults to true. */
|
bool (* ignore_block) (const_tree);
|
bool (* ignore_block) (const_tree);
|
|
|
/* Record a source file location at (FILE, LINE, DISCRIMINATOR). */
|
/* Record a source file location at (FILE, LINE, DISCRIMINATOR). */
|
void (* source_line) (unsigned int line, const char *file,
|
void (* source_line) (unsigned int line, const char *file,
|
int discriminator, bool is_stmt);
|
int discriminator, bool is_stmt);
|
|
|
/* Called at start of prologue code. LINE is the first line in the
|
/* Called at start of prologue code. LINE is the first line in the
|
function. */
|
function. */
|
void (* begin_prologue) (unsigned int line, const char *file);
|
void (* begin_prologue) (unsigned int line, const char *file);
|
|
|
/* Called at end of prologue code. LINE is the first line in the
|
/* Called at end of prologue code. LINE is the first line in the
|
function. */
|
function. */
|
void (* end_prologue) (unsigned int line, const char *file);
|
void (* end_prologue) (unsigned int line, const char *file);
|
|
|
/* Record end of epilogue code. */
|
/* Record end of epilogue code. */
|
void (* end_epilogue) (unsigned int line, const char *file);
|
void (* end_epilogue) (unsigned int line, const char *file);
|
|
|
/* Called at start of function DECL, before it is declared. */
|
/* Called at start of function DECL, before it is declared. */
|
void (* begin_function) (tree decl);
|
void (* begin_function) (tree decl);
|
|
|
/* Record end of function. LINE is highest line number in function. */
|
/* Record end of function. LINE is highest line number in function. */
|
void (* end_function) (unsigned int line);
|
void (* end_function) (unsigned int line);
|
|
|
/* Debug information for a function DECL. This might include the
|
/* Debug information for a function DECL. This might include the
|
function name (a symbol), its parameters, and the block that
|
function name (a symbol), its parameters, and the block that
|
makes up the function's body, and the local variables of the
|
makes up the function's body, and the local variables of the
|
function. */
|
function. */
|
void (* function_decl) (tree decl);
|
void (* function_decl) (tree decl);
|
|
|
/* Debug information for a global DECL. Called from toplev.c after
|
/* Debug information for a global DECL. Called from toplev.c after
|
compilation proper has finished. */
|
compilation proper has finished. */
|
void (* global_decl) (tree decl);
|
void (* global_decl) (tree decl);
|
|
|
/* Debug information for a type DECL. Called from toplev.c after
|
/* Debug information for a type DECL. Called from toplev.c after
|
compilation proper, also from various language front ends to
|
compilation proper, also from various language front ends to
|
record built-in types. The second argument is properly a
|
record built-in types. The second argument is properly a
|
boolean, which indicates whether or not the type is a "local"
|
boolean, which indicates whether or not the type is a "local"
|
type as determined by the language. (It's not a boolean for
|
type as determined by the language. (It's not a boolean for
|
legacy reasons.) */
|
legacy reasons.) */
|
void (* type_decl) (tree decl, int local);
|
void (* type_decl) (tree decl, int local);
|
|
|
/* Debug information for imported modules and declarations. */
|
/* Debug information for imported modules and declarations. */
|
void (* imported_module_or_decl) (tree decl, tree name,
|
void (* imported_module_or_decl) (tree decl, tree name,
|
tree context, bool child);
|
tree context, bool child);
|
|
|
/* DECL is an inline function, whose body is present, but which is
|
/* DECL is an inline function, whose body is present, but which is
|
not being output at this point. */
|
not being output at this point. */
|
void (* deferred_inline_function) (tree decl);
|
void (* deferred_inline_function) (tree decl);
|
|
|
/* DECL is an inline function which is about to be emitted out of
|
/* DECL is an inline function which is about to be emitted out of
|
line. The hook is useful to, e.g., emit abstract debug info for
|
line. The hook is useful to, e.g., emit abstract debug info for
|
the inline before it gets mangled by optimization. */
|
the inline before it gets mangled by optimization. */
|
void (* outlining_inline_function) (tree decl);
|
void (* outlining_inline_function) (tree decl);
|
|
|
/* Called from final_scan_insn for any CODE_LABEL insn whose
|
/* Called from final_scan_insn for any CODE_LABEL insn whose
|
LABEL_NAME is non-null. */
|
LABEL_NAME is non-null. */
|
void (* label) (rtx);
|
void (* label) (rtx);
|
|
|
/* Called after the start and before the end of writing a PCH file.
|
/* Called after the start and before the end of writing a PCH file.
|
The parameter is 0 if after the start, 1 if before the end. */
|
The parameter is 0 if after the start, 1 if before the end. */
|
void (* handle_pch) (unsigned int);
|
void (* handle_pch) (unsigned int);
|
|
|
/* Called from final_scan_insn for any NOTE_INSN_VAR_LOCATION note. */
|
/* Called from final_scan_insn for any NOTE_INSN_VAR_LOCATION note. */
|
void (* var_location) (rtx);
|
void (* var_location) (rtx);
|
|
|
/* Called from final_scan_insn if there is a switch between hot and cold
|
/* Called from final_scan_insn if there is a switch between hot and cold
|
text sections. */
|
text sections. */
|
void (* switch_text_section) (void);
|
void (* switch_text_section) (void);
|
|
|
/* Records a direct call to the function DECL, noting the point of call
|
/* Records a direct call to the function DECL, noting the point of call
|
and the debug info for the function. Called from final_scan_insn
|
and the debug info for the function. Called from final_scan_insn
|
when ICF debugging is enabled. */
|
when ICF debugging is enabled. */
|
void (* direct_call) (tree decl);
|
void (* direct_call) (tree decl);
|
|
|
/* Records the OBJ_TYPE_REF_TOKEN for a virtual call through ADDR, which
|
/* Records the OBJ_TYPE_REF_TOKEN for a virtual call through ADDR, which
|
for C++ is the vtable slot index, noting the INSN_UID for the call
|
for C++ is the vtable slot index, noting the INSN_UID for the call
|
instruction. Called from calls.c:emit_call_1 when ICF debugging is
|
instruction. Called from calls.c:emit_call_1 when ICF debugging is
|
enabled. It's necessary to do this during lowering because the
|
enabled. It's necessary to do this during lowering because the
|
call instruction and the OBJ_TYPE_REF become separated after that
|
call instruction and the OBJ_TYPE_REF become separated after that
|
point. */
|
point. */
|
void (* virtual_call_token) (tree addr, int insn_uid);
|
void (* virtual_call_token) (tree addr, int insn_uid);
|
|
|
/* Copies the OBJ_TYPE_REF_TOKEN for a virtual call from OLD_INSN to
|
/* Copies the OBJ_TYPE_REF_TOKEN for a virtual call from OLD_INSN to
|
NEW_INSN. Called from emit-rtl.c:try_split when a CALL_INSN is
|
NEW_INSN. Called from emit-rtl.c:try_split when a CALL_INSN is
|
split, so that the vtable slot index remains associated with the
|
split, so that the vtable slot index remains associated with the
|
new CALL_INSN. */
|
new CALL_INSN. */
|
void (* copy_call_info) (rtx old_insn, rtx new_insn);
|
void (* copy_call_info) (rtx old_insn, rtx new_insn);
|
|
|
/* Records a virtual call given INSN_UID, which is the UID of the call
|
/* Records a virtual call given INSN_UID, which is the UID of the call
|
instruction. The UID is then mapped to the vtable slot index noted
|
instruction. The UID is then mapped to the vtable slot index noted
|
during the lowering phase. Called from final_scan_insn when ICF
|
during the lowering phase. Called from final_scan_insn when ICF
|
debugging is enabled. */
|
debugging is enabled. */
|
void (* virtual_call) (int insn_uid);
|
void (* virtual_call) (int insn_uid);
|
|
|
/* Called from grokdeclarator. Replaces the anonymous name with the
|
/* Called from grokdeclarator. Replaces the anonymous name with the
|
type name. */
|
type name. */
|
void (* set_name) (tree, tree);
|
void (* set_name) (tree, tree);
|
|
|
/* This is 1 if the debug writer wants to see start and end commands for the
|
/* This is 1 if the debug writer wants to see start and end commands for the
|
main source files, and 0 otherwise. */
|
main source files, and 0 otherwise. */
|
int start_end_main_source_file;
|
int start_end_main_source_file;
|
};
|
};
|
|
|
extern const struct gcc_debug_hooks *debug_hooks;
|
extern const struct gcc_debug_hooks *debug_hooks;
|
|
|
/* The do-nothing hooks. */
|
/* The do-nothing hooks. */
|
extern void debug_nothing_void (void);
|
extern void debug_nothing_void (void);
|
extern void debug_nothing_charstar (const char *);
|
extern void debug_nothing_charstar (const char *);
|
extern void debug_nothing_int_charstar (unsigned int, const char *);
|
extern void debug_nothing_int_charstar (unsigned int, const char *);
|
extern void debug_nothing_int_charstar_int_bool (unsigned int, const char *,
|
extern void debug_nothing_int_charstar_int_bool (unsigned int, const char *,
|
int, bool);
|
int, bool);
|
extern void debug_nothing_int (unsigned int);
|
extern void debug_nothing_int (unsigned int);
|
extern void debug_nothing_int_int (unsigned int, unsigned int);
|
extern void debug_nothing_int_int (unsigned int, unsigned int);
|
extern void debug_nothing_tree (tree);
|
extern void debug_nothing_tree (tree);
|
extern void debug_nothing_tree_tree (tree, tree);
|
extern void debug_nothing_tree_tree (tree, tree);
|
extern void debug_nothing_tree_int (tree, int);
|
extern void debug_nothing_tree_int (tree, int);
|
extern void debug_nothing_tree_tree_tree_bool (tree, tree, tree, bool);
|
extern void debug_nothing_tree_tree_tree_bool (tree, tree, tree, bool);
|
extern bool debug_true_const_tree (const_tree);
|
extern bool debug_true_const_tree (const_tree);
|
extern void debug_nothing_rtx (rtx);
|
extern void debug_nothing_rtx (rtx);
|
extern void debug_nothing_rtx_rtx (rtx, rtx);
|
extern void debug_nothing_rtx_rtx (rtx, rtx);
|
extern void debug_nothing_uid (int);
|
extern void debug_nothing_uid (int);
|
|
|
/* Hooks for various debug formats. */
|
/* Hooks for various debug formats. */
|
extern const struct gcc_debug_hooks do_nothing_debug_hooks;
|
extern const struct gcc_debug_hooks do_nothing_debug_hooks;
|
extern const struct gcc_debug_hooks dbx_debug_hooks;
|
extern const struct gcc_debug_hooks dbx_debug_hooks;
|
extern const struct gcc_debug_hooks sdb_debug_hooks;
|
extern const struct gcc_debug_hooks sdb_debug_hooks;
|
extern const struct gcc_debug_hooks xcoff_debug_hooks;
|
extern const struct gcc_debug_hooks xcoff_debug_hooks;
|
extern const struct gcc_debug_hooks dwarf2_debug_hooks;
|
extern const struct gcc_debug_hooks dwarf2_debug_hooks;
|
extern const struct gcc_debug_hooks vmsdbg_debug_hooks;
|
extern const struct gcc_debug_hooks vmsdbg_debug_hooks;
|
|
|
/* Dwarf2 frame information. */
|
/* Dwarf2 frame information. */
|
|
|
extern void dwarf2out_begin_prologue (unsigned int, const char *);
|
extern void dwarf2out_begin_prologue (unsigned int, const char *);
|
extern void dwarf2out_end_epilogue (unsigned int, const char *);
|
extern void dwarf2out_end_epilogue (unsigned int, const char *);
|
extern void dwarf2out_frame_init (void);
|
extern void dwarf2out_frame_init (void);
|
extern void dwarf2out_frame_finish (void);
|
extern void dwarf2out_frame_finish (void);
|
/* Decide whether we want to emit frame unwind information for the current
|
/* Decide whether we want to emit frame unwind information for the current
|
translation unit. */
|
translation unit. */
|
extern int dwarf2out_do_frame (void);
|
extern int dwarf2out_do_frame (void);
|
extern int dwarf2out_do_cfi_asm (void);
|
extern int dwarf2out_do_cfi_asm (void);
|
extern void dwarf2out_switch_text_section (void);
|
extern void dwarf2out_switch_text_section (void);
|
|
|
extern void debug_flush_symbol_queue (void);
|
extern void debug_flush_symbol_queue (void);
|
extern void debug_queue_symbol (tree);
|
extern void debug_queue_symbol (tree);
|
extern void debug_free_queue (void);
|
extern void debug_free_queue (void);
|
extern int debug_nesting;
|
extern int debug_nesting;
|
extern int symbol_queue_index;
|
extern int symbol_queue_index;
|
|
|
const char *remap_debug_filename (const char *);
|
const char *remap_debug_filename (const char *);
|
void add_debug_prefix_map (const char *);
|
void add_debug_prefix_map (const char *);
|
|
|
#endif /* !GCC_DEBUG_H */
|
#endif /* !GCC_DEBUG_H */
|
|
|
