ada: Use std::string in print_dynamic_range_bound
[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. */
9e86da07 157 int n_psyms = 0;
95cf5869
DE
158
159 /* Number of full symbols read. */
9e86da07 160 int n_syms = 0;
95cf5869
DE
161
162 /* Number of ".stabs" read (if applicable). */
9e86da07 163 int n_stabs = 0;
95cf5869
DE
164
165 /* Number of types. */
9e86da07 166 int n_types = 0;
95cf5869
DE
167
168 /* Size of stringtable, (if applicable). */
9e86da07 169 int sz_strtab = 0;
95cf5869 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{
23732b1e
PA
187 objfile_per_bfd_storage ()
188 : minsyms_read (false)
189 {}
190
706e3705
TT
191 /* The storage has an obstack of its own. */
192
23732b1e 193 auto_obstack storage_obstack;
95cf5869 194
706e3705
TT
195 /* Byte cache for file names. */
196
23732b1e 197 bcache *filename_cache = NULL;
6532ff36
TT
198
199 /* Byte cache for macros. */
95cf5869 200
23732b1e 201 bcache *macro_cache = NULL;
df6d5441
TT
202
203 /* The gdbarch associated with the BFD. Note that this gdbarch is
204 determined solely from BFD information, without looking at target
205 information. The gdbarch determined from a running target may
206 differ from this e.g. with respect to register types and names. */
207
23732b1e 208 struct gdbarch *gdbarch = NULL;
84a1243b
TT
209
210 /* Hash table for mapping symbol names to demangled names. Each
211 entry in the hash table is actually two consecutive strings,
212 both null-terminated; the first one is a mangled or linkage
213 name, and the second is the demangled name or just a zero byte
214 if the name doesn't demangle. */
95cf5869 215
23732b1e 216 htab *demangled_names_hash = NULL;
6ef55de7
TT
217
218 /* The per-objfile information about the entry point, the scope (file/func)
219 containing the entry point, and the scope of the user's main() func. */
220
23732b1e 221 entry_info ei {};
3d548a53
TT
222
223 /* The name and language of any "main" found in this objfile. The
224 name can be NULL, which means that the information was not
225 recorded. */
226
23732b1e
PA
227 const char *name_of_main = NULL;
228 enum language language_of_main = language_unknown;
34643a32
TT
229
230 /* Each file contains a pointer to an array of minimal symbols for all
231 global symbols that are defined within the file. The array is
232 terminated by a "null symbol", one that has a NULL pointer for the
233 name and a zero value for the address. This makes it easy to walk
234 through the array when passed a pointer to somewhere in the middle
235 of it. There is also a count of the number of symbols, which does
236 not include the terminating null symbol. The array itself, as well
237 as all the data that it points to, should be allocated on the
238 objfile_obstack for this file. */
239
23732b1e
PA
240 minimal_symbol *msymbols = NULL;
241 int minimal_symbol_count = 0;
34643a32 242
5f6cac40
TT
243 /* The number of minimal symbols read, before any minimal symbol
244 de-duplication is applied. Note in particular that this has only
245 a passing relationship with the actual size of the table above;
246 use minimal_symbol_count if you need the true size. */
95cf5869 247
23732b1e 248 int n_minsyms = 0;
5f6cac40 249
34643a32
TT
250 /* This is true if minimal symbols have already been read. Symbol
251 readers can use this to bypass minimal symbol reading. Also, the
252 minimal symbol table management code in minsyms.c uses this to
253 suppress new minimal symbols. You might think that MSYMBOLS or
254 MINIMAL_SYMBOL_COUNT could be used for this, but it is possible
255 for multiple readers to install minimal symbols into a given
256 per-BFD. */
257
23732b1e 258 bool minsyms_read : 1;
34643a32
TT
259
260 /* This is a hash table used to index the minimal symbols by name. */
261
23732b1e 262 minimal_symbol *msymbol_hash[MINIMAL_SYMBOL_HASH_SIZE] {};
34643a32
TT
263
264 /* This hash table is used to index the minimal symbols by their
265 demangled names. */
266
23732b1e 267 minimal_symbol *msymbol_demangled_hash[MINIMAL_SYMBOL_HASH_SIZE] {};
706e3705
TT
268};
269
c906108c
SS
270/* Master structure for keeping track of each file from which
271 gdb reads symbols. There are several ways these get allocated: 1.
272 The main symbol file, symfile_objfile, set by the symbol-file command,
273 2. Additional symbol files added by the add-symbol-file command,
274 3. Shared library objfiles, added by ADD_SOLIB, 4. symbol files
275 for modules that were loaded when GDB attached to a remote system
276 (see remote-vx.c). */
277
278struct objfile
95cf5869 279{
9e86da07
TT
280 objfile (bfd *, const char *, objfile_flags);
281 ~objfile ();
282
283 DISABLE_COPY_AND_ASSIGN (objfile);
284
95cf5869
DE
285 /* All struct objfile's are chained together by their next pointers.
286 The program space field "objfiles" (frequently referenced via
287 the macro "object_files") points to the first link in this chain. */
c906108c 288
9e86da07 289 struct objfile *next = nullptr;
c906108c 290
95cf5869
DE
291 /* The object file's original name as specified by the user,
292 made absolute, and tilde-expanded. However, it is not canonicalized
293 (i.e., it has not been passed through gdb_realpath).
294 This pointer is never NULL. This does not have to be freed; it is
295 guaranteed to have a lifetime at least as long as the objfile. */
c906108c 296
9e86da07 297 char *original_name = nullptr;
c906108c 298
9e86da07 299 CORE_ADDR addr_low = 0;
c906108c 300
b15cc25c 301 /* Some flag bits for this objfile. */
e4f6d2ec 302
b15cc25c 303 objfile_flags flags;
c906108c 304
95cf5869 305 /* The program space associated with this objfile. */
c906108c 306
95cf5869 307 struct program_space *pspace;
6c95b8df 308
95cf5869
DE
309 /* List of compunits.
310 These are used to do symbol lookups and file/line-number lookups. */
6c95b8df 311
9e86da07 312 struct compunit_symtab *compunit_symtabs = nullptr;
c906108c 313
95cf5869
DE
314 /* Each objfile points to a linked list of partial symtabs derived from
315 this file, one partial symtab structure for each compilation unit
316 (source file). */
c906108c 317
9e86da07 318 struct partial_symtab *psymtabs = nullptr;
c906108c 319
95cf5869
DE
320 /* Map addresses to the entries of PSYMTABS. It would be more efficient to
321 have a map per the whole process but ADDRMAP cannot selectively remove
322 its items during FREE_OBJFILE. This mapping is already present even for
323 PARTIAL_SYMTABs which still have no corresponding full SYMTABs read. */
c906108c 324
9e86da07 325 struct addrmap *psymtabs_addrmap = nullptr;
ff013f42 326
95cf5869 327 /* List of freed partial symtabs, available for re-use. */
ff013f42 328
9e86da07 329 struct partial_symtab *free_psymtabs = nullptr;
c906108c 330
95cf5869
DE
331 /* The object file's BFD. Can be null if the objfile contains only
332 minimal symbols, e.g. the run time common symbols for SunOS4. */
c906108c 333
95cf5869 334 bfd *obfd;
c906108c 335
95cf5869
DE
336 /* The per-BFD data. Note that this is treated specially if OBFD
337 is NULL. */
c906108c 338
9e86da07 339 struct objfile_per_bfd_storage *per_bfd = nullptr;
706e3705 340
95cf5869
DE
341 /* The modification timestamp of the object file, as of the last time
342 we read its symbols. */
706e3705 343
9e86da07 344 long mtime = 0;
c906108c 345
95cf5869
DE
346 /* Obstack to hold objects that should be freed when we load a new symbol
347 table from this object file. */
c906108c 348
9e86da07 349 struct obstack objfile_obstack {};
b99607ea 350
95cf5869
DE
351 /* A byte cache where we can stash arbitrary "chunks" of bytes that
352 will not change. */
b99607ea 353
9e86da07 354 struct psymbol_bcache *psymbol_cache;
c906108c 355
95cf5869
DE
356 /* Vectors of all partial symbols read in from file. The actual data
357 is stored in the objfile_obstack. */
c906108c 358
9e86da07
TT
359 struct psymbol_allocation_list global_psymbols {};
360 struct psymbol_allocation_list static_psymbols {};
c906108c 361
95cf5869
DE
362 /* Structure which keeps track of functions that manipulate objfile's
363 of the same type as this objfile. I.e. the function to read partial
364 symbols for example. Note that this structure is in statically
365 allocated memory, and is shared by all objfiles that use the
366 object module reader of this type. */
c906108c 367
9e86da07 368 const struct sym_fns *sf = nullptr;
c906108c 369
95cf5869 370 /* Per objfile data-pointers required by other GDB modules. */
c906108c 371
9e86da07 372 REGISTRY_FIELDS {};
0d0e1a63 373
95cf5869
DE
374 /* Set of relocation offsets to apply to each section.
375 The table is indexed by the_bfd_section->index, thus it is generally
376 as large as the number of sections in the binary.
377 The table is stored on the objfile_obstack.
0d0e1a63 378
95cf5869
DE
379 These offsets indicate that all symbols (including partial and
380 minimal symbols) which have been read have been relocated by this
381 much. Symbols which are yet to be read need to be relocated by it. */
c906108c 382
9e86da07
TT
383 struct section_offsets *section_offsets = nullptr;
384 int num_sections = 0;
c906108c 385
95cf5869
DE
386 /* Indexes in the section_offsets array. These are initialized by the
387 *_symfile_offsets() family of functions (som_symfile_offsets,
388 xcoff_symfile_offsets, default_symfile_offsets). In theory they
389 should correspond to the section indexes used by bfd for the
390 current objfile. The exception to this for the time being is the
9e86da07
TT
391 SOM version.
392
393 These are initialized to -1 so that we can later detect if they
394 are used w/o being properly assigned to. */
c906108c 395
9e86da07
TT
396 int sect_index_text = -1;
397 int sect_index_data = -1;
398 int sect_index_bss = -1;
399 int sect_index_rodata = -1;
b8fbeb18 400
95cf5869
DE
401 /* These pointers are used to locate the section table, which
402 among other things, is used to map pc addresses into sections.
403 SECTIONS points to the first entry in the table, and
404 SECTIONS_END points to the first location past the last entry
405 in the table. The table is stored on the objfile_obstack. The
406 sections are indexed by the BFD section index; but the
407 structure data is only valid for certain sections
408 (e.g. non-empty, SEC_ALLOC). */
b8fbeb18 409
9e86da07
TT
410 struct obj_section *sections = nullptr;
411 struct obj_section *sections_end = nullptr;
c906108c 412
95cf5869
DE
413 /* GDB allows to have debug symbols in separate object files. This is
414 used by .gnu_debuglink, ELF build id note and Mach-O OSO.
415 Although this is a tree structure, GDB only support one level
416 (ie a separate debug for a separate debug is not supported). Note that
417 separate debug object are in the main chain and therefore will be
418 visited by ALL_OBJFILES & co iterators. Separate debug objfile always
419 has a non-nul separate_debug_objfile_backlink. */
c906108c 420
95cf5869 421 /* Link to the first separate debug object, if any. */
15d123c9 422
9e86da07 423 struct objfile *separate_debug_objfile = nullptr;
5b5d99cf 424
95cf5869
DE
425 /* If this is a separate debug object, this is used as a link to the
426 actual executable objfile. */
15d123c9 427
9e86da07 428 struct objfile *separate_debug_objfile_backlink = nullptr;
15d123c9 429
95cf5869
DE
430 /* If this is a separate debug object, this is a link to the next one
431 for the same executable objfile. */
5c4e30ca 432
9e86da07 433 struct objfile *separate_debug_objfile_link = nullptr;
95cf5869
DE
434
435 /* Place to stash various statistics about this objfile. */
436
437 OBJSTATS;
438
439 /* A linked list of symbols created when reading template types or
440 function templates. These symbols are not stored in any symbol
441 table, so we have to keep them here to relocate them
442 properly. */
443
9e86da07 444 struct symbol *template_symbols = nullptr;
63e43d3a
PMR
445
446 /* Associate a static link (struct dynamic_prop *) to all blocks (struct
447 block *) that have one.
448
449 In the context of nested functions (available in Pascal, Ada and GNU C,
450 for instance), a static link (as in DWARF's DW_AT_static_link attribute)
451 for a function is a way to get the frame corresponding to the enclosing
452 function.
453
454 Very few blocks have a static link, so it's more memory efficient to
455 store these here rather than in struct block. Static links must be
456 allocated on the objfile's obstack. */
9e86da07 457 htab_t static_links {};
95cf5869 458};
c906108c 459
c906108c
SS
460/* Declarations for functions defined in objfiles.c */
461
9c1877ea 462extern struct gdbarch *get_objfile_arch (const struct objfile *);
5e2b427d 463
abd0a5fa
JK
464extern int entry_point_address_query (CORE_ADDR *entry_p);
465
9ab9195f
EZ
466extern CORE_ADDR entry_point_address (void);
467
d82ea6a8 468extern void build_objfile_section_table (struct objfile *);
c906108c 469
15d123c9
TG
470extern struct objfile *objfile_separate_debug_iterate (const struct objfile *,
471 const struct objfile *);
472
5b5d99cf
JB
473extern void put_objfile_before (struct objfile *, struct objfile *);
474
15d123c9
TG
475extern void add_separate_debug_objfile (struct objfile *, struct objfile *);
476
a14ed312 477extern void unlink_objfile (struct objfile *);
c906108c 478
15d123c9
TG
479extern void free_objfile_separate_debug (struct objfile *);
480
74b7792f
AC
481extern struct cleanup *make_cleanup_free_objfile (struct objfile *);
482
a14ed312 483extern void free_all_objfiles (void);
c906108c 484
3189cb12 485extern void objfile_relocate (struct objfile *, const struct section_offsets *);
4141a416 486extern void objfile_rebase (struct objfile *, CORE_ADDR);
c906108c 487
55333a84
DE
488extern int objfile_has_partial_symbols (struct objfile *objfile);
489
490extern int objfile_has_full_symbols (struct objfile *objfile);
491
e361b228
TG
492extern int objfile_has_symbols (struct objfile *objfile);
493
a14ed312 494extern int have_partial_symbols (void);
c906108c 495
a14ed312 496extern int have_full_symbols (void);
c906108c 497
8fb8eb5c
DE
498extern void objfile_set_sym_fns (struct objfile *objfile,
499 const struct sym_fns *sf);
500
bb272892 501extern void objfiles_changed (void);
63644780
NB
502
503extern int is_addr_in_objfile (CORE_ADDR addr, const struct objfile *objfile);
bb272892 504
d03de421
PA
505/* Return true if ADDRESS maps into one of the sections of a
506 OBJF_SHARED objfile of PSPACE and false otherwise. */
08351840 507
d03de421
PA
508extern int shared_objfile_contains_address_p (struct program_space *pspace,
509 CORE_ADDR address);
08351840 510
c906108c
SS
511/* This operation deletes all objfile entries that represent solibs that
512 weren't explicitly loaded by the user, via e.g., the add-symbol-file
0df8b418
MS
513 command. */
514
a14ed312 515extern void objfile_purge_solibs (void);
c906108c
SS
516
517/* Functions for dealing with the minimal symbol table, really a misc
518 address<->symbol mapping for things we don't have debug symbols for. */
519
a14ed312 520extern int have_minimal_symbols (void);
c906108c 521
a14ed312 522extern struct obj_section *find_pc_section (CORE_ADDR pc);
c906108c 523
3e5d3a5a 524/* Return non-zero if PC is in a section called NAME. */
a121b7c1 525extern int pc_in_section (CORE_ADDR, const char *);
3e5d3a5a
MR
526
527/* Return non-zero if PC is in a SVR4-style procedure linkage table
528 section. */
529
530static inline int
531in_plt_section (CORE_ADDR pc)
532{
533 return pc_in_section (pc, ".plt");
534}
c906108c 535
0d0e1a63
MK
536/* Keep a registry of per-objfile data-pointers required by other GDB
537 modules. */
8e260fc0 538DECLARE_REGISTRY(objfile);
e3c69974 539
607ece04
GB
540/* In normal use, the section map will be rebuilt by find_pc_section
541 if objfiles have been added, removed or relocated since it was last
542 called. Calling inhibit_section_map_updates will inhibit this
543 behavior until resume_section_map_updates is called. If you call
544 inhibit_section_map_updates you must ensure that every call to
545 find_pc_section in the inhibited region relates to a section that
546 is already in the section map and has not since been removed or
547 relocated. */
548extern void inhibit_section_map_updates (struct program_space *pspace);
549
550/* Resume automatically rebuilding the section map as required. */
551extern void resume_section_map_updates (struct program_space *pspace);
552
553/* Version of the above suitable for use as a cleanup. */
554extern void resume_section_map_updates_cleanup (void *arg);
555
19630284
JB
556extern void default_iterate_over_objfiles_in_search_order
557 (struct gdbarch *gdbarch,
558 iterate_over_objfiles_in_search_order_cb_ftype *cb,
559 void *cb_data, struct objfile *current_objfile);
0d0e1a63
MK
560\f
561
6c95b8df
PA
562/* Traverse all object files in the current program space.
563 ALL_OBJFILES_SAFE works even if you delete the objfile during the
564 traversal. */
565
566/* Traverse all object files in program space SS. */
c906108c 567
6c95b8df 568#define ALL_PSPACE_OBJFILES(ss, obj) \
81b52a3a 569 for ((obj) = ss->objfiles; (obj) != NULL; (obj) = (obj)->next)
c906108c 570
6c95b8df
PA
571#define ALL_OBJFILES(obj) \
572 for ((obj) = current_program_space->objfiles; \
573 (obj) != NULL; \
574 (obj) = (obj)->next)
575
576#define ALL_OBJFILES_SAFE(obj,nxt) \
577 for ((obj) = current_program_space->objfiles; \
c906108c
SS
578 (obj) != NULL? ((nxt)=(obj)->next,1) :0; \
579 (obj) = (nxt))
580
581/* Traverse all symtabs in one objfile. */
582
43f3e411
DE
583#define ALL_OBJFILE_FILETABS(objfile, cu, s) \
584 ALL_OBJFILE_COMPUNITS (objfile, cu) \
585 ALL_COMPUNIT_FILETABS (cu, s)
c906108c 586
43f3e411 587/* Traverse all compunits in one objfile. */
d790cf0a 588
43f3e411
DE
589#define ALL_OBJFILE_COMPUNITS(objfile, cu) \
590 for ((cu) = (objfile) -> compunit_symtabs; (cu) != NULL; (cu) = (cu) -> next)
d790cf0a 591
c906108c
SS
592/* Traverse all minimal symbols in one objfile. */
593
34643a32
TT
594#define ALL_OBJFILE_MSYMBOLS(objfile, m) \
595 for ((m) = (objfile)->per_bfd->msymbols; \
596 MSYMBOL_LINKAGE_NAME (m) != NULL; \
597 (m)++)
c906108c 598
6c95b8df
PA
599/* Traverse all symtabs in all objfiles in the current symbol
600 space. */
c906108c 601
43f3e411
DE
602#define ALL_FILETABS(objfile, ps, s) \
603 ALL_OBJFILES (objfile) \
604 ALL_OBJFILE_FILETABS (objfile, ps, s)
c906108c 605
43f3e411 606/* Traverse all compunits in all objfiles in the current program space. */
11309657 607
43f3e411 608#define ALL_COMPUNITS(objfile, cu) \
11309657 609 ALL_OBJFILES (objfile) \
43f3e411 610 ALL_OBJFILE_COMPUNITS (objfile, cu)
11309657 611
6c95b8df
PA
612/* Traverse all minimal symbols in all objfiles in the current symbol
613 space. */
c906108c
SS
614
615#define ALL_MSYMBOLS(objfile, m) \
616 ALL_OBJFILES (objfile) \
15831452 617 ALL_OBJFILE_MSYMBOLS (objfile, m)
c906108c
SS
618
619#define ALL_OBJFILE_OSECTIONS(objfile, osect) \
65cf3563
TT
620 for (osect = objfile->sections; osect < objfile->sections_end; osect++) \
621 if (osect->the_bfd_section == NULL) \
622 { \
623 /* Nothing. */ \
624 } \
625 else
c906108c 626
96a8853a
PA
627/* Traverse all obj_sections in all objfiles in the current program
628 space.
629
630 Note that this detects a "break" in the inner loop, and exits
631 immediately from the outer loop as well, thus, client code doesn't
632 need to know that this is implemented with a double for. The extra
633 hair is to make sure that a "break;" stops the outer loop iterating
634 as well, and both OBJFILE and OSECT are left unmodified:
635
636 - The outer loop learns about the inner loop's end condition, and
637 stops iterating if it detects the inner loop didn't reach its
638 end. In other words, the outer loop keeps going only if the
639 inner loop reached its end cleanly [(osect) ==
640 (objfile)->sections_end].
641
642 - OSECT is initialized in the outer loop initialization
643 expressions, such as if the inner loop has reached its end, so
644 the check mentioned above succeeds the first time.
645
646 - The trick to not clearing OBJFILE on a "break;" is, in the outer
647 loop's loop expression, advance OBJFILE, but iff the inner loop
648 reached its end. If not, there was a "break;", so leave OBJFILE
649 as is; the outer loop's conditional will break immediately as
0df8b418 650 well (as OSECT will be different from OBJFILE->sections_end). */
96a8853a
PA
651
652#define ALL_OBJSECTIONS(objfile, osect) \
653 for ((objfile) = current_program_space->objfiles, \
654 (objfile) != NULL ? ((osect) = (objfile)->sections_end) : 0; \
655 (objfile) != NULL \
656 && (osect) == (objfile)->sections_end; \
657 ((osect) == (objfile)->sections_end \
658 ? ((objfile) = (objfile)->next, \
659 (objfile) != NULL ? (osect) = (objfile)->sections_end : 0) \
660 : 0)) \
65cf3563 661 ALL_OBJFILE_OSECTIONS (objfile, osect)
c906108c 662
b8fbeb18 663#define SECT_OFF_DATA(objfile) \
8e65ff28 664 ((objfile->sect_index_data == -1) \
3e43a32a
MS
665 ? (internal_error (__FILE__, __LINE__, \
666 _("sect_index_data not initialized")), -1) \
8e65ff28 667 : objfile->sect_index_data)
b8fbeb18
EZ
668
669#define SECT_OFF_RODATA(objfile) \
8e65ff28 670 ((objfile->sect_index_rodata == -1) \
3e43a32a
MS
671 ? (internal_error (__FILE__, __LINE__, \
672 _("sect_index_rodata not initialized")), -1) \
8e65ff28 673 : objfile->sect_index_rodata)
b8fbeb18
EZ
674
675#define SECT_OFF_TEXT(objfile) \
8e65ff28 676 ((objfile->sect_index_text == -1) \
3e43a32a
MS
677 ? (internal_error (__FILE__, __LINE__, \
678 _("sect_index_text not initialized")), -1) \
8e65ff28 679 : objfile->sect_index_text)
b8fbeb18 680
a4c8257b 681/* Sometimes the .bss section is missing from the objfile, so we don't
0df8b418
MS
682 want to die here. Let the users of SECT_OFF_BSS deal with an
683 uninitialized section index. */
a4c8257b 684#define SECT_OFF_BSS(objfile) (objfile)->sect_index_bss
b8fbeb18 685
c14c28ba
PP
686/* Answer whether there is more than one object file loaded. */
687
688#define MULTI_OBJFILE_P() (object_files && object_files->next)
689
706e3705
TT
690/* Reset the per-BFD storage area on OBJ. */
691
692void set_objfile_per_bfd (struct objfile *obj);
693
e02c96a7
DE
694/* Return canonical name for OBJFILE.
695 This is the real file name if the file has been opened.
696 Otherwise it is the original name supplied by the user. */
697
4262abfb
JK
698const char *objfile_name (const struct objfile *objfile);
699
e02c96a7
DE
700/* Return the (real) file name of OBJFILE if the file has been opened,
701 otherwise return NULL. */
702
703const char *objfile_filename (const struct objfile *objfile);
704
cc485e62
DE
705/* Return the name to print for OBJFILE in debugging messages. */
706
707extern const char *objfile_debug_name (const struct objfile *objfile);
708
015d2e7e
DE
709/* Return the name of the file format of OBJFILE if the file has been opened,
710 otherwise return NULL. */
711
712const char *objfile_flavour_name (struct objfile *objfile);
713
3d548a53
TT
714/* Set the objfile's notion of the "main" name and language. */
715
716extern void set_objfile_main_name (struct objfile *objfile,
717 const char *name, enum language lang);
718
63e43d3a
PMR
719extern void objfile_register_static_link
720 (struct objfile *objfile,
721 const struct block *block,
722 const struct dynamic_prop *static_link);
723
724extern const struct dynamic_prop *objfile_lookup_static_link
725 (struct objfile *objfile, const struct block *block);
726
c5aa993b 727#endif /* !defined (OBJFILES_H) */
This page took 1.644911 seconds and 4 git commands to generate.