/* Definitions for symbol file management in GDB.
- Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001,
- 2002, 2003, 2004, 2007, 2008, 2009 Free Software Foundation, Inc.
+ Copyright (C) 1992-2020 Free Software Foundation, Inc.
This file is part of GDB.
#if !defined (OBJFILES_H)
#define OBJFILES_H
+#include "hashtab.h"
#include "gdb_obstack.h" /* For obstack internals. */
-#include "symfile.h" /* For struct psymbol_allocation_list */
+#include "objfile-flags.h"
+#include "symfile.h"
+#include "progspace.h"
+#include "registry.h"
+#include "gdb_bfd.h"
+#include "psymtab.h"
+#include <atomic>
+#include <bitset>
+#include <vector>
+#include "gdbsupport/next-iterator.h"
+#include "gdbsupport/safe-iterator.h"
+#include "bcache.h"
+#include "gdbarch.h"
+#include "gdbsupport/refcounted-object.h"
-struct bcache;
struct htab;
-struct symtab;
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
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
+ "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
+ 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.
+ What happens is, that the first frame is printed normally and
+ following frames are treated as being inside the entry file then.
This way, only the #0 frame is printed in the backtrace output.''
Ref "frame.c" "NOTE: vinschen/2003-04-01".
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
+ have been built in the startup code, as we might get hopelessly
confused. However, we almost always have debugging information
available for main().
from user code don't go wandering off into the startup code. */
struct entry_info
- {
-
- /* The value we should use for this objects entry point.
- The illegal/unknown value needs to be something other than 0, ~0
- for instance, which is much less likely than 0. */
+{
+ /* The unrelocated value we should use for this objfile entry point. */
+ CORE_ADDR entry_point;
- CORE_ADDR entry_point;
+ /* The index of the section in which the entry point appears. */
+ int the_bfd_section_index;
-#define INVALID_ENTRY_POINT (~0) /* ~0 will not be in any file, we hope. */
+ /* 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
- {
- struct bfd_section *the_bfd_section; /* BFD section pointer */
+{
+ /* BFD section pointer */
+ struct bfd_section *the_bfd_section;
- /* Objfile this section is part of. */
- struct objfile *objfile;
+ /* Objfile this section is part of. */
+ struct objfile *objfile;
- /* True if this "overlay section" is mapped into an "overlay region". */
- int ovly_mapped;
- };
+ /* 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[(s)->the_bfd_section->index])
+ (((s)->objfile->section_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->abfd, s->the_bfd_section) \
+ (bfd_section_vma (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->abfd, s->the_bfd_section) \
- + bfd_get_section_size ((s)->the_bfd_section) \
+ (bfd_section_vma (s->the_bfd_section) \
+ + bfd_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. */
+ read, size of string table (if any), etc. */
struct objstats
- {
- int n_minsyms; /* Number of minimal symbols read */
- int n_psyms; /* Number of partial symbols read */
- int n_syms; /* Number of full symbols read */
- int n_stabs; /* Number of ".stabs" read (if applicable) */
- int n_types; /* Number of types */
- int sz_strtab; /* Size of stringtable, (if applicable) */
- };
+{
+ /* 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
/* Number of entries in the minimal symbol hash table. */
#define MINIMAL_SYMBOL_HASH_SIZE 2039
-/* 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). */
+/* An iterator for minimal symbols. */
-struct objfile
+struct minimal_symbol_iterator
+{
+ typedef minimal_symbol_iterator self_type;
+ typedef struct minimal_symbol *value_type;
+ typedef struct minimal_symbol *&reference;
+ typedef struct minimal_symbol **pointer;
+ typedef std::forward_iterator_tag iterator_category;
+ typedef int difference_type;
+
+ explicit minimal_symbol_iterator (struct minimal_symbol *msym)
+ : m_msym (msym)
{
+ }
- /* All struct objfile's are chained together by their next pointers.
- The global variable "object_files" points to the first link in this
- chain.
+ value_type operator* () const
+ {
+ return m_msym;
+ }
- FIXME: There is a problem here if the objfile is reusable, and if
- multiple users are to be supported. The problem is that the objfile
- list is linked through a member of the objfile struct itself, which
- is only valid for one gdb process. The list implementation needs to
- be changed to something like:
+ bool operator== (const self_type &other) const
+ {
+ return m_msym == other.m_msym;
+ }
- struct list {struct list *next; struct objfile *objfile};
+ bool operator!= (const self_type &other) const
+ {
+ return m_msym != other.m_msym;
+ }
- where the list structure is completely maintained separately within
- each gdb process. */
+ self_type &operator++ ()
+ {
+ ++m_msym;
+ return *this;
+ }
- struct objfile *next;
+private:
+ struct minimal_symbol *m_msym;
+};
- /* The object file's name, tilde-expanded and absolute.
- Malloc'd; free it if you free this struct. */
+/* 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. */
- char *name;
+struct objfile_per_bfd_storage
+{
+ objfile_per_bfd_storage ()
+ : minsyms_read (false)
+ {}
- /* Some flag bits for this objfile. */
+ ~objfile_per_bfd_storage ();
- unsigned short flags;
+ /* The storage has an obstack of its own. */
- /* Each objfile points to a linked list of symtabs derived from this file,
- one symtab structure for each compilation unit (source file). Each link
- in the symtab list contains a backpointer to this objfile. */
+ auto_obstack storage_obstack;
- struct symtab *symtabs;
+ /* Byte cache for file names. */
- /* Each objfile points to a linked list of partial symtabs derived from
- this file, one partial symtab structure for each compilation unit
- (source file). */
+ gdb::bcache filename_cache;
- struct partial_symtab *psymtabs;
+ /* Byte cache for macros. */
- /* 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. */
+ gdb::bcache macro_cache;
- struct addrmap *psymtabs_addrmap;
+ /* 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. */
- /* List of freed partial symtabs, available for re-use */
+ struct gdbarch *gdbarch = NULL;
- struct partial_symtab *free_psymtabs;
+ /* Hash table for mapping symbol names to demangled names. Each
+ entry in the hash table is a demangled_name_entry struct, storing the
+ language and 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. */
- /* The object file's BFD. Can be null if the objfile contains only
- minimal symbols, e.g. the run time common symbols for SunOS4. */
+ htab_up demangled_names_hash;
- bfd *obfd;
+ /* 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. */
- /* 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. */
+ entry_info ei {};
- struct gdbarch *gdbarch;
+ /* The name and language of any "main" found in this objfile. The
+ name can be NULL, which means that the information was not
+ recorded. */
- /* The modification timestamp of the object file, as of the last time
- we read its symbols. */
+ const char *name_of_main = NULL;
+ enum language language_of_main = language_unknown;
- long mtime;
+ /* 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. */
- /* Obstack to hold objects that should be freed when we load a new symbol
- table from this object file. */
+ gdb::unique_xmalloc_ptr<minimal_symbol> msymbols;
+ int minimal_symbol_count = 0;
- struct obstack objfile_obstack;
+ /* 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. */
- /* A byte cache where we can stash arbitrary "chunks" of bytes that
- will not change. */
+ int n_minsyms = 0;
- struct bcache *psymbol_cache; /* Byte cache for partial syms */
- struct bcache *macro_cache; /* Byte cache for macros */
+ /* 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. */
- /* 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. */
- struct htab *demangled_names_hash;
+ bool minsyms_read : 1;
- /* Vectors of all partial symbols read in from file. The actual data
- is stored in the objfile_obstack. */
+ /* This is a hash table used to index the minimal symbols by (mangled)
+ name. */
- struct psymbol_allocation_list global_psymbols;
- struct psymbol_allocation_list static_psymbols;
+ minimal_symbol *msymbol_hash[MINIMAL_SYMBOL_HASH_SIZE] {};
- /* 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. */
+ /* This hash table is used to index the minimal symbols by their
+ demangled names. Uses a language-specific hash function via
+ search_name_hash. */
- struct minimal_symbol *msymbols;
- int minimal_symbol_count;
+ minimal_symbol *msymbol_demangled_hash[MINIMAL_SYMBOL_HASH_SIZE] {};
- /* This is a hash table used to index the minimal symbols by name. */
+ /* All the different languages of symbols found in the demangled
+ hash table. */
+ std::bitset<nr_languages> demangled_hash_languages;
+};
- struct minimal_symbol *msymbol_hash[MINIMAL_SYMBOL_HASH_SIZE];
+/* An iterator that first returns a parent objfile, and then each
+ separate debug objfile. */
- /* This hash table is used to index the minimal symbols by their
- demangled names. */
+class separate_debug_iterator
+{
+public:
- struct minimal_symbol *msymbol_demangled_hash[MINIMAL_SYMBOL_HASH_SIZE];
+ explicit separate_debug_iterator (struct objfile *objfile)
+ : m_objfile (objfile),
+ m_parent (objfile)
+ {
+ }
- /* 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. */
+ bool operator!= (const separate_debug_iterator &other)
+ {
+ return m_objfile != other.m_objfile;
+ }
- struct sym_fns *sf;
+ separate_debug_iterator &operator++ ();
- /* 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. */
+ struct objfile *operator* ()
+ {
+ return m_objfile;
+ }
- struct entry_info ei;
+private:
- /* Information about stabs. Will be filled in with a dbx_symfile_info
- struct by those readers that need it. */
- /* NOTE: cagney/2004-10-23: This has been replaced by per-objfile
- data points implemented using "data" and "num_data" below. For
- an example of how to use this replacement, see "objfile_data"
- in "mips-tdep.c". */
+ struct objfile *m_objfile;
+ struct objfile *m_parent;
+};
- struct dbx_symfile_info *deprecated_sym_stab_info;
+/* A range adapter wrapping separate_debug_iterator. */
- /* Hook for information for use by the symbol reader (currently used
- for information shared by sym_init and sym_read). It is
- typically a pointer to malloc'd memory. The symbol reader's finish
- function is responsible for freeing the memory thusly allocated. */
- /* NOTE: cagney/2004-10-23: This has been replaced by per-objfile
- data points implemented using "data" and "num_data" below. For
- an example of how to use this replacement, see "objfile_data"
- in "mips-tdep.c". */
+class separate_debug_range
+{
+public:
- void *deprecated_sym_private;
+ explicit separate_debug_range (struct objfile *objfile)
+ : m_objfile (objfile)
+ {
+ }
- /* Per objfile data-pointers required by other GDB modules. */
- /* FIXME: kettenis/20030711: This mechanism could replace
- deprecated_sym_stab_info and deprecated_sym_private
- entirely. */
+ separate_debug_iterator begin ()
+ {
+ return separate_debug_iterator (m_objfile);
+ }
- void **data;
- unsigned num_data;
+ separate_debug_iterator end ()
+ {
+ return separate_debug_iterator (nullptr);
+ }
- /* Set of relocation offsets to apply to each section.
- Currently on the objfile_obstack (which makes no sense, but I'm
- not sure it's harming anything).
+private:
- 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 objfile *m_objfile;
+};
- struct section_offsets *section_offsets;
- int num_sections;
+/* 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).
+
+ GDB typically reads symbols twice -- first an initial scan which just
+ reads "partial symbols"; these are partial information for the
+ static/global symbols in a symbol file. When later looking up symbols,
+ objfile->sf->qf->lookup_symbol is used to check if we only have a partial
+ symbol and if so, read and expand the full compunit. */
+
+struct objfile
+{
+private:
+
+ /* The only way to create an objfile is to call objfile::make. */
+ objfile (bfd *, const char *, objfile_flags);
+
+public:
+
+ /* Normally you should not call delete. Instead, call 'unlink' to
+ remove it from the program space's list. In some cases, you may
+ need to hold a reference to an objfile that is independent of its
+ existence on the program space's list; for this case, the
+ destructor must be public so that shared_ptr can reference
+ it. */
+ ~objfile ();
+
+ /* Create an objfile. */
+ static objfile *make (bfd *bfd_, const char *name_, objfile_flags flags_,
+ objfile *parent = nullptr);
+
+ /* Remove an objfile from the current program space, and free
+ it. */
+ void unlink ();
+
+ DISABLE_COPY_AND_ASSIGN (objfile);
+
+ /* A range adapter that makes it possible to iterate over all
+ psymtabs in one objfile. */
+
+ psymtab_storage::partial_symtab_range psymtabs ()
+ {
+ return partial_symtabs->range ();
+ }
+
+ /* Reset the storage for the partial symbol tables. */
+
+ void reset_psymtabs ()
+ {
+ psymbol_map.clear ();
+ partial_symtabs.reset (new psymtab_storage ());
+ }
+
+ typedef next_adapter<struct compunit_symtab> compunits_range;
+
+ /* A range adapter that makes it possible to iterate over all
+ compunits in one objfile. */
+
+ compunits_range compunits ()
+ {
+ return compunits_range (compunit_symtabs);
+ }
+
+ /* A range adapter that makes it possible to iterate over all
+ minimal symbols of an objfile. */
+
+ class msymbols_range
+ {
+ public:
- /* 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. */
-
- int sect_index_text;
- int sect_index_data;
- int sect_index_bss;
- int sect_index_rodata;
-
- /* 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. Currently the table is stored on the
- objfile_obstack (which makes no sense, but I'm not sure it's
- harming anything). */
-
- struct obj_section
- *sections, *sections_end;
-
- /* Link to objfile that contains the debug symbols for this one.
- One is loaded if this file has an debug link to an existing
- debug file with the right checksum */
- struct objfile *separate_debug_objfile;
-
- /* If this is a separate debug object, this is used as a link to the
- actual executable objfile. */
- struct objfile *separate_debug_objfile_backlink;
-
- /* Place to stash various statistics about this objfile */
- OBJSTATS;
+ explicit msymbols_range (struct objfile *objfile)
+ : m_objfile (objfile)
+ {
+ }
- /* A symtab that the C++ code uses to stash special symbols
- associated to namespaces. */
-
- /* FIXME/carlton-2003-06-27: Delete this in a few years once
- "possible namespace symbols" go away. */
- struct symtab *cp_namespace_symtab;
+ minimal_symbol_iterator begin () const
+ {
+ return minimal_symbol_iterator (m_objfile->per_bfd->msymbols.get ());
+ }
+
+ minimal_symbol_iterator end () const
+ {
+ return minimal_symbol_iterator
+ (m_objfile->per_bfd->msymbols.get ()
+ + m_objfile->per_bfd->minimal_symbol_count);
+ }
+
+ private:
+
+ struct objfile *m_objfile;
};
-/* Defines for the objfile flag word. */
+ /* Return a range adapter for iterating over all minimal
+ symbols. */
-/* When an object file has its functions reordered (currently Irix-5.2
- shared libraries exhibit this behaviour), we will need an expensive
- algorithm to locate a partial symtab or symtab via an address.
- To avoid this penalty for normal object files, we use this flag,
- whose setting is determined upon symbol table read in. */
+ msymbols_range msymbols ()
+ {
+ return msymbols_range (this);
+ }
-#define OBJF_REORDERED (1 << 0) /* Functions are reordered */
+ /* Return a range adapter for iterating over all the separate debug
+ objfiles of this objfile. */
-/* Distinguish between an objfile for a shared library and a "vanilla"
- objfile. (If not set, the objfile may still actually be a solib.
- This can happen if the user created the objfile by using the
- add-symbol-file command. GDB doesn't in that situation actually
- check whether the file is a solib. Rather, the target's
- implementation of the solib interface is responsible for setting
- this flag when noticing solibs used by an inferior.) */
+ separate_debug_range separate_debug_objfiles ()
+ {
+ return separate_debug_range (this);
+ }
-#define OBJF_SHARED (1 << 1) /* From a shared library */
-/* User requested that this objfile be read in it's entirety. */
+ /* 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. */
-#define OBJF_READNOW (1 << 2) /* Immediate full read */
+ const char *original_name = nullptr;
-/* This objfile was created because the user explicitly caused it
- (e.g., used the add-symbol-file command). This bit offers a way
- for run_command to remove old objfile entries which are no longer
- valid (i.e., are associated with an old inferior), but to preserve
- ones that the user explicitly loaded via the add-symbol-file
- command. */
+ CORE_ADDR addr_low = 0;
-#define OBJF_USERLOADED (1 << 3) /* User loaded */
+ /* Some flag bits for this objfile. */
-/* The object file that the main symbol table was loaded from (e.g. the
- argument to the "symbol-file" or "file" command). */
+ objfile_flags flags;
-extern struct objfile *symfile_objfile;
+ /* The program space associated with this objfile. */
-/* The object file that contains the runtime common minimal symbols
- for SunOS4. Note that this objfile has no associated BFD. */
+ struct program_space *pspace;
-extern struct objfile *rt_common_objfile;
+ /* List of compunits.
+ These are used to do symbol lookups and file/line-number lookups. */
-/* When we need to allocate a new type, we need to know which objfile_obstack
- to allocate the type on, since there is one for each objfile. The places
- where types are allocated are deeply buried in function call hierarchies
- which know nothing about objfiles, so rather than trying to pass a
- particular objfile down to them, we just do an end run around them and
- set current_objfile to be whatever objfile we expect to be using at the
- time types are being allocated. For instance, when we start reading
- symbols for a particular objfile, we set current_objfile to point to that
- objfile, and when we are done, we set it back to NULL, to ensure that we
- never put a type someplace other than where we are expecting to put it.
- FIXME: Maybe we should review the entire type handling system and
- see if there is a better way to avoid this problem. */
+ struct compunit_symtab *compunit_symtabs = nullptr;
-extern struct objfile *current_objfile;
+ /* The partial symbol tables. */
-/* All known objfiles are kept in a linked list. This points to the
- root of this list. */
+ std::unique_ptr<psymtab_storage> partial_symtabs;
-extern struct objfile *object_files;
+ /* The object file's BFD. Can be null if the objfile contains only
+ minimal symbols, e.g. the run time common symbols for SunOS4. */
-/* Declarations for functions defined in objfiles.c */
+ bfd *obfd;
-extern struct objfile *allocate_objfile (bfd *, int);
+ /* The per-BFD data. Note that this is treated specially if OBFD
+ is NULL. */
-extern struct gdbarch *get_objfile_arch (struct objfile *);
+ struct objfile_per_bfd_storage *per_bfd = nullptr;
-extern void init_entry_point_info (struct objfile *);
+ /* The modification timestamp of the object file, as of the last time
+ we read its symbols. */
-extern CORE_ADDR entry_point_address (void);
+ long mtime = 0;
-extern int build_objfile_section_table (struct objfile *);
+ /* Obstack to hold objects that should be freed when we load a new symbol
+ table from this object file. */
-extern void terminate_minimal_symbol_table (struct objfile *objfile);
+ struct obstack objfile_obstack {};
-extern void put_objfile_before (struct objfile *, struct objfile *);
+ /* Map symbol addresses to the partial symtab that defines the
+ object at that address. */
-extern void objfile_to_front (struct objfile *);
+ std::vector<std::pair<CORE_ADDR, partial_symtab *>> psymbol_map;
-extern void unlink_objfile (struct objfile *);
+ /* 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. */
-extern void free_objfile (struct objfile *);
+ const struct sym_fns *sf = nullptr;
-extern struct cleanup *make_cleanup_free_objfile (struct objfile *);
+ /* Per objfile data-pointers required by other GDB modules. */
-extern void free_all_objfiles (void);
+ REGISTRY_FIELDS {};
-extern void objfile_relocate (struct objfile *, struct section_offsets *);
+ /* 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.
-extern int have_partial_symbols (void);
+ 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. */
-extern int have_full_symbols (void);
+ ::section_offsets section_offsets;
-extern void objfiles_changed (void);
+ /* 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.
-/* 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);
+ These are initialized to -1 so that we can later detect if they
+ are used w/o being properly assigned to. */
-/* Functions for dealing with the minimal symbol table, really a misc
- address<->symbol mapping for things we don't have debug symbols for. */
+ int sect_index_text = -1;
+ int sect_index_data = -1;
+ int sect_index_bss = -1;
+ int sect_index_rodata = -1;
-extern int have_minimal_symbols (void);
+ /* 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). */
-extern struct obj_section *find_pc_section (CORE_ADDR pc);
+ struct obj_section *sections = nullptr;
+ struct obj_section *sections_end = nullptr;
-extern int in_plt_section (CORE_ADDR, char *);
+ /* 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 objfiles & co iterators. Separate debug objfile always
+ has a non-nul separate_debug_objfile_backlink. */
-/* Keep a registry of per-objfile data-pointers required by other GDB
- modules. */
+ /* Link to the first separate debug object, if any. */
-extern const struct objfile_data *register_objfile_data (void);
-extern const struct objfile_data *register_objfile_data_with_cleanup
- (void (*cleanup) (struct objfile *, void *));
-extern void clear_objfile_data (struct objfile *objfile);
-extern void set_objfile_data (struct objfile *objfile,
- const struct objfile_data *data, void *value);
-extern void *objfile_data (struct objfile *objfile,
- const struct objfile_data *data);
+ struct objfile *separate_debug_objfile = nullptr;
-extern void gdb_bfd_unref (struct bfd *abfd);
-\f
+ /* If this is a separate debug object, this is used as a link to the
+ actual executable objfile. */
-/* Traverse all object files. ALL_OBJFILES_SAFE works even if you delete
- the objfile during the traversal. */
+ struct objfile *separate_debug_objfile_backlink = nullptr;
-#define ALL_OBJFILES(obj) \
- for ((obj) = object_files; (obj) != NULL; (obj) = (obj)->next)
+ /* If this is a separate debug object, this is a link to the next one
+ for the same executable objfile. */
-#define ALL_OBJFILES_SAFE(obj,nxt) \
- for ((obj) = object_files; \
- (obj) != NULL? ((nxt)=(obj)->next,1) :0; \
- (obj) = (nxt))
+ struct objfile *separate_debug_objfile_link = nullptr;
-/* Traverse all symtabs in one objfile. */
+ /* Place to stash various statistics about this objfile. */
-#define ALL_OBJFILE_SYMTABS(objfile, s) \
- for ((s) = (objfile) -> symtabs; (s) != NULL; (s) = (s) -> next)
+ OBJSTATS;
-/* Traverse all psymtabs in one objfile. */
+ /* 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. */
-#define ALL_OBJFILE_PSYMTABS(objfile, p) \
- for ((p) = (objfile) -> psymtabs; (p) != NULL; (p) = (p) -> next)
+ struct symbol *template_symbols = nullptr;
-/* Traverse all minimal symbols in one objfile. */
+ /* Associate a static link (struct dynamic_prop *) to all blocks (struct
+ block *) that have one.
-#define ALL_OBJFILE_MSYMBOLS(objfile, m) \
- for ((m) = (objfile) -> msymbols; SYMBOL_LINKAGE_NAME(m) != NULL; (m)++)
+ 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.
-/* Traverse all symtabs in all objfiles. */
+ 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_up static_links;
+};
-#define ALL_SYMTABS(objfile, s) \
- ALL_OBJFILES (objfile) \
- ALL_OBJFILE_SYMTABS (objfile, s)
+/* A deleter for objfile. */
-/* Traverse all symtabs in all objfiles, skipping included files
- (which share a blockvector with their primary symtab). */
+struct objfile_deleter
+{
+ void operator() (objfile *ptr) const
+ {
+ ptr->unlink ();
+ }
+};
-#define ALL_PRIMARY_SYMTABS(objfile, s) \
- ALL_OBJFILES (objfile) \
- ALL_OBJFILE_SYMTABS (objfile, s) \
- if ((s)->primary)
+/* A unique pointer that holds an objfile. */
-/* Traverse all psymtabs in all objfiles. */
+typedef std::unique_ptr<objfile, objfile_deleter> objfile_up;
-#define ALL_PSYMTABS(objfile, p) \
- ALL_OBJFILES (objfile) \
- ALL_OBJFILE_PSYMTABS (objfile, p)
+/* Declarations for functions defined in objfiles.c */
-/* Traverse all minimal symbols in all objfiles. */
+extern struct gdbarch *get_objfile_arch (const struct objfile *);
-#define ALL_MSYMBOLS(objfile, m) \
- ALL_OBJFILES (objfile) \
- ALL_OBJFILE_MSYMBOLS (objfile, m)
+extern int entry_point_address_query (CORE_ADDR *entry_p);
-#define ALL_OBJFILE_OSECTIONS(objfile, osect) \
- for (osect = objfile->sections; osect < objfile->sections_end; osect++)
+extern CORE_ADDR entry_point_address (void);
+
+extern void build_objfile_section_table (struct objfile *);
+
+extern void free_objfile_separate_debug (struct objfile *);
+
+extern void objfile_relocate (struct objfile *, const 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);
-#define ALL_OBJSECTIONS(objfile, osect) \
- ALL_OBJFILES (objfile) \
- ALL_OBJFILE_OSECTIONS (objfile, osect)
+/* 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 the returned scoped_restore object is destroyed. 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 scoped_restore_tmpl<int> inhibit_section_map_updates
+ (struct program_space *pspace);
+
+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);
+\f
+
+#define ALL_OBJFILE_OSECTIONS(objfile, osect) \
+ for (osect = objfile->sections; osect < objfile->sections_end; osect++) \
+ if (osect->the_bfd_section == NULL) \
+ { \
+ /* Nothing. */ \
+ } \
+ else
#define SECT_OFF_DATA(objfile) \
((objfile->sect_index_data == -1) \
- ? (internal_error (__FILE__, __LINE__, _("sect_index_data not initialized")), -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) \
+ ? (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) \
+ ? (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. */
+ 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. */
+/* 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);
-#define MULTI_OBJFILE_P() (object_files && object_files->next)
+extern const struct dynamic_prop *objfile_lookup_static_link
+ (struct objfile *objfile, const struct block *block);
#endif /* !defined (OBJFILES_H) */
projects / deliverable / binutils-gdb.git / blobdiff