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