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