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