gdb/objfiles.h

   1 /* Definitions for symbol file management in GDB.
   2
   3    Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001,
   4    2002, 2003, 2004, 2007, 2008, 2009, 2010, 2011
   5    Free Software Foundation, Inc.
   6
   7    This file is part of GDB.
   8
   9    This program is free software; you can redistribute it and/or modify
  10    it under the terms of the GNU General Public License as published by
  11    the Free Software Foundation; either version 3 of the License, or
  12    (at your option) any later version.
  13
  14    This program is distributed in the hope that it will be useful,
  15    but WITHOUT ANY WARRANTY; without even the implied warranty of
  16    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17    GNU General Public License for more details.
  18
  19    You should have received a copy of the GNU General Public License
  20    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  21
  22 #if !defined (OBJFILES_H)
  23 #define OBJFILES_H
  24
  25 #include "gdb_obstack.h"        /* For obstack internals.  */
  26 #include "symfile.h"            /* For struct psymbol_allocation_list.  */
  27 #include "progspace.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[(s)->the_bfd_section->index])
 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 /* Master structure for keeping track of each file from which
 165    gdb reads symbols.  There are several ways these get allocated: 1.
 166    The main symbol file, symfile_objfile, set by the symbol-file command,
 167    2.  Additional symbol files added by the add-symbol-file command,
 168    3.  Shared library objfiles, added by ADD_SOLIB,  4.  symbol files
 169    for modules that were loaded when GDB attached to a remote system
 170    (see remote-vx.c).  */
 171
 172 struct objfile
 173   {
 174
 175     /* All struct objfile's are chained together by their next pointers.
 176        The global variable "object_files" points to the first link in this
 177        chain.
 178
 179        FIXME:  There is a problem here if the objfile is reusable, and if
 180        multiple users are to be supported.  The problem is that the objfile
 181        list is linked through a member of the objfile struct itself, which
 182        is only valid for one gdb process.  The list implementation needs to
 183        be changed to something like:
 184
 185        struct list {struct list *next; struct objfile *objfile};
 186
 187        where the list structure is completely maintained separately within
 188        each gdb process.  */
 189
 190     struct objfile *next;
 191
 192     /* The object file's name, tilde-expanded and absolute.  Malloc'd; free it
 193        if you free this struct.  This pointer is never NULL.  */
 194
 195     char *name;
 196
 197     CORE_ADDR addr_low;
 198
 199     /* Some flag bits for this objfile.
 200        The values are defined by OBJF_*.  */
 201
 202     unsigned short flags;
 203
 204     /* The program space associated with this objfile.  */
 205
 206     struct program_space *pspace;
 207
 208     /* Each objfile points to a linked list of symtabs derived from this file,
 209        one symtab structure for each compilation unit (source file).  Each link
 210        in the symtab list contains a backpointer to this objfile.  */
 211
 212     struct symtab *symtabs;
 213
 214     /* Each objfile points to a linked list of partial symtabs derived from
 215        this file, one partial symtab structure for each compilation unit
 216        (source file).  */
 217
 218     struct partial_symtab *psymtabs;
 219
 220     /* Map addresses to the entries of PSYMTABS.  It would be more efficient to
 221        have a map per the whole process but ADDRMAP cannot selectively remove
 222        its items during FREE_OBJFILE.  This mapping is already present even for
 223        PARTIAL_SYMTABs which still have no corresponding full SYMTABs read.  */
 224
 225     struct addrmap *psymtabs_addrmap;
 226
 227     /* List of freed partial symtabs, available for re-use.  */
 228
 229     struct partial_symtab *free_psymtabs;
 230
 231     /* The object file's BFD.  Can be null if the objfile contains only
 232        minimal symbols, e.g. the run time common symbols for SunOS4.  */
 233
 234     bfd *obfd;
 235
 236     /* The gdbarch associated with the BFD.  Note that this gdbarch is
 237        determined solely from BFD information, without looking at target
 238        information.  The gdbarch determined from a running target may
 239        differ from this e.g. with respect to register types and names.  */
 240
 241     struct gdbarch *gdbarch;
 242
 243     /* The modification timestamp of the object file, as of the last time
 244        we read its symbols.  */
 245
 246     long mtime;
 247
 248     /* Cached 32-bit CRC as computed by gnu_debuglink_crc32.  CRC32 is valid
 249        iff CRC32_P.  */
 250     unsigned long crc32;
 251     int crc32_p;
 252
 253     /* Obstack to hold objects that should be freed when we load a new symbol
 254        table from this object file.  */
 255
 256     struct obstack objfile_obstack;
 257
 258     /* A byte cache where we can stash arbitrary "chunks" of bytes that
 259        will not change.  */
 260
 261     struct psymbol_bcache *psymbol_cache; /* Byte cache for partial syms.  */
 262     struct bcache *macro_cache;           /* Byte cache for macros.  */
 263     struct bcache *filename_cache;        /* Byte cache for file names.  */
 264
 265     /* Hash table for mapping symbol names to demangled names.  Each
 266        entry in the hash table is actually two consecutive strings,
 267        both null-terminated; the first one is a mangled or linkage
 268        name, and the second is the demangled name or just a zero byte
 269        if the name doesn't demangle.  */
 270     struct htab *demangled_names_hash;
 271
 272     /* Vectors of all partial symbols read in from file.  The actual data
 273        is stored in the objfile_obstack.  */
 274
 275     struct psymbol_allocation_list global_psymbols;
 276     struct psymbol_allocation_list static_psymbols;
 277
 278     /* Each file contains a pointer to an array of minimal symbols for all
 279        global symbols that are defined within the file.  The array is
 280        terminated by a "null symbol", one that has a NULL pointer for the
 281        name and a zero value for the address.  This makes it easy to walk
 282        through the array when passed a pointer to somewhere in the middle
 283        of it.  There is also a count of the number of symbols, which does
 284        not include the terminating null symbol.  The array itself, as well
 285        as all the data that it points to, should be allocated on the
 286        objfile_obstack for this file.  */
 287
 288     struct minimal_symbol *msymbols;
 289     int minimal_symbol_count;
 290
 291     /* This is a hash table used to index the minimal symbols by name.  */
 292
 293     struct minimal_symbol *msymbol_hash[MINIMAL_SYMBOL_HASH_SIZE];
 294
 295     /* This hash table is used to index the minimal symbols by their
 296        demangled names.  */
 297
 298     struct minimal_symbol *msymbol_demangled_hash[MINIMAL_SYMBOL_HASH_SIZE];
 299
 300     /* Structure which keeps track of functions that manipulate objfile's
 301        of the same type as this objfile.  I.e. the function to read partial
 302        symbols for example.  Note that this structure is in statically
 303        allocated memory, and is shared by all objfiles that use the
 304        object module reader of this type.  */
 305
 306     const struct sym_fns *sf;
 307
 308     /* The per-objfile information about the entry point, the scope (file/func)
 309        containing the entry point, and the scope of the user's main() func.  */
 310
 311     struct entry_info ei;
 312
 313     /* Information about stabs.  Will be filled in with a dbx_symfile_info
 314        struct by those readers that need it.  */
 315     /* NOTE: cagney/2004-10-23: This has been replaced by per-objfile
 316        data points implemented using "data" and "num_data" below.  For
 317        an example of how to use this replacement, see "objfile_data"
 318        in "mips-tdep.c".  */
 319
 320     struct dbx_symfile_info *deprecated_sym_stab_info;
 321
 322     /* Hook for information for use by the symbol reader (currently used
 323        for information shared by sym_init and sym_read).  It is
 324        typically a pointer to malloc'd memory.  The symbol reader's finish
 325        function is responsible for freeing the memory thusly allocated.  */
 326     /* NOTE: cagney/2004-10-23: This has been replaced by per-objfile
 327        data points implemented using "data" and "num_data" below.  For
 328        an example of how to use this replacement, see "objfile_data"
 329        in "mips-tdep.c".  */
 330
 331     void *deprecated_sym_private;
 332
 333     /* Per objfile data-pointers required by other GDB modules.  */
 334     /* FIXME: kettenis/20030711: This mechanism could replace
 335        deprecated_sym_stab_info and deprecated_sym_private
 336        entirely.  */
 337
 338     void **data;
 339     unsigned num_data;
 340
 341     /* Set of relocation offsets to apply to each section.
 342        Currently on the objfile_obstack (which makes no sense, but I'm
 343        not sure it's harming anything).
 344
 345        These offsets indicate that all symbols (including partial and
 346        minimal symbols) which have been read have been relocated by this
 347        much.  Symbols which are yet to be read need to be relocated by
 348        it.  */
 349
 350     struct section_offsets *section_offsets;
 351     int num_sections;
 352
 353     /* Indexes in the section_offsets array.  These are initialized by the
 354        *_symfile_offsets() family of functions (som_symfile_offsets,
 355        xcoff_symfile_offsets, default_symfile_offsets).  In theory they
 356        should correspond to the section indexes used by bfd for the
 357        current objfile.  The exception to this for the time being is the
 358        SOM version.  */
 359
 360     int sect_index_text;
 361     int sect_index_data;
 362     int sect_index_bss;
 363     int sect_index_rodata;
 364
 365     /* These pointers are used to locate the section table, which
 366        among other things, is used to map pc addresses into sections.
 367        SECTIONS points to the first entry in the table, and
 368        SECTIONS_END points to the first location past the last entry
 369        in the table.  Currently the table is stored on the
 370        objfile_obstack (which makes no sense, but I'm not sure it's
 371        harming anything).  */
 372
 373     struct obj_section
 374      *sections, *sections_end;
 375
 376     /* GDB allows to have debug symbols in separate object files.  This is
 377        used by .gnu_debuglink, ELF build id note and Mach-O OSO.
 378        Although this is a tree structure, GDB only support one level
 379        (ie a separate debug for a separate debug is not supported).  Note that
 380        separate debug object are in the main chain and therefore will be
 381        visited by ALL_OBJFILES & co iterators.  Separate debug objfile always
 382        has a non-nul separate_debug_objfile_backlink.  */
 383
 384     /* Link to the first separate debug object, if any.  */
 385     struct objfile *separate_debug_objfile;
 386
 387     /* If this is a separate debug object, this is used as a link to the
 388        actual executable objfile.  */
 389     struct objfile *separate_debug_objfile_backlink;
 390
 391     /* If this is a separate debug object, this is a link to the next one
 392        for the same executable objfile.  */
 393     struct objfile *separate_debug_objfile_link;
 394
 395     /* Place to stash various statistics about this objfile.  */
 396       OBJSTATS;
 397
 398     /* A linked list of symbols created when reading template types or
 399        function templates.  These symbols are not stored in any symbol
 400        table, so we have to keep them here to relocate them
 401        properly.  */
 402     struct symbol *template_symbols;
 403   };
 404
 405 /* Defines for the objfile flag word.  */
 406
 407 /* When an object file has its functions reordered (currently Irix-5.2
 408    shared libraries exhibit this behaviour), we will need an expensive
 409    algorithm to locate a partial symtab or symtab via an address.
 410    To avoid this penalty for normal object files, we use this flag,
 411    whose setting is determined upon symbol table read in.  */
 412
 413 #define OBJF_REORDERED  (1 << 0)        /* Functions are reordered */
 414
 415 /* Distinguish between an objfile for a shared library and a "vanilla"
 416    objfile.  (If not set, the objfile may still actually be a solib.
 417    This can happen if the user created the objfile by using the
 418    add-symbol-file command.  GDB doesn't in that situation actually
 419    check whether the file is a solib.  Rather, the target's
 420    implementation of the solib interface is responsible for setting
 421    this flag when noticing solibs used by an inferior.)  */
 422
 423 #define OBJF_SHARED     (1 << 1)        /* From a shared library */
 424
 425 /* User requested that this objfile be read in it's entirety.  */
 426
 427 #define OBJF_READNOW    (1 << 2)        /* Immediate full read */
 428
 429 /* This objfile was created because the user explicitly caused it
 430    (e.g., used the add-symbol-file command).  This bit offers a way
 431    for run_command to remove old objfile entries which are no longer
 432    valid (i.e., are associated with an old inferior), but to preserve
 433    ones that the user explicitly loaded via the add-symbol-file
 434    command.  */
 435
 436 #define OBJF_USERLOADED (1 << 3)        /* User loaded */
 437
 438 /* Set if we have tried to read partial symtabs for this objfile.
 439    This is used to allow lazy reading of partial symtabs.  */
 440
 441 #define OBJF_PSYMTABS_READ (1 << 4)
 442
 443 /* Set if this is the main symbol file
 444    (as opposed to symbol file for dynamically loaded code).  */
 445
 446 #define OBJF_MAINLINE (1 << 5)
 447
 448 /* The object file that contains the runtime common minimal symbols
 449    for SunOS4.  Note that this objfile has no associated BFD.  */
 450
 451 extern struct objfile *rt_common_objfile;
 452
 453 /* Declarations for functions defined in objfiles.c */
 454
 455 extern struct objfile *allocate_objfile (bfd *, int);
 456
 457 extern struct gdbarch *get_objfile_arch (struct objfile *);
 458
 459 extern void init_entry_point_info (struct objfile *);
 460
 461 extern int entry_point_address_query (CORE_ADDR *entry_p);
 462
 463 extern CORE_ADDR entry_point_address (void);
 464
 465 extern int build_objfile_section_table (struct objfile *);
 466
 467 extern void terminate_minimal_symbol_table (struct objfile *objfile);
 468
 469 extern struct objfile *objfile_separate_debug_iterate (const struct objfile *,
 470                                                        const struct objfile *);
 471
 472 extern void put_objfile_before (struct objfile *, struct objfile *);
 473
 474 extern void objfile_to_front (struct objfile *);
 475
 476 extern void add_separate_debug_objfile (struct objfile *, struct objfile *);
 477
 478 extern void unlink_objfile (struct objfile *);
 479
 480 extern void free_objfile (struct objfile *);
 481
 482 extern void free_objfile_separate_debug (struct objfile *);
 483
 484 extern struct cleanup *make_cleanup_free_objfile (struct objfile *);
 485
 486 extern void free_all_objfiles (void);
 487
 488 extern void objfile_relocate (struct objfile *, struct section_offsets *);
 489
 490 extern int objfile_has_partial_symbols (struct objfile *objfile);
 491
 492 extern int objfile_has_full_symbols (struct objfile *objfile);
 493
 494 extern int objfile_has_symbols (struct objfile *objfile);
 495
 496 extern int have_partial_symbols (void);
 497
 498 extern int have_full_symbols (void);
 499
 500 extern void objfiles_changed (void);
 501
 502 /* This operation deletes all objfile entries that represent solibs that
 503    weren't explicitly loaded by the user, via e.g., the add-symbol-file
 504    command.  */
 505
 506 extern void objfile_purge_solibs (void);
 507
 508 /* Functions for dealing with the minimal symbol table, really a misc
 509    address<->symbol mapping for things we don't have debug symbols for.  */
 510
 511 extern int have_minimal_symbols (void);
 512
 513 extern struct obj_section *find_pc_section (CORE_ADDR pc);
 514
 515 extern int in_plt_section (CORE_ADDR, char *);
 516
 517 /* Keep a registry of per-objfile data-pointers required by other GDB
 518    modules.  */
 519
 520 /* Allocate an entry in the per-objfile registry.  */
 521 extern const struct objfile_data *register_objfile_data (void);
 522
 523 /* Allocate an entry in the per-objfile registry.
 524    SAVE and FREE are called when clearing objfile data.
 525    First all registered SAVE functions are called.
 526    Then all registered FREE functions are called.
 527    Either or both of SAVE, FREE may be NULL.  */
 528 extern const struct objfile_data *register_objfile_data_with_cleanup
 529   (void (*save) (struct objfile *, void *),
 530    void (*free) (struct objfile *, void *));
 531
 532 extern void clear_objfile_data (struct objfile *objfile);
 533 extern void set_objfile_data (struct objfile *objfile,
 534                               const struct objfile_data *data, void *value);
 535 extern void *objfile_data (struct objfile *objfile,
 536                            const struct objfile_data *data);
 537
 538 extern struct bfd *gdb_bfd_ref (struct bfd *abfd);
 539 extern void gdb_bfd_unref (struct bfd *abfd);
 540 extern int gdb_bfd_close_or_warn (struct bfd *abfd);
 541 \f
 542
 543 /* Traverse all object files in the current program space.
 544    ALL_OBJFILES_SAFE works even if you delete the objfile during the
 545    traversal.  */
 546
 547 /* Traverse all object files in program space SS.  */
 548
 549 #define ALL_PSPACE_OBJFILES(ss, obj)                                    \
 550   for ((obj) = ss->objfiles; (obj) != NULL; (obj) = (obj)->next)        \
 551
 552 #define ALL_PSPACE_OBJFILES_SAFE(ss, obj, nxt)          \
 553   for ((obj) = ss->objfiles;                    \
 554        (obj) != NULL? ((nxt)=(obj)->next,1) :0; \
 555        (obj) = (nxt))
 556
 557 #define ALL_OBJFILES(obj)                           \
 558   for ((obj) = current_program_space->objfiles; \
 559        (obj) != NULL;                               \
 560        (obj) = (obj)->next)
 561
 562 #define ALL_OBJFILES_SAFE(obj,nxt)                      \
 563   for ((obj) = current_program_space->objfiles; \
 564        (obj) != NULL? ((nxt)=(obj)->next,1) :0; \
 565        (obj) = (nxt))
 566
 567 /* Traverse all symtabs in one objfile.  */
 568
 569 #define ALL_OBJFILE_SYMTABS(objfile, s) \
 570     for ((s) = (objfile) -> symtabs; (s) != NULL; (s) = (s) -> next)
 571
 572 /* Traverse all minimal symbols in one objfile.  */
 573
 574 #define ALL_OBJFILE_MSYMBOLS(objfile, m) \
 575     for ((m) = (objfile) -> msymbols; SYMBOL_LINKAGE_NAME(m) != NULL; (m)++)
 576
 577 /* Traverse all symtabs in all objfiles in the current symbol
 578    space.  */
 579
 580 #define ALL_SYMTABS(objfile, s) \
 581   ALL_OBJFILES (objfile)         \
 582     ALL_OBJFILE_SYMTABS (objfile, s)
 583
 584 #define ALL_PSPACE_SYMTABS(ss, objfile, s)              \
 585   ALL_PSPACE_OBJFILES (ss, objfile)                     \
 586     ALL_OBJFILE_SYMTABS (objfile, s)
 587
 588 /* Traverse all symtabs in all objfiles in the current program space,
 589    skipping included files (which share a blockvector with their
 590    primary symtab).  */
 591
 592 #define ALL_PRIMARY_SYMTABS(objfile, s) \
 593   ALL_OBJFILES (objfile)                \
 594     ALL_OBJFILE_SYMTABS (objfile, s)    \
 595       if ((s)->primary)
 596
 597 #define ALL_PSPACE_PRIMARY_SYMTABS(pspace, objfile, s)  \
 598   ALL_PSPACE_OBJFILES (ss, objfile)                     \
 599     ALL_OBJFILE_SYMTABS (objfile, s)                    \
 600       if ((s)->primary)
 601
 602 /* Traverse all minimal symbols in all objfiles in the current symbol
 603    space.  */
 604
 605 #define ALL_MSYMBOLS(objfile, m) \
 606   ALL_OBJFILES (objfile)         \
 607     ALL_OBJFILE_MSYMBOLS (objfile, m)
 608
 609 #define ALL_OBJFILE_OSECTIONS(objfile, osect)   \
 610   for (osect = objfile->sections; osect < objfile->sections_end; osect++)
 611
 612 /* Traverse all obj_sections in all objfiles in the current program
 613    space.
 614
 615    Note that this detects a "break" in the inner loop, and exits
 616    immediately from the outer loop as well, thus, client code doesn't
 617    need to know that this is implemented with a double for.  The extra
 618    hair is to make sure that a "break;" stops the outer loop iterating
 619    as well, and both OBJFILE and OSECT are left unmodified:
 620
 621     - The outer loop learns about the inner loop's end condition, and
 622       stops iterating if it detects the inner loop didn't reach its
 623       end.  In other words, the outer loop keeps going only if the
 624       inner loop reached its end cleanly [(osect) ==
 625       (objfile)->sections_end].
 626
 627     - OSECT is initialized in the outer loop initialization
 628       expressions, such as if the inner loop has reached its end, so
 629       the check mentioned above succeeds the first time.
 630
 631     - The trick to not clearing OBJFILE on a "break;" is, in the outer
 632       loop's loop expression, advance OBJFILE, but iff the inner loop
 633       reached its end.  If not, there was a "break;", so leave OBJFILE
 634       as is; the outer loop's conditional will break immediately as
 635       well (as OSECT will be different from OBJFILE->sections_end).  */
 636
 637 #define ALL_OBJSECTIONS(objfile, osect)                                 \
 638   for ((objfile) = current_program_space->objfiles,                     \
 639          (objfile) != NULL ? ((osect) = (objfile)->sections_end) : 0;   \
 640        (objfile) != NULL                                                \
 641          && (osect) == (objfile)->sections_end;                         \
 642        ((osect) == (objfile)->sections_end                              \
 643         ? ((objfile) = (objfile)->next,                                 \
 644            (objfile) != NULL ? (osect) = (objfile)->sections_end : 0)   \
 645         : 0))                                                           \
 646     for ((osect) = (objfile)->sections;                                 \
 647          (osect) < (objfile)->sections_end;                             \
 648          (osect)++)
 649
 650 #define SECT_OFF_DATA(objfile) \
 651      ((objfile->sect_index_data == -1) \
 652       ? (internal_error (__FILE__, __LINE__, \
 653                          _("sect_index_data not initialized")), -1)     \
 654       : objfile->sect_index_data)
 655
 656 #define SECT_OFF_RODATA(objfile) \
 657      ((objfile->sect_index_rodata == -1) \
 658       ? (internal_error (__FILE__, __LINE__, \
 659                          _("sect_index_rodata not initialized")), -1)   \
 660       : objfile->sect_index_rodata)
 661
 662 #define SECT_OFF_TEXT(objfile) \
 663      ((objfile->sect_index_text == -1) \
 664       ? (internal_error (__FILE__, __LINE__, \
 665                          _("sect_index_text not initialized")), -1)     \
 666       : objfile->sect_index_text)
 667
 668 /* Sometimes the .bss section is missing from the objfile, so we don't
 669    want to die here.  Let the users of SECT_OFF_BSS deal with an
 670    uninitialized section index.  */
 671 #define SECT_OFF_BSS(objfile) (objfile)->sect_index_bss
 672
 673 /* Answer whether there is more than one object file loaded.  */
 674
 675 #define MULTI_OBJFILE_P() (object_files && object_files->next)
 676
 677 #endif /* !defined (OBJFILES_H) */