gdb/symfile.h

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