gdb/objfiles.h

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