Commit | Line | Data |
---|---|---|
c906108c | 1 | /* Definitions for symbol file management in GDB. |
af5f3db6 | 2 | |
3666a048 | 3 | Copyright (C) 1992-2021 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" |
af5bf4ad | 26 | #include "symfile.h" |
6c95b8df | 27 | #include "progspace.h" |
8e260fc0 | 28 | #include "registry.h" |
65cf3563 | 29 | #include "gdb_bfd.h" |
d320c2b5 | 30 | #include "psymtab.h" |
7d7167ce | 31 | #include <atomic> |
1b7a07cb | 32 | #include <bitset> |
b5ec771e | 33 | #include <vector> |
268a13a5 TT |
34 | #include "gdbsupport/next-iterator.h" |
35 | #include "gdbsupport/safe-iterator.h" | |
b366c208 | 36 | #include "bcache.h" |
0d12e84c | 37 | #include "gdbarch.h" |
7d7167ce | 38 | #include "gdbsupport/refcounted-object.h" |
238b5c9f | 39 | #include "jit.h" |
39298a5d | 40 | #include "quick-symbol.h" |
e1114590 | 41 | #include <forward_list> |
3956d554 | 42 | |
2de7ced7 | 43 | struct htab; |
4a4b3fed | 44 | struct objfile_data; |
af5bf4ad | 45 | struct partial_symbol; |
08c0b5bc | 46 | |
c906108c SS |
47 | /* This structure maintains information on a per-objfile basis about the |
48 | "entry point" of the objfile, and the scope within which the entry point | |
49 | exists. It is possible that gdb will see more than one objfile that is | |
50 | executable, each with its own entry point. | |
51 | ||
52 | For example, for dynamically linked executables in SVR4, the dynamic linker | |
53 | code is contained within the shared C library, which is actually executable | |
54 | and is run by the kernel first when an exec is done of a user executable | |
55 | that is dynamically linked. The dynamic linker within the shared C library | |
56 | then maps in the various program segments in the user executable and jumps | |
57 | to the user executable's recorded entry point, as if the call had been made | |
58 | directly by the kernel. | |
59 | ||
73c1e0a1 AC |
60 | The traditional gdb method of using this info was to use the |
61 | recorded entry point to set the entry-file's lowpc and highpc from | |
627b3ba2 AC |
62 | the debugging information, where these values are the starting |
63 | address (inclusive) and ending address (exclusive) of the | |
64 | instruction space in the executable which correspond to the | |
0df8b418 | 65 | "startup file", i.e. crt0.o in most cases. This file is assumed to |
627b3ba2 AC |
66 | be a startup file and frames with pc's inside it are treated as |
67 | nonexistent. Setting these variables is necessary so that | |
68 | backtraces do not fly off the bottom of the stack. | |
69 | ||
70 | NOTE: cagney/2003-09-09: It turns out that this "traditional" | |
71 | method doesn't work. Corinna writes: ``It turns out that the call | |
2f72f850 | 72 | to test for "inside entry file" destroys a meaningful backtrace |
0df8b418 | 73 | under some conditions. E.g. the backtrace tests in the asm-source |
627b3ba2 AC |
74 | testcase are broken for some targets. In this test the functions |
75 | are all implemented as part of one file and the testcase is not | |
76 | necessarily linked with a start file (depending on the target). | |
30baf67b TV |
77 | What happens is, that the first frame is printed normally and |
78 | following frames are treated as being inside the entry file then. | |
627b3ba2 AC |
79 | This way, only the #0 frame is printed in the backtrace output.'' |
80 | Ref "frame.c" "NOTE: vinschen/2003-04-01". | |
c906108c SS |
81 | |
82 | Gdb also supports an alternate method to avoid running off the bottom | |
83 | of the stack. | |
84 | ||
85 | There are two frames that are "special", the frame for the function | |
86 | containing the process entry point, since it has no predecessor frame, | |
87 | and the frame for the function containing the user code entry point | |
88 | (the main() function), since all the predecessor frames are for the | |
89 | process startup code. Since we have no guarantee that the linked | |
90 | in startup modules have any debugging information that gdb can use, | |
91 | we need to avoid following frame pointers back into frames that might | |
95cf5869 | 92 | have been built in the startup code, as we might get hopelessly |
c906108c SS |
93 | confused. However, we almost always have debugging information |
94 | available for main(). | |
95 | ||
618ce49f AC |
96 | These variables are used to save the range of PC values which are |
97 | valid within the main() function and within the function containing | |
98 | the process entry point. If we always consider the frame for | |
99 | main() as the outermost frame when debugging user code, and the | |
100 | frame for the process entry point function as the outermost frame | |
101 | when debugging startup code, then all we have to do is have | |
102 | DEPRECATED_FRAME_CHAIN_VALID return false whenever a frame's | |
103 | current PC is within the range specified by these variables. In | |
104 | essence, we set "ceilings" in the frame chain beyond which we will | |
c906108c SS |
105 | not proceed when following the frame chain back up the stack. |
106 | ||
107 | A nice side effect is that we can still debug startup code without | |
108 | running off the end of the frame chain, assuming that we have usable | |
109 | debugging information in the startup modules, and if we choose to not | |
110 | use the block at main, or can't find it for some reason, everything | |
111 | still works as before. And if we have no startup code debugging | |
112 | information but we do have usable information for main(), backtraces | |
6e4c6c91 | 113 | from user code don't go wandering off into the startup code. */ |
c906108c SS |
114 | |
115 | struct entry_info | |
95cf5869 DE |
116 | { |
117 | /* The unrelocated value we should use for this objfile entry point. */ | |
118 | CORE_ADDR entry_point; | |
c906108c | 119 | |
95cf5869 DE |
120 | /* The index of the section in which the entry point appears. */ |
121 | int the_bfd_section_index; | |
53eddfa6 | 122 | |
95cf5869 DE |
123 | /* Set to 1 iff ENTRY_POINT contains a valid value. */ |
124 | unsigned entry_point_p : 1; | |
6ef55de7 | 125 | |
95cf5869 DE |
126 | /* Set to 1 iff this object was initialized. */ |
127 | unsigned initialized : 1; | |
128 | }; | |
c906108c | 129 | |
f1f6aadf PA |
130 | /* Sections in an objfile. The section offsets are stored in the |
131 | OBJFILE. */ | |
c906108c | 132 | |
c5aa993b | 133 | struct obj_section |
95cf5869 DE |
134 | { |
135 | /* BFD section pointer */ | |
136 | struct bfd_section *the_bfd_section; | |
c906108c | 137 | |
95cf5869 DE |
138 | /* Objfile this section is part of. */ |
139 | struct objfile *objfile; | |
c906108c | 140 | |
95cf5869 DE |
141 | /* True if this "overlay section" is mapped into an "overlay region". */ |
142 | int ovly_mapped; | |
143 | }; | |
c906108c | 144 | |
f1f6aadf PA |
145 | /* Relocation offset applied to S. */ |
146 | #define obj_section_offset(s) \ | |
6a053cb1 | 147 | (((s)->objfile->section_offsets)[gdb_bfd_section_index ((s)->objfile->obfd, (s)->the_bfd_section)]) |
f1f6aadf PA |
148 | |
149 | /* The memory address of section S (vma + offset). */ | |
150 | #define obj_section_addr(s) \ | |
fd361982 | 151 | (bfd_section_vma (s->the_bfd_section) \ |
f1f6aadf PA |
152 | + obj_section_offset (s)) |
153 | ||
154 | /* The one-passed-the-end memory address of section S | |
155 | (vma + size + offset). */ | |
156 | #define obj_section_endaddr(s) \ | |
fd361982 AM |
157 | (bfd_section_vma (s->the_bfd_section) \ |
158 | + bfd_section_size ((s)->the_bfd_section) \ | |
f1f6aadf | 159 | + obj_section_offset (s)) |
c906108c | 160 | |
b3b3bada SM |
161 | #define ALL_OBJFILE_OSECTIONS(objfile, osect) \ |
162 | for (osect = objfile->sections; osect < objfile->sections_end; osect++) \ | |
163 | if (osect->the_bfd_section == NULL) \ | |
164 | { \ | |
165 | /* Nothing. */ \ | |
166 | } \ | |
167 | else | |
168 | ||
169 | #define SECT_OFF_DATA(objfile) \ | |
170 | ((objfile->sect_index_data == -1) \ | |
171 | ? (internal_error (__FILE__, __LINE__, \ | |
172 | _("sect_index_data not initialized")), -1) \ | |
173 | : objfile->sect_index_data) | |
174 | ||
175 | #define SECT_OFF_RODATA(objfile) \ | |
176 | ((objfile->sect_index_rodata == -1) \ | |
177 | ? (internal_error (__FILE__, __LINE__, \ | |
178 | _("sect_index_rodata not initialized")), -1) \ | |
179 | : objfile->sect_index_rodata) | |
180 | ||
181 | #define SECT_OFF_TEXT(objfile) \ | |
182 | ((objfile->sect_index_text == -1) \ | |
183 | ? (internal_error (__FILE__, __LINE__, \ | |
184 | _("sect_index_text not initialized")), -1) \ | |
185 | : objfile->sect_index_text) | |
186 | ||
187 | /* Sometimes the .bss section is missing from the objfile, so we don't | |
188 | want to die here. Let the users of SECT_OFF_BSS deal with an | |
189 | uninitialized section index. */ | |
190 | #define SECT_OFF_BSS(objfile) (objfile)->sect_index_bss | |
191 | ||
c906108c SS |
192 | /* The "objstats" structure provides a place for gdb to record some |
193 | interesting information about its internal state at runtime, on a | |
194 | per objfile basis, such as information about the number of symbols | |
0df8b418 | 195 | read, size of string table (if any), etc. */ |
c906108c | 196 | |
c5aa993b | 197 | struct objstats |
95cf5869 | 198 | { |
95cf5869 | 199 | /* Number of full symbols read. */ |
9e86da07 | 200 | int n_syms = 0; |
95cf5869 DE |
201 | |
202 | /* Number of ".stabs" read (if applicable). */ | |
9e86da07 | 203 | int n_stabs = 0; |
95cf5869 DE |
204 | |
205 | /* Number of types. */ | |
9e86da07 | 206 | int n_types = 0; |
95cf5869 DE |
207 | |
208 | /* Size of stringtable, (if applicable). */ | |
9e86da07 | 209 | int sz_strtab = 0; |
95cf5869 | 210 | }; |
c906108c SS |
211 | |
212 | #define OBJSTAT(objfile, expr) (objfile -> stats.expr) | |
213 | #define OBJSTATS struct objstats stats | |
a14ed312 | 214 | extern void print_objfile_statistics (void); |
c906108c | 215 | |
9227b5eb | 216 | /* Number of entries in the minimal symbol hash table. */ |
375f3d86 | 217 | #define MINIMAL_SYMBOL_HASH_SIZE 2039 |
9227b5eb | 218 | |
7932255d TT |
219 | /* An iterator for minimal symbols. */ |
220 | ||
221 | struct minimal_symbol_iterator | |
222 | { | |
223 | typedef minimal_symbol_iterator self_type; | |
224 | typedef struct minimal_symbol *value_type; | |
225 | typedef struct minimal_symbol *&reference; | |
226 | typedef struct minimal_symbol **pointer; | |
227 | typedef std::forward_iterator_tag iterator_category; | |
228 | typedef int difference_type; | |
229 | ||
230 | explicit minimal_symbol_iterator (struct minimal_symbol *msym) | |
231 | : m_msym (msym) | |
232 | { | |
233 | } | |
234 | ||
235 | value_type operator* () const | |
236 | { | |
237 | return m_msym; | |
238 | } | |
239 | ||
240 | bool operator== (const self_type &other) const | |
241 | { | |
242 | return m_msym == other.m_msym; | |
243 | } | |
244 | ||
245 | bool operator!= (const self_type &other) const | |
246 | { | |
247 | return m_msym != other.m_msym; | |
248 | } | |
249 | ||
250 | self_type &operator++ () | |
251 | { | |
252 | ++m_msym; | |
253 | return *this; | |
254 | } | |
255 | ||
256 | private: | |
257 | struct minimal_symbol *m_msym; | |
258 | }; | |
259 | ||
706e3705 TT |
260 | /* Some objfile data is hung off the BFD. This enables sharing of the |
261 | data across all objfiles using the BFD. The data is stored in an | |
262 | instance of this structure, and associated with the BFD using the | |
263 | registry system. */ | |
264 | ||
265 | struct objfile_per_bfd_storage | |
266 | { | |
23732b1e PA |
267 | objfile_per_bfd_storage () |
268 | : minsyms_read (false) | |
269 | {} | |
270 | ||
d6797f46 TT |
271 | ~objfile_per_bfd_storage (); |
272 | ||
706e3705 TT |
273 | /* The storage has an obstack of its own. */ |
274 | ||
23732b1e | 275 | auto_obstack storage_obstack; |
95cf5869 | 276 | |
be1e3d3e | 277 | /* String cache. */ |
706e3705 | 278 | |
be1e3d3e | 279 | gdb::bcache string_cache; |
df6d5441 TT |
280 | |
281 | /* The gdbarch associated with the BFD. Note that this gdbarch is | |
282 | determined solely from BFD information, without looking at target | |
283 | information. The gdbarch determined from a running target may | |
284 | differ from this e.g. with respect to register types and names. */ | |
285 | ||
23732b1e | 286 | struct gdbarch *gdbarch = NULL; |
84a1243b TT |
287 | |
288 | /* Hash table for mapping symbol names to demangled names. Each | |
c7ee338a CB |
289 | entry in the hash table is a demangled_name_entry struct, storing the |
290 | language and two consecutive strings, both null-terminated; the first one | |
291 | is a mangled or linkage name, and the second is the demangled name or just | |
292 | a zero byte if the name doesn't demangle. */ | |
95cf5869 | 293 | |
db92718b | 294 | htab_up demangled_names_hash; |
6ef55de7 TT |
295 | |
296 | /* The per-objfile information about the entry point, the scope (file/func) | |
297 | containing the entry point, and the scope of the user's main() func. */ | |
298 | ||
23732b1e | 299 | entry_info ei {}; |
3d548a53 TT |
300 | |
301 | /* The name and language of any "main" found in this objfile. The | |
302 | name can be NULL, which means that the information was not | |
303 | recorded. */ | |
304 | ||
23732b1e PA |
305 | const char *name_of_main = NULL; |
306 | enum language language_of_main = language_unknown; | |
34643a32 TT |
307 | |
308 | /* Each file contains a pointer to an array of minimal symbols for all | |
309 | global symbols that are defined within the file. The array is | |
310 | terminated by a "null symbol", one that has a NULL pointer for the | |
311 | name and a zero value for the address. This makes it easy to walk | |
312 | through the array when passed a pointer to somewhere in the middle | |
313 | of it. There is also a count of the number of symbols, which does | |
042d75e4 | 314 | not include the terminating null symbol. */ |
34643a32 | 315 | |
042d75e4 | 316 | gdb::unique_xmalloc_ptr<minimal_symbol> msymbols; |
23732b1e | 317 | int minimal_symbol_count = 0; |
34643a32 | 318 | |
5f6cac40 TT |
319 | /* The number of minimal symbols read, before any minimal symbol |
320 | de-duplication is applied. Note in particular that this has only | |
321 | a passing relationship with the actual size of the table above; | |
322 | use minimal_symbol_count if you need the true size. */ | |
95cf5869 | 323 | |
23732b1e | 324 | int n_minsyms = 0; |
5f6cac40 | 325 | |
34643a32 TT |
326 | /* This is true if minimal symbols have already been read. Symbol |
327 | readers can use this to bypass minimal symbol reading. Also, the | |
328 | minimal symbol table management code in minsyms.c uses this to | |
329 | suppress new minimal symbols. You might think that MSYMBOLS or | |
330 | MINIMAL_SYMBOL_COUNT could be used for this, but it is possible | |
331 | for multiple readers to install minimal symbols into a given | |
332 | per-BFD. */ | |
333 | ||
23732b1e | 334 | bool minsyms_read : 1; |
34643a32 | 335 | |
c7ee338a CB |
336 | /* This is a hash table used to index the minimal symbols by (mangled) |
337 | name. */ | |
34643a32 | 338 | |
23732b1e | 339 | minimal_symbol *msymbol_hash[MINIMAL_SYMBOL_HASH_SIZE] {}; |
34643a32 TT |
340 | |
341 | /* This hash table is used to index the minimal symbols by their | |
c7ee338a CB |
342 | demangled names. Uses a language-specific hash function via |
343 | search_name_hash. */ | |
34643a32 | 344 | |
23732b1e | 345 | minimal_symbol *msymbol_demangled_hash[MINIMAL_SYMBOL_HASH_SIZE] {}; |
b5ec771e PA |
346 | |
347 | /* All the different languages of symbols found in the demangled | |
1b7a07cb TT |
348 | hash table. */ |
349 | std::bitset<nr_languages> demangled_hash_languages; | |
706e3705 TT |
350 | }; |
351 | ||
e9ad22ee TT |
352 | /* An iterator that first returns a parent objfile, and then each |
353 | separate debug objfile. */ | |
354 | ||
355 | class separate_debug_iterator | |
356 | { | |
357 | public: | |
358 | ||
359 | explicit separate_debug_iterator (struct objfile *objfile) | |
360 | : m_objfile (objfile), | |
361 | m_parent (objfile) | |
362 | { | |
363 | } | |
364 | ||
365 | bool operator!= (const separate_debug_iterator &other) | |
366 | { | |
367 | return m_objfile != other.m_objfile; | |
368 | } | |
369 | ||
370 | separate_debug_iterator &operator++ (); | |
371 | ||
372 | struct objfile *operator* () | |
373 | { | |
374 | return m_objfile; | |
375 | } | |
376 | ||
377 | private: | |
378 | ||
379 | struct objfile *m_objfile; | |
380 | struct objfile *m_parent; | |
381 | }; | |
382 | ||
383 | /* A range adapter wrapping separate_debug_iterator. */ | |
384 | ||
385 | class separate_debug_range | |
386 | { | |
387 | public: | |
388 | ||
389 | explicit separate_debug_range (struct objfile *objfile) | |
390 | : m_objfile (objfile) | |
391 | { | |
392 | } | |
393 | ||
394 | separate_debug_iterator begin () | |
395 | { | |
396 | return separate_debug_iterator (m_objfile); | |
397 | } | |
398 | ||
399 | separate_debug_iterator end () | |
400 | { | |
401 | return separate_debug_iterator (nullptr); | |
402 | } | |
403 | ||
404 | private: | |
405 | ||
406 | struct objfile *m_objfile; | |
407 | }; | |
408 | ||
c906108c SS |
409 | /* Master structure for keeping track of each file from which |
410 | gdb reads symbols. There are several ways these get allocated: 1. | |
411 | The main symbol file, symfile_objfile, set by the symbol-file command, | |
412 | 2. Additional symbol files added by the add-symbol-file command, | |
413 | 3. Shared library objfiles, added by ADD_SOLIB, 4. symbol files | |
414 | for modules that were loaded when GDB attached to a remote system | |
4ee94178 CB |
415 | (see remote-vx.c). |
416 | ||
417 | GDB typically reads symbols twice -- first an initial scan which just | |
418 | reads "partial symbols"; these are partial information for the | |
4d080b46 TT |
419 | static/global symbols in a symbol file. When later looking up |
420 | symbols, lookup_symbol is used to check if we only have a partial | |
4ee94178 | 421 | symbol and if so, read and expand the full compunit. */ |
c906108c SS |
422 | |
423 | struct objfile | |
95cf5869 | 424 | { |
bda13cdc TT |
425 | private: |
426 | ||
427 | /* The only way to create an objfile is to call objfile::make. */ | |
9e86da07 | 428 | objfile (bfd *, const char *, objfile_flags); |
bda13cdc TT |
429 | |
430 | public: | |
431 | ||
7d7167ce TT |
432 | /* Normally you should not call delete. Instead, call 'unlink' to |
433 | remove it from the program space's list. In some cases, you may | |
434 | need to hold a reference to an objfile that is independent of its | |
435 | existence on the program space's list; for this case, the | |
436 | destructor must be public so that shared_ptr can reference | |
437 | it. */ | |
438 | ~objfile (); | |
439 | ||
bda13cdc | 440 | /* Create an objfile. */ |
f65fe570 TT |
441 | static objfile *make (bfd *bfd_, const char *name_, objfile_flags flags_, |
442 | objfile *parent = nullptr); | |
bda13cdc | 443 | |
268e4f09 TT |
444 | /* Remove an objfile from the current program space, and free |
445 | it. */ | |
446 | void unlink (); | |
9e86da07 TT |
447 | |
448 | DISABLE_COPY_AND_ASSIGN (objfile); | |
449 | ||
b669c953 TT |
450 | typedef next_adapter<struct compunit_symtab> compunits_range; |
451 | ||
452 | /* A range adapter that makes it possible to iterate over all | |
453 | compunits in one objfile. */ | |
454 | ||
455 | compunits_range compunits () | |
456 | { | |
457 | return compunits_range (compunit_symtabs); | |
458 | } | |
6d6a12bf | 459 | |
7932255d TT |
460 | /* A range adapter that makes it possible to iterate over all |
461 | minimal symbols of an objfile. */ | |
462 | ||
463 | class msymbols_range | |
464 | { | |
465 | public: | |
466 | ||
467 | explicit msymbols_range (struct objfile *objfile) | |
468 | : m_objfile (objfile) | |
469 | { | |
470 | } | |
471 | ||
472 | minimal_symbol_iterator begin () const | |
473 | { | |
042d75e4 | 474 | return minimal_symbol_iterator (m_objfile->per_bfd->msymbols.get ()); |
7932255d TT |
475 | } |
476 | ||
477 | minimal_symbol_iterator end () const | |
478 | { | |
479 | return minimal_symbol_iterator | |
042d75e4 | 480 | (m_objfile->per_bfd->msymbols.get () |
7932255d TT |
481 | + m_objfile->per_bfd->minimal_symbol_count); |
482 | } | |
483 | ||
484 | private: | |
485 | ||
486 | struct objfile *m_objfile; | |
487 | }; | |
488 | ||
489 | /* Return a range adapter for iterating over all minimal | |
490 | symbols. */ | |
491 | ||
492 | msymbols_range msymbols () | |
493 | { | |
494 | return msymbols_range (this); | |
495 | } | |
496 | ||
e9ad22ee TT |
497 | /* Return a range adapter for iterating over all the separate debug |
498 | objfiles of this objfile. */ | |
499 | ||
500 | separate_debug_range separate_debug_objfiles () | |
501 | { | |
502 | return separate_debug_range (this); | |
503 | } | |
504 | ||
b3b3bada SM |
505 | CORE_ADDR text_section_offset () const |
506 | { | |
507 | return section_offsets[SECT_OFF_TEXT (this)]; | |
508 | } | |
509 | ||
510 | CORE_ADDR data_section_offset () const | |
511 | { | |
512 | return section_offsets[SECT_OFF_DATA (this)]; | |
513 | } | |
7932255d | 514 | |
be1e3d3e TT |
515 | /* Intern STRING and return the unique copy. The copy has the same |
516 | lifetime as the per-BFD object. */ | |
517 | const char *intern (const char *str) | |
518 | { | |
519 | return (const char *) per_bfd->string_cache.insert (str, strlen (str) + 1); | |
520 | } | |
521 | ||
522 | /* Intern STRING and return the unique copy. The copy has the same | |
523 | lifetime as the per-BFD object. */ | |
524 | const char *intern (const std::string &str) | |
525 | { | |
526 | return (const char *) per_bfd->string_cache.insert (str.c_str (), | |
527 | str.size () + 1); | |
528 | } | |
529 | ||
08feed99 TT |
530 | /* Retrieve the gdbarch associated with this objfile. */ |
531 | struct gdbarch *arch () const | |
532 | { | |
533 | return per_bfd->gdbarch; | |
534 | } | |
535 | ||
a8ad4f3c TT |
536 | /* Return true if OBJFILE has partial symbols. */ |
537 | ||
fae2120b | 538 | bool has_partial_symbols (); |
be1e3d3e | 539 | |
4d080b46 TT |
540 | /* See quick_symbol_functions. */ |
541 | struct symtab *find_last_source_symtab (); | |
542 | ||
543 | /* See quick_symbol_functions. */ | |
544 | void forget_cached_source_info (); | |
545 | ||
546 | /* See quick_symbol_functions. */ | |
547 | bool map_symtabs_matching_filename | |
548 | (const char *name, const char *real_path, | |
549 | gdb::function_view<bool (symtab *)> callback); | |
550 | ||
551 | /* See quick_symbol_functions. */ | |
552 | struct compunit_symtab *lookup_symbol (block_enum kind, const char *name, | |
553 | domain_enum domain); | |
554 | ||
555 | /* See quick_symbol_functions. */ | |
4829711b | 556 | void print_stats (bool print_bcache); |
4d080b46 TT |
557 | |
558 | /* See quick_symbol_functions. */ | |
559 | void dump (); | |
560 | ||
561 | /* See quick_symbol_functions. */ | |
562 | void expand_symtabs_for_function (const char *func_name); | |
563 | ||
564 | /* See quick_symbol_functions. */ | |
565 | void expand_all_symtabs (); | |
566 | ||
567 | /* See quick_symbol_functions. */ | |
568 | void expand_symtabs_with_fullname (const char *fullname); | |
569 | ||
570 | /* See quick_symbol_functions. */ | |
571 | void map_matching_symbols | |
572 | (const lookup_name_info &name, domain_enum domain, | |
573 | int global, | |
574 | gdb::function_view<symbol_found_callback_ftype> callback, | |
575 | symbol_compare_ftype *ordered_compare); | |
576 | ||
577 | /* See quick_symbol_functions. */ | |
578 | void expand_symtabs_matching | |
579 | (gdb::function_view<expand_symtabs_file_matcher_ftype> file_matcher, | |
580 | const lookup_name_info *lookup_name, | |
581 | gdb::function_view<expand_symtabs_symbol_matcher_ftype> symbol_matcher, | |
582 | gdb::function_view<expand_symtabs_exp_notify_ftype> expansion_notify, | |
583 | enum search_domain kind); | |
584 | ||
585 | /* See quick_symbol_functions. */ | |
586 | struct compunit_symtab *find_pc_sect_compunit_symtab | |
587 | (struct bound_minimal_symbol msymbol, | |
588 | CORE_ADDR pc, | |
589 | struct obj_section *section, | |
590 | int warn_if_readin); | |
591 | ||
592 | /* See quick_symbol_functions. */ | |
f4655dee TT |
593 | void map_symbol_filenames (gdb::function_view<symbol_filename_ftype> fun, |
594 | bool need_fullname); | |
4d080b46 TT |
595 | |
596 | /* See quick_symbol_functions. */ | |
597 | struct compunit_symtab *find_compunit_symtab_by_address (CORE_ADDR address); | |
598 | ||
599 | /* See quick_symbol_functions. */ | |
600 | enum language lookup_global_symbol_language (const char *name, | |
601 | domain_enum domain, | |
602 | bool *symbol_found_p); | |
603 | ||
d1eef86d TT |
604 | /* See quick_symbol_functions. */ |
605 | void require_partial_symbols (bool verbose); | |
606 | ||
4d080b46 | 607 | |
95cf5869 DE |
608 | /* The object file's original name as specified by the user, |
609 | made absolute, and tilde-expanded. However, it is not canonicalized | |
610 | (i.e., it has not been passed through gdb_realpath). | |
611 | This pointer is never NULL. This does not have to be freed; it is | |
612 | guaranteed to have a lifetime at least as long as the objfile. */ | |
c906108c | 613 | |
befcd486 | 614 | const char *original_name = nullptr; |
c906108c | 615 | |
9e86da07 | 616 | CORE_ADDR addr_low = 0; |
c906108c | 617 | |
b15cc25c | 618 | /* Some flag bits for this objfile. */ |
e4f6d2ec | 619 | |
b15cc25c | 620 | objfile_flags flags; |
c906108c | 621 | |
95cf5869 | 622 | /* The program space associated with this objfile. */ |
c906108c | 623 | |
95cf5869 | 624 | struct program_space *pspace; |
6c95b8df | 625 | |
95cf5869 DE |
626 | /* List of compunits. |
627 | These are used to do symbol lookups and file/line-number lookups. */ | |
6c95b8df | 628 | |
9e86da07 | 629 | struct compunit_symtab *compunit_symtabs = nullptr; |
c906108c | 630 | |
95cf5869 DE |
631 | /* The object file's BFD. Can be null if the objfile contains only |
632 | minimal symbols, e.g. the run time common symbols for SunOS4. */ | |
c906108c | 633 | |
95cf5869 | 634 | bfd *obfd; |
c906108c | 635 | |
95cf5869 DE |
636 | /* The per-BFD data. Note that this is treated specially if OBFD |
637 | is NULL. */ | |
c906108c | 638 | |
9e86da07 | 639 | struct objfile_per_bfd_storage *per_bfd = nullptr; |
706e3705 | 640 | |
95cf5869 DE |
641 | /* The modification timestamp of the object file, as of the last time |
642 | we read its symbols. */ | |
706e3705 | 643 | |
9e86da07 | 644 | long mtime = 0; |
c906108c | 645 | |
95cf5869 DE |
646 | /* Obstack to hold objects that should be freed when we load a new symbol |
647 | table from this object file. */ | |
c906108c | 648 | |
9e86da07 | 649 | struct obstack objfile_obstack {}; |
b99607ea | 650 | |
95cf5869 DE |
651 | /* Structure which keeps track of functions that manipulate objfile's |
652 | of the same type as this objfile. I.e. the function to read partial | |
653 | symbols for example. Note that this structure is in statically | |
654 | allocated memory, and is shared by all objfiles that use the | |
655 | object module reader of this type. */ | |
c906108c | 656 | |
9e86da07 | 657 | const struct sym_fns *sf = nullptr; |
c906108c | 658 | |
5c3f1e5b TT |
659 | /* The "quick" (aka partial) symbol functions for this symbol |
660 | reader. */ | |
e1114590 | 661 | std::forward_list<quick_symbol_functions_up> qf; |
5c3f1e5b | 662 | |
95cf5869 | 663 | /* Per objfile data-pointers required by other GDB modules. */ |
c906108c | 664 | |
9e86da07 | 665 | REGISTRY_FIELDS {}; |
0d0e1a63 | 666 | |
95cf5869 DE |
667 | /* Set of relocation offsets to apply to each section. |
668 | The table is indexed by the_bfd_section->index, thus it is generally | |
669 | as large as the number of sections in the binary. | |
0d0e1a63 | 670 | |
95cf5869 DE |
671 | These offsets indicate that all symbols (including partial and |
672 | minimal symbols) which have been read have been relocated by this | |
673 | much. Symbols which are yet to be read need to be relocated by it. */ | |
c906108c | 674 | |
6a053cb1 | 675 | ::section_offsets section_offsets; |
c906108c | 676 | |
95cf5869 DE |
677 | /* Indexes in the section_offsets array. These are initialized by the |
678 | *_symfile_offsets() family of functions (som_symfile_offsets, | |
679 | xcoff_symfile_offsets, default_symfile_offsets). In theory they | |
680 | should correspond to the section indexes used by bfd for the | |
681 | current objfile. The exception to this for the time being is the | |
9e86da07 TT |
682 | SOM version. |
683 | ||
684 | These are initialized to -1 so that we can later detect if they | |
685 | are used w/o being properly assigned to. */ | |
c906108c | 686 | |
9e86da07 TT |
687 | int sect_index_text = -1; |
688 | int sect_index_data = -1; | |
689 | int sect_index_bss = -1; | |
690 | int sect_index_rodata = -1; | |
b8fbeb18 | 691 | |
95cf5869 DE |
692 | /* These pointers are used to locate the section table, which |
693 | among other things, is used to map pc addresses into sections. | |
694 | SECTIONS points to the first entry in the table, and | |
695 | SECTIONS_END points to the first location past the last entry | |
696 | in the table. The table is stored on the objfile_obstack. The | |
697 | sections are indexed by the BFD section index; but the | |
698 | structure data is only valid for certain sections | |
699 | (e.g. non-empty, SEC_ALLOC). */ | |
b8fbeb18 | 700 | |
9e86da07 TT |
701 | struct obj_section *sections = nullptr; |
702 | struct obj_section *sections_end = nullptr; | |
c906108c | 703 | |
95cf5869 DE |
704 | /* GDB allows to have debug symbols in separate object files. This is |
705 | used by .gnu_debuglink, ELF build id note and Mach-O OSO. | |
706 | Although this is a tree structure, GDB only support one level | |
707 | (ie a separate debug for a separate debug is not supported). Note that | |
708 | separate debug object are in the main chain and therefore will be | |
2030c079 | 709 | visited by objfiles & co iterators. Separate debug objfile always |
95cf5869 | 710 | has a non-nul separate_debug_objfile_backlink. */ |
c906108c | 711 | |
95cf5869 | 712 | /* Link to the first separate debug object, if any. */ |
15d123c9 | 713 | |
9e86da07 | 714 | struct objfile *separate_debug_objfile = nullptr; |
5b5d99cf | 715 | |
95cf5869 DE |
716 | /* If this is a separate debug object, this is used as a link to the |
717 | actual executable objfile. */ | |
15d123c9 | 718 | |
9e86da07 | 719 | struct objfile *separate_debug_objfile_backlink = nullptr; |
15d123c9 | 720 | |
95cf5869 DE |
721 | /* If this is a separate debug object, this is a link to the next one |
722 | for the same executable objfile. */ | |
5c4e30ca | 723 | |
9e86da07 | 724 | struct objfile *separate_debug_objfile_link = nullptr; |
95cf5869 DE |
725 | |
726 | /* Place to stash various statistics about this objfile. */ | |
727 | ||
728 | OBJSTATS; | |
729 | ||
730 | /* A linked list of symbols created when reading template types or | |
731 | function templates. These symbols are not stored in any symbol | |
732 | table, so we have to keep them here to relocate them | |
733 | properly. */ | |
734 | ||
9e86da07 | 735 | struct symbol *template_symbols = nullptr; |
63e43d3a PMR |
736 | |
737 | /* Associate a static link (struct dynamic_prop *) to all blocks (struct | |
738 | block *) that have one. | |
739 | ||
740 | In the context of nested functions (available in Pascal, Ada and GNU C, | |
741 | for instance), a static link (as in DWARF's DW_AT_static_link attribute) | |
742 | for a function is a way to get the frame corresponding to the enclosing | |
743 | function. | |
744 | ||
745 | Very few blocks have a static link, so it's more memory efficient to | |
746 | store these here rather than in struct block. Static links must be | |
747 | allocated on the objfile's obstack. */ | |
cf250e36 | 748 | htab_up static_links; |
238b5c9f | 749 | |
0e74a041 SM |
750 | /* JIT-related data for this objfile, if the objfile is a JITer; |
751 | that is, it produces JITed objfiles. */ | |
752 | std::unique_ptr<jiter_objfile_data> jiter_data = nullptr; | |
753 | ||
754 | /* JIT-related data for this objfile, if the objfile is JITed; | |
755 | that is, it was produced by a JITer. */ | |
756 | std::unique_ptr<jited_objfile_data> jited_data = nullptr; | |
a7b4ff4f SM |
757 | |
758 | /* A flag that is set to true if the JIT interface symbols are not | |
759 | found in this objfile, so that we can skip the symbol lookup the | |
760 | next time. If an objfile does not have the symbols, it will | |
761 | never have them. */ | |
762 | bool skip_jit_symbol_lookup = false; | |
95cf5869 | 763 | }; |
c906108c | 764 | |
268e4f09 TT |
765 | /* A deleter for objfile. */ |
766 | ||
767 | struct objfile_deleter | |
768 | { | |
769 | void operator() (objfile *ptr) const | |
770 | { | |
771 | ptr->unlink (); | |
772 | } | |
773 | }; | |
774 | ||
775 | /* A unique pointer that holds an objfile. */ | |
776 | ||
777 | typedef std::unique_ptr<objfile, objfile_deleter> objfile_up; | |
778 | ||
c906108c SS |
779 | /* Declarations for functions defined in objfiles.c */ |
780 | ||
abd0a5fa JK |
781 | extern int entry_point_address_query (CORE_ADDR *entry_p); |
782 | ||
9ab9195f EZ |
783 | extern CORE_ADDR entry_point_address (void); |
784 | ||
d82ea6a8 | 785 | extern void build_objfile_section_table (struct objfile *); |
c906108c | 786 | |
15d123c9 TG |
787 | extern void free_objfile_separate_debug (struct objfile *); |
788 | ||
6a053cb1 | 789 | extern void objfile_relocate (struct objfile *, const section_offsets &); |
4141a416 | 790 | extern void objfile_rebase (struct objfile *, CORE_ADDR); |
c906108c | 791 | |
55333a84 DE |
792 | extern int objfile_has_full_symbols (struct objfile *objfile); |
793 | ||
e361b228 TG |
794 | extern int objfile_has_symbols (struct objfile *objfile); |
795 | ||
a14ed312 | 796 | extern int have_partial_symbols (void); |
c906108c | 797 | |
a14ed312 | 798 | extern int have_full_symbols (void); |
c906108c | 799 | |
8fb8eb5c DE |
800 | extern void objfile_set_sym_fns (struct objfile *objfile, |
801 | const struct sym_fns *sf); | |
802 | ||
bb272892 | 803 | extern void objfiles_changed (void); |
63644780 | 804 | |
02ff80c2 SM |
805 | /* Return true if ADDR maps into one of the sections of OBJFILE and false |
806 | otherwise. */ | |
807 | ||
808 | extern bool is_addr_in_objfile (CORE_ADDR addr, const struct objfile *objfile); | |
bb272892 | 809 | |
d03de421 PA |
810 | /* Return true if ADDRESS maps into one of the sections of a |
811 | OBJF_SHARED objfile of PSPACE and false otherwise. */ | |
08351840 | 812 | |
02ff80c2 | 813 | extern bool shared_objfile_contains_address_p (struct program_space *pspace, |
dda83cd7 | 814 | CORE_ADDR address); |
08351840 | 815 | |
c906108c SS |
816 | /* This operation deletes all objfile entries that represent solibs that |
817 | weren't explicitly loaded by the user, via e.g., the add-symbol-file | |
0df8b418 MS |
818 | command. */ |
819 | ||
a14ed312 | 820 | extern void objfile_purge_solibs (void); |
c906108c SS |
821 | |
822 | /* Functions for dealing with the minimal symbol table, really a misc | |
823 | address<->symbol mapping for things we don't have debug symbols for. */ | |
824 | ||
a14ed312 | 825 | extern int have_minimal_symbols (void); |
c906108c | 826 | |
a14ed312 | 827 | extern struct obj_section *find_pc_section (CORE_ADDR pc); |
c906108c | 828 | |
3e5d3a5a | 829 | /* Return non-zero if PC is in a section called NAME. */ |
a121b7c1 | 830 | extern int pc_in_section (CORE_ADDR, const char *); |
3e5d3a5a MR |
831 | |
832 | /* Return non-zero if PC is in a SVR4-style procedure linkage table | |
833 | section. */ | |
834 | ||
835 | static inline int | |
836 | in_plt_section (CORE_ADDR pc) | |
837 | { | |
5fae2a2c TV |
838 | return (pc_in_section (pc, ".plt") |
839 | || pc_in_section (pc, ".plt.sec")); | |
3e5d3a5a | 840 | } |
c906108c | 841 | |
0d0e1a63 MK |
842 | /* Keep a registry of per-objfile data-pointers required by other GDB |
843 | modules. */ | |
8e260fc0 | 844 | DECLARE_REGISTRY(objfile); |
e3c69974 | 845 | |
607ece04 GB |
846 | /* In normal use, the section map will be rebuilt by find_pc_section |
847 | if objfiles have been added, removed or relocated since it was last | |
848 | called. Calling inhibit_section_map_updates will inhibit this | |
06424eac TT |
849 | behavior until the returned scoped_restore object is destroyed. If |
850 | you call inhibit_section_map_updates you must ensure that every | |
851 | call to find_pc_section in the inhibited region relates to a | |
852 | section that is already in the section map and has not since been | |
853 | removed or relocated. */ | |
854 | extern scoped_restore_tmpl<int> inhibit_section_map_updates | |
855 | (struct program_space *pspace); | |
607ece04 | 856 | |
19630284 JB |
857 | extern void default_iterate_over_objfiles_in_search_order |
858 | (struct gdbarch *gdbarch, | |
859 | iterate_over_objfiles_in_search_order_cb_ftype *cb, | |
860 | void *cb_data, struct objfile *current_objfile); | |
b8fbeb18 | 861 | |
706e3705 TT |
862 | /* Reset the per-BFD storage area on OBJ. */ |
863 | ||
864 | void set_objfile_per_bfd (struct objfile *obj); | |
865 | ||
e02c96a7 DE |
866 | /* Return canonical name for OBJFILE. |
867 | This is the real file name if the file has been opened. | |
868 | Otherwise it is the original name supplied by the user. */ | |
869 | ||
4262abfb JK |
870 | const char *objfile_name (const struct objfile *objfile); |
871 | ||
e02c96a7 DE |
872 | /* Return the (real) file name of OBJFILE if the file has been opened, |
873 | otherwise return NULL. */ | |
874 | ||
875 | const char *objfile_filename (const struct objfile *objfile); | |
876 | ||
cc485e62 DE |
877 | /* Return the name to print for OBJFILE in debugging messages. */ |
878 | ||
879 | extern const char *objfile_debug_name (const struct objfile *objfile); | |
880 | ||
015d2e7e DE |
881 | /* Return the name of the file format of OBJFILE if the file has been opened, |
882 | otherwise return NULL. */ | |
883 | ||
884 | const char *objfile_flavour_name (struct objfile *objfile); | |
885 | ||
3d548a53 TT |
886 | /* Set the objfile's notion of the "main" name and language. */ |
887 | ||
888 | extern void set_objfile_main_name (struct objfile *objfile, | |
889 | const char *name, enum language lang); | |
890 | ||
63e43d3a PMR |
891 | extern void objfile_register_static_link |
892 | (struct objfile *objfile, | |
893 | const struct block *block, | |
894 | const struct dynamic_prop *static_link); | |
895 | ||
896 | extern const struct dynamic_prop *objfile_lookup_static_link | |
897 | (struct objfile *objfile, const struct block *block); | |
898 | ||
c5aa993b | 899 | #endif /* !defined (OBJFILES_H) */ |