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