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, 2008, 2009, 2010
   5    Free Software Foundation, Inc.
   6
   7    This file is part of GDB.
   8
   9    This program is free software; you can redistribute it and/or modify
  10    it under the terms of the GNU General Public License as published by
  11    the Free Software Foundation; either version 3 of the License, or
  12    (at your option) any later version.
  13
  14    This program is distributed in the hope that it will be useful,
  15    but WITHOUT ANY WARRANTY; without even the implied warranty of
  16    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17    GNU General Public License for more details.
  18
  19    You should have received a copy of the GNU General Public License
  20    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  21
  22 #if !defined (SYMFILE_H)
  23 #define SYMFILE_H
  24
  25 /* This file requires that you first include "bfd.h".  */
  26 #include "symtab.h"
  27
  28 /* Opaque declarations.  */
  29 struct target_section;
  30 struct objfile;
  31 struct obj_section;
  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
  88 /* A table listing the load segments in a symfile, and which segment
  89    each BFD section belongs to.  */
  90 struct symfile_segment_data
  91 {
  92   /* How many segments are present in this file.  If there are
  93      two, the text segment is the first one and the data segment
  94      is the second one.  */
  95   int num_segments;
  96
  97   /* If NUM_SEGMENTS is greater than zero, the original base address
  98      of each segment.  */
  99   CORE_ADDR *segment_bases;
 100
 101   /* If NUM_SEGMENTS is greater than zero, the memory size of each
 102      segment.  */
 103   CORE_ADDR *segment_sizes;
 104
 105   /* If NUM_SEGMENTS is greater than zero, this is an array of entries
 106      recording which segment contains each BFD section.
 107      SEGMENT_INFO[I] is S+1 if the I'th BFD section belongs to segment
 108      S, or zero if it is not in any segment.  */
 109   int *segment_info;
 110 };
 111
 112 /* Structure to keep track of symbol reading functions for various
 113    object file types.  */
 114
 115 struct sym_fns
 116 {
 117
 118   /* BFD flavour that we handle, or (as a special kludge, see
 119      xcoffread.c, (enum bfd_flavour)-1 for xcoff).  */
 120
 121   enum bfd_flavour sym_flavour;
 122
 123   /* Initializes anything that is global to the entire symbol table.
 124      It is called during symbol_file_add, when we begin debugging an
 125      entirely new program.  */
 126
 127   void (*sym_new_init) (struct objfile *);
 128
 129   /* Reads any initial information from a symbol file, and initializes
 130      the struct sym_fns SF in preparation for sym_read().  It is
 131      called every time we read a symbol file for any reason.  */
 132
 133   void (*sym_init) (struct objfile *);
 134
 135   /* sym_read (objfile, symfile_flags) Reads a symbol file into a psymtab
 136      (or possibly a symtab).  OBJFILE is the objfile struct for the
 137      file we are reading.  SYMFILE_FLAGS are the flags passed to
 138      symbol_file_add & co.  */
 139
 140   void (*sym_read) (struct objfile *, int);
 141
 142   /* Called when we are finished with an objfile.  Should do all
 143      cleanup that is specific to the object file format for the
 144      particular objfile.  */
 145
 146   void (*sym_finish) (struct objfile *);
 147
 148   /* This function produces a file-dependent section_offsets
 149      structure, allocated in the objfile's storage, and based on the
 150      parameter.  The parameter is currently a CORE_ADDR (FIXME!) for
 151      backward compatibility with the higher levels of GDB.  It should
 152      probably be changed to a string, where NULL means the default,
 153      and others are parsed in a file dependent way.  */
 154
 155   void (*sym_offsets) (struct objfile *, struct section_addr_info *);
 156
 157   /* This function produces a format-independent description of
 158      the segments of ABFD.  Each segment is a unit of the file
 159      which may be relocated independently.  */
 160
 161   struct symfile_segment_data *(*sym_segments) (bfd *abfd);
 162
 163   /* This function should read the linetable from the objfile when
 164      the line table cannot be read while processing the debugging
 165      information.  */
 166   void (*sym_read_linetable) (void);
 167
 168   /* Finds the next struct sym_fns.  They are allocated and
 169      initialized in whatever module implements the functions pointed
 170      to; an initializer calls add_symtab_fns to add them to the global
 171      chain.  */
 172
 173   struct sym_fns *next;
 174
 175 };
 176
 177 /* The default version of sym_fns.sym_offsets for readers that don't
 178    do anything special.  */
 179
 180 extern void default_symfile_offsets (struct objfile *objfile,
 181                                      struct section_addr_info *);
 182
 183 /* The default version of sym_fns.sym_segments for readers that don't
 184    do anything special.  */
 185
 186 extern struct symfile_segment_data *default_symfile_segments (bfd *abfd);
 187
 188 extern void extend_psymbol_list (struct psymbol_allocation_list *,
 189                                  struct objfile *);
 190
 191 /* Add any kind of symbol to a psymbol_allocation_list.  */
 192
 193 /* #include "demangle.h" */
 194
 195 extern const
 196 struct partial_symbol *add_psymbol_to_list (char *, int, int, domain_enum,
 197                                             enum address_class,
 198                                             struct psymbol_allocation_list *,
 199                                             long, CORE_ADDR,
 200                                             enum language, struct objfile *);
 201
 202 extern void init_psymbol_list (struct objfile *, int);
 203
 204 extern void sort_pst_symbols (struct partial_symtab *);
 205
 206 extern struct symtab *allocate_symtab (char *, struct objfile *);
 207
 208 extern int free_named_symtabs (char *);
 209
 210 extern void add_symtab_fns (struct sym_fns *);
 211
 212 /* This enum encodes bit-flags passed as ADD_FLAGS parameter to
 213    syms_from_objfile, symbol_file_add, etc.  */
 214
 215 enum symfile_add_flags
 216   {
 217     /* Be chatty about what you are doing.  */
 218     SYMFILE_VERBOSE = 1 << 1,
 219
 220     /* This is the main symbol file (as opposed to symbol file for dynamically
 221        loaded code).  */
 222     SYMFILE_MAINLINE = 1 << 2,
 223
 224     /* Do not call breakpoint_re_set when adding this symbol file.  */
 225     SYMFILE_DEFER_BP_RESET = 1 << 3
 226   };
 227
 228 extern void syms_from_objfile (struct objfile *,
 229                                struct section_addr_info *,
 230                                struct section_offsets *, int, int);
 231
 232 extern void new_symfile_objfile (struct objfile *, int);
 233
 234 extern struct objfile *symbol_file_add (char *, int,
 235                                         struct section_addr_info *, int);
 236
 237 extern struct objfile *symbol_file_add_from_bfd (bfd *, int,
 238                                                  struct section_addr_info *,
 239                                                  int);
 240
 241 extern void symbol_file_add_separate (bfd *, int, struct objfile *);
 242
 243 extern char *find_separate_debug_file_by_debuglink (struct objfile *);
 244
 245 /* Create a new section_addr_info, with room for NUM_SECTIONS.  */
 246
 247 extern struct section_addr_info *alloc_section_addr_info (size_t
 248                                                           num_sections);
 249
 250 /* Return a freshly allocated copy of ADDRS.  The section names, if
 251    any, are also freshly allocated copies of those in ADDRS.  */
 252 extern struct section_addr_info *(copy_section_addr_info
 253                                   (struct section_addr_info *addrs));
 254
 255 /* Build (allocate and populate) a section_addr_info struct from an
 256    existing section table.  */
 257
 258 extern struct section_addr_info
 259   *build_section_addr_info_from_section_table (const struct target_section
 260                                                *start,
 261                                                const struct target_section
 262                                                *end);
 263
 264 /* Free all memory allocated by
 265    build_section_addr_info_from_section_table.  */
 266
 267 extern void free_section_addr_info (struct section_addr_info *);
 268
 269
 270 extern struct partial_symtab *start_psymtab_common (struct objfile *,
 271                                                     struct section_offsets *,
 272                                                     const char *, CORE_ADDR,
 273                                                     struct partial_symbol **,
 274                                                     struct partial_symbol **);
 275
 276 /* Make a copy of the string at PTR with SIZE characters in the symbol
 277    obstack (and add a null character at the end in the copy).  Returns
 278    the address of the copy.  */
 279
 280 extern char *obsavestring (const char *, int, struct obstack *);
 281
 282 /* Concatenate strings S1, S2 and S3; return the new string.  Space is
 283    found in the OBSTACKP  */
 284
 285 extern char *obconcat (struct obstack *obstackp, const char *, const char *,
 286                        const char *);
 287
 288                         /*   Variables   */
 289
 290 /* If non-zero, shared library symbols will be added automatically
 291    when the inferior is created, new libraries are loaded, or when
 292    attaching to the inferior.  This is almost always what users will
 293    want to have happen; but for very large programs, the startup time
 294    will be excessive, and so if this is a problem, the user can clear
 295    this flag and then add the shared library symbols as needed.  Note
 296    that there is a potential for confusion, since if the shared
 297    library symbols are not loaded, commands like "info fun" will *not*
 298    report all the functions that are actually present.  */
 299
 300 extern int auto_solib_add;
 301
 302 /* For systems that support it, a threshold size in megabytes.  If
 303    automatically adding a new library's symbol table to those already
 304    known to the debugger would cause the total shared library symbol
 305    size to exceed this threshhold, then the shlib's symbols are not
 306    added.  The threshold is ignored if the user explicitly asks for a
 307    shlib to be added, such as when using the "sharedlibrary" command.  */
 308
 309 extern int auto_solib_limit;
 310
 311 /* From symfile.c */
 312
 313 extern void set_initial_language (void);
 314
 315 extern struct partial_symtab *allocate_psymtab (const char *,
 316                                                 struct objfile *);
 317
 318 extern void discard_psymtab (struct partial_symtab *);
 319
 320 extern void find_lowest_section (bfd *, asection *, void *);
 321
 322 extern bfd *symfile_bfd_open (char *);
 323
 324 extern bfd *bfd_open_maybe_remote (const char *);
 325
 326 extern int get_section_index (struct objfile *, char *);
 327
 328 /* Utility functions for overlay sections: */
 329 extern enum overlay_debugging_state
 330 {
 331   ovly_off,
 332   ovly_on,
 333   ovly_auto
 334 } overlay_debugging;
 335 extern int overlay_cache_invalid;
 336
 337 /* Return the "mapped" overlay section containing the PC.  */
 338 extern struct obj_section *find_pc_mapped_section (CORE_ADDR);
 339
 340 /* Return any overlay section containing the PC (even in its LMA
 341    region).  */
 342 extern struct obj_section *find_pc_overlay (CORE_ADDR);
 343
 344 /* Return true if the section is an overlay.  */
 345 extern int section_is_overlay (struct obj_section *);
 346
 347 /* Return true if the overlay section is currently "mapped".  */
 348 extern int section_is_mapped (struct obj_section *);
 349
 350 /* Return true if pc belongs to section's VMA.  */
 351 extern CORE_ADDR pc_in_mapped_range (CORE_ADDR, struct obj_section *);
 352
 353 /* Return true if pc belongs to section's LMA.  */
 354 extern CORE_ADDR pc_in_unmapped_range (CORE_ADDR, struct obj_section *);
 355
 356 /* Map an address from a section's LMA to its VMA.  */
 357 extern CORE_ADDR overlay_mapped_address (CORE_ADDR, struct obj_section *);
 358
 359 /* Map an address from a section's VMA to its LMA.  */
 360 extern CORE_ADDR overlay_unmapped_address (CORE_ADDR, struct obj_section *);
 361
 362 /* Convert an address in an overlay section (force into VMA range).  */
 363 extern CORE_ADDR symbol_overlayed_address (CORE_ADDR, struct obj_section *);
 364
 365 /* Load symbols from a file.  */
 366 extern void symbol_file_add_main (char *args, int from_tty);
 367
 368 /* Clear GDB symbol tables.  */
 369 extern void symbol_file_clear (int from_tty);
 370
 371 /* Default overlay update function.  */
 372 extern void simple_overlay_update (struct obj_section *);
 373
 374 extern bfd_byte *symfile_relocate_debug_section (bfd *abfd, asection *sectp,
 375                                                  bfd_byte * buf);
 376
 377 extern int symfile_map_offsets_to_segments (bfd *,
 378                                             struct symfile_segment_data *,
 379                                             struct section_offsets *,
 380                                             int, const CORE_ADDR *);
 381 struct symfile_segment_data *get_symfile_segment_data (bfd *abfd);
 382 void free_symfile_segment_data (struct symfile_segment_data *data);
 383
 384 /* From dwarf2read.c */
 385
 386 extern int dwarf2_has_info (struct objfile *);
 387
 388 extern void dwarf2_build_psymtabs (struct objfile *);
 389 extern void dwarf2_build_frame_info (struct objfile *);
 390
 391 void dwarf2_free_objfile (struct objfile *);
 392
 393 /* From mdebugread.c */
 394
 395 /* Hack to force structures to exist before use in parameter list.  */
 396 struct ecoff_debug_hack
 397 {
 398   struct ecoff_debug_swap *a;
 399   struct ecoff_debug_info *b;
 400 };
 401
 402 extern void mdebug_build_psymtabs (struct objfile *,
 403                                    const struct ecoff_debug_swap *,
 404                                    struct ecoff_debug_info *);
 405
 406 extern void elfmdebug_build_psymtabs (struct objfile *,
 407                                       const struct ecoff_debug_swap *,
 408                                       asection *);
 409
 410 #endif /* !defined(SYMFILE_H) */