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
  84     /* SECTINDEX must be valid for associated BFD if ADDR is not zero.  */
  85     int sectindex;
  86   } other[1];
  87 };
  88
  89
  90 /* A table listing the load segments in a symfile, and which segment
  91    each BFD section belongs to.  */
  92 struct symfile_segment_data
  93 {
  94   /* How many segments are present in this file.  If there are
  95      two, the text segment is the first one and the data segment
  96      is the second one.  */
  97   int num_segments;
  98
  99   /* If NUM_SEGMENTS is greater than zero, the original base address
 100      of each segment.  */
 101   CORE_ADDR *segment_bases;
 102
 103   /* If NUM_SEGMENTS is greater than zero, the memory size of each
 104      segment.  */
 105   CORE_ADDR *segment_sizes;
 106
 107   /* If NUM_SEGMENTS is greater than zero, this is an array of entries
 108      recording which segment contains each BFD section.
 109      SEGMENT_INFO[I] is S+1 if the I'th BFD section belongs to segment
 110      S, or zero if it is not in any segment.  */
 111   int *segment_info;
 112 };
 113
 114 /* The "quick" symbol functions exist so that symbol readers can
 115    avoiding an initial read of all the symbols.  For example, symbol
 116    readers might choose to use the "partial symbol table" utilities,
 117    which is one implementation of the quick symbol functions.
 118
 119    The quick symbol functions are generally opaque: the underlying
 120    representation is hidden from the caller.
 121
 122    In general, these functions should only look at whatever special
 123    index the symbol reader creates -- looking through the symbol
 124    tables themselves is handled by generic code.  If a function is
 125    defined as returning a "symbol table", this means that the function
 126    should only return a newly-created symbol table; it should not
 127    examine pre-existing ones.
 128
 129    The exact list of functions here was determined in an ad hoc way
 130    based on gdb's history.  */
 131
 132 struct quick_symbol_functions
 133 {
 134   /* Return true if this objfile has any "partial" symbols
 135      available.  */
 136   int (*has_symbols) (struct objfile *objfile);
 137
 138   /* Return the symbol table for the "last" file appearing in
 139      OBJFILE.  */
 140   struct symtab *(*find_last_source_symtab) (struct objfile *objfile);
 141
 142   /* Forget all cached full file names for OBJFILE.  */
 143   void (*forget_cached_source_info) (struct objfile *objfile);
 144
 145   /* Look up the symbol table, in OBJFILE, of a source file named
 146      NAME.  If there is no '/' in the name, a match after a '/' in the
 147      symbol table's file name will also work.  FULL_PATH is the
 148      absolute file name, and REAL_PATH is the same, run through
 149      gdb_realpath.
 150
 151      If no such symbol table can be found, returns 0.
 152
 153      Otherwise, sets *RESULT to the symbol table and returns 1.  This
 154      might return 1 and set *RESULT to NULL if the requested file is
 155      an include file that does not have a symtab of its own.  */
 156   int (*lookup_symtab) (struct objfile *objfile,
 157                         const char *name,
 158                         const char *full_path,
 159                         const char *real_path,
 160                         struct symtab **result);
 161
 162   /* Check to see if the symbol is defined in a "partial" symbol table
 163      of OBJFILE.  KIND should be either GLOBAL_BLOCK or STATIC_BLOCK,
 164      depending on whether we want to search global symbols or static
 165      symbols.  NAME is the name of the symbol to look for.  DOMAIN
 166      indicates what sort of symbol to search for.
 167
 168      Returns the newly-expanded symbol table in which the symbol is
 169      defined, or NULL if no such symbol table exists.  */
 170   struct symtab *(*lookup_symbol) (struct objfile *objfile,
 171                                    int kind, const char *name,
 172                                    domain_enum domain);
 173
 174   /* This is called to expand symbol tables before looking up a
 175      symbol.  A backend can choose to implement this and then have its
 176      `lookup_symbol' hook always return NULL, or the reverse.  (It
 177      doesn't make sense to implement both.)  The arguments are as for
 178      `lookup_symbol'.  */
 179   void (*pre_expand_symtabs_matching) (struct objfile *objfile,
 180                                        int kind, const char *name,
 181                                        domain_enum domain);
 182
 183   /* Print statistics about any indices loaded for OBJFILE.  The
 184      statistics should be printed to gdb_stdout.  This is used for
 185      "maint print statistics".  */
 186   void (*print_stats) (struct objfile *objfile);
 187
 188   /* Dump any indices loaded for OBJFILE.  The dump should go to
 189      gdb_stdout.  This is used for "maint print objfiles".  */
 190   void (*dump) (struct objfile *objfile);
 191
 192   /* This is called by objfile_relocate to relocate any indices loaded
 193      for OBJFILE.  */
 194   void (*relocate) (struct objfile *objfile,
 195                     struct section_offsets *new_offsets,
 196                     struct section_offsets *delta);
 197
 198   /* Find all the symbols in OBJFILE named FUNC_NAME, and ensure that
 199      the corresponding symbol tables are loaded.  */
 200   void (*expand_symtabs_for_function) (struct objfile *objfile,
 201                                        const char *func_name);
 202
 203   /* Read all symbol tables associated with OBJFILE.  */
 204   void (*expand_all_symtabs) (struct objfile *objfile);
 205
 206   /* Read all symbol tables associated with OBJFILE which have the
 207      file name FILENAME.  */
 208   void (*expand_symtabs_with_filename) (struct objfile *objfile,
 209                                         const char *filename);
 210
 211   /* Return the file name of the file holding the symbol in OBJFILE
 212      named NAME.  If no such symbol exists in OBJFILE, return NULL.  */
 213   const char *(*find_symbol_file) (struct objfile *objfile, const char *name);
 214
 215   /* Find global or static symbols in all tables that are in NAMESPACE
 216      and for which MATCH (symbol name, NAME) == 0, passing each to
 217      CALLBACK, reading in partial symbol symbol tables as needed.  Look
 218      through global symbols if GLOBAL and otherwise static symbols.
 219      Passes NAME, NAMESPACE, and DATA to CALLBACK with each symbol
 220      found.  After each block is processed, passes NULL to CALLBACK.
 221      MATCH must be weaker than strcmp_iw in the sense that
 222      strcmp_iw(x,y) == 0 --> MATCH(x,y) == 0.  ORDERED_COMPARE, if
 223      non-null, must be an ordering relation compatible with strcmp_iw
 224      in the sense that
 225             strcmp(x,y) == 0 --> ORDERED_COMPARE(x,y) == 0
 226      and
 227             strcmp(x,y) <= 0 --> ORDERED_COMPARE(x,y) <= 0
 228      (allowing strcmp(x,y) < 0 while ORDERED_COMPARE(x, y) == 0).
 229      CALLBACK returns 0 to indicate that the scan should continue, or
 230      non-zero to indicate that the scan should be terminated.  */
 231
 232   void (*map_matching_symbols) (const char *name, domain_enum namespace,
 233                                 struct objfile *, int global,
 234                                 int (*callback) (struct block *,
 235                                                  struct symbol *, void *),
 236                                 void *data,
 237                                 int (*match) (const char *, const char *),
 238                                 int (*ordered_compare) (const char *,
 239                                                         const char *));
 240
 241   /* Expand all symbol tables in OBJFILE matching some criteria.
 242
 243      FILE_MATCHER is called for each file in OBJFILE.  The file name
 244      and the DATA argument are passed to it.  If it returns zero, this
 245      file is skipped.
 246
 247      Otherwise, if the file is not skipped, then NAME_MATCHER is
 248      called for each symbol defined in the file.  The symbol's
 249      "natural" name and DATA are passed to NAME_MATCHER.
 250
 251      If NAME_MATCHER returns zero, then this symbol is skipped.
 252
 253      Otherwise, if this symbol is not skipped, and it matches KIND,
 254      then this symbol's symbol table is expanded.
 255
 256      DATA is user data that is passed unmodified to the callback
 257      functions.  */
 258   void (*expand_symtabs_matching) (struct objfile *objfile,
 259                                    int (*file_matcher) (const char *, void *),
 260                                    int (*name_matcher) (const char *, void *),
 261                                    domain_enum kind,
 262                                    void *data);
 263
 264   /* Return the symbol table from OBJFILE that contains PC and
 265      SECTION.  Return NULL if there is no such symbol table.  This
 266      should return the symbol table that contains a symbol whose
 267      address exactly matches PC, or, if there is no exact match, the
 268      symbol table that contains a symbol whose address is closest to
 269      PC.  */
 270   struct symtab *(*find_pc_sect_symtab) (struct objfile *objfile,
 271                                          struct minimal_symbol *msymbol,
 272                                          CORE_ADDR pc,
 273                                          struct obj_section *section,
 274                                          int warn_if_readin);
 275
 276   /* Call a callback for every symbol defined in OBJFILE.  FUN is the
 277      callback.  It is passed the symbol's natural name, and the DATA
 278      passed to this function.  */
 279   void (*map_symbol_names) (struct objfile *objfile,
 280                             void (*fun) (const char *, void *),
 281                             void *data);
 282
 283   /* Call a callback for every file defined in OBJFILE.  FUN is the
 284      callback.  It is passed the file's name, the file's full name,
 285      and the DATA passed to this function.  */
 286   void (*map_symbol_filenames) (struct objfile *objfile,
 287                                 void (*fun) (const char *, const char *,
 288                                              void *),
 289                                 void *data);
 290 };
 291
 292 /* Structure to keep track of symbol reading functions for various
 293    object file types.  */
 294
 295 struct sym_fns
 296 {
 297
 298   /* BFD flavour that we handle, or (as a special kludge, see
 299      xcoffread.c, (enum bfd_flavour)-1 for xcoff).  */
 300
 301   enum bfd_flavour sym_flavour;
 302
 303   /* Initializes anything that is global to the entire symbol table.
 304      It is called during symbol_file_add, when we begin debugging an
 305      entirely new program.  */
 306
 307   void (*sym_new_init) (struct objfile *);
 308
 309   /* Reads any initial information from a symbol file, and initializes
 310      the struct sym_fns SF in preparation for sym_read().  It is
 311      called every time we read a symbol file for any reason.  */
 312
 313   void (*sym_init) (struct objfile *);
 314
 315   /* sym_read (objfile, symfile_flags) Reads a symbol file into a psymtab
 316      (or possibly a symtab).  OBJFILE is the objfile struct for the
 317      file we are reading.  SYMFILE_FLAGS are the flags passed to
 318      symbol_file_add & co.  */
 319
 320   void (*sym_read) (struct objfile *, int);
 321
 322   /* Called when we are finished with an objfile.  Should do all
 323      cleanup that is specific to the object file format for the
 324      particular objfile.  */
 325
 326   void (*sym_finish) (struct objfile *);
 327
 328   /* This function produces a file-dependent section_offsets
 329      structure, allocated in the objfile's storage, and based on the
 330      parameter.  The parameter is currently a CORE_ADDR (FIXME!) for
 331      backward compatibility with the higher levels of GDB.  It should
 332      probably be changed to a string, where NULL means the default,
 333      and others are parsed in a file dependent way.  */
 334
 335   void (*sym_offsets) (struct objfile *, struct section_addr_info *);
 336
 337   /* This function produces a format-independent description of
 338      the segments of ABFD.  Each segment is a unit of the file
 339      which may be relocated independently.  */
 340
 341   struct symfile_segment_data *(*sym_segments) (bfd *abfd);
 342
 343   /* This function should read the linetable from the objfile when
 344      the line table cannot be read while processing the debugging
 345      information.  */
 346
 347   void (*sym_read_linetable) (void);
 348
 349   /* Relocate the contents of a debug section SECTP.  The
 350      contents are stored in BUF if it is non-NULL, or returned in a
 351      malloc'd buffer otherwise.  */
 352
 353   bfd_byte *(*sym_relocate) (struct objfile *, asection *sectp, bfd_byte *buf);
 354
 355   /* The "quick" (aka partial) symbol functions for this symbol
 356      reader.  */
 357   const struct quick_symbol_functions *qf;
 358 };
 359
 360 extern struct section_addr_info *
 361            build_section_addr_info_from_objfile (const struct objfile *objfile);
 362
 363 extern void relative_addr_info_to_section_offsets
 364   (struct section_offsets *section_offsets, int num_sections,
 365    struct section_addr_info *addrs);
 366
 367 extern void addr_info_make_relative (struct section_addr_info *addrs,
 368                                      bfd *abfd);
 369
 370 /* The default version of sym_fns.sym_offsets for readers that don't
 371    do anything special.  */
 372
 373 extern void default_symfile_offsets (struct objfile *objfile,
 374                                      struct section_addr_info *);
 375
 376 /* The default version of sym_fns.sym_segments for readers that don't
 377    do anything special.  */
 378
 379 extern struct symfile_segment_data *default_symfile_segments (bfd *abfd);
 380
 381 /* The default version of sym_fns.sym_relocate for readers that don't
 382    do anything special.  */
 383
 384 extern bfd_byte *default_symfile_relocate (struct objfile *objfile,
 385                                            asection *sectp, bfd_byte *buf);
 386
 387 extern struct symtab *allocate_symtab (const char *, struct objfile *);
 388
 389 extern void add_symtab_fns (const struct sym_fns *);
 390
 391 /* This enum encodes bit-flags passed as ADD_FLAGS parameter to
 392    syms_from_objfile, symbol_file_add, etc.  */
 393
 394 enum symfile_add_flags
 395   {
 396     /* Be chatty about what you are doing.  */
 397     SYMFILE_VERBOSE = 1 << 1,
 398
 399     /* This is the main symbol file (as opposed to symbol file for dynamically
 400        loaded code).  */
 401     SYMFILE_MAINLINE = 1 << 2,
 402
 403     /* Do not call breakpoint_re_set when adding this symbol file.  */
 404     SYMFILE_DEFER_BP_RESET = 1 << 3
 405   };
 406
 407 extern void syms_from_objfile (struct objfile *,
 408                                struct section_addr_info *,
 409                                struct section_offsets *, int, int);
 410
 411 extern void new_symfile_objfile (struct objfile *, int);
 412
 413 extern struct objfile *symbol_file_add (char *, int,
 414                                         struct section_addr_info *, int);
 415
 416 extern struct objfile *symbol_file_add_from_bfd (bfd *, int,
 417                                                  struct section_addr_info *,
 418                                                  int);
 419
 420 extern void symbol_file_add_separate (bfd *, int, struct objfile *);
 421
 422 extern char *find_separate_debug_file_by_debuglink (struct objfile *);
 423
 424 /* Create a new section_addr_info, with room for NUM_SECTIONS.  */
 425
 426 extern struct section_addr_info *alloc_section_addr_info (size_t
 427                                                           num_sections);
 428
 429 /* Build (allocate and populate) a section_addr_info struct from an
 430    existing section table.  */
 431
 432 extern struct section_addr_info
 433   *build_section_addr_info_from_section_table (const struct target_section
 434                                                *start,
 435                                                const struct target_section
 436                                                *end);
 437
 438 /* Free all memory allocated by
 439    build_section_addr_info_from_section_table.  */
 440
 441 extern void free_section_addr_info (struct section_addr_info *);
 442
 443
 444 /* Make a copy of the string at PTR with SIZE characters in the symbol
 445    obstack (and add a null character at the end in the copy).  Returns
 446    the address of the copy.  */
 447
 448 extern char *obsavestring (const char *, int, struct obstack *);
 449
 450 /* Concatenate NULL terminated variable argument list of `const char *' strings;
 451    return the new string.  Space is found in the OBSTACKP.  Argument list must
 452    be terminated by a sentinel expression `(char *) NULL'.  */
 453
 454 extern char *obconcat (struct obstack *obstackp, ...) ATTRIBUTE_SENTINEL;
 455
 456                         /*   Variables   */
 457
 458 /* If non-zero, shared library symbols will be added automatically
 459    when the inferior is created, new libraries are loaded, or when
 460    attaching to the inferior.  This is almost always what users will
 461    want to have happen; but for very large programs, the startup time
 462    will be excessive, and so if this is a problem, the user can clear
 463    this flag and then add the shared library symbols as needed.  Note
 464    that there is a potential for confusion, since if the shared
 465    library symbols are not loaded, commands like "info fun" will *not*
 466    report all the functions that are actually present.  */
 467
 468 extern int auto_solib_add;
 469
 470 /* For systems that support it, a threshold size in megabytes.  If
 471    automatically adding a new library's symbol table to those already
 472    known to the debugger would cause the total shared library symbol
 473    size to exceed this threshhold, then the shlib's symbols are not
 474    added.  The threshold is ignored if the user explicitly asks for a
 475    shlib to be added, such as when using the "sharedlibrary" command.  */
 476
 477 extern int auto_solib_limit;
 478
 479 /* From symfile.c */
 480
 481 extern void set_initial_language (void);
 482
 483 extern void find_lowest_section (bfd *, asection *, void *);
 484
 485 extern bfd *symfile_bfd_open (char *);
 486
 487 extern bfd *bfd_open_maybe_remote (const char *);
 488
 489 extern int get_section_index (struct objfile *, char *);
 490
 491 /* Utility functions for overlay sections: */
 492 extern enum overlay_debugging_state
 493 {
 494   ovly_off,
 495   ovly_on,
 496   ovly_auto
 497 } overlay_debugging;
 498 extern int overlay_cache_invalid;
 499
 500 /* Return the "mapped" overlay section containing the PC.  */
 501 extern struct obj_section *find_pc_mapped_section (CORE_ADDR);
 502
 503 /* Return any overlay section containing the PC (even in its LMA
 504    region).  */
 505 extern struct obj_section *find_pc_overlay (CORE_ADDR);
 506
 507 /* Return true if the section is an overlay.  */
 508 extern int section_is_overlay (struct obj_section *);
 509
 510 /* Return true if the overlay section is currently "mapped".  */
 511 extern int section_is_mapped (struct obj_section *);
 512
 513 /* Return true if pc belongs to section's VMA.  */
 514 extern CORE_ADDR pc_in_mapped_range (CORE_ADDR, struct obj_section *);
 515
 516 /* Return true if pc belongs to section's LMA.  */
 517 extern CORE_ADDR pc_in_unmapped_range (CORE_ADDR, struct obj_section *);
 518
 519 /* Map an address from a section's LMA to its VMA.  */
 520 extern CORE_ADDR overlay_mapped_address (CORE_ADDR, struct obj_section *);
 521
 522 /* Map an address from a section's VMA to its LMA.  */
 523 extern CORE_ADDR overlay_unmapped_address (CORE_ADDR, struct obj_section *);
 524
 525 /* Convert an address in an overlay section (force into VMA range).  */
 526 extern CORE_ADDR symbol_overlayed_address (CORE_ADDR, struct obj_section *);
 527
 528 /* Load symbols from a file.  */
 529 extern void symbol_file_add_main (char *args, int from_tty);
 530
 531 /* Clear GDB symbol tables.  */
 532 extern void symbol_file_clear (int from_tty);
 533
 534 /* Default overlay update function.  */
 535 extern void simple_overlay_update (struct obj_section *);
 536
 537 extern bfd_byte *symfile_relocate_debug_section (struct objfile *, asection *,
 538                                                  bfd_byte *);
 539
 540 extern int symfile_map_offsets_to_segments (bfd *,
 541                                             struct symfile_segment_data *,
 542                                             struct section_offsets *,
 543                                             int, const CORE_ADDR *);
 544 struct symfile_segment_data *get_symfile_segment_data (bfd *abfd);
 545 void free_symfile_segment_data (struct symfile_segment_data *data);
 546
 547 extern struct cleanup *increment_reading_symtab (void);
 548
 549 /* From dwarf2read.c */
 550
 551 extern int dwarf2_has_info (struct objfile *);
 552
 553 extern int dwarf2_initialize_objfile (struct objfile *);
 554 extern void dwarf2_build_psymtabs (struct objfile *);
 555 extern void dwarf2_build_frame_info (struct objfile *);
 556
 557 void dwarf2_free_objfile (struct objfile *);
 558
 559 /* From mdebugread.c */
 560
 561 /* Hack to force structures to exist before use in parameter list.  */
 562 struct ecoff_debug_hack
 563 {
 564   struct ecoff_debug_swap *a;
 565   struct ecoff_debug_info *b;
 566 };
 567
 568 extern void mdebug_build_psymtabs (struct objfile *,
 569                                    const struct ecoff_debug_swap *,
 570                                    struct ecoff_debug_info *);
 571
 572 extern void elfmdebug_build_psymtabs (struct objfile *,
 573                                       const struct ecoff_debug_swap *,
 574                                       asection *);
 575
 576 #endif /* !defined(SYMFILE_H) */