gdb/symfile.h

   1 /* Definitions for reading symbol files into GDB.
   2
   3    Copyright (C) 1990, 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
   4    2000, 2001, 2002, 2003, 2004, 2007 Free Software Foundation, Inc.
   5
   6    This file is part of GDB.
   7
   8    This program is free software; you can redistribute it and/or modify
   9    it under the terms of the GNU General Public License as published by
  10    the Free Software Foundation; either version 2 of the License, or
  11    (at your option) any later version.
  12
  13    This program is distributed in the hope that it will be useful,
  14    but WITHOUT ANY WARRANTY; without even the implied warranty of
  15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16    GNU General Public License for more details.
  17
  18    You should have received a copy of the GNU General Public License
  19    along with this program; if not, write to the Free Software
  20    Foundation, Inc., 51 Franklin Street, Fifth Floor,
  21    Boston, MA 02110-1301, USA.  */
  22
  23 #if !defined (SYMFILE_H)
  24 #define SYMFILE_H
  25
  26 /* This file requires that you first include "bfd.h".  */
  27 #include "symtab.h"
  28
  29 /* Opaque declarations.  */
  30 struct section_table;
  31 struct objfile;
  32 struct obj_section;
  33 struct obstack;
  34 struct block;
  35
  36 /* Partial symbols are stored in the psymbol_cache and pointers to
  37    them are kept in a dynamically grown array that is obtained from
  38    malloc and grown as necessary via realloc.  Each objfile typically
  39    has two of these, one for global symbols and one for static
  40    symbols.  Although this adds a level of indirection for storing or
  41    accessing the partial symbols, it allows us to throw away duplicate
  42    psymbols and set all pointers to the single saved instance.  */
  43
  44 struct psymbol_allocation_list
  45 {
  46
  47   /* Pointer to beginning of dynamically allocated array of pointers
  48      to partial symbols.  The array is dynamically expanded as
  49      necessary to accommodate more pointers.  */
  50
  51   struct partial_symbol **list;
  52
  53   /* Pointer to next available slot in which to store a pointer to a
  54      partial symbol.  */
  55
  56   struct partial_symbol **next;
  57
  58   /* Number of allocated pointer slots in current dynamic array (not
  59      the number of bytes of storage).  The "next" pointer will always
  60      point somewhere between list[0] and list[size], and when at
  61      list[size] the array will be expanded on the next attempt to
  62      store a pointer.  */
  63
  64   int size;
  65 };
  66
  67 /* Define an array of addresses to accommodate non-contiguous dynamic
  68    loading of modules.  This is for use when entering commands, so we
  69    can keep track of the section names until we read the file and can
  70    map them to bfd sections.  This structure is also used by solib.c
  71    to communicate the section addresses in shared objects to
  72    symbol_file_add ().  */
  73
  74 struct section_addr_info
  75 {
  76   /* The number of sections for which address information is
  77      available.  */
  78   size_t num_sections;
  79   /* Sections whose names are file format dependent. */
  80   struct other_sections
  81   {
  82     CORE_ADDR addr;
  83     char *name;
  84     int sectindex;
  85   } other[1];
  86 };
  87
  88 /* Structure to keep track of symbol reading functions for various
  89    object file types.  */
  90
  91 struct sym_fns
  92 {
  93
  94   /* BFD flavour that we handle, or (as a special kludge, see
  95      xcoffread.c, (enum bfd_flavour)-1 for xcoff).  */
  96
  97   enum bfd_flavour sym_flavour;
  98
  99   /* Initializes anything that is global to the entire symbol table.
 100      It is called during symbol_file_add, when we begin debugging an
 101      entirely new program.  */
 102
 103   void (*sym_new_init) (struct objfile *);
 104
 105   /* Reads any initial information from a symbol file, and initializes
 106      the struct sym_fns SF in preparation for sym_read().  It is
 107      called every time we read a symbol file for any reason.  */
 108
 109   void (*sym_init) (struct objfile *);
 110
 111   /* sym_read (objfile, mainline) Reads a symbol file into a psymtab
 112      (or possibly a symtab).  OBJFILE is the objfile struct for the
 113      file we are reading.  MAINLINE is 1 if this is the main symbol
 114      table being read, and 0 if a secondary symbol file (e.g. shared
 115      library or dynamically loaded file) is being read.  */
 116
 117   void (*sym_read) (struct objfile *, int);
 118
 119   /* Called when we are finished with an objfile.  Should do all
 120      cleanup that is specific to the object file format for the
 121      particular objfile.  */
 122
 123   void (*sym_finish) (struct objfile *);
 124
 125   /* This function produces a file-dependent section_offsets
 126      structure, allocated in the objfile's storage, and based on the
 127      parameter.  The parameter is currently a CORE_ADDR (FIXME!) for
 128      backward compatibility with the higher levels of GDB.  It should
 129      probably be changed to a string, where NULL means the default,
 130      and others are parsed in a file dependent way.  */
 131
 132   void (*sym_offsets) (struct objfile *, struct section_addr_info *);
 133
 134   /* Finds the next struct sym_fns.  They are allocated and
 135      initialized in whatever module implements the functions pointed
 136      to; an initializer calls add_symtab_fns to add them to the global
 137      chain.  */
 138
 139   struct sym_fns *next;
 140
 141 };
 142
 143 /* The default version of sym_fns.sym_offsets for readers that don't
 144    do anything special.  */
 145
 146 extern void default_symfile_offsets (struct objfile *objfile,
 147                                      struct section_addr_info *);
 148
 149
 150 extern void extend_psymbol_list (struct psymbol_allocation_list *,
 151                                  struct objfile *);
 152
 153 /* Add any kind of symbol to a psymbol_allocation_list.  */
 154
 155 /* #include "demangle.h" */
 156
 157 extern const
 158 struct partial_symbol *add_psymbol_to_list (char *, int, domain_enum,
 159                                             enum address_class,
 160                                             struct psymbol_allocation_list *,
 161                                             long, CORE_ADDR,
 162                                             enum language, struct objfile *);
 163
 164 extern void init_psymbol_list (struct objfile *, int);
 165
 166 extern void sort_pst_symbols (struct partial_symtab *);
 167
 168 extern struct symtab *allocate_symtab (char *, struct objfile *);
 169
 170 extern int free_named_symtabs (char *);
 171
 172 extern void fill_in_vptr_fieldno (struct type *);
 173
 174 extern void add_symtab_fns (struct sym_fns *);
 175
 176 extern void syms_from_objfile (struct objfile *,
 177                                struct section_addr_info *,
 178                                struct section_offsets *, int, int, int);
 179
 180 extern void new_symfile_objfile (struct objfile *, int, int);
 181
 182 extern struct objfile *symbol_file_add (char *, int,
 183                                         struct section_addr_info *, int, int);
 184
 185 extern struct objfile *symbol_file_add_from_bfd (bfd *, int,
 186                                                  struct section_addr_info *,
 187                                                  int, int);
 188
 189 /* Create a new section_addr_info, with room for NUM_SECTIONS.  */
 190
 191 extern struct section_addr_info *alloc_section_addr_info (size_t
 192                                                           num_sections);
 193
 194 /* Return a freshly allocated copy of ADDRS.  The section names, if
 195    any, are also freshly allocated copies of those in ADDRS.  */
 196 extern struct section_addr_info *(copy_section_addr_info
 197                                   (struct section_addr_info *addrs));
 198
 199 /* Build (allocate and populate) a section_addr_info struct from an
 200    existing section table.  */
 201
 202 extern struct section_addr_info
 203   *build_section_addr_info_from_section_table (const struct section_table
 204                                                *start,
 205                                                const struct section_table
 206                                                *end);
 207
 208 /* Free all memory allocated by
 209    build_section_addr_info_from_section_table.  */
 210
 211 extern void free_section_addr_info (struct section_addr_info *);
 212
 213
 214 extern struct partial_symtab *start_psymtab_common (struct objfile *,
 215                                                     struct section_offsets *,
 216                                                     char *, CORE_ADDR,
 217                                                     struct partial_symbol **,
 218                                                     struct partial_symbol **);
 219
 220 /* Make a copy of the string at PTR with SIZE characters in the symbol
 221    obstack (and add a null character at the end in the copy).  Returns
 222    the address of the copy.  */
 223
 224 extern char *obsavestring (const char *, int, struct obstack *);
 225
 226 /* Concatenate strings S1, S2 and S3; return the new string.  Space is
 227    found in the OBSTACKP  */
 228
 229 extern char *obconcat (struct obstack *obstackp, const char *, const char *,
 230                        const char *);
 231
 232                         /*   Variables   */
 233
 234 /* If non-zero, shared library symbols will be added automatically
 235    when the inferior is created, new libraries are loaded, or when
 236    attaching to the inferior.  This is almost always what users will
 237    want to have happen; but for very large programs, the startup time
 238    will be excessive, and so if this is a problem, the user can clear
 239    this flag and then add the shared library symbols as needed.  Note
 240    that there is a potential for confusion, since if the shared
 241    library symbols are not loaded, commands like "info fun" will *not*
 242    report all the functions that are actually present.  */
 243
 244 extern int auto_solib_add;
 245
 246 /* For systems that support it, a threshold size in megabytes.  If
 247    automatically adding a new library's symbol table to those already
 248    known to the debugger would cause the total shared library symbol
 249    size to exceed this threshhold, then the shlib's symbols are not
 250    added.  The threshold is ignored if the user explicitly asks for a
 251    shlib to be added, such as when using the "sharedlibrary" command.  */
 252
 253 extern int auto_solib_limit;
 254
 255 /* From symfile.c */
 256
 257 extern struct partial_symtab *allocate_psymtab (char *, struct objfile *);
 258
 259 extern void discard_psymtab (struct partial_symtab *);
 260
 261 extern void find_lowest_section (bfd *, asection *, void *);
 262
 263 extern bfd *symfile_bfd_open (char *);
 264
 265 extern int get_section_index (struct objfile *, char *);
 266
 267 /* Utility functions for overlay sections: */
 268 extern enum overlay_debugging_state
 269 {
 270   ovly_off,
 271   ovly_on,
 272   ovly_auto
 273 } overlay_debugging;
 274 extern int overlay_cache_invalid;
 275
 276 /* Return the "mapped" overlay section containing the PC.  */
 277 extern asection *find_pc_mapped_section (CORE_ADDR);
 278
 279 /* Return any overlay section containing the PC (even in its LMA
 280    region).  */
 281 extern asection *find_pc_overlay (CORE_ADDR);
 282
 283 /* Return true if the section is an overlay.  */
 284 extern int section_is_overlay (asection *);
 285
 286 /* Return true if the overlay section is currently "mapped".  */
 287 extern int section_is_mapped (asection *);
 288
 289 /* Return true if pc belongs to section's VMA.  */
 290 extern CORE_ADDR pc_in_mapped_range (CORE_ADDR, asection *);
 291
 292 /* Return true if pc belongs to section's LMA.  */
 293 extern CORE_ADDR pc_in_unmapped_range (CORE_ADDR, asection *);
 294
 295 /* Map an address from a section's LMA to its VMA.  */
 296 extern CORE_ADDR overlay_mapped_address (CORE_ADDR, asection *);
 297
 298 /* Map an address from a section's VMA to its LMA.  */
 299 extern CORE_ADDR overlay_unmapped_address (CORE_ADDR, asection *);
 300
 301 /* Convert an address in an overlay section (force into VMA range).  */
 302 extern CORE_ADDR symbol_overlayed_address (CORE_ADDR, asection *);
 303
 304 /* Load symbols from a file.  */
 305 extern void symbol_file_add_main (char *args, int from_tty);
 306
 307 /* Clear GDB symbol tables.  */
 308 extern void symbol_file_clear (int from_tty);
 309
 310 /* Default overlay update function.  */
 311 extern void simple_overlay_update (struct obj_section *);
 312
 313 extern bfd_byte *symfile_relocate_debug_section (bfd *abfd, asection *sectp,
 314                                                  bfd_byte * buf);
 315
 316 /* From dwarf2read.c */
 317
 318 extern int dwarf2_has_info (struct objfile *);
 319
 320 extern void dwarf2_build_psymtabs (struct objfile *, int);
 321 extern void dwarf2_build_frame_info (struct objfile *);
 322
 323 /* From mdebugread.c */
 324
 325 /* Hack to force structures to exist before use in parameter list.  */
 326 struct ecoff_debug_hack
 327 {
 328   struct ecoff_debug_swap *a;
 329   struct ecoff_debug_info *b;
 330 };
 331
 332 extern void mdebug_build_psymtabs (struct objfile *,
 333                                    const struct ecoff_debug_swap *,
 334                                    struct ecoff_debug_info *);
 335
 336 extern void elfmdebug_build_psymtabs (struct objfile *,
 337                                       const struct ecoff_debug_swap *,
 338                                       asection *);
 339
 340 #endif /* !defined(SYMFILE_H) */