gdb/psympriv.h

   1 /* Private partial symbol table definitions.
   2
   3    Copyright (C) 2009-2014 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      This is typically objfile->section_offsets, but in some cases
 103      it's different.  See, e.g., elfstab_offset_sections.  */
 104
 105   struct section_offsets *section_offsets;
 106
 107   /* Range of text addresses covered by this file; texthigh is the
 108      beginning of the next section.  Do not use if PSYMTABS_ADDRMAP_SUPPORTED
 109      is set.  */
 110
 111   CORE_ADDR textlow;
 112   CORE_ADDR texthigh;
 113
 114   /* If NULL, this is an ordinary partial symbol table.
 115
 116      If non-NULL, this holds a single includer of this partial symbol
 117      table, and this partial symbol table is a shared one.
 118
 119      A shared psymtab is one that is referenced by multiple other
 120      psymtabs, and which conceptually has its contents directly
 121      included in those.
 122
 123      Shared psymtabs have special semantics.  When a search finds a
 124      symbol in a shared table, we instead return one of the non-shared
 125      tables that include this one.
 126
 127      A shared psymtabs can be referred to by other shared ones.
 128
 129      The psymtabs that refer to a shared psymtab will list the shared
 130      psymtab in their 'dependencies' array.
 131
 132      In DWARF terms, a shared psymtab is a DW_TAG_partial_unit; but
 133      of course using a name based on that would be too confusing, so
 134      "shared" was chosen instead.
 135
 136      Only a single user is needed because, when expanding a shared
 137      psymtab, we only need to expand its "canonical" non-shared user.
 138      The choice of which one should be canonical is left to the
 139      debuginfo reader; it can be arbitrary.  */
 140
 141   struct partial_symtab *user;
 142
 143   /* Array of pointers to all of the partial_symtab's which this one
 144      depends on.  Since this array can only be set to previous or
 145      the current (?) psymtab, this dependency tree is guaranteed not
 146      to have any loops.  "depends on" means that symbols must be read
 147      for the dependencies before being read for this psymtab; this is
 148      for type references in stabs, where if foo.c includes foo.h, declarations
 149      in foo.h may use type numbers defined in foo.c.  For other debugging
 150      formats there may be no need to use dependencies.  */
 151
 152   struct partial_symtab **dependencies;
 153
 154   int number_of_dependencies;
 155
 156   /* Global symbol list.  This list will be sorted after readin to
 157      improve access.  Binary search will be the usual method of
 158      finding a symbol within it.  globals_offset is an integer offset
 159      within global_psymbols[].  */
 160
 161   int globals_offset;
 162   int n_global_syms;
 163
 164   /* Static symbol list.  This list will *not* be sorted after readin;
 165      to find a symbol in it, exhaustive search must be used.  This is
 166      reasonable because searches through this list will eventually
 167      lead to either the read in of a files symbols for real (assumed
 168      to take a *lot* of time; check) or an error (and we don't care
 169      how long errors take).  This is an offset and size within
 170      static_psymbols[].  */
 171
 172   int statics_offset;
 173   int n_static_syms;
 174
 175   /* Non-zero if the symtab corresponding to this psymtab has been
 176      readin.  This is located here so that this structure packs better
 177      on 64-bit systems.  */
 178
 179   unsigned char readin;
 180
 181   /* True iff objfile->psymtabs_addrmap is properly populated for this
 182      partial_symtab.  For discontiguous overlapping psymtabs is the only usable
 183      info in PSYMTABS_ADDRMAP.  */
 184
 185   unsigned char psymtabs_addrmap_supported;
 186
 187   /* True if the name of this partial symtab is not a source file name.  */
 188
 189   unsigned char anonymous;
 190
 191   /* A flag that is temporarily used when searching psymtabs.  */
 192
 193   ENUM_BITFIELD (psymtab_search_status) searched_flag : 2;
 194
 195   /* Pointer to symtab eventually allocated for this source file, 0 if
 196      !readin or if we haven't looked for the symtab after it was readin.  */
 197
 198   struct symtab *symtab;
 199
 200   /* Pointer to function which will read in the symtab corresponding to
 201      this psymtab.  */
 202
 203   void (*read_symtab) (struct partial_symtab *, struct objfile *);
 204
 205   /* Information that lets read_symtab() locate the part of the symbol table
 206      that this psymtab corresponds to.  This information is private to the
 207      format-dependent symbol reading routines.  For further detail examine
 208      the various symbol reading modules.  */
 209
 210   void *read_symtab_private;
 211 };
 212
 213 extern void sort_pst_symbols (struct objfile *, struct partial_symtab *);
 214
 215 /* Add any kind of symbol to a psymbol_allocation_list.  */
 216
 217 extern void add_psymbol_to_list (const char *, int,
 218                                  int, domain_enum,
 219                                  enum address_class,
 220                                  struct psymbol_allocation_list *,
 221                                  long, CORE_ADDR,
 222                                  enum language, struct objfile *);
 223
 224 extern void init_psymbol_list (struct objfile *, int);
 225
 226 extern struct partial_symtab *start_psymtab_common (struct objfile *,
 227                                                     struct section_offsets *,
 228                                                     const char *, CORE_ADDR,
 229                                                     struct partial_symbol **,
 230                                                     struct partial_symbol **);
 231
 232 extern struct partial_symtab *allocate_psymtab (const char *,
 233                                                 struct objfile *)
 234   ATTRIBUTE_NONNULL (1);
 235
 236 extern void discard_psymtab (struct objfile *, struct partial_symtab *);
 237
 238 extern struct cleanup *make_cleanup_discard_psymtabs (struct objfile *);
 239
 240 /* Traverse all psymtabs in one objfile.  */
 241
 242 #define ALL_OBJFILE_PSYMTABS(objfile, p) \
 243     for ((p) = (objfile) -> psymtabs; (p) != NULL; (p) = (p) -> next)
 244
 245 #endif /* PSYMPRIV_H */