gdb/symfile.h

   1 /* Definitions for reading symbol files into GDB.
   2
   3    Copyright (C) 1990-2020 Free Software Foundation, Inc.
   4
   5    This file is part of GDB.
   6
   7    This program is free software; you can redistribute it and/or modify
   8    it under the terms of the GNU General Public License as published by
   9    the Free Software Foundation; either version 3 of the License, or
  10    (at your option) any later version.
  11
  12    This program is distributed in the hope that it will be useful,
  13    but WITHOUT ANY WARRANTY; without even the implied warranty of
  14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15    GNU General Public License for more details.
  16
  17    You should have received a copy of the GNU General Public License
  18    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  19
  20 #if !defined (SYMFILE_H)
  21 #define SYMFILE_H
  22
  23 /* This file requires that you first include "bfd.h".  */
  24 #include "symtab.h"
  25 #include "probe.h"
  26 #include "symfile-add-flags.h"
  27 #include "objfile-flags.h"
  28 #include "gdb_bfd.h"
  29 #include "gdbsupport/function-view.h"
  30
  31 /* Opaque declarations.  */
  32 struct target_section;
  33 struct objfile;
  34 struct obj_section;
  35 struct obstack;
  36 struct block;
  37 struct value;
  38 struct frame_info;
  39 struct agent_expr;
  40 struct axs_value;
  41 class probe;
  42
  43 /* Comparison function for symbol look ups.  */
  44
  45 typedef int (symbol_compare_ftype) (const char *string1,
  46                                     const char *string2);
  47
  48 struct other_sections
  49 {
  50   other_sections (CORE_ADDR addr_, std::string &&name_, int sectindex_)
  51     : addr (addr_),
  52       name (std::move (name_)),
  53       sectindex (sectindex_)
  54   {
  55   }
  56
  57   other_sections (other_sections &&other) = default;
  58
  59   DISABLE_COPY_AND_ASSIGN (other_sections);
  60
  61   CORE_ADDR addr;
  62   std::string name;
  63
  64   /* SECTINDEX must be valid for associated BFD or set to -1.
  65      See syms_from_objfile_1 for an exception to this rule.
  66    */
  67   int sectindex;
  68 };
  69
  70 /* Define an array of addresses to accommodate non-contiguous dynamic
  71    loading of modules.  This is for use when entering commands, so we
  72    can keep track of the section names until we read the file and can
  73    map them to bfd sections.  This structure is also used by solib.c
  74    to communicate the section addresses in shared objects to
  75    symbol_file_add ().  */
  76
  77 typedef std::vector<other_sections> section_addr_info;
  78
  79 /* A table listing the load segments in a symfile, and which segment
  80    each BFD section belongs to.  */
  81 struct symfile_segment_data
  82 {
  83   /* How many segments are present in this file.  If there are
  84      two, the text segment is the first one and the data segment
  85      is the second one.  */
  86   int num_segments;
  87
  88   /* If NUM_SEGMENTS is greater than zero, the original base address
  89      of each segment.  */
  90   CORE_ADDR *segment_bases;
  91
  92   /* If NUM_SEGMENTS is greater than zero, the memory size of each
  93      segment.  */
  94   CORE_ADDR *segment_sizes;
  95
  96   /* If NUM_SEGMENTS is greater than zero, this is an array of entries
  97      recording which segment contains each BFD section.
  98      SEGMENT_INFO[I] is S+1 if the I'th BFD section belongs to segment
  99      S, or zero if it is not in any segment.  */
 100   int *segment_info;
 101 };
 102
 103 /* Callback for quick_symbol_functions->map_symbol_filenames.  */
 104
 105 typedef void (symbol_filename_ftype) (const char *filename,
 106                                       const char *fullname, void *data);
 107
 108 /* Callback for quick_symbol_functions->expand_symtabs_matching
 109    to match a file name.  */
 110
 111 typedef bool (expand_symtabs_file_matcher_ftype) (const char *filename,
 112                                                   bool basenames);
 113
 114 /* Callback for quick_symbol_functions->expand_symtabs_matching
 115    to match a symbol name.  */
 116
 117 typedef bool (expand_symtabs_symbol_matcher_ftype) (const char *name);
 118
 119 /* Callback for quick_symbol_functions->expand_symtabs_matching
 120    to be called after a symtab has been expanded.  */
 121
 122 typedef void (expand_symtabs_exp_notify_ftype) (compunit_symtab *symtab);
 123
 124 /* The "quick" symbol functions exist so that symbol readers can
 125    avoiding an initial read of all the symbols.  For example, symbol
 126    readers might choose to use the "partial symbol table" utilities,
 127    which is one implementation of the quick symbol functions.
 128
 129    The quick symbol functions are generally opaque: the underlying
 130    representation is hidden from the caller.
 131
 132    In general, these functions should only look at whatever special
 133    index the symbol reader creates -- looking through the symbol
 134    tables themselves is handled by generic code.  If a function is
 135    defined as returning a "symbol table", this means that the function
 136    should only return a newly-created symbol table; it should not
 137    examine pre-existing ones.
 138
 139    The exact list of functions here was determined in an ad hoc way
 140    based on gdb's history.  */
 141
 142 struct quick_symbol_functions
 143 {
 144   /* Return true if this objfile has any "partial" symbols
 145      available.  */
 146   int (*has_symbols) (struct objfile *objfile);
 147
 148   /* Return the symbol table for the "last" file appearing in
 149      OBJFILE.  */
 150   struct symtab *(*find_last_source_symtab) (struct objfile *objfile);
 151
 152   /* Forget all cached full file names for OBJFILE.  */
 153   void (*forget_cached_source_info) (struct objfile *objfile);
 154
 155   /* Expand and iterate over each "partial" symbol table in OBJFILE
 156      where the source file is named NAME.
 157
 158      If NAME is not absolute, a match after a '/' in the symbol table's
 159      file name will also work, REAL_PATH is NULL then.  If NAME is
 160      absolute then REAL_PATH is non-NULL absolute file name as resolved
 161      via gdb_realpath from NAME.
 162
 163      If a match is found, the "partial" symbol table is expanded.
 164      Then, this calls iterate_over_some_symtabs (or equivalent) over
 165      all newly-created symbol tables, passing CALLBACK to it.
 166      The result of this call is returned.  */
 167   bool (*map_symtabs_matching_filename)
 168     (struct objfile *objfile, const char *name, const char *real_path,
 169      gdb::function_view<bool (symtab *)> callback);
 170
 171   /* Check to see if the symbol is defined in a "partial" symbol table
 172      of OBJFILE.  BLOCK_INDEX should be either GLOBAL_BLOCK or STATIC_BLOCK,
 173      depending on whether we want to search global symbols or static
 174      symbols.  NAME is the name of the symbol to look for.  DOMAIN
 175      indicates what sort of symbol to search for.
 176
 177      Returns the newly-expanded compunit in which the symbol is
 178      defined, or NULL if no such symbol table exists.  If OBJFILE
 179      contains !TYPE_OPAQUE symbol prefer its compunit.  If it contains
 180      only TYPE_OPAQUE symbol(s), return at least that compunit.  */
 181   struct compunit_symtab *(*lookup_symbol) (struct objfile *objfile,
 182                                             block_enum block_index,
 183                                             const char *name,
 184                                             domain_enum domain);
 185
 186   /* Check to see if the global symbol is defined in a "partial" symbol table
 187      of OBJFILE. NAME is the name of the symbol to look for.  DOMAIN
 188      indicates what sort of symbol to search for.
 189
 190      If found, sets *symbol_found_p to true and returns the symbol language.
 191      defined, or NULL if no such symbol table exists.  */
 192   enum language (*lookup_global_symbol_language) (struct objfile *objfile,
 193                                                   const char *name,
 194                                                   domain_enum domain,
 195                                                   bool *symbol_found_p);
 196
 197   /* Print statistics about any indices loaded for OBJFILE.  The
 198      statistics should be printed to gdb_stdout.  This is used for
 199      "maint print statistics".  */
 200   void (*print_stats) (struct objfile *objfile);
 201
 202   /* Dump any indices loaded for OBJFILE.  The dump should go to
 203      gdb_stdout.  This is used for "maint print objfiles".  */
 204   void (*dump) (struct objfile *objfile);
 205
 206   /* Find all the symbols in OBJFILE named FUNC_NAME, and ensure that
 207      the corresponding symbol tables are loaded.  */
 208   void (*expand_symtabs_for_function) (struct objfile *objfile,
 209                                        const char *func_name);
 210
 211   /* Read all symbol tables associated with OBJFILE.  */
 212   void (*expand_all_symtabs) (struct objfile *objfile);
 213
 214   /* Read all symbol tables associated with OBJFILE which have
 215      symtab_to_fullname equal to FULLNAME.
 216      This is for the purposes of examining code only, e.g., expand_line_sal.
 217      The routine may ignore debug info that is known to not be useful with
 218      code, e.g., DW_TAG_type_unit for dwarf debug info.  */
 219   void (*expand_symtabs_with_fullname) (struct objfile *objfile,
 220                                         const char *fullname);
 221
 222   /* Find global or static symbols in all tables that are in DOMAIN
 223      and for which MATCH (symbol name, NAME) == 0, passing each to
 224      CALLBACK, reading in partial symbol tables as needed.  Look
 225      through global symbols if GLOBAL and otherwise static symbols.
 226      Passes NAME and NAMESPACE to CALLBACK with each symbol
 227      found.  After each block is processed, passes NULL to CALLBACK.
 228      MATCH must be weaker than strcmp_iw_ordered in the sense that
 229      strcmp_iw_ordered(x,y) == 0 --> MATCH(x,y) == 0.  ORDERED_COMPARE,
 230      if non-null, must be an ordering relation compatible with
 231      strcmp_iw_ordered in the sense that
 232             strcmp_iw_ordered(x,y) == 0 --> ORDERED_COMPARE(x,y) == 0
 233      and
 234             strcmp_iw_ordered(x,y) <= 0 --> ORDERED_COMPARE(x,y) <= 0
 235      (allowing strcmp_iw_ordered(x,y) < 0 while ORDERED_COMPARE(x, y) == 0).
 236      CALLBACK returns true to indicate that the scan should continue, or
 237      false to indicate that the scan should be terminated.  */
 238
 239   void (*map_matching_symbols)
 240     (struct objfile *,
 241      const lookup_name_info &lookup_name,
 242      domain_enum domain,
 243      int global,
 244      gdb::function_view<symbol_found_callback_ftype> callback,
 245      symbol_compare_ftype *ordered_compare);
 246
 247   /* Expand all symbol tables in OBJFILE matching some criteria.
 248
 249      FILE_MATCHER is called for each file in OBJFILE.  The file name
 250      is passed to it.  If the matcher returns false, the file is
 251      skipped.  If FILE_MATCHER is NULL the file is not skipped.  If
 252      BASENAMES is true the matcher should consider only file base
 253      names (the passed file name is already only the lbasename'd
 254      part).
 255
 256      If the file is not skipped, and SYMBOL_MATCHER and LOOKUP_NAME are NULL,
 257      the symbol table is expanded.
 258
 259      Otherwise, individual symbols are considered.
 260
 261      If KIND does not match, the symbol is skipped.
 262
 263      If the symbol name does not match LOOKUP_NAME, the symbol is skipped.
 264
 265      If SYMBOL_MATCHER returns false, then the symbol is skipped.
 266
 267      Otherwise, the symbol's symbol table is expanded.  */
 268   void (*expand_symtabs_matching)
 269     (struct objfile *objfile,
 270      gdb::function_view<expand_symtabs_file_matcher_ftype> file_matcher,
 271      const lookup_name_info *lookup_name,
 272      gdb::function_view<expand_symtabs_symbol_matcher_ftype> symbol_matcher,
 273      gdb::function_view<expand_symtabs_exp_notify_ftype> expansion_notify,
 274      enum search_domain kind);
 275
 276   /* Return the comp unit from OBJFILE that contains PC and
 277      SECTION.  Return NULL if there is no such compunit.  This
 278      should return the compunit that contains a symbol whose
 279      address exactly matches PC, or, if there is no exact match, the
 280      compunit that contains a symbol whose address is closest to
 281      PC.  */
 282   struct compunit_symtab *(*find_pc_sect_compunit_symtab)
 283     (struct objfile *objfile, struct bound_minimal_symbol msymbol,
 284      CORE_ADDR pc, struct obj_section *section, int warn_if_readin);
 285
 286   /* Return the comp unit from OBJFILE that contains a symbol at
 287      ADDRESS.  Return NULL if there is no such comp unit.  Unlike
 288      find_pc_sect_compunit_symtab, any sort of symbol (not just text
 289      symbols) can be considered, and only exact address matches are
 290      considered.  This pointer may be NULL.  */
 291   struct compunit_symtab *(*find_compunit_symtab_by_address)
 292     (struct objfile *objfile, CORE_ADDR address);
 293
 294   /* Call a callback for every file defined in OBJFILE whose symtab is
 295      not already read in.  FUN is the callback.  It is passed the file's
 296      FILENAME, the file's FULLNAME (if need_fullname is non-zero), and
 297      the DATA passed to this function.  */
 298   void (*map_symbol_filenames) (struct objfile *objfile,
 299                                 symbol_filename_ftype *fun, void *data,
 300                                 int need_fullname);
 301 };
 302
 303 /* Structure of functions used for probe support.  If one of these functions
 304    is provided, all must be.  */
 305
 306 struct sym_probe_fns
 307 {
 308   /* If non-NULL, return a reference to vector of probe objects.  */
 309   const std::vector<std::unique_ptr<probe>> &(*sym_get_probes)
 310     (struct objfile *);
 311 };
 312
 313 /* Structure to keep track of symbol reading functions for various
 314    object file types.  */
 315
 316 struct sym_fns
 317 {
 318   /* Initializes anything that is global to the entire symbol table.
 319      It is called during symbol_file_add, when we begin debugging an
 320      entirely new program.  */
 321
 322   void (*sym_new_init) (struct objfile *);
 323
 324   /* Reads any initial information from a symbol file, and initializes
 325      the struct sym_fns SF in preparation for sym_read().  It is
 326      called every time we read a symbol file for any reason.  */
 327
 328   void (*sym_init) (struct objfile *);
 329
 330   /* sym_read (objfile, symfile_flags) Reads a symbol file into a psymtab
 331      (or possibly a symtab).  OBJFILE is the objfile struct for the
 332      file we are reading.  SYMFILE_FLAGS are the flags passed to
 333      symbol_file_add & co.  */
 334
 335   void (*sym_read) (struct objfile *, symfile_add_flags);
 336
 337   /* Read the partial symbols for an objfile.  This may be NULL, in which case
 338      gdb has to check other ways if this objfile has any symbols.  This may
 339      only be non-NULL if the objfile actually does have debuginfo available.
 340      */
 341
 342   void (*sym_read_psymbols) (struct objfile *);
 343
 344   /* Called when we are finished with an objfile.  Should do all
 345      cleanup that is specific to the object file format for the
 346      particular objfile.  */
 347
 348   void (*sym_finish) (struct objfile *);
 349
 350
 351   /* This function produces a file-dependent section_offsets
 352      structure, allocated in the objfile's storage.
 353
 354      The section_addr_info structure contains the offset of loadable and
 355      allocated sections, relative to the absolute offsets found in the BFD.  */
 356
 357   void (*sym_offsets) (struct objfile *, const section_addr_info &);
 358
 359   /* This function produces a format-independent description of
 360      the segments of ABFD.  Each segment is a unit of the file
 361      which may be relocated independently.  */
 362
 363   struct symfile_segment_data *(*sym_segments) (bfd *abfd);
 364
 365   /* This function should read the linetable from the objfile when
 366      the line table cannot be read while processing the debugging
 367      information.  */
 368
 369   void (*sym_read_linetable) (struct objfile *);
 370
 371   /* Relocate the contents of a debug section SECTP.  The
 372      contents are stored in BUF if it is non-NULL, or returned in a
 373      malloc'd buffer otherwise.  */
 374
 375   bfd_byte *(*sym_relocate) (struct objfile *, asection *sectp, bfd_byte *buf);
 376
 377   /* If non-NULL, this objfile has probe support, and all the probe
 378      functions referred to here will be non-NULL.  */
 379   const struct sym_probe_fns *sym_probe_fns;
 380
 381   /* The "quick" (aka partial) symbol functions for this symbol
 382      reader.  */
 383   const struct quick_symbol_functions *qf;
 384 };
 385
 386 extern section_addr_info
 387   build_section_addr_info_from_objfile (const struct objfile *objfile);
 388
 389 extern void relative_addr_info_to_section_offsets
 390   (section_offsets &section_offsets, const section_addr_info &addrs);
 391
 392 extern void addr_info_make_relative (section_addr_info *addrs,
 393                                      bfd *abfd);
 394
 395 /* The default version of sym_fns.sym_offsets for readers that don't
 396    do anything special.  */
 397
 398 extern void default_symfile_offsets (struct objfile *objfile,
 399                                      const section_addr_info &);
 400
 401 /* The default version of sym_fns.sym_segments for readers that don't
 402    do anything special.  */
 403
 404 extern struct symfile_segment_data *default_symfile_segments (bfd *abfd);
 405
 406 /* The default version of sym_fns.sym_relocate for readers that don't
 407    do anything special.  */
 408
 409 extern bfd_byte *default_symfile_relocate (struct objfile *objfile,
 410                                            asection *sectp, bfd_byte *buf);
 411
 412 extern struct symtab *allocate_symtab (struct compunit_symtab *, const char *)
 413   ATTRIBUTE_NONNULL (1);
 414
 415 extern struct compunit_symtab *allocate_compunit_symtab (struct objfile *,
 416                                                          const char *)
 417   ATTRIBUTE_NONNULL (1);
 418
 419 extern void add_compunit_symtab_to_objfile (struct compunit_symtab *cu);
 420
 421 extern void add_symtab_fns (enum bfd_flavour flavour, const struct sym_fns *);
 422
 423 extern void clear_symtab_users (symfile_add_flags add_flags);
 424
 425 extern enum language deduce_language_from_filename (const char *);
 426
 427 /* Map the filename extension EXT to the language LANG.  Any previous
 428    association of EXT will be removed.  EXT will be copied by this
 429    function.  */
 430 extern void add_filename_language (const char *ext, enum language lang);
 431
 432 extern struct objfile *symbol_file_add (const char *, symfile_add_flags,
 433                                         section_addr_info *, objfile_flags);
 434
 435 extern struct objfile *symbol_file_add_from_bfd (bfd *, const char *, symfile_add_flags,
 436                                                  section_addr_info *,
 437                                                  objfile_flags, struct objfile *parent);
 438
 439 extern void symbol_file_add_separate (bfd *, const char *, symfile_add_flags,
 440                                       struct objfile *);
 441
 442 extern std::string find_separate_debug_file_by_debuglink (struct objfile *);
 443
 444 /* Build (allocate and populate) a section_addr_info struct from an
 445    existing section table.  */
 446
 447 extern section_addr_info
 448    build_section_addr_info_from_section_table (const struct target_section
 449                                                *start,
 450                                                const struct target_section
 451                                                *end);
 452
 453                         /*   Variables   */
 454
 455 /* If true, shared library symbols will be added automatically
 456    when the inferior is created, new libraries are loaded, or when
 457    attaching to the inferior.  This is almost always what users will
 458    want to have happen; but for very large programs, the startup time
 459    will be excessive, and so if this is a problem, the user can clear
 460    this flag and then add the shared library symbols as needed.  Note
 461    that there is a potential for confusion, since if the shared
 462    library symbols are not loaded, commands like "info fun" will *not*
 463    report all the functions that are actually present.  */
 464
 465 extern bool auto_solib_add;
 466
 467 /* From symfile.c */
 468
 469 extern void set_initial_language (void);
 470
 471 extern void find_lowest_section (bfd *, asection *, void *);
 472
 473 extern gdb_bfd_ref_ptr symfile_bfd_open (const char *);
 474
 475 extern int get_section_index (struct objfile *, const char *);
 476
 477 extern int print_symbol_loading_p (int from_tty, int mainline, int full);
 478
 479 /* Utility functions for overlay sections: */
 480 extern enum overlay_debugging_state
 481 {
 482   ovly_off,
 483   ovly_on,
 484   ovly_auto
 485 } overlay_debugging;
 486 extern int overlay_cache_invalid;
 487
 488 /* Return the "mapped" overlay section containing the PC.  */
 489 extern struct obj_section *find_pc_mapped_section (CORE_ADDR);
 490
 491 /* Return any overlay section containing the PC (even in its LMA
 492    region).  */
 493 extern struct obj_section *find_pc_overlay (CORE_ADDR);
 494
 495 /* Return true if the section is an overlay.  */
 496 extern int section_is_overlay (struct obj_section *);
 497
 498 /* Return true if the overlay section is currently "mapped".  */
 499 extern int section_is_mapped (struct obj_section *);
 500
 501 /* Return true if pc belongs to section's VMA.  */
 502 extern CORE_ADDR pc_in_mapped_range (CORE_ADDR, struct obj_section *);
 503
 504 /* Return true if pc belongs to section's LMA.  */
 505 extern CORE_ADDR pc_in_unmapped_range (CORE_ADDR, struct obj_section *);
 506
 507 /* Map an address from a section's LMA to its VMA.  */
 508 extern CORE_ADDR overlay_mapped_address (CORE_ADDR, struct obj_section *);
 509
 510 /* Map an address from a section's VMA to its LMA.  */
 511 extern CORE_ADDR overlay_unmapped_address (CORE_ADDR, struct obj_section *);
 512
 513 /* Convert an address in an overlay section (force into VMA range).  */
 514 extern CORE_ADDR symbol_overlayed_address (CORE_ADDR, struct obj_section *);
 515
 516 /* Load symbols from a file.  */
 517 extern void symbol_file_add_main (const char *args,
 518                                   symfile_add_flags add_flags);
 519
 520 /* Clear GDB symbol tables.  */
 521 extern void symbol_file_clear (int from_tty);
 522
 523 /* Default overlay update function.  */
 524 extern void simple_overlay_update (struct obj_section *);
 525
 526 extern bfd_byte *symfile_relocate_debug_section (struct objfile *, asection *,
 527                                                  bfd_byte *);
 528
 529 extern int symfile_map_offsets_to_segments (bfd *,
 530                                             const struct symfile_segment_data *,
 531                                             section_offsets &,
 532                                             int, const CORE_ADDR *);
 533 struct symfile_segment_data *get_symfile_segment_data (bfd *abfd);
 534 void free_symfile_segment_data (struct symfile_segment_data *data);
 535
 536 extern scoped_restore_tmpl<int> increment_reading_symtab (void);
 537
 538 void expand_symtabs_matching
 539   (gdb::function_view<expand_symtabs_file_matcher_ftype> file_matcher,
 540    const lookup_name_info &lookup_name,
 541    gdb::function_view<expand_symtabs_symbol_matcher_ftype> symbol_matcher,
 542    gdb::function_view<expand_symtabs_exp_notify_ftype> expansion_notify,
 543    enum search_domain kind);
 544
 545 void map_symbol_filenames (symbol_filename_ftype *fun, void *data,
 546                            int need_fullname);
 547
 548 /* Target-agnostic function to load the sections of an executable into memory.
 549
 550    ARGS should be in the form "EXECUTABLE [OFFSET]", where OFFSET is an
 551    optional offset to apply to each section.  */
 552 extern void generic_load (const char *args, int from_tty);
 553
 554 /* From dwarf2read.c */
 555
 556 /* Names for a dwarf2 debugging section.  The field NORMAL is the normal
 557    section name (usually from the DWARF standard), while the field COMPRESSED
 558    is the name of compressed sections.  If your object file format doesn't
 559    support compressed sections, the field COMPRESSED can be NULL.  Likewise,
 560    the debugging section is not supported, the field NORMAL can be NULL too.
 561    It doesn't make sense to have a NULL NORMAL field but a non-NULL COMPRESSED
 562    field.  */
 563
 564 struct dwarf2_section_names {
 565   const char *normal;
 566   const char *compressed;
 567 };
 568
 569 /* List of names for dward2 debugging sections.  Also most object file formats
 570    use the standardized (ie ELF) names, some (eg XCOFF) have customized names
 571    due to restrictions.
 572    The table for the standard names is defined in dwarf2read.c.  Please
 573    update all instances of dwarf2_debug_sections if you add a field to this
 574    structure.  It is always safe to use { NULL, NULL } in this case.  */
 575
 576 struct dwarf2_debug_sections {
 577   struct dwarf2_section_names info;
 578   struct dwarf2_section_names abbrev;
 579   struct dwarf2_section_names line;
 580   struct dwarf2_section_names loc;
 581   struct dwarf2_section_names loclists;
 582   struct dwarf2_section_names macinfo;
 583   struct dwarf2_section_names macro;
 584   struct dwarf2_section_names str;
 585   struct dwarf2_section_names str_offsets;
 586   struct dwarf2_section_names line_str;
 587   struct dwarf2_section_names ranges;
 588   struct dwarf2_section_names rnglists;
 589   struct dwarf2_section_names types;
 590   struct dwarf2_section_names addr;
 591   struct dwarf2_section_names frame;
 592   struct dwarf2_section_names eh_frame;
 593   struct dwarf2_section_names gdb_index;
 594   struct dwarf2_section_names debug_names;
 595   struct dwarf2_section_names debug_aranges;
 596   /* This field has no meaning, but exists solely to catch changes to
 597      this structure which are not reflected in some instance.  */
 598   int sentinel;
 599 };
 600
 601 extern int dwarf2_has_info (struct objfile *,
 602                             const struct dwarf2_debug_sections *,
 603                             bool = false);
 604
 605 /* Dwarf2 sections that can be accessed by dwarf2_get_section_info.  */
 606 enum dwarf2_section_enum {
 607   DWARF2_DEBUG_FRAME,
 608   DWARF2_EH_FRAME
 609 };
 610
 611 extern void dwarf2_get_section_info (struct objfile *,
 612                                      enum dwarf2_section_enum,
 613                                      asection **, const gdb_byte **,
 614                                      bfd_size_type *);
 615
 616 /* A DWARF names index variant.  */
 617 enum class dw_index_kind
 618 {
 619   /* GDB's own .gdb_index format.   */
 620   GDB_INDEX,
 621
 622   /* DWARF5 .debug_names.  */
 623   DEBUG_NAMES,
 624 };
 625
 626 /* Initialize for reading DWARF for OBJFILE.  Return false if this
 627    file will use psymtabs, or true if using an index, in which case
 628    *INDEX_KIND is set to the index variant in use.  */
 629 extern bool dwarf2_initialize_objfile (struct objfile *objfile,
 630                                        dw_index_kind *index_kind);
 631
 632 extern void dwarf2_build_psymtabs (struct objfile *);
 633 extern void dwarf2_build_frame_info (struct objfile *);
 634
 635 void dwarf2_free_objfile (struct objfile *);
 636
 637 /* From minidebug.c.  */
 638
 639 extern gdb_bfd_ref_ptr find_separate_debug_file_in_section (struct objfile *);
 640
 641 /* True if we are printing debug output about separate debug info files.  */
 642
 643 extern bool separate_debug_file_debug;
 644
 645 #endif /* !defined(SYMFILE_H) */