gdb/psympriv.h

   1 /* Private partial symbol table definitions.
   2
   3    Copyright (C) 2009-2013 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 PSYMPRIV_H
  21 #define PSYMPRIV_H
  22
  23 #include "psymtab.h"
  24
  25 struct psymbol_allocation_list;
  26
  27 /* A partial_symbol records the name, domain, and address class of
  28    symbols whose types we have not parsed yet.  For functions, it also
  29    contains their memory address, so we can find them from a PC value.
  30    Each partial_symbol sits in a partial_symtab, all of which are chained
  31    on a  partial symtab list and which points to the corresponding
  32    normal symtab once the partial_symtab has been referenced.  */
  33
  34 /* This structure is space critical.  See space comments at the top of
  35    symtab.h.  */
  36
  37 struct partial_symbol
  38 {
  39
  40   /* The general symbol info required for all types of symbols.  */
  41
  42   struct general_symbol_info ginfo;
  43
  44   /* Name space code.  */
  45
  46   ENUM_BITFIELD(domain_enum_tag) domain : 6;
  47
  48   /* Address class (for info_symbols).  Note that we don't allow
  49      synthetic "aclass" values here at present, simply because there's
  50      no need.  */
  51
  52   ENUM_BITFIELD(address_class) aclass : 6;
  53
  54 };
  55
  56 #define PSYMBOL_DOMAIN(psymbol) (psymbol)->domain
  57 #define PSYMBOL_CLASS(psymbol)          (psymbol)->aclass
  58
  59 /* A convenience enum to give names to some constants used when
  60    searching psymtabs.  This is internal to psymtab and should not be
  61    used elsewhere.  */
  62
  63 enum psymtab_search_status
  64   {
  65     PST_NOT_SEARCHED,
  66     PST_SEARCHED_AND_FOUND,
  67     PST_SEARCHED_AND_NOT_FOUND
  68   };
  69
  70 /* Each source file that has not been fully read in is represented by
  71    a partial_symtab.  This contains the information on where in the
  72    executable the debugging symbols for a specific file are, and a
  73    list of names of global symbols which are located in this file.
  74    They are all chained on partial symtab lists.
  75
  76    Even after the source file has been read into a symtab, the
  77    partial_symtab remains around.  They are allocated on an obstack,
  78    objfile_obstack.  */
  79
  80 struct partial_symtab
  81 {
  82
  83   /* Chain of all existing partial symtabs.  */
  84
  85   struct partial_symtab *next;
  86
  87   /* Name of the source file which this partial_symtab defines,
  88      or if the psymtab is anonymous then a descriptive name for
  89      debugging purposes, or "".  It must not be NULL.  */
  90
  91   const char *filename;
  92
  93   /* Full path of the source file.  NULL if not known.  */
  94
  95   char *fullname;
  96
  97   /* Directory in which it was compiled, or NULL if we don't know.  */
  98
  99   const char *dirname;
 100
 101   /* Set of relocation offsets to apply to each section.  */
 102
 103   struct section_offsets *section_offsets;
 104
 105   /* Range of text addresses covered by this file; texthigh is the
 106      beginning of the next section.  Do not use if PSYMTABS_ADDRMAP_SUPPORTED
 107      is set.  */
 108
 109   CORE_ADDR textlow;
 110   CORE_ADDR texthigh;
 111
 112   /* Array of pointers to all of the partial_symtab's which this one
 113      depends on.  Since this array can only be set to previous or
 114      the current (?) psymtab, this dependency tree is guaranteed not
 115      to have any loops.  "depends on" means that symbols must be read
 116      for the dependencies before being read for this psymtab; this is
 117      for type references in stabs, where if foo.c includes foo.h, declarations
 118      in foo.h may use type numbers defined in foo.c.  For other debugging
 119      formats there may be no need to use dependencies.  */
 120
 121   struct partial_symtab **dependencies;
 122
 123   int number_of_dependencies;
 124
 125   /* If NULL, this is an ordinary partial symbol table.
 126
 127      If non-NULL, this holds a single includer of this partial symbol
 128      table, and this partial symbol table is a shared one.
 129
 130      A shared psymtab is one that is referenced by multiple other
 131      psymtabs, and which conceptually has its contents directly
 132      included in those.
 133
 134      Shared psymtabs have special semantics.  When a search finds a
 135      symbol in a shared table, we instead return one of the non-shared
 136      tables that include this one.
 137
 138      A shared psymtabs can be referred to by other shared ones.
 139
 140      The psymtabs that refer to a shared psymtab will list the shared
 141      psymtab in their 'dependencies' array.
 142
 143      In DWARF terms, a shared psymtab is a DW_TAG_partial_unit; but
 144      of course using a name based on that would be too confusing, so
 145      "shared" was chosen instead.
 146
 147      Only a single user is needed because, when expanding a shared
 148      psymtab, we only need to expand its "canonical" non-shared user.
 149      The choice of which one should be canonical is left to the
 150      debuginfo reader; it can be arbitrary.  */
 151
 152   struct partial_symtab *user;
 153
 154   /* Global symbol list.  This list will be sorted after readin to
 155      improve access.  Binary search will be the usual method of
 156      finding a symbol within it.  globals_offset is an integer offset
 157      within global_psymbols[].  */
 158
 159   int globals_offset;
 160   int n_global_syms;
 161
 162   /* Static symbol list.  This list will *not* be sorted after readin;
 163      to find a symbol in it, exhaustive search must be used.  This is
 164      reasonable because searches through this list will eventually
 165      lead to either the read in of a files symbols for real (assumed
 166      to take a *lot* of time; check) or an error (and we don't care
 167      how long errors take).  This is an offset and size within
 168      static_psymbols[].  */
 169
 170   int statics_offset;
 171   int n_static_syms;
 172
 173   /* Non-zero if the symtab corresponding to this psymtab has been
 174      readin.  This is located here so that this structure packs better
 175      on 64-bit systems.  */
 176
 177   unsigned char readin;
 178
 179   /* True iff objfile->psymtabs_addrmap is properly populated for this
 180      partial_symtab.  For discontiguous overlapping psymtabs is the only usable
 181      info in PSYMTABS_ADDRMAP.  */
 182
 183   unsigned char psymtabs_addrmap_supported;
 184
 185   /* True if the name of this partial symtab is not a source file name.  */
 186
 187   unsigned char anonymous;
 188
 189   /* A flag that is temporarily used when searching psymtabs.  */
 190
 191   ENUM_BITFIELD (psymtab_search_status) searched_flag : 2;
 192
 193   /* Pointer to symtab eventually allocated for this source file, 0 if
 194      !readin or if we haven't looked for the symtab after it was readin.  */
 195
 196   struct symtab *symtab;
 197
 198   /* Pointer to function which will read in the symtab corresponding to
 199      this psymtab.  */
 200
 201   void (*read_symtab) (struct partial_symtab *, struct objfile *);
 202
 203   /* Information that lets read_symtab() locate the part of the symbol table
 204      that this psymtab corresponds to.  This information is private to the
 205      format-dependent symbol reading routines.  For further detail examine
 206      the various symbol reading modules.  */
 207
 208   void *read_symtab_private;
 209 };
 210
 211 extern void sort_pst_symbols (struct objfile *, struct partial_symtab *);
 212
 213 /* Add any kind of symbol to a psymbol_allocation_list.  */
 214
 215 extern void add_psymbol_to_list (const char *, int,
 216                                  int, domain_enum,
 217                                  enum address_class,
 218                                  struct psymbol_allocation_list *,
 219                                  long, CORE_ADDR,
 220                                  enum language, struct objfile *);
 221
 222 extern void init_psymbol_list (struct objfile *, int);
 223
 224 extern struct partial_symtab *start_psymtab_common (struct objfile *,
 225                                                     struct section_offsets *,
 226                                                     const char *, CORE_ADDR,
 227                                                     struct partial_symbol **,
 228                                                     struct partial_symbol **);
 229
 230 extern struct partial_symtab *allocate_psymtab (const char *,
 231                                                 struct objfile *)
 232   ATTRIBUTE_NONNULL (1);
 233
 234 extern void discard_psymtab (struct objfile *, struct partial_symtab *);
 235
 236 extern struct cleanup *make_cleanup_discard_psymtabs (struct objfile *);
 237
 238 /* Traverse all psymtabs in one objfile.  */
 239
 240 #define ALL_OBJFILE_PSYMTABS(objfile, p) \
 241     for ((p) = (objfile) -> psymtabs; (p) != NULL; (p) = (p) -> next)
 242
 243 #endif /* PSYMPRIV_H */