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 add_psymbol_with_dem_name_to_list (char *, int, char *, int,
 164                                                domain_enum,
 165                                                enum address_class,
 166                                                struct psymbol_allocation_list
 167                                                *, long, CORE_ADDR,
 168                                                enum language,
 169                                                struct objfile *);
 170
 171
 172 extern void init_psymbol_list (struct objfile *, int);
 173
 174 extern void sort_pst_symbols (struct partial_symtab *);
 175
 176 extern struct symtab *allocate_symtab (char *, struct objfile *);
 177
 178 extern int free_named_symtabs (char *);
 179
 180 extern void fill_in_vptr_fieldno (struct type *);
 181
 182 extern void add_symtab_fns (struct sym_fns *);
 183
 184 extern void syms_from_objfile (struct objfile *,
 185                                struct section_addr_info *,
 186                                struct section_offsets *, int, int, int);
 187
 188 extern void new_symfile_objfile (struct objfile *, int, int);
 189
 190 extern struct objfile *symbol_file_add (char *, int,
 191                                         struct section_addr_info *, int, int);
 192
 193 extern struct objfile *symbol_file_add_from_bfd (bfd *, int,
 194                                                  struct section_addr_info *,
 195                                                  int, int);
 196
 197 /* Create a new section_addr_info, with room for NUM_SECTIONS.  */
 198
 199 extern struct section_addr_info *alloc_section_addr_info (size_t
 200                                                           num_sections);
 201
 202 /* Return a freshly allocated copy of ADDRS.  The section names, if
 203    any, are also freshly allocated copies of those in ADDRS.  */
 204 extern struct section_addr_info *(copy_section_addr_info
 205                                   (struct section_addr_info *addrs));
 206
 207 /* Build (allocate and populate) a section_addr_info struct from an
 208    existing section table.  */
 209
 210 extern struct section_addr_info
 211   *build_section_addr_info_from_section_table (const struct section_table
 212                                                *start,
 213                                                const struct section_table
 214                                                *end);
 215
 216 /* Free all memory allocated by
 217    build_section_addr_info_from_section_table.  */
 218
 219 extern void free_section_addr_info (struct section_addr_info *);
 220
 221
 222 extern struct partial_symtab *start_psymtab_common (struct objfile *,
 223                                                     struct section_offsets *,
 224                                                     char *, CORE_ADDR,
 225                                                     struct partial_symbol **,
 226                                                     struct partial_symbol **);
 227
 228 /* Make a copy of the string at PTR with SIZE characters in the symbol
 229    obstack (and add a null character at the end in the copy).  Returns
 230    the address of the copy.  */
 231
 232 extern char *obsavestring (const char *, int, struct obstack *);
 233
 234 /* Concatenate strings S1, S2 and S3; return the new string.  Space is
 235    found in the OBSTACKP  */
 236
 237 extern char *obconcat (struct obstack *obstackp, const char *, const char *,
 238                        const char *);
 239
 240                         /*   Variables   */
 241
 242 /* If non-zero, shared library symbols will be added automatically
 243    when the inferior is created, new libraries are loaded, or when
 244    attaching to the inferior.  This is almost always what users will
 245    want to have happen; but for very large programs, the startup time
 246    will be excessive, and so if this is a problem, the user can clear
 247    this flag and then add the shared library symbols as needed.  Note
 248    that there is a potential for confusion, since if the shared
 249    library symbols are not loaded, commands like "info fun" will *not*
 250    report all the functions that are actually present.  */
 251
 252 extern int auto_solib_add;
 253
 254 /* For systems that support it, a threshold size in megabytes.  If
 255    automatically adding a new library's symbol table to those already
 256    known to the debugger would cause the total shared library symbol
 257    size to exceed this threshhold, then the shlib's symbols are not
 258    added.  The threshold is ignored if the user explicitly asks for a
 259    shlib to be added, such as when using the "sharedlibrary" command.  */
 260
 261 extern int auto_solib_limit;
 262
 263 /* From symfile.c */
 264
 265 extern struct partial_symtab *allocate_psymtab (char *, struct objfile *);
 266
 267 extern void discard_psymtab (struct partial_symtab *);
 268
 269 extern void find_lowest_section (bfd *, asection *, void *);
 270
 271 extern bfd *symfile_bfd_open (char *);
 272
 273 extern int get_section_index (struct objfile *, char *);
 274
 275 /* Utility functions for overlay sections: */
 276 extern enum overlay_debugging_state
 277 {
 278   ovly_off,
 279   ovly_on,
 280   ovly_auto
 281 } overlay_debugging;
 282 extern int overlay_cache_invalid;
 283
 284 /* Return the "mapped" overlay section containing the PC.  */
 285 extern asection *find_pc_mapped_section (CORE_ADDR);
 286
 287 /* Return any overlay section containing the PC (even in its LMA
 288    region).  */
 289 extern asection *find_pc_overlay (CORE_ADDR);
 290
 291 /* Return true if the section is an overlay.  */
 292 extern int section_is_overlay (asection *);
 293
 294 /* Return true if the overlay section is currently "mapped".  */
 295 extern int section_is_mapped (asection *);
 296
 297 /* Return true if pc belongs to section's VMA.  */
 298 extern CORE_ADDR pc_in_mapped_range (CORE_ADDR, asection *);
 299
 300 /* Return true if pc belongs to section's LMA.  */
 301 extern CORE_ADDR pc_in_unmapped_range (CORE_ADDR, asection *);
 302
 303 /* Map an address from a section's LMA to its VMA.  */
 304 extern CORE_ADDR overlay_mapped_address (CORE_ADDR, asection *);
 305
 306 /* Map an address from a section's VMA to its LMA.  */
 307 extern CORE_ADDR overlay_unmapped_address (CORE_ADDR, asection *);
 308
 309 /* Convert an address in an overlay section (force into VMA range).  */
 310 extern CORE_ADDR symbol_overlayed_address (CORE_ADDR, asection *);
 311
 312 /* Load symbols from a file.  */
 313 extern void symbol_file_add_main (char *args, int from_tty);
 314
 315 /* Clear GDB symbol tables.  */
 316 extern void symbol_file_clear (int from_tty);
 317
 318 extern bfd_byte *symfile_relocate_debug_section (bfd *abfd, asection *sectp,
 319                                                  bfd_byte * buf);
 320
 321 /* From dwarfread.c */
 322
 323 extern void dwarf_build_psymtabs (struct objfile *, int, file_ptr,
 324                                   unsigned int, file_ptr, unsigned int);
 325
 326 /* From dwarf2read.c */
 327
 328 extern int dwarf2_has_info (struct objfile *);
 329
 330 extern void dwarf2_build_psymtabs (struct objfile *, int);
 331 extern void dwarf2_build_frame_info (struct objfile *);
 332
 333 /* From mdebugread.c */
 334
 335 /* Hack to force structures to exist before use in parameter list.  */
 336 struct ecoff_debug_hack
 337 {
 338   struct ecoff_debug_swap *a;
 339   struct ecoff_debug_info *b;
 340 };
 341
 342 extern void mdebug_build_psymtabs (struct objfile *,
 343                                    const struct ecoff_debug_swap *,
 344                                    struct ecoff_debug_info *);
 345
 346 extern void elfmdebug_build_psymtabs (struct objfile *,
 347                                       const struct ecoff_debug_swap *,
 348                                       asection *);
 349
 350 #endif /* !defined(SYMFILE_H) */