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