mirror of
https://sourceware.org/git/binutils-gdb.git
synced 2025-03-01 13:26:47 +08:00
Summary: - This is preparation for supporting wild name matching on C++ too. - This is also preparation for TAB-completion fixes. - Makes symbol name matching (think strcmp_iw) be based on a per-language method. - Merges completion and non-completion name comparison (think language_ops::la_get_symbol_name_cmp generalized). - Avoid re-hashing lookup name multiple times - Centralizes preparing a name for lookup (Ada name encoding / C++ Demangling), both completion and non-completion. - Fixes Ada latent bug with verbatim name matches in expressions - Makes ada-lang.c use common|symtab.c completion code a bit more. Ada's wild matching basically means that "(gdb) break foo" will find all methods named "foo" in all packages. Translating to C++, it's roughly the same as saying that "break klass::method" sets breakpoints on all "klass::method" methods of all classes, no matter the namespace. A following patch will teach GDB about fullname vs wild matching for C++ too. This patch is preparatory work to get there. Another idea here is to do symbol name matching based on the symbol language's algorithm. I.e., avoid dependency on current language set. This allows for example doing (gdb) b foo::bar< int > (<tab> and having gdb name match the C++ symbols correctly even if the current language is C or Assembly (or Rust, or Ada, or ...), which can easily happen if you step into an Assembly/C runtime library frame. By encapsulating all the information related to a lookup name in a class, we can also cache hash computation for a given language in the lookup name object, to avoid recomputing it over and over. Similarly, because we don't really know upfront which languages the lookup name will be matched against, for each language we store the lookup name transformed into a search name. E.g., for C++, that means demangling the name. But for Ada, it means encoding the name. This actually forces us to centralize all the different lookup name encoding in a central place, resulting in clearer code, IMO. See e.g., the new ada_lookup_name_info class. The lookup name -> symbol search name computation is also done only once per language. The old language->la_get_symbol_name_cmp / symbol_name_cmp_ftype are generalized to work with both completion, and normal symbol look up. At some point early on, I had separate completion vs non-completion language vector entry points, but a single method ends up being better IMO for simplifying things -- the more we merge the completion / non-completion name lookup code paths, the less changes for bugs causing completion vs normal lookup finding different symbols. The ada-lex.l change is necessary because when doing (gdb) p <UpperCase> then the name that is passed to write_ write_var_or_type -> ada_lookup_symbol_list misses the "<>", i.e., it's just "UpperCase", and we end up doing a wild match against "UpperCase" lowercased by ada_lookup_name_info's constructor. I.e., "uppercase" wouldn't ever match "UpperCase", and the symbol lookup fails. This wouldn't cause any regression in the testsuite, but I added a new test that would pass before the patch and fail after, if it weren't for that fix. This is latent bug that happens to go unnoticed because that particular path was inconsistent with the rest of Ada symbol lookup by not lowercasing the lookup name. Ada's symbol_completion_add is deleted, replaced by using common code's completion_list_add_name. To make the latter work for Ada, we needed to add a new output parameter, because Ada wants to return back a custom completion candidates that are not the symbol name. With this patch, minimal symbol demangled name hashing is made consistent with regular symbol hashing. I.e., it now goes via the language vector's search_name_hash method too, as I had suggested in a previous patch. dw2_expand_symtabs_matching / .gdb_index symbol names were a challenge. The problem is that we have no way to telling what is the language of each symbol name found in the index, until we expand the corresponding full symbol, which is off course what we're trying to avoid. Language information is simply not considered in the index format... Since the symbol name hashing and comparison routines are per-language, we now have a problem. The patch sorts this out by matching each name against all languages. This is inneficient, and indeed slows down completion several times. E.g., with: $ cat script.cmd set pagination off set $count = 0 while $count < 400 complete b string_prin printf "count = %d\n", $count set $count = $count + 1 end $ time gdb --batch -q ./gdb-with-index -ex "source script-string_printf.cmd" I get, before patch (-O2, x86-64): real 0m1.773s user 0m1.737s sys 0m0.040s While after patch (-O2, x86-64): real 0m9.843s user 0m9.482s sys 0m0.034s However, the following patch will optimize this, and will actually make this use case faster compared to the "before patch" above: real 0m1.321s user 0m1.285s sys 0m0.039s gdb/ChangeLog: 2017-11-08 Pedro Alves <palves@redhat.com> * ada-lang.c (ada_encode): Rename to .. (ada_encode_1): ... this. Add throw_errors parameter and handle it. (ada_encode): Reimplement. (match_name): Delete, folded into full_name. (resolve_subexp): No longer pass the encoded name to ada_lookup_symbol_list. (should_use_wild_match): Delete. (name_match_type_from_name): New. (ada_lookup_simple_minsym): Use lookup_name_info and the language's symbol_name_matcher_ftype. (add_symbols_from_enclosing_procs, ada_add_local_symbols) (ada_add_block_renamings): Adjust to use lookup_name_info. (ada_lookup_name): New. (add_nonlocal_symbols, ada_add_all_symbols) (ada_lookup_symbol_list_worker, ada_lookup_symbol_list) (ada_iterate_over_symbols): Adjust to use lookup_name_info. (ada_name_for_lookup): Delete. (ada_lookup_encoded_symbol): Construct a verbatim name. (wild_match): Reverse sense of return type. Use bool. (full_match): Reverse sense of return type. Inline bits of old match_name here. (ada_add_block_symbols): Adjust to use lookup_name_info. (symbol_completion_match): Delete, folded into... (ada_lookup_name_info::matches): ... .this new method. (symbol_completion_add): Delete. (ada_collect_symbol_completion_matches): Add name_match_type parameter. Adjust to use lookup_name_info and completion_list_add_name. (get_var_value, ada_add_global_exceptions): Adjust to use lookup_name_info. (ada_get_symbol_name_cmp): Delete. (do_wild_match, do_full_match): New functions. (ada_lookup_name_info::ada_lookup_name_info): New method. (ada_symbol_name_matches, ada_get_symbol_name_matcher): New functions. (ada_language_defn): Install ada_get_symbol_name_matcher. * ada-lex.l (processId): If name starts with '<', copy it verbatim. * block.c (block_iter_match_step, block_iter_match_first) (block_iter_match_next, block_lookup_symbol) (block_lookup_symbol_primary, block_find_symbol): Adjust to use lookup_name_info. * block.h (block_iter_match_first, block_iter_match_next) (ALL_BLOCK_SYMBOLS_WITH_NAME): Adjust to use lookup_name_info. * c-lang.c (c_language_defn, cplus_language_defn) (asm_language_defn, minimal_language_defn): Adjust comments to refer to la_get_symbol_name_matcher. * completer.c (complete_files_symbols) (collect_explicit_location_matches, symbol_completer): Pass a symbol_name_match_type down. * completer.h (class completion_match, completion_match_result): New classes. (completion_tracker::reset_completion_match_result): New method. (completion_tracker::m_completion_match_result): New field. * cp-support.c (make_symbol_overload_list_block): Adjust to use lookup_name_info. (cp_fq_symbol_name_matches, cp_get_symbol_name_matcher): New functions. * cp-support.h (cp_get_symbol_name_matcher): New declaration. * d-lang.c: Adjust comments to refer to la_get_symbol_name_matcher. * dictionary.c (dict_vector) <iter_match_first, iter_match_next>: Adjust to use lookup_name_info. (dict_iter_match_first, dict_iter_match_next) (iter_match_first_hashed, iter_match_next_hashed) (iter_match_first_linear, iter_match_next_linear): Adjust to work with a lookup_name_info. * dictionary.h (dict_iter_match_first, dict_iter_match_next): Likewise. * dwarf2read.c (dw2_lookup_symbol): Adjust to use lookup_name_info. (dw2_map_matching_symbols): Adjust to use symbol_name_match_type. (gdb_index_symbol_name_matcher): New class. (dw2_expand_symtabs_matching) Adjust to use lookup_name_info and gdb_index_symbol_name_matcher. Accept a NULL symbol_matcher. * f-lang.c (f_collect_symbol_completion_matches): Adjust to work with a symbol_name_match_type. (f_language_defn): Adjust comments to refer to la_get_symbol_name_matcher. * go-lang.c (go_language_defn): Adjust comments to refer to la_get_symbol_name_matcher. * language.c (default_symbol_name_matcher) (language_get_symbol_name_matcher): New functions. (unknown_language_defn, auto_language_defn): Adjust comments to refer to la_get_symbol_name_matcher. * language.h (symbol_name_cmp_ftype): Delete. (language_defn) <la_collect_symbol_completion_matches>: Add match type parameter. <la_get_symbol_name_cmp>: Delete field. <la_get_symbol_name_matcher>: New field. <la_iterate_over_symbols>: Adjust to use lookup_name_info. (default_symbol_name_matcher, language_get_symbol_name_matcher): Declare. * linespec.c (iterate_over_all_matching_symtabs) (iterate_over_file_blocks): Adjust to use lookup_name_info. (find_methods): Add language parameter, and use lookup_name_info and the language's symbol_name_matcher_ftype. (linespec_complete_function): Adjust. (lookup_prefix_sym): Use lookup_name_info. (add_all_symbol_names_from_pspace): Adjust. (find_superclass_methods): Add language parameter and pass it down. (find_method): Pass symbol language down. (find_linespec_symbols): Don't demangle or Ada encode here. (search_minsyms_for_name): Add lookup_name_info parameter. (add_matching_symbols_to_info): Add name_match_type parameter. Use lookup_name_info. * m2-lang.c (m2_language_defn): Adjust comments to refer to la_get_symbol_name_matcher. * minsyms.c: Include <algorithm>. (add_minsym_to_demangled_hash_table): Remove table parameter and add objfile parameter. Use search_name_hash, and add language to demangled languages vector. (struct found_minimal_symbols): New struct. (lookup_minimal_symbol_mangled, lookup_minimal_symbol_demangled): New functions. (lookup_minimal_symbol): Adjust to use them. Don't canonicalize input names here. Use lookup_name_info instead. Lookup up demangled names once for each language in the demangled names vector. (iterate_over_minimal_symbols): Use lookup_name_info. Lookup up demangled names once for each language in the demangled names vector. (build_minimal_symbol_hash_tables): Adjust. * minsyms.h (iterate_over_minimal_symbols): Adjust to pass down a lookup_name_info. * objc-lang.c (objc_language_defn): Adjust comment to refer to la_get_symbol_name_matcher. * objfiles.h: Include <vector>. (objfile_per_bfd_storage) <demangled_hash_languages>: New field. * opencl-lang.c (opencl_language_defn): Adjust comment to refer to la_get_symbol_name_matcher. * p-lang.c (pascal_language_defn): Adjust comment to refer to la_get_symbol_name_matcher. * psymtab.c (psym_lookup_symbol): Use lookup_name_info. (match_partial_symbol): Use symbol_name_match_type, lookup_name_info and psymbol_name_matches. (lookup_partial_symbol): Use lookup_name_info. (map_block): Use symbol_name_match_type and lookup_name_info. (psym_map_matching_symbols): Use symbol_name_match_type. (psymbol_name_matches): New. (recursively_search_psymtabs): Use lookup_name_info and psymbol_name_matches. Rename 'kind' parameter to 'domain'. (psym_expand_symtabs_matching): Use lookup_name_info. Rename 'kind' parameter to 'domain'. * rust-lang.c (rust_language_defn): Adjust comment to refer to la_get_symbol_name_matcher. * symfile-debug.c (debug_qf_map_matching_symbols) (debug_qf_map_matching_symbols): Use symbol_name_match_type. (debug_qf_expand_symtabs_matching): Use lookup_name_info. * symfile.c (expand_symtabs_matching): Use lookup_name_info. * symfile.h (quick_symbol_functions) <map_matching_symbols>: Adjust to use symbol_name_match_type. <expand_symtabs_matching>: Adjust to use lookup_name_info. (expand_symtabs_matching): Adjust to use lookup_name_info. * symmisc.c (maintenance_expand_symtabs): Use lookup_name_info::match_any (). * symtab.c (symbol_matches_search_name): New. (eq_symbol_entry): Adjust to use lookup_name_info and the language's matcher. (demangle_for_lookup_info::demangle_for_lookup_info): New. (lookup_name_info::match_any): New. (iterate_over_symbols, search_symbols): Use lookup_name_info. (compare_symbol_name): Add language, lookup_name_info and completion_match_result parameters, and use them. (completion_list_add_name): Make extern. Add language and lookup_name_info parameters. Use them. (completion_list_add_symbol, completion_list_add_msymbol) (completion_list_objc_symbol): Add lookup_name_info parameters and adjust. Pass down language. (completion_list_add_fields): Add lookup_name_info parameters and adjust. Pass down language. (add_symtab_completions): Add lookup_name_info parameters and adjust. (default_collect_symbol_completion_matches_break_on): Add name_match_type parameter, and use it. Use lookup_name_info. (default_collect_symbol_completion_matches) (collect_symbol_completion_matches): Add name_match_type parameter, and pass it down. (collect_symbol_completion_matches_type): Adjust. (collect_file_symbol_completion_matches): Add name_match_type parameter, and use lookup_name_info. * symtab.h: Include <string> and "common/gdb_optional.h". (enum class symbol_name_match_type): New. (class ada_lookup_name_info): New. (struct demangle_for_lookup_info): New. (class lookup_name_info): New. (symbol_name_matcher_ftype): New. (SYMBOL_MATCHES_SEARCH_NAME): Use symbol_matches_search_name. (symbol_matches_search_name): Declare. (MSYMBOL_MATCHES_SEARCH_NAME): Delete. (default_collect_symbol_completion_matches) (collect_symbol_completion_matches) (collect_file_symbol_completion_matches): Add name_match_type parameter. (iterate_over_symbols): Use lookup_name_info. (completion_list_add_name): Declare. * utils.c (enum class strncmp_iw_mode): Moved to utils.h. (strncmp_iw_with_mode): Now extern. * utils.h (enum class strncmp_iw_mode): Moved from utils.c. (strncmp_iw_with_mode): Declare. gdb/testsuite/ChangeLog: 2017-11-08 Pedro Alves <palves@redhat.com> * gdb.ada/complete.exp (p <Exported_Capitalized>): New test. (p Exported_Capitalized): New test. (p exported_capitalized): New test.
734 lines
27 KiB
C++
734 lines
27 KiB
C++
/* Definitions for symbol file management in GDB.
|
||
|
||
Copyright (C) 1992-2017 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 (OBJFILES_H)
|
||
#define OBJFILES_H
|
||
|
||
#include "hashtab.h"
|
||
#include "gdb_obstack.h" /* For obstack internals. */
|
||
#include "objfile-flags.h"
|
||
#include "symfile.h"
|
||
#include "progspace.h"
|
||
#include "registry.h"
|
||
#include "gdb_bfd.h"
|
||
#include <vector>
|
||
|
||
struct bcache;
|
||
struct htab;
|
||
struct objfile_data;
|
||
struct partial_symbol;
|
||
|
||
/* This structure maintains information on a per-objfile basis about the
|
||
"entry point" of the objfile, and the scope within which the entry point
|
||
exists. It is possible that gdb will see more than one objfile that is
|
||
executable, each with its own entry point.
|
||
|
||
For example, for dynamically linked executables in SVR4, the dynamic linker
|
||
code is contained within the shared C library, which is actually executable
|
||
and is run by the kernel first when an exec is done of a user executable
|
||
that is dynamically linked. The dynamic linker within the shared C library
|
||
then maps in the various program segments in the user executable and jumps
|
||
to the user executable's recorded entry point, as if the call had been made
|
||
directly by the kernel.
|
||
|
||
The traditional gdb method of using this info was to use the
|
||
recorded entry point to set the entry-file's lowpc and highpc from
|
||
the debugging information, where these values are the starting
|
||
address (inclusive) and ending address (exclusive) of the
|
||
instruction space in the executable which correspond to the
|
||
"startup file", i.e. crt0.o in most cases. This file is assumed to
|
||
be a startup file and frames with pc's inside it are treated as
|
||
nonexistent. Setting these variables is necessary so that
|
||
backtraces do not fly off the bottom of the stack.
|
||
|
||
NOTE: cagney/2003-09-09: It turns out that this "traditional"
|
||
method doesn't work. Corinna writes: ``It turns out that the call
|
||
to test for "inside entry file" destroys a meaningful backtrace
|
||
under some conditions. E.g. the backtrace tests in the asm-source
|
||
testcase are broken for some targets. In this test the functions
|
||
are all implemented as part of one file and the testcase is not
|
||
necessarily linked with a start file (depending on the target).
|
||
What happens is, that the first frame is printed normaly and
|
||
following frames are treated as being inside the enttry file then.
|
||
This way, only the #0 frame is printed in the backtrace output.''
|
||
Ref "frame.c" "NOTE: vinschen/2003-04-01".
|
||
|
||
Gdb also supports an alternate method to avoid running off the bottom
|
||
of the stack.
|
||
|
||
There are two frames that are "special", the frame for the function
|
||
containing the process entry point, since it has no predecessor frame,
|
||
and the frame for the function containing the user code entry point
|
||
(the main() function), since all the predecessor frames are for the
|
||
process startup code. Since we have no guarantee that the linked
|
||
in startup modules have any debugging information that gdb can use,
|
||
we need to avoid following frame pointers back into frames that might
|
||
have been built in the startup code, as we might get hopelessly
|
||
confused. However, we almost always have debugging information
|
||
available for main().
|
||
|
||
These variables are used to save the range of PC values which are
|
||
valid within the main() function and within the function containing
|
||
the process entry point. If we always consider the frame for
|
||
main() as the outermost frame when debugging user code, and the
|
||
frame for the process entry point function as the outermost frame
|
||
when debugging startup code, then all we have to do is have
|
||
DEPRECATED_FRAME_CHAIN_VALID return false whenever a frame's
|
||
current PC is within the range specified by these variables. In
|
||
essence, we set "ceilings" in the frame chain beyond which we will
|
||
not proceed when following the frame chain back up the stack.
|
||
|
||
A nice side effect is that we can still debug startup code without
|
||
running off the end of the frame chain, assuming that we have usable
|
||
debugging information in the startup modules, and if we choose to not
|
||
use the block at main, or can't find it for some reason, everything
|
||
still works as before. And if we have no startup code debugging
|
||
information but we do have usable information for main(), backtraces
|
||
from user code don't go wandering off into the startup code. */
|
||
|
||
struct entry_info
|
||
{
|
||
/* The unrelocated value we should use for this objfile entry point. */
|
||
CORE_ADDR entry_point;
|
||
|
||
/* The index of the section in which the entry point appears. */
|
||
int the_bfd_section_index;
|
||
|
||
/* Set to 1 iff ENTRY_POINT contains a valid value. */
|
||
unsigned entry_point_p : 1;
|
||
|
||
/* Set to 1 iff this object was initialized. */
|
||
unsigned initialized : 1;
|
||
};
|
||
|
||
/* Sections in an objfile. The section offsets are stored in the
|
||
OBJFILE. */
|
||
|
||
struct obj_section
|
||
{
|
||
/* BFD section pointer */
|
||
struct bfd_section *the_bfd_section;
|
||
|
||
/* Objfile this section is part of. */
|
||
struct objfile *objfile;
|
||
|
||
/* True if this "overlay section" is mapped into an "overlay region". */
|
||
int ovly_mapped;
|
||
};
|
||
|
||
/* Relocation offset applied to S. */
|
||
#define obj_section_offset(s) \
|
||
(((s)->objfile->section_offsets)->offsets[gdb_bfd_section_index ((s)->objfile->obfd, (s)->the_bfd_section)])
|
||
|
||
/* The memory address of section S (vma + offset). */
|
||
#define obj_section_addr(s) \
|
||
(bfd_get_section_vma ((s)->objfile->obfd, s->the_bfd_section) \
|
||
+ obj_section_offset (s))
|
||
|
||
/* The one-passed-the-end memory address of section S
|
||
(vma + size + offset). */
|
||
#define obj_section_endaddr(s) \
|
||
(bfd_get_section_vma ((s)->objfile->obfd, s->the_bfd_section) \
|
||
+ bfd_get_section_size ((s)->the_bfd_section) \
|
||
+ obj_section_offset (s))
|
||
|
||
/* The "objstats" structure provides a place for gdb to record some
|
||
interesting information about its internal state at runtime, on a
|
||
per objfile basis, such as information about the number of symbols
|
||
read, size of string table (if any), etc. */
|
||
|
||
struct objstats
|
||
{
|
||
/* Number of partial symbols read. */
|
||
int n_psyms = 0;
|
||
|
||
/* Number of full symbols read. */
|
||
int n_syms = 0;
|
||
|
||
/* Number of ".stabs" read (if applicable). */
|
||
int n_stabs = 0;
|
||
|
||
/* Number of types. */
|
||
int n_types = 0;
|
||
|
||
/* Size of stringtable, (if applicable). */
|
||
int sz_strtab = 0;
|
||
};
|
||
|
||
#define OBJSTAT(objfile, expr) (objfile -> stats.expr)
|
||
#define OBJSTATS struct objstats stats
|
||
extern void print_objfile_statistics (void);
|
||
extern void print_symbol_bcache_statistics (void);
|
||
|
||
/* Number of entries in the minimal symbol hash table. */
|
||
#define MINIMAL_SYMBOL_HASH_SIZE 2039
|
||
|
||
/* Some objfile data is hung off the BFD. This enables sharing of the
|
||
data across all objfiles using the BFD. The data is stored in an
|
||
instance of this structure, and associated with the BFD using the
|
||
registry system. */
|
||
|
||
struct objfile_per_bfd_storage
|
||
{
|
||
objfile_per_bfd_storage ()
|
||
: minsyms_read (false)
|
||
{}
|
||
|
||
/* The storage has an obstack of its own. */
|
||
|
||
auto_obstack storage_obstack;
|
||
|
||
/* Byte cache for file names. */
|
||
|
||
bcache *filename_cache = NULL;
|
||
|
||
/* Byte cache for macros. */
|
||
|
||
bcache *macro_cache = NULL;
|
||
|
||
/* The gdbarch associated with the BFD. Note that this gdbarch is
|
||
determined solely from BFD information, without looking at target
|
||
information. The gdbarch determined from a running target may
|
||
differ from this e.g. with respect to register types and names. */
|
||
|
||
struct gdbarch *gdbarch = NULL;
|
||
|
||
/* Hash table for mapping symbol names to demangled names. Each
|
||
entry in the hash table is actually two consecutive strings,
|
||
both null-terminated; the first one is a mangled or linkage
|
||
name, and the second is the demangled name or just a zero byte
|
||
if the name doesn't demangle. */
|
||
|
||
htab *demangled_names_hash = NULL;
|
||
|
||
/* The per-objfile information about the entry point, the scope (file/func)
|
||
containing the entry point, and the scope of the user's main() func. */
|
||
|
||
entry_info ei {};
|
||
|
||
/* The name and language of any "main" found in this objfile. The
|
||
name can be NULL, which means that the information was not
|
||
recorded. */
|
||
|
||
const char *name_of_main = NULL;
|
||
enum language language_of_main = language_unknown;
|
||
|
||
/* Each file contains a pointer to an array of minimal symbols for all
|
||
global symbols that are defined within the file. The array is
|
||
terminated by a "null symbol", one that has a NULL pointer for the
|
||
name and a zero value for the address. This makes it easy to walk
|
||
through the array when passed a pointer to somewhere in the middle
|
||
of it. There is also a count of the number of symbols, which does
|
||
not include the terminating null symbol. The array itself, as well
|
||
as all the data that it points to, should be allocated on the
|
||
objfile_obstack for this file. */
|
||
|
||
minimal_symbol *msymbols = NULL;
|
||
int minimal_symbol_count = 0;
|
||
|
||
/* The number of minimal symbols read, before any minimal symbol
|
||
de-duplication is applied. Note in particular that this has only
|
||
a passing relationship with the actual size of the table above;
|
||
use minimal_symbol_count if you need the true size. */
|
||
|
||
int n_minsyms = 0;
|
||
|
||
/* This is true if minimal symbols have already been read. Symbol
|
||
readers can use this to bypass minimal symbol reading. Also, the
|
||
minimal symbol table management code in minsyms.c uses this to
|
||
suppress new minimal symbols. You might think that MSYMBOLS or
|
||
MINIMAL_SYMBOL_COUNT could be used for this, but it is possible
|
||
for multiple readers to install minimal symbols into a given
|
||
per-BFD. */
|
||
|
||
bool minsyms_read : 1;
|
||
|
||
/* This is a hash table used to index the minimal symbols by name. */
|
||
|
||
minimal_symbol *msymbol_hash[MINIMAL_SYMBOL_HASH_SIZE] {};
|
||
|
||
/* This hash table is used to index the minimal symbols by their
|
||
demangled names. */
|
||
|
||
minimal_symbol *msymbol_demangled_hash[MINIMAL_SYMBOL_HASH_SIZE] {};
|
||
|
||
/* All the different languages of symbols found in the demangled
|
||
hash table. A flat/vector-based map is more efficient than a map
|
||
or hash table here, since this will only usually contain zero or
|
||
one entries. */
|
||
std::vector<enum language> demangled_hash_languages;
|
||
};
|
||
|
||
/* Master structure for keeping track of each file from which
|
||
gdb reads symbols. There are several ways these get allocated: 1.
|
||
The main symbol file, symfile_objfile, set by the symbol-file command,
|
||
2. Additional symbol files added by the add-symbol-file command,
|
||
3. Shared library objfiles, added by ADD_SOLIB, 4. symbol files
|
||
for modules that were loaded when GDB attached to a remote system
|
||
(see remote-vx.c). */
|
||
|
||
struct objfile
|
||
{
|
||
objfile (bfd *, const char *, objfile_flags);
|
||
~objfile ();
|
||
|
||
DISABLE_COPY_AND_ASSIGN (objfile);
|
||
|
||
/* All struct objfile's are chained together by their next pointers.
|
||
The program space field "objfiles" (frequently referenced via
|
||
the macro "object_files") points to the first link in this chain. */
|
||
|
||
struct objfile *next = nullptr;
|
||
|
||
/* The object file's original name as specified by the user,
|
||
made absolute, and tilde-expanded. However, it is not canonicalized
|
||
(i.e., it has not been passed through gdb_realpath).
|
||
This pointer is never NULL. This does not have to be freed; it is
|
||
guaranteed to have a lifetime at least as long as the objfile. */
|
||
|
||
char *original_name = nullptr;
|
||
|
||
CORE_ADDR addr_low = 0;
|
||
|
||
/* Some flag bits for this objfile. */
|
||
|
||
objfile_flags flags;
|
||
|
||
/* The program space associated with this objfile. */
|
||
|
||
struct program_space *pspace;
|
||
|
||
/* List of compunits.
|
||
These are used to do symbol lookups and file/line-number lookups. */
|
||
|
||
struct compunit_symtab *compunit_symtabs = nullptr;
|
||
|
||
/* Each objfile points to a linked list of partial symtabs derived from
|
||
this file, one partial symtab structure for each compilation unit
|
||
(source file). */
|
||
|
||
struct partial_symtab *psymtabs = nullptr;
|
||
|
||
/* Map addresses to the entries of PSYMTABS. It would be more efficient to
|
||
have a map per the whole process but ADDRMAP cannot selectively remove
|
||
its items during FREE_OBJFILE. This mapping is already present even for
|
||
PARTIAL_SYMTABs which still have no corresponding full SYMTABs read. */
|
||
|
||
struct addrmap *psymtabs_addrmap = nullptr;
|
||
|
||
/* List of freed partial symtabs, available for re-use. */
|
||
|
||
struct partial_symtab *free_psymtabs = nullptr;
|
||
|
||
/* The object file's BFD. Can be null if the objfile contains only
|
||
minimal symbols, e.g. the run time common symbols for SunOS4. */
|
||
|
||
bfd *obfd;
|
||
|
||
/* The per-BFD data. Note that this is treated specially if OBFD
|
||
is NULL. */
|
||
|
||
struct objfile_per_bfd_storage *per_bfd = nullptr;
|
||
|
||
/* The modification timestamp of the object file, as of the last time
|
||
we read its symbols. */
|
||
|
||
long mtime = 0;
|
||
|
||
/* Obstack to hold objects that should be freed when we load a new symbol
|
||
table from this object file. */
|
||
|
||
struct obstack objfile_obstack {};
|
||
|
||
/* A byte cache where we can stash arbitrary "chunks" of bytes that
|
||
will not change. */
|
||
|
||
struct psymbol_bcache *psymbol_cache;
|
||
|
||
/* Vectors of all partial symbols read in from file. The actual data
|
||
is stored in the objfile_obstack. */
|
||
|
||
std::vector<partial_symbol *> global_psymbols;
|
||
std::vector<partial_symbol *> static_psymbols;
|
||
|
||
/* Structure which keeps track of functions that manipulate objfile's
|
||
of the same type as this objfile. I.e. the function to read partial
|
||
symbols for example. Note that this structure is in statically
|
||
allocated memory, and is shared by all objfiles that use the
|
||
object module reader of this type. */
|
||
|
||
const struct sym_fns *sf = nullptr;
|
||
|
||
/* Per objfile data-pointers required by other GDB modules. */
|
||
|
||
REGISTRY_FIELDS {};
|
||
|
||
/* Set of relocation offsets to apply to each section.
|
||
The table is indexed by the_bfd_section->index, thus it is generally
|
||
as large as the number of sections in the binary.
|
||
The table is stored on the objfile_obstack.
|
||
|
||
These offsets indicate that all symbols (including partial and
|
||
minimal symbols) which have been read have been relocated by this
|
||
much. Symbols which are yet to be read need to be relocated by it. */
|
||
|
||
struct section_offsets *section_offsets = nullptr;
|
||
int num_sections = 0;
|
||
|
||
/* Indexes in the section_offsets array. These are initialized by the
|
||
*_symfile_offsets() family of functions (som_symfile_offsets,
|
||
xcoff_symfile_offsets, default_symfile_offsets). In theory they
|
||
should correspond to the section indexes used by bfd for the
|
||
current objfile. The exception to this for the time being is the
|
||
SOM version.
|
||
|
||
These are initialized to -1 so that we can later detect if they
|
||
are used w/o being properly assigned to. */
|
||
|
||
int sect_index_text = -1;
|
||
int sect_index_data = -1;
|
||
int sect_index_bss = -1;
|
||
int sect_index_rodata = -1;
|
||
|
||
/* These pointers are used to locate the section table, which
|
||
among other things, is used to map pc addresses into sections.
|
||
SECTIONS points to the first entry in the table, and
|
||
SECTIONS_END points to the first location past the last entry
|
||
in the table. The table is stored on the objfile_obstack. The
|
||
sections are indexed by the BFD section index; but the
|
||
structure data is only valid for certain sections
|
||
(e.g. non-empty, SEC_ALLOC). */
|
||
|
||
struct obj_section *sections = nullptr;
|
||
struct obj_section *sections_end = nullptr;
|
||
|
||
/* GDB allows to have debug symbols in separate object files. This is
|
||
used by .gnu_debuglink, ELF build id note and Mach-O OSO.
|
||
Although this is a tree structure, GDB only support one level
|
||
(ie a separate debug for a separate debug is not supported). Note that
|
||
separate debug object are in the main chain and therefore will be
|
||
visited by ALL_OBJFILES & co iterators. Separate debug objfile always
|
||
has a non-nul separate_debug_objfile_backlink. */
|
||
|
||
/* Link to the first separate debug object, if any. */
|
||
|
||
struct objfile *separate_debug_objfile = nullptr;
|
||
|
||
/* If this is a separate debug object, this is used as a link to the
|
||
actual executable objfile. */
|
||
|
||
struct objfile *separate_debug_objfile_backlink = nullptr;
|
||
|
||
/* If this is a separate debug object, this is a link to the next one
|
||
for the same executable objfile. */
|
||
|
||
struct objfile *separate_debug_objfile_link = nullptr;
|
||
|
||
/* Place to stash various statistics about this objfile. */
|
||
|
||
OBJSTATS;
|
||
|
||
/* A linked list of symbols created when reading template types or
|
||
function templates. These symbols are not stored in any symbol
|
||
table, so we have to keep them here to relocate them
|
||
properly. */
|
||
|
||
struct symbol *template_symbols = nullptr;
|
||
|
||
/* Associate a static link (struct dynamic_prop *) to all blocks (struct
|
||
block *) that have one.
|
||
|
||
In the context of nested functions (available in Pascal, Ada and GNU C,
|
||
for instance), a static link (as in DWARF's DW_AT_static_link attribute)
|
||
for a function is a way to get the frame corresponding to the enclosing
|
||
function.
|
||
|
||
Very few blocks have a static link, so it's more memory efficient to
|
||
store these here rather than in struct block. Static links must be
|
||
allocated on the objfile's obstack. */
|
||
htab_t static_links {};
|
||
};
|
||
|
||
/* Declarations for functions defined in objfiles.c */
|
||
|
||
extern struct gdbarch *get_objfile_arch (const struct objfile *);
|
||
|
||
extern int entry_point_address_query (CORE_ADDR *entry_p);
|
||
|
||
extern CORE_ADDR entry_point_address (void);
|
||
|
||
extern void build_objfile_section_table (struct objfile *);
|
||
|
||
extern struct objfile *objfile_separate_debug_iterate (const struct objfile *,
|
||
const struct objfile *);
|
||
|
||
extern void put_objfile_before (struct objfile *, struct objfile *);
|
||
|
||
extern void add_separate_debug_objfile (struct objfile *, struct objfile *);
|
||
|
||
extern void unlink_objfile (struct objfile *);
|
||
|
||
extern void free_objfile_separate_debug (struct objfile *);
|
||
|
||
extern void free_all_objfiles (void);
|
||
|
||
extern void objfile_relocate (struct objfile *, const struct section_offsets *);
|
||
extern void objfile_rebase (struct objfile *, CORE_ADDR);
|
||
|
||
extern int objfile_has_partial_symbols (struct objfile *objfile);
|
||
|
||
extern int objfile_has_full_symbols (struct objfile *objfile);
|
||
|
||
extern int objfile_has_symbols (struct objfile *objfile);
|
||
|
||
extern int have_partial_symbols (void);
|
||
|
||
extern int have_full_symbols (void);
|
||
|
||
extern void objfile_set_sym_fns (struct objfile *objfile,
|
||
const struct sym_fns *sf);
|
||
|
||
extern void objfiles_changed (void);
|
||
|
||
extern int is_addr_in_objfile (CORE_ADDR addr, const struct objfile *objfile);
|
||
|
||
/* Return true if ADDRESS maps into one of the sections of a
|
||
OBJF_SHARED objfile of PSPACE and false otherwise. */
|
||
|
||
extern int shared_objfile_contains_address_p (struct program_space *pspace,
|
||
CORE_ADDR address);
|
||
|
||
/* This operation deletes all objfile entries that represent solibs that
|
||
weren't explicitly loaded by the user, via e.g., the add-symbol-file
|
||
command. */
|
||
|
||
extern void objfile_purge_solibs (void);
|
||
|
||
/* Functions for dealing with the minimal symbol table, really a misc
|
||
address<->symbol mapping for things we don't have debug symbols for. */
|
||
|
||
extern int have_minimal_symbols (void);
|
||
|
||
extern struct obj_section *find_pc_section (CORE_ADDR pc);
|
||
|
||
/* Return non-zero if PC is in a section called NAME. */
|
||
extern int pc_in_section (CORE_ADDR, const char *);
|
||
|
||
/* Return non-zero if PC is in a SVR4-style procedure linkage table
|
||
section. */
|
||
|
||
static inline int
|
||
in_plt_section (CORE_ADDR pc)
|
||
{
|
||
return pc_in_section (pc, ".plt");
|
||
}
|
||
|
||
/* Keep a registry of per-objfile data-pointers required by other GDB
|
||
modules. */
|
||
DECLARE_REGISTRY(objfile);
|
||
|
||
/* In normal use, the section map will be rebuilt by find_pc_section
|
||
if objfiles have been added, removed or relocated since it was last
|
||
called. Calling inhibit_section_map_updates will inhibit this
|
||
behavior until resume_section_map_updates is called. If you call
|
||
inhibit_section_map_updates you must ensure that every call to
|
||
find_pc_section in the inhibited region relates to a section that
|
||
is already in the section map and has not since been removed or
|
||
relocated. */
|
||
extern void inhibit_section_map_updates (struct program_space *pspace);
|
||
|
||
/* Resume automatically rebuilding the section map as required. */
|
||
extern void resume_section_map_updates (struct program_space *pspace);
|
||
|
||
/* Version of the above suitable for use as a cleanup. */
|
||
extern void resume_section_map_updates_cleanup (void *arg);
|
||
|
||
extern void default_iterate_over_objfiles_in_search_order
|
||
(struct gdbarch *gdbarch,
|
||
iterate_over_objfiles_in_search_order_cb_ftype *cb,
|
||
void *cb_data, struct objfile *current_objfile);
|
||
|
||
|
||
/* Traverse all object files in the current program space.
|
||
ALL_OBJFILES_SAFE works even if you delete the objfile during the
|
||
traversal. */
|
||
|
||
/* Traverse all object files in program space SS. */
|
||
|
||
#define ALL_PSPACE_OBJFILES(ss, obj) \
|
||
for ((obj) = ss->objfiles; (obj) != NULL; (obj) = (obj)->next)
|
||
|
||
#define ALL_OBJFILES(obj) \
|
||
for ((obj) = current_program_space->objfiles; \
|
||
(obj) != NULL; \
|
||
(obj) = (obj)->next)
|
||
|
||
#define ALL_OBJFILES_SAFE(obj,nxt) \
|
||
for ((obj) = current_program_space->objfiles; \
|
||
(obj) != NULL? ((nxt)=(obj)->next,1) :0; \
|
||
(obj) = (nxt))
|
||
|
||
/* Traverse all symtabs in one objfile. */
|
||
|
||
#define ALL_OBJFILE_FILETABS(objfile, cu, s) \
|
||
ALL_OBJFILE_COMPUNITS (objfile, cu) \
|
||
ALL_COMPUNIT_FILETABS (cu, s)
|
||
|
||
/* Traverse all compunits in one objfile. */
|
||
|
||
#define ALL_OBJFILE_COMPUNITS(objfile, cu) \
|
||
for ((cu) = (objfile) -> compunit_symtabs; (cu) != NULL; (cu) = (cu) -> next)
|
||
|
||
/* Traverse all minimal symbols in one objfile. */
|
||
|
||
#define ALL_OBJFILE_MSYMBOLS(objfile, m) \
|
||
for ((m) = (objfile)->per_bfd->msymbols; \
|
||
MSYMBOL_LINKAGE_NAME (m) != NULL; \
|
||
(m)++)
|
||
|
||
/* Traverse all symtabs in all objfiles in the current symbol
|
||
space. */
|
||
|
||
#define ALL_FILETABS(objfile, ps, s) \
|
||
ALL_OBJFILES (objfile) \
|
||
ALL_OBJFILE_FILETABS (objfile, ps, s)
|
||
|
||
/* Traverse all compunits in all objfiles in the current program space. */
|
||
|
||
#define ALL_COMPUNITS(objfile, cu) \
|
||
ALL_OBJFILES (objfile) \
|
||
ALL_OBJFILE_COMPUNITS (objfile, cu)
|
||
|
||
/* Traverse all minimal symbols in all objfiles in the current symbol
|
||
space. */
|
||
|
||
#define ALL_MSYMBOLS(objfile, m) \
|
||
ALL_OBJFILES (objfile) \
|
||
ALL_OBJFILE_MSYMBOLS (objfile, m)
|
||
|
||
#define ALL_OBJFILE_OSECTIONS(objfile, osect) \
|
||
for (osect = objfile->sections; osect < objfile->sections_end; osect++) \
|
||
if (osect->the_bfd_section == NULL) \
|
||
{ \
|
||
/* Nothing. */ \
|
||
} \
|
||
else
|
||
|
||
/* Traverse all obj_sections in all objfiles in the current program
|
||
space.
|
||
|
||
Note that this detects a "break" in the inner loop, and exits
|
||
immediately from the outer loop as well, thus, client code doesn't
|
||
need to know that this is implemented with a double for. The extra
|
||
hair is to make sure that a "break;" stops the outer loop iterating
|
||
as well, and both OBJFILE and OSECT are left unmodified:
|
||
|
||
- The outer loop learns about the inner loop's end condition, and
|
||
stops iterating if it detects the inner loop didn't reach its
|
||
end. In other words, the outer loop keeps going only if the
|
||
inner loop reached its end cleanly [(osect) ==
|
||
(objfile)->sections_end].
|
||
|
||
- OSECT is initialized in the outer loop initialization
|
||
expressions, such as if the inner loop has reached its end, so
|
||
the check mentioned above succeeds the first time.
|
||
|
||
- The trick to not clearing OBJFILE on a "break;" is, in the outer
|
||
loop's loop expression, advance OBJFILE, but iff the inner loop
|
||
reached its end. If not, there was a "break;", so leave OBJFILE
|
||
as is; the outer loop's conditional will break immediately as
|
||
well (as OSECT will be different from OBJFILE->sections_end). */
|
||
|
||
#define ALL_OBJSECTIONS(objfile, osect) \
|
||
for ((objfile) = current_program_space->objfiles, \
|
||
(objfile) != NULL ? ((osect) = (objfile)->sections_end) : 0; \
|
||
(objfile) != NULL \
|
||
&& (osect) == (objfile)->sections_end; \
|
||
((osect) == (objfile)->sections_end \
|
||
? ((objfile) = (objfile)->next, \
|
||
(objfile) != NULL ? (osect) = (objfile)->sections_end : 0) \
|
||
: 0)) \
|
||
ALL_OBJFILE_OSECTIONS (objfile, osect)
|
||
|
||
#define SECT_OFF_DATA(objfile) \
|
||
((objfile->sect_index_data == -1) \
|
||
? (internal_error (__FILE__, __LINE__, \
|
||
_("sect_index_data not initialized")), -1) \
|
||
: objfile->sect_index_data)
|
||
|
||
#define SECT_OFF_RODATA(objfile) \
|
||
((objfile->sect_index_rodata == -1) \
|
||
? (internal_error (__FILE__, __LINE__, \
|
||
_("sect_index_rodata not initialized")), -1) \
|
||
: objfile->sect_index_rodata)
|
||
|
||
#define SECT_OFF_TEXT(objfile) \
|
||
((objfile->sect_index_text == -1) \
|
||
? (internal_error (__FILE__, __LINE__, \
|
||
_("sect_index_text not initialized")), -1) \
|
||
: objfile->sect_index_text)
|
||
|
||
/* Sometimes the .bss section is missing from the objfile, so we don't
|
||
want to die here. Let the users of SECT_OFF_BSS deal with an
|
||
uninitialized section index. */
|
||
#define SECT_OFF_BSS(objfile) (objfile)->sect_index_bss
|
||
|
||
/* Answer whether there is more than one object file loaded. */
|
||
|
||
#define MULTI_OBJFILE_P() (object_files && object_files->next)
|
||
|
||
/* Reset the per-BFD storage area on OBJ. */
|
||
|
||
void set_objfile_per_bfd (struct objfile *obj);
|
||
|
||
/* Return canonical name for OBJFILE.
|
||
This is the real file name if the file has been opened.
|
||
Otherwise it is the original name supplied by the user. */
|
||
|
||
const char *objfile_name (const struct objfile *objfile);
|
||
|
||
/* Return the (real) file name of OBJFILE if the file has been opened,
|
||
otherwise return NULL. */
|
||
|
||
const char *objfile_filename (const struct objfile *objfile);
|
||
|
||
/* Return the name to print for OBJFILE in debugging messages. */
|
||
|
||
extern const char *objfile_debug_name (const struct objfile *objfile);
|
||
|
||
/* Return the name of the file format of OBJFILE if the file has been opened,
|
||
otherwise return NULL. */
|
||
|
||
const char *objfile_flavour_name (struct objfile *objfile);
|
||
|
||
/* Set the objfile's notion of the "main" name and language. */
|
||
|
||
extern void set_objfile_main_name (struct objfile *objfile,
|
||
const char *name, enum language lang);
|
||
|
||
extern void objfile_register_static_link
|
||
(struct objfile *objfile,
|
||
const struct block *block,
|
||
const struct dynamic_prop *static_link);
|
||
|
||
extern const struct dynamic_prop *objfile_lookup_static_link
|
||
(struct objfile *objfile, const struct block *block);
|
||
|
||
#endif /* !defined (OBJFILES_H) */
|