gdb/psymtab.h

   1 /* Public partial symbol table definitions.
   2
   3    Copyright (C) 2009-2019 Free Software Foundation, Inc.
   4
   5    This file is part of GDB.
   6
   7    This program is free software; you can redistribute it and/or modify
   8    it under the terms of the GNU General Public License as published by
   9    the Free Software Foundation; either version 3 of the License, or
  10    (at your option) any later version.
  11
  12    This program is distributed in the hope that it will be useful,
  13    but WITHOUT ANY WARRANTY; without even the implied warranty of
  14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15    GNU General Public License for more details.
  16
  17    You should have received a copy of the GNU General Public License
  18    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  19
  20 #ifndef PSYMTAB_H
  21 #define PSYMTAB_H
  22
  23 #include "symfile.h"
  24 #include "common/next-iterator.h"
  25
  26 struct partial_symbol;
  27
  28 /* A bcache for partial symbols.  */
  29
  30 struct psymbol_bcache;
  31
  32 /* An instance of this class manages the partial symbol tables and
  33    partial symbols for a given objfile.  */
  34
  35 class psymtab_storage
  36 {
  37 public:
  38
  39   explicit psymtab_storage (struct objfile *objfile);
  40
  41   ~psymtab_storage ();
  42
  43   DISABLE_COPY_AND_ASSIGN (psymtab_storage);
  44
  45   /* Discard all partial symbol tables starting with "psymtabs" and
  46      proceeding until "to" has been discarded.  */
  47
  48   void discard_psymtabs_to (struct partial_symtab *to)
  49   {
  50     while (psymtabs != to)
  51       discard_psymtab (psymtabs);
  52   }
  53
  54   /* Discard the partial symbol table.  */
  55
  56   void discard_psymtab (struct partial_symtab *pst);
  57
  58
  59   /* Each objfile points to a linked list of partial symtabs derived from
  60      this file, one partial symtab structure for each compilation unit
  61      (source file).  */
  62
  63   struct partial_symtab *psymtabs = nullptr;
  64
  65   /* Map addresses to the entries of PSYMTABS.  It would be more efficient to
  66      have a map per the whole process but ADDRMAP cannot selectively remove
  67      its items during FREE_OBJFILE.  This mapping is already present even for
  68      PARTIAL_SYMTABs which still have no corresponding full SYMTABs read.  */
  69
  70   struct addrmap *psymtabs_addrmap = nullptr;
  71
  72   /* List of freed partial symtabs, available for re-use.  */
  73
  74   struct partial_symtab *free_psymtabs = nullptr;
  75
  76   /* The obstack where allocations are made.  */
  77
  78   struct obstack *obstack;
  79
  80   /* A byte cache where we can stash arbitrary "chunks" of bytes that
  81      will not change.  */
  82
  83   struct psymbol_bcache *psymbol_cache;
  84
  85   /* Vectors of all partial symbols read in from file.  The actual data
  86      is stored in the objfile_obstack.  */
  87
  88   std::vector<partial_symbol *> global_psymbols;
  89   std::vector<partial_symbol *> static_psymbols;
  90 };
  91
  92
  93 extern struct psymbol_bcache *psymbol_bcache_init (void);
  94 extern void psymbol_bcache_free (struct psymbol_bcache *);
  95 extern struct bcache *psymbol_bcache_get_bcache (struct psymbol_bcache *);
  96
  97 extern const struct quick_symbol_functions psym_functions;
  98
  99 extern const struct quick_symbol_functions dwarf2_gdb_index_functions;
 100 extern const struct quick_symbol_functions dwarf2_debug_names_functions;
 101
 102 /* Ensure that the partial symbols for OBJFILE have been loaded.  If
 103    VERBOSE is non-zero, then this will print a message when symbols
 104    are loaded.  This function returns a range adapter suitable for
 105    iterating over the psymtabs of OBJFILE.  */
 106
 107 class objfile_psymtabs;
 108 extern objfile_psymtabs require_partial_symbols (struct objfile *objfile,
 109                                                  int verbose);
 110
 111 #endif /* PSYMTAB_H */