]> git.ipfire.org Git - thirdparty/binutils-gdb.git/blame - gdb/objfiles.h
"$ gdb PROGRAM" vs "(gdb) file PROGRAM" difference; warn on failure to remove breakpoint.
[thirdparty/binutils-gdb.git] / gdb / objfiles.h
CommitLineData
c906108c 1/* Definitions for symbol file management in GDB.
af5f3db6 2
ecd75fc8 3 Copyright (C) 1992-2014 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
3956d554 23#include "gdb_obstack.h" /* For obstack internals. */
0df8b418 24#include "symfile.h" /* For struct psymbol_allocation_list. */
6c95b8df 25#include "progspace.h"
8e260fc0 26#include "registry.h"
65cf3563 27#include "gdb_bfd.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 {
53eddfa6 104 /* The unrelocated value we should use for this objfile entry point. */
c5aa993b 105 CORE_ADDR entry_point;
c906108c 106
53eddfa6
TT
107 /* The index of the section in which the entry point appears. */
108 int the_bfd_section_index;
109
abd0a5fa
JK
110 /* Set to 1 iff ENTRY_POINT contains a valid value. */
111 unsigned entry_point_p : 1;
6ef55de7
TT
112
113 /* Set to 1 iff this object was initialized. */
114 unsigned initialized : 1;
c5aa993b 115 };
c906108c 116
f1f6aadf
PA
117/* Sections in an objfile. The section offsets are stored in the
118 OBJFILE. */
c906108c 119
c5aa993b
JM
120struct obj_section
121 {
7be0c536 122 struct bfd_section *the_bfd_section; /* BFD section pointer */
c906108c 123
c5aa993b
JM
124 /* Objfile this section is part of. */
125 struct objfile *objfile;
c906108c 126
0df8b418 127 /* True if this "overlay section" is mapped into an "overlay region". */
c5aa993b
JM
128 int ovly_mapped;
129 };
c906108c 130
f1f6aadf
PA
131/* Relocation offset applied to S. */
132#define obj_section_offset(s) \
65cf3563 133 (((s)->objfile->section_offsets)->offsets[gdb_bfd_section_index ((s)->objfile->obfd, (s)->the_bfd_section)])
f1f6aadf
PA
134
135/* The memory address of section S (vma + offset). */
136#define obj_section_addr(s) \
1706c199 137 (bfd_get_section_vma ((s)->objfile->obfd, s->the_bfd_section) \
f1f6aadf
PA
138 + obj_section_offset (s))
139
140/* The one-passed-the-end memory address of section S
141 (vma + size + offset). */
142#define obj_section_endaddr(s) \
1706c199 143 (bfd_get_section_vma ((s)->objfile->obfd, s->the_bfd_section) \
f1f6aadf
PA
144 + bfd_get_section_size ((s)->the_bfd_section) \
145 + obj_section_offset (s))
c906108c 146
c906108c
SS
147/* The "objstats" structure provides a place for gdb to record some
148 interesting information about its internal state at runtime, on a
149 per objfile basis, such as information about the number of symbols
0df8b418 150 read, size of string table (if any), etc. */
c906108c 151
c5aa993b
JM
152struct objstats
153 {
c5aa993b
JM
154 int n_psyms; /* Number of partial symbols read */
155 int n_syms; /* Number of full symbols read */
156 int n_stabs; /* Number of ".stabs" read (if applicable) */
157 int n_types; /* Number of types */
158 int sz_strtab; /* Size of stringtable, (if applicable) */
159 };
c906108c
SS
160
161#define OBJSTAT(objfile, expr) (objfile -> stats.expr)
162#define OBJSTATS struct objstats stats
a14ed312
KB
163extern void print_objfile_statistics (void);
164extern void print_symbol_bcache_statistics (void);
c906108c 165
9227b5eb 166/* Number of entries in the minimal symbol hash table. */
375f3d86 167#define MINIMAL_SYMBOL_HASH_SIZE 2039
9227b5eb 168
706e3705
TT
169/* Some objfile data is hung off the BFD. This enables sharing of the
170 data across all objfiles using the BFD. The data is stored in an
171 instance of this structure, and associated with the BFD using the
172 registry system. */
173
174struct objfile_per_bfd_storage
175{
176 /* The storage has an obstack of its own. */
177
178 struct obstack storage_obstack;
179
180 /* Byte cache for file names. */
181
182 struct bcache *filename_cache;
6532ff36
TT
183
184 /* Byte cache for macros. */
185 struct bcache *macro_cache;
df6d5441
TT
186
187 /* The gdbarch associated with the BFD. Note that this gdbarch is
188 determined solely from BFD information, without looking at target
189 information. The gdbarch determined from a running target may
190 differ from this e.g. with respect to register types and names. */
191
192 struct gdbarch *gdbarch;
84a1243b
TT
193
194 /* Hash table for mapping symbol names to demangled names. Each
195 entry in the hash table is actually two consecutive strings,
196 both null-terminated; the first one is a mangled or linkage
197 name, and the second is the demangled name or just a zero byte
198 if the name doesn't demangle. */
199 struct htab *demangled_names_hash;
6ef55de7
TT
200
201 /* The per-objfile information about the entry point, the scope (file/func)
202 containing the entry point, and the scope of the user's main() func. */
203
204 struct entry_info ei;
3d548a53
TT
205
206 /* The name and language of any "main" found in this objfile. The
207 name can be NULL, which means that the information was not
208 recorded. */
209
210 const char *name_of_main;
211 enum language language_of_main;
34643a32
TT
212
213 /* Each file contains a pointer to an array of minimal symbols for all
214 global symbols that are defined within the file. The array is
215 terminated by a "null symbol", one that has a NULL pointer for the
216 name and a zero value for the address. This makes it easy to walk
217 through the array when passed a pointer to somewhere in the middle
218 of it. There is also a count of the number of symbols, which does
219 not include the terminating null symbol. The array itself, as well
220 as all the data that it points to, should be allocated on the
221 objfile_obstack for this file. */
222
223 struct minimal_symbol *msymbols;
224 int minimal_symbol_count;
225
5f6cac40
TT
226 /* The number of minimal symbols read, before any minimal symbol
227 de-duplication is applied. Note in particular that this has only
228 a passing relationship with the actual size of the table above;
229 use minimal_symbol_count if you need the true size. */
230 int n_minsyms;
231
34643a32
TT
232 /* This is true if minimal symbols have already been read. Symbol
233 readers can use this to bypass minimal symbol reading. Also, the
234 minimal symbol table management code in minsyms.c uses this to
235 suppress new minimal symbols. You might think that MSYMBOLS or
236 MINIMAL_SYMBOL_COUNT could be used for this, but it is possible
237 for multiple readers to install minimal symbols into a given
238 per-BFD. */
239
240 unsigned int minsyms_read : 1;
241
242 /* This is a hash table used to index the minimal symbols by name. */
243
244 struct minimal_symbol *msymbol_hash[MINIMAL_SYMBOL_HASH_SIZE];
245
246 /* This hash table is used to index the minimal symbols by their
247 demangled names. */
248
249 struct minimal_symbol *msymbol_demangled_hash[MINIMAL_SYMBOL_HASH_SIZE];
706e3705
TT
250};
251
c906108c
SS
252/* Master structure for keeping track of each file from which
253 gdb reads symbols. There are several ways these get allocated: 1.
254 The main symbol file, symfile_objfile, set by the symbol-file command,
255 2. Additional symbol files added by the add-symbol-file command,
256 3. Shared library objfiles, added by ADD_SOLIB, 4. symbol files
257 for modules that were loaded when GDB attached to a remote system
258 (see remote-vx.c). */
259
260struct objfile
c5aa993b 261 {
c906108c 262
c5aa993b 263 /* All struct objfile's are chained together by their next pointers.
ff011ed7
TT
264 The program space field "objfiles" (frequently referenced via
265 the macro "object_files") points to the first link in this
266 chain. */
c906108c 267
c5aa993b 268 struct objfile *next;
c906108c 269
04affae3
JK
270 /* The object file's original name as specified by the user,
271 made absolute, and tilde-expanded. However, it is not canonicalized
272 (i.e., it has not been passed through gdb_realpath).
273 This pointer is never NULL. This does not have to be freed; it is
e1507e95 274 guaranteed to have a lifetime at least as long as the objfile. */
c906108c 275
4262abfb 276 char *original_name;
c906108c 277
e4f6d2ec
TJB
278 CORE_ADDR addr_low;
279
0838fb57
DE
280 /* Some flag bits for this objfile.
281 The values are defined by OBJF_*. */
c906108c 282
c5aa993b 283 unsigned short flags;
c906108c 284
6c95b8df
PA
285 /* The program space associated with this objfile. */
286
287 struct program_space *pspace;
288
c5aa993b
JM
289 /* Each objfile points to a linked list of symtabs derived from this file,
290 one symtab structure for each compilation unit (source file). Each link
0df8b418 291 in the symtab list contains a backpointer to this objfile. */
c906108c 292
c5aa993b 293 struct symtab *symtabs;
c906108c 294
c5aa993b
JM
295 /* Each objfile points to a linked list of partial symtabs derived from
296 this file, one partial symtab structure for each compilation unit
0df8b418 297 (source file). */
c906108c 298
c5aa993b 299 struct partial_symtab *psymtabs;
c906108c 300
ff013f42
JK
301 /* Map addresses to the entries of PSYMTABS. It would be more efficient to
302 have a map per the whole process but ADDRMAP cannot selectively remove
303 its items during FREE_OBJFILE. This mapping is already present even for
304 PARTIAL_SYMTABs which still have no corresponding full SYMTABs read. */
305
306 struct addrmap *psymtabs_addrmap;
307
0df8b418 308 /* List of freed partial symtabs, available for re-use. */
c906108c 309
c5aa993b 310 struct partial_symtab *free_psymtabs;
c906108c 311
c5aa993b
JM
312 /* The object file's BFD. Can be null if the objfile contains only
313 minimal symbols, e.g. the run time common symbols for SunOS4. */
c906108c 314
c5aa993b 315 bfd *obfd;
c906108c 316
706e3705
TT
317 /* The per-BFD data. Note that this is treated specially if OBFD
318 is NULL. */
319
320 struct objfile_per_bfd_storage *per_bfd;
321
c5aa993b
JM
322 /* The modification timestamp of the object file, as of the last time
323 we read its symbols. */
c906108c 324
c5aa993b 325 long mtime;
c906108c 326
b99607ea 327 /* Obstack to hold objects that should be freed when we load a new symbol
0df8b418 328 table from this object file. */
b99607ea 329
b99607ea
EZ
330 struct obstack objfile_obstack;
331
c5aa993b 332 /* A byte cache where we can stash arbitrary "chunks" of bytes that
0df8b418 333 will not change. */
c906108c 334
0df8b418 335 struct psymbol_bcache *psymbol_cache; /* Byte cache for partial syms. */
c906108c 336
c5aa993b 337 /* Vectors of all partial symbols read in from file. The actual data
0df8b418 338 is stored in the objfile_obstack. */
c906108c 339
c5aa993b
JM
340 struct psymbol_allocation_list global_psymbols;
341 struct psymbol_allocation_list static_psymbols;
c906108c 342
c5aa993b 343 /* Structure which keeps track of functions that manipulate objfile's
0df8b418 344 of the same type as this objfile. I.e. the function to read partial
c5aa993b
JM
345 symbols for example. Note that this structure is in statically
346 allocated memory, and is shared by all objfiles that use the
0df8b418 347 object module reader of this type. */
c906108c 348
00b5771c 349 const struct sym_fns *sf;
c906108c 350
0d0e1a63 351 /* Per objfile data-pointers required by other GDB modules. */
0d0e1a63 352
8e260fc0 353 REGISTRY_FIELDS;
0d0e1a63 354
c5aa993b 355 /* Set of relocation offsets to apply to each section.
d82ea6a8
DE
356 The table is indexed by the_bfd_section->index, thus it is generally
357 as large as the number of sections in the binary.
358 The table is stored on the objfile_obstack.
c906108c 359
c5aa993b
JM
360 These offsets indicate that all symbols (including partial and
361 minimal symbols) which have been read have been relocated by this
d82ea6a8 362 much. Symbols which are yet to be read need to be relocated by it. */
c906108c 363
c5aa993b
JM
364 struct section_offsets *section_offsets;
365 int num_sections;
c906108c 366
0df8b418 367 /* Indexes in the section_offsets array. These are initialized by the
b8fbeb18 368 *_symfile_offsets() family of functions (som_symfile_offsets,
0df8b418 369 xcoff_symfile_offsets, default_symfile_offsets). In theory they
b8fbeb18 370 should correspond to the section indexes used by bfd for the
0df8b418
MS
371 current objfile. The exception to this for the time being is the
372 SOM version. */
b8fbeb18
EZ
373
374 int sect_index_text;
375 int sect_index_data;
376 int sect_index_bss;
377 int sect_index_rodata;
378
96baa820 379 /* These pointers are used to locate the section table, which
5c44784c 380 among other things, is used to map pc addresses into sections.
96baa820
JM
381 SECTIONS points to the first entry in the table, and
382 SECTIONS_END points to the first location past the last entry
65cf3563
TT
383 in the table. The table is stored on the objfile_obstack. The
384 sections are indexed by the BFD section index; but the
385 structure data is only valid for certain sections
386 (e.g. non-empty, SEC_ALLOC). */
c906108c 387
d82ea6a8 388 struct obj_section *sections, *sections_end;
c906108c 389
15d123c9
TG
390 /* GDB allows to have debug symbols in separate object files. This is
391 used by .gnu_debuglink, ELF build id note and Mach-O OSO.
392 Although this is a tree structure, GDB only support one level
393 (ie a separate debug for a separate debug is not supported). Note that
394 separate debug object are in the main chain and therefore will be
395 visited by ALL_OBJFILES & co iterators. Separate debug objfile always
396 has a non-nul separate_debug_objfile_backlink. */
397
398 /* Link to the first separate debug object, if any. */
5b5d99cf
JB
399 struct objfile *separate_debug_objfile;
400
401 /* If this is a separate debug object, this is used as a link to the
0df8b418 402 actual executable objfile. */
5b5d99cf 403 struct objfile *separate_debug_objfile_backlink;
15d123c9
TG
404
405 /* If this is a separate debug object, this is a link to the next one
406 for the same executable objfile. */
407 struct objfile *separate_debug_objfile_link;
408
0df8b418 409 /* Place to stash various statistics about this objfile. */
d82ea6a8 410 OBJSTATS;
5c4e30ca 411
34eaf542
TT
412 /* A linked list of symbols created when reading template types or
413 function templates. These symbols are not stored in any symbol
414 table, so we have to keep them here to relocate them
415 properly. */
416 struct symbol *template_symbols;
c5aa993b 417 };
c906108c 418
0df8b418 419/* Defines for the objfile flag word. */
c906108c 420
c906108c
SS
421/* When an object file has its functions reordered (currently Irix-5.2
422 shared libraries exhibit this behaviour), we will need an expensive
423 algorithm to locate a partial symtab or symtab via an address.
424 To avoid this penalty for normal object files, we use this flag,
425 whose setting is determined upon symbol table read in. */
426
8b41ec65 427#define OBJF_REORDERED (1 << 0) /* Functions are reordered */
c5aa993b 428
2df3850c 429/* Distinguish between an objfile for a shared library and a "vanilla"
d03de421
PA
430 objfile. This may come from a target's implementation of the solib
431 interface, from add-symbol-file, or any other mechanism that loads
432 dynamic objects. */
c906108c 433
8b41ec65 434#define OBJF_SHARED (1 << 1) /* From a shared library */
c906108c 435
0df8b418 436/* User requested that this objfile be read in it's entirety. */
2acceee2 437
8b41ec65 438#define OBJF_READNOW (1 << 2) /* Immediate full read */
2acceee2 439
2df3850c
JM
440/* This objfile was created because the user explicitly caused it
441 (e.g., used the add-symbol-file command). This bit offers a way
442 for run_command to remove old objfile entries which are no longer
443 valid (i.e., are associated with an old inferior), but to preserve
444 ones that the user explicitly loaded via the add-symbol-file
0df8b418 445 command. */
2df3850c 446
8b41ec65 447#define OBJF_USERLOADED (1 << 3) /* User loaded */
2df3850c 448
b11896a5
TT
449/* Set if we have tried to read partial symtabs for this objfile.
450 This is used to allow lazy reading of partial symtabs. */
451
452#define OBJF_PSYMTABS_READ (1 << 4)
453
0838fb57
DE
454/* Set if this is the main symbol file
455 (as opposed to symbol file for dynamically loaded code). */
456
457#define OBJF_MAINLINE (1 << 5)
458
40135bb1
JK
459/* ORIGINAL_NAME and OBFD->FILENAME correspond to text description unrelated to
460 filesystem names. It can be for example "<image in memory>". */
461
462#define OBJF_NOT_FILENAME (1 << 6)
463
c906108c
SS
464/* Declarations for functions defined in objfiles.c */
465
24ba069a 466extern struct objfile *allocate_objfile (bfd *, const char *name, int);
c906108c 467
5e2b427d
UW
468extern struct gdbarch *get_objfile_arch (struct objfile *);
469
abd0a5fa
JK
470extern int entry_point_address_query (CORE_ADDR *entry_p);
471
9ab9195f
EZ
472extern CORE_ADDR entry_point_address (void);
473
d82ea6a8 474extern void build_objfile_section_table (struct objfile *);
c906108c 475
15831452
JB
476extern void terminate_minimal_symbol_table (struct objfile *objfile);
477
15d123c9
TG
478extern struct objfile *objfile_separate_debug_iterate (const struct objfile *,
479 const struct objfile *);
480
5b5d99cf
JB
481extern void put_objfile_before (struct objfile *, struct objfile *);
482
15d123c9
TG
483extern void add_separate_debug_objfile (struct objfile *, struct objfile *);
484
a14ed312 485extern void unlink_objfile (struct objfile *);
c906108c 486
a14ed312 487extern void free_objfile (struct objfile *);
c906108c 488
15d123c9
TG
489extern void free_objfile_separate_debug (struct objfile *);
490
74b7792f
AC
491extern struct cleanup *make_cleanup_free_objfile (struct objfile *);
492
a14ed312 493extern void free_all_objfiles (void);
c906108c 494
3189cb12 495extern void objfile_relocate (struct objfile *, const struct section_offsets *);
4141a416 496extern void objfile_rebase (struct objfile *, CORE_ADDR);
c906108c 497
55333a84
DE
498extern int objfile_has_partial_symbols (struct objfile *objfile);
499
500extern int objfile_has_full_symbols (struct objfile *objfile);
501
e361b228
TG
502extern int objfile_has_symbols (struct objfile *objfile);
503
a14ed312 504extern int have_partial_symbols (void);
c906108c 505
a14ed312 506extern int have_full_symbols (void);
c906108c 507
8fb8eb5c
DE
508extern void objfile_set_sym_fns (struct objfile *objfile,
509 const struct sym_fns *sf);
510
bb272892 511extern void objfiles_changed (void);
63644780
NB
512
513extern int is_addr_in_objfile (CORE_ADDR addr, const struct objfile *objfile);
bb272892 514
d03de421
PA
515/* Return true if ADDRESS maps into one of the sections of a
516 OBJF_SHARED objfile of PSPACE and false otherwise. */
08351840 517
d03de421
PA
518extern int shared_objfile_contains_address_p (struct program_space *pspace,
519 CORE_ADDR address);
08351840 520
c906108c
SS
521/* This operation deletes all objfile entries that represent solibs that
522 weren't explicitly loaded by the user, via e.g., the add-symbol-file
0df8b418
MS
523 command. */
524
a14ed312 525extern void objfile_purge_solibs (void);
c906108c
SS
526
527/* Functions for dealing with the minimal symbol table, really a misc
528 address<->symbol mapping for things we don't have debug symbols for. */
529
a14ed312 530extern int have_minimal_symbols (void);
c906108c 531
a14ed312 532extern struct obj_section *find_pc_section (CORE_ADDR pc);
c906108c 533
3e5d3a5a
MR
534/* Return non-zero if PC is in a section called NAME. */
535extern int pc_in_section (CORE_ADDR, char *);
536
537/* Return non-zero if PC is in a SVR4-style procedure linkage table
538 section. */
539
540static inline int
541in_plt_section (CORE_ADDR pc)
542{
543 return pc_in_section (pc, ".plt");
544}
c906108c 545
0d0e1a63
MK
546/* Keep a registry of per-objfile data-pointers required by other GDB
547 modules. */
8e260fc0 548DECLARE_REGISTRY(objfile);
e3c69974 549
607ece04
GB
550/* In normal use, the section map will be rebuilt by find_pc_section
551 if objfiles have been added, removed or relocated since it was last
552 called. Calling inhibit_section_map_updates will inhibit this
553 behavior until resume_section_map_updates is called. If you call
554 inhibit_section_map_updates you must ensure that every call to
555 find_pc_section in the inhibited region relates to a section that
556 is already in the section map and has not since been removed or
557 relocated. */
558extern void inhibit_section_map_updates (struct program_space *pspace);
559
560/* Resume automatically rebuilding the section map as required. */
561extern void resume_section_map_updates (struct program_space *pspace);
562
563/* Version of the above suitable for use as a cleanup. */
564extern void resume_section_map_updates_cleanup (void *arg);
565
19630284
JB
566extern void default_iterate_over_objfiles_in_search_order
567 (struct gdbarch *gdbarch,
568 iterate_over_objfiles_in_search_order_cb_ftype *cb,
569 void *cb_data, struct objfile *current_objfile);
0d0e1a63
MK
570\f
571
6c95b8df
PA
572/* Traverse all object files in the current program space.
573 ALL_OBJFILES_SAFE works even if you delete the objfile during the
574 traversal. */
575
576/* Traverse all object files in program space SS. */
c906108c 577
6c95b8df 578#define ALL_PSPACE_OBJFILES(ss, obj) \
81b52a3a 579 for ((obj) = ss->objfiles; (obj) != NULL; (obj) = (obj)->next)
c906108c 580
6c95b8df
PA
581#define ALL_PSPACE_OBJFILES_SAFE(ss, obj, nxt) \
582 for ((obj) = ss->objfiles; \
583 (obj) != NULL? ((nxt)=(obj)->next,1) :0; \
584 (obj) = (nxt))
585
586#define ALL_OBJFILES(obj) \
587 for ((obj) = current_program_space->objfiles; \
588 (obj) != NULL; \
589 (obj) = (obj)->next)
590
591#define ALL_OBJFILES_SAFE(obj,nxt) \
592 for ((obj) = current_program_space->objfiles; \
c906108c
SS
593 (obj) != NULL? ((nxt)=(obj)->next,1) :0; \
594 (obj) = (nxt))
595
596/* Traverse all symtabs in one objfile. */
597
598#define ALL_OBJFILE_SYMTABS(objfile, s) \
599 for ((s) = (objfile) -> symtabs; (s) != NULL; (s) = (s) -> next)
600
d790cf0a
DE
601/* Traverse all primary symtabs in one objfile. */
602
603#define ALL_OBJFILE_PRIMARY_SYMTABS(objfile, s) \
604 ALL_OBJFILE_SYMTABS ((objfile), (s)) \
605 if ((s)->primary)
606
c906108c
SS
607/* Traverse all minimal symbols in one objfile. */
608
34643a32
TT
609#define ALL_OBJFILE_MSYMBOLS(objfile, m) \
610 for ((m) = (objfile)->per_bfd->msymbols; \
611 MSYMBOL_LINKAGE_NAME (m) != NULL; \
612 (m)++)
c906108c 613
6c95b8df
PA
614/* Traverse all symtabs in all objfiles in the current symbol
615 space. */
c906108c
SS
616
617#define ALL_SYMTABS(objfile, s) \
618 ALL_OBJFILES (objfile) \
619 ALL_OBJFILE_SYMTABS (objfile, s)
620
6c95b8df
PA
621#define ALL_PSPACE_SYMTABS(ss, objfile, s) \
622 ALL_PSPACE_OBJFILES (ss, objfile) \
623 ALL_OBJFILE_SYMTABS (objfile, s)
624
625/* Traverse all symtabs in all objfiles in the current program space,
626 skipping included files (which share a blockvector with their
627 primary symtab). */
11309657
DJ
628
629#define ALL_PRIMARY_SYMTABS(objfile, s) \
630 ALL_OBJFILES (objfile) \
d790cf0a 631 ALL_OBJFILE_PRIMARY_SYMTABS (objfile, s)
11309657 632
6c95b8df
PA
633#define ALL_PSPACE_PRIMARY_SYMTABS(pspace, objfile, s) \
634 ALL_PSPACE_OBJFILES (ss, objfile) \
d790cf0a 635 ALL_OBJFILE_PRIMARY_SYMTABS (objfile, s)
6c95b8df 636
6c95b8df
PA
637/* Traverse all minimal symbols in all objfiles in the current symbol
638 space. */
c906108c
SS
639
640#define ALL_MSYMBOLS(objfile, m) \
641 ALL_OBJFILES (objfile) \
15831452 642 ALL_OBJFILE_MSYMBOLS (objfile, m)
c906108c
SS
643
644#define ALL_OBJFILE_OSECTIONS(objfile, osect) \
65cf3563
TT
645 for (osect = objfile->sections; osect < objfile->sections_end; osect++) \
646 if (osect->the_bfd_section == NULL) \
647 { \
648 /* Nothing. */ \
649 } \
650 else
c906108c 651
96a8853a
PA
652/* Traverse all obj_sections in all objfiles in the current program
653 space.
654
655 Note that this detects a "break" in the inner loop, and exits
656 immediately from the outer loop as well, thus, client code doesn't
657 need to know that this is implemented with a double for. The extra
658 hair is to make sure that a "break;" stops the outer loop iterating
659 as well, and both OBJFILE and OSECT are left unmodified:
660
661 - The outer loop learns about the inner loop's end condition, and
662 stops iterating if it detects the inner loop didn't reach its
663 end. In other words, the outer loop keeps going only if the
664 inner loop reached its end cleanly [(osect) ==
665 (objfile)->sections_end].
666
667 - OSECT is initialized in the outer loop initialization
668 expressions, such as if the inner loop has reached its end, so
669 the check mentioned above succeeds the first time.
670
671 - The trick to not clearing OBJFILE on a "break;" is, in the outer
672 loop's loop expression, advance OBJFILE, but iff the inner loop
673 reached its end. If not, there was a "break;", so leave OBJFILE
674 as is; the outer loop's conditional will break immediately as
0df8b418 675 well (as OSECT will be different from OBJFILE->sections_end). */
96a8853a
PA
676
677#define ALL_OBJSECTIONS(objfile, osect) \
678 for ((objfile) = current_program_space->objfiles, \
679 (objfile) != NULL ? ((osect) = (objfile)->sections_end) : 0; \
680 (objfile) != NULL \
681 && (osect) == (objfile)->sections_end; \
682 ((osect) == (objfile)->sections_end \
683 ? ((objfile) = (objfile)->next, \
684 (objfile) != NULL ? (osect) = (objfile)->sections_end : 0) \
685 : 0)) \
65cf3563 686 ALL_OBJFILE_OSECTIONS (objfile, osect)
c906108c 687
b8fbeb18 688#define SECT_OFF_DATA(objfile) \
8e65ff28 689 ((objfile->sect_index_data == -1) \
3e43a32a
MS
690 ? (internal_error (__FILE__, __LINE__, \
691 _("sect_index_data not initialized")), -1) \
8e65ff28 692 : objfile->sect_index_data)
b8fbeb18
EZ
693
694#define SECT_OFF_RODATA(objfile) \
8e65ff28 695 ((objfile->sect_index_rodata == -1) \
3e43a32a
MS
696 ? (internal_error (__FILE__, __LINE__, \
697 _("sect_index_rodata not initialized")), -1) \
8e65ff28 698 : objfile->sect_index_rodata)
b8fbeb18
EZ
699
700#define SECT_OFF_TEXT(objfile) \
8e65ff28 701 ((objfile->sect_index_text == -1) \
3e43a32a
MS
702 ? (internal_error (__FILE__, __LINE__, \
703 _("sect_index_text not initialized")), -1) \
8e65ff28 704 : objfile->sect_index_text)
b8fbeb18 705
a4c8257b 706/* Sometimes the .bss section is missing from the objfile, so we don't
0df8b418
MS
707 want to die here. Let the users of SECT_OFF_BSS deal with an
708 uninitialized section index. */
a4c8257b 709#define SECT_OFF_BSS(objfile) (objfile)->sect_index_bss
b8fbeb18 710
c14c28ba
PP
711/* Answer whether there is more than one object file loaded. */
712
713#define MULTI_OBJFILE_P() (object_files && object_files->next)
714
706e3705
TT
715/* Reset the per-BFD storage area on OBJ. */
716
717void set_objfile_per_bfd (struct objfile *obj);
718
4262abfb
JK
719const char *objfile_name (const struct objfile *objfile);
720
3d548a53
TT
721/* Set the objfile's notion of the "main" name and language. */
722
723extern void set_objfile_main_name (struct objfile *objfile,
724 const char *name, enum language lang);
725
c5aa993b 726#endif /* !defined (OBJFILES_H) */