/* Private partial symbol table definitions.
- Copyright (C) 2009, 2010 Free Software Foundation, Inc.
+ Copyright (C) 2009-2019 Free Software Foundation, Inc.
This file is part of GDB.
#define PSYMPRIV_H
#include "psymtab.h"
-
-struct psymbol_allocation_list;
+#include "objfiles.h"
/* A partial_symbol records the name, domain, and address class of
symbols whose types we have not parsed yet. For functions, it also
contains their memory address, so we can find them from a PC value.
Each partial_symbol sits in a partial_symtab, all of which are chained
- on a partial symtab list and which points to the corresponding
+ on a partial symtab list and which points to the corresponding
normal symtab once the partial_symtab has been referenced. */
/* This structure is space critical. See space comments at the top of
- symtab.h. */
+ symtab.h. */
-struct partial_symbol
+struct partial_symbol : public general_symbol_info
{
-
- /* The general symbol info required for all types of symbols. */
-
- struct general_symbol_info ginfo;
+ /* Return the section for this partial symbol, or nullptr if no
+ section has been set. */
+ struct obj_section *obj_section (struct objfile *objfile) const
+ {
+ if (section >= 0)
+ return &objfile->sections[section];
+ return nullptr;
+ }
+
+ /* Return the unrelocated address of this partial symbol. */
+ CORE_ADDR unrelocated_address () const
+ {
+ return value.address;
+ }
+
+ /* Return the address of this partial symbol, relocated according to
+ the offsets provided in OBJFILE. */
+ CORE_ADDR address (const struct objfile *objfile) const
+ {
+ return value.address + ANOFFSET (objfile->section_offsets, section);
+ }
+
+ /* Set the address of this partial symbol. The address must be
+ unrelocated. */
+ void set_unrelocated_address (CORE_ADDR addr)
+ {
+ value.address = addr;
+ }
/* Name space code. */
- ENUM_BITFIELD(domain_enum_tag) domain : 6;
-
- /* Address class (for info_symbols) */
+ ENUM_BITFIELD(domain_enum_tag) domain : SYMBOL_DOMAIN_BITS;
- ENUM_BITFIELD(address_class) aclass : 6;
+ /* Address class (for info_symbols). Note that we don't allow
+ synthetic "aclass" values here at present, simply because there's
+ no need. */
+ ENUM_BITFIELD(address_class) aclass : SYMBOL_ACLASS_BITS;
};
-#define PSYMBOL_DOMAIN(psymbol) (psymbol)->domain
-#define PSYMBOL_CLASS(psymbol) (psymbol)->aclass
+/* A convenience enum to give names to some constants used when
+ searching psymtabs. This is internal to psymtab and should not be
+ used elsewhere. */
+
+enum psymtab_search_status
+ {
+ PST_NOT_SEARCHED,
+ PST_SEARCHED_AND_FOUND,
+ PST_SEARCHED_AND_NOT_FOUND
+ };
/* Each source file that has not been fully read in is represented by
a partial_symtab. This contains the information on where in the
struct partial_symtab
{
+ /* Return the raw low text address of this partial_symtab. */
+ CORE_ADDR raw_text_low () const
+ {
+ return m_text_low;
+ }
+
+ /* Return the raw high text address of this partial_symtab. */
+ CORE_ADDR raw_text_high () const
+ {
+ return m_text_high;
+ }
+
+ /* Return the relocated low text address of this partial_symtab. */
+ CORE_ADDR text_low (struct objfile *objfile) const
+ {
+ return m_text_low + ANOFFSET (objfile->section_offsets,
+ SECT_OFF_TEXT (objfile));
+ }
+
+ /* Return the relocated high text address of this partial_symtab. */
+ CORE_ADDR text_high (struct objfile *objfile) const
+ {
+ return m_text_high + ANOFFSET (objfile->section_offsets,
+ SECT_OFF_TEXT (objfile));
+ }
+
+ /* Set the low text address of this partial_symtab. */
+ void set_text_low (CORE_ADDR addr)
+ {
+ m_text_low = addr;
+ text_low_valid = 1;
+ }
+
+ /* Set the hight text address of this partial_symtab. */
+ void set_text_high (CORE_ADDR addr)
+ {
+ m_text_high = addr;
+ text_high_valid = 1;
+ }
+
/* Chain of all existing partial symtabs. */
struct partial_symtab *next;
- /* Name of the source file which this partial_symtab defines */
+ /* Name of the source file which this partial_symtab defines,
+ or if the psymtab is anonymous then a descriptive name for
+ debugging purposes, or "". It must not be NULL. */
const char *filename;
const char *dirname;
- /* Information about the object file from which symbols should be read. */
+ /* Range of text addresses covered by this file; texthigh is the
+ beginning of the next section. Do not use if PSYMTABS_ADDRMAP_SUPPORTED
+ is set. Do not refer directly to these fields. Instead, use the
+ accessors. The validity of these fields is determined by the
+ text_low_valid and text_high_valid fields; these are located later
+ in this structure for better packing. */
- struct objfile *objfile;
+ CORE_ADDR m_text_low;
+ CORE_ADDR m_text_high;
- /* Set of relocation offsets to apply to each section. */
+ /* If NULL, this is an ordinary partial symbol table.
- struct section_offsets *section_offsets;
+ If non-NULL, this holds a single includer of this partial symbol
+ table, and this partial symbol table is a shared one.
- /* Range of text addresses covered by this file; texthigh is the
- beginning of the next section. */
+ A shared psymtab is one that is referenced by multiple other
+ psymtabs, and which conceptually has its contents directly
+ included in those.
- CORE_ADDR textlow;
- CORE_ADDR texthigh;
+ Shared psymtabs have special semantics. When a search finds a
+ symbol in a shared table, we instead return one of the non-shared
+ tables that include this one.
+
+ A shared psymtabs can be referred to by other shared ones.
+
+ The psymtabs that refer to a shared psymtab will list the shared
+ psymtab in their 'dependencies' array.
+
+ In DWARF terms, a shared psymtab is a DW_TAG_partial_unit; but
+ of course using a name based on that would be too confusing, so
+ "shared" was chosen instead.
+
+ Only a single user is needed because, when expanding a shared
+ psymtab, we only need to expand its "canonical" non-shared user.
+ The choice of which one should be canonical is left to the
+ debuginfo reader; it can be arbitrary. */
+
+ struct partial_symtab *user;
/* Array of pointers to all of the partial_symtab's which this one
depends on. Since this array can only be set to previous or
/* Global symbol list. This list will be sorted after readin to
improve access. Binary search will be the usual method of
- finding a symbol within it. globals_offset is an integer offset
+ finding a symbol within it. globals_offset is an integer offset
within global_psymbols[]. */
int globals_offset;
unsigned char readin;
- /* Pointer to symtab eventually allocated for this source file, 0 if
+ /* True iff objfile->psymtabs_addrmap is properly populated for this
+ partial_symtab. For discontiguous overlapping psymtabs is the only usable
+ info in PSYMTABS_ADDRMAP. */
+
+ unsigned char psymtabs_addrmap_supported;
+
+ /* True if the name of this partial symtab is not a source file name. */
+
+ unsigned char anonymous;
+
+ /* A flag that is temporarily used when searching psymtabs. */
+
+ ENUM_BITFIELD (psymtab_search_status) searched_flag : 2;
+
+ /* Validity of the m_text_low and m_text_high fields. */
+
+ unsigned int text_low_valid : 1;
+ unsigned int text_high_valid : 1;
+
+ /* Pointer to compunit eventually allocated for this source file, 0 if
!readin or if we haven't looked for the symtab after it was readin. */
- struct symtab *symtab;
+ struct compunit_symtab *compunit_symtab;
/* Pointer to function which will read in the symtab corresponding to
this psymtab. */
- void (*read_symtab) (struct partial_symtab *);
+ void (*read_symtab) (struct partial_symtab *, struct objfile *);
/* Information that lets read_symtab() locate the part of the symbol table
that this psymtab corresponds to. This information is private to the
void *read_symtab_private;
};
-extern void sort_pst_symbols (struct partial_symtab *);
+/* Specify whether a partial psymbol should be allocated on the global
+ list or the static list. */
+
+enum class psymbol_placement
+{
+ STATIC,
+ GLOBAL
+};
+
+/* Add any kind of symbol to a partial_symbol vector. */
-/* Add any kind of symbol to a psymbol_allocation_list. */
+extern void add_psymbol_to_list (const char *, int,
+ int, domain_enum,
+ enum address_class,
+ short /* section */,
+ enum psymbol_placement,
+ CORE_ADDR,
+ enum language, struct objfile *);
-extern const
-struct partial_symbol *add_psymbol_to_list (const char *, int, int, domain_enum,
- enum address_class,
- struct psymbol_allocation_list *,
- long, CORE_ADDR,
- enum language, struct objfile *);
+/* Initialize storage for partial symbols. If partial symbol storage
+ has already been initialized, this does nothing. TOTAL_SYMBOLS is
+ an estimate of how many symbols there will be. */
-extern void init_psymbol_list (struct objfile *, int);
+extern void init_psymbol_list (struct objfile *objfile, int total_symbols);
extern struct partial_symtab *start_psymtab_common (struct objfile *,
- struct section_offsets *,
- const char *, CORE_ADDR,
- struct partial_symbol **,
- struct partial_symbol **);
-
-extern struct partial_symtab *allocate_psymtab (const char *,
- struct objfile *);
+ const char *, CORE_ADDR);
-extern void discard_psymtab (struct partial_symtab *);
+extern void end_psymtab_common (struct objfile *, struct partial_symtab *);
-/* Traverse all psymtabs in one objfile. */
+/* Allocate a new partial symbol table associated with OBJFILE.
+ FILENAME (which must be non-NULL) is the filename of this partial
+ symbol table; it is copied into the appropriate storage. A new
+ partial symbol table is returned; aside from "next" and "filename",
+ its fields are initialized to zero. */
-#define ALL_OBJFILE_PSYMTABS(objfile, p) \
- for ((p) = (objfile) -> psymtabs; (p) != NULL; (p) = (p) -> next)
+extern struct partial_symtab *allocate_psymtab (const char *filename,
+ struct objfile *objfile)
+ ATTRIBUTE_NONNULL (1);
-/* Traverse all psymtabs in all objfiles. */
+static inline void
+discard_psymtab (struct objfile *objfile, struct partial_symtab *pst)
+{
+ objfile->partial_symtabs->discard_psymtab (pst);
+}
-#define ALL_PSYMTABS(objfile, p) \
- ALL_OBJFILES (objfile) \
- ALL_OBJFILE_PSYMTABS (objfile, p)
+/* Used when recording partial symbol tables. On destruction,
+ discards any partial symbol tables that have been built. However,
+ the tables can be kept by calling the "keep" method. */
+class psymtab_discarder
+{
+ public:
+
+ psymtab_discarder (struct objfile *objfile)
+ : m_objfile (objfile),
+ m_psymtab (objfile->partial_symtabs->psymtabs)
+ {
+ }
+
+ ~psymtab_discarder ()
+ {
+ if (m_objfile != NULL)
+ m_objfile->partial_symtabs->discard_psymtabs_to (m_psymtab);
+ }
+
+ /* Keep any partial symbol tables that were built. */
+ void keep ()
+ {
+ m_objfile = NULL;
+ }
+
+ private:
+
+ /* The objfile. If NULL this serves as a sentinel to indicate that
+ the psymtabs should be kept. */
+ struct objfile *m_objfile;
+ /* How far back to free. */
+ struct partial_symtab *m_psymtab;
+};
#endif /* PSYMPRIV_H */
projects / thirdparty / binutils-gdb.git / blobdiff