Fix snafu in aarch64 opcodes debugging statement.
[deliverable/binutils-gdb.git] / gdb / objfiles.h
CommitLineData
c906108c 1/* Definitions for symbol file management in GDB.
af5f3db6 2
61baf725 3 Copyright (C) 1992-2017 Free Software Foundation, Inc.
c906108c 4
c5aa993b 5 This file is part of GDB.
c906108c 6
c5aa993b
JM
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
a9762ec7 9 the Free Software Foundation; either version 3 of the License, or
c5aa993b 10 (at your option) any later version.
c906108c 11
c5aa993b
JM
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
c906108c 16
c5aa993b 17 You should have received a copy of the GNU General Public License
a9762ec7 18 along with this program. If not, see <http://www.gnu.org/licenses/>. */
c906108c
SS
19
20#if !defined (OBJFILES_H)
21#define OBJFILES_H
22
63e43d3a 23#include "hashtab.h"
3956d554 24#include "gdb_obstack.h" /* For obstack internals. */
b15cc25c 25#include "objfile-flags.h"
0df8b418 26#include "symfile.h" /* For struct psymbol_allocation_list. */
6c95b8df 27#include "progspace.h"
8e260fc0 28#include "registry.h"
65cf3563 29#include "gdb_bfd.h"
3956d554 30
af5f3db6 31struct bcache;
2de7ced7 32struct htab;
4a4b3fed 33struct objfile_data;
08c0b5bc 34
c906108c
SS
35/* This structure maintains information on a per-objfile basis about the
36 "entry point" of the objfile, and the scope within which the entry point
37 exists. It is possible that gdb will see more than one objfile that is
38 executable, each with its own entry point.
39
40 For example, for dynamically linked executables in SVR4, the dynamic linker
41 code is contained within the shared C library, which is actually executable
42 and is run by the kernel first when an exec is done of a user executable
43 that is dynamically linked. The dynamic linker within the shared C library
44 then maps in the various program segments in the user executable and jumps
45 to the user executable's recorded entry point, as if the call had been made
46 directly by the kernel.
47
73c1e0a1
AC
48 The traditional gdb method of using this info was to use the
49 recorded entry point to set the entry-file's lowpc and highpc from
627b3ba2
AC
50 the debugging information, where these values are the starting
51 address (inclusive) and ending address (exclusive) of the
52 instruction space in the executable which correspond to the
0df8b418 53 "startup file", i.e. crt0.o in most cases. This file is assumed to
627b3ba2
AC
54 be a startup file and frames with pc's inside it are treated as
55 nonexistent. Setting these variables is necessary so that
56 backtraces do not fly off the bottom of the stack.
57
58 NOTE: cagney/2003-09-09: It turns out that this "traditional"
59 method doesn't work. Corinna writes: ``It turns out that the call
2f72f850 60 to test for "inside entry file" destroys a meaningful backtrace
0df8b418 61 under some conditions. E.g. the backtrace tests in the asm-source
627b3ba2
AC
62 testcase are broken for some targets. In this test the functions
63 are all implemented as part of one file and the testcase is not
64 necessarily linked with a start file (depending on the target).
65 What happens is, that the first frame is printed normaly and
66 following frames are treated as being inside the enttry file then.
67 This way, only the #0 frame is printed in the backtrace output.''
68 Ref "frame.c" "NOTE: vinschen/2003-04-01".
c906108c
SS
69
70 Gdb also supports an alternate method to avoid running off the bottom
71 of the stack.
72
73 There are two frames that are "special", the frame for the function
74 containing the process entry point, since it has no predecessor frame,
75 and the frame for the function containing the user code entry point
76 (the main() function), since all the predecessor frames are for the
77 process startup code. Since we have no guarantee that the linked
78 in startup modules have any debugging information that gdb can use,
79 we need to avoid following frame pointers back into frames that might
95cf5869 80 have been built in the startup code, as we might get hopelessly
c906108c
SS
81 confused. However, we almost always have debugging information
82 available for main().
83
618ce49f
AC
84 These variables are used to save the range of PC values which are
85 valid within the main() function and within the function containing
86 the process entry point. If we always consider the frame for
87 main() as the outermost frame when debugging user code, and the
88 frame for the process entry point function as the outermost frame
89 when debugging startup code, then all we have to do is have
90 DEPRECATED_FRAME_CHAIN_VALID return false whenever a frame's
91 current PC is within the range specified by these variables. In
92 essence, we set "ceilings" in the frame chain beyond which we will
c906108c
SS
93 not proceed when following the frame chain back up the stack.
94
95 A nice side effect is that we can still debug startup code without
96 running off the end of the frame chain, assuming that we have usable
97 debugging information in the startup modules, and if we choose to not
98 use the block at main, or can't find it for some reason, everything
99 still works as before. And if we have no startup code debugging
100 information but we do have usable information for main(), backtraces
6e4c6c91 101 from user code don't go wandering off into the startup code. */
c906108c
SS
102
103struct entry_info
95cf5869
DE
104{
105 /* The unrelocated value we should use for this objfile entry point. */
106 CORE_ADDR entry_point;
c906108c 107
95cf5869
DE
108 /* The index of the section in which the entry point appears. */
109 int the_bfd_section_index;
53eddfa6 110
95cf5869
DE
111 /* Set to 1 iff ENTRY_POINT contains a valid value. */
112 unsigned entry_point_p : 1;
6ef55de7 113
95cf5869
DE
114 /* Set to 1 iff this object was initialized. */
115 unsigned initialized : 1;
116};
c906108c 117
f1f6aadf
PA
118/* Sections in an objfile. The section offsets are stored in the
119 OBJFILE. */
c906108c 120
c5aa993b 121struct obj_section
95cf5869
DE
122{
123 /* BFD section pointer */
124 struct bfd_section *the_bfd_section;
c906108c 125
95cf5869
DE
126 /* Objfile this section is part of. */
127 struct objfile *objfile;
c906108c 128
95cf5869
DE
129 /* True if this "overlay section" is mapped into an "overlay region". */
130 int ovly_mapped;
131};
c906108c 132
f1f6aadf
PA
133/* Relocation offset applied to S. */
134#define obj_section_offset(s) \
65cf3563 135 (((s)->objfile->section_offsets)->offsets[gdb_bfd_section_index ((s)->objfile->obfd, (s)->the_bfd_section)])
f1f6aadf
PA
136
137/* The memory address of section S (vma + offset). */
138#define obj_section_addr(s) \
1706c199 139 (bfd_get_section_vma ((s)->objfile->obfd, s->the_bfd_section) \
f1f6aadf
PA
140 + obj_section_offset (s))
141
142/* The one-passed-the-end memory address of section S
143 (vma + size + offset). */
144#define obj_section_endaddr(s) \
1706c199 145 (bfd_get_section_vma ((s)->objfile->obfd, s->the_bfd_section) \
f1f6aadf
PA
146 + bfd_get_section_size ((s)->the_bfd_section) \
147 + obj_section_offset (s))
c906108c 148
c906108c
SS
149/* The "objstats" structure provides a place for gdb to record some
150 interesting information about its internal state at runtime, on a
151 per objfile basis, such as information about the number of symbols
0df8b418 152 read, size of string table (if any), etc. */
c906108c 153
c5aa993b 154struct objstats
95cf5869
DE
155{
156 /* Number of partial symbols read. */
157 int n_psyms;
158
159 /* Number of full symbols read. */
160 int n_syms;
161
162 /* Number of ".stabs" read (if applicable). */
163 int n_stabs;
164
165 /* Number of types. */
166 int n_types;
167
168 /* Size of stringtable, (if applicable). */
169 int sz_strtab;
170};
c906108c
SS
171
172#define OBJSTAT(objfile, expr) (objfile -> stats.expr)
173#define OBJSTATS struct objstats stats
a14ed312
KB
174extern void print_objfile_statistics (void);
175extern void print_symbol_bcache_statistics (void);
c906108c 176
9227b5eb 177/* Number of entries in the minimal symbol hash table. */
375f3d86 178#define MINIMAL_SYMBOL_HASH_SIZE 2039
9227b5eb 179
706e3705
TT
180/* Some objfile data is hung off the BFD. This enables sharing of the
181 data across all objfiles using the BFD. The data is stored in an
182 instance of this structure, and associated with the BFD using the
183 registry system. */
184
185struct objfile_per_bfd_storage
186{
187 /* The storage has an obstack of its own. */
188
189 struct obstack storage_obstack;
95cf5869 190
706e3705
TT
191 /* Byte cache for file names. */
192
193 struct bcache *filename_cache;
6532ff36
TT
194
195 /* Byte cache for macros. */
95cf5869 196
6532ff36 197 struct bcache *macro_cache;
df6d5441
TT
198
199 /* The gdbarch associated with the BFD. Note that this gdbarch is
200 determined solely from BFD information, without looking at target
201 information. The gdbarch determined from a running target may
202 differ from this e.g. with respect to register types and names. */
203
204 struct gdbarch *gdbarch;
84a1243b
TT
205
206 /* Hash table for mapping symbol names to demangled names. Each
207 entry in the hash table is actually two consecutive strings,
208 both null-terminated; the first one is a mangled or linkage
209 name, and the second is the demangled name or just a zero byte
210 if the name doesn't demangle. */
95cf5869 211
84a1243b 212 struct htab *demangled_names_hash;
6ef55de7
TT
213
214 /* The per-objfile information about the entry point, the scope (file/func)
215 containing the entry point, and the scope of the user's main() func. */
216
217 struct entry_info ei;
3d548a53
TT
218
219 /* The name and language of any "main" found in this objfile. The
220 name can be NULL, which means that the information was not
221 recorded. */
222
223 const char *name_of_main;
224 enum language language_of_main;
34643a32
TT
225
226 /* Each file contains a pointer to an array of minimal symbols for all
227 global symbols that are defined within the file. The array is
228 terminated by a "null symbol", one that has a NULL pointer for the
229 name and a zero value for the address. This makes it easy to walk
230 through the array when passed a pointer to somewhere in the middle
231 of it. There is also a count of the number of symbols, which does
232 not include the terminating null symbol. The array itself, as well
233 as all the data that it points to, should be allocated on the
234 objfile_obstack for this file. */
235
236 struct minimal_symbol *msymbols;
237 int minimal_symbol_count;
238
5f6cac40
TT
239 /* The number of minimal symbols read, before any minimal symbol
240 de-duplication is applied. Note in particular that this has only
241 a passing relationship with the actual size of the table above;
242 use minimal_symbol_count if you need the true size. */
95cf5869 243
5f6cac40
TT
244 int n_minsyms;
245
34643a32
TT
246 /* This is true if minimal symbols have already been read. Symbol
247 readers can use this to bypass minimal symbol reading. Also, the
248 minimal symbol table management code in minsyms.c uses this to
249 suppress new minimal symbols. You might think that MSYMBOLS or
250 MINIMAL_SYMBOL_COUNT could be used for this, but it is possible
251 for multiple readers to install minimal symbols into a given
252 per-BFD. */
253
254 unsigned int minsyms_read : 1;
255
256 /* This is a hash table used to index the minimal symbols by name. */
257
258 struct minimal_symbol *msymbol_hash[MINIMAL_SYMBOL_HASH_SIZE];
259
260 /* This hash table is used to index the minimal symbols by their
261 demangled names. */
262
263 struct minimal_symbol *msymbol_demangled_hash[MINIMAL_SYMBOL_HASH_SIZE];
706e3705
TT
264};
265
c906108c
SS
266/* Master structure for keeping track of each file from which
267 gdb reads symbols. There are several ways these get allocated: 1.
268 The main symbol file, symfile_objfile, set by the symbol-file command,
269 2. Additional symbol files added by the add-symbol-file command,
270 3. Shared library objfiles, added by ADD_SOLIB, 4. symbol files
271 for modules that were loaded when GDB attached to a remote system
272 (see remote-vx.c). */
273
274struct objfile
95cf5869
DE
275{
276 /* All struct objfile's are chained together by their next pointers.
277 The program space field "objfiles" (frequently referenced via
278 the macro "object_files") points to the first link in this chain. */
c906108c 279
95cf5869 280 struct objfile *next;
c906108c 281
95cf5869
DE
282 /* The object file's original name as specified by the user,
283 made absolute, and tilde-expanded. However, it is not canonicalized
284 (i.e., it has not been passed through gdb_realpath).
285 This pointer is never NULL. This does not have to be freed; it is
286 guaranteed to have a lifetime at least as long as the objfile. */
c906108c 287
95cf5869 288 char *original_name;
c906108c 289
95cf5869 290 CORE_ADDR addr_low;
c906108c 291
b15cc25c 292 /* Some flag bits for this objfile. */
e4f6d2ec 293
b15cc25c 294 objfile_flags flags;
c906108c 295
95cf5869 296 /* The program space associated with this objfile. */
c906108c 297
95cf5869 298 struct program_space *pspace;
6c95b8df 299
95cf5869
DE
300 /* List of compunits.
301 These are used to do symbol lookups and file/line-number lookups. */
6c95b8df 302
95cf5869 303 struct compunit_symtab *compunit_symtabs;
c906108c 304
95cf5869
DE
305 /* Each objfile points to a linked list of partial symtabs derived from
306 this file, one partial symtab structure for each compilation unit
307 (source file). */
c906108c 308
95cf5869 309 struct partial_symtab *psymtabs;
c906108c 310
95cf5869
DE
311 /* Map addresses to the entries of PSYMTABS. It would be more efficient to
312 have a map per the whole process but ADDRMAP cannot selectively remove
313 its items during FREE_OBJFILE. This mapping is already present even for
314 PARTIAL_SYMTABs which still have no corresponding full SYMTABs read. */
c906108c 315
95cf5869 316 struct addrmap *psymtabs_addrmap;
ff013f42 317
95cf5869 318 /* List of freed partial symtabs, available for re-use. */
ff013f42 319
95cf5869 320 struct partial_symtab *free_psymtabs;
c906108c 321
95cf5869
DE
322 /* The object file's BFD. Can be null if the objfile contains only
323 minimal symbols, e.g. the run time common symbols for SunOS4. */
c906108c 324
95cf5869 325 bfd *obfd;
c906108c 326
95cf5869
DE
327 /* The per-BFD data. Note that this is treated specially if OBFD
328 is NULL. */
c906108c 329
95cf5869 330 struct objfile_per_bfd_storage *per_bfd;
706e3705 331
95cf5869
DE
332 /* The modification timestamp of the object file, as of the last time
333 we read its symbols. */
706e3705 334
95cf5869 335 long mtime;
c906108c 336
95cf5869
DE
337 /* Obstack to hold objects that should be freed when we load a new symbol
338 table from this object file. */
c906108c 339
95cf5869 340 struct obstack objfile_obstack;
b99607ea 341
95cf5869
DE
342 /* A byte cache where we can stash arbitrary "chunks" of bytes that
343 will not change. */
b99607ea 344
95cf5869 345 struct psymbol_bcache *psymbol_cache; /* Byte cache for partial syms. */
c906108c 346
95cf5869
DE
347 /* Vectors of all partial symbols read in from file. The actual data
348 is stored in the objfile_obstack. */
c906108c 349
95cf5869
DE
350 struct psymbol_allocation_list global_psymbols;
351 struct psymbol_allocation_list static_psymbols;
c906108c 352
95cf5869
DE
353 /* Structure which keeps track of functions that manipulate objfile's
354 of the same type as this objfile. I.e. the function to read partial
355 symbols for example. Note that this structure is in statically
356 allocated memory, and is shared by all objfiles that use the
357 object module reader of this type. */
c906108c 358
95cf5869 359 const struct sym_fns *sf;
c906108c 360
95cf5869 361 /* Per objfile data-pointers required by other GDB modules. */
c906108c 362
95cf5869 363 REGISTRY_FIELDS;
0d0e1a63 364
95cf5869
DE
365 /* Set of relocation offsets to apply to each section.
366 The table is indexed by the_bfd_section->index, thus it is generally
367 as large as the number of sections in the binary.
368 The table is stored on the objfile_obstack.
0d0e1a63 369
95cf5869
DE
370 These offsets indicate that all symbols (including partial and
371 minimal symbols) which have been read have been relocated by this
372 much. Symbols which are yet to be read need to be relocated by it. */
c906108c 373
95cf5869
DE
374 struct section_offsets *section_offsets;
375 int num_sections;
c906108c 376
95cf5869
DE
377 /* Indexes in the section_offsets array. These are initialized by the
378 *_symfile_offsets() family of functions (som_symfile_offsets,
379 xcoff_symfile_offsets, default_symfile_offsets). In theory they
380 should correspond to the section indexes used by bfd for the
381 current objfile. The exception to this for the time being is the
382 SOM version. */
c906108c 383
95cf5869
DE
384 int sect_index_text;
385 int sect_index_data;
386 int sect_index_bss;
387 int sect_index_rodata;
b8fbeb18 388
95cf5869
DE
389 /* These pointers are used to locate the section table, which
390 among other things, is used to map pc addresses into sections.
391 SECTIONS points to the first entry in the table, and
392 SECTIONS_END points to the first location past the last entry
393 in the table. The table is stored on the objfile_obstack. The
394 sections are indexed by the BFD section index; but the
395 structure data is only valid for certain sections
396 (e.g. non-empty, SEC_ALLOC). */
b8fbeb18 397
95cf5869 398 struct obj_section *sections, *sections_end;
c906108c 399
95cf5869
DE
400 /* GDB allows to have debug symbols in separate object files. This is
401 used by .gnu_debuglink, ELF build id note and Mach-O OSO.
402 Although this is a tree structure, GDB only support one level
403 (ie a separate debug for a separate debug is not supported). Note that
404 separate debug object are in the main chain and therefore will be
405 visited by ALL_OBJFILES & co iterators. Separate debug objfile always
406 has a non-nul separate_debug_objfile_backlink. */
c906108c 407
95cf5869 408 /* Link to the first separate debug object, if any. */
15d123c9 409
95cf5869 410 struct objfile *separate_debug_objfile;
5b5d99cf 411
95cf5869
DE
412 /* If this is a separate debug object, this is used as a link to the
413 actual executable objfile. */
15d123c9 414
95cf5869 415 struct objfile *separate_debug_objfile_backlink;
15d123c9 416
95cf5869
DE
417 /* If this is a separate debug object, this is a link to the next one
418 for the same executable objfile. */
5c4e30ca 419
95cf5869
DE
420 struct objfile *separate_debug_objfile_link;
421
422 /* Place to stash various statistics about this objfile. */
423
424 OBJSTATS;
425
426 /* A linked list of symbols created when reading template types or
427 function templates. These symbols are not stored in any symbol
428 table, so we have to keep them here to relocate them
429 properly. */
430
431 struct symbol *template_symbols;
63e43d3a
PMR
432
433 /* Associate a static link (struct dynamic_prop *) to all blocks (struct
434 block *) that have one.
435
436 In the context of nested functions (available in Pascal, Ada and GNU C,
437 for instance), a static link (as in DWARF's DW_AT_static_link attribute)
438 for a function is a way to get the frame corresponding to the enclosing
439 function.
440
441 Very few blocks have a static link, so it's more memory efficient to
442 store these here rather than in struct block. Static links must be
443 allocated on the objfile's obstack. */
444 htab_t static_links;
95cf5869 445};
c906108c 446
c906108c
SS
447/* Declarations for functions defined in objfiles.c */
448
b15cc25c
PA
449extern struct objfile *allocate_objfile (bfd *, const char *name,
450 objfile_flags);
c906108c 451
9c1877ea 452extern struct gdbarch *get_objfile_arch (const struct objfile *);
5e2b427d 453
abd0a5fa
JK
454extern int entry_point_address_query (CORE_ADDR *entry_p);
455
9ab9195f
EZ
456extern CORE_ADDR entry_point_address (void);
457
d82ea6a8 458extern void build_objfile_section_table (struct objfile *);
c906108c 459
15d123c9
TG
460extern struct objfile *objfile_separate_debug_iterate (const struct objfile *,
461 const struct objfile *);
462
5b5d99cf
JB
463extern void put_objfile_before (struct objfile *, struct objfile *);
464
15d123c9
TG
465extern void add_separate_debug_objfile (struct objfile *, struct objfile *);
466
a14ed312 467extern void unlink_objfile (struct objfile *);
c906108c 468
a14ed312 469extern void free_objfile (struct objfile *);
c906108c 470
15d123c9
TG
471extern void free_objfile_separate_debug (struct objfile *);
472
74b7792f
AC
473extern struct cleanup *make_cleanup_free_objfile (struct objfile *);
474
a14ed312 475extern void free_all_objfiles (void);
c906108c 476
3189cb12 477extern void objfile_relocate (struct objfile *, const struct section_offsets *);
4141a416 478extern void objfile_rebase (struct objfile *, CORE_ADDR);
c906108c 479
55333a84
DE
480extern int objfile_has_partial_symbols (struct objfile *objfile);
481
482extern int objfile_has_full_symbols (struct objfile *objfile);
483
e361b228
TG
484extern int objfile_has_symbols (struct objfile *objfile);
485
a14ed312 486extern int have_partial_symbols (void);
c906108c 487
a14ed312 488extern int have_full_symbols (void);
c906108c 489
8fb8eb5c
DE
490extern void objfile_set_sym_fns (struct objfile *objfile,
491 const struct sym_fns *sf);
492
bb272892 493extern void objfiles_changed (void);
63644780
NB
494
495extern int is_addr_in_objfile (CORE_ADDR addr, const struct objfile *objfile);
bb272892 496
d03de421
PA
497/* Return true if ADDRESS maps into one of the sections of a
498 OBJF_SHARED objfile of PSPACE and false otherwise. */
08351840 499
d03de421
PA
500extern int shared_objfile_contains_address_p (struct program_space *pspace,
501 CORE_ADDR address);
08351840 502
c906108c
SS
503/* This operation deletes all objfile entries that represent solibs that
504 weren't explicitly loaded by the user, via e.g., the add-symbol-file
0df8b418
MS
505 command. */
506
a14ed312 507extern void objfile_purge_solibs (void);
c906108c
SS
508
509/* Functions for dealing with the minimal symbol table, really a misc
510 address<->symbol mapping for things we don't have debug symbols for. */
511
a14ed312 512extern int have_minimal_symbols (void);
c906108c 513
a14ed312 514extern struct obj_section *find_pc_section (CORE_ADDR pc);
c906108c 515
3e5d3a5a 516/* Return non-zero if PC is in a section called NAME. */
a121b7c1 517extern int pc_in_section (CORE_ADDR, const char *);
3e5d3a5a
MR
518
519/* Return non-zero if PC is in a SVR4-style procedure linkage table
520 section. */
521
522static inline int
523in_plt_section (CORE_ADDR pc)
524{
525 return pc_in_section (pc, ".plt");
526}
c906108c 527
0d0e1a63
MK
528/* Keep a registry of per-objfile data-pointers required by other GDB
529 modules. */
8e260fc0 530DECLARE_REGISTRY(objfile);
e3c69974 531
607ece04
GB
532/* In normal use, the section map will be rebuilt by find_pc_section
533 if objfiles have been added, removed or relocated since it was last
534 called. Calling inhibit_section_map_updates will inhibit this
535 behavior until resume_section_map_updates is called. If you call
536 inhibit_section_map_updates you must ensure that every call to
537 find_pc_section in the inhibited region relates to a section that
538 is already in the section map and has not since been removed or
539 relocated. */
540extern void inhibit_section_map_updates (struct program_space *pspace);
541
542/* Resume automatically rebuilding the section map as required. */
543extern void resume_section_map_updates (struct program_space *pspace);
544
545/* Version of the above suitable for use as a cleanup. */
546extern void resume_section_map_updates_cleanup (void *arg);
547
19630284
JB
548extern void default_iterate_over_objfiles_in_search_order
549 (struct gdbarch *gdbarch,
550 iterate_over_objfiles_in_search_order_cb_ftype *cb,
551 void *cb_data, struct objfile *current_objfile);
0d0e1a63
MK
552\f
553
6c95b8df
PA
554/* Traverse all object files in the current program space.
555 ALL_OBJFILES_SAFE works even if you delete the objfile during the
556 traversal. */
557
558/* Traverse all object files in program space SS. */
c906108c 559
6c95b8df 560#define ALL_PSPACE_OBJFILES(ss, obj) \
81b52a3a 561 for ((obj) = ss->objfiles; (obj) != NULL; (obj) = (obj)->next)
c906108c 562
6c95b8df
PA
563#define ALL_OBJFILES(obj) \
564 for ((obj) = current_program_space->objfiles; \
565 (obj) != NULL; \
566 (obj) = (obj)->next)
567
568#define ALL_OBJFILES_SAFE(obj,nxt) \
569 for ((obj) = current_program_space->objfiles; \
c906108c
SS
570 (obj) != NULL? ((nxt)=(obj)->next,1) :0; \
571 (obj) = (nxt))
572
573/* Traverse all symtabs in one objfile. */
574
43f3e411
DE
575#define ALL_OBJFILE_FILETABS(objfile, cu, s) \
576 ALL_OBJFILE_COMPUNITS (objfile, cu) \
577 ALL_COMPUNIT_FILETABS (cu, s)
c906108c 578
43f3e411 579/* Traverse all compunits in one objfile. */
d790cf0a 580
43f3e411
DE
581#define ALL_OBJFILE_COMPUNITS(objfile, cu) \
582 for ((cu) = (objfile) -> compunit_symtabs; (cu) != NULL; (cu) = (cu) -> next)
d790cf0a 583
c906108c
SS
584/* Traverse all minimal symbols in one objfile. */
585
34643a32
TT
586#define ALL_OBJFILE_MSYMBOLS(objfile, m) \
587 for ((m) = (objfile)->per_bfd->msymbols; \
588 MSYMBOL_LINKAGE_NAME (m) != NULL; \
589 (m)++)
c906108c 590
6c95b8df
PA
591/* Traverse all symtabs in all objfiles in the current symbol
592 space. */
c906108c 593
43f3e411
DE
594#define ALL_FILETABS(objfile, ps, s) \
595 ALL_OBJFILES (objfile) \
596 ALL_OBJFILE_FILETABS (objfile, ps, s)
c906108c 597
43f3e411 598/* Traverse all compunits in all objfiles in the current program space. */
11309657 599
43f3e411 600#define ALL_COMPUNITS(objfile, cu) \
11309657 601 ALL_OBJFILES (objfile) \
43f3e411 602 ALL_OBJFILE_COMPUNITS (objfile, cu)
11309657 603
6c95b8df
PA
604/* Traverse all minimal symbols in all objfiles in the current symbol
605 space. */
c906108c
SS
606
607#define ALL_MSYMBOLS(objfile, m) \
608 ALL_OBJFILES (objfile) \
15831452 609 ALL_OBJFILE_MSYMBOLS (objfile, m)
c906108c
SS
610
611#define ALL_OBJFILE_OSECTIONS(objfile, osect) \
65cf3563
TT
612 for (osect = objfile->sections; osect < objfile->sections_end; osect++) \
613 if (osect->the_bfd_section == NULL) \
614 { \
615 /* Nothing. */ \
616 } \
617 else
c906108c 618
96a8853a
PA
619/* Traverse all obj_sections in all objfiles in the current program
620 space.
621
622 Note that this detects a "break" in the inner loop, and exits
623 immediately from the outer loop as well, thus, client code doesn't
624 need to know that this is implemented with a double for. The extra
625 hair is to make sure that a "break;" stops the outer loop iterating
626 as well, and both OBJFILE and OSECT are left unmodified:
627
628 - The outer loop learns about the inner loop's end condition, and
629 stops iterating if it detects the inner loop didn't reach its
630 end. In other words, the outer loop keeps going only if the
631 inner loop reached its end cleanly [(osect) ==
632 (objfile)->sections_end].
633
634 - OSECT is initialized in the outer loop initialization
635 expressions, such as if the inner loop has reached its end, so
636 the check mentioned above succeeds the first time.
637
638 - The trick to not clearing OBJFILE on a "break;" is, in the outer
639 loop's loop expression, advance OBJFILE, but iff the inner loop
640 reached its end. If not, there was a "break;", so leave OBJFILE
641 as is; the outer loop's conditional will break immediately as
0df8b418 642 well (as OSECT will be different from OBJFILE->sections_end). */
96a8853a
PA
643
644#define ALL_OBJSECTIONS(objfile, osect) \
645 for ((objfile) = current_program_space->objfiles, \
646 (objfile) != NULL ? ((osect) = (objfile)->sections_end) : 0; \
647 (objfile) != NULL \
648 && (osect) == (objfile)->sections_end; \
649 ((osect) == (objfile)->sections_end \
650 ? ((objfile) = (objfile)->next, \
651 (objfile) != NULL ? (osect) = (objfile)->sections_end : 0) \
652 : 0)) \
65cf3563 653 ALL_OBJFILE_OSECTIONS (objfile, osect)
c906108c 654
b8fbeb18 655#define SECT_OFF_DATA(objfile) \
8e65ff28 656 ((objfile->sect_index_data == -1) \
3e43a32a
MS
657 ? (internal_error (__FILE__, __LINE__, \
658 _("sect_index_data not initialized")), -1) \
8e65ff28 659 : objfile->sect_index_data)
b8fbeb18
EZ
660
661#define SECT_OFF_RODATA(objfile) \
8e65ff28 662 ((objfile->sect_index_rodata == -1) \
3e43a32a
MS
663 ? (internal_error (__FILE__, __LINE__, \
664 _("sect_index_rodata not initialized")), -1) \
8e65ff28 665 : objfile->sect_index_rodata)
b8fbeb18
EZ
666
667#define SECT_OFF_TEXT(objfile) \
8e65ff28 668 ((objfile->sect_index_text == -1) \
3e43a32a
MS
669 ? (internal_error (__FILE__, __LINE__, \
670 _("sect_index_text not initialized")), -1) \
8e65ff28 671 : objfile->sect_index_text)
b8fbeb18 672
a4c8257b 673/* Sometimes the .bss section is missing from the objfile, so we don't
0df8b418
MS
674 want to die here. Let the users of SECT_OFF_BSS deal with an
675 uninitialized section index. */
a4c8257b 676#define SECT_OFF_BSS(objfile) (objfile)->sect_index_bss
b8fbeb18 677
c14c28ba
PP
678/* Answer whether there is more than one object file loaded. */
679
680#define MULTI_OBJFILE_P() (object_files && object_files->next)
681
706e3705
TT
682/* Reset the per-BFD storage area on OBJ. */
683
684void set_objfile_per_bfd (struct objfile *obj);
685
e02c96a7
DE
686/* Return canonical name for OBJFILE.
687 This is the real file name if the file has been opened.
688 Otherwise it is the original name supplied by the user. */
689
4262abfb
JK
690const char *objfile_name (const struct objfile *objfile);
691
e02c96a7
DE
692/* Return the (real) file name of OBJFILE if the file has been opened,
693 otherwise return NULL. */
694
695const char *objfile_filename (const struct objfile *objfile);
696
cc485e62
DE
697/* Return the name to print for OBJFILE in debugging messages. */
698
699extern const char *objfile_debug_name (const struct objfile *objfile);
700
015d2e7e
DE
701/* Return the name of the file format of OBJFILE if the file has been opened,
702 otherwise return NULL. */
703
704const char *objfile_flavour_name (struct objfile *objfile);
705
3d548a53
TT
706/* Set the objfile's notion of the "main" name and language. */
707
708extern void set_objfile_main_name (struct objfile *objfile,
709 const char *name, enum language lang);
710
63e43d3a
PMR
711extern void objfile_register_static_link
712 (struct objfile *objfile,
713 const struct block *block,
714 const struct dynamic_prop *static_link);
715
716extern const struct dynamic_prop *objfile_lookup_static_link
717 (struct objfile *objfile, const struct block *block);
718
c5aa993b 719#endif /* !defined (OBJFILES_H) */
This page took 1.572647 seconds and 4 git commands to generate.