gdb/objfiles.h

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