"$ gdb PROGRAM" vs "(gdb) file PROGRAM" difference; warn on failure to remove breakpoint.
[external/binutils.git] / 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.  This may come from a target's implementation of the solib
431    interface, from add-symbol-file, or any other mechanism that loads
432    dynamic objects.  */
433
434 #define OBJF_SHARED     (1 << 1)        /* From a shared library */
435
436 /* User requested that this objfile be read in it's entirety.  */
437
438 #define OBJF_READNOW    (1 << 2)        /* Immediate full read */
439
440 /* This objfile was created because the user explicitly caused it
441    (e.g., used the add-symbol-file command).  This bit offers a way
442    for run_command to remove old objfile entries which are no longer
443    valid (i.e., are associated with an old inferior), but to preserve
444    ones that the user explicitly loaded via the add-symbol-file
445    command.  */
446
447 #define OBJF_USERLOADED (1 << 3)        /* User loaded */
448
449 /* Set if we have tried to read partial symtabs for this objfile.
450    This is used to allow lazy reading of partial symtabs.  */
451
452 #define OBJF_PSYMTABS_READ (1 << 4)
453
454 /* Set if this is the main symbol file
455    (as opposed to symbol file for dynamically loaded code).  */
456
457 #define OBJF_MAINLINE (1 << 5)
458
459 /* ORIGINAL_NAME and OBFD->FILENAME correspond to text description unrelated to
460    filesystem names.  It can be for example "<image in memory>".  */
461
462 #define OBJF_NOT_FILENAME (1 << 6)
463
464 /* Declarations for functions defined in objfiles.c */
465
466 extern struct objfile *allocate_objfile (bfd *, const char *name, int);
467
468 extern struct gdbarch *get_objfile_arch (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 add_separate_debug_objfile (struct objfile *, struct objfile *);
484
485 extern void unlink_objfile (struct objfile *);
486
487 extern void free_objfile (struct objfile *);
488
489 extern void free_objfile_separate_debug (struct objfile *);
490
491 extern struct cleanup *make_cleanup_free_objfile (struct objfile *);
492
493 extern void free_all_objfiles (void);
494
495 extern void objfile_relocate (struct objfile *, const struct section_offsets *);
496 extern void objfile_rebase (struct objfile *, CORE_ADDR);
497
498 extern int objfile_has_partial_symbols (struct objfile *objfile);
499
500 extern int objfile_has_full_symbols (struct objfile *objfile);
501
502 extern int objfile_has_symbols (struct objfile *objfile);
503
504 extern int have_partial_symbols (void);
505
506 extern int have_full_symbols (void);
507
508 extern void objfile_set_sym_fns (struct objfile *objfile,
509                                  const struct sym_fns *sf);
510
511 extern void objfiles_changed (void);
512
513 extern int is_addr_in_objfile (CORE_ADDR addr, const struct objfile *objfile);
514
515 /* Return true if ADDRESS maps into one of the sections of a
516    OBJF_SHARED objfile of PSPACE and false otherwise.  */
517
518 extern int shared_objfile_contains_address_p (struct program_space *pspace,
519                                               CORE_ADDR address);
520
521 /* This operation deletes all objfile entries that represent solibs that
522    weren't explicitly loaded by the user, via e.g., the add-symbol-file
523    command.  */
524
525 extern void objfile_purge_solibs (void);
526
527 /* Functions for dealing with the minimal symbol table, really a misc
528    address<->symbol mapping for things we don't have debug symbols for.  */
529
530 extern int have_minimal_symbols (void);
531
532 extern struct obj_section *find_pc_section (CORE_ADDR pc);
533
534 /* Return non-zero if PC is in a section called NAME.  */
535 extern int pc_in_section (CORE_ADDR, char *);
536
537 /* Return non-zero if PC is in a SVR4-style procedure linkage table
538    section.  */
539
540 static inline int
541 in_plt_section (CORE_ADDR pc)
542 {
543   return pc_in_section (pc, ".plt");
544 }
545
546 /* Keep a registry of per-objfile data-pointers required by other GDB
547    modules.  */
548 DECLARE_REGISTRY(objfile);
549
550 /* In normal use, the section map will be rebuilt by find_pc_section
551    if objfiles have been added, removed or relocated since it was last
552    called.  Calling inhibit_section_map_updates will inhibit this
553    behavior until resume_section_map_updates is called.  If you call
554    inhibit_section_map_updates you must ensure that every call to
555    find_pc_section in the inhibited region relates to a section that
556    is already in the section map and has not since been removed or
557    relocated.  */
558 extern void inhibit_section_map_updates (struct program_space *pspace);
559
560 /* Resume automatically rebuilding the section map as required.  */
561 extern void resume_section_map_updates (struct program_space *pspace);
562
563 /* Version of the above suitable for use as a cleanup.  */
564 extern void resume_section_map_updates_cleanup (void *arg);
565
566 extern void default_iterate_over_objfiles_in_search_order
567   (struct gdbarch *gdbarch,
568    iterate_over_objfiles_in_search_order_cb_ftype *cb,
569    void *cb_data, struct objfile *current_objfile);
570 \f
571
572 /* Traverse all object files in the current program space.
573    ALL_OBJFILES_SAFE works even if you delete the objfile during the
574    traversal.  */
575
576 /* Traverse all object files in program space SS.  */
577
578 #define ALL_PSPACE_OBJFILES(ss, obj)                                    \
579   for ((obj) = ss->objfiles; (obj) != NULL; (obj) = (obj)->next)
580
581 #define ALL_PSPACE_OBJFILES_SAFE(ss, obj, nxt)          \
582   for ((obj) = ss->objfiles;                    \
583        (obj) != NULL? ((nxt)=(obj)->next,1) :0; \
584        (obj) = (nxt))
585
586 #define ALL_OBJFILES(obj)                           \
587   for ((obj) = current_program_space->objfiles; \
588        (obj) != NULL;                               \
589        (obj) = (obj)->next)
590
591 #define ALL_OBJFILES_SAFE(obj,nxt)                      \
592   for ((obj) = current_program_space->objfiles; \
593        (obj) != NULL? ((nxt)=(obj)->next,1) :0; \
594        (obj) = (nxt))
595
596 /* Traverse all symtabs in one objfile.  */
597
598 #define ALL_OBJFILE_SYMTABS(objfile, s) \
599     for ((s) = (objfile) -> symtabs; (s) != NULL; (s) = (s) -> next)
600
601 /* Traverse all primary symtabs in one objfile.  */
602
603 #define ALL_OBJFILE_PRIMARY_SYMTABS(objfile, s) \
604   ALL_OBJFILE_SYMTABS ((objfile), (s)) \
605     if ((s)->primary)
606
607 /* Traverse all minimal symbols in one objfile.  */
608
609 #define ALL_OBJFILE_MSYMBOLS(objfile, m)        \
610     for ((m) = (objfile)->per_bfd->msymbols;    \
611          MSYMBOL_LINKAGE_NAME (m) != NULL;      \
612          (m)++)
613
614 /* Traverse all symtabs in all objfiles in the current symbol
615    space.  */
616
617 #define ALL_SYMTABS(objfile, s) \
618   ALL_OBJFILES (objfile)         \
619     ALL_OBJFILE_SYMTABS (objfile, s)
620
621 #define ALL_PSPACE_SYMTABS(ss, objfile, s)              \
622   ALL_PSPACE_OBJFILES (ss, objfile)                     \
623     ALL_OBJFILE_SYMTABS (objfile, s)
624
625 /* Traverse all symtabs in all objfiles in the current program space,
626    skipping included files (which share a blockvector with their
627    primary symtab).  */
628
629 #define ALL_PRIMARY_SYMTABS(objfile, s) \
630   ALL_OBJFILES (objfile)                \
631     ALL_OBJFILE_PRIMARY_SYMTABS (objfile, s)
632
633 #define ALL_PSPACE_PRIMARY_SYMTABS(pspace, objfile, s)  \
634   ALL_PSPACE_OBJFILES (ss, objfile)                     \
635     ALL_OBJFILE_PRIMARY_SYMTABS (objfile, s)
636
637 /* Traverse all minimal symbols in all objfiles in the current symbol
638    space.  */
639
640 #define ALL_MSYMBOLS(objfile, m) \
641   ALL_OBJFILES (objfile)         \
642     ALL_OBJFILE_MSYMBOLS (objfile, m)
643
644 #define ALL_OBJFILE_OSECTIONS(objfile, osect)   \
645   for (osect = objfile->sections; osect < objfile->sections_end; osect++) \
646     if (osect->the_bfd_section == NULL)                                 \
647       {                                                                 \
648         /* Nothing.  */                                                 \
649       }                                                                 \
650     else
651
652 /* Traverse all obj_sections in all objfiles in the current program
653    space.
654
655    Note that this detects a "break" in the inner loop, and exits
656    immediately from the outer loop as well, thus, client code doesn't
657    need to know that this is implemented with a double for.  The extra
658    hair is to make sure that a "break;" stops the outer loop iterating
659    as well, and both OBJFILE and OSECT are left unmodified:
660
661     - The outer loop learns about the inner loop's end condition, and
662       stops iterating if it detects the inner loop didn't reach its
663       end.  In other words, the outer loop keeps going only if the
664       inner loop reached its end cleanly [(osect) ==
665       (objfile)->sections_end].
666
667     - OSECT is initialized in the outer loop initialization
668       expressions, such as if the inner loop has reached its end, so
669       the check mentioned above succeeds the first time.
670
671     - The trick to not clearing OBJFILE on a "break;" is, in the outer
672       loop's loop expression, advance OBJFILE, but iff the inner loop
673       reached its end.  If not, there was a "break;", so leave OBJFILE
674       as is; the outer loop's conditional will break immediately as
675       well (as OSECT will be different from OBJFILE->sections_end).  */
676
677 #define ALL_OBJSECTIONS(objfile, osect)                                 \
678   for ((objfile) = current_program_space->objfiles,                     \
679          (objfile) != NULL ? ((osect) = (objfile)->sections_end) : 0;   \
680        (objfile) != NULL                                                \
681          && (osect) == (objfile)->sections_end;                         \
682        ((osect) == (objfile)->sections_end                              \
683         ? ((objfile) = (objfile)->next,                                 \
684            (objfile) != NULL ? (osect) = (objfile)->sections_end : 0)   \
685         : 0))                                                           \
686     ALL_OBJFILE_OSECTIONS (objfile, osect)
687
688 #define SECT_OFF_DATA(objfile) \
689      ((objfile->sect_index_data == -1) \
690       ? (internal_error (__FILE__, __LINE__, \
691                          _("sect_index_data not initialized")), -1)     \
692       : objfile->sect_index_data)
693
694 #define SECT_OFF_RODATA(objfile) \
695      ((objfile->sect_index_rodata == -1) \
696       ? (internal_error (__FILE__, __LINE__, \
697                          _("sect_index_rodata not initialized")), -1)   \
698       : objfile->sect_index_rodata)
699
700 #define SECT_OFF_TEXT(objfile) \
701      ((objfile->sect_index_text == -1) \
702       ? (internal_error (__FILE__, __LINE__, \
703                          _("sect_index_text not initialized")), -1)     \
704       : objfile->sect_index_text)
705
706 /* Sometimes the .bss section is missing from the objfile, so we don't
707    want to die here.  Let the users of SECT_OFF_BSS deal with an
708    uninitialized section index.  */
709 #define SECT_OFF_BSS(objfile) (objfile)->sect_index_bss
710
711 /* Answer whether there is more than one object file loaded.  */
712
713 #define MULTI_OBJFILE_P() (object_files && object_files->next)
714
715 /* Reset the per-BFD storage area on OBJ.  */
716
717 void set_objfile_per_bfd (struct objfile *obj);
718
719 const char *objfile_name (const struct objfile *objfile);
720
721 /* Set the objfile's notion of the "main" name and language.  */
722
723 extern void set_objfile_main_name (struct objfile *objfile,
724                                    const char *name, enum language lang);
725
726 #endif /* !defined (OBJFILES_H) */