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