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