Add new target_read_raw_memory function, and consolidate comments.
[deliverable/binutils-gdb.git] / gdb / objfiles.h
CommitLineData
c906108c 1/* Definitions for symbol file management in GDB.
af5f3db6 2
28e7fd62 3 Copyright (C) 1992-2013 Free Software Foundation, Inc.
c906108c 4
c5aa993b 5 This file is part of GDB.
c906108c 6
c5aa993b
JM
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
a9762ec7 9 the Free Software Foundation; either version 3 of the License, or
c5aa993b 10 (at your option) any later version.
c906108c 11
c5aa993b
JM
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.
c906108c 16
c5aa993b 17 You should have received a copy of the GNU General Public License
a9762ec7 18 along with this program. If not, see <http://www.gnu.org/licenses/>. */
c906108c
SS
19
20#if !defined (OBJFILES_H)
21#define OBJFILES_H
22
3956d554 23#include "gdb_obstack.h" /* For obstack internals. */
0df8b418 24#include "symfile.h" /* For struct psymbol_allocation_list. */
6c95b8df 25#include "progspace.h"
8e260fc0 26#include "registry.h"
65cf3563 27#include "gdb_bfd.h"
3956d554 28
af5f3db6 29struct bcache;
2de7ced7 30struct htab;
5c4e30ca 31struct symtab;
4a4b3fed 32struct objfile_data;
08c0b5bc 33
c906108c
SS
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
73c1e0a1
AC
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
627b3ba2
AC
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
0df8b418 52 "startup file", i.e. crt0.o in most cases. This file is assumed to
627b3ba2
AC
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
2f72f850 59 to test for "inside entry file" destroys a meaningful backtrace
0df8b418 60 under some conditions. E.g. the backtrace tests in the asm-source
627b3ba2
AC
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".
c906108c
SS
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
618ce49f
AC
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
c906108c
SS
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
6e4c6c91 100 from user code don't go wandering off into the startup code. */
c906108c
SS
101
102struct entry_info
c5aa993b 103 {
abd0a5fa 104 /* The relocated value we should use for this objfile entry point. */
c5aa993b 105 CORE_ADDR entry_point;
c906108c 106
abd0a5fa
JK
107 /* Set to 1 iff ENTRY_POINT contains a valid value. */
108 unsigned entry_point_p : 1;
c5aa993b 109 };
c906108c 110
f1f6aadf
PA
111/* Sections in an objfile. The section offsets are stored in the
112 OBJFILE. */
c906108c 113
c5aa993b
JM
114struct obj_section
115 {
7be0c536 116 struct bfd_section *the_bfd_section; /* BFD section pointer */
c906108c 117
c5aa993b
JM
118 /* Objfile this section is part of. */
119 struct objfile *objfile;
c906108c 120
0df8b418 121 /* True if this "overlay section" is mapped into an "overlay region". */
c5aa993b
JM
122 int ovly_mapped;
123 };
c906108c 124
f1f6aadf
PA
125/* Relocation offset applied to S. */
126#define obj_section_offset(s) \
65cf3563 127 (((s)->objfile->section_offsets)->offsets[gdb_bfd_section_index ((s)->objfile->obfd, (s)->the_bfd_section)])
f1f6aadf
PA
128
129/* The memory address of section S (vma + offset). */
130#define obj_section_addr(s) \
1706c199 131 (bfd_get_section_vma ((s)->objfile->obfd, s->the_bfd_section) \
f1f6aadf
PA
132 + obj_section_offset (s))
133
134/* The one-passed-the-end memory address of section S
135 (vma + size + offset). */
136#define obj_section_endaddr(s) \
1706c199 137 (bfd_get_section_vma ((s)->objfile->obfd, s->the_bfd_section) \
f1f6aadf
PA
138 + bfd_get_section_size ((s)->the_bfd_section) \
139 + obj_section_offset (s))
c906108c 140
c906108c
SS
141/* The "objstats" structure provides a place for gdb to record some
142 interesting information about its internal state at runtime, on a
143 per objfile basis, such as information about the number of symbols
0df8b418 144 read, size of string table (if any), etc. */
c906108c 145
c5aa993b
JM
146struct objstats
147 {
148 int n_minsyms; /* Number of minimal symbols read */
149 int n_psyms; /* Number of partial symbols read */
150 int n_syms; /* Number of full symbols read */
151 int n_stabs; /* Number of ".stabs" read (if applicable) */
152 int n_types; /* Number of types */
153 int sz_strtab; /* Size of stringtable, (if applicable) */
154 };
c906108c
SS
155
156#define OBJSTAT(objfile, expr) (objfile -> stats.expr)
157#define OBJSTATS struct objstats stats
a14ed312
KB
158extern void print_objfile_statistics (void);
159extern void print_symbol_bcache_statistics (void);
c906108c 160
9227b5eb 161/* Number of entries in the minimal symbol hash table. */
375f3d86 162#define MINIMAL_SYMBOL_HASH_SIZE 2039
9227b5eb 163
706e3705
TT
164/* Some objfile data is hung off the BFD. This enables sharing of the
165 data across all objfiles using the BFD. The data is stored in an
166 instance of this structure, and associated with the BFD using the
167 registry system. */
168
169struct objfile_per_bfd_storage
170{
171 /* The storage has an obstack of its own. */
172
173 struct obstack storage_obstack;
174
175 /* Byte cache for file names. */
176
177 struct bcache *filename_cache;
6532ff36
TT
178
179 /* Byte cache for macros. */
180 struct bcache *macro_cache;
df6d5441
TT
181
182 /* The gdbarch associated with the BFD. Note that this gdbarch is
183 determined solely from BFD information, without looking at target
184 information. The gdbarch determined from a running target may
185 differ from this e.g. with respect to register types and names. */
186
187 struct gdbarch *gdbarch;
84a1243b
TT
188
189 /* Hash table for mapping symbol names to demangled names. Each
190 entry in the hash table is actually two consecutive strings,
191 both null-terminated; the first one is a mangled or linkage
192 name, and the second is the demangled name or just a zero byte
193 if the name doesn't demangle. */
194 struct htab *demangled_names_hash;
706e3705
TT
195};
196
c906108c
SS
197/* Master structure for keeping track of each file from which
198 gdb reads symbols. There are several ways these get allocated: 1.
199 The main symbol file, symfile_objfile, set by the symbol-file command,
200 2. Additional symbol files added by the add-symbol-file command,
201 3. Shared library objfiles, added by ADD_SOLIB, 4. symbol files
202 for modules that were loaded when GDB attached to a remote system
203 (see remote-vx.c). */
204
205struct objfile
c5aa993b 206 {
c906108c 207
c5aa993b 208 /* All struct objfile's are chained together by their next pointers.
ff011ed7
TT
209 The program space field "objfiles" (frequently referenced via
210 the macro "object_files") points to the first link in this
211 chain. */
c906108c 212
c5aa993b 213 struct objfile *next;
c906108c 214
e1507e95
TT
215 /* The object file's name, tilde-expanded and absolute. This
216 pointer is never NULL. This does not have to be freed; it is
217 guaranteed to have a lifetime at least as long as the objfile. */
c906108c 218
4262abfb 219 char *original_name;
c906108c 220
e4f6d2ec
TJB
221 CORE_ADDR addr_low;
222
0838fb57
DE
223 /* Some flag bits for this objfile.
224 The values are defined by OBJF_*. */
c906108c 225
c5aa993b 226 unsigned short flags;
c906108c 227
6c95b8df
PA
228 /* The program space associated with this objfile. */
229
230 struct program_space *pspace;
231
c5aa993b
JM
232 /* Each objfile points to a linked list of symtabs derived from this file,
233 one symtab structure for each compilation unit (source file). Each link
0df8b418 234 in the symtab list contains a backpointer to this objfile. */
c906108c 235
c5aa993b 236 struct symtab *symtabs;
c906108c 237
c5aa993b
JM
238 /* Each objfile points to a linked list of partial symtabs derived from
239 this file, one partial symtab structure for each compilation unit
0df8b418 240 (source file). */
c906108c 241
c5aa993b 242 struct partial_symtab *psymtabs;
c906108c 243
ff013f42
JK
244 /* Map addresses to the entries of PSYMTABS. It would be more efficient to
245 have a map per the whole process but ADDRMAP cannot selectively remove
246 its items during FREE_OBJFILE. This mapping is already present even for
247 PARTIAL_SYMTABs which still have no corresponding full SYMTABs read. */
248
249 struct addrmap *psymtabs_addrmap;
250
0df8b418 251 /* List of freed partial symtabs, available for re-use. */
c906108c 252
c5aa993b 253 struct partial_symtab *free_psymtabs;
c906108c 254
c5aa993b
JM
255 /* The object file's BFD. Can be null if the objfile contains only
256 minimal symbols, e.g. the run time common symbols for SunOS4. */
c906108c 257
c5aa993b 258 bfd *obfd;
c906108c 259
706e3705
TT
260 /* The per-BFD data. Note that this is treated specially if OBFD
261 is NULL. */
262
263 struct objfile_per_bfd_storage *per_bfd;
264
c5aa993b
JM
265 /* The modification timestamp of the object file, as of the last time
266 we read its symbols. */
c906108c 267
c5aa993b 268 long mtime;
c906108c 269
b99607ea 270 /* Obstack to hold objects that should be freed when we load a new symbol
0df8b418 271 table from this object file. */
b99607ea 272
b99607ea
EZ
273 struct obstack objfile_obstack;
274
c5aa993b 275 /* A byte cache where we can stash arbitrary "chunks" of bytes that
0df8b418 276 will not change. */
c906108c 277
0df8b418 278 struct psymbol_bcache *psymbol_cache; /* Byte cache for partial syms. */
c906108c 279
c5aa993b 280 /* Vectors of all partial symbols read in from file. The actual data
0df8b418 281 is stored in the objfile_obstack. */
c906108c 282
c5aa993b
JM
283 struct psymbol_allocation_list global_psymbols;
284 struct psymbol_allocation_list static_psymbols;
c906108c 285
c5aa993b 286 /* Each file contains a pointer to an array of minimal symbols for all
3e43a32a
MS
287 global symbols that are defined within the file. The array is
288 terminated by a "null symbol", one that has a NULL pointer for the
289 name and a zero value for the address. This makes it easy to walk
290 through the array when passed a pointer to somewhere in the middle
291 of it. There is also a count of the number of symbols, which does
292 not include the terminating null symbol. The array itself, as well
293 as all the data that it points to, should be allocated on the
0df8b418 294 objfile_obstack for this file. */
c906108c 295
c5aa993b
JM
296 struct minimal_symbol *msymbols;
297 int minimal_symbol_count;
c906108c 298
9227b5eb
JB
299 /* This is a hash table used to index the minimal symbols by name. */
300
301 struct minimal_symbol *msymbol_hash[MINIMAL_SYMBOL_HASH_SIZE];
302
303 /* This hash table is used to index the minimal symbols by their
304 demangled names. */
305
306 struct minimal_symbol *msymbol_demangled_hash[MINIMAL_SYMBOL_HASH_SIZE];
307
c5aa993b 308 /* Structure which keeps track of functions that manipulate objfile's
0df8b418 309 of the same type as this objfile. I.e. the function to read partial
c5aa993b
JM
310 symbols for example. Note that this structure is in statically
311 allocated memory, and is shared by all objfiles that use the
0df8b418 312 object module reader of this type. */
c906108c 313
00b5771c 314 const struct sym_fns *sf;
c906108c 315
c5aa993b 316 /* The per-objfile information about the entry point, the scope (file/func)
0df8b418 317 containing the entry point, and the scope of the user's main() func. */
c906108c 318
c5aa993b 319 struct entry_info ei;
c906108c 320
0d0e1a63 321 /* Per objfile data-pointers required by other GDB modules. */
0d0e1a63 322
8e260fc0 323 REGISTRY_FIELDS;
0d0e1a63 324
c5aa993b 325 /* Set of relocation offsets to apply to each section.
d82ea6a8
DE
326 The table is indexed by the_bfd_section->index, thus it is generally
327 as large as the number of sections in the binary.
328 The table is stored on the objfile_obstack.
c906108c 329
c5aa993b
JM
330 These offsets indicate that all symbols (including partial and
331 minimal symbols) which have been read have been relocated by this
d82ea6a8 332 much. Symbols which are yet to be read need to be relocated by it. */
c906108c 333
c5aa993b
JM
334 struct section_offsets *section_offsets;
335 int num_sections;
c906108c 336
0df8b418 337 /* Indexes in the section_offsets array. These are initialized by the
b8fbeb18 338 *_symfile_offsets() family of functions (som_symfile_offsets,
0df8b418 339 xcoff_symfile_offsets, default_symfile_offsets). In theory they
b8fbeb18 340 should correspond to the section indexes used by bfd for the
0df8b418
MS
341 current objfile. The exception to this for the time being is the
342 SOM version. */
b8fbeb18
EZ
343
344 int sect_index_text;
345 int sect_index_data;
346 int sect_index_bss;
347 int sect_index_rodata;
348
96baa820 349 /* These pointers are used to locate the section table, which
5c44784c 350 among other things, is used to map pc addresses into sections.
96baa820
JM
351 SECTIONS points to the first entry in the table, and
352 SECTIONS_END points to the first location past the last entry
65cf3563
TT
353 in the table. The table is stored on the objfile_obstack. The
354 sections are indexed by the BFD section index; but the
355 structure data is only valid for certain sections
356 (e.g. non-empty, SEC_ALLOC). */
c906108c 357
d82ea6a8 358 struct obj_section *sections, *sections_end;
c906108c 359
15d123c9
TG
360 /* GDB allows to have debug symbols in separate object files. This is
361 used by .gnu_debuglink, ELF build id note and Mach-O OSO.
362 Although this is a tree structure, GDB only support one level
363 (ie a separate debug for a separate debug is not supported). Note that
364 separate debug object are in the main chain and therefore will be
365 visited by ALL_OBJFILES & co iterators. Separate debug objfile always
366 has a non-nul separate_debug_objfile_backlink. */
367
368 /* Link to the first separate debug object, if any. */
5b5d99cf
JB
369 struct objfile *separate_debug_objfile;
370
371 /* If this is a separate debug object, this is used as a link to the
0df8b418 372 actual executable objfile. */
5b5d99cf 373 struct objfile *separate_debug_objfile_backlink;
15d123c9
TG
374
375 /* If this is a separate debug object, this is a link to the next one
376 for the same executable objfile. */
377 struct objfile *separate_debug_objfile_link;
378
0df8b418 379 /* Place to stash various statistics about this objfile. */
d82ea6a8 380 OBJSTATS;
5c4e30ca 381
34eaf542
TT
382 /* A linked list of symbols created when reading template types or
383 function templates. These symbols are not stored in any symbol
384 table, so we have to keep them here to relocate them
385 properly. */
386 struct symbol *template_symbols;
c5aa993b 387 };
c906108c 388
0df8b418 389/* Defines for the objfile flag word. */
c906108c 390
c906108c
SS
391/* When an object file has its functions reordered (currently Irix-5.2
392 shared libraries exhibit this behaviour), we will need an expensive
393 algorithm to locate a partial symtab or symtab via an address.
394 To avoid this penalty for normal object files, we use this flag,
395 whose setting is determined upon symbol table read in. */
396
8b41ec65 397#define OBJF_REORDERED (1 << 0) /* Functions are reordered */
c5aa993b 398
2df3850c 399/* Distinguish between an objfile for a shared library and a "vanilla"
0df8b418 400 objfile. (If not set, the objfile may still actually be a solib.
2df3850c
JM
401 This can happen if the user created the objfile by using the
402 add-symbol-file command. GDB doesn't in that situation actually
403 check whether the file is a solib. Rather, the target's
404 implementation of the solib interface is responsible for setting
405 this flag when noticing solibs used by an inferior.) */
c906108c 406
8b41ec65 407#define OBJF_SHARED (1 << 1) /* From a shared library */
c906108c 408
0df8b418 409/* User requested that this objfile be read in it's entirety. */
2acceee2 410
8b41ec65 411#define OBJF_READNOW (1 << 2) /* Immediate full read */
2acceee2 412
2df3850c
JM
413/* This objfile was created because the user explicitly caused it
414 (e.g., used the add-symbol-file command). This bit offers a way
415 for run_command to remove old objfile entries which are no longer
416 valid (i.e., are associated with an old inferior), but to preserve
417 ones that the user explicitly loaded via the add-symbol-file
0df8b418 418 command. */
2df3850c 419
8b41ec65 420#define OBJF_USERLOADED (1 << 3) /* User loaded */
2df3850c 421
b11896a5
TT
422/* Set if we have tried to read partial symtabs for this objfile.
423 This is used to allow lazy reading of partial symtabs. */
424
425#define OBJF_PSYMTABS_READ (1 << 4)
426
0838fb57
DE
427/* Set if this is the main symbol file
428 (as opposed to symbol file for dynamically loaded code). */
429
430#define OBJF_MAINLINE (1 << 5)
431
40135bb1
JK
432/* ORIGINAL_NAME and OBFD->FILENAME correspond to text description unrelated to
433 filesystem names. It can be for example "<image in memory>". */
434
435#define OBJF_NOT_FILENAME (1 << 6)
436
c906108c
SS
437/* Declarations for functions defined in objfiles.c */
438
24ba069a 439extern struct objfile *allocate_objfile (bfd *, const char *name, int);
c906108c 440
5e2b427d
UW
441extern struct gdbarch *get_objfile_arch (struct objfile *);
442
abd0a5fa
JK
443extern int entry_point_address_query (CORE_ADDR *entry_p);
444
9ab9195f
EZ
445extern CORE_ADDR entry_point_address (void);
446
d82ea6a8 447extern void build_objfile_section_table (struct objfile *);
c906108c 448
15831452
JB
449extern void terminate_minimal_symbol_table (struct objfile *objfile);
450
15d123c9
TG
451extern struct objfile *objfile_separate_debug_iterate (const struct objfile *,
452 const struct objfile *);
453
5b5d99cf
JB
454extern void put_objfile_before (struct objfile *, struct objfile *);
455
a14ed312 456extern void objfile_to_front (struct objfile *);
c906108c 457
15d123c9
TG
458extern void add_separate_debug_objfile (struct objfile *, struct objfile *);
459
a14ed312 460extern void unlink_objfile (struct objfile *);
c906108c 461
a14ed312 462extern void free_objfile (struct objfile *);
c906108c 463
15d123c9
TG
464extern void free_objfile_separate_debug (struct objfile *);
465
74b7792f
AC
466extern struct cleanup *make_cleanup_free_objfile (struct objfile *);
467
a14ed312 468extern void free_all_objfiles (void);
c906108c 469
3189cb12 470extern void objfile_relocate (struct objfile *, const struct section_offsets *);
4141a416 471extern void objfile_rebase (struct objfile *, CORE_ADDR);
c906108c 472
55333a84
DE
473extern int objfile_has_partial_symbols (struct objfile *objfile);
474
475extern int objfile_has_full_symbols (struct objfile *objfile);
476
e361b228
TG
477extern int objfile_has_symbols (struct objfile *objfile);
478
a14ed312 479extern int have_partial_symbols (void);
c906108c 480
a14ed312 481extern int have_full_symbols (void);
c906108c 482
8fb8eb5c
DE
483extern void objfile_set_sym_fns (struct objfile *objfile,
484 const struct sym_fns *sf);
485
bb272892 486extern void objfiles_changed (void);
63644780
NB
487
488extern int is_addr_in_objfile (CORE_ADDR addr, const struct objfile *objfile);
bb272892 489
c906108c
SS
490/* This operation deletes all objfile entries that represent solibs that
491 weren't explicitly loaded by the user, via e.g., the add-symbol-file
0df8b418
MS
492 command. */
493
a14ed312 494extern void objfile_purge_solibs (void);
c906108c
SS
495
496/* Functions for dealing with the minimal symbol table, really a misc
497 address<->symbol mapping for things we don't have debug symbols for. */
498
a14ed312 499extern int have_minimal_symbols (void);
c906108c 500
a14ed312 501extern struct obj_section *find_pc_section (CORE_ADDR pc);
c906108c 502
3e5d3a5a
MR
503/* Return non-zero if PC is in a section called NAME. */
504extern int pc_in_section (CORE_ADDR, char *);
505
506/* Return non-zero if PC is in a SVR4-style procedure linkage table
507 section. */
508
509static inline int
510in_plt_section (CORE_ADDR pc)
511{
512 return pc_in_section (pc, ".plt");
513}
c906108c 514
0d0e1a63
MK
515/* Keep a registry of per-objfile data-pointers required by other GDB
516 modules. */
8e260fc0 517DECLARE_REGISTRY(objfile);
e3c69974 518
607ece04
GB
519/* In normal use, the section map will be rebuilt by find_pc_section
520 if objfiles have been added, removed or relocated since it was last
521 called. Calling inhibit_section_map_updates will inhibit this
522 behavior until resume_section_map_updates is called. If you call
523 inhibit_section_map_updates you must ensure that every call to
524 find_pc_section in the inhibited region relates to a section that
525 is already in the section map and has not since been removed or
526 relocated. */
527extern void inhibit_section_map_updates (struct program_space *pspace);
528
529/* Resume automatically rebuilding the section map as required. */
530extern void resume_section_map_updates (struct program_space *pspace);
531
532/* Version of the above suitable for use as a cleanup. */
533extern void resume_section_map_updates_cleanup (void *arg);
534
19630284
JB
535extern void default_iterate_over_objfiles_in_search_order
536 (struct gdbarch *gdbarch,
537 iterate_over_objfiles_in_search_order_cb_ftype *cb,
538 void *cb_data, struct objfile *current_objfile);
0d0e1a63
MK
539\f
540
6c95b8df
PA
541/* Traverse all object files in the current program space.
542 ALL_OBJFILES_SAFE works even if you delete the objfile during the
543 traversal. */
544
545/* Traverse all object files in program space SS. */
c906108c 546
6c95b8df 547#define ALL_PSPACE_OBJFILES(ss, obj) \
81b52a3a 548 for ((obj) = ss->objfiles; (obj) != NULL; (obj) = (obj)->next)
c906108c 549
6c95b8df
PA
550#define ALL_PSPACE_OBJFILES_SAFE(ss, obj, nxt) \
551 for ((obj) = ss->objfiles; \
552 (obj) != NULL? ((nxt)=(obj)->next,1) :0; \
553 (obj) = (nxt))
554
555#define ALL_OBJFILES(obj) \
556 for ((obj) = current_program_space->objfiles; \
557 (obj) != NULL; \
558 (obj) = (obj)->next)
559
560#define ALL_OBJFILES_SAFE(obj,nxt) \
561 for ((obj) = current_program_space->objfiles; \
c906108c
SS
562 (obj) != NULL? ((nxt)=(obj)->next,1) :0; \
563 (obj) = (nxt))
564
565/* Traverse all symtabs in one objfile. */
566
567#define ALL_OBJFILE_SYMTABS(objfile, s) \
568 for ((s) = (objfile) -> symtabs; (s) != NULL; (s) = (s) -> next)
569
d790cf0a
DE
570/* Traverse all primary symtabs in one objfile. */
571
572#define ALL_OBJFILE_PRIMARY_SYMTABS(objfile, s) \
573 ALL_OBJFILE_SYMTABS ((objfile), (s)) \
574 if ((s)->primary)
575
c906108c
SS
576/* Traverse all minimal symbols in one objfile. */
577
578#define ALL_OBJFILE_MSYMBOLS(objfile, m) \
3567439c 579 for ((m) = (objfile) -> msymbols; SYMBOL_LINKAGE_NAME(m) != NULL; (m)++)
c906108c 580
6c95b8df
PA
581/* Traverse all symtabs in all objfiles in the current symbol
582 space. */
c906108c
SS
583
584#define ALL_SYMTABS(objfile, s) \
585 ALL_OBJFILES (objfile) \
586 ALL_OBJFILE_SYMTABS (objfile, s)
587
6c95b8df
PA
588#define ALL_PSPACE_SYMTABS(ss, objfile, s) \
589 ALL_PSPACE_OBJFILES (ss, objfile) \
590 ALL_OBJFILE_SYMTABS (objfile, s)
591
592/* Traverse all symtabs in all objfiles in the current program space,
593 skipping included files (which share a blockvector with their
594 primary symtab). */
11309657
DJ
595
596#define ALL_PRIMARY_SYMTABS(objfile, s) \
597 ALL_OBJFILES (objfile) \
d790cf0a 598 ALL_OBJFILE_PRIMARY_SYMTABS (objfile, s)
11309657 599
6c95b8df
PA
600#define ALL_PSPACE_PRIMARY_SYMTABS(pspace, objfile, s) \
601 ALL_PSPACE_OBJFILES (ss, objfile) \
d790cf0a 602 ALL_OBJFILE_PRIMARY_SYMTABS (objfile, s)
6c95b8df 603
6c95b8df
PA
604/* Traverse all minimal symbols in all objfiles in the current symbol
605 space. */
c906108c
SS
606
607#define ALL_MSYMBOLS(objfile, m) \
608 ALL_OBJFILES (objfile) \
15831452 609 ALL_OBJFILE_MSYMBOLS (objfile, m)
c906108c
SS
610
611#define ALL_OBJFILE_OSECTIONS(objfile, osect) \
65cf3563
TT
612 for (osect = objfile->sections; osect < objfile->sections_end; osect++) \
613 if (osect->the_bfd_section == NULL) \
614 { \
615 /* Nothing. */ \
616 } \
617 else
c906108c 618
96a8853a
PA
619/* Traverse all obj_sections in all objfiles in the current program
620 space.
621
622 Note that this detects a "break" in the inner loop, and exits
623 immediately from the outer loop as well, thus, client code doesn't
624 need to know that this is implemented with a double for. The extra
625 hair is to make sure that a "break;" stops the outer loop iterating
626 as well, and both OBJFILE and OSECT are left unmodified:
627
628 - The outer loop learns about the inner loop's end condition, and
629 stops iterating if it detects the inner loop didn't reach its
630 end. In other words, the outer loop keeps going only if the
631 inner loop reached its end cleanly [(osect) ==
632 (objfile)->sections_end].
633
634 - OSECT is initialized in the outer loop initialization
635 expressions, such as if the inner loop has reached its end, so
636 the check mentioned above succeeds the first time.
637
638 - The trick to not clearing OBJFILE on a "break;" is, in the outer
639 loop's loop expression, advance OBJFILE, but iff the inner loop
640 reached its end. If not, there was a "break;", so leave OBJFILE
641 as is; the outer loop's conditional will break immediately as
0df8b418 642 well (as OSECT will be different from OBJFILE->sections_end). */
96a8853a
PA
643
644#define ALL_OBJSECTIONS(objfile, osect) \
645 for ((objfile) = current_program_space->objfiles, \
646 (objfile) != NULL ? ((osect) = (objfile)->sections_end) : 0; \
647 (objfile) != NULL \
648 && (osect) == (objfile)->sections_end; \
649 ((osect) == (objfile)->sections_end \
650 ? ((objfile) = (objfile)->next, \
651 (objfile) != NULL ? (osect) = (objfile)->sections_end : 0) \
652 : 0)) \
65cf3563 653 ALL_OBJFILE_OSECTIONS (objfile, osect)
c906108c 654
b8fbeb18 655#define SECT_OFF_DATA(objfile) \
8e65ff28 656 ((objfile->sect_index_data == -1) \
3e43a32a
MS
657 ? (internal_error (__FILE__, __LINE__, \
658 _("sect_index_data not initialized")), -1) \
8e65ff28 659 : objfile->sect_index_data)
b8fbeb18
EZ
660
661#define SECT_OFF_RODATA(objfile) \
8e65ff28 662 ((objfile->sect_index_rodata == -1) \
3e43a32a
MS
663 ? (internal_error (__FILE__, __LINE__, \
664 _("sect_index_rodata not initialized")), -1) \
8e65ff28 665 : objfile->sect_index_rodata)
b8fbeb18
EZ
666
667#define SECT_OFF_TEXT(objfile) \
8e65ff28 668 ((objfile->sect_index_text == -1) \
3e43a32a
MS
669 ? (internal_error (__FILE__, __LINE__, \
670 _("sect_index_text not initialized")), -1) \
8e65ff28 671 : objfile->sect_index_text)
b8fbeb18 672
a4c8257b 673/* Sometimes the .bss section is missing from the objfile, so we don't
0df8b418
MS
674 want to die here. Let the users of SECT_OFF_BSS deal with an
675 uninitialized section index. */
a4c8257b 676#define SECT_OFF_BSS(objfile) (objfile)->sect_index_bss
b8fbeb18 677
c14c28ba
PP
678/* Answer whether there is more than one object file loaded. */
679
680#define MULTI_OBJFILE_P() (object_files && object_files->next)
681
706e3705
TT
682/* Reset the per-BFD storage area on OBJ. */
683
684void set_objfile_per_bfd (struct objfile *obj);
685
4262abfb
JK
686const char *objfile_name (const struct objfile *objfile);
687
c5aa993b 688#endif /* !defined (OBJFILES_H) */
This page took 1.574618 seconds and 4 git commands to generate.