contrib/gdb/gdb/symfile.h

   1 /* Definitions for reading symbol files into GDB.
   2    Copyright (C) 1990, 1991, 1992, 1993, 1994, 1996
   3    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 2 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, write to the Free Software
  19 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.  */
  20
  21 #if !defined (SYMFILE_H)
  22 #define SYMFILE_H
  23
  24 /* This file requires that you first include "bfd.h".  */
  25
  26 /* Partial symbols are stored in the psymbol_cache and pointers to them
  27    are kept in a dynamically grown array that is obtained from malloc and
  28    grown as necessary via realloc.  Each objfile typically has two of these,
  29    one for global symbols and one for static symbols.  Although this adds
  30    a level of indirection for storing or accessing the partial symbols,
  31    it allows us to throw away duplicate psymbols and set all pointers
  32    to the single saved instance. */
  33
  34 struct psymbol_allocation_list {
  35
  36   /* Pointer to beginning of dynamically allocated array of pointers to
  37    partial symbols.  The array is dynamically expanded as necessary to
  38    accommodate more pointers. */
  39
  40   struct partial_symbol **list;
  41
  42   /* Pointer to next available slot in which to store a pointer to a partial
  43      symbol. */
  44
  45   struct partial_symbol **next;
  46
  47   /* Number of allocated pointer slots in current dynamic array (not the
  48      number of bytes of storage).  The "next" pointer will always point
  49      somewhere between list[0] and list[size], and when at list[size] the
  50      array will be expanded on the next attempt to store a pointer. */
  51
  52   int size;
  53 };
  54
  55 /* Structure to keep track of symbol reading functions for various
  56    object file types.  */
  57
  58 struct sym_fns {
  59
  60   /* BFD flavour that we handle, or (as a special kludge, see xcoffread.c,
  61      (enum bfd_flavour)-1 for xcoff).  */
  62
  63   enum bfd_flavour sym_flavour;
  64
  65   /* Initializes anything that is global to the entire symbol table.  It is
  66      called during symbol_file_add, when we begin debugging an entirely new
  67      program. */
  68
  69   void (*sym_new_init) PARAMS ((struct objfile *));
  70
  71   /* Reads any initial information from a symbol file, and initializes the
  72      struct sym_fns SF in preparation for sym_read().  It is called every
  73      time we read a symbol file for any reason. */
  74
  75   void (*sym_init) PARAMS ((struct objfile *));
  76
  77   /* sym_read (objfile, addr, mainline)
  78      Reads a symbol file into a psymtab (or possibly a symtab).
  79      OBJFILE is the objfile struct for the file we are reading.
  80      SECTION_OFFSETS
  81      are the offset between the file's specified section addresses and
  82      their true addresses in memory.
  83      MAINLINE is 1 if this is the
  84      main symbol table being read, and 0 if a secondary
  85      symbol file (e.g. shared library or dynamically loaded file)
  86      is being read.  */
  87
  88   void (*sym_read) PARAMS ((struct objfile *, struct section_offsets *, int));
  89
  90   /* Called when we are finished with an objfile.  Should do all cleanup
  91      that is specific to the object file format for the particular objfile. */
  92
  93   void (*sym_finish) PARAMS ((struct objfile *));
  94
  95   /* This function produces a file-dependent section_offsets structure,
  96      allocated in the objfile's storage, and based on the parameter.
  97      The parameter is currently a CORE_ADDR (FIXME!) for backward compatibility
  98      with the higher levels of GDB.  It should probably be changed to
  99      a string, where NULL means the default, and others are parsed in a file
 100      dependent way.  The result of this function is handed in to sym_read.  */
 101
 102   struct section_offsets *(*sym_offsets) PARAMS ((struct objfile *, CORE_ADDR));
 103
 104   /* Finds the next struct sym_fns.  They are allocated and initialized
 105      in whatever module implements the functions pointed to; an
 106      initializer calls add_symtab_fns to add them to the global chain.  */
 107
 108   struct sym_fns *next;
 109
 110 };
 111
 112 /* The default version of sym_fns.sym_offsets for readers that don't
 113    do anything special.  */
 114
 115 extern struct section_offsets *
 116 default_symfile_offsets PARAMS ((struct objfile *objfile, CORE_ADDR addr));
 117
 118
 119 extern void
 120 extend_psymbol_list PARAMS ((struct psymbol_allocation_list *,
 121                              struct objfile *));
 122
 123 /* Add any kind of symbol to a psymbol_allocation_list. */
 124
 125 /* #include "demangle.h" */
 126
 127 extern void
 128 add_psymbol_to_list PARAMS ((char *, int, namespace_enum, enum address_class,
 129                              struct psymbol_allocation_list *, long, CORE_ADDR,
 130                              enum language, struct objfile *));
 131
 132 extern void
 133 add_psymbol_with_dem_name_to_list PARAMS ((char *, int, char *, int, namespace_enum,
 134                                            enum address_class,
 135                                            struct psymbol_allocation_list *,
 136                                            long, CORE_ADDR,
 137                                            enum language, struct objfile *));
 138
 139
 140 extern void init_psymbol_list PARAMS ((struct objfile *, int));
 141
 142 extern void
 143 sort_pst_symbols PARAMS ((struct partial_symtab *));
 144
 145 extern struct symtab *
 146 allocate_symtab PARAMS ((char *, struct objfile *));
 147
 148 extern int
 149 free_named_symtabs PARAMS ((char *));
 150
 151 extern void
 152 fill_in_vptr_fieldno PARAMS ((struct type *));
 153
 154 extern void
 155 add_symtab_fns PARAMS ((struct sym_fns *));
 156
 157 extern void
 158 init_entry_point_info PARAMS ((struct objfile *));
 159
 160 extern void
 161 syms_from_objfile PARAMS ((struct objfile *, CORE_ADDR, int, int));
 162
 163 extern void
 164 new_symfile_objfile PARAMS ((struct objfile *, int, int));
 165
 166 extern struct partial_symtab *
 167 start_psymtab_common PARAMS ((struct objfile *, struct section_offsets *,
 168                               char *, CORE_ADDR,
 169                               struct partial_symbol **,
 170                               struct partial_symbol **));
 171
 172 /* Sorting your symbols for fast lookup or alphabetical printing.  */
 173
 174 extern void
 175 sort_block_syms PARAMS ((struct block *));
 176
 177 extern void
 178 sort_symtab_syms PARAMS ((struct symtab *));
 179
 180 /* Make a copy of the string at PTR with SIZE characters in the symbol obstack
 181    (and add a null character at the end in the copy).
 182    Returns the address of the copy.  */
 183
 184 extern char *
 185 obsavestring PARAMS ((char *, int, struct obstack *));
 186
 187 /* Concatenate strings S1, S2 and S3; return the new string.
 188    Space is found in the symbol_obstack.  */
 189
 190 extern char *
 191 obconcat PARAMS ((struct obstack *obstackp, const char *, const char *,
 192                   const char *));
 193
 194                         /*   Variables   */
 195
 196 /* whether to auto load solibs at startup time:  0/1.
 197
 198    On all platforms, 0 means "don't auto load".
 199
 200    On HP-UX, > 0 means a threshhold, in megabytes, of symbol table which will
 201    be auto loaded.  When the cumulative size of solib symbol table exceeds
 202    this threshhold, solibs' symbol tables will not be loaded.
 203
 204    On other platforms, > 0 means, "always auto load".
 205    */
 206
 207 extern int auto_solib_add;
 208
 209 /* From symfile.c */
 210
 211 extern CORE_ADDR
 212 entry_point_address PARAMS ((void));
 213
 214 extern struct partial_symtab *
 215 allocate_psymtab PARAMS ((char *, struct objfile *));
 216
 217 extern void
 218 discard_psymtab PARAMS ((struct partial_symtab *));
 219
 220 extern void find_lowest_section PARAMS ((bfd *, asection *, PTR));
 221
 222 extern bfd * symfile_bfd_open PARAMS ((char *));
 223
 224 /* Remote targets may wish to use this as their load function.  */
 225 extern void generic_load PARAMS ((char *name, int from_tty));
 226
 227 /* Utility functions for overlay sections: */
 228 extern int overlay_debugging;
 229 extern int overlay_cache_invalid;
 230
 231 /* return the "mapped" overlay section  containing the PC */
 232 extern asection *
 233 find_pc_mapped_section PARAMS ((CORE_ADDR));
 234
 235 /* return any overlay section containing the PC (even in its LMA region) */
 236 extern asection *
 237 find_pc_overlay PARAMS ((CORE_ADDR));
 238
 239 /* return true if the section is an overlay */
 240 extern int
 241 section_is_overlay PARAMS ((asection *));
 242
 243 /* return true if the overlay section is currently "mapped" */
 244 extern int
 245 section_is_mapped PARAMS ((asection *));
 246
 247 /* return true if pc belongs to section's VMA */
 248 extern CORE_ADDR
 249 pc_in_mapped_range PARAMS ((CORE_ADDR, asection *));
 250
 251 /* return true if pc belongs to section's LMA */
 252 extern CORE_ADDR
 253 pc_in_unmapped_range PARAMS ((CORE_ADDR, asection *));
 254
 255 /* map an address from a section's LMA to its VMA */
 256 extern CORE_ADDR
 257 overlay_mapped_address PARAMS ((CORE_ADDR, asection *));
 258
 259 /* map an address from a section's VMA to its LMA */
 260 extern CORE_ADDR
 261 overlay_unmapped_address PARAMS ((CORE_ADDR, asection *));
 262
 263 /* convert an address in an overlay section (force into VMA range) */
 264 extern CORE_ADDR
 265 symbol_overlayed_address PARAMS ((CORE_ADDR, asection *));
 266
 267 /* From dwarfread.c */
 268
 269 extern void
 270 dwarf_build_psymtabs PARAMS ((struct objfile *, struct section_offsets *, int,
 271                               file_ptr, unsigned int, file_ptr, unsigned int));
 272
 273 /* From dwarf2read.c */
 274
 275 extern int dwarf2_has_info PARAMS ((bfd *abfd));
 276
 277 extern void dwarf2_build_psymtabs PARAMS ((struct objfile *,
 278                                            struct section_offsets *,
 279                                            int));
 280 /* From mdebugread.c */
 281
 282 /* Hack to force structures to exist before use in parameter list.  */
 283 struct ecoff_debug_hack
 284 {
 285   struct ecoff_debug_swap *a;
 286   struct ecoff_debug_info *b;
 287 };
 288 extern void
 289 mdebug_build_psymtabs PARAMS ((struct objfile *,
 290                                const struct ecoff_debug_swap *,
 291                                struct ecoff_debug_info *,
 292                                struct section_offsets *));
 293
 294 extern void
 295 elfmdebug_build_psymtabs PARAMS ((struct objfile *,
 296                                   const struct ecoff_debug_swap *,
 297                                   asection *,
 298                                   struct section_offsets *));
 299
 300 #endif  /* !defined(SYMFILE_H) */