gdb/objfiles.h

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