584 lines
21 KiB
C
584 lines
21 KiB
C
/* Definitions for reading symbol files into GDB.
|
|
|
|
Copyright (C) 1990, 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
|
|
2000, 2001, 2002, 2003, 2004, 2007, 2008, 2009, 2010
|
|
Free Software Foundation, Inc.
|
|
|
|
This file is part of GDB.
|
|
|
|
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 Free Software Foundation; either version 3 of the License, or
|
|
(at your option) any later version.
|
|
|
|
This program is distributed in the hope that it will be useful,
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
GNU General Public License for more details.
|
|
|
|
You should have received a copy of the GNU General Public License
|
|
along with this program. If not, see <http://www.gnu.org/licenses/>. */
|
|
|
|
#if !defined (SYMFILE_H)
|
|
#define SYMFILE_H
|
|
|
|
/* This file requires that you first include "bfd.h". */
|
|
#include "symtab.h"
|
|
|
|
/* Opaque declarations. */
|
|
struct target_section;
|
|
struct objfile;
|
|
struct obj_section;
|
|
struct obstack;
|
|
struct block;
|
|
|
|
/* Comparison function for symbol look ups. */
|
|
|
|
typedef int (symbol_compare_ftype) (const char *string1,
|
|
const char *string2);
|
|
|
|
/* Partial symbols are stored in the psymbol_cache and pointers to
|
|
them are kept in a dynamically grown array that is obtained from
|
|
malloc and grown as necessary via realloc. Each objfile typically
|
|
has two of these, one for global symbols and one for static
|
|
symbols. Although this adds a level of indirection for storing or
|
|
accessing the partial symbols, it allows us to throw away duplicate
|
|
psymbols and set all pointers to the single saved instance. */
|
|
|
|
struct psymbol_allocation_list
|
|
{
|
|
|
|
/* Pointer to beginning of dynamically allocated array of pointers
|
|
to partial symbols. The array is dynamically expanded as
|
|
necessary to accommodate more pointers. */
|
|
|
|
struct partial_symbol **list;
|
|
|
|
/* Pointer to next available slot in which to store a pointer to a
|
|
partial symbol. */
|
|
|
|
struct partial_symbol **next;
|
|
|
|
/* Number of allocated pointer slots in current dynamic array (not
|
|
the number of bytes of storage). The "next" pointer will always
|
|
point somewhere between list[0] and list[size], and when at
|
|
list[size] the array will be expanded on the next attempt to
|
|
store a pointer. */
|
|
|
|
int size;
|
|
};
|
|
|
|
/* Define an array of addresses to accommodate non-contiguous dynamic
|
|
loading of modules. This is for use when entering commands, so we
|
|
can keep track of the section names until we read the file and can
|
|
map them to bfd sections. This structure is also used by solib.c
|
|
to communicate the section addresses in shared objects to
|
|
symbol_file_add (). */
|
|
|
|
struct section_addr_info
|
|
{
|
|
/* The number of sections for which address information is
|
|
available. */
|
|
size_t num_sections;
|
|
/* Sections whose names are file format dependent. */
|
|
struct other_sections
|
|
{
|
|
CORE_ADDR addr;
|
|
char *name;
|
|
|
|
/* SECTINDEX must be valid for associated BFD if ADDR is not zero. */
|
|
int sectindex;
|
|
} other[1];
|
|
};
|
|
|
|
|
|
/* A table listing the load segments in a symfile, and which segment
|
|
each BFD section belongs to. */
|
|
struct symfile_segment_data
|
|
{
|
|
/* How many segments are present in this file. If there are
|
|
two, the text segment is the first one and the data segment
|
|
is the second one. */
|
|
int num_segments;
|
|
|
|
/* If NUM_SEGMENTS is greater than zero, the original base address
|
|
of each segment. */
|
|
CORE_ADDR *segment_bases;
|
|
|
|
/* If NUM_SEGMENTS is greater than zero, the memory size of each
|
|
segment. */
|
|
CORE_ADDR *segment_sizes;
|
|
|
|
/* If NUM_SEGMENTS is greater than zero, this is an array of entries
|
|
recording which segment contains each BFD section.
|
|
SEGMENT_INFO[I] is S+1 if the I'th BFD section belongs to segment
|
|
S, or zero if it is not in any segment. */
|
|
int *segment_info;
|
|
};
|
|
|
|
/* The "quick" symbol functions exist so that symbol readers can
|
|
avoiding an initial read of all the symbols. For example, symbol
|
|
readers might choose to use the "partial symbol table" utilities,
|
|
which is one implementation of the quick symbol functions.
|
|
|
|
The quick symbol functions are generally opaque: the underlying
|
|
representation is hidden from the caller.
|
|
|
|
In general, these functions should only look at whatever special
|
|
index the symbol reader creates -- looking through the symbol
|
|
tables themselves is handled by generic code. If a function is
|
|
defined as returning a "symbol table", this means that the function
|
|
should only return a newly-created symbol table; it should not
|
|
examine pre-existing ones.
|
|
|
|
The exact list of functions here was determined in an ad hoc way
|
|
based on gdb's history. */
|
|
|
|
struct quick_symbol_functions
|
|
{
|
|
/* Return true if this objfile has any "partial" symbols
|
|
available. */
|
|
int (*has_symbols) (struct objfile *objfile);
|
|
|
|
/* Return the symbol table for the "last" file appearing in
|
|
OBJFILE. */
|
|
struct symtab *(*find_last_source_symtab) (struct objfile *objfile);
|
|
|
|
/* Forget all cached full file names for OBJFILE. */
|
|
void (*forget_cached_source_info) (struct objfile *objfile);
|
|
|
|
/* Look up the symbol table, in OBJFILE, of a source file named
|
|
NAME. If there is no '/' in the name, a match after a '/' in the
|
|
symbol table's file name will also work. FULL_PATH is the
|
|
absolute file name, and REAL_PATH is the same, run through
|
|
gdb_realpath.
|
|
|
|
If no such symbol table can be found, returns 0.
|
|
|
|
Otherwise, sets *RESULT to the symbol table and returns 1. This
|
|
might return 1 and set *RESULT to NULL if the requested file is
|
|
an include file that does not have a symtab of its own. */
|
|
int (*lookup_symtab) (struct objfile *objfile,
|
|
const char *name,
|
|
const char *full_path,
|
|
const char *real_path,
|
|
struct symtab **result);
|
|
|
|
/* Check to see if the symbol is defined in a "partial" symbol table
|
|
of OBJFILE. KIND should be either GLOBAL_BLOCK or STATIC_BLOCK,
|
|
depending on whether we want to search global symbols or static
|
|
symbols. NAME is the name of the symbol to look for. DOMAIN
|
|
indicates what sort of symbol to search for.
|
|
|
|
Returns the newly-expanded symbol table in which the symbol is
|
|
defined, or NULL if no such symbol table exists. */
|
|
struct symtab *(*lookup_symbol) (struct objfile *objfile,
|
|
int kind, const char *name,
|
|
domain_enum domain);
|
|
|
|
/* This is called to expand symbol tables before looking up a
|
|
symbol. A backend can choose to implement this and then have its
|
|
`lookup_symbol' hook always return NULL, or the reverse. (It
|
|
doesn't make sense to implement both.) The arguments are as for
|
|
`lookup_symbol'. */
|
|
void (*pre_expand_symtabs_matching) (struct objfile *objfile,
|
|
int kind, const char *name,
|
|
domain_enum domain);
|
|
|
|
/* Print statistics about any indices loaded for OBJFILE. The
|
|
statistics should be printed to gdb_stdout. This is used for
|
|
"maint print statistics". */
|
|
void (*print_stats) (struct objfile *objfile);
|
|
|
|
/* Dump any indices loaded for OBJFILE. The dump should go to
|
|
gdb_stdout. This is used for "maint print objfiles". */
|
|
void (*dump) (struct objfile *objfile);
|
|
|
|
/* This is called by objfile_relocate to relocate any indices loaded
|
|
for OBJFILE. */
|
|
void (*relocate) (struct objfile *objfile,
|
|
struct section_offsets *new_offsets,
|
|
struct section_offsets *delta);
|
|
|
|
/* Find all the symbols in OBJFILE named FUNC_NAME, and ensure that
|
|
the corresponding symbol tables are loaded. */
|
|
void (*expand_symtabs_for_function) (struct objfile *objfile,
|
|
const char *func_name);
|
|
|
|
/* Read all symbol tables associated with OBJFILE. */
|
|
void (*expand_all_symtabs) (struct objfile *objfile);
|
|
|
|
/* Read all symbol tables associated with OBJFILE which have the
|
|
file name FILENAME.
|
|
This is for the purposes of examining code only, e.g., expand_line_sal.
|
|
The routine may ignore debug info that is known to not be useful with
|
|
code, e.g., DW_TAG_type_unit for dwarf debug info. */
|
|
void (*expand_symtabs_with_filename) (struct objfile *objfile,
|
|
const char *filename);
|
|
|
|
/* Return the file name of the file holding the symbol in OBJFILE
|
|
named NAME. If no such symbol exists in OBJFILE, return NULL. */
|
|
const char *(*find_symbol_file) (struct objfile *objfile, const char *name);
|
|
|
|
/* Find global or static symbols in all tables that are in NAMESPACE
|
|
and for which MATCH (symbol name, NAME) == 0, passing each to
|
|
CALLBACK, reading in partial symbol symbol tables as needed. Look
|
|
through global symbols if GLOBAL and otherwise static symbols.
|
|
Passes NAME, NAMESPACE, and DATA to CALLBACK with each symbol
|
|
found. After each block is processed, passes NULL to CALLBACK.
|
|
MATCH must be weaker than strcmp_iw in the sense that
|
|
strcmp_iw(x,y) == 0 --> MATCH(x,y) == 0. ORDERED_COMPARE, if
|
|
non-null, must be an ordering relation compatible with strcmp_iw
|
|
in the sense that
|
|
strcmp(x,y) == 0 --> ORDERED_COMPARE(x,y) == 0
|
|
and
|
|
strcmp(x,y) <= 0 --> ORDERED_COMPARE(x,y) <= 0
|
|
(allowing strcmp(x,y) < 0 while ORDERED_COMPARE(x, y) == 0).
|
|
CALLBACK returns 0 to indicate that the scan should continue, or
|
|
non-zero to indicate that the scan should be terminated. */
|
|
|
|
void (*map_matching_symbols) (const char *name, domain_enum namespace,
|
|
struct objfile *, int global,
|
|
int (*callback) (struct block *,
|
|
struct symbol *, void *),
|
|
void *data,
|
|
symbol_compare_ftype *match,
|
|
symbol_compare_ftype *ordered_compare);
|
|
|
|
/* Expand all symbol tables in OBJFILE matching some criteria.
|
|
|
|
FILE_MATCHER is called for each file in OBJFILE. The file name
|
|
and the DATA argument are passed to it. If it returns zero, this
|
|
file is skipped.
|
|
|
|
Otherwise, if the file is not skipped, then NAME_MATCHER is
|
|
called for each symbol defined in the file. The symbol's
|
|
"natural" name and DATA are passed to NAME_MATCHER.
|
|
|
|
If NAME_MATCHER returns zero, then this symbol is skipped.
|
|
|
|
Otherwise, if this symbol is not skipped, and it matches KIND,
|
|
then this symbol's symbol table is expanded.
|
|
|
|
DATA is user data that is passed unmodified to the callback
|
|
functions. */
|
|
void (*expand_symtabs_matching) (struct objfile *objfile,
|
|
int (*file_matcher) (const char *, void *),
|
|
int (*name_matcher) (const char *, void *),
|
|
domain_enum kind,
|
|
void *data);
|
|
|
|
/* Return the symbol table from OBJFILE that contains PC and
|
|
SECTION. Return NULL if there is no such symbol table. This
|
|
should return the symbol table that contains a symbol whose
|
|
address exactly matches PC, or, if there is no exact match, the
|
|
symbol table that contains a symbol whose address is closest to
|
|
PC. */
|
|
struct symtab *(*find_pc_sect_symtab) (struct objfile *objfile,
|
|
struct minimal_symbol *msymbol,
|
|
CORE_ADDR pc,
|
|
struct obj_section *section,
|
|
int warn_if_readin);
|
|
|
|
/* Call a callback for every symbol defined in OBJFILE. FUN is the
|
|
callback. It is passed the symbol's natural name, and the DATA
|
|
passed to this function. */
|
|
void (*map_symbol_names) (struct objfile *objfile,
|
|
void (*fun) (const char *, void *),
|
|
void *data);
|
|
|
|
/* Call a callback for every file defined in OBJFILE. FUN is the
|
|
callback. It is passed the file's name, the file's full name,
|
|
and the DATA passed to this function. */
|
|
void (*map_symbol_filenames) (struct objfile *objfile,
|
|
void (*fun) (const char *, const char *,
|
|
void *),
|
|
void *data);
|
|
};
|
|
|
|
/* Structure to keep track of symbol reading functions for various
|
|
object file types. */
|
|
|
|
struct sym_fns
|
|
{
|
|
|
|
/* BFD flavour that we handle, or (as a special kludge, see
|
|
xcoffread.c, (enum bfd_flavour)-1 for xcoff). */
|
|
|
|
enum bfd_flavour sym_flavour;
|
|
|
|
/* Initializes anything that is global to the entire symbol table.
|
|
It is called during symbol_file_add, when we begin debugging an
|
|
entirely new program. */
|
|
|
|
void (*sym_new_init) (struct objfile *);
|
|
|
|
/* Reads any initial information from a symbol file, and initializes
|
|
the struct sym_fns SF in preparation for sym_read(). It is
|
|
called every time we read a symbol file for any reason. */
|
|
|
|
void (*sym_init) (struct objfile *);
|
|
|
|
/* sym_read (objfile, symfile_flags) Reads a symbol file into a psymtab
|
|
(or possibly a symtab). OBJFILE is the objfile struct for the
|
|
file we are reading. SYMFILE_FLAGS are the flags passed to
|
|
symbol_file_add & co. */
|
|
|
|
void (*sym_read) (struct objfile *, int);
|
|
|
|
/* Called when we are finished with an objfile. Should do all
|
|
cleanup that is specific to the object file format for the
|
|
particular objfile. */
|
|
|
|
void (*sym_finish) (struct objfile *);
|
|
|
|
/* This function produces a file-dependent section_offsets
|
|
structure, allocated in the objfile's storage, and based on the
|
|
parameter. The parameter is currently a CORE_ADDR (FIXME!) for
|
|
backward compatibility with the higher levels of GDB. It should
|
|
probably be changed to a string, where NULL means the default,
|
|
and others are parsed in a file dependent way. */
|
|
|
|
void (*sym_offsets) (struct objfile *, struct section_addr_info *);
|
|
|
|
/* This function produces a format-independent description of
|
|
the segments of ABFD. Each segment is a unit of the file
|
|
which may be relocated independently. */
|
|
|
|
struct symfile_segment_data *(*sym_segments) (bfd *abfd);
|
|
|
|
/* This function should read the linetable from the objfile when
|
|
the line table cannot be read while processing the debugging
|
|
information. */
|
|
|
|
void (*sym_read_linetable) (void);
|
|
|
|
/* Relocate the contents of a debug section SECTP. The
|
|
contents are stored in BUF if it is non-NULL, or returned in a
|
|
malloc'd buffer otherwise. */
|
|
|
|
bfd_byte *(*sym_relocate) (struct objfile *, asection *sectp, bfd_byte *buf);
|
|
|
|
/* The "quick" (aka partial) symbol functions for this symbol
|
|
reader. */
|
|
const struct quick_symbol_functions *qf;
|
|
};
|
|
|
|
extern struct section_addr_info *
|
|
build_section_addr_info_from_objfile (const struct objfile *objfile);
|
|
|
|
extern void relative_addr_info_to_section_offsets
|
|
(struct section_offsets *section_offsets, int num_sections,
|
|
struct section_addr_info *addrs);
|
|
|
|
extern void addr_info_make_relative (struct section_addr_info *addrs,
|
|
bfd *abfd);
|
|
|
|
/* The default version of sym_fns.sym_offsets for readers that don't
|
|
do anything special. */
|
|
|
|
extern void default_symfile_offsets (struct objfile *objfile,
|
|
struct section_addr_info *);
|
|
|
|
/* The default version of sym_fns.sym_segments for readers that don't
|
|
do anything special. */
|
|
|
|
extern struct symfile_segment_data *default_symfile_segments (bfd *abfd);
|
|
|
|
/* The default version of sym_fns.sym_relocate for readers that don't
|
|
do anything special. */
|
|
|
|
extern bfd_byte *default_symfile_relocate (struct objfile *objfile,
|
|
asection *sectp, bfd_byte *buf);
|
|
|
|
extern struct symtab *allocate_symtab (const char *, struct objfile *);
|
|
|
|
extern void add_symtab_fns (const struct sym_fns *);
|
|
|
|
/* This enum encodes bit-flags passed as ADD_FLAGS parameter to
|
|
syms_from_objfile, symbol_file_add, etc. */
|
|
|
|
enum symfile_add_flags
|
|
{
|
|
/* Be chatty about what you are doing. */
|
|
SYMFILE_VERBOSE = 1 << 1,
|
|
|
|
/* This is the main symbol file (as opposed to symbol file for dynamically
|
|
loaded code). */
|
|
SYMFILE_MAINLINE = 1 << 2,
|
|
|
|
/* Do not call breakpoint_re_set when adding this symbol file. */
|
|
SYMFILE_DEFER_BP_RESET = 1 << 3
|
|
};
|
|
|
|
extern void syms_from_objfile (struct objfile *,
|
|
struct section_addr_info *,
|
|
struct section_offsets *, int, int);
|
|
|
|
extern void new_symfile_objfile (struct objfile *, int);
|
|
|
|
extern struct objfile *symbol_file_add (char *, int,
|
|
struct section_addr_info *, int);
|
|
|
|
extern struct objfile *symbol_file_add_from_bfd (bfd *, int,
|
|
struct section_addr_info *,
|
|
int);
|
|
|
|
extern void symbol_file_add_separate (bfd *, int, struct objfile *);
|
|
|
|
extern char *find_separate_debug_file_by_debuglink (struct objfile *);
|
|
|
|
/* Create a new section_addr_info, with room for NUM_SECTIONS. */
|
|
|
|
extern struct section_addr_info *alloc_section_addr_info (size_t
|
|
num_sections);
|
|
|
|
/* Build (allocate and populate) a section_addr_info struct from an
|
|
existing section table. */
|
|
|
|
extern struct section_addr_info
|
|
*build_section_addr_info_from_section_table (const struct target_section
|
|
*start,
|
|
const struct target_section
|
|
*end);
|
|
|
|
/* Free all memory allocated by
|
|
build_section_addr_info_from_section_table. */
|
|
|
|
extern void free_section_addr_info (struct section_addr_info *);
|
|
|
|
|
|
/* Make a copy of the string at PTR with SIZE characters in the symbol
|
|
obstack (and add a null character at the end in the copy). Returns
|
|
the address of the copy. */
|
|
|
|
extern char *obsavestring (const char *, int, struct obstack *);
|
|
|
|
/* Concatenate NULL terminated variable argument list of `const char *' strings;
|
|
return the new string. Space is found in the OBSTACKP. Argument list must
|
|
be terminated by a sentinel expression `(char *) NULL'. */
|
|
|
|
extern char *obconcat (struct obstack *obstackp, ...) ATTRIBUTE_SENTINEL;
|
|
|
|
/* Variables */
|
|
|
|
/* If non-zero, shared library symbols will be added automatically
|
|
when the inferior is created, new libraries are loaded, or when
|
|
attaching to the inferior. This is almost always what users will
|
|
want to have happen; but for very large programs, the startup time
|
|
will be excessive, and so if this is a problem, the user can clear
|
|
this flag and then add the shared library symbols as needed. Note
|
|
that there is a potential for confusion, since if the shared
|
|
library symbols are not loaded, commands like "info fun" will *not*
|
|
report all the functions that are actually present. */
|
|
|
|
extern int auto_solib_add;
|
|
|
|
/* For systems that support it, a threshold size in megabytes. If
|
|
automatically adding a new library's symbol table to those already
|
|
known to the debugger would cause the total shared library symbol
|
|
size to exceed this threshhold, then the shlib's symbols are not
|
|
added. The threshold is ignored if the user explicitly asks for a
|
|
shlib to be added, such as when using the "sharedlibrary" command. */
|
|
|
|
extern int auto_solib_limit;
|
|
|
|
/* From symfile.c */
|
|
|
|
extern void set_initial_language (void);
|
|
|
|
extern void find_lowest_section (bfd *, asection *, void *);
|
|
|
|
extern bfd *symfile_bfd_open (char *);
|
|
|
|
extern bfd *bfd_open_maybe_remote (const char *);
|
|
|
|
extern int get_section_index (struct objfile *, char *);
|
|
|
|
/* Utility functions for overlay sections: */
|
|
extern enum overlay_debugging_state
|
|
{
|
|
ovly_off,
|
|
ovly_on,
|
|
ovly_auto
|
|
} overlay_debugging;
|
|
extern int overlay_cache_invalid;
|
|
|
|
/* Return the "mapped" overlay section containing the PC. */
|
|
extern struct obj_section *find_pc_mapped_section (CORE_ADDR);
|
|
|
|
/* Return any overlay section containing the PC (even in its LMA
|
|
region). */
|
|
extern struct obj_section *find_pc_overlay (CORE_ADDR);
|
|
|
|
/* Return true if the section is an overlay. */
|
|
extern int section_is_overlay (struct obj_section *);
|
|
|
|
/* Return true if the overlay section is currently "mapped". */
|
|
extern int section_is_mapped (struct obj_section *);
|
|
|
|
/* Return true if pc belongs to section's VMA. */
|
|
extern CORE_ADDR pc_in_mapped_range (CORE_ADDR, struct obj_section *);
|
|
|
|
/* Return true if pc belongs to section's LMA. */
|
|
extern CORE_ADDR pc_in_unmapped_range (CORE_ADDR, struct obj_section *);
|
|
|
|
/* Map an address from a section's LMA to its VMA. */
|
|
extern CORE_ADDR overlay_mapped_address (CORE_ADDR, struct obj_section *);
|
|
|
|
/* Map an address from a section's VMA to its LMA. */
|
|
extern CORE_ADDR overlay_unmapped_address (CORE_ADDR, struct obj_section *);
|
|
|
|
/* Convert an address in an overlay section (force into VMA range). */
|
|
extern CORE_ADDR symbol_overlayed_address (CORE_ADDR, struct obj_section *);
|
|
|
|
/* Load symbols from a file. */
|
|
extern void symbol_file_add_main (char *args, int from_tty);
|
|
|
|
/* Clear GDB symbol tables. */
|
|
extern void symbol_file_clear (int from_tty);
|
|
|
|
/* Default overlay update function. */
|
|
extern void simple_overlay_update (struct obj_section *);
|
|
|
|
extern bfd_byte *symfile_relocate_debug_section (struct objfile *, asection *,
|
|
bfd_byte *);
|
|
|
|
extern int symfile_map_offsets_to_segments (bfd *,
|
|
struct symfile_segment_data *,
|
|
struct section_offsets *,
|
|
int, const CORE_ADDR *);
|
|
struct symfile_segment_data *get_symfile_segment_data (bfd *abfd);
|
|
void free_symfile_segment_data (struct symfile_segment_data *data);
|
|
|
|
extern struct cleanup *increment_reading_symtab (void);
|
|
|
|
/* From dwarf2read.c */
|
|
|
|
extern int dwarf2_has_info (struct objfile *);
|
|
|
|
extern int dwarf2_initialize_objfile (struct objfile *);
|
|
extern void dwarf2_build_psymtabs (struct objfile *);
|
|
extern void dwarf2_build_frame_info (struct objfile *);
|
|
|
|
void dwarf2_free_objfile (struct objfile *);
|
|
|
|
/* From mdebugread.c */
|
|
|
|
/* Hack to force structures to exist before use in parameter list. */
|
|
struct ecoff_debug_hack
|
|
{
|
|
struct ecoff_debug_swap *a;
|
|
struct ecoff_debug_info *b;
|
|
};
|
|
|
|
extern void mdebug_build_psymtabs (struct objfile *,
|
|
const struct ecoff_debug_swap *,
|
|
struct ecoff_debug_info *);
|
|
|
|
extern void elfmdebug_build_psymtabs (struct objfile *,
|
|
const struct ecoff_debug_swap *,
|
|
asection *);
|
|
|
|
#endif /* !defined(SYMFILE_H) */
|