gdb/objfiles.h

   1 /* Definitions for symbol file management in GDB.
   2
   3    Copyright (C) 1992-2019 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 (OBJFILES_H)
  21 #define OBJFILES_H
  22
  23 #include "hashtab.h"
  24 #include "gdb_obstack.h"        /* For obstack internals.  */
  25 #include "objfile-flags.h"
  26 #include "symfile.h"
  27 #include "progspace.h"
  28 #include "registry.h"
  29 #include "gdb_bfd.h"
  30 #include "psymtab.h"
  31 #include <vector>
  32 #include "common/next-iterator.h"
  33 #include "common/safe-iterator.h"
  34
  35 struct bcache;
  36 struct htab;
  37 struct objfile_data;
  38 struct partial_symbol;
  39
  40 /* This structure maintains information on a per-objfile basis about the
  41    "entry point" of the objfile, and the scope within which the entry point
  42    exists.  It is possible that gdb will see more than one objfile that is
  43    executable, each with its own entry point.
  44
  45    For example, for dynamically linked executables in SVR4, the dynamic linker
  46    code is contained within the shared C library, which is actually executable
  47    and is run by the kernel first when an exec is done of a user executable
  48    that is dynamically linked.  The dynamic linker within the shared C library
  49    then maps in the various program segments in the user executable and jumps
  50    to the user executable's recorded entry point, as if the call had been made
  51    directly by the kernel.
  52
  53    The traditional gdb method of using this info was to use the
  54    recorded entry point to set the entry-file's lowpc and highpc from
  55    the debugging information, where these values are the starting
  56    address (inclusive) and ending address (exclusive) of the
  57    instruction space in the executable which correspond to the
  58    "startup file", i.e. crt0.o in most cases.  This file is assumed to
  59    be a startup file and frames with pc's inside it are treated as
  60    nonexistent.  Setting these variables is necessary so that
  61    backtraces do not fly off the bottom of the stack.
  62
  63    NOTE: cagney/2003-09-09: It turns out that this "traditional"
  64    method doesn't work.  Corinna writes: ``It turns out that the call
  65    to test for "inside entry file" destroys a meaningful backtrace
  66    under some conditions.  E.g. the backtrace tests in the asm-source
  67    testcase are broken for some targets.  In this test the functions
  68    are all implemented as part of one file and the testcase is not
  69    necessarily linked with a start file (depending on the target).
  70    What happens is, that the first frame is printed normaly and
  71    following frames are treated as being inside the enttry file then.
  72    This way, only the #0 frame is printed in the backtrace output.''
  73    Ref "frame.c" "NOTE: vinschen/2003-04-01".
  74
  75    Gdb also supports an alternate method to avoid running off the bottom
  76    of the stack.
  77
  78    There are two frames that are "special", the frame for the function
  79    containing the process entry point, since it has no predecessor frame,
  80    and the frame for the function containing the user code entry point
  81    (the main() function), since all the predecessor frames are for the
  82    process startup code.  Since we have no guarantee that the linked
  83    in startup modules have any debugging information that gdb can use,
  84    we need to avoid following frame pointers back into frames that might
  85    have been built in the startup code, as we might get hopelessly
  86    confused.  However, we almost always have debugging information
  87    available for main().
  88
  89    These variables are used to save the range of PC values which are
  90    valid within the main() function and within the function containing
  91    the process entry point.  If we always consider the frame for
  92    main() as the outermost frame when debugging user code, and the
  93    frame for the process entry point function as the outermost frame
  94    when debugging startup code, then all we have to do is have
  95    DEPRECATED_FRAME_CHAIN_VALID return false whenever a frame's
  96    current PC is within the range specified by these variables.  In
  97    essence, we set "ceilings" in the frame chain beyond which we will
  98    not proceed when following the frame chain back up the stack.
  99
 100    A nice side effect is that we can still debug startup code without
 101    running off the end of the frame chain, assuming that we have usable
 102    debugging information in the startup modules, and if we choose to not
 103    use the block at main, or can't find it for some reason, everything
 104    still works as before.  And if we have no startup code debugging
 105    information but we do have usable information for main(), backtraces
 106    from user code don't go wandering off into the startup code.  */
 107
 108 struct entry_info
 109 {
 110   /* The unrelocated value we should use for this objfile entry point.  */
 111   CORE_ADDR entry_point;
 112
 113   /* The index of the section in which the entry point appears.  */
 114   int the_bfd_section_index;
 115
 116   /* Set to 1 iff ENTRY_POINT contains a valid value.  */
 117   unsigned entry_point_p : 1;
 118
 119   /* Set to 1 iff this object was initialized.  */
 120   unsigned initialized : 1;
 121 };
 122
 123 /* Sections in an objfile.  The section offsets are stored in the
 124    OBJFILE.  */
 125
 126 struct obj_section
 127 {
 128   /* BFD section pointer */
 129   struct bfd_section *the_bfd_section;
 130
 131   /* Objfile this section is part of.  */
 132   struct objfile *objfile;
 133
 134   /* True if this "overlay section" is mapped into an "overlay region".  */
 135   int ovly_mapped;
 136 };
 137
 138 /* Relocation offset applied to S.  */
 139 #define obj_section_offset(s)                                           \
 140   (((s)->objfile->section_offsets)->offsets[gdb_bfd_section_index ((s)->objfile->obfd, (s)->the_bfd_section)])
 141
 142 /* The memory address of section S (vma + offset).  */
 143 #define obj_section_addr(s)                                             \
 144   (bfd_get_section_vma ((s)->objfile->obfd, s->the_bfd_section)         \
 145    + obj_section_offset (s))
 146
 147 /* The one-passed-the-end memory address of section S
 148    (vma + size + offset).  */
 149 #define obj_section_endaddr(s)                                          \
 150   (bfd_get_section_vma ((s)->objfile->obfd, s->the_bfd_section)         \
 151    + bfd_get_section_size ((s)->the_bfd_section)                        \
 152    + obj_section_offset (s))
 153
 154 /* The "objstats" structure provides a place for gdb to record some
 155    interesting information about its internal state at runtime, on a
 156    per objfile basis, such as information about the number of symbols
 157    read, size of string table (if any), etc.  */
 158
 159 struct objstats
 160 {
 161   /* Number of partial symbols read.  */
 162   int n_psyms = 0;
 163
 164   /* Number of full symbols read.  */
 165   int n_syms = 0;
 166
 167   /* Number of ".stabs" read (if applicable).  */
 168   int n_stabs = 0;
 169
 170   /* Number of types.  */
 171   int n_types = 0;
 172
 173   /* Size of stringtable, (if applicable).  */
 174   int sz_strtab = 0;
 175 };
 176
 177 #define OBJSTAT(objfile, expr) (objfile -> stats.expr)
 178 #define OBJSTATS struct objstats stats
 179 extern void print_objfile_statistics (void);
 180 extern void print_symbol_bcache_statistics (void);
 181
 182 /* Number of entries in the minimal symbol hash table.  */
 183 #define MINIMAL_SYMBOL_HASH_SIZE 2039
 184
 185 /* Some objfile data is hung off the BFD.  This enables sharing of the
 186    data across all objfiles using the BFD.  The data is stored in an
 187    instance of this structure, and associated with the BFD using the
 188    registry system.  */
 189
 190 struct objfile_per_bfd_storage
 191 {
 192   objfile_per_bfd_storage ()
 193     : minsyms_read (false)
 194   {}
 195
 196   /* The storage has an obstack of its own.  */
 197
 198   auto_obstack storage_obstack;
 199
 200   /* Byte cache for file names.  */
 201
 202   bcache *filename_cache = NULL;
 203
 204   /* Byte cache for macros.  */
 205
 206   bcache *macro_cache = NULL;
 207
 208   /* The gdbarch associated with the BFD.  Note that this gdbarch is
 209      determined solely from BFD information, without looking at target
 210      information.  The gdbarch determined from a running target may
 211      differ from this e.g. with respect to register types and names.  */
 212
 213   struct gdbarch *gdbarch = NULL;
 214
 215   /* Hash table for mapping symbol names to demangled names.  Each
 216      entry in the hash table is actually two consecutive strings,
 217      both null-terminated; the first one is a mangled or linkage
 218      name, and the second is the demangled name or just a zero byte
 219      if the name doesn't demangle.  */
 220
 221   htab *demangled_names_hash = NULL;
 222
 223   /* The per-objfile information about the entry point, the scope (file/func)
 224      containing the entry point, and the scope of the user's main() func.  */
 225
 226   entry_info ei {};
 227
 228   /* The name and language of any "main" found in this objfile.  The
 229      name can be NULL, which means that the information was not
 230      recorded.  */
 231
 232   const char *name_of_main = NULL;
 233   enum language language_of_main = language_unknown;
 234
 235   /* Each file contains a pointer to an array of minimal symbols for all
 236      global symbols that are defined within the file.  The array is
 237      terminated by a "null symbol", one that has a NULL pointer for the
 238      name and a zero value for the address.  This makes it easy to walk
 239      through the array when passed a pointer to somewhere in the middle
 240      of it.  There is also a count of the number of symbols, which does
 241      not include the terminating null symbol.  The array itself, as well
 242      as all the data that it points to, should be allocated on the
 243      objfile_obstack for this file.  */
 244
 245   minimal_symbol *msymbols = NULL;
 246   int minimal_symbol_count = 0;
 247
 248   /* The number of minimal symbols read, before any minimal symbol
 249      de-duplication is applied.  Note in particular that this has only
 250      a passing relationship with the actual size of the table above;
 251      use minimal_symbol_count if you need the true size.  */
 252
 253   int n_minsyms = 0;
 254
 255   /* This is true if minimal symbols have already been read.  Symbol
 256      readers can use this to bypass minimal symbol reading.  Also, the
 257      minimal symbol table management code in minsyms.c uses this to
 258      suppress new minimal symbols.  You might think that MSYMBOLS or
 259      MINIMAL_SYMBOL_COUNT could be used for this, but it is possible
 260      for multiple readers to install minimal symbols into a given
 261      per-BFD.  */
 262
 263   bool minsyms_read : 1;
 264
 265   /* This is a hash table used to index the minimal symbols by name.  */
 266
 267   minimal_symbol *msymbol_hash[MINIMAL_SYMBOL_HASH_SIZE] {};
 268
 269   /* This hash table is used to index the minimal symbols by their
 270      demangled names.  */
 271
 272   minimal_symbol *msymbol_demangled_hash[MINIMAL_SYMBOL_HASH_SIZE] {};
 273
 274   /* All the different languages of symbols found in the demangled
 275      hash table.  A flat/vector-based map is more efficient than a map
 276      or hash table here, since this will only usually contain zero or
 277      one entries.  */
 278   std::vector<enum language> demangled_hash_languages;
 279 };
 280
 281 /* Master structure for keeping track of each file from which
 282    gdb reads symbols.  There are several ways these get allocated: 1.
 283    The main symbol file, symfile_objfile, set by the symbol-file command,
 284    2.  Additional symbol files added by the add-symbol-file command,
 285    3.  Shared library objfiles, added by ADD_SOLIB,  4.  symbol files
 286    for modules that were loaded when GDB attached to a remote system
 287    (see remote-vx.c).  */
 288
 289 struct objfile
 290 {
 291   objfile (bfd *, const char *, objfile_flags);
 292   ~objfile ();
 293
 294   DISABLE_COPY_AND_ASSIGN (objfile);
 295
 296   /* All struct objfile's are chained together by their next pointers.
 297      The program space field "objfiles"  (frequently referenced via
 298      the macro "object_files") points to the first link in this chain.  */
 299
 300   struct objfile *next = nullptr;
 301
 302   /* The object file's original name as specified by the user,
 303      made absolute, and tilde-expanded.  However, it is not canonicalized
 304      (i.e., it has not been passed through gdb_realpath).
 305      This pointer is never NULL.  This does not have to be freed; it is
 306      guaranteed to have a lifetime at least as long as the objfile.  */
 307
 308   char *original_name = nullptr;
 309
 310   CORE_ADDR addr_low = 0;
 311
 312   /* Some flag bits for this objfile.  */
 313
 314   objfile_flags flags;
 315
 316   /* The program space associated with this objfile.  */
 317
 318   struct program_space *pspace;
 319
 320   /* List of compunits.
 321      These are used to do symbol lookups and file/line-number lookups.  */
 322
 323   struct compunit_symtab *compunit_symtabs = nullptr;
 324
 325   /* The partial symbol tables.  */
 326
 327   std::shared_ptr<psymtab_storage> partial_symtabs;
 328
 329   /* The object file's BFD.  Can be null if the objfile contains only
 330      minimal symbols, e.g. the run time common symbols for SunOS4.  */
 331
 332   bfd *obfd;
 333
 334   /* The per-BFD data.  Note that this is treated specially if OBFD
 335      is NULL.  */
 336
 337   struct objfile_per_bfd_storage *per_bfd = nullptr;
 338
 339   /* The modification timestamp of the object file, as of the last time
 340      we read its symbols.  */
 341
 342   long mtime = 0;
 343
 344   /* Obstack to hold objects that should be freed when we load a new symbol
 345      table from this object file.  */
 346
 347   struct obstack objfile_obstack {};
 348
 349   /* Map symbol addresses to the partial symtab that defines the
 350      object at that address.  */
 351
 352   std::vector<std::pair<CORE_ADDR, partial_symtab *>> psymbol_map;
 353
 354   /* Structure which keeps track of functions that manipulate objfile's
 355      of the same type as this objfile.  I.e. the function to read partial
 356      symbols for example.  Note that this structure is in statically
 357      allocated memory, and is shared by all objfiles that use the
 358      object module reader of this type.  */
 359
 360   const struct sym_fns *sf = nullptr;
 361
 362   /* Per objfile data-pointers required by other GDB modules.  */
 363
 364   REGISTRY_FIELDS {};
 365
 366   /* Set of relocation offsets to apply to each section.
 367      The table is indexed by the_bfd_section->index, thus it is generally
 368      as large as the number of sections in the binary.
 369      The table is stored on the objfile_obstack.
 370
 371      These offsets indicate that all symbols (including partial and
 372      minimal symbols) which have been read have been relocated by this
 373      much.  Symbols which are yet to be read need to be relocated by it.  */
 374
 375   struct section_offsets *section_offsets = nullptr;
 376   int num_sections = 0;
 377
 378   /* Indexes in the section_offsets array.  These are initialized by the
 379      *_symfile_offsets() family of functions (som_symfile_offsets,
 380      xcoff_symfile_offsets, default_symfile_offsets).  In theory they
 381      should correspond to the section indexes used by bfd for the
 382      current objfile.  The exception to this for the time being is the
 383      SOM version.
 384
 385      These are initialized to -1 so that we can later detect if they
 386      are used w/o being properly assigned to.  */
 387
 388   int sect_index_text = -1;
 389   int sect_index_data = -1;
 390   int sect_index_bss = -1;
 391   int sect_index_rodata = -1;
 392
 393   /* These pointers are used to locate the section table, which
 394      among other things, is used to map pc addresses into sections.
 395      SECTIONS points to the first entry in the table, and
 396      SECTIONS_END points to the first location past the last entry
 397      in the table.  The table is stored on the objfile_obstack.  The
 398      sections are indexed by the BFD section index; but the
 399      structure data is only valid for certain sections
 400      (e.g. non-empty, SEC_ALLOC).  */
 401
 402   struct obj_section *sections = nullptr;
 403   struct obj_section *sections_end = nullptr;
 404
 405   /* GDB allows to have debug symbols in separate object files.  This is
 406      used by .gnu_debuglink, ELF build id note and Mach-O OSO.
 407      Although this is a tree structure, GDB only support one level
 408      (ie a separate debug for a separate debug is not supported).  Note that
 409      separate debug object are in the main chain and therefore will be
 410      visited by all_objfiles & co iterators.  Separate debug objfile always
 411      has a non-nul separate_debug_objfile_backlink.  */
 412
 413   /* Link to the first separate debug object, if any.  */
 414
 415   struct objfile *separate_debug_objfile = nullptr;
 416
 417   /* If this is a separate debug object, this is used as a link to the
 418      actual executable objfile.  */
 419
 420   struct objfile *separate_debug_objfile_backlink = nullptr;
 421
 422   /* If this is a separate debug object, this is a link to the next one
 423      for the same executable objfile.  */
 424
 425   struct objfile *separate_debug_objfile_link = nullptr;
 426
 427   /* Place to stash various statistics about this objfile.  */
 428
 429   OBJSTATS;
 430
 431   /* A linked list of symbols created when reading template types or
 432      function templates.  These symbols are not stored in any symbol
 433      table, so we have to keep them here to relocate them
 434      properly.  */
 435
 436   struct symbol *template_symbols = nullptr;
 437
 438   /* Associate a static link (struct dynamic_prop *) to all blocks (struct
 439      block *) that have one.
 440
 441      In the context of nested functions (available in Pascal, Ada and GNU C,
 442      for instance), a static link (as in DWARF's DW_AT_static_link attribute)
 443      for a function is a way to get the frame corresponding to the enclosing
 444      function.
 445
 446      Very few blocks have a static link, so it's more memory efficient to
 447      store these here rather than in struct block.  Static links must be
 448      allocated on the objfile's obstack.  */
 449   htab_t static_links {};
 450 };
 451
 452 /* Declarations for functions defined in objfiles.c */
 453
 454 extern struct gdbarch *get_objfile_arch (const struct objfile *);
 455
 456 extern int entry_point_address_query (CORE_ADDR *entry_p);
 457
 458 extern CORE_ADDR entry_point_address (void);
 459
 460 extern void build_objfile_section_table (struct objfile *);
 461
 462 extern struct objfile *objfile_separate_debug_iterate (const struct objfile *,
 463                                                        const struct objfile *);
 464
 465 extern void put_objfile_before (struct objfile *, struct objfile *);
 466
 467 extern void add_separate_debug_objfile (struct objfile *, struct objfile *);
 468
 469 extern void unlink_objfile (struct objfile *);
 470
 471 extern void free_objfile_separate_debug (struct objfile *);
 472
 473 extern void free_all_objfiles (void);
 474
 475 extern void objfile_relocate (struct objfile *, const struct section_offsets *);
 476 extern void objfile_rebase (struct objfile *, CORE_ADDR);
 477
 478 extern int objfile_has_partial_symbols (struct objfile *objfile);
 479
 480 extern int objfile_has_full_symbols (struct objfile *objfile);
 481
 482 extern int objfile_has_symbols (struct objfile *objfile);
 483
 484 extern int have_partial_symbols (void);
 485
 486 extern int have_full_symbols (void);
 487
 488 extern void objfile_set_sym_fns (struct objfile *objfile,
 489                                  const struct sym_fns *sf);
 490
 491 extern void objfiles_changed (void);
 492
 493 extern int is_addr_in_objfile (CORE_ADDR addr, const struct objfile *objfile);
 494
 495 /* Return true if ADDRESS maps into one of the sections of a
 496    OBJF_SHARED objfile of PSPACE and false otherwise.  */
 497
 498 extern int shared_objfile_contains_address_p (struct program_space *pspace,
 499                                               CORE_ADDR address);
 500
 501 /* This operation deletes all objfile entries that represent solibs that
 502    weren't explicitly loaded by the user, via e.g., the add-symbol-file
 503    command.  */
 504
 505 extern void objfile_purge_solibs (void);
 506
 507 /* Functions for dealing with the minimal symbol table, really a misc
 508    address<->symbol mapping for things we don't have debug symbols for.  */
 509
 510 extern int have_minimal_symbols (void);
 511
 512 extern struct obj_section *find_pc_section (CORE_ADDR pc);
 513
 514 /* Return non-zero if PC is in a section called NAME.  */
 515 extern int pc_in_section (CORE_ADDR, const char *);
 516
 517 /* Return non-zero if PC is in a SVR4-style procedure linkage table
 518    section.  */
 519
 520 static inline int
 521 in_plt_section (CORE_ADDR pc)
 522 {
 523   return pc_in_section (pc, ".plt");
 524 }
 525
 526 /* Keep a registry of per-objfile data-pointers required by other GDB
 527    modules.  */
 528 DECLARE_REGISTRY(objfile);
 529
 530 /* In normal use, the section map will be rebuilt by find_pc_section
 531    if objfiles have been added, removed or relocated since it was last
 532    called.  Calling inhibit_section_map_updates will inhibit this
 533    behavior until the returned scoped_restore object is destroyed.  If
 534    you call inhibit_section_map_updates you must ensure that every
 535    call to find_pc_section in the inhibited region relates to a
 536    section that is already in the section map and has not since been
 537    removed or relocated.  */
 538 extern scoped_restore_tmpl<int> inhibit_section_map_updates
 539     (struct program_space *pspace);
 540
 541 extern void default_iterate_over_objfiles_in_search_order
 542   (struct gdbarch *gdbarch,
 543    iterate_over_objfiles_in_search_order_cb_ftype *cb,
 544    void *cb_data, struct objfile *current_objfile);
 545 \f
 546
 547 /* An iterarable object that can be used to iterate over all
 548    objfiles.  The basic use is in a foreach, like:
 549
 550    for (objfile *objf : all_objfiles (pspace)) { ... }  */
 551
 552 class all_objfiles : public next_adapter<struct objfile>
 553 {
 554 public:
 555
 556   explicit all_objfiles (struct program_space *pspace)
 557     : next_adapter<struct objfile> (pspace->objfiles)
 558   {
 559   }
 560 };
 561
 562 /* An iterarable object that can be used to iterate over all
 563    objfiles.  The basic use is in a foreach, like:
 564
 565    for (objfile *objf : all_objfiles_safe (pspace)) { ... }
 566
 567    This variant uses a basic_safe_iterator so that objfiles can be
 568    deleted during iteration.  */
 569
 570 class all_objfiles_safe
 571   : public next_adapter<struct objfile,
 572                         basic_safe_iterator<next_iterator<objfile>>>
 573 {
 574 public:
 575
 576   explicit all_objfiles_safe (struct program_space *pspace)
 577     : next_adapter<struct objfile,
 578                    basic_safe_iterator<next_iterator<objfile>>>
 579         (pspace->objfiles)
 580   {
 581   }
 582 };
 583
 584 /* A range adapter that makes it possible to iterate over all
 585    compunits in one objfile.  */
 586
 587 class objfile_compunits : public next_adapter<struct compunit_symtab>
 588 {
 589 public:
 590
 591   explicit objfile_compunits (struct objfile *objfile)
 592     : next_adapter<struct compunit_symtab> (objfile->compunit_symtabs)
 593   {
 594   }
 595 };
 596
 597 /* A range adapter that makes it possible to iterate over all
 598    minimal symbols of an objfile.  */
 599
 600 class objfile_msymbols
 601 {
 602 public:
 603
 604   explicit objfile_msymbols (struct objfile *objfile)
 605     : m_objfile (objfile)
 606   {
 607   }
 608
 609   struct iterator
 610   {
 611     typedef iterator self_type;
 612     typedef struct minimal_symbol *value_type;
 613     typedef struct minimal_symbol *&reference;
 614     typedef struct minimal_symbol **pointer;
 615     typedef std::forward_iterator_tag iterator_category;
 616     typedef int difference_type;
 617
 618     explicit iterator (struct objfile *objfile)
 619       : m_msym (objfile->per_bfd->msymbols)
 620     {
 621       /* Make sure to properly handle the case where there are no
 622          minsyms.  */
 623       if (MSYMBOL_LINKAGE_NAME (m_msym) == nullptr)
 624         m_msym = nullptr;
 625     }
 626
 627     iterator ()
 628       : m_msym (nullptr)
 629     {
 630     }
 631
 632     value_type operator* () const
 633     {
 634       return m_msym;
 635     }
 636
 637     bool operator== (const self_type &other) const
 638     {
 639       return m_msym == other.m_msym;
 640     }
 641
 642     bool operator!= (const self_type &other) const
 643     {
 644       return m_msym != other.m_msym;
 645     }
 646
 647     self_type &operator++ ()
 648     {
 649       if (m_msym != nullptr)
 650         {
 651           ++m_msym;
 652           if (MSYMBOL_LINKAGE_NAME (m_msym) == nullptr)
 653             m_msym = nullptr;
 654         }
 655       return *this;
 656     }
 657
 658   private:
 659     struct minimal_symbol *m_msym;
 660   };
 661
 662   iterator begin () const
 663   {
 664     return iterator (m_objfile);
 665   }
 666
 667   iterator end () const
 668   {
 669     return iterator ();
 670   }
 671
 672 private:
 673
 674   struct objfile *m_objfile;
 675 };
 676
 677 /* A range adapter that makes it possible to iterate over all
 678    psymtabs in one objfile.  */
 679
 680 class objfile_psymtabs : public next_adapter<struct partial_symtab>
 681 {
 682 public:
 683
 684   explicit objfile_psymtabs (struct objfile *objfile)
 685     : next_adapter<struct partial_symtab> (objfile->partial_symtabs->psymtabs)
 686   {
 687   }
 688 };
 689
 690 #define ALL_OBJFILE_OSECTIONS(objfile, osect)   \
 691   for (osect = objfile->sections; osect < objfile->sections_end; osect++) \
 692     if (osect->the_bfd_section == NULL)                                 \
 693       {                                                                 \
 694         /* Nothing.  */                                                 \
 695       }                                                                 \
 696     else
 697
 698 #define SECT_OFF_DATA(objfile) \
 699      ((objfile->sect_index_data == -1) \
 700       ? (internal_error (__FILE__, __LINE__, \
 701                          _("sect_index_data not initialized")), -1)     \
 702       : objfile->sect_index_data)
 703
 704 #define SECT_OFF_RODATA(objfile) \
 705      ((objfile->sect_index_rodata == -1) \
 706       ? (internal_error (__FILE__, __LINE__, \
 707                          _("sect_index_rodata not initialized")), -1)   \
 708       : objfile->sect_index_rodata)
 709
 710 #define SECT_OFF_TEXT(objfile) \
 711      ((objfile->sect_index_text == -1) \
 712       ? (internal_error (__FILE__, __LINE__, \
 713                          _("sect_index_text not initialized")), -1)     \
 714       : objfile->sect_index_text)
 715
 716 /* Sometimes the .bss section is missing from the objfile, so we don't
 717    want to die here.  Let the users of SECT_OFF_BSS deal with an
 718    uninitialized section index.  */
 719 #define SECT_OFF_BSS(objfile) (objfile)->sect_index_bss
 720
 721 /* Answer whether there is more than one object file loaded.  */
 722
 723 #define MULTI_OBJFILE_P() (object_files && object_files->next)
 724
 725 /* Reset the per-BFD storage area on OBJ.  */
 726
 727 void set_objfile_per_bfd (struct objfile *obj);
 728
 729 /* Return canonical name for OBJFILE.
 730    This is the real file name if the file has been opened.
 731    Otherwise it is the original name supplied by the user.  */
 732
 733 const char *objfile_name (const struct objfile *objfile);
 734
 735 /* Return the (real) file name of OBJFILE if the file has been opened,
 736    otherwise return NULL.  */
 737
 738 const char *objfile_filename (const struct objfile *objfile);
 739
 740 /* Return the name to print for OBJFILE in debugging messages.  */
 741
 742 extern const char *objfile_debug_name (const struct objfile *objfile);
 743
 744 /* Return the name of the file format of OBJFILE if the file has been opened,
 745    otherwise return NULL.  */
 746
 747 const char *objfile_flavour_name (struct objfile *objfile);
 748
 749 /* Set the objfile's notion of the "main" name and language.  */
 750
 751 extern void set_objfile_main_name (struct objfile *objfile,
 752                                    const char *name, enum language lang);
 753
 754 extern void objfile_register_static_link
 755   (struct objfile *objfile,
 756    const struct block *block,
 757    const struct dynamic_prop *static_link);
 758
 759 extern const struct dynamic_prop *objfile_lookup_static_link
 760   (struct objfile *objfile, const struct block *block);
 761
 762 #endif /* !defined (OBJFILES_H) */