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