*** empty log message ***
[deliverable/binutils-gdb.git] / gdb / objfiles.h
CommitLineData
c906108c 1/* Definitions for symbol file management in GDB.
af5f3db6 2
6aba47ca 3 Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001,
7b6bb8da
JB
4 2002, 2003, 2004, 2007, 2008, 2009, 2010, 2011
5 Free Software Foundation, Inc.
c906108c 6
c5aa993b 7 This file is part of GDB.
c906108c 8
c5aa993b
JM
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
a9762ec7 11 the Free Software Foundation; either version 3 of the License, or
c5aa993b 12 (at your option) any later version.
c906108c 13
c5aa993b
JM
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
c906108c 18
c5aa993b 19 You should have received a copy of the GNU General Public License
a9762ec7 20 along with this program. If not, see <http://www.gnu.org/licenses/>. */
c906108c
SS
21
22#if !defined (OBJFILES_H)
23#define OBJFILES_H
24
3956d554
JB
25#include "gdb_obstack.h" /* For obstack internals. */
26#include "symfile.h" /* For struct psymbol_allocation_list */
6c95b8df 27#include "progspace.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
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
2f72f850 59 to test for "inside entry file" destroys a meaningful backtrace
627b3ba2
AC
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".
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
c5aa993b
JM
121 /* True if this "overlay section" is mapped into an "overlay region". */
122 int ovly_mapped;
123 };
c906108c 124
f1f6aadf
PA
125/* Relocation offset applied to S. */
126#define obj_section_offset(s) \
127 (((s)->objfile->section_offsets)->offsets[(s)->the_bfd_section->index])
128
129/* The memory address of section S (vma + offset). */
130#define obj_section_addr(s) \
131 (bfd_get_section_vma ((s)->objfile->abfd, s->the_bfd_section) \
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) \
137 (bfd_get_section_vma ((s)->objfile->abfd, s->the_bfd_section) \
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
144 read, size of string table (if any), etc. */
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
c906108c
SS
164/* Master structure for keeping track of each file from which
165 gdb reads symbols. There are several ways these get allocated: 1.
166 The main symbol file, symfile_objfile, set by the symbol-file command,
167 2. Additional symbol files added by the add-symbol-file command,
168 3. Shared library objfiles, added by ADD_SOLIB, 4. symbol files
169 for modules that were loaded when GDB attached to a remote system
170 (see remote-vx.c). */
171
172struct objfile
c5aa993b 173 {
c906108c 174
c5aa993b
JM
175 /* All struct objfile's are chained together by their next pointers.
176 The global variable "object_files" points to the first link in this
177 chain.
c906108c 178
c5aa993b
JM
179 FIXME: There is a problem here if the objfile is reusable, and if
180 multiple users are to be supported. The problem is that the objfile
181 list is linked through a member of the objfile struct itself, which
182 is only valid for one gdb process. The list implementation needs to
183 be changed to something like:
c906108c 184
c5aa993b 185 struct list {struct list *next; struct objfile *objfile};
c906108c 186
c5aa993b
JM
187 where the list structure is completely maintained separately within
188 each gdb process. */
c906108c 189
c5aa993b 190 struct objfile *next;
c906108c 191
d31d2fc3
JK
192 /* The object file's name, tilde-expanded and absolute. Malloc'd; free it
193 if you free this struct. This pointer is never NULL. */
c906108c 194
c5aa993b 195 char *name;
c906108c 196
c5aa993b 197 /* Some flag bits for this objfile. */
c906108c 198
c5aa993b 199 unsigned short flags;
c906108c 200
6c95b8df
PA
201 /* The program space associated with this objfile. */
202
203 struct program_space *pspace;
204
c5aa993b
JM
205 /* Each objfile points to a linked list of symtabs derived from this file,
206 one symtab structure for each compilation unit (source file). Each link
207 in the symtab list contains a backpointer to this objfile. */
c906108c 208
c5aa993b 209 struct symtab *symtabs;
c906108c 210
c5aa993b
JM
211 /* Each objfile points to a linked list of partial symtabs derived from
212 this file, one partial symtab structure for each compilation unit
213 (source file). */
c906108c 214
c5aa993b 215 struct partial_symtab *psymtabs;
c906108c 216
ff013f42
JK
217 /* Map addresses to the entries of PSYMTABS. It would be more efficient to
218 have a map per the whole process but ADDRMAP cannot selectively remove
219 its items during FREE_OBJFILE. This mapping is already present even for
220 PARTIAL_SYMTABs which still have no corresponding full SYMTABs read. */
221
222 struct addrmap *psymtabs_addrmap;
223
c5aa993b 224 /* List of freed partial symtabs, available for re-use */
c906108c 225
c5aa993b 226 struct partial_symtab *free_psymtabs;
c906108c 227
c5aa993b
JM
228 /* The object file's BFD. Can be null if the objfile contains only
229 minimal symbols, e.g. the run time common symbols for SunOS4. */
c906108c 230
c5aa993b 231 bfd *obfd;
c906108c 232
5e2b427d
UW
233 /* The gdbarch associated with the BFD. Note that this gdbarch is
234 determined solely from BFD information, without looking at target
235 information. The gdbarch determined from a running target may
236 differ from this e.g. with respect to register types and names. */
237
238 struct gdbarch *gdbarch;
239
c5aa993b
JM
240 /* The modification timestamp of the object file, as of the last time
241 we read its symbols. */
c906108c 242
c5aa993b 243 long mtime;
c906108c 244
b99607ea
EZ
245 /* Obstack to hold objects that should be freed when we load a new symbol
246 table from this object file. */
247
b99607ea
EZ
248 struct obstack objfile_obstack;
249
c5aa993b
JM
250 /* A byte cache where we can stash arbitrary "chunks" of bytes that
251 will not change. */
c906108c 252
710e1a31 253 struct psymbol_bcache *psymbol_cache; /* Byte cache for partial syms */
af5f3db6 254 struct bcache *macro_cache; /* Byte cache for macros */
10abe6bf 255 struct bcache *filename_cache; /* Byte cache for file names. */
c906108c 256
2de7ced7
DJ
257 /* Hash table for mapping symbol names to demangled names. Each
258 entry in the hash table is actually two consecutive strings,
259 both null-terminated; the first one is a mangled or linkage
260 name, and the second is the demangled name or just a zero byte
261 if the name doesn't demangle. */
262 struct htab *demangled_names_hash;
263
c5aa993b 264 /* Vectors of all partial symbols read in from file. The actual data
8b92e4d5 265 is stored in the objfile_obstack. */
c906108c 266
c5aa993b
JM
267 struct psymbol_allocation_list global_psymbols;
268 struct psymbol_allocation_list static_psymbols;
c906108c 269
c5aa993b
JM
270 /* Each file contains a pointer to an array of minimal symbols for all
271 global symbols that are defined within the file. The array is terminated
272 by a "null symbol", one that has a NULL pointer for the name and a zero
273 value for the address. This makes it easy to walk through the array
274 when passed a pointer to somewhere in the middle of it. There is also
275 a count of the number of symbols, which does not include the terminating
276 null symbol. The array itself, as well as all the data that it points
4a146b47 277 to, should be allocated on the objfile_obstack for this file. */
c906108c 278
c5aa993b
JM
279 struct minimal_symbol *msymbols;
280 int minimal_symbol_count;
c906108c 281
9227b5eb
JB
282 /* This is a hash table used to index the minimal symbols by name. */
283
284 struct minimal_symbol *msymbol_hash[MINIMAL_SYMBOL_HASH_SIZE];
285
286 /* This hash table is used to index the minimal symbols by their
287 demangled names. */
288
289 struct minimal_symbol *msymbol_demangled_hash[MINIMAL_SYMBOL_HASH_SIZE];
290
c5aa993b
JM
291 /* Structure which keeps track of functions that manipulate objfile's
292 of the same type as this objfile. I.E. the function to read partial
293 symbols for example. Note that this structure is in statically
294 allocated memory, and is shared by all objfiles that use the
295 object module reader of this type. */
c906108c 296
00b5771c 297 const struct sym_fns *sf;
c906108c 298
c5aa993b
JM
299 /* The per-objfile information about the entry point, the scope (file/func)
300 containing the entry point, and the scope of the user's main() func. */
c906108c 301
c5aa993b 302 struct entry_info ei;
c906108c 303
c5aa993b
JM
304 /* Information about stabs. Will be filled in with a dbx_symfile_info
305 struct by those readers that need it. */
0a6ddd08
AC
306 /* NOTE: cagney/2004-10-23: This has been replaced by per-objfile
307 data points implemented using "data" and "num_data" below. For
308 an example of how to use this replacement, see "objfile_data"
309 in "mips-tdep.c". */
c906108c 310
0a6ddd08 311 struct dbx_symfile_info *deprecated_sym_stab_info;
c906108c 312
c5aa993b
JM
313 /* Hook for information for use by the symbol reader (currently used
314 for information shared by sym_init and sym_read). It is
315 typically a pointer to malloc'd memory. The symbol reader's finish
316 function is responsible for freeing the memory thusly allocated. */
0a6ddd08
AC
317 /* NOTE: cagney/2004-10-23: This has been replaced by per-objfile
318 data points implemented using "data" and "num_data" below. For
319 an example of how to use this replacement, see "objfile_data"
320 in "mips-tdep.c". */
c906108c 321
0a6ddd08 322 void *deprecated_sym_private;
c906108c 323
0d0e1a63
MK
324 /* Per objfile data-pointers required by other GDB modules. */
325 /* FIXME: kettenis/20030711: This mechanism could replace
f98dfd4b
TT
326 deprecated_sym_stab_info and deprecated_sym_private
327 entirely. */
0d0e1a63
MK
328
329 void **data;
330 unsigned num_data;
331
c5aa993b 332 /* Set of relocation offsets to apply to each section.
8b92e4d5 333 Currently on the objfile_obstack (which makes no sense, but I'm
c5aa993b 334 not sure it's harming anything).
c906108c 335
c5aa993b
JM
336 These offsets indicate that all symbols (including partial and
337 minimal symbols) which have been read have been relocated by this
338 much. Symbols which are yet to be read need to be relocated by
339 it. */
c906108c 340
c5aa993b
JM
341 struct section_offsets *section_offsets;
342 int num_sections;
c906108c 343
b8fbeb18
EZ
344 /* Indexes in the section_offsets array. These are initialized by the
345 *_symfile_offsets() family of functions (som_symfile_offsets,
346 xcoff_symfile_offsets, default_symfile_offsets). In theory they
347 should correspond to the section indexes used by bfd for the
348 current objfile. The exception to this for the time being is the
349 SOM version. */
350
351 int sect_index_text;
352 int sect_index_data;
353 int sect_index_bss;
354 int sect_index_rodata;
355
96baa820 356 /* These pointers are used to locate the section table, which
5c44784c 357 among other things, is used to map pc addresses into sections.
96baa820
JM
358 SECTIONS points to the first entry in the table, and
359 SECTIONS_END points to the first location past the last entry
360 in the table. Currently the table is stored on the
8b92e4d5 361 objfile_obstack (which makes no sense, but I'm not sure it's
96baa820 362 harming anything). */
c906108c 363
c5aa993b
JM
364 struct obj_section
365 *sections, *sections_end;
c906108c 366
15d123c9
TG
367 /* GDB allows to have debug symbols in separate object files. This is
368 used by .gnu_debuglink, ELF build id note and Mach-O OSO.
369 Although this is a tree structure, GDB only support one level
370 (ie a separate debug for a separate debug is not supported). Note that
371 separate debug object are in the main chain and therefore will be
372 visited by ALL_OBJFILES & co iterators. Separate debug objfile always
373 has a non-nul separate_debug_objfile_backlink. */
374
375 /* Link to the first separate debug object, if any. */
5b5d99cf
JB
376 struct objfile *separate_debug_objfile;
377
378 /* If this is a separate debug object, this is used as a link to the
379 actual executable objfile. */
380 struct objfile *separate_debug_objfile_backlink;
15d123c9
TG
381
382 /* If this is a separate debug object, this is a link to the next one
383 for the same executable objfile. */
384 struct objfile *separate_debug_objfile_link;
385
c5aa993b
JM
386 /* Place to stash various statistics about this objfile */
387 OBJSTATS;
5c4e30ca
DC
388
389 /* A symtab that the C++ code uses to stash special symbols
390 associated to namespaces. */
391
392 /* FIXME/carlton-2003-06-27: Delete this in a few years once
393 "possible namespace symbols" go away. */
394 struct symtab *cp_namespace_symtab;
34eaf542
TT
395
396 /* A linked list of symbols created when reading template types or
397 function templates. These symbols are not stored in any symbol
398 table, so we have to keep them here to relocate them
399 properly. */
400 struct symbol *template_symbols;
c5aa993b 401 };
c906108c
SS
402
403/* Defines for the objfile flag word. */
404
c906108c
SS
405/* When an object file has its functions reordered (currently Irix-5.2
406 shared libraries exhibit this behaviour), we will need an expensive
407 algorithm to locate a partial symtab or symtab via an address.
408 To avoid this penalty for normal object files, we use this flag,
409 whose setting is determined upon symbol table read in. */
410
8b41ec65 411#define OBJF_REORDERED (1 << 0) /* Functions are reordered */
c5aa993b 412
2df3850c
JM
413/* Distinguish between an objfile for a shared library and a "vanilla"
414 objfile. (If not set, the objfile may still actually be a solib.
415 This can happen if the user created the objfile by using the
416 add-symbol-file command. GDB doesn't in that situation actually
417 check whether the file is a solib. Rather, the target's
418 implementation of the solib interface is responsible for setting
419 this flag when noticing solibs used by an inferior.) */
c906108c 420
8b41ec65 421#define OBJF_SHARED (1 << 1) /* From a shared library */
c906108c 422
2acceee2
JM
423/* User requested that this objfile be read in it's entirety. */
424
8b41ec65 425#define OBJF_READNOW (1 << 2) /* Immediate full read */
2acceee2 426
2df3850c
JM
427/* This objfile was created because the user explicitly caused it
428 (e.g., used the add-symbol-file command). This bit offers a way
429 for run_command to remove old objfile entries which are no longer
430 valid (i.e., are associated with an old inferior), but to preserve
431 ones that the user explicitly loaded via the add-symbol-file
432 command. */
433
8b41ec65 434#define OBJF_USERLOADED (1 << 3) /* User loaded */
2df3850c 435
c906108c
SS
436/* The object file that contains the runtime common minimal symbols
437 for SunOS4. Note that this objfile has no associated BFD. */
438
439extern struct objfile *rt_common_objfile;
440
b99607ea 441/* When we need to allocate a new type, we need to know which objfile_obstack
c906108c
SS
442 to allocate the type on, since there is one for each objfile. The places
443 where types are allocated are deeply buried in function call hierarchies
444 which know nothing about objfiles, so rather than trying to pass a
445 particular objfile down to them, we just do an end run around them and
446 set current_objfile to be whatever objfile we expect to be using at the
447 time types are being allocated. For instance, when we start reading
448 symbols for a particular objfile, we set current_objfile to point to that
449 objfile, and when we are done, we set it back to NULL, to ensure that we
450 never put a type someplace other than where we are expecting to put it.
451 FIXME: Maybe we should review the entire type handling system and
452 see if there is a better way to avoid this problem. */
453
454extern struct objfile *current_objfile;
455
c906108c
SS
456/* Declarations for functions defined in objfiles.c */
457
a14ed312 458extern struct objfile *allocate_objfile (bfd *, int);
c906108c 459
5e2b427d
UW
460extern struct gdbarch *get_objfile_arch (struct objfile *);
461
9ab9195f
EZ
462extern void init_entry_point_info (struct objfile *);
463
abd0a5fa
JK
464extern int entry_point_address_query (CORE_ADDR *entry_p);
465
9ab9195f
EZ
466extern CORE_ADDR entry_point_address (void);
467
a14ed312 468extern int build_objfile_section_table (struct objfile *);
c906108c 469
15831452
JB
470extern void terminate_minimal_symbol_table (struct objfile *objfile);
471
15d123c9
TG
472extern struct objfile *objfile_separate_debug_iterate (const struct objfile *,
473 const struct objfile *);
474
5b5d99cf
JB
475extern void put_objfile_before (struct objfile *, struct objfile *);
476
a14ed312 477extern void objfile_to_front (struct objfile *);
c906108c 478
15d123c9
TG
479extern void add_separate_debug_objfile (struct objfile *, struct objfile *);
480
a14ed312 481extern void unlink_objfile (struct objfile *);
c906108c 482
a14ed312 483extern void free_objfile (struct objfile *);
c906108c 484
15d123c9
TG
485extern void free_objfile_separate_debug (struct objfile *);
486
74b7792f
AC
487extern struct cleanup *make_cleanup_free_objfile (struct objfile *);
488
a14ed312 489extern void free_all_objfiles (void);
c906108c 490
a14ed312 491extern void objfile_relocate (struct objfile *, struct section_offsets *);
c906108c 492
55333a84
DE
493extern int objfile_has_partial_symbols (struct objfile *objfile);
494
495extern int objfile_has_full_symbols (struct objfile *objfile);
496
e361b228
TG
497extern int objfile_has_symbols (struct objfile *objfile);
498
a14ed312 499extern int have_partial_symbols (void);
c906108c 500
a14ed312 501extern int have_full_symbols (void);
c906108c 502
bb272892
PP
503extern void objfiles_changed (void);
504
c906108c
SS
505/* This operation deletes all objfile entries that represent solibs that
506 weren't explicitly loaded by the user, via e.g., the add-symbol-file
507 command.
c5aa993b 508 */
a14ed312 509extern void objfile_purge_solibs (void);
c906108c
SS
510
511/* Functions for dealing with the minimal symbol table, really a misc
512 address<->symbol mapping for things we don't have debug symbols for. */
513
a14ed312 514extern int have_minimal_symbols (void);
c906108c 515
a14ed312 516extern struct obj_section *find_pc_section (CORE_ADDR pc);
c906108c 517
a14ed312 518extern int in_plt_section (CORE_ADDR, char *);
c906108c 519
0d0e1a63
MK
520/* Keep a registry of per-objfile data-pointers required by other GDB
521 modules. */
522
c1bd65d0 523/* Allocate an entry in the per-objfile registry. */
0d0e1a63 524extern const struct objfile_data *register_objfile_data (void);
c1bd65d0
DE
525
526/* Allocate an entry in the per-objfile registry.
527 SAVE and FREE are called when clearing objfile data.
528 First all registered SAVE functions are called.
529 Then all registered FREE functions are called.
530 Either or both of SAVE, FREE may be NULL. */
60c5725c 531extern const struct objfile_data *register_objfile_data_with_cleanup
c1bd65d0
DE
532 (void (*save) (struct objfile *, void *),
533 void (*free) (struct objfile *, void *));
534
7b097ae3 535extern void clear_objfile_data (struct objfile *objfile);
0d0e1a63
MK
536extern void set_objfile_data (struct objfile *objfile,
537 const struct objfile_data *data, void *value);
538extern void *objfile_data (struct objfile *objfile,
539 const struct objfile_data *data);
e3c69974 540
3db741ef 541extern struct bfd *gdb_bfd_ref (struct bfd *abfd);
e3c69974 542extern void gdb_bfd_unref (struct bfd *abfd);
516ba659 543extern int gdb_bfd_close_or_warn (struct bfd *abfd);
0d0e1a63
MK
544\f
545
6c95b8df
PA
546/* Traverse all object files in the current program space.
547 ALL_OBJFILES_SAFE works even if you delete the objfile during the
548 traversal. */
549
550/* Traverse all object files in program space SS. */
c906108c 551
6c95b8df
PA
552#define ALL_PSPACE_OBJFILES(ss, obj) \
553 for ((obj) = ss->objfiles; (obj) != NULL; (obj) = (obj)->next) \
c906108c 554
6c95b8df
PA
555#define ALL_PSPACE_OBJFILES_SAFE(ss, obj, nxt) \
556 for ((obj) = ss->objfiles; \
557 (obj) != NULL? ((nxt)=(obj)->next,1) :0; \
558 (obj) = (nxt))
559
560#define ALL_OBJFILES(obj) \
561 for ((obj) = current_program_space->objfiles; \
562 (obj) != NULL; \
563 (obj) = (obj)->next)
564
565#define ALL_OBJFILES_SAFE(obj,nxt) \
566 for ((obj) = current_program_space->objfiles; \
c906108c
SS
567 (obj) != NULL? ((nxt)=(obj)->next,1) :0; \
568 (obj) = (nxt))
569
570/* Traverse all symtabs in one objfile. */
571
572#define ALL_OBJFILE_SYMTABS(objfile, s) \
573 for ((s) = (objfile) -> symtabs; (s) != NULL; (s) = (s) -> next)
574
c906108c
SS
575/* Traverse all minimal symbols in one objfile. */
576
577#define ALL_OBJFILE_MSYMBOLS(objfile, m) \
3567439c 578 for ((m) = (objfile) -> msymbols; SYMBOL_LINKAGE_NAME(m) != NULL; (m)++)
c906108c 579
6c95b8df
PA
580/* Traverse all symtabs in all objfiles in the current symbol
581 space. */
c906108c
SS
582
583#define ALL_SYMTABS(objfile, s) \
584 ALL_OBJFILES (objfile) \
585 ALL_OBJFILE_SYMTABS (objfile, s)
586
6c95b8df
PA
587#define ALL_PSPACE_SYMTABS(ss, objfile, s) \
588 ALL_PSPACE_OBJFILES (ss, objfile) \
589 ALL_OBJFILE_SYMTABS (objfile, s)
590
591/* Traverse all symtabs in all objfiles in the current program space,
592 skipping included files (which share a blockvector with their
593 primary symtab). */
11309657
DJ
594
595#define ALL_PRIMARY_SYMTABS(objfile, s) \
596 ALL_OBJFILES (objfile) \
597 ALL_OBJFILE_SYMTABS (objfile, s) \
598 if ((s)->primary)
599
6c95b8df
PA
600#define ALL_PSPACE_PRIMARY_SYMTABS(pspace, objfile, s) \
601 ALL_PSPACE_OBJFILES (ss, objfile) \
602 ALL_OBJFILE_SYMTABS (objfile, s) \
603 if ((s)->primary)
604
6c95b8df
PA
605/* Traverse all minimal symbols in all objfiles in the current symbol
606 space. */
c906108c
SS
607
608#define ALL_MSYMBOLS(objfile, m) \
609 ALL_OBJFILES (objfile) \
15831452 610 ALL_OBJFILE_MSYMBOLS (objfile, m)
c906108c
SS
611
612#define ALL_OBJFILE_OSECTIONS(objfile, osect) \
613 for (osect = objfile->sections; osect < objfile->sections_end; osect++)
614
96a8853a
PA
615/* Traverse all obj_sections in all objfiles in the current program
616 space.
617
618 Note that this detects a "break" in the inner loop, and exits
619 immediately from the outer loop as well, thus, client code doesn't
620 need to know that this is implemented with a double for. The extra
621 hair is to make sure that a "break;" stops the outer loop iterating
622 as well, and both OBJFILE and OSECT are left unmodified:
623
624 - The outer loop learns about the inner loop's end condition, and
625 stops iterating if it detects the inner loop didn't reach its
626 end. In other words, the outer loop keeps going only if the
627 inner loop reached its end cleanly [(osect) ==
628 (objfile)->sections_end].
629
630 - OSECT is initialized in the outer loop initialization
631 expressions, such as if the inner loop has reached its end, so
632 the check mentioned above succeeds the first time.
633
634 - The trick to not clearing OBJFILE on a "break;" is, in the outer
635 loop's loop expression, advance OBJFILE, but iff the inner loop
636 reached its end. If not, there was a "break;", so leave OBJFILE
637 as is; the outer loop's conditional will break immediately as
638 well (as OSECT will be different from OBJFILE->sections_end).
639*/
640
641#define ALL_OBJSECTIONS(objfile, osect) \
642 for ((objfile) = current_program_space->objfiles, \
643 (objfile) != NULL ? ((osect) = (objfile)->sections_end) : 0; \
644 (objfile) != NULL \
645 && (osect) == (objfile)->sections_end; \
646 ((osect) == (objfile)->sections_end \
647 ? ((objfile) = (objfile)->next, \
648 (objfile) != NULL ? (osect) = (objfile)->sections_end : 0) \
649 : 0)) \
650 for ((osect) = (objfile)->sections; \
651 (osect) < (objfile)->sections_end; \
652 (osect)++)
c906108c 653
b8fbeb18 654#define SECT_OFF_DATA(objfile) \
8e65ff28 655 ((objfile->sect_index_data == -1) \
e2e0b3e5 656 ? (internal_error (__FILE__, __LINE__, _("sect_index_data not initialized")), -1) \
8e65ff28 657 : objfile->sect_index_data)
b8fbeb18
EZ
658
659#define SECT_OFF_RODATA(objfile) \
8e65ff28 660 ((objfile->sect_index_rodata == -1) \
e2e0b3e5 661 ? (internal_error (__FILE__, __LINE__, _("sect_index_rodata not initialized")), -1) \
8e65ff28 662 : objfile->sect_index_rodata)
b8fbeb18
EZ
663
664#define SECT_OFF_TEXT(objfile) \
8e65ff28 665 ((objfile->sect_index_text == -1) \
e2e0b3e5 666 ? (internal_error (__FILE__, __LINE__, _("sect_index_text not initialized")), -1) \
8e65ff28 667 : objfile->sect_index_text)
b8fbeb18 668
a4c8257b
EZ
669/* Sometimes the .bss section is missing from the objfile, so we don't
670 want to die here. Let the users of SECT_OFF_BSS deal with an
671 uninitialized section index. */
672#define SECT_OFF_BSS(objfile) (objfile)->sect_index_bss
b8fbeb18 673
c14c28ba
PP
674/* Answer whether there is more than one object file loaded. */
675
676#define MULTI_OBJFILE_P() (object_files && object_files->next)
677
c5aa993b 678#endif /* !defined (OBJFILES_H) */
This page took 0.948206 seconds and 4 git commands to generate.