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