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 extern struct section_addr_info *
 178            build_section_addr_info_from_objfile (const struct objfile *objfile);
 179
 180 extern void relative_addr_info_to_section_offsets
 181   (struct section_offsets *section_offsets, int num_sections,
 182    struct section_addr_info *addrs);
 183
 184 extern void addr_info_make_relative (struct section_addr_info *addrs,
 185                                      bfd *abfd);
 186
 187 /* The default version of sym_fns.sym_offsets for readers that don't
 188    do anything special.  */
 189
 190 extern void default_symfile_offsets (struct objfile *objfile,
 191                                      struct section_addr_info *);
 192
 193 /* The default version of sym_fns.sym_segments for readers that don't
 194    do anything special.  */
 195
 196 extern struct symfile_segment_data *default_symfile_segments (bfd *abfd);
 197
 198 extern void extend_psymbol_list (struct psymbol_allocation_list *,
 199                                  struct objfile *);
 200
 201 /* Add any kind of symbol to a psymbol_allocation_list.  */
 202
 203 /* #include "demangle.h" */
 204
 205 extern const
 206 struct partial_symbol *add_psymbol_to_list (char *, int, int, domain_enum,
 207                                             enum address_class,
 208                                             struct psymbol_allocation_list *,
 209                                             long, CORE_ADDR,
 210                                             enum language, struct objfile *);
 211
 212 extern void init_psymbol_list (struct objfile *, int);
 213
 214 extern void sort_pst_symbols (struct partial_symtab *);
 215
 216 extern struct symtab *allocate_symtab (char *, struct objfile *);
 217
 218 extern void add_symtab_fns (struct sym_fns *);
 219
 220 /* This enum encodes bit-flags passed as ADD_FLAGS parameter to
 221    syms_from_objfile, symbol_file_add, etc.  */
 222
 223 enum symfile_add_flags
 224   {
 225     /* Be chatty about what you are doing.  */
 226     SYMFILE_VERBOSE = 1 << 1,
 227
 228     /* This is the main symbol file (as opposed to symbol file for dynamically
 229        loaded code).  */
 230     SYMFILE_MAINLINE = 1 << 2,
 231
 232     /* Do not call breakpoint_re_set when adding this symbol file.  */
 233     SYMFILE_DEFER_BP_RESET = 1 << 3
 234   };
 235
 236 extern void syms_from_objfile (struct objfile *,
 237                                struct section_addr_info *,
 238                                struct section_offsets *, int, int);
 239
 240 extern void new_symfile_objfile (struct objfile *, int);
 241
 242 extern struct objfile *symbol_file_add (char *, int,
 243                                         struct section_addr_info *, int);
 244
 245 extern struct objfile *symbol_file_add_from_bfd (bfd *, int,
 246                                                  struct section_addr_info *,
 247                                                  int);
 248
 249 extern void symbol_file_add_separate (bfd *, int, struct objfile *);
 250
 251 extern char *find_separate_debug_file_by_debuglink (struct objfile *);
 252
 253 /* Create a new section_addr_info, with room for NUM_SECTIONS.  */
 254
 255 extern struct section_addr_info *alloc_section_addr_info (size_t
 256                                                           num_sections);
 257
 258 /* Build (allocate and populate) a section_addr_info struct from an
 259    existing section table.  */
 260
 261 extern struct section_addr_info
 262   *build_section_addr_info_from_section_table (const struct target_section
 263                                                *start,
 264                                                const struct target_section
 265                                                *end);
 266
 267 /* Free all memory allocated by
 268    build_section_addr_info_from_section_table.  */
 269
 270 extern void free_section_addr_info (struct section_addr_info *);
 271
 272
 273 extern struct partial_symtab *start_psymtab_common (struct objfile *,
 274                                                     struct section_offsets *,
 275                                                     const char *, CORE_ADDR,
 276                                                     struct partial_symbol **,
 277                                                     struct partial_symbol **);
 278
 279 /* Make a copy of the string at PTR with SIZE characters in the symbol
 280    obstack (and add a null character at the end in the copy).  Returns
 281    the address of the copy.  */
 282
 283 extern char *obsavestring (const char *, int, struct obstack *);
 284
 285 /* Concatenate strings S1, S2 and S3; return the new string.  Space is
 286    found in the OBSTACKP  */
 287
 288 extern char *obconcat (struct obstack *obstackp, const char *, const char *,
 289                        const char *);
 290
 291                         /*   Variables   */
 292
 293 /* If non-zero, shared library symbols will be added automatically
 294    when the inferior is created, new libraries are loaded, or when
 295    attaching to the inferior.  This is almost always what users will
 296    want to have happen; but for very large programs, the startup time
 297    will be excessive, and so if this is a problem, the user can clear
 298    this flag and then add the shared library symbols as needed.  Note
 299    that there is a potential for confusion, since if the shared
 300    library symbols are not loaded, commands like "info fun" will *not*
 301    report all the functions that are actually present.  */
 302
 303 extern int auto_solib_add;
 304
 305 /* For systems that support it, a threshold size in megabytes.  If
 306    automatically adding a new library's symbol table to those already
 307    known to the debugger would cause the total shared library symbol
 308    size to exceed this threshhold, then the shlib's symbols are not
 309    added.  The threshold is ignored if the user explicitly asks for a
 310    shlib to be added, such as when using the "sharedlibrary" command.  */
 311
 312 extern int auto_solib_limit;
 313
 314 /* From symfile.c */
 315
 316 extern void set_initial_language (void);
 317
 318 extern struct partial_symtab *allocate_psymtab (const char *,
 319                                                 struct objfile *);
 320
 321 extern void discard_psymtab (struct partial_symtab *);
 322
 323 extern void find_lowest_section (bfd *, asection *, void *);
 324
 325 extern bfd *symfile_bfd_open (char *);
 326
 327 extern bfd *bfd_open_maybe_remote (const char *);
 328
 329 extern int get_section_index (struct objfile *, char *);
 330
 331 /* Utility functions for overlay sections: */
 332 extern enum overlay_debugging_state
 333 {
 334   ovly_off,
 335   ovly_on,
 336   ovly_auto
 337 } overlay_debugging;
 338 extern int overlay_cache_invalid;
 339
 340 /* Return the "mapped" overlay section containing the PC.  */
 341 extern struct obj_section *find_pc_mapped_section (CORE_ADDR);
 342
 343 /* Return any overlay section containing the PC (even in its LMA
 344    region).  */
 345 extern struct obj_section *find_pc_overlay (CORE_ADDR);
 346
 347 /* Return true if the section is an overlay.  */
 348 extern int section_is_overlay (struct obj_section *);
 349
 350 /* Return true if the overlay section is currently "mapped".  */
 351 extern int section_is_mapped (struct obj_section *);
 352
 353 /* Return true if pc belongs to section's VMA.  */
 354 extern CORE_ADDR pc_in_mapped_range (CORE_ADDR, struct obj_section *);
 355
 356 /* Return true if pc belongs to section's LMA.  */
 357 extern CORE_ADDR pc_in_unmapped_range (CORE_ADDR, struct obj_section *);
 358
 359 /* Map an address from a section's LMA to its VMA.  */
 360 extern CORE_ADDR overlay_mapped_address (CORE_ADDR, struct obj_section *);
 361
 362 /* Map an address from a section's VMA to its LMA.  */
 363 extern CORE_ADDR overlay_unmapped_address (CORE_ADDR, struct obj_section *);
 364
 365 /* Convert an address in an overlay section (force into VMA range).  */
 366 extern CORE_ADDR symbol_overlayed_address (CORE_ADDR, struct obj_section *);
 367
 368 /* Load symbols from a file.  */
 369 extern void symbol_file_add_main (char *args, int from_tty);
 370
 371 /* Clear GDB symbol tables.  */
 372 extern void symbol_file_clear (int from_tty);
 373
 374 /* Default overlay update function.  */
 375 extern void simple_overlay_update (struct obj_section *);
 376
 377 extern bfd_byte *symfile_relocate_debug_section (bfd *abfd, asection *sectp,
 378                                                  bfd_byte * buf);
 379
 380 extern int symfile_map_offsets_to_segments (bfd *,
 381                                             struct symfile_segment_data *,
 382                                             struct section_offsets *,
 383                                             int, const CORE_ADDR *);
 384 struct symfile_segment_data *get_symfile_segment_data (bfd *abfd);
 385 void free_symfile_segment_data (struct symfile_segment_data *data);
 386
 387 /* From dwarf2read.c */
 388
 389 extern int dwarf2_has_info (struct objfile *);
 390
 391 extern void dwarf2_build_psymtabs (struct objfile *);
 392 extern void dwarf2_build_frame_info (struct objfile *);
 393
 394 void dwarf2_free_objfile (struct objfile *);
 395
 396 /* From mdebugread.c */
 397
 398 /* Hack to force structures to exist before use in parameter list.  */
 399 struct ecoff_debug_hack
 400 {
 401   struct ecoff_debug_swap *a;
 402   struct ecoff_debug_info *b;
 403 };
 404
 405 extern void mdebug_build_psymtabs (struct objfile *,
 406                                    const struct ecoff_debug_swap *,
 407                                    struct ecoff_debug_info *);
 408
 409 extern void elfmdebug_build_psymtabs (struct objfile *,
 410                                       const struct ecoff_debug_swap *,
 411                                       asection *);
 412
 413 #endif /* !defined(SYMFILE_H) */