/* Public partial symbol table definitions.
- Copyright (C) 2009, 2010, 2011 Free Software Foundation, Inc.
+ Copyright (C) 2009-2022 Free Software Foundation, Inc.
This file is part of GDB.
#ifndef PSYMTAB_H
#define PSYMTAB_H
+#include "gdbsupport/gdb_obstack.h"
#include "symfile.h"
+#include "gdbsupport/next-iterator.h"
+#include "bcache.h"
-/* A bcache for partial symbols. */
+struct partial_symbol;
-struct psymbol_bcache;
+/* Specialization of bcache to store partial symbols. */
-extern struct psymbol_bcache *psymbol_bcache_init (void);
-extern void psymbol_bcache_free (struct psymbol_bcache *);
-extern struct bcache *psymbol_bcache_get_bcache (struct psymbol_bcache *);
+struct psymbol_bcache : public gdb::bcache
+{
+ /* Calculate a hash code for the given partial symbol. The hash is
+ calculated using the symbol's value, language, domain, class
+ and name. These are the values which are set by
+ add_psymbol_to_bcache. */
+ unsigned long hash (const void *addr, int length) override;
-void expand_partial_symbol_names (int (*fun) (const char *, void *),
- void *data);
+ /* Returns true if the symbol LEFT equals the symbol RIGHT.
+ For the comparison this function uses a symbols value,
+ language, domain, class and name. */
+ int compare (const void *left, const void *right, int length) override;
+};
-void map_partial_symbol_filenames (symbol_filename_ftype *fun, void *data,
- int need_fullname);
+/* An instance of this class manages the partial symbol tables and
+ partial symbols for a given objfile.
-extern const struct quick_symbol_functions psym_functions;
+ The core psymtab functions -- those in psymtab.c -- arrange for
+ nearly all psymtab- and psymbol-related allocations to happen
+ either in the psymtab_storage object (either on its obstack or in
+ other memory managed by this class), or on the per-BFD object. The
+ only link from the psymtab storage object back to the objfile (or
+ objfile_obstack) that is made by the core psymtab code is the
+ compunit_symtab member in the standard_psymtab -- and a given
+ symbol reader can avoid this by implementing its own subclasses of
+ partial_symtab.
-extern const struct quick_symbol_functions dwarf2_gdb_index_functions;
+ However, it is up to each symbol reader to maintain this invariant
+ in other ways, if it wants to reuse psymtabs across multiple
+ objfiles. The main issue here is ensuring that read_symtab_private
+ does not point into objfile_obstack. */
-/* Ensure that the partial symbols for OBJFILE have been loaded. If
- VERBOSE is non-zero, then this will print a message when symbols
- are loaded. This function always returns its argument, as a
- convenience. */
+class psymtab_storage
+{
+public:
+ psymtab_storage () = default;
+ ~psymtab_storage ();
-extern struct objfile *require_partial_symbols (struct objfile *objfile,
- int verbose);
+ DISABLE_COPY_AND_ASSIGN (psymtab_storage);
+
+ /* Discard all partial symbol tables starting with "psymtabs" and
+ proceeding until "to" has been discarded. */
+
+ void discard_psymtabs_to (struct partial_symtab *to)
+ {
+ while (psymtabs != to)
+ discard_psymtab (psymtabs);
+ }
+
+ /* Discard the partial symbol table. */
+
+ void discard_psymtab (struct partial_symtab *pst);
+
+ /* Return the obstack that is used for storage by this object. */
+
+ struct obstack *obstack ()
+ {
+ if (!m_obstack.has_value ())
+ m_obstack.emplace ();
+ return &*m_obstack;
+ }
+
+ /* Allocate storage for the "dependencies" field of a psymtab.
+ NUMBER says how many dependencies there are. */
+
+ struct partial_symtab **allocate_dependencies (int number)
+ {
+ return OBSTACK_CALLOC (obstack (), number, struct partial_symtab *);
+ }
+
+ /* Install a psymtab on the psymtab list. This transfers ownership
+ of PST to this object. */
+
+ void install_psymtab (partial_symtab *pst);
+
+ using partial_symtab_range = next_range<partial_symtab>;
+
+ /* A range adapter that makes it possible to iterate over all
+ psymtabs in one objfile. */
+
+ partial_symtab_range range ()
+ {
+ return partial_symtab_range (psymtabs);
+ }
+
+
+ /* 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.
+
+ The DWARF parser reuses this addrmap to store things other than
+ psymtabs in the cases where debug information is being read from, for
+ example, the .debug-names section. */
+
+ struct addrmap *psymtabs_addrmap = nullptr;
+
+ /* A byte cache where we can stash arbitrary "chunks" of bytes that
+ will not change. */
+
+ psymbol_bcache psymbol_cache;
+
+private:
+
+ /* The obstack where allocations are made. This is lazily allocated
+ so that we don't waste memory when there are no psymtabs. */
+
+ gdb::optional<auto_obstack> m_obstack;
+};
#endif /* PSYMTAB_H */