gdb/objfiles.h

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