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