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