gdb/
[deliverable/binutils-gdb.git] / gdb / objfiles.h
CommitLineData
c906108c 1/* Definitions for symbol file management in GDB.
af5f3db6 2
0b302171 3 Copyright (C) 1992-2004, 2007-2012 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"
3956d554 26
af5f3db6 27struct bcache;
2de7ced7 28struct htab;
5c4e30ca 29struct symtab;
4a4b3fed 30struct objfile_data;
08c0b5bc 31
c906108c
SS
32/* This structure maintains information on a per-objfile basis about the
33 "entry point" of the objfile, and the scope within which the entry point
34 exists. It is possible that gdb will see more than one objfile that is
35 executable, each with its own entry point.
36
37 For example, for dynamically linked executables in SVR4, the dynamic linker
38 code is contained within the shared C library, which is actually executable
39 and is run by the kernel first when an exec is done of a user executable
40 that is dynamically linked. The dynamic linker within the shared C library
41 then maps in the various program segments in the user executable and jumps
42 to the user executable's recorded entry point, as if the call had been made
43 directly by the kernel.
44
73c1e0a1
AC
45 The traditional gdb method of using this info was to use the
46 recorded entry point to set the entry-file's lowpc and highpc from
627b3ba2
AC
47 the debugging information, where these values are the starting
48 address (inclusive) and ending address (exclusive) of the
49 instruction space in the executable which correspond to the
0df8b418 50 "startup file", i.e. crt0.o in most cases. This file is assumed to
627b3ba2
AC
51 be a startup file and frames with pc's inside it are treated as
52 nonexistent. Setting these variables is necessary so that
53 backtraces do not fly off the bottom of the stack.
54
55 NOTE: cagney/2003-09-09: It turns out that this "traditional"
56 method doesn't work. Corinna writes: ``It turns out that the call
2f72f850 57 to test for "inside entry file" destroys a meaningful backtrace
0df8b418 58 under some conditions. E.g. the backtrace tests in the asm-source
627b3ba2
AC
59 testcase are broken for some targets. In this test the functions
60 are all implemented as part of one file and the testcase is not
61 necessarily linked with a start file (depending on the target).
62 What happens is, that the first frame is printed normaly and
63 following frames are treated as being inside the enttry file then.
64 This way, only the #0 frame is printed in the backtrace output.''
65 Ref "frame.c" "NOTE: vinschen/2003-04-01".
c906108c
SS
66
67 Gdb also supports an alternate method to avoid running off the bottom
68 of the stack.
69
70 There are two frames that are "special", the frame for the function
71 containing the process entry point, since it has no predecessor frame,
72 and the frame for the function containing the user code entry point
73 (the main() function), since all the predecessor frames are for the
74 process startup code. Since we have no guarantee that the linked
75 in startup modules have any debugging information that gdb can use,
76 we need to avoid following frame pointers back into frames that might
77 have been built in the startup code, as we might get hopelessly
78 confused. However, we almost always have debugging information
79 available for main().
80
618ce49f
AC
81 These variables are used to save the range of PC values which are
82 valid within the main() function and within the function containing
83 the process entry point. If we always consider the frame for
84 main() as the outermost frame when debugging user code, and the
85 frame for the process entry point function as the outermost frame
86 when debugging startup code, then all we have to do is have
87 DEPRECATED_FRAME_CHAIN_VALID return false whenever a frame's
88 current PC is within the range specified by these variables. In
89 essence, we set "ceilings" in the frame chain beyond which we will
c906108c
SS
90 not proceed when following the frame chain back up the stack.
91
92 A nice side effect is that we can still debug startup code without
93 running off the end of the frame chain, assuming that we have usable
94 debugging information in the startup modules, and if we choose to not
95 use the block at main, or can't find it for some reason, everything
96 still works as before. And if we have no startup code debugging
97 information but we do have usable information for main(), backtraces
6e4c6c91 98 from user code don't go wandering off into the startup code. */
c906108c
SS
99
100struct entry_info
c5aa993b 101 {
abd0a5fa 102 /* The relocated value we should use for this objfile entry point. */
c5aa993b 103 CORE_ADDR entry_point;
c906108c 104
abd0a5fa
JK
105 /* Set to 1 iff ENTRY_POINT contains a valid value. */
106 unsigned entry_point_p : 1;
c5aa993b 107 };
c906108c 108
f1f6aadf
PA
109/* Sections in an objfile. The section offsets are stored in the
110 OBJFILE. */
c906108c 111
c5aa993b
JM
112struct obj_section
113 {
7be0c536 114 struct bfd_section *the_bfd_section; /* BFD section pointer */
c906108c 115
c5aa993b
JM
116 /* Objfile this section is part of. */
117 struct objfile *objfile;
c906108c 118
0df8b418 119 /* True if this "overlay section" is mapped into an "overlay region". */
c5aa993b
JM
120 int ovly_mapped;
121 };
c906108c 122
f1f6aadf
PA
123/* Relocation offset applied to S. */
124#define obj_section_offset(s) \
125 (((s)->objfile->section_offsets)->offsets[(s)->the_bfd_section->index])
126
127/* The memory address of section S (vma + offset). */
128#define obj_section_addr(s) \
1706c199 129 (bfd_get_section_vma ((s)->objfile->obfd, s->the_bfd_section) \
f1f6aadf
PA
130 + obj_section_offset (s))
131
132/* The one-passed-the-end memory address of section S
133 (vma + size + offset). */
134#define obj_section_endaddr(s) \
1706c199 135 (bfd_get_section_vma ((s)->objfile->obfd, s->the_bfd_section) \
f1f6aadf
PA
136 + bfd_get_section_size ((s)->the_bfd_section) \
137 + obj_section_offset (s))
c906108c 138
c906108c
SS
139/* The "objstats" structure provides a place for gdb to record some
140 interesting information about its internal state at runtime, on a
141 per objfile basis, such as information about the number of symbols
0df8b418 142 read, size of string table (if any), etc. */
c906108c 143
c5aa993b
JM
144struct objstats
145 {
146 int n_minsyms; /* Number of minimal symbols read */
147 int n_psyms; /* Number of partial symbols read */
148 int n_syms; /* Number of full symbols read */
149 int n_stabs; /* Number of ".stabs" read (if applicable) */
150 int n_types; /* Number of types */
151 int sz_strtab; /* Size of stringtable, (if applicable) */
152 };
c906108c
SS
153
154#define OBJSTAT(objfile, expr) (objfile -> stats.expr)
155#define OBJSTATS struct objstats stats
a14ed312
KB
156extern void print_objfile_statistics (void);
157extern void print_symbol_bcache_statistics (void);
c906108c 158
9227b5eb 159/* Number of entries in the minimal symbol hash table. */
375f3d86 160#define MINIMAL_SYMBOL_HASH_SIZE 2039
9227b5eb 161
c906108c
SS
162/* Master structure for keeping track of each file from which
163 gdb reads symbols. There are several ways these get allocated: 1.
164 The main symbol file, symfile_objfile, set by the symbol-file command,
165 2. Additional symbol files added by the add-symbol-file command,
166 3. Shared library objfiles, added by ADD_SOLIB, 4. symbol files
167 for modules that were loaded when GDB attached to a remote system
168 (see remote-vx.c). */
169
170struct objfile
c5aa993b 171 {
c906108c 172
c5aa993b 173 /* All struct objfile's are chained together by their next pointers.
ff011ed7
TT
174 The program space field "objfiles" (frequently referenced via
175 the macro "object_files") points to the first link in this
176 chain. */
c906108c 177
c5aa993b 178 struct objfile *next;
c906108c 179
d31d2fc3
JK
180 /* The object file's name, tilde-expanded and absolute. Malloc'd; free it
181 if you free this struct. This pointer is never NULL. */
c906108c 182
c5aa993b 183 char *name;
c906108c 184
e4f6d2ec
TJB
185 CORE_ADDR addr_low;
186
0838fb57
DE
187 /* Some flag bits for this objfile.
188 The values are defined by OBJF_*. */
c906108c 189
c5aa993b 190 unsigned short flags;
c906108c 191
6c95b8df
PA
192 /* The program space associated with this objfile. */
193
194 struct program_space *pspace;
195
c5aa993b
JM
196 /* Each objfile points to a linked list of symtabs derived from this file,
197 one symtab structure for each compilation unit (source file). Each link
0df8b418 198 in the symtab list contains a backpointer to this objfile. */
c906108c 199
c5aa993b 200 struct symtab *symtabs;
c906108c 201
c5aa993b
JM
202 /* Each objfile points to a linked list of partial symtabs derived from
203 this file, one partial symtab structure for each compilation unit
0df8b418 204 (source file). */
c906108c 205
c5aa993b 206 struct partial_symtab *psymtabs;
c906108c 207
ff013f42
JK
208 /* Map addresses to the entries of PSYMTABS. It would be more efficient to
209 have a map per the whole process but ADDRMAP cannot selectively remove
210 its items during FREE_OBJFILE. This mapping is already present even for
211 PARTIAL_SYMTABs which still have no corresponding full SYMTABs read. */
212
213 struct addrmap *psymtabs_addrmap;
214
0df8b418 215 /* List of freed partial symtabs, available for re-use. */
c906108c 216
c5aa993b 217 struct partial_symtab *free_psymtabs;
c906108c 218
c5aa993b
JM
219 /* The object file's BFD. Can be null if the objfile contains only
220 minimal symbols, e.g. the run time common symbols for SunOS4. */
c906108c 221
c5aa993b 222 bfd *obfd;
c906108c 223
5e2b427d
UW
224 /* The gdbarch associated with the BFD. Note that this gdbarch is
225 determined solely from BFD information, without looking at target
226 information. The gdbarch determined from a running target may
227 differ from this e.g. with respect to register types and names. */
228
229 struct gdbarch *gdbarch;
230
c5aa993b
JM
231 /* The modification timestamp of the object file, as of the last time
232 we read its symbols. */
c906108c 233
c5aa993b 234 long mtime;
c906108c 235
904578ed
JK
236 /* Cached 32-bit CRC as computed by gnu_debuglink_crc32. CRC32 is valid
237 iff CRC32_P. */
238 unsigned long crc32;
239 int crc32_p;
240
b99607ea 241 /* Obstack to hold objects that should be freed when we load a new symbol
0df8b418 242 table from this object file. */
b99607ea 243
b99607ea
EZ
244 struct obstack objfile_obstack;
245
c5aa993b 246 /* A byte cache where we can stash arbitrary "chunks" of bytes that
0df8b418 247 will not change. */
c906108c 248
0df8b418
MS
249 struct psymbol_bcache *psymbol_cache; /* Byte cache for partial syms. */
250 struct bcache *macro_cache; /* Byte cache for macros. */
251 struct bcache *filename_cache; /* Byte cache for file names. */
c906108c 252
2de7ced7
DJ
253 /* Hash table for mapping symbol names to demangled names. Each
254 entry in the hash table is actually two consecutive strings,
255 both null-terminated; the first one is a mangled or linkage
256 name, and the second is the demangled name or just a zero byte
257 if the name doesn't demangle. */
258 struct htab *demangled_names_hash;
259
c5aa993b 260 /* Vectors of all partial symbols read in from file. The actual data
0df8b418 261 is stored in the objfile_obstack. */
c906108c 262
c5aa993b
JM
263 struct psymbol_allocation_list global_psymbols;
264 struct psymbol_allocation_list static_psymbols;
c906108c 265
c5aa993b 266 /* Each file contains a pointer to an array of minimal symbols for all
3e43a32a
MS
267 global symbols that are defined within the file. The array is
268 terminated by a "null symbol", one that has a NULL pointer for the
269 name and a zero value for the address. This makes it easy to walk
270 through the array when passed a pointer to somewhere in the middle
271 of it. There is also a count of the number of symbols, which does
272 not include the terminating null symbol. The array itself, as well
273 as all the data that it points to, should be allocated on the
0df8b418 274 objfile_obstack for this file. */
c906108c 275
c5aa993b
JM
276 struct minimal_symbol *msymbols;
277 int minimal_symbol_count;
c906108c 278
9227b5eb
JB
279 /* This is a hash table used to index the minimal symbols by name. */
280
281 struct minimal_symbol *msymbol_hash[MINIMAL_SYMBOL_HASH_SIZE];
282
283 /* This hash table is used to index the minimal symbols by their
284 demangled names. */
285
286 struct minimal_symbol *msymbol_demangled_hash[MINIMAL_SYMBOL_HASH_SIZE];
287
c5aa993b 288 /* Structure which keeps track of functions that manipulate objfile's
0df8b418 289 of the same type as this objfile. I.e. the function to read partial
c5aa993b
JM
290 symbols for example. Note that this structure is in statically
291 allocated memory, and is shared by all objfiles that use the
0df8b418 292 object module reader of this type. */
c906108c 293
00b5771c 294 const struct sym_fns *sf;
c906108c 295
c5aa993b 296 /* The per-objfile information about the entry point, the scope (file/func)
0df8b418 297 containing the entry point, and the scope of the user's main() func. */
c906108c 298
c5aa993b 299 struct entry_info ei;
c906108c 300
c5aa993b 301 /* Information about stabs. Will be filled in with a dbx_symfile_info
0df8b418 302 struct by those readers that need it. */
0a6ddd08
AC
303 /* NOTE: cagney/2004-10-23: This has been replaced by per-objfile
304 data points implemented using "data" and "num_data" below. For
305 an example of how to use this replacement, see "objfile_data"
306 in "mips-tdep.c". */
c906108c 307
0a6ddd08 308 struct dbx_symfile_info *deprecated_sym_stab_info;
c906108c 309
c5aa993b
JM
310 /* Hook for information for use by the symbol reader (currently used
311 for information shared by sym_init and sym_read). It is
312 typically a pointer to malloc'd memory. The symbol reader's finish
313 function is responsible for freeing the memory thusly allocated. */
0a6ddd08
AC
314 /* NOTE: cagney/2004-10-23: This has been replaced by per-objfile
315 data points implemented using "data" and "num_data" below. For
316 an example of how to use this replacement, see "objfile_data"
317 in "mips-tdep.c". */
c906108c 318
0a6ddd08 319 void *deprecated_sym_private;
c906108c 320
0d0e1a63
MK
321 /* Per objfile data-pointers required by other GDB modules. */
322 /* FIXME: kettenis/20030711: This mechanism could replace
f98dfd4b
TT
323 deprecated_sym_stab_info and deprecated_sym_private
324 entirely. */
0d0e1a63
MK
325
326 void **data;
327 unsigned num_data;
328
c5aa993b 329 /* Set of relocation offsets to apply to each section.
d82ea6a8
DE
330 The table is indexed by the_bfd_section->index, thus it is generally
331 as large as the number of sections in the binary.
332 The table is stored on the objfile_obstack.
c906108c 333
c5aa993b
JM
334 These offsets indicate that all symbols (including partial and
335 minimal symbols) which have been read have been relocated by this
d82ea6a8 336 much. Symbols which are yet to be read need to be relocated by it. */
c906108c 337
c5aa993b
JM
338 struct section_offsets *section_offsets;
339 int num_sections;
c906108c 340
0df8b418 341 /* Indexes in the section_offsets array. These are initialized by the
b8fbeb18 342 *_symfile_offsets() family of functions (som_symfile_offsets,
0df8b418 343 xcoff_symfile_offsets, default_symfile_offsets). In theory they
b8fbeb18 344 should correspond to the section indexes used by bfd for the
0df8b418
MS
345 current objfile. The exception to this for the time being is the
346 SOM version. */
b8fbeb18
EZ
347
348 int sect_index_text;
349 int sect_index_data;
350 int sect_index_bss;
351 int sect_index_rodata;
352
96baa820 353 /* These pointers are used to locate the section table, which
5c44784c 354 among other things, is used to map pc addresses into sections.
96baa820
JM
355 SECTIONS points to the first entry in the table, and
356 SECTIONS_END points to the first location past the last entry
d82ea6a8
DE
357 in the table. The table is stored on the objfile_obstack.
358 There is no particular order to the sections in this table, and it
359 only contains sections we care about (e.g. non-empty, SEC_ALLOC). */
c906108c 360
d82ea6a8 361 struct obj_section *sections, *sections_end;
c906108c 362
15d123c9
TG
363 /* GDB allows to have debug symbols in separate object files. This is
364 used by .gnu_debuglink, ELF build id note and Mach-O OSO.
365 Although this is a tree structure, GDB only support one level
366 (ie a separate debug for a separate debug is not supported). Note that
367 separate debug object are in the main chain and therefore will be
368 visited by ALL_OBJFILES & co iterators. Separate debug objfile always
369 has a non-nul separate_debug_objfile_backlink. */
370
371 /* Link to the first separate debug object, if any. */
5b5d99cf
JB
372 struct objfile *separate_debug_objfile;
373
374 /* If this is a separate debug object, this is used as a link to the
0df8b418 375 actual executable objfile. */
5b5d99cf 376 struct objfile *separate_debug_objfile_backlink;
15d123c9
TG
377
378 /* If this is a separate debug object, this is a link to the next one
379 for the same executable objfile. */
380 struct objfile *separate_debug_objfile_link;
381
0df8b418 382 /* Place to stash various statistics about this objfile. */
d82ea6a8 383 OBJSTATS;
5c4e30ca 384
34eaf542
TT
385 /* A linked list of symbols created when reading template types or
386 function templates. These symbols are not stored in any symbol
387 table, so we have to keep them here to relocate them
388 properly. */
389 struct symbol *template_symbols;
c5aa993b 390 };
c906108c 391
0df8b418 392/* Defines for the objfile flag word. */
c906108c 393
c906108c
SS
394/* When an object file has its functions reordered (currently Irix-5.2
395 shared libraries exhibit this behaviour), we will need an expensive
396 algorithm to locate a partial symtab or symtab via an address.
397 To avoid this penalty for normal object files, we use this flag,
398 whose setting is determined upon symbol table read in. */
399
8b41ec65 400#define OBJF_REORDERED (1 << 0) /* Functions are reordered */
c5aa993b 401
2df3850c 402/* Distinguish between an objfile for a shared library and a "vanilla"
0df8b418 403 objfile. (If not set, the objfile may still actually be a solib.
2df3850c
JM
404 This can happen if the user created the objfile by using the
405 add-symbol-file command. GDB doesn't in that situation actually
406 check whether the file is a solib. Rather, the target's
407 implementation of the solib interface is responsible for setting
408 this flag when noticing solibs used by an inferior.) */
c906108c 409
8b41ec65 410#define OBJF_SHARED (1 << 1) /* From a shared library */
c906108c 411
0df8b418 412/* User requested that this objfile be read in it's entirety. */
2acceee2 413
8b41ec65 414#define OBJF_READNOW (1 << 2) /* Immediate full read */
2acceee2 415
2df3850c
JM
416/* This objfile was created because the user explicitly caused it
417 (e.g., used the add-symbol-file command). This bit offers a way
418 for run_command to remove old objfile entries which are no longer
419 valid (i.e., are associated with an old inferior), but to preserve
420 ones that the user explicitly loaded via the add-symbol-file
0df8b418 421 command. */
2df3850c 422
8b41ec65 423#define OBJF_USERLOADED (1 << 3) /* User loaded */
2df3850c 424
b11896a5
TT
425/* Set if we have tried to read partial symtabs for this objfile.
426 This is used to allow lazy reading of partial symtabs. */
427
428#define OBJF_PSYMTABS_READ (1 << 4)
429
0838fb57
DE
430/* Set if this is the main symbol file
431 (as opposed to symbol file for dynamically loaded code). */
432
433#define OBJF_MAINLINE (1 << 5)
434
c906108c 435/* The object file that contains the runtime common minimal symbols
0df8b418 436 for SunOS4. Note that this objfile has no associated BFD. */
c906108c
SS
437
438extern struct objfile *rt_common_objfile;
439
c906108c
SS
440/* Declarations for functions defined in objfiles.c */
441
a14ed312 442extern struct objfile *allocate_objfile (bfd *, int);
c906108c 443
5e2b427d
UW
444extern struct gdbarch *get_objfile_arch (struct objfile *);
445
9ab9195f
EZ
446extern void init_entry_point_info (struct objfile *);
447
abd0a5fa
JK
448extern int entry_point_address_query (CORE_ADDR *entry_p);
449
9ab9195f
EZ
450extern CORE_ADDR entry_point_address (void);
451
d82ea6a8 452extern void build_objfile_section_table (struct objfile *);
c906108c 453
15831452
JB
454extern void terminate_minimal_symbol_table (struct objfile *objfile);
455
15d123c9
TG
456extern struct objfile *objfile_separate_debug_iterate (const struct objfile *,
457 const struct objfile *);
458
5b5d99cf
JB
459extern void put_objfile_before (struct objfile *, struct objfile *);
460
a14ed312 461extern void objfile_to_front (struct objfile *);
c906108c 462
15d123c9
TG
463extern void add_separate_debug_objfile (struct objfile *, struct objfile *);
464
a14ed312 465extern void unlink_objfile (struct objfile *);
c906108c 466
a14ed312 467extern void free_objfile (struct objfile *);
c906108c 468
15d123c9
TG
469extern void free_objfile_separate_debug (struct objfile *);
470
74b7792f
AC
471extern struct cleanup *make_cleanup_free_objfile (struct objfile *);
472
a14ed312 473extern void free_all_objfiles (void);
c906108c 474
a14ed312 475extern void objfile_relocate (struct objfile *, struct section_offsets *);
c906108c 476
55333a84
DE
477extern int objfile_has_partial_symbols (struct objfile *objfile);
478
479extern int objfile_has_full_symbols (struct objfile *objfile);
480
e361b228
TG
481extern int objfile_has_symbols (struct objfile *objfile);
482
a14ed312 483extern int have_partial_symbols (void);
c906108c 484
a14ed312 485extern int have_full_symbols (void);
c906108c 486
bb272892
PP
487extern void objfiles_changed (void);
488
c906108c
SS
489/* This operation deletes all objfile entries that represent solibs that
490 weren't explicitly loaded by the user, via e.g., the add-symbol-file
0df8b418
MS
491 command. */
492
a14ed312 493extern void objfile_purge_solibs (void);
c906108c
SS
494
495/* Functions for dealing with the minimal symbol table, really a misc
496 address<->symbol mapping for things we don't have debug symbols for. */
497
a14ed312 498extern int have_minimal_symbols (void);
c906108c 499
a14ed312 500extern struct obj_section *find_pc_section (CORE_ADDR pc);
c906108c 501
a14ed312 502extern int in_plt_section (CORE_ADDR, char *);
c906108c 503
0d0e1a63
MK
504/* Keep a registry of per-objfile data-pointers required by other GDB
505 modules. */
506
c1bd65d0 507/* Allocate an entry in the per-objfile registry. */
0d0e1a63 508extern const struct objfile_data *register_objfile_data (void);
c1bd65d0
DE
509
510/* Allocate an entry in the per-objfile registry.
511 SAVE and FREE are called when clearing objfile data.
512 First all registered SAVE functions are called.
513 Then all registered FREE functions are called.
514 Either or both of SAVE, FREE may be NULL. */
60c5725c 515extern const struct objfile_data *register_objfile_data_with_cleanup
c1bd65d0
DE
516 (void (*save) (struct objfile *, void *),
517 void (*free) (struct objfile *, void *));
518
7b097ae3 519extern void clear_objfile_data (struct objfile *objfile);
0d0e1a63
MK
520extern void set_objfile_data (struct objfile *objfile,
521 const struct objfile_data *data, void *value);
522extern void *objfile_data (struct objfile *objfile,
523 const struct objfile_data *data);
e3c69974 524
3db741ef 525extern struct bfd *gdb_bfd_ref (struct bfd *abfd);
e3c69974 526extern void gdb_bfd_unref (struct bfd *abfd);
516ba659 527extern int gdb_bfd_close_or_warn (struct bfd *abfd);
19630284
JB
528
529extern void default_iterate_over_objfiles_in_search_order
530 (struct gdbarch *gdbarch,
531 iterate_over_objfiles_in_search_order_cb_ftype *cb,
532 void *cb_data, struct objfile *current_objfile);
0d0e1a63
MK
533\f
534
6c95b8df
PA
535/* Traverse all object files in the current program space.
536 ALL_OBJFILES_SAFE works even if you delete the objfile during the
537 traversal. */
538
539/* Traverse all object files in program space SS. */
c906108c 540
6c95b8df
PA
541#define ALL_PSPACE_OBJFILES(ss, obj) \
542 for ((obj) = ss->objfiles; (obj) != NULL; (obj) = (obj)->next) \
c906108c 543
6c95b8df
PA
544#define ALL_PSPACE_OBJFILES_SAFE(ss, obj, nxt) \
545 for ((obj) = ss->objfiles; \
546 (obj) != NULL? ((nxt)=(obj)->next,1) :0; \
547 (obj) = (nxt))
548
549#define ALL_OBJFILES(obj) \
550 for ((obj) = current_program_space->objfiles; \
551 (obj) != NULL; \
552 (obj) = (obj)->next)
553
554#define ALL_OBJFILES_SAFE(obj,nxt) \
555 for ((obj) = current_program_space->objfiles; \
c906108c
SS
556 (obj) != NULL? ((nxt)=(obj)->next,1) :0; \
557 (obj) = (nxt))
558
559/* Traverse all symtabs in one objfile. */
560
561#define ALL_OBJFILE_SYMTABS(objfile, s) \
562 for ((s) = (objfile) -> symtabs; (s) != NULL; (s) = (s) -> next)
563
d790cf0a
DE
564/* Traverse all primary symtabs in one objfile. */
565
566#define ALL_OBJFILE_PRIMARY_SYMTABS(objfile, s) \
567 ALL_OBJFILE_SYMTABS ((objfile), (s)) \
568 if ((s)->primary)
569
c906108c
SS
570/* Traverse all minimal symbols in one objfile. */
571
572#define ALL_OBJFILE_MSYMBOLS(objfile, m) \
3567439c 573 for ((m) = (objfile) -> msymbols; SYMBOL_LINKAGE_NAME(m) != NULL; (m)++)
c906108c 574
6c95b8df
PA
575/* Traverse all symtabs in all objfiles in the current symbol
576 space. */
c906108c
SS
577
578#define ALL_SYMTABS(objfile, s) \
579 ALL_OBJFILES (objfile) \
580 ALL_OBJFILE_SYMTABS (objfile, s)
581
6c95b8df
PA
582#define ALL_PSPACE_SYMTABS(ss, objfile, s) \
583 ALL_PSPACE_OBJFILES (ss, objfile) \
584 ALL_OBJFILE_SYMTABS (objfile, s)
585
586/* Traverse all symtabs in all objfiles in the current program space,
587 skipping included files (which share a blockvector with their
588 primary symtab). */
11309657
DJ
589
590#define ALL_PRIMARY_SYMTABS(objfile, s) \
591 ALL_OBJFILES (objfile) \
d790cf0a 592 ALL_OBJFILE_PRIMARY_SYMTABS (objfile, s)
11309657 593
6c95b8df
PA
594#define ALL_PSPACE_PRIMARY_SYMTABS(pspace, objfile, s) \
595 ALL_PSPACE_OBJFILES (ss, objfile) \
d790cf0a 596 ALL_OBJFILE_PRIMARY_SYMTABS (objfile, s)
6c95b8df 597
6c95b8df
PA
598/* Traverse all minimal symbols in all objfiles in the current symbol
599 space. */
c906108c
SS
600
601#define ALL_MSYMBOLS(objfile, m) \
602 ALL_OBJFILES (objfile) \
15831452 603 ALL_OBJFILE_MSYMBOLS (objfile, m)
c906108c
SS
604
605#define ALL_OBJFILE_OSECTIONS(objfile, osect) \
606 for (osect = objfile->sections; osect < objfile->sections_end; osect++)
607
96a8853a
PA
608/* Traverse all obj_sections in all objfiles in the current program
609 space.
610
611 Note that this detects a "break" in the inner loop, and exits
612 immediately from the outer loop as well, thus, client code doesn't
613 need to know that this is implemented with a double for. The extra
614 hair is to make sure that a "break;" stops the outer loop iterating
615 as well, and both OBJFILE and OSECT are left unmodified:
616
617 - The outer loop learns about the inner loop's end condition, and
618 stops iterating if it detects the inner loop didn't reach its
619 end. In other words, the outer loop keeps going only if the
620 inner loop reached its end cleanly [(osect) ==
621 (objfile)->sections_end].
622
623 - OSECT is initialized in the outer loop initialization
624 expressions, such as if the inner loop has reached its end, so
625 the check mentioned above succeeds the first time.
626
627 - The trick to not clearing OBJFILE on a "break;" is, in the outer
628 loop's loop expression, advance OBJFILE, but iff the inner loop
629 reached its end. If not, there was a "break;", so leave OBJFILE
630 as is; the outer loop's conditional will break immediately as
0df8b418 631 well (as OSECT will be different from OBJFILE->sections_end). */
96a8853a
PA
632
633#define ALL_OBJSECTIONS(objfile, osect) \
634 for ((objfile) = current_program_space->objfiles, \
635 (objfile) != NULL ? ((osect) = (objfile)->sections_end) : 0; \
636 (objfile) != NULL \
637 && (osect) == (objfile)->sections_end; \
638 ((osect) == (objfile)->sections_end \
639 ? ((objfile) = (objfile)->next, \
640 (objfile) != NULL ? (osect) = (objfile)->sections_end : 0) \
641 : 0)) \
642 for ((osect) = (objfile)->sections; \
643 (osect) < (objfile)->sections_end; \
644 (osect)++)
c906108c 645
b8fbeb18 646#define SECT_OFF_DATA(objfile) \
8e65ff28 647 ((objfile->sect_index_data == -1) \
3e43a32a
MS
648 ? (internal_error (__FILE__, __LINE__, \
649 _("sect_index_data not initialized")), -1) \
8e65ff28 650 : objfile->sect_index_data)
b8fbeb18
EZ
651
652#define SECT_OFF_RODATA(objfile) \
8e65ff28 653 ((objfile->sect_index_rodata == -1) \
3e43a32a
MS
654 ? (internal_error (__FILE__, __LINE__, \
655 _("sect_index_rodata not initialized")), -1) \
8e65ff28 656 : objfile->sect_index_rodata)
b8fbeb18
EZ
657
658#define SECT_OFF_TEXT(objfile) \
8e65ff28 659 ((objfile->sect_index_text == -1) \
3e43a32a
MS
660 ? (internal_error (__FILE__, __LINE__, \
661 _("sect_index_text not initialized")), -1) \
8e65ff28 662 : objfile->sect_index_text)
b8fbeb18 663
a4c8257b 664/* Sometimes the .bss section is missing from the objfile, so we don't
0df8b418
MS
665 want to die here. Let the users of SECT_OFF_BSS deal with an
666 uninitialized section index. */
a4c8257b 667#define SECT_OFF_BSS(objfile) (objfile)->sect_index_bss
b8fbeb18 668
c14c28ba
PP
669/* Answer whether there is more than one object file loaded. */
670
671#define MULTI_OBJFILE_P() (object_files && object_files->next)
672
c5aa993b 673#endif /* !defined (OBJFILES_H) */
This page took 1.15189 seconds and 4 git commands to generate.