Commit | Line | Data |
---|---|---|
c906108c | 1 | /* Symbol table definitions for GDB. |
1bac305b | 2 | |
42a4f53d | 3 | Copyright (C) 1986-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 (SYMTAB_H) | |
21 | #define SYMTAB_H 1 | |
22 | ||
a014b87a | 23 | #include <array> |
67d89901 | 24 | #include <vector> |
b5ec771e | 25 | #include <string> |
268a13a5 | 26 | #include "gdbsupport/gdb_vecs.h" |
2f68a895 | 27 | #include "gdbtypes.h" |
468c0cbb | 28 | #include "gdb_obstack.h" |
12615cba | 29 | #include "gdb_regex.h" |
268a13a5 TT |
30 | #include "gdbsupport/enum-flags.h" |
31 | #include "gdbsupport/function-view.h" | |
32 | #include "gdbsupport/gdb_optional.h" | |
31edb802 | 33 | #include "gdbsupport/gdb_string_view.h" |
268a13a5 | 34 | #include "gdbsupport/next-iterator.h" |
eb3ff9a5 | 35 | #include "completer.h" |
f10ffa41 | 36 | #include "gdb-demangle.h" |
f8eba3c6 | 37 | |
5f8a3188 | 38 | /* Opaque declarations. */ |
da3331ec AC |
39 | struct ui_file; |
40 | struct frame_info; | |
41 | struct symbol; | |
5f8a3188 | 42 | struct obstack; |
6a2f5abf | 43 | struct objfile; |
fe898f56 DC |
44 | struct block; |
45 | struct blockvector; | |
4c2df51b DJ |
46 | struct axs_value; |
47 | struct agent_expr; | |
6c95b8df | 48 | struct program_space; |
66a17cb6 | 49 | struct language_defn; |
4357ac6c | 50 | struct common_block; |
06096720 AB |
51 | struct obj_section; |
52 | struct cmd_list_element; | |
935676c9 | 53 | class probe; |
b5ec771e PA |
54 | struct lookup_name_info; |
55 | ||
56 | /* How to match a lookup name against a symbol search name. */ | |
57 | enum class symbol_name_match_type | |
58 | { | |
59 | /* Wild matching. Matches unqualified symbol names in all | |
60 | namespace/module/packages, etc. */ | |
61 | WILD, | |
62 | ||
63 | /* Full matching. The lookup name indicates a fully-qualified name, | |
64 | and only matches symbol search names in the specified | |
65 | namespace/module/package. */ | |
66 | FULL, | |
67 | ||
de63c46b PA |
68 | /* Search name matching. This is like FULL, but the search name did |
69 | not come from the user; instead it is already a search name | |
987012b8 | 70 | retrieved from a search_name () call. |
de63c46b PA |
71 | For Ada, this avoids re-encoding an already-encoded search name |
72 | (which would potentially incorrectly lowercase letters in the | |
73 | linkage/search name that should remain uppercase). For C++, it | |
74 | avoids trying to demangle a name we already know is | |
75 | demangled. */ | |
76 | SEARCH_NAME, | |
77 | ||
b5ec771e PA |
78 | /* Expression matching. The same as FULL matching in most |
79 | languages. The same as WILD matching in Ada. */ | |
80 | EXPRESSION, | |
81 | }; | |
82 | ||
83 | /* Hash the given symbol search name according to LANGUAGE's | |
84 | rules. */ | |
85 | extern unsigned int search_name_hash (enum language language, | |
86 | const char *search_name); | |
87 | ||
88 | /* Ada-specific bits of a lookup_name_info object. This is lazily | |
89 | constructed on demand. */ | |
90 | ||
91 | class ada_lookup_name_info final | |
92 | { | |
93 | public: | |
94 | /* Construct. */ | |
95 | explicit ada_lookup_name_info (const lookup_name_info &lookup_name); | |
96 | ||
97 | /* Compare SYMBOL_SEARCH_NAME with our lookup name, using MATCH_TYPE | |
98 | as name match type. Returns true if there's a match, false | |
99 | otherwise. If non-NULL, store the matching results in MATCH. */ | |
100 | bool matches (const char *symbol_search_name, | |
101 | symbol_name_match_type match_type, | |
a207cff2 | 102 | completion_match_result *comp_match_res) const; |
b5ec771e PA |
103 | |
104 | /* The Ada-encoded lookup name. */ | |
105 | const std::string &lookup_name () const | |
106 | { return m_encoded_name; } | |
107 | ||
108 | /* Return true if we're supposed to be doing a wild match look | |
109 | up. */ | |
110 | bool wild_match_p () const | |
111 | { return m_wild_match_p; } | |
112 | ||
113 | /* Return true if we're looking up a name inside package | |
114 | Standard. */ | |
115 | bool standard_p () const | |
116 | { return m_standard_p; } | |
117 | ||
c63d3e8d PA |
118 | /* Return true if doing a verbatim match. */ |
119 | bool verbatim_p () const | |
120 | { return m_verbatim_p; } | |
121 | ||
122 | private: | |
b5ec771e PA |
123 | /* The Ada-encoded lookup name. */ |
124 | std::string m_encoded_name; | |
125 | ||
126 | /* Whether the user-provided lookup name was Ada encoded. If so, | |
127 | then return encoded names in the 'matches' method's 'completion | |
128 | match result' output. */ | |
129 | bool m_encoded_p : 1; | |
130 | ||
131 | /* True if really doing wild matching. Even if the user requests | |
132 | wild matching, some cases require full matching. */ | |
133 | bool m_wild_match_p : 1; | |
134 | ||
135 | /* True if doing a verbatim match. This is true if the decoded | |
136 | version of the symbol name is wrapped in '<'/'>'. This is an | |
137 | escape hatch users can use to look up symbols the Ada encoding | |
138 | does not understand. */ | |
139 | bool m_verbatim_p : 1; | |
140 | ||
141 | /* True if the user specified a symbol name that is inside package | |
142 | Standard. Symbol names inside package Standard are handled | |
143 | specially. We always do a non-wild match of the symbol name | |
144 | without the "standard__" prefix, and only search static and | |
145 | global symbols. This was primarily introduced in order to allow | |
146 | the user to specifically access the standard exceptions using, | |
147 | for instance, Standard.Constraint_Error when Constraint_Error is | |
148 | ambiguous (due to the user defining its own Constraint_Error | |
149 | entity inside its program). */ | |
150 | bool m_standard_p : 1; | |
151 | }; | |
152 | ||
153 | /* Language-specific bits of a lookup_name_info object, for languages | |
154 | that do name searching using demangled names (C++/D/Go). This is | |
155 | lazily constructed on demand. */ | |
156 | ||
157 | struct demangle_for_lookup_info final | |
158 | { | |
159 | public: | |
160 | demangle_for_lookup_info (const lookup_name_info &lookup_name, | |
161 | language lang); | |
162 | ||
163 | /* The demangled lookup name. */ | |
164 | const std::string &lookup_name () const | |
165 | { return m_demangled_name; } | |
166 | ||
167 | private: | |
168 | /* The demangled lookup name. */ | |
169 | std::string m_demangled_name; | |
170 | }; | |
171 | ||
172 | /* Object that aggregates all information related to a symbol lookup | |
173 | name. I.e., the name that is matched against the symbol's search | |
174 | name. Caches per-language information so that it doesn't require | |
175 | recomputing it for every symbol comparison, like for example the | |
176 | Ada encoded name and the symbol's name hash for a given language. | |
177 | The object is conceptually immutable once constructed, and thus has | |
178 | no setters. This is to prevent some code path from tweaking some | |
179 | property of the lookup name for some local reason and accidentally | |
180 | altering the results of any continuing search(es). | |
181 | lookup_name_info objects are generally passed around as a const | |
182 | reference to reinforce that. (They're not passed around by value | |
183 | because they're not small.) */ | |
184 | class lookup_name_info final | |
185 | { | |
186 | public: | |
187 | /* Create a new object. */ | |
188 | lookup_name_info (std::string name, | |
189 | symbol_name_match_type match_type, | |
c62446b1 PA |
190 | bool completion_mode = false, |
191 | bool ignore_parameters = false) | |
b5ec771e PA |
192 | : m_match_type (match_type), |
193 | m_completion_mode (completion_mode), | |
c62446b1 | 194 | m_ignore_parameters (ignore_parameters), |
b5ec771e PA |
195 | m_name (std::move (name)) |
196 | {} | |
197 | ||
198 | /* Getters. See description of each corresponding field. */ | |
199 | symbol_name_match_type match_type () const { return m_match_type; } | |
200 | bool completion_mode () const { return m_completion_mode; } | |
201 | const std::string &name () const { return m_name; } | |
c62446b1 PA |
202 | const bool ignore_parameters () const { return m_ignore_parameters; } |
203 | ||
204 | /* Return a version of this lookup name that is usable with | |
205 | comparisons against symbols have no parameter info, such as | |
206 | psymbols and GDB index symbols. */ | |
207 | lookup_name_info make_ignore_params () const | |
208 | { | |
209 | return lookup_name_info (m_name, m_match_type, m_completion_mode, | |
210 | true /* ignore params */); | |
211 | } | |
b5ec771e PA |
212 | |
213 | /* Get the search name hash for searches in language LANG. */ | |
214 | unsigned int search_name_hash (language lang) const | |
215 | { | |
216 | /* Only compute each language's hash once. */ | |
217 | if (!m_demangled_hashes_p[lang]) | |
218 | { | |
219 | m_demangled_hashes[lang] | |
220 | = ::search_name_hash (lang, language_lookup_name (lang).c_str ()); | |
221 | m_demangled_hashes_p[lang] = true; | |
222 | } | |
223 | return m_demangled_hashes[lang]; | |
224 | } | |
225 | ||
226 | /* Get the search name for searches in language LANG. */ | |
227 | const std::string &language_lookup_name (language lang) const | |
228 | { | |
229 | switch (lang) | |
230 | { | |
231 | case language_ada: | |
232 | return ada ().lookup_name (); | |
233 | case language_cplus: | |
234 | return cplus ().lookup_name (); | |
235 | case language_d: | |
236 | return d ().lookup_name (); | |
237 | case language_go: | |
238 | return go ().lookup_name (); | |
239 | default: | |
240 | return m_name; | |
241 | } | |
242 | } | |
243 | ||
244 | /* Get the Ada-specific lookup info. */ | |
245 | const ada_lookup_name_info &ada () const | |
246 | { | |
247 | maybe_init (m_ada); | |
248 | return *m_ada; | |
249 | } | |
250 | ||
251 | /* Get the C++-specific lookup info. */ | |
252 | const demangle_for_lookup_info &cplus () const | |
253 | { | |
254 | maybe_init (m_cplus, language_cplus); | |
255 | return *m_cplus; | |
256 | } | |
257 | ||
258 | /* Get the D-specific lookup info. */ | |
259 | const demangle_for_lookup_info &d () const | |
260 | { | |
261 | maybe_init (m_d, language_d); | |
262 | return *m_d; | |
263 | } | |
264 | ||
265 | /* Get the Go-specific lookup info. */ | |
266 | const demangle_for_lookup_info &go () const | |
267 | { | |
268 | maybe_init (m_go, language_go); | |
269 | return *m_go; | |
270 | } | |
271 | ||
272 | /* Get a reference to a lookup_name_info object that matches any | |
273 | symbol name. */ | |
274 | static const lookup_name_info &match_any (); | |
275 | ||
276 | private: | |
277 | /* Initialize FIELD, if not initialized yet. */ | |
278 | template<typename Field, typename... Args> | |
279 | void maybe_init (Field &field, Args&&... args) const | |
280 | { | |
281 | if (!field) | |
282 | field.emplace (*this, std::forward<Args> (args)...); | |
283 | } | |
284 | ||
285 | /* The lookup info as passed to the ctor. */ | |
286 | symbol_name_match_type m_match_type; | |
287 | bool m_completion_mode; | |
c62446b1 | 288 | bool m_ignore_parameters; |
b5ec771e PA |
289 | std::string m_name; |
290 | ||
291 | /* Language-specific info. These fields are filled lazily the first | |
292 | time a lookup is done in the corresponding language. They're | |
293 | mutable because lookup_name_info objects are typically passed | |
294 | around by const reference (see intro), and they're conceptually | |
295 | "cache" that can always be reconstructed from the non-mutable | |
296 | fields. */ | |
297 | mutable gdb::optional<ada_lookup_name_info> m_ada; | |
298 | mutable gdb::optional<demangle_for_lookup_info> m_cplus; | |
299 | mutable gdb::optional<demangle_for_lookup_info> m_d; | |
300 | mutable gdb::optional<demangle_for_lookup_info> m_go; | |
301 | ||
302 | /* The demangled hashes. Stored in an array with one entry for each | |
303 | possible language. The second array records whether we've | |
304 | already computed the each language's hash. (These are separate | |
305 | arrays instead of a single array of optional<unsigned> to avoid | |
306 | alignment padding). */ | |
307 | mutable std::array<unsigned int, nr_languages> m_demangled_hashes; | |
308 | mutable std::array<bool, nr_languages> m_demangled_hashes_p {}; | |
309 | }; | |
310 | ||
311 | /* Comparison function for completion symbol lookup. | |
312 | ||
313 | Returns true if the symbol name matches against LOOKUP_NAME. | |
314 | ||
315 | SYMBOL_SEARCH_NAME should be a symbol's "search" name. | |
316 | ||
a207cff2 PA |
317 | On success and if non-NULL, COMP_MATCH_RES->match is set to point |
318 | to the symbol name as should be presented to the user as a | |
319 | completion match list element. In most languages, this is the same | |
320 | as the symbol's search name, but in some, like Ada, the display | |
321 | name is dynamically computed within the comparison routine. | |
322 | ||
323 | Also, on success and if non-NULL, COMP_MATCH_RES->match_for_lcd | |
324 | points the part of SYMBOL_SEARCH_NAME that was considered to match | |
325 | LOOKUP_NAME. E.g., in C++, in linespec/wild mode, if the symbol is | |
326 | "foo::function()" and LOOKUP_NAME is "function(", MATCH_FOR_LCD | |
327 | points to "function()" inside SYMBOL_SEARCH_NAME. */ | |
b5ec771e PA |
328 | typedef bool (symbol_name_matcher_ftype) |
329 | (const char *symbol_search_name, | |
330 | const lookup_name_info &lookup_name, | |
a207cff2 | 331 | completion_match_result *comp_match_res); |
c906108c | 332 | |
a7f19c79 MC |
333 | /* Some of the structures in this file are space critical. |
334 | The space-critical structures are: | |
335 | ||
336 | struct general_symbol_info | |
337 | struct symbol | |
338 | struct partial_symbol | |
339 | ||
5bccb4d1 | 340 | These structures are laid out to encourage good packing. |
a7f19c79 MC |
341 | They use ENUM_BITFIELD and short int fields, and they order the |
342 | structure members so that fields less than a word are next | |
c378eb4e | 343 | to each other so they can be packed together. */ |
a7f19c79 MC |
344 | |
345 | /* Rearranged: used ENUM_BITFIELD and rearranged field order in | |
346 | all the space critical structures (plus struct minimal_symbol). | |
347 | Memory usage dropped from 99360768 bytes to 90001408 bytes. | |
348 | I measured this with before-and-after tests of | |
349 | "HEAD-old-gdb -readnow HEAD-old-gdb" and | |
350 | "HEAD-new-gdb -readnow HEAD-old-gdb" on native i686-pc-linux-gnu, | |
351 | red hat linux 8, with LD_LIBRARY_PATH=/usr/lib/debug, | |
352 | typing "maint space 1" at the first command prompt. | |
353 | ||
354 | Here is another measurement (from andrew c): | |
355 | # no /usr/lib/debug, just plain glibc, like a normal user | |
356 | gdb HEAD-old-gdb | |
357 | (gdb) break internal_error | |
358 | (gdb) run | |
359 | (gdb) maint internal-error | |
360 | (gdb) backtrace | |
361 | (gdb) maint space 1 | |
362 | ||
363 | gdb gdb_6_0_branch 2003-08-19 space used: 8896512 | |
364 | gdb HEAD 2003-08-19 space used: 8904704 | |
365 | gdb HEAD 2003-08-21 space used: 8396800 (+symtab.h) | |
366 | gdb HEAD 2003-08-21 space used: 8265728 (+gdbtypes.h) | |
367 | ||
368 | The third line shows the savings from the optimizations in symtab.h. | |
369 | The fourth line shows the savings from the optimizations in | |
370 | gdbtypes.h. Both optimizations are in gdb HEAD now. | |
371 | ||
372 | --chastain 2003-08-21 */ | |
373 | ||
c906108c SS |
374 | /* Define a structure for the information that is common to all symbol types, |
375 | including minimal symbols, partial symbols, and full symbols. In a | |
376 | multilanguage environment, some language specific information may need to | |
c378eb4e | 377 | be recorded along with each symbol. */ |
c906108c | 378 | |
c378eb4e | 379 | /* This structure is space critical. See space comments at the top. */ |
c906108c SS |
380 | |
381 | struct general_symbol_info | |
17c5ed2c | 382 | { |
c9d95fa3 CB |
383 | /* Short version as to when to use which name accessor: |
384 | Use natural_name () to refer to the name of the symbol in the original | |
385 | source code. Use linkage_name () if you want to know what the linker | |
386 | thinks the symbol's name is. Use print_name () for output. Use | |
387 | demangled_name () if you specifically need to know whether natural_name () | |
388 | and linkage_name () are different. */ | |
389 | ||
390 | const char *linkage_name () const | |
391 | { return name; } | |
392 | ||
393 | /* Return SYMBOL's "natural" name, i.e. the name that it was called in | |
394 | the original source code. In languages like C++ where symbols may | |
395 | be mangled for ease of manipulation by the linker, this is the | |
396 | demangled name. */ | |
397 | const char *natural_name () const; | |
398 | ||
399 | /* Returns a version of the name of a symbol that is | |
400 | suitable for output. In C++ this is the "demangled" form of the | |
401 | name if demangle is on and the "mangled" form of the name if | |
402 | demangle is off. In other languages this is just the symbol name. | |
403 | The result should never be NULL. Don't use this for internal | |
404 | purposes (e.g. storing in a hashtable): it's only suitable for output. */ | |
405 | const char *print_name () const | |
406 | { return demangle ? natural_name () : linkage_name (); } | |
407 | ||
408 | /* Return the demangled name for a symbol based on the language for | |
409 | that symbol. If no demangled name exists, return NULL. */ | |
410 | const char *demangled_name () const; | |
411 | ||
412 | /* Returns the name to be used when sorting and searching symbols. | |
413 | In C++, we search for the demangled form of a name, | |
414 | and so sort symbols accordingly. In Ada, however, we search by mangled | |
415 | name. If there is no distinct demangled name, then this | |
416 | returns the same value (same pointer) as linkage_name (). */ | |
417 | const char *search_name () const; | |
418 | ||
22abf04a | 419 | /* Name of the symbol. This is a required field. Storage for the |
4a146b47 EZ |
420 | name is allocated on the objfile_obstack for the associated |
421 | objfile. For languages like C++ that make a distinction between | |
422 | the mangled name and demangled name, this is the mangled | |
423 | name. */ | |
c906108c | 424 | |
0d5cff50 | 425 | const char *name; |
c906108c | 426 | |
17c5ed2c DC |
427 | /* Value of the symbol. Which member of this union to use, and what |
428 | it means, depends on what kind of symbol this is and its | |
429 | SYMBOL_CLASS. See comments there for more details. All of these | |
430 | are in host byte order (though what they point to might be in | |
431 | target byte order, e.g. LOC_CONST_BYTES). */ | |
c906108c | 432 | |
17c5ed2c DC |
433 | union |
434 | { | |
12df843f | 435 | LONGEST ivalue; |
c906108c | 436 | |
3977b71f | 437 | const struct block *block; |
c906108c | 438 | |
d47a1bc1 | 439 | const gdb_byte *bytes; |
c906108c | 440 | |
17c5ed2c | 441 | CORE_ADDR address; |
c906108c | 442 | |
5a352474 | 443 | /* A common block. Used with LOC_COMMON_BLOCK. */ |
4357ac6c | 444 | |
17a40b44 | 445 | const struct common_block *common_block; |
4357ac6c | 446 | |
c378eb4e | 447 | /* For opaque typedef struct chain. */ |
c906108c | 448 | |
17c5ed2c DC |
449 | struct symbol *chain; |
450 | } | |
451 | value; | |
c906108c | 452 | |
17c5ed2c | 453 | /* Since one and only one language can apply, wrap the language specific |
29df156d | 454 | information inside a union. */ |
c906108c | 455 | |
17c5ed2c DC |
456 | union |
457 | { | |
f85f34ed TT |
458 | /* A pointer to an obstack that can be used for storage associated |
459 | with this symbol. This is only used by Ada, and only when the | |
460 | 'ada_mangled' field is zero. */ | |
461 | struct obstack *obstack; | |
462 | ||
afa16725 | 463 | /* This is used by languages which wish to store a demangled name. |
9c37b5ae | 464 | currently used by Ada, C++, and Objective C. */ |
615b3f62 | 465 | const char *demangled_name; |
17c5ed2c DC |
466 | } |
467 | language_specific; | |
c5aa993b | 468 | |
17c5ed2c DC |
469 | /* Record the source code language that applies to this symbol. |
470 | This is used to select one of the fields from the language specific | |
c378eb4e | 471 | union above. */ |
c5aa993b | 472 | |
51cdc993 | 473 | ENUM_BITFIELD(language) language : LANGUAGE_BITS; |
c5aa993b | 474 | |
a04a15f5 | 475 | /* This is only used by Ada. If set, then the 'demangled_name' field |
f85f34ed TT |
476 | of language_specific is valid. Otherwise, the 'obstack' field is |
477 | valid. */ | |
478 | unsigned int ada_mangled : 1; | |
479 | ||
17c5ed2c DC |
480 | /* Which section is this symbol in? This is an index into |
481 | section_offsets for this objfile. Negative means that the symbol | |
e27d198c | 482 | does not get relocated relative to a section. */ |
c5aa993b | 483 | |
17c5ed2c | 484 | short section; |
17c5ed2c | 485 | }; |
c906108c | 486 | |
cfc594ee TT |
487 | extern void symbol_set_demangled_name (struct general_symbol_info *, |
488 | const char *, | |
ccde22c0 | 489 | struct obstack *); |
b250c185 | 490 | |
0d5cff50 DE |
491 | extern const char *symbol_get_demangled_name |
492 | (const struct general_symbol_info *); | |
b250c185 | 493 | |
714835d5 | 494 | extern CORE_ADDR symbol_overlayed_address (CORE_ADDR, struct obj_section *); |
c906108c | 495 | |
4b610737 TT |
496 | /* Return the address of SYM. The MAYBE_COPIED flag must be set on |
497 | SYM. If SYM appears in the main program's minimal symbols, then | |
498 | that minsym's address is returned; otherwise, SYM's address is | |
499 | returned. This should generally only be used via the | |
500 | SYMBOL_VALUE_ADDRESS macro. */ | |
501 | ||
502 | extern CORE_ADDR get_symbol_address (const struct symbol *sym); | |
503 | ||
468c0cbb | 504 | /* Note that these macros only work with symbol, not partial_symbol. */ |
88cda038 | 505 | |
468c0cbb | 506 | #define SYMBOL_VALUE(symbol) (symbol)->value.ivalue |
4b610737 TT |
507 | #define SYMBOL_VALUE_ADDRESS(symbol) \ |
508 | (((symbol)->maybe_copied) ? get_symbol_address (symbol) \ | |
468c0cbb | 509 | : ((symbol)->value.address)) |
38583298 | 510 | #define SET_SYMBOL_VALUE_ADDRESS(symbol, new_value) \ |
468c0cbb CB |
511 | ((symbol)->value.address = (new_value)) |
512 | #define SYMBOL_VALUE_BYTES(symbol) (symbol)->value.bytes | |
513 | #define SYMBOL_VALUE_COMMON_BLOCK(symbol) (symbol)->value.common_block | |
514 | #define SYMBOL_BLOCK_VALUE(symbol) (symbol)->value.block | |
515 | #define SYMBOL_VALUE_CHAIN(symbol) (symbol)->value.chain | |
516 | #define SYMBOL_LANGUAGE(symbol) (symbol)->language | |
517 | #define SYMBOL_SECTION(symbol) (symbol)->section | |
e27d198c | 518 | #define SYMBOL_OBJ_SECTION(objfile, symbol) \ |
468c0cbb CB |
519 | (((symbol)->section >= 0) \ |
520 | ? (&(((objfile)->sections)[(symbol)->section])) \ | |
e27d198c | 521 | : NULL) |
c906108c | 522 | |
89aad1f9 | 523 | /* Initializes the language dependent portion of a symbol |
c378eb4e | 524 | depending upon the language for the symbol. */ |
f85f34ed | 525 | #define SYMBOL_SET_LANGUAGE(symbol,language,obstack) \ |
468c0cbb | 526 | (symbol_set_language ((symbol), (language), (obstack))) |
33e5013e | 527 | extern void symbol_set_language (struct general_symbol_info *symbol, |
f85f34ed TT |
528 | enum language language, |
529 | struct obstack *obstack); | |
c906108c | 530 | |
3567439c DJ |
531 | /* Set just the linkage name of a symbol; do not try to demangle |
532 | it. Used for constructs which do not have a mangled name, | |
533 | e.g. struct tags. Unlike SYMBOL_SET_NAMES, linkage_name must | |
1c9e8358 TT |
534 | be terminated and either already on the objfile's obstack or |
535 | permanently allocated. */ | |
3567439c | 536 | #define SYMBOL_SET_LINKAGE_NAME(symbol,linkage_name) \ |
468c0cbb | 537 | (symbol)->name = (linkage_name) |
3567439c DJ |
538 | |
539 | /* Set the linkage and natural names of a symbol, by demangling | |
0c921b21 CB |
540 | the linkage name. If linkage_name may not be nullterminated, |
541 | copy_name must be set to true. */ | |
31edb802 | 542 | #define SYMBOL_SET_NAMES(symbol,linkage_name,copy_name,objfile) \ |
468c0cbb | 543 | symbol_set_names ((symbol), linkage_name, copy_name, \ |
1d94a5a3 | 544 | (objfile)->per_bfd) |
2de7ced7 | 545 | extern void symbol_set_names (struct general_symbol_info *symbol, |
31edb802 | 546 | gdb::string_view linkage_name, bool copy_name, |
1d94a5a3 | 547 | struct objfile_per_bfd_storage *per_bfd); |
2de7ced7 | 548 | |
b5ec771e PA |
549 | /* Return true if NAME matches the "search" name of SYMBOL, according |
550 | to the symbol's language. */ | |
551 | #define SYMBOL_MATCHES_SEARCH_NAME(symbol, name) \ | |
468c0cbb | 552 | symbol_matches_search_name ((symbol), (name)) |
b5ec771e PA |
553 | |
554 | /* Helper for SYMBOL_MATCHES_SEARCH_NAME that works with both symbols | |
555 | and psymbols. */ | |
556 | extern bool symbol_matches_search_name | |
557 | (const struct general_symbol_info *gsymbol, | |
558 | const lookup_name_info &name); | |
4725b721 | 559 | |
5ffa0793 PA |
560 | /* Compute the hash of the given symbol search name of a symbol of |
561 | language LANGUAGE. */ | |
562 | extern unsigned int search_name_hash (enum language language, | |
563 | const char *search_name); | |
564 | ||
87193939 MC |
565 | /* Classification types for a minimal symbol. These should be taken as |
566 | "advisory only", since if gdb can't easily figure out a | |
567 | classification it simply selects mst_unknown. It may also have to | |
568 | guess when it can't figure out which is a better match between two | |
569 | types (mst_data versus mst_bss) for example. Since the minimal | |
570 | symbol info is sometimes derived from the BFD library's view of a | |
c378eb4e | 571 | file, we need to live with what information bfd supplies. */ |
87193939 MC |
572 | |
573 | enum minimal_symbol_type | |
574 | { | |
575 | mst_unknown = 0, /* Unknown type, the default */ | |
576 | mst_text, /* Generally executable instructions */ | |
f50776aa PA |
577 | |
578 | /* A GNU ifunc symbol, in the .text section. GDB uses to know | |
579 | whether the user is setting a breakpoint on a GNU ifunc function, | |
580 | and thus GDB needs to actually set the breakpoint on the target | |
581 | function. It is also used to know whether the program stepped | |
582 | into an ifunc resolver -- the resolver may get a separate | |
583 | symbol/alias under a different name, but it'll have the same | |
584 | address as the ifunc symbol. */ | |
585 | mst_text_gnu_ifunc, /* Executable code returning address | |
586 | of executable code */ | |
587 | ||
588 | /* A GNU ifunc function descriptor symbol, in a data section | |
589 | (typically ".opd"). Seen on architectures that use function | |
590 | descriptors, like PPC64/ELFv1. In this case, this symbol's value | |
591 | is the address of the descriptor. There'll be a corresponding | |
592 | mst_text_gnu_ifunc synthetic symbol for the text/entry | |
593 | address. */ | |
594 | mst_data_gnu_ifunc, /* Executable code returning address | |
0875794a | 595 | of executable code */ |
f50776aa | 596 | |
0875794a | 597 | mst_slot_got_plt, /* GOT entries for .plt sections */ |
87193939 MC |
598 | mst_data, /* Generally initialized data */ |
599 | mst_bss, /* Generally uninitialized data */ | |
600 | mst_abs, /* Generally absolute (nonrelocatable) */ | |
601 | /* GDB uses mst_solib_trampoline for the start address of a shared | |
602 | library trampoline entry. Breakpoints for shared library functions | |
603 | are put there if the shared library is not yet loaded. | |
604 | After the shared library is loaded, lookup_minimal_symbol will | |
605 | prefer the minimal symbol from the shared library (usually | |
606 | a mst_text symbol) over the mst_solib_trampoline symbol, and the | |
607 | breakpoints will be moved to their true address in the shared | |
608 | library via breakpoint_re_set. */ | |
609 | mst_solib_trampoline, /* Shared library trampoline code */ | |
610 | /* For the mst_file* types, the names are only guaranteed to be unique | |
611 | within a given .o file. */ | |
612 | mst_file_text, /* Static version of mst_text */ | |
613 | mst_file_data, /* Static version of mst_data */ | |
51cdc993 DE |
614 | mst_file_bss, /* Static version of mst_bss */ |
615 | nr_minsym_types | |
87193939 MC |
616 | }; |
617 | ||
51cdc993 DE |
618 | /* The number of enum minimal_symbol_type values, with some padding for |
619 | reasonable growth. */ | |
620 | #define MINSYM_TYPE_BITS 4 | |
621 | gdb_static_assert (nr_minsym_types <= (1 << MINSYM_TYPE_BITS)); | |
622 | ||
c906108c SS |
623 | /* Define a simple structure used to hold some very basic information about |
624 | all defined global symbols (text, data, bss, abs, etc). The only required | |
625 | information is the general_symbol_info. | |
626 | ||
627 | In many cases, even if a file was compiled with no special options for | |
628 | debugging at all, as long as was not stripped it will contain sufficient | |
629 | information to build a useful minimal symbol table using this structure. | |
630 | Even when a file contains enough debugging information to build a full | |
631 | symbol table, these minimal symbols are still useful for quickly mapping | |
632 | between names and addresses, and vice versa. They are also sometimes | |
c378eb4e | 633 | used to figure out what full symbol table entries need to be read in. */ |
c906108c | 634 | |
eefba3da | 635 | struct minimal_symbol : public general_symbol_info |
17c5ed2c | 636 | { |
8763cede | 637 | /* Size of this symbol. dbx_end_psymtab in dbxread.c uses this |
f594e5e9 MC |
638 | information to calculate the end of the partial symtab based on the |
639 | address of the last symbol plus the size of the last symbol. */ | |
640 | ||
641 | unsigned long size; | |
642 | ||
17c5ed2c | 643 | /* Which source file is this symbol in? Only relevant for mst_file_*. */ |
04aba065 | 644 | const char *filename; |
c906108c | 645 | |
87193939 | 646 | /* Classification type for this minimal symbol. */ |
17c5ed2c | 647 | |
51cdc993 | 648 | ENUM_BITFIELD(minimal_symbol_type) type : MINSYM_TYPE_BITS; |
17c5ed2c | 649 | |
422d65e7 DE |
650 | /* Non-zero if this symbol was created by gdb. |
651 | Such symbols do not appear in the output of "info var|fun". */ | |
652 | unsigned int created_by_gdb : 1; | |
653 | ||
b887350f TT |
654 | /* Two flag bits provided for the use of the target. */ |
655 | unsigned int target_flag_1 : 1; | |
656 | unsigned int target_flag_2 : 1; | |
657 | ||
d9eaeb59 JB |
658 | /* Nonzero iff the size of the minimal symbol has been set. |
659 | Symbol size information can sometimes not be determined, because | |
660 | the object file format may not carry that piece of information. */ | |
661 | unsigned int has_size : 1; | |
662 | ||
4b610737 TT |
663 | /* For data symbols only, if this is set, then the symbol might be |
664 | subject to copy relocation. In this case, a minimal symbol | |
665 | matching the symbol's linkage name is first looked for in the | |
666 | main objfile. If found, then that address is used; otherwise the | |
667 | address in this symbol is used. */ | |
668 | ||
669 | unsigned maybe_copied : 1; | |
670 | ||
17c5ed2c DC |
671 | /* Minimal symbols with the same hash key are kept on a linked |
672 | list. This is the link. */ | |
673 | ||
674 | struct minimal_symbol *hash_next; | |
675 | ||
676 | /* Minimal symbols are stored in two different hash tables. This is | |
677 | the `next' pointer for the demangled hash table. */ | |
678 | ||
679 | struct minimal_symbol *demangled_hash_next; | |
1ed9f74e | 680 | |
eefba3da | 681 | /* True if this symbol is of some data type. */ |
1ed9f74e PW |
682 | |
683 | bool data_p () const; | |
684 | ||
685 | /* True if MSYMBOL is of some text type. */ | |
686 | ||
687 | bool text_p () const; | |
17c5ed2c | 688 | }; |
c906108c | 689 | |
4b610737 TT |
690 | /* Return the address of MINSYM, which comes from OBJF. The |
691 | MAYBE_COPIED flag must be set on MINSYM. If MINSYM appears in the | |
692 | main program's minimal symbols, then that minsym's address is | |
693 | returned; otherwise, MINSYM's address is returned. This should | |
694 | generally only be used via the MSYMBOL_VALUE_ADDRESS macro. */ | |
695 | ||
696 | extern CORE_ADDR get_msymbol_address (struct objfile *objf, | |
697 | const struct minimal_symbol *minsym); | |
698 | ||
b887350f TT |
699 | #define MSYMBOL_TARGET_FLAG_1(msymbol) (msymbol)->target_flag_1 |
700 | #define MSYMBOL_TARGET_FLAG_2(msymbol) (msymbol)->target_flag_2 | |
d9eaeb59 JB |
701 | #define MSYMBOL_SIZE(msymbol) ((msymbol)->size + 0) |
702 | #define SET_MSYMBOL_SIZE(msymbol, sz) \ | |
703 | do \ | |
704 | { \ | |
705 | (msymbol)->size = sz; \ | |
706 | (msymbol)->has_size = 1; \ | |
707 | } while (0) | |
708 | #define MSYMBOL_HAS_SIZE(msymbol) ((msymbol)->has_size + 0) | |
c906108c | 709 | #define MSYMBOL_TYPE(msymbol) (msymbol)->type |
c906108c | 710 | |
eefba3da | 711 | #define MSYMBOL_VALUE(symbol) (symbol)->value.ivalue |
77e371c0 | 712 | /* The unrelocated address of the minimal symbol. */ |
eefba3da | 713 | #define MSYMBOL_VALUE_RAW_ADDRESS(symbol) ((symbol)->value.address + 0) |
2273f0ac TT |
714 | /* The relocated address of the minimal symbol, using the section |
715 | offsets from OBJFILE. */ | |
77e371c0 | 716 | #define MSYMBOL_VALUE_ADDRESS(objfile, symbol) \ |
4b610737 TT |
717 | (((symbol)->maybe_copied) ? get_msymbol_address (objfile, symbol) \ |
718 | : ((symbol)->value.address \ | |
719 | + ANOFFSET ((objfile)->section_offsets, ((symbol)->section)))) | |
77e371c0 TT |
720 | /* For a bound minsym, we can easily compute the address directly. */ |
721 | #define BMSYMBOL_VALUE_ADDRESS(symbol) \ | |
722 | MSYMBOL_VALUE_ADDRESS ((symbol).objfile, (symbol).minsym) | |
723 | #define SET_MSYMBOL_VALUE_ADDRESS(symbol, new_value) \ | |
eefba3da TT |
724 | ((symbol)->value.address = (new_value)) |
725 | #define MSYMBOL_VALUE_BYTES(symbol) (symbol)->value.bytes | |
726 | #define MSYMBOL_BLOCK_VALUE(symbol) (symbol)->value.block | |
727 | #define MSYMBOL_VALUE_CHAIN(symbol) (symbol)->value.chain | |
728 | #define MSYMBOL_LANGUAGE(symbol) (symbol)->language | |
729 | #define MSYMBOL_SECTION(symbol) (symbol)->section | |
efd66ac6 | 730 | #define MSYMBOL_OBJ_SECTION(objfile, symbol) \ |
eefba3da TT |
731 | (((symbol)->section >= 0) \ |
732 | ? (&(((objfile)->sections)[(symbol)->section])) \ | |
efd66ac6 TT |
733 | : NULL) |
734 | ||
c35384fb TT |
735 | #include "minsyms.h" |
736 | ||
c906108c | 737 | \f |
c5aa993b | 738 | |
c906108c SS |
739 | /* Represent one symbol name; a variable, constant, function or typedef. */ |
740 | ||
176620f1 | 741 | /* Different name domains for symbols. Looking up a symbol specifies a |
c378eb4e | 742 | domain and ignores symbol definitions in other name domains. */ |
c906108c | 743 | |
87193939 | 744 | typedef enum domain_enum_tag |
17c5ed2c | 745 | { |
176620f1 | 746 | /* UNDEF_DOMAIN is used when a domain has not been discovered or |
17c5ed2c | 747 | none of the following apply. This usually indicates an error either |
c378eb4e | 748 | in the symbol information or in gdb's handling of symbols. */ |
c906108c | 749 | |
176620f1 | 750 | UNDEF_DOMAIN, |
c906108c | 751 | |
176620f1 | 752 | /* VAR_DOMAIN is the usual domain. In C, this contains variables, |
c378eb4e | 753 | function names, typedef names and enum type values. */ |
c906108c | 754 | |
176620f1 | 755 | VAR_DOMAIN, |
c906108c | 756 | |
176620f1 | 757 | /* STRUCT_DOMAIN is used in C to hold struct, union and enum type names. |
17c5ed2c | 758 | Thus, if `struct foo' is used in a C program, it produces a symbol named |
c378eb4e | 759 | `foo' in the STRUCT_DOMAIN. */ |
c906108c | 760 | |
176620f1 | 761 | STRUCT_DOMAIN, |
c906108c | 762 | |
530e8392 KB |
763 | /* MODULE_DOMAIN is used in Fortran to hold module type names. */ |
764 | ||
765 | MODULE_DOMAIN, | |
766 | ||
0f5238ed | 767 | /* LABEL_DOMAIN may be used for names of labels (for gotos). */ |
c906108c | 768 | |
4357ac6c TT |
769 | LABEL_DOMAIN, |
770 | ||
5a352474 JK |
771 | /* Fortran common blocks. Their naming must be separate from VAR_DOMAIN. |
772 | They also always use LOC_COMMON_BLOCK. */ | |
51cdc993 DE |
773 | COMMON_BLOCK_DOMAIN, |
774 | ||
775 | /* This must remain last. */ | |
776 | NR_DOMAINS | |
8903c50d | 777 | } domain_enum; |
c906108c | 778 | |
c01feb36 DE |
779 | /* The number of bits in a symbol used to represent the domain. */ |
780 | ||
51cdc993 DE |
781 | #define SYMBOL_DOMAIN_BITS 3 |
782 | gdb_static_assert (NR_DOMAINS <= (1 << SYMBOL_DOMAIN_BITS)); | |
c01feb36 | 783 | |
20c681d1 DE |
784 | extern const char *domain_name (domain_enum); |
785 | ||
e8930875 JK |
786 | /* Searching domains, used for `search_symbols'. Element numbers are |
787 | hardcoded in GDB, check all enum uses before changing it. */ | |
c906108c | 788 | |
8903c50d TT |
789 | enum search_domain |
790 | { | |
bd2e94ce TT |
791 | /* Everything in VAR_DOMAIN minus FUNCTIONS_DOMAIN and |
792 | TYPES_DOMAIN. */ | |
e8930875 | 793 | VARIABLES_DOMAIN = 0, |
c906108c | 794 | |
c378eb4e | 795 | /* All functions -- for some reason not methods, though. */ |
e8930875 | 796 | FUNCTIONS_DOMAIN = 1, |
c906108c | 797 | |
17c5ed2c | 798 | /* All defined types */ |
e8930875 | 799 | TYPES_DOMAIN = 2, |
7b08b9eb | 800 | |
59c35742 AB |
801 | /* All modules. */ |
802 | MODULES_DOMAIN = 3, | |
803 | ||
7b08b9eb | 804 | /* Any type. */ |
59c35742 | 805 | ALL_DOMAIN = 4 |
8903c50d | 806 | }; |
c906108c | 807 | |
20c681d1 DE |
808 | extern const char *search_domain_name (enum search_domain); |
809 | ||
c906108c SS |
810 | /* An address-class says where to find the value of a symbol. */ |
811 | ||
812 | enum address_class | |
17c5ed2c | 813 | { |
c378eb4e | 814 | /* Not used; catches errors. */ |
c5aa993b | 815 | |
17c5ed2c | 816 | LOC_UNDEF, |
c906108c | 817 | |
c378eb4e | 818 | /* Value is constant int SYMBOL_VALUE, host byteorder. */ |
c906108c | 819 | |
17c5ed2c | 820 | LOC_CONST, |
c906108c | 821 | |
c378eb4e | 822 | /* Value is at fixed address SYMBOL_VALUE_ADDRESS. */ |
c906108c | 823 | |
17c5ed2c | 824 | LOC_STATIC, |
c906108c | 825 | |
768a979c UW |
826 | /* Value is in register. SYMBOL_VALUE is the register number |
827 | in the original debug format. SYMBOL_REGISTER_OPS holds a | |
828 | function that can be called to transform this into the | |
829 | actual register number this represents in a specific target | |
830 | architecture (gdbarch). | |
2a2d4dc3 AS |
831 | |
832 | For some symbol formats (stabs, for some compilers at least), | |
833 | the compiler generates two symbols, an argument and a register. | |
834 | In some cases we combine them to a single LOC_REGISTER in symbol | |
835 | reading, but currently not for all cases (e.g. it's passed on the | |
836 | stack and then loaded into a register). */ | |
c906108c | 837 | |
17c5ed2c | 838 | LOC_REGISTER, |
c906108c | 839 | |
17c5ed2c | 840 | /* It's an argument; the value is at SYMBOL_VALUE offset in arglist. */ |
c906108c | 841 | |
17c5ed2c | 842 | LOC_ARG, |
c906108c | 843 | |
17c5ed2c | 844 | /* Value address is at SYMBOL_VALUE offset in arglist. */ |
c906108c | 845 | |
17c5ed2c | 846 | LOC_REF_ARG, |
c906108c | 847 | |
2a2d4dc3 | 848 | /* Value is in specified register. Just like LOC_REGISTER except the |
17c5ed2c | 849 | register holds the address of the argument instead of the argument |
c378eb4e | 850 | itself. This is currently used for the passing of structs and unions |
17c5ed2c DC |
851 | on sparc and hppa. It is also used for call by reference where the |
852 | address is in a register, at least by mipsread.c. */ | |
c906108c | 853 | |
17c5ed2c | 854 | LOC_REGPARM_ADDR, |
c906108c | 855 | |
17c5ed2c | 856 | /* Value is a local variable at SYMBOL_VALUE offset in stack frame. */ |
c906108c | 857 | |
17c5ed2c | 858 | LOC_LOCAL, |
c906108c | 859 | |
176620f1 EZ |
860 | /* Value not used; definition in SYMBOL_TYPE. Symbols in the domain |
861 | STRUCT_DOMAIN all have this class. */ | |
c906108c | 862 | |
17c5ed2c | 863 | LOC_TYPEDEF, |
c906108c | 864 | |
c378eb4e | 865 | /* Value is address SYMBOL_VALUE_ADDRESS in the code. */ |
c906108c | 866 | |
17c5ed2c | 867 | LOC_LABEL, |
c906108c | 868 | |
17c5ed2c DC |
869 | /* In a symbol table, value is SYMBOL_BLOCK_VALUE of a `struct block'. |
870 | In a partial symbol table, SYMBOL_VALUE_ADDRESS is the start address | |
c378eb4e | 871 | of the block. Function names have this class. */ |
c906108c | 872 | |
17c5ed2c | 873 | LOC_BLOCK, |
c906108c | 874 | |
17c5ed2c DC |
875 | /* Value is a constant byte-sequence pointed to by SYMBOL_VALUE_BYTES, in |
876 | target byte order. */ | |
c906108c | 877 | |
17c5ed2c | 878 | LOC_CONST_BYTES, |
c906108c | 879 | |
17c5ed2c DC |
880 | /* Value is at fixed address, but the address of the variable has |
881 | to be determined from the minimal symbol table whenever the | |
882 | variable is referenced. | |
883 | This happens if debugging information for a global symbol is | |
884 | emitted and the corresponding minimal symbol is defined | |
885 | in another object file or runtime common storage. | |
886 | The linker might even remove the minimal symbol if the global | |
887 | symbol is never referenced, in which case the symbol remains | |
de40b933 JK |
888 | unresolved. |
889 | ||
890 | GDB would normally find the symbol in the minimal symbol table if it will | |
891 | not find it in the full symbol table. But a reference to an external | |
892 | symbol in a local block shadowing other definition requires full symbol | |
893 | without possibly having its address available for LOC_STATIC. Testcase | |
5382cfab PW |
894 | is provided as `gdb.dwarf2/dw2-unresolved.exp'. |
895 | ||
896 | This is also used for thread local storage (TLS) variables. In this case, | |
897 | the address of the TLS variable must be determined when the variable is | |
898 | referenced, from the MSYMBOL_VALUE_RAW_ADDRESS, which is the offset | |
899 | of the TLS variable in the thread local storage of the shared | |
900 | library/object. */ | |
c906108c | 901 | |
17c5ed2c | 902 | LOC_UNRESOLVED, |
c906108c | 903 | |
17c5ed2c DC |
904 | /* The variable does not actually exist in the program. |
905 | The value is ignored. */ | |
c906108c | 906 | |
17c5ed2c | 907 | LOC_OPTIMIZED_OUT, |
c906108c | 908 | |
4c2df51b | 909 | /* The variable's address is computed by a set of location |
768a979c | 910 | functions (see "struct symbol_computed_ops" below). */ |
4c2df51b | 911 | LOC_COMPUTED, |
5a352474 JK |
912 | |
913 | /* The variable uses general_symbol_info->value->common_block field. | |
914 | It also always uses COMMON_BLOCK_DOMAIN. */ | |
915 | LOC_COMMON_BLOCK, | |
f1e6e072 TT |
916 | |
917 | /* Not used, just notes the boundary of the enum. */ | |
918 | LOC_FINAL_VALUE | |
4c2df51b DJ |
919 | }; |
920 | ||
51cdc993 DE |
921 | /* The number of bits needed for values in enum address_class, with some |
922 | padding for reasonable growth, and room for run-time registered address | |
923 | classes. See symtab.c:MAX_SYMBOL_IMPLS. | |
924 | This is a #define so that we can have a assertion elsewhere to | |
925 | verify that we have reserved enough space for synthetic address | |
926 | classes. */ | |
927 | #define SYMBOL_ACLASS_BITS 5 | |
928 | gdb_static_assert (LOC_FINAL_VALUE <= (1 << SYMBOL_ACLASS_BITS)); | |
929 | ||
768a979c | 930 | /* The methods needed to implement LOC_COMPUTED. These methods can |
a67af2b9 AC |
931 | use the symbol's .aux_value for additional per-symbol information. |
932 | ||
933 | At present this is only used to implement location expressions. */ | |
934 | ||
768a979c | 935 | struct symbol_computed_ops |
4c2df51b DJ |
936 | { |
937 | ||
938 | /* Return the value of the variable SYMBOL, relative to the stack | |
939 | frame FRAME. If the variable has been optimized out, return | |
940 | zero. | |
941 | ||
0b31a4bc TT |
942 | Iff `read_needs_frame (SYMBOL)' is not SYMBOL_NEEDS_FRAME, then |
943 | FRAME may be zero. */ | |
4c2df51b DJ |
944 | |
945 | struct value *(*read_variable) (struct symbol * symbol, | |
946 | struct frame_info * frame); | |
947 | ||
e18b2753 JK |
948 | /* Read variable SYMBOL like read_variable at (callee) FRAME's function |
949 | entry. SYMBOL should be a function parameter, otherwise | |
950 | NO_ENTRY_VALUE_ERROR will be thrown. */ | |
951 | struct value *(*read_variable_at_entry) (struct symbol *symbol, | |
952 | struct frame_info *frame); | |
953 | ||
0b31a4bc TT |
954 | /* Find the "symbol_needs_kind" value for the given symbol. This |
955 | value determines whether reading the symbol needs memory (e.g., a | |
956 | global variable), just registers (a thread-local), or a frame (a | |
957 | local variable). */ | |
958 | enum symbol_needs_kind (*get_symbol_read_needs) (struct symbol * symbol); | |
4c2df51b DJ |
959 | |
960 | /* Write to STREAM a natural-language description of the location of | |
08922a10 SS |
961 | SYMBOL, in the context of ADDR. */ |
962 | void (*describe_location) (struct symbol * symbol, CORE_ADDR addr, | |
963 | struct ui_file * stream); | |
4c2df51b | 964 | |
f1e6e072 TT |
965 | /* Non-zero if this symbol's address computation is dependent on PC. */ |
966 | unsigned char location_has_loclist; | |
967 | ||
4c2df51b DJ |
968 | /* Tracepoint support. Append bytecodes to the tracepoint agent |
969 | expression AX that push the address of the object SYMBOL. Set | |
970 | VALUE appropriately. Note --- for objects in registers, this | |
971 | needn't emit any code; as long as it sets VALUE properly, then | |
972 | the caller will generate the right code in the process of | |
973 | treating this as an lvalue or rvalue. */ | |
974 | ||
40f4af28 SM |
975 | void (*tracepoint_var_ref) (struct symbol *symbol, struct agent_expr *ax, |
976 | struct axs_value *value); | |
bb2ec1b3 TT |
977 | |
978 | /* Generate C code to compute the location of SYMBOL. The C code is | |
979 | emitted to STREAM. GDBARCH is the current architecture and PC is | |
980 | the PC at which SYMBOL's location should be evaluated. | |
981 | REGISTERS_USED is a vector indexed by register number; the | |
982 | generator function should set an element in this vector if the | |
983 | corresponding register is needed by the location computation. | |
984 | The generated C code must assign the location to a local | |
985 | variable; this variable's name is RESULT_NAME. */ | |
986 | ||
d82b3862 | 987 | void (*generate_c_location) (struct symbol *symbol, string_file *stream, |
bb2ec1b3 TT |
988 | struct gdbarch *gdbarch, |
989 | unsigned char *registers_used, | |
990 | CORE_ADDR pc, const char *result_name); | |
991 | ||
17c5ed2c | 992 | }; |
c906108c | 993 | |
f1e6e072 TT |
994 | /* The methods needed to implement LOC_BLOCK for inferior functions. |
995 | These methods can use the symbol's .aux_value for additional | |
996 | per-symbol information. */ | |
997 | ||
998 | struct symbol_block_ops | |
999 | { | |
1000 | /* Fill in *START and *LENGTH with DWARF block data of function | |
1001 | FRAMEFUNC valid for inferior context address PC. Set *LENGTH to | |
1002 | zero if such location is not valid for PC; *START is left | |
1003 | uninitialized in such case. */ | |
1004 | void (*find_frame_base_location) (struct symbol *framefunc, CORE_ADDR pc, | |
1005 | const gdb_byte **start, size_t *length); | |
63e43d3a PMR |
1006 | |
1007 | /* Return the frame base address. FRAME is the frame for which we want to | |
1008 | compute the base address while FRAMEFUNC is the symbol for the | |
1009 | corresponding function. Return 0 on failure (FRAMEFUNC may not hold the | |
1010 | information we need). | |
1011 | ||
1012 | This method is designed to work with static links (nested functions | |
1013 | handling). Static links are function properties whose evaluation returns | |
1014 | the frame base address for the enclosing frame. However, there are | |
1015 | multiple definitions for "frame base": the content of the frame base | |
1016 | register, the CFA as defined by DWARF unwinding information, ... | |
1017 | ||
1018 | So this specific method is supposed to compute the frame base address such | |
30baf67b | 1019 | as for nested functions, the static link computes the same address. For |
63e43d3a PMR |
1020 | instance, considering DWARF debugging information, the static link is |
1021 | computed with DW_AT_static_link and this method must be used to compute | |
1022 | the corresponding DW_AT_frame_base attribute. */ | |
1023 | CORE_ADDR (*get_frame_base) (struct symbol *framefunc, | |
1024 | struct frame_info *frame); | |
f1e6e072 TT |
1025 | }; |
1026 | ||
768a979c UW |
1027 | /* Functions used with LOC_REGISTER and LOC_REGPARM_ADDR. */ |
1028 | ||
1029 | struct symbol_register_ops | |
1030 | { | |
1031 | int (*register_number) (struct symbol *symbol, struct gdbarch *gdbarch); | |
1032 | }; | |
1033 | ||
f1e6e072 TT |
1034 | /* Objects of this type are used to find the address class and the |
1035 | various computed ops vectors of a symbol. */ | |
1036 | ||
1037 | struct symbol_impl | |
1038 | { | |
1039 | enum address_class aclass; | |
1040 | ||
1041 | /* Used with LOC_COMPUTED. */ | |
1042 | const struct symbol_computed_ops *ops_computed; | |
1043 | ||
1044 | /* Used with LOC_BLOCK. */ | |
1045 | const struct symbol_block_ops *ops_block; | |
1046 | ||
1047 | /* Used with LOC_REGISTER and LOC_REGPARM_ADDR. */ | |
1048 | const struct symbol_register_ops *ops_register; | |
1049 | }; | |
1050 | ||
cf724bc9 TT |
1051 | /* struct symbol has some subclasses. This enum is used to |
1052 | differentiate between them. */ | |
1053 | ||
1054 | enum symbol_subclass_kind | |
1055 | { | |
1056 | /* Plain struct symbol. */ | |
1057 | SYMBOL_NONE, | |
1058 | ||
1059 | /* struct template_symbol. */ | |
1060 | SYMBOL_TEMPLATE, | |
1061 | ||
1062 | /* struct rust_vtable_symbol. */ | |
1063 | SYMBOL_RUST_VTABLE | |
1064 | }; | |
1065 | ||
c378eb4e | 1066 | /* This structure is space critical. See space comments at the top. */ |
a7f19c79 | 1067 | |
468c0cbb | 1068 | struct symbol : public general_symbol_info, public allocate_on_obstack |
17c5ed2c | 1069 | { |
468c0cbb CB |
1070 | symbol () |
1071 | /* Class-initialization of bitfields is only allowed in C++20. */ | |
1072 | : domain (UNDEF_DOMAIN), | |
1073 | aclass_index (0), | |
1074 | is_objfile_owned (0), | |
1075 | is_argument (0), | |
1076 | is_inlined (0), | |
1077 | maybe_copied (0), | |
1078 | subclass (SYMBOL_NONE) | |
1079 | { | |
1080 | /* We can't use an initializer list for members of a base class, and | |
1081 | general_symbol_info needs to stay a POD type. */ | |
1082 | name = nullptr; | |
1083 | value.ivalue = 0; | |
1084 | language_specific.obstack = nullptr; | |
1085 | language = language_unknown; | |
1086 | ada_mangled = 0; | |
1087 | section = 0; | |
6edc43ec CB |
1088 | /* GCC 4.8.5 (on CentOS 7) does not correctly compile class- |
1089 | initialization of unions, so we initialize it manually here. */ | |
1090 | owner.symtab = nullptr; | |
468c0cbb | 1091 | } |
c906108c | 1092 | |
17c5ed2c | 1093 | /* Data type of value */ |
c906108c | 1094 | |
468c0cbb | 1095 | struct type *type = nullptr; |
c906108c | 1096 | |
1994afbf | 1097 | /* The owner of this symbol. |
e2ada9cb | 1098 | Which one to use is defined by symbol.is_objfile_owned. */ |
1994afbf DE |
1099 | |
1100 | union | |
1101 | { | |
1102 | /* The symbol table containing this symbol. This is the file associated | |
1103 | with LINE. It can be NULL during symbols read-in but it is never NULL | |
1104 | during normal operation. */ | |
6edc43ec | 1105 | struct symtab *symtab; |
1994afbf DE |
1106 | |
1107 | /* For types defined by the architecture. */ | |
1108 | struct gdbarch *arch; | |
1109 | } owner; | |
cb1df416 | 1110 | |
176620f1 | 1111 | /* Domain code. */ |
c906108c | 1112 | |
c01feb36 | 1113 | ENUM_BITFIELD(domain_enum_tag) domain : SYMBOL_DOMAIN_BITS; |
c906108c | 1114 | |
f1e6e072 TT |
1115 | /* Address class. This holds an index into the 'symbol_impls' |
1116 | table. The actual enum address_class value is stored there, | |
1117 | alongside any per-class ops vectors. */ | |
c906108c | 1118 | |
f1e6e072 | 1119 | unsigned int aclass_index : SYMBOL_ACLASS_BITS; |
c906108c | 1120 | |
1994afbf | 1121 | /* If non-zero then symbol is objfile-owned, use owner.symtab. |
468c0cbb | 1122 | Otherwise symbol is arch-owned, use owner.arch. */ |
1994afbf DE |
1123 | |
1124 | unsigned int is_objfile_owned : 1; | |
1125 | ||
2a2d4dc3 AS |
1126 | /* Whether this is an argument. */ |
1127 | ||
1128 | unsigned is_argument : 1; | |
1129 | ||
edb3359d DJ |
1130 | /* Whether this is an inlined function (class LOC_BLOCK only). */ |
1131 | unsigned is_inlined : 1; | |
1132 | ||
4b610737 TT |
1133 | /* For LOC_STATIC only, if this is set, then the symbol might be |
1134 | subject to copy relocation. In this case, a minimal symbol | |
1135 | matching the symbol's linkage name is first looked for in the | |
1136 | main objfile. If found, then that address is used; otherwise the | |
1137 | address in this symbol is used. */ | |
1138 | ||
1139 | unsigned maybe_copied : 1; | |
1140 | ||
cf724bc9 | 1141 | /* The concrete type of this symbol. */ |
71a3c369 | 1142 | |
cf724bc9 | 1143 | ENUM_BITFIELD (symbol_subclass_kind) subclass : 2; |
71a3c369 | 1144 | |
edb3359d DJ |
1145 | /* Line number of this symbol's definition, except for inlined |
1146 | functions. For an inlined function (class LOC_BLOCK and | |
1147 | SYMBOL_INLINED set) this is the line number of the function's call | |
1148 | site. Inlined function symbols are not definitions, and they are | |
1149 | never found by symbol table lookup. | |
1994afbf | 1150 | If this symbol is arch-owned, LINE shall be zero. |
edb3359d DJ |
1151 | |
1152 | FIXME: Should we really make the assumption that nobody will try | |
1153 | to debug files longer than 64K lines? What about machine | |
1154 | generated programs? */ | |
c906108c | 1155 | |
468c0cbb | 1156 | unsigned short line = 0; |
c906108c | 1157 | |
10f4ecb8 UW |
1158 | /* An arbitrary data pointer, allowing symbol readers to record |
1159 | additional information on a per-symbol basis. Note that this data | |
1160 | must be allocated using the same obstack as the symbol itself. */ | |
1cd36e54 DE |
1161 | /* So far it is only used by: |
1162 | LOC_COMPUTED: to find the location information | |
1163 | LOC_BLOCK (DWARF2 function): information used internally by the | |
1164 | DWARF 2 code --- specifically, the location expression for the frame | |
10f4ecb8 UW |
1165 | base for this function. */ |
1166 | /* FIXME drow/2003-02-21: For the LOC_BLOCK case, it might be better | |
1167 | to add a magic symbol to the block containing this information, | |
1168 | or to have a generic debug info annotation slot for symbols. */ | |
1169 | ||
468c0cbb | 1170 | void *aux_value = nullptr; |
c906108c | 1171 | |
468c0cbb | 1172 | struct symbol *hash_next = nullptr; |
17c5ed2c | 1173 | }; |
c906108c | 1174 | |
d12307c1 PMR |
1175 | /* Several lookup functions return both a symbol and the block in which the |
1176 | symbol is found. This structure is used in these cases. */ | |
1177 | ||
1178 | struct block_symbol | |
1179 | { | |
1180 | /* The symbol that was found, or NULL if no symbol was found. */ | |
1181 | struct symbol *symbol; | |
1182 | ||
1183 | /* If SYMBOL is not NULL, then this is the block in which the symbol is | |
1184 | defined. */ | |
1185 | const struct block *block; | |
1186 | }; | |
1187 | ||
f1e6e072 | 1188 | extern const struct symbol_impl *symbol_impls; |
c906108c | 1189 | |
1994afbf DE |
1190 | /* Note: There is no accessor macro for symbol.owner because it is |
1191 | "private". */ | |
1192 | ||
176620f1 | 1193 | #define SYMBOL_DOMAIN(symbol) (symbol)->domain |
f1e6e072 TT |
1194 | #define SYMBOL_IMPL(symbol) (symbol_impls[(symbol)->aclass_index]) |
1195 | #define SYMBOL_ACLASS_INDEX(symbol) (symbol)->aclass_index | |
1196 | #define SYMBOL_CLASS(symbol) (SYMBOL_IMPL (symbol).aclass) | |
1994afbf | 1197 | #define SYMBOL_OBJFILE_OWNED(symbol) ((symbol)->is_objfile_owned) |
2a2d4dc3 | 1198 | #define SYMBOL_IS_ARGUMENT(symbol) (symbol)->is_argument |
edb3359d | 1199 | #define SYMBOL_INLINED(symbol) (symbol)->is_inlined |
34eaf542 | 1200 | #define SYMBOL_IS_CPLUS_TEMPLATE_FUNCTION(symbol) \ |
cf724bc9 | 1201 | (((symbol)->subclass) == SYMBOL_TEMPLATE) |
c906108c SS |
1202 | #define SYMBOL_TYPE(symbol) (symbol)->type |
1203 | #define SYMBOL_LINE(symbol) (symbol)->line | |
f1e6e072 TT |
1204 | #define SYMBOL_COMPUTED_OPS(symbol) (SYMBOL_IMPL (symbol).ops_computed) |
1205 | #define SYMBOL_BLOCK_OPS(symbol) (SYMBOL_IMPL (symbol).ops_block) | |
1206 | #define SYMBOL_REGISTER_OPS(symbol) (SYMBOL_IMPL (symbol).ops_register) | |
10f4ecb8 | 1207 | #define SYMBOL_LOCATION_BATON(symbol) (symbol)->aux_value |
34eaf542 | 1208 | |
f1e6e072 TT |
1209 | extern int register_symbol_computed_impl (enum address_class, |
1210 | const struct symbol_computed_ops *); | |
1211 | ||
1212 | extern int register_symbol_block_impl (enum address_class aclass, | |
1213 | const struct symbol_block_ops *ops); | |
1214 | ||
1215 | extern int register_symbol_register_impl (enum address_class, | |
1216 | const struct symbol_register_ops *); | |
1217 | ||
08be3fe3 DE |
1218 | /* Return the OBJFILE of SYMBOL. |
1219 | It is an error to call this if symbol.is_objfile_owned is false, which | |
1220 | only happens for architecture-provided types. */ | |
1221 | ||
1222 | extern struct objfile *symbol_objfile (const struct symbol *symbol); | |
1223 | ||
1224 | /* Return the ARCH of SYMBOL. */ | |
1225 | ||
1226 | extern struct gdbarch *symbol_arch (const struct symbol *symbol); | |
1227 | ||
1228 | /* Return the SYMTAB of SYMBOL. | |
1229 | It is an error to call this if symbol.is_objfile_owned is false, which | |
1230 | only happens for architecture-provided types. */ | |
1231 | ||
1232 | extern struct symtab *symbol_symtab (const struct symbol *symbol); | |
1233 | ||
1234 | /* Set the symtab of SYMBOL to SYMTAB. | |
1235 | It is an error to call this if symbol.is_objfile_owned is false, which | |
1236 | only happens for architecture-provided types. */ | |
1237 | ||
1238 | extern void symbol_set_symtab (struct symbol *symbol, struct symtab *symtab); | |
1239 | ||
34eaf542 | 1240 | /* An instance of this type is used to represent a C++ template |
68e745e3 TT |
1241 | function. A symbol is really of this type iff |
1242 | SYMBOL_IS_CPLUS_TEMPLATE_FUNCTION is true. */ | |
34eaf542 | 1243 | |
68e745e3 | 1244 | struct template_symbol : public symbol |
34eaf542 | 1245 | { |
34eaf542 | 1246 | /* The number of template arguments. */ |
468c0cbb | 1247 | int n_template_arguments = 0; |
34eaf542 TT |
1248 | |
1249 | /* The template arguments. This is an array with | |
1250 | N_TEMPLATE_ARGUMENTS elements. */ | |
468c0cbb | 1251 | struct symbol **template_arguments = nullptr; |
34eaf542 TT |
1252 | }; |
1253 | ||
71a3c369 TT |
1254 | /* A symbol that represents a Rust virtual table object. */ |
1255 | ||
1256 | struct rust_vtable_symbol : public symbol | |
1257 | { | |
1258 | /* The concrete type for which this vtable was created; that is, in | |
1259 | "impl Trait for Type", this is "Type". */ | |
468c0cbb | 1260 | struct type *concrete_type = nullptr; |
71a3c369 TT |
1261 | }; |
1262 | ||
c906108c | 1263 | \f |
c906108c SS |
1264 | /* Each item represents a line-->pc (or the reverse) mapping. This is |
1265 | somewhat more wasteful of space than one might wish, but since only | |
1266 | the files which are actually debugged are read in to core, we don't | |
1267 | waste much space. */ | |
1268 | ||
1269 | struct linetable_entry | |
17c5ed2c DC |
1270 | { |
1271 | int line; | |
1272 | CORE_ADDR pc; | |
1273 | }; | |
c906108c SS |
1274 | |
1275 | /* The order of entries in the linetable is significant. They should | |
1276 | be sorted by increasing values of the pc field. If there is more than | |
1277 | one entry for a given pc, then I'm not sure what should happen (and | |
1278 | I not sure whether we currently handle it the best way). | |
1279 | ||
1280 | Example: a C for statement generally looks like this | |
1281 | ||
c5aa993b JM |
1282 | 10 0x100 - for the init/test part of a for stmt. |
1283 | 20 0x200 | |
1284 | 30 0x300 | |
1285 | 10 0x400 - for the increment part of a for stmt. | |
c906108c | 1286 | |
e8717518 FF |
1287 | If an entry has a line number of zero, it marks the start of a PC |
1288 | range for which no line number information is available. It is | |
1289 | acceptable, though wasteful of table space, for such a range to be | |
1290 | zero length. */ | |
c906108c SS |
1291 | |
1292 | struct linetable | |
17c5ed2c DC |
1293 | { |
1294 | int nitems; | |
c906108c | 1295 | |
17c5ed2c DC |
1296 | /* Actually NITEMS elements. If you don't like this use of the |
1297 | `struct hack', you can shove it up your ANSI (seriously, if the | |
1298 | committee tells us how to do it, we can probably go along). */ | |
1299 | struct linetable_entry item[1]; | |
1300 | }; | |
c906108c | 1301 | |
c906108c SS |
1302 | /* How to relocate the symbols from each section in a symbol file. |
1303 | Each struct contains an array of offsets. | |
1304 | The ordering and meaning of the offsets is file-type-dependent; | |
1305 | typically it is indexed by section numbers or symbol types or | |
1306 | something like that. | |
1307 | ||
1308 | To give us flexibility in changing the internal representation | |
1309 | of these offsets, the ANOFFSET macro must be used to insert and | |
1310 | extract offset values in the struct. */ | |
1311 | ||
1312 | struct section_offsets | |
17c5ed2c | 1313 | { |
c378eb4e | 1314 | CORE_ADDR offsets[1]; /* As many as needed. */ |
17c5ed2c | 1315 | }; |
c906108c | 1316 | |
a4c8257b | 1317 | #define ANOFFSET(secoff, whichone) \ |
3e43a32a MS |
1318 | ((whichone == -1) \ |
1319 | ? (internal_error (__FILE__, __LINE__, \ | |
1320 | _("Section index is uninitialized")), -1) \ | |
1321 | : secoff->offsets[whichone]) | |
c906108c | 1322 | |
b29c9944 JB |
1323 | /* The size of a section_offsets table for N sections. */ |
1324 | #define SIZEOF_N_SECTION_OFFSETS(n) \ | |
c906108c | 1325 | (sizeof (struct section_offsets) \ |
b29c9944 JB |
1326 | + sizeof (((struct section_offsets *) 0)->offsets) * ((n)-1)) |
1327 | ||
c378eb4e | 1328 | /* Each source file or header is represented by a struct symtab. |
43f3e411 | 1329 | The name "symtab" is historical, another name for it is "filetab". |
c906108c SS |
1330 | These objects are chained through the `next' field. */ |
1331 | ||
1332 | struct symtab | |
17c5ed2c | 1333 | { |
b7236fbe DE |
1334 | /* Unordered chain of all filetabs in the compunit, with the exception |
1335 | that the "main" source file is the first entry in the list. */ | |
c906108c | 1336 | |
17c5ed2c | 1337 | struct symtab *next; |
c906108c | 1338 | |
43f3e411 | 1339 | /* Backlink to containing compunit symtab. */ |
c906108c | 1340 | |
43f3e411 | 1341 | struct compunit_symtab *compunit_symtab; |
c906108c | 1342 | |
17c5ed2c DC |
1343 | /* Table mapping core addresses to line numbers for this file. |
1344 | Can be NULL if none. Never shared between different symtabs. */ | |
c906108c | 1345 | |
17c5ed2c | 1346 | struct linetable *linetable; |
c906108c | 1347 | |
4e04028d | 1348 | /* Name of this source file. This pointer is never NULL. */ |
c906108c | 1349 | |
21ea9eec | 1350 | const char *filename; |
c906108c | 1351 | |
17c5ed2c | 1352 | /* Language of this source file. */ |
c906108c | 1353 | |
17c5ed2c | 1354 | enum language language; |
c906108c | 1355 | |
43f3e411 DE |
1356 | /* Full name of file as found by searching the source path. |
1357 | NULL if not yet known. */ | |
1358 | ||
1359 | char *fullname; | |
1360 | }; | |
1361 | ||
1362 | #define SYMTAB_COMPUNIT(symtab) ((symtab)->compunit_symtab) | |
1363 | #define SYMTAB_LINETABLE(symtab) ((symtab)->linetable) | |
1364 | #define SYMTAB_LANGUAGE(symtab) ((symtab)->language) | |
1365 | #define SYMTAB_BLOCKVECTOR(symtab) \ | |
1366 | COMPUNIT_BLOCKVECTOR (SYMTAB_COMPUNIT (symtab)) | |
1367 | #define SYMTAB_OBJFILE(symtab) \ | |
1368 | COMPUNIT_OBJFILE (SYMTAB_COMPUNIT (symtab)) | |
1369 | #define SYMTAB_PSPACE(symtab) (SYMTAB_OBJFILE (symtab)->pspace) | |
1370 | #define SYMTAB_DIRNAME(symtab) \ | |
1371 | COMPUNIT_DIRNAME (SYMTAB_COMPUNIT (symtab)) | |
1372 | ||
43f3e411 DE |
1373 | /* Compunit symtabs contain the actual "symbol table", aka blockvector, as well |
1374 | as the list of all source files (what gdb has historically associated with | |
1375 | the term "symtab"). | |
1376 | Additional information is recorded here that is common to all symtabs in a | |
1377 | compilation unit (DWARF or otherwise). | |
1378 | ||
1379 | Example: | |
1380 | For the case of a program built out of these files: | |
1381 | ||
1382 | foo.c | |
1383 | foo1.h | |
1384 | foo2.h | |
1385 | bar.c | |
1386 | foo1.h | |
1387 | bar.h | |
1388 | ||
1389 | This is recorded as: | |
1390 | ||
1391 | objfile -> foo.c(cu) -> bar.c(cu) -> NULL | |
1392 | | | | |
1393 | v v | |
1394 | foo.c bar.c | |
1395 | | | | |
1396 | v v | |
1397 | foo1.h foo1.h | |
1398 | | | | |
1399 | v v | |
1400 | foo2.h bar.h | |
1401 | | | | |
1402 | v v | |
1403 | NULL NULL | |
1404 | ||
1405 | where "foo.c(cu)" and "bar.c(cu)" are struct compunit_symtab objects, | |
1406 | and the files foo.c, etc. are struct symtab objects. */ | |
1407 | ||
1408 | struct compunit_symtab | |
1409 | { | |
1410 | /* Unordered chain of all compunit symtabs of this objfile. */ | |
1411 | struct compunit_symtab *next; | |
1412 | ||
1413 | /* Object file from which this symtab information was read. */ | |
1414 | struct objfile *objfile; | |
1415 | ||
1416 | /* Name of the symtab. | |
1417 | This is *not* intended to be a usable filename, and is | |
1418 | for debugging purposes only. */ | |
1419 | const char *name; | |
1420 | ||
1421 | /* Unordered list of file symtabs, except that by convention the "main" | |
1422 | source file (e.g., .c, .cc) is guaranteed to be first. | |
1423 | Each symtab is a file, either the "main" source file (e.g., .c, .cc) | |
1424 | or header (e.g., .h). */ | |
1425 | struct symtab *filetabs; | |
1426 | ||
1427 | /* Last entry in FILETABS list. | |
1428 | Subfiles are added to the end of the list so they accumulate in order, | |
1429 | with the main source subfile living at the front. | |
1430 | The main reason is so that the main source file symtab is at the head | |
1431 | of the list, and the rest appear in order for debugging convenience. */ | |
1432 | struct symtab *last_filetab; | |
1433 | ||
1434 | /* Non-NULL string that identifies the format of the debugging information, | |
1435 | such as "stabs", "dwarf 1", "dwarf 2", "coff", etc. This is mostly useful | |
17c5ed2c | 1436 | for automated testing of gdb but may also be information that is |
c378eb4e | 1437 | useful to the user. */ |
554d387d | 1438 | const char *debugformat; |
c906108c | 1439 | |
43f3e411 | 1440 | /* String of producer version information, or NULL if we don't know. */ |
554d387d | 1441 | const char *producer; |
c906108c | 1442 | |
43f3e411 DE |
1443 | /* Directory in which it was compiled, or NULL if we don't know. */ |
1444 | const char *dirname; | |
c906108c | 1445 | |
43f3e411 DE |
1446 | /* List of all symbol scope blocks for this symtab. It is shared among |
1447 | all symtabs in a given compilation unit. */ | |
1448 | const struct blockvector *blockvector; | |
c906108c | 1449 | |
43f3e411 DE |
1450 | /* Section in objfile->section_offsets for the blockvector and |
1451 | the linetable. Probably always SECT_OFF_TEXT. */ | |
1452 | int block_line_section; | |
c906108c | 1453 | |
43f3e411 DE |
1454 | /* Symtab has been compiled with both optimizations and debug info so that |
1455 | GDB may stop skipping prologues as variables locations are valid already | |
1456 | at function entry points. */ | |
1457 | unsigned int locations_valid : 1; | |
c906108c | 1458 | |
43f3e411 DE |
1459 | /* DWARF unwinder for this CU is valid even for epilogues (PC at the return |
1460 | instruction). This is supported by GCC since 4.5.0. */ | |
1461 | unsigned int epilogue_unwind_valid : 1; | |
8e3b41a9 | 1462 | |
43f3e411 | 1463 | /* struct call_site entries for this compilation unit or NULL. */ |
8e3b41a9 | 1464 | htab_t call_site_htab; |
b5b04b5b | 1465 | |
43f3e411 DE |
1466 | /* The macro table for this symtab. Like the blockvector, this |
1467 | is shared between different symtabs in a given compilation unit. | |
1468 | It's debatable whether it *should* be shared among all the symtabs in | |
1469 | the given compilation unit, but it currently is. */ | |
1470 | struct macro_table *macro_table; | |
1471 | ||
b5b04b5b | 1472 | /* If non-NULL, then this points to a NULL-terminated vector of |
43f3e411 DE |
1473 | included compunits. When searching the static or global |
1474 | block of this compunit, the corresponding block of all | |
1475 | included compunits will also be searched. Note that this | |
b5b04b5b TT |
1476 | list must be flattened -- the symbol reader is responsible for |
1477 | ensuring that this vector contains the transitive closure of all | |
43f3e411 DE |
1478 | included compunits. */ |
1479 | struct compunit_symtab **includes; | |
b5b04b5b | 1480 | |
43f3e411 DE |
1481 | /* If this is an included compunit, this points to one includer |
1482 | of the table. This user is considered the canonical compunit | |
1483 | containing this one. An included compunit may itself be | |
b5b04b5b | 1484 | included by another. */ |
43f3e411 | 1485 | struct compunit_symtab *user; |
17c5ed2c | 1486 | }; |
c906108c | 1487 | |
43f3e411 DE |
1488 | #define COMPUNIT_OBJFILE(cust) ((cust)->objfile) |
1489 | #define COMPUNIT_FILETABS(cust) ((cust)->filetabs) | |
1490 | #define COMPUNIT_DEBUGFORMAT(cust) ((cust)->debugformat) | |
1491 | #define COMPUNIT_PRODUCER(cust) ((cust)->producer) | |
1492 | #define COMPUNIT_DIRNAME(cust) ((cust)->dirname) | |
1493 | #define COMPUNIT_BLOCKVECTOR(cust) ((cust)->blockvector) | |
1494 | #define COMPUNIT_BLOCK_LINE_SECTION(cust) ((cust)->block_line_section) | |
1495 | #define COMPUNIT_LOCATIONS_VALID(cust) ((cust)->locations_valid) | |
1496 | #define COMPUNIT_EPILOGUE_UNWIND_VALID(cust) ((cust)->epilogue_unwind_valid) | |
1497 | #define COMPUNIT_CALL_SITE_HTAB(cust) ((cust)->call_site_htab) | |
1498 | #define COMPUNIT_MACRO_TABLE(cust) ((cust)->macro_table) | |
ec94af83 | 1499 | |
5accd1a0 TT |
1500 | /* A range adapter to allowing iterating over all the file tables |
1501 | within a compunit. */ | |
db0fec5c | 1502 | |
5accd1a0 TT |
1503 | struct compunit_filetabs : public next_adapter<struct symtab> |
1504 | { | |
1505 | compunit_filetabs (struct compunit_symtab *cu) | |
1506 | : next_adapter<struct symtab> (cu->filetabs) | |
1507 | { | |
1508 | } | |
1509 | }; | |
43f3e411 DE |
1510 | |
1511 | /* Return the primary symtab of CUST. */ | |
1512 | ||
1513 | extern struct symtab * | |
1514 | compunit_primary_filetab (const struct compunit_symtab *cust); | |
1515 | ||
1516 | /* Return the language of CUST. */ | |
1517 | ||
1518 | extern enum language compunit_language (const struct compunit_symtab *cust); | |
1519 | ||
c906108c | 1520 | \f |
c5aa993b | 1521 | |
c906108c | 1522 | /* The virtual function table is now an array of structures which have the |
a960f249 | 1523 | form { int16 offset, delta; void *pfn; }. |
c906108c SS |
1524 | |
1525 | In normal virtual function tables, OFFSET is unused. | |
1526 | DELTA is the amount which is added to the apparent object's base | |
1527 | address in order to point to the actual object to which the | |
1528 | virtual function should be applied. | |
1529 | PFN is a pointer to the virtual function. | |
1530 | ||
c378eb4e | 1531 | Note that this macro is g++ specific (FIXME). */ |
c5aa993b | 1532 | |
c906108c SS |
1533 | #define VTBL_FNADDR_OFFSET 2 |
1534 | ||
c378eb4e | 1535 | /* External variables and functions for the objects described above. */ |
c906108c | 1536 | |
c378eb4e | 1537 | /* True if we are nested inside psymtab_to_symtab. */ |
c906108c SS |
1538 | |
1539 | extern int currently_reading_symtab; | |
1540 | ||
c906108c SS |
1541 | /* symtab.c lookup functions */ |
1542 | ||
7fc830e2 MK |
1543 | extern const char multiple_symbols_ask[]; |
1544 | extern const char multiple_symbols_all[]; | |
1545 | extern const char multiple_symbols_cancel[]; | |
717d2f5a JB |
1546 | |
1547 | const char *multiple_symbols_select_mode (void); | |
1548 | ||
ececd218 CB |
1549 | bool symbol_matches_domain (enum language symbol_language, |
1550 | domain_enum symbol_domain, | |
1551 | domain_enum domain); | |
4186eb54 | 1552 | |
c378eb4e | 1553 | /* lookup a symbol table by source file name. */ |
c906108c | 1554 | |
1f8cc6db | 1555 | extern struct symtab *lookup_symtab (const char *); |
c906108c | 1556 | |
1993b719 TT |
1557 | /* An object of this type is passed as the 'is_a_field_of_this' |
1558 | argument to lookup_symbol and lookup_symbol_in_language. */ | |
1559 | ||
1560 | struct field_of_this_result | |
1561 | { | |
1562 | /* The type in which the field was found. If this is NULL then the | |
1563 | symbol was not found in 'this'. If non-NULL, then one of the | |
1564 | other fields will be non-NULL as well. */ | |
1565 | ||
1566 | struct type *type; | |
1567 | ||
1568 | /* If the symbol was found as an ordinary field of 'this', then this | |
1569 | is non-NULL and points to the particular field. */ | |
1570 | ||
1571 | struct field *field; | |
1572 | ||
cf901d3b | 1573 | /* If the symbol was found as a function field of 'this', then this |
1993b719 TT |
1574 | is non-NULL and points to the particular field. */ |
1575 | ||
1576 | struct fn_fieldlist *fn_field; | |
1577 | }; | |
1578 | ||
cf901d3b DE |
1579 | /* Find the definition for a specified symbol name NAME |
1580 | in domain DOMAIN in language LANGUAGE, visible from lexical block BLOCK | |
1581 | if non-NULL or from global/static blocks if BLOCK is NULL. | |
1582 | Returns the struct symbol pointer, or NULL if no symbol is found. | |
1583 | C++: if IS_A_FIELD_OF_THIS is non-NULL on entry, check to see if | |
1584 | NAME is a field of the current implied argument `this'. If so fill in the | |
1585 | fields of IS_A_FIELD_OF_THIS, otherwise the fields are set to NULL. | |
cf901d3b | 1586 | The symbol's section is fixed up if necessary. */ |
53c5240f | 1587 | |
d12307c1 PMR |
1588 | extern struct block_symbol |
1589 | lookup_symbol_in_language (const char *, | |
1590 | const struct block *, | |
1591 | const domain_enum, | |
1592 | enum language, | |
1593 | struct field_of_this_result *); | |
53c5240f | 1594 | |
cf901d3b | 1595 | /* Same as lookup_symbol_in_language, but using the current language. */ |
c906108c | 1596 | |
d12307c1 PMR |
1597 | extern struct block_symbol lookup_symbol (const char *, |
1598 | const struct block *, | |
1599 | const domain_enum, | |
1600 | struct field_of_this_result *); | |
c906108c | 1601 | |
de63c46b PA |
1602 | /* Find the definition for a specified symbol search name in domain |
1603 | DOMAIN, visible from lexical block BLOCK if non-NULL or from | |
1604 | global/static blocks if BLOCK is NULL. The passed-in search name | |
1605 | should not come from the user; instead it should already be a | |
987012b8 | 1606 | search name as retrieved from a search_name () call. See definition of |
de63c46b PA |
1607 | symbol_name_match_type::SEARCH_NAME. Returns the struct symbol |
1608 | pointer, or NULL if no symbol is found. The symbol's section is | |
1609 | fixed up if necessary. */ | |
1610 | ||
1611 | extern struct block_symbol lookup_symbol_search_name (const char *search_name, | |
1612 | const struct block *block, | |
1613 | domain_enum domain); | |
1614 | ||
5f9a71c3 | 1615 | /* A default version of lookup_symbol_nonlocal for use by languages |
cf901d3b DE |
1616 | that can't think of anything better to do. |
1617 | This implements the C lookup rules. */ | |
5f9a71c3 | 1618 | |
d12307c1 | 1619 | extern struct block_symbol |
f606139a DE |
1620 | basic_lookup_symbol_nonlocal (const struct language_defn *langdef, |
1621 | const char *, | |
1622 | const struct block *, | |
1623 | const domain_enum); | |
5f9a71c3 DC |
1624 | |
1625 | /* Some helper functions for languages that need to write their own | |
1626 | lookup_symbol_nonlocal functions. */ | |
1627 | ||
1628 | /* Lookup a symbol in the static block associated to BLOCK, if there | |
cf901d3b | 1629 | is one; do nothing if BLOCK is NULL or a global block. |
d12307c1 | 1630 | Upon success fixes up the symbol's section if necessary. */ |
5f9a71c3 | 1631 | |
d12307c1 PMR |
1632 | extern struct block_symbol |
1633 | lookup_symbol_in_static_block (const char *name, | |
1634 | const struct block *block, | |
1635 | const domain_enum domain); | |
5f9a71c3 | 1636 | |
08724ab7 | 1637 | /* Search all static file-level symbols for NAME from DOMAIN. |
d12307c1 | 1638 | Upon success fixes up the symbol's section if necessary. */ |
08724ab7 | 1639 | |
d12307c1 PMR |
1640 | extern struct block_symbol lookup_static_symbol (const char *name, |
1641 | const domain_enum domain); | |
08724ab7 | 1642 | |
cf901d3b | 1643 | /* Lookup a symbol in all files' global blocks. |
67be31e5 DE |
1644 | |
1645 | If BLOCK is non-NULL then it is used for two things: | |
1646 | 1) If a target-specific lookup routine for libraries exists, then use the | |
1647 | routine for the objfile of BLOCK, and | |
1648 | 2) The objfile of BLOCK is used to assist in determining the search order | |
1649 | if the target requires it. | |
1650 | See gdbarch_iterate_over_objfiles_in_search_order. | |
1651 | ||
d12307c1 | 1652 | Upon success fixes up the symbol's section if necessary. */ |
5f9a71c3 | 1653 | |
d12307c1 PMR |
1654 | extern struct block_symbol |
1655 | lookup_global_symbol (const char *name, | |
1656 | const struct block *block, | |
1657 | const domain_enum domain); | |
5f9a71c3 | 1658 | |
d1a2d36d | 1659 | /* Lookup a symbol in block BLOCK. |
d12307c1 | 1660 | Upon success fixes up the symbol's section if necessary. */ |
5f9a71c3 | 1661 | |
d12307c1 PMR |
1662 | extern struct symbol * |
1663 | lookup_symbol_in_block (const char *name, | |
de63c46b | 1664 | symbol_name_match_type match_type, |
d12307c1 PMR |
1665 | const struct block *block, |
1666 | const domain_enum domain); | |
5f9a71c3 | 1667 | |
cf901d3b DE |
1668 | /* Look up the `this' symbol for LANG in BLOCK. Return the symbol if |
1669 | found, or NULL if not found. */ | |
1670 | ||
d12307c1 PMR |
1671 | extern struct block_symbol |
1672 | lookup_language_this (const struct language_defn *lang, | |
1673 | const struct block *block); | |
66a17cb6 | 1674 | |
cf901d3b | 1675 | /* Lookup a [struct, union, enum] by name, within a specified block. */ |
c906108c | 1676 | |
270140bd | 1677 | extern struct type *lookup_struct (const char *, const struct block *); |
c906108c | 1678 | |
270140bd | 1679 | extern struct type *lookup_union (const char *, const struct block *); |
c906108c | 1680 | |
270140bd | 1681 | extern struct type *lookup_enum (const char *, const struct block *); |
c906108c | 1682 | |
c906108c SS |
1683 | /* from blockframe.c: */ |
1684 | ||
cd2bb709 PA |
1685 | /* lookup the function symbol corresponding to the address. The |
1686 | return value will not be an inlined function; the containing | |
1687 | function will be returned instead. */ | |
c906108c | 1688 | |
a14ed312 | 1689 | extern struct symbol *find_pc_function (CORE_ADDR); |
c906108c | 1690 | |
cd2bb709 PA |
1691 | /* lookup the function corresponding to the address and section. The |
1692 | return value will not be an inlined function; the containing | |
1693 | function will be returned instead. */ | |
c906108c | 1694 | |
714835d5 | 1695 | extern struct symbol *find_pc_sect_function (CORE_ADDR, struct obj_section *); |
c5aa993b | 1696 | |
cd2bb709 PA |
1697 | /* lookup the function symbol corresponding to the address and |
1698 | section. The return value will be the closest enclosing function, | |
1699 | which might be an inline function. */ | |
1700 | ||
1701 | extern struct symbol *find_pc_sect_containing_function | |
1702 | (CORE_ADDR pc, struct obj_section *section); | |
1703 | ||
71a3c369 TT |
1704 | /* Find the symbol at the given address. Returns NULL if no symbol |
1705 | found. Only exact matches for ADDRESS are considered. */ | |
1706 | ||
1707 | extern struct symbol *find_symbol_at_address (CORE_ADDR); | |
1708 | ||
fc811edd KB |
1709 | /* Finds the "function" (text symbol) that is smaller than PC but |
1710 | greatest of all of the potential text symbols in SECTION. Sets | |
1711 | *NAME and/or *ADDRESS conditionally if that pointer is non-null. | |
1712 | If ENDADDR is non-null, then set *ENDADDR to be the end of the | |
1713 | function (exclusive). If the optional parameter BLOCK is non-null, | |
1714 | then set *BLOCK to the address of the block corresponding to the | |
1715 | function symbol, if such a symbol could be found during the lookup; | |
1716 | nullptr is used as a return value for *BLOCK if no block is found. | |
1717 | This function either succeeds or fails (not halfway succeeds). If | |
1718 | it succeeds, it sets *NAME, *ADDRESS, and *ENDADDR to real | |
ececd218 CB |
1719 | information and returns true. If it fails, it sets *NAME, *ADDRESS |
1720 | and *ENDADDR to zero and returns false. | |
fc811edd KB |
1721 | |
1722 | If the function in question occupies non-contiguous ranges, | |
1723 | *ADDRESS and *ENDADDR are (subject to the conditions noted above) set | |
1724 | to the start and end of the range in which PC is found. Thus | |
1725 | *ADDRESS <= PC < *ENDADDR with no intervening gaps (in which ranges | |
1726 | from other functions might be found). | |
1727 | ||
1728 | This property allows find_pc_partial_function to be used (as it had | |
1729 | been prior to the introduction of non-contiguous range support) by | |
1730 | various tdep files for finding a start address and limit address | |
1731 | for prologue analysis. This still isn't ideal, however, because we | |
1732 | probably shouldn't be doing prologue analysis (in which | |
1733 | instructions are scanned to determine frame size and stack layout) | |
1734 | for any range that doesn't contain the entry pc. Moreover, a good | |
1735 | argument can be made that prologue analysis ought to be performed | |
1736 | starting from the entry pc even when PC is within some other range. | |
1737 | This might suggest that *ADDRESS and *ENDADDR ought to be set to the | |
1738 | limits of the entry pc range, but that will cause the | |
1739 | *ADDRESS <= PC < *ENDADDR condition to be violated; many of the | |
59adbf5d KB |
1740 | callers of find_pc_partial_function expect this condition to hold. |
1741 | ||
1742 | Callers which require the start and/or end addresses for the range | |
1743 | containing the entry pc should instead call | |
1744 | find_function_entry_range_from_pc. */ | |
fc811edd | 1745 | |
ececd218 CB |
1746 | extern bool find_pc_partial_function (CORE_ADDR pc, const char **name, |
1747 | CORE_ADDR *address, CORE_ADDR *endaddr, | |
1748 | const struct block **block = nullptr); | |
c906108c | 1749 | |
59adbf5d KB |
1750 | /* Like find_pc_partial_function, above, but *ADDRESS and *ENDADDR are |
1751 | set to start and end addresses of the range containing the entry pc. | |
1752 | ||
1753 | Note that it is not necessarily the case that (for non-NULL ADDRESS | |
1754 | and ENDADDR arguments) the *ADDRESS <= PC < *ENDADDR condition will | |
1755 | hold. | |
1756 | ||
1757 | See comment for find_pc_partial_function, above, for further | |
1758 | explanation. */ | |
1759 | ||
1760 | extern bool find_function_entry_range_from_pc (CORE_ADDR pc, | |
1761 | const char **name, | |
1762 | CORE_ADDR *address, | |
1763 | CORE_ADDR *endaddr); | |
1764 | ||
8388016d PA |
1765 | /* Return the type of a function with its first instruction exactly at |
1766 | the PC address. Return NULL otherwise. */ | |
1767 | ||
1768 | extern struct type *find_function_type (CORE_ADDR pc); | |
1769 | ||
1770 | /* See if we can figure out the function's actual type from the type | |
1771 | that the resolver returns. RESOLVER_FUNADDR is the address of the | |
1772 | ifunc resolver. */ | |
1773 | ||
1774 | extern struct type *find_gnu_ifunc_target_type (CORE_ADDR resolver_funaddr); | |
1775 | ||
ca31ab1d PA |
1776 | /* Find the GNU ifunc minimal symbol that matches SYM. */ |
1777 | extern bound_minimal_symbol find_gnu_ifunc (const symbol *sym); | |
1778 | ||
a14ed312 | 1779 | extern void clear_pc_function_cache (void); |
c906108c | 1780 | |
2097ae25 | 1781 | /* Expand symtab containing PC, SECTION if not already expanded. */ |
c906108c | 1782 | |
2097ae25 | 1783 | extern void expand_symtab_containing_pc (CORE_ADDR, struct obj_section *); |
c906108c | 1784 | |
c378eb4e | 1785 | /* lookup full symbol table by address. */ |
c906108c | 1786 | |
43f3e411 | 1787 | extern struct compunit_symtab *find_pc_compunit_symtab (CORE_ADDR); |
c906108c | 1788 | |
c378eb4e | 1789 | /* lookup full symbol table by address and section. */ |
c906108c | 1790 | |
43f3e411 DE |
1791 | extern struct compunit_symtab * |
1792 | find_pc_sect_compunit_symtab (CORE_ADDR, struct obj_section *); | |
c906108c | 1793 | |
ececd218 | 1794 | extern bool find_pc_line_pc_range (CORE_ADDR, CORE_ADDR *, CORE_ADDR *); |
c906108c | 1795 | |
a14ed312 | 1796 | extern void reread_symbols (void); |
c906108c | 1797 | |
cf901d3b DE |
1798 | /* Look up a type named NAME in STRUCT_DOMAIN in the current language. |
1799 | The type returned must not be opaque -- i.e., must have at least one field | |
1800 | defined. */ | |
1801 | ||
a14ed312 | 1802 | extern struct type *lookup_transparent_type (const char *); |
c906108c | 1803 | |
cf901d3b | 1804 | extern struct type *basic_lookup_transparent_type (const char *); |
c906108c | 1805 | |
c378eb4e | 1806 | /* Macro for name of symbol to indicate a file compiled with gcc. */ |
c906108c SS |
1807 | #ifndef GCC_COMPILED_FLAG_SYMBOL |
1808 | #define GCC_COMPILED_FLAG_SYMBOL "gcc_compiled." | |
1809 | #endif | |
1810 | ||
c378eb4e | 1811 | /* Macro for name of symbol to indicate a file compiled with gcc2. */ |
c906108c SS |
1812 | #ifndef GCC2_COMPILED_FLAG_SYMBOL |
1813 | #define GCC2_COMPILED_FLAG_SYMBOL "gcc2_compiled." | |
1814 | #endif | |
1815 | ||
ececd218 | 1816 | extern bool in_gnu_ifunc_stub (CORE_ADDR pc); |
0875794a | 1817 | |
07be84bf JK |
1818 | /* Functions for resolving STT_GNU_IFUNC symbols which are implemented only |
1819 | for ELF symbol files. */ | |
1820 | ||
1821 | struct gnu_ifunc_fns | |
1822 | { | |
1823 | /* See elf_gnu_ifunc_resolve_addr for its real implementation. */ | |
1824 | CORE_ADDR (*gnu_ifunc_resolve_addr) (struct gdbarch *gdbarch, CORE_ADDR pc); | |
1825 | ||
1826 | /* See elf_gnu_ifunc_resolve_name for its real implementation. */ | |
ececd218 | 1827 | bool (*gnu_ifunc_resolve_name) (const char *function_name, |
07be84bf | 1828 | CORE_ADDR *function_address_p); |
0e30163f JK |
1829 | |
1830 | /* See elf_gnu_ifunc_resolver_stop for its real implementation. */ | |
1831 | void (*gnu_ifunc_resolver_stop) (struct breakpoint *b); | |
1832 | ||
1833 | /* See elf_gnu_ifunc_resolver_return_stop for its real implementation. */ | |
1834 | void (*gnu_ifunc_resolver_return_stop) (struct breakpoint *b); | |
07be84bf JK |
1835 | }; |
1836 | ||
1837 | #define gnu_ifunc_resolve_addr gnu_ifunc_fns_p->gnu_ifunc_resolve_addr | |
1838 | #define gnu_ifunc_resolve_name gnu_ifunc_fns_p->gnu_ifunc_resolve_name | |
0e30163f JK |
1839 | #define gnu_ifunc_resolver_stop gnu_ifunc_fns_p->gnu_ifunc_resolver_stop |
1840 | #define gnu_ifunc_resolver_return_stop \ | |
1841 | gnu_ifunc_fns_p->gnu_ifunc_resolver_return_stop | |
07be84bf JK |
1842 | |
1843 | extern const struct gnu_ifunc_fns *gnu_ifunc_fns_p; | |
1844 | ||
52f729a7 | 1845 | extern CORE_ADDR find_solib_trampoline_target (struct frame_info *, CORE_ADDR); |
c906108c | 1846 | |
c906108c | 1847 | struct symtab_and_line |
17c5ed2c | 1848 | { |
6c95b8df | 1849 | /* The program space of this sal. */ |
51abb421 | 1850 | struct program_space *pspace = NULL; |
6c95b8df | 1851 | |
51abb421 | 1852 | struct symtab *symtab = NULL; |
06871ae8 | 1853 | struct symbol *symbol = NULL; |
51abb421 | 1854 | struct obj_section *section = NULL; |
3467ec66 | 1855 | struct minimal_symbol *msymbol = NULL; |
17c5ed2c DC |
1856 | /* Line number. Line numbers start at 1 and proceed through symtab->nlines. |
1857 | 0 is never a valid line number; it is used to indicate that line number | |
1858 | information is not available. */ | |
51abb421 | 1859 | int line = 0; |
17c5ed2c | 1860 | |
51abb421 PA |
1861 | CORE_ADDR pc = 0; |
1862 | CORE_ADDR end = 0; | |
1863 | bool explicit_pc = false; | |
1864 | bool explicit_line = false; | |
55aa24fb SDJ |
1865 | |
1866 | /* The probe associated with this symtab_and_line. */ | |
935676c9 | 1867 | probe *prob = NULL; |
729662a5 TT |
1868 | /* If PROBE is not NULL, then this is the objfile in which the probe |
1869 | originated. */ | |
51abb421 | 1870 | struct objfile *objfile = NULL; |
17c5ed2c | 1871 | }; |
c906108c | 1872 | |
c5aa993b | 1873 | \f |
c906108c | 1874 | |
c906108c SS |
1875 | /* Given a pc value, return line number it is in. Second arg nonzero means |
1876 | if pc is on the boundary use the previous statement's line number. */ | |
1877 | ||
a14ed312 | 1878 | extern struct symtab_and_line find_pc_line (CORE_ADDR, int); |
c906108c | 1879 | |
c378eb4e | 1880 | /* Same function, but specify a section as well as an address. */ |
c906108c | 1881 | |
714835d5 UW |
1882 | extern struct symtab_and_line find_pc_sect_line (CORE_ADDR, |
1883 | struct obj_section *, int); | |
c906108c | 1884 | |
34248c3a DE |
1885 | /* Wrapper around find_pc_line to just return the symtab. */ |
1886 | ||
1887 | extern struct symtab *find_pc_line_symtab (CORE_ADDR); | |
1888 | ||
c906108c SS |
1889 | /* Given a symtab and line number, return the pc there. */ |
1890 | ||
ececd218 | 1891 | extern bool find_line_pc (struct symtab *, int, CORE_ADDR *); |
c906108c | 1892 | |
ececd218 CB |
1893 | extern bool find_line_pc_range (struct symtab_and_line, CORE_ADDR *, |
1894 | CORE_ADDR *); | |
c906108c | 1895 | |
a14ed312 | 1896 | extern void resolve_sal_pc (struct symtab_and_line *); |
c906108c | 1897 | |
f176c4b5 | 1898 | /* solib.c */ |
c906108c | 1899 | |
a14ed312 | 1900 | extern void clear_solib (void); |
c906108c | 1901 | |
c6756f62 PA |
1902 | /* The reason we're calling into a completion match list collector |
1903 | function. */ | |
1904 | enum class complete_symbol_mode | |
1905 | { | |
1906 | /* Completing an expression. */ | |
1907 | EXPRESSION, | |
1908 | ||
1909 | /* Completing a linespec. */ | |
1910 | LINESPEC, | |
1911 | }; | |
1912 | ||
eb3ff9a5 PA |
1913 | extern void default_collect_symbol_completion_matches_break_on |
1914 | (completion_tracker &tracker, | |
c6756f62 | 1915 | complete_symbol_mode mode, |
b5ec771e | 1916 | symbol_name_match_type name_match_type, |
eb3ff9a5 | 1917 | const char *text, const char *word, const char *break_on, |
2f68a895 | 1918 | enum type_code code); |
eb3ff9a5 PA |
1919 | extern void default_collect_symbol_completion_matches |
1920 | (completion_tracker &tracker, | |
c6756f62 | 1921 | complete_symbol_mode, |
b5ec771e | 1922 | symbol_name_match_type name_match_type, |
eb3ff9a5 PA |
1923 | const char *, |
1924 | const char *, | |
1925 | enum type_code); | |
b5ec771e PA |
1926 | extern void collect_symbol_completion_matches |
1927 | (completion_tracker &tracker, | |
1928 | complete_symbol_mode mode, | |
1929 | symbol_name_match_type name_match_type, | |
1930 | const char *, const char *); | |
eb3ff9a5 PA |
1931 | extern void collect_symbol_completion_matches_type (completion_tracker &tracker, |
1932 | const char *, const char *, | |
2f68a895 | 1933 | enum type_code); |
c906108c | 1934 | |
b5ec771e PA |
1935 | extern void collect_file_symbol_completion_matches |
1936 | (completion_tracker &tracker, | |
1937 | complete_symbol_mode, | |
1938 | symbol_name_match_type name_match_type, | |
1939 | const char *, const char *, const char *); | |
c94fdfd0 | 1940 | |
eb3ff9a5 PA |
1941 | extern completion_list |
1942 | make_source_files_completion_list (const char *, const char *); | |
c94fdfd0 | 1943 | |
f9d67a22 PA |
1944 | /* Return whether SYM is a function/method, as opposed to a data symbol. */ |
1945 | ||
1946 | extern bool symbol_is_function_or_method (symbol *sym); | |
1947 | ||
1948 | /* Return whether MSYMBOL is a function/method, as opposed to a data | |
1949 | symbol */ | |
1950 | ||
1951 | extern bool symbol_is_function_or_method (minimal_symbol *msymbol); | |
1952 | ||
1953 | /* Return whether SYM should be skipped in completion mode MODE. In | |
1954 | linespec mode, we're only interested in functions/methods. */ | |
1955 | ||
1956 | template<typename Symbol> | |
1957 | static bool | |
1958 | completion_skip_symbol (complete_symbol_mode mode, Symbol *sym) | |
1959 | { | |
1960 | return (mode == complete_symbol_mode::LINESPEC | |
1961 | && !symbol_is_function_or_method (sym)); | |
1962 | } | |
1963 | ||
c906108c SS |
1964 | /* symtab.c */ |
1965 | ||
ececd218 | 1966 | bool matching_obj_sections (struct obj_section *, struct obj_section *); |
94277a38 | 1967 | |
ececd218 | 1968 | extern struct symtab *find_line_symtab (struct symtab *, int, int *, bool *); |
50641945 | 1969 | |
42ddae10 PA |
1970 | /* Given a function symbol SYM, find the symtab and line for the start |
1971 | of the function. If FUNFIRSTLINE is true, we want the first line | |
1972 | of real code inside the function. */ | |
1973 | extern symtab_and_line find_function_start_sal (symbol *sym, bool | |
1974 | funfirstline); | |
1975 | ||
1976 | /* Same, but start with a function address/section instead of a | |
1977 | symbol. */ | |
1978 | extern symtab_and_line find_function_start_sal (CORE_ADDR func_addr, | |
1979 | obj_section *section, | |
1980 | bool funfirstline); | |
50641945 | 1981 | |
059acae7 UW |
1982 | extern void skip_prologue_sal (struct symtab_and_line *); |
1983 | ||
c906108c SS |
1984 | /* symtab.c */ |
1985 | ||
d80b854b UW |
1986 | extern CORE_ADDR skip_prologue_using_sal (struct gdbarch *gdbarch, |
1987 | CORE_ADDR func_addr); | |
634aa483 | 1988 | |
a14ed312 KB |
1989 | extern struct symbol *fixup_symbol_section (struct symbol *, |
1990 | struct objfile *); | |
c906108c | 1991 | |
bf223d3e PA |
1992 | /* If MSYMBOL is an text symbol, look for a function debug symbol with |
1993 | the same address. Returns NULL if not found. This is necessary in | |
1994 | case a function is an alias to some other function, because debug | |
1995 | information is only emitted for the alias target function's | |
1996 | definition, not for the alias. */ | |
1997 | extern symbol *find_function_alias_target (bound_minimal_symbol msymbol); | |
1998 | ||
c906108c | 1999 | /* Symbol searching */ |
5c04624b DE |
2000 | /* Note: struct symbol_search, search_symbols, et.al. are declared here, |
2001 | instead of making them local to symtab.c, for gdbtk's sake. */ | |
c906108c | 2002 | |
b9c04fb2 TT |
2003 | /* When using search_symbols, a vector of the following structs is |
2004 | returned. */ | |
c906108c | 2005 | struct symbol_search |
17c5ed2c | 2006 | { |
b9c04fb2 TT |
2007 | symbol_search (int block_, struct symbol *symbol_) |
2008 | : block (block_), | |
2009 | symbol (symbol_) | |
2010 | { | |
2011 | msymbol.minsym = nullptr; | |
2012 | msymbol.objfile = nullptr; | |
2013 | } | |
2014 | ||
2015 | symbol_search (int block_, struct minimal_symbol *minsym, | |
2016 | struct objfile *objfile) | |
2017 | : block (block_), | |
2018 | symbol (nullptr) | |
2019 | { | |
2020 | msymbol.minsym = minsym; | |
2021 | msymbol.objfile = objfile; | |
2022 | } | |
2023 | ||
2024 | bool operator< (const symbol_search &other) const | |
2025 | { | |
2026 | return compare_search_syms (*this, other) < 0; | |
2027 | } | |
2028 | ||
2029 | bool operator== (const symbol_search &other) const | |
2030 | { | |
2031 | return compare_search_syms (*this, other) == 0; | |
2032 | } | |
2033 | ||
c378eb4e MS |
2034 | /* The block in which the match was found. Could be, for example, |
2035 | STATIC_BLOCK or GLOBAL_BLOCK. */ | |
17c5ed2c | 2036 | int block; |
c906108c | 2037 | |
17c5ed2c | 2038 | /* Information describing what was found. |
c906108c | 2039 | |
d01060f0 | 2040 | If symbol is NOT NULL, then information was found for this match. */ |
17c5ed2c | 2041 | struct symbol *symbol; |
c906108c | 2042 | |
17c5ed2c | 2043 | /* If msymbol is non-null, then a match was made on something for |
c378eb4e | 2044 | which only minimal_symbols exist. */ |
7c7b6655 | 2045 | struct bound_minimal_symbol msymbol; |
c906108c | 2046 | |
b9c04fb2 TT |
2047 | private: |
2048 | ||
2049 | static int compare_search_syms (const symbol_search &sym_a, | |
2050 | const symbol_search &sym_b); | |
17c5ed2c | 2051 | }; |
c906108c | 2052 | |
b9c04fb2 | 2053 | extern std::vector<symbol_search> search_symbols (const char *, |
12615cba PW |
2054 | enum search_domain, |
2055 | const char *, | |
2056 | int, | |
4acfdd20 AB |
2057 | const char **, |
2058 | bool); | |
165f8965 AB |
2059 | |
2060 | /* When searching for Fortran symbols within modules (functions/variables) | |
2061 | we return a vector of this type. The first item in the pair is the | |
2062 | module symbol, and the second item is the symbol for the function or | |
2063 | variable we found. */ | |
2064 | typedef std::pair<symbol_search, symbol_search> module_symbol_search; | |
2065 | ||
2066 | /* Searches the symbols to find function and variables symbols (depending | |
2067 | on KIND) within Fortran modules. The MODULE_REGEXP matches against the | |
2068 | name of the module, REGEXP matches against the name of the symbol within | |
2069 | the module, and TYPE_REGEXP matches against the type of the symbol | |
2070 | within the module. */ | |
2071 | extern std::vector<module_symbol_search> search_module_symbols | |
2072 | (const char *module_regexp, const char *regexp, | |
2073 | const char *type_regexp, search_domain kind); | |
2074 | ||
12615cba PW |
2075 | extern bool treg_matches_sym_type_name (const compiled_regex &treg, |
2076 | const struct symbol *sym); | |
c906108c | 2077 | |
cd215b2e TT |
2078 | /* The name of the ``main'' function. */ |
2079 | extern const char *main_name (); | |
9e6c82ad | 2080 | extern enum language main_language (void); |
51cc5b07 | 2081 | |
442853af CB |
2082 | /* Lookup symbol NAME from DOMAIN in MAIN_OBJFILE's global or static blocks, |
2083 | as specified by BLOCK_INDEX. | |
cf901d3b DE |
2084 | This searches MAIN_OBJFILE as well as any associated separate debug info |
2085 | objfiles of MAIN_OBJFILE. | |
442853af | 2086 | BLOCK_INDEX can be GLOBAL_BLOCK or STATIC_BLOCK. |
d12307c1 | 2087 | Upon success fixes up the symbol's section if necessary. */ |
cf901d3b | 2088 | |
d12307c1 | 2089 | extern struct block_symbol |
efad9b6a | 2090 | lookup_global_symbol_from_objfile (struct objfile *main_objfile, |
442853af | 2091 | enum block_enum block_index, |
cf901d3b DE |
2092 | const char *name, |
2093 | const domain_enum domain); | |
3a40aaa0 | 2094 | |
a6c727b2 DJ |
2095 | /* Return 1 if the supplied producer string matches the ARM RealView |
2096 | compiler (armcc). */ | |
ececd218 | 2097 | bool producer_is_realview (const char *producer); |
3a40aaa0 | 2098 | |
ccefe4c4 TT |
2099 | void fixup_section (struct general_symbol_info *ginfo, |
2100 | CORE_ADDR addr, struct objfile *objfile); | |
2101 | ||
cf901d3b DE |
2102 | /* Look up objfile containing BLOCK. */ |
2103 | ||
c0201579 JK |
2104 | struct objfile *lookup_objfile_from_block (const struct block *block); |
2105 | ||
db0fec5c | 2106 | extern unsigned int symtab_create_debug; |
45cfd468 | 2107 | |
cc485e62 DE |
2108 | extern unsigned int symbol_lookup_debug; |
2109 | ||
491144b5 | 2110 | extern bool basenames_may_differ; |
c011a4f4 | 2111 | |
ececd218 CB |
2112 | bool compare_filenames_for_search (const char *filename, |
2113 | const char *search_name); | |
4aac40c8 | 2114 | |
ececd218 CB |
2115 | bool compare_glob_filenames_for_search (const char *filename, |
2116 | const char *search_name); | |
cce0e923 | 2117 | |
14bc53a8 PA |
2118 | bool iterate_over_some_symtabs (const char *name, |
2119 | const char *real_path, | |
2120 | struct compunit_symtab *first, | |
2121 | struct compunit_symtab *after_last, | |
2122 | gdb::function_view<bool (symtab *)> callback); | |
f8eba3c6 TT |
2123 | |
2124 | void iterate_over_symtabs (const char *name, | |
14bc53a8 PA |
2125 | gdb::function_view<bool (symtab *)> callback); |
2126 | ||
f8eba3c6 | 2127 | |
67d89901 TT |
2128 | std::vector<CORE_ADDR> find_pcs_for_symtab_line |
2129 | (struct symtab *symtab, int line, struct linetable_entry **best_entry); | |
f8eba3c6 | 2130 | |
14bc53a8 PA |
2131 | /* Prototype for callbacks for LA_ITERATE_OVER_SYMBOLS. The callback |
2132 | is called once per matching symbol SYM. The callback should return | |
2133 | true to indicate that LA_ITERATE_OVER_SYMBOLS should continue | |
2134 | iterating, or false to indicate that the iteration should end. */ | |
8e704927 | 2135 | |
7e41c8db | 2136 | typedef bool (symbol_found_callback_ftype) (struct block_symbol *bsym); |
8e704927 | 2137 | |
6969f124 TT |
2138 | /* Iterate over the symbols named NAME, matching DOMAIN, in BLOCK. |
2139 | ||
2140 | For each symbol that matches, CALLBACK is called. The symbol is | |
2141 | passed to the callback. | |
2142 | ||
2143 | If CALLBACK returns false, the iteration ends and this function | |
2144 | returns false. Otherwise, the search continues, and the function | |
2145 | eventually returns true. */ | |
2146 | ||
2147 | bool iterate_over_symbols (const struct block *block, | |
b5ec771e | 2148 | const lookup_name_info &name, |
f8eba3c6 | 2149 | const domain_enum domain, |
14bc53a8 | 2150 | gdb::function_view<symbol_found_callback_ftype> callback); |
f8eba3c6 | 2151 | |
6a3dbf1b TT |
2152 | /* Like iterate_over_symbols, but if all calls to CALLBACK return |
2153 | true, then calls CALLBACK one additional time with a block_symbol | |
2154 | that has a valid block but a NULL symbol. */ | |
2155 | ||
2156 | bool iterate_over_symbols_terminated | |
2157 | (const struct block *block, | |
2158 | const lookup_name_info &name, | |
2159 | const domain_enum domain, | |
2160 | gdb::function_view<symbol_found_callback_ftype> callback); | |
2161 | ||
2f408ecb PA |
2162 | /* Storage type used by demangle_for_lookup. demangle_for_lookup |
2163 | either returns a const char * pointer that points to either of the | |
2164 | fields of this type, or a pointer to the input NAME. This is done | |
2165 | this way because the underlying functions that demangle_for_lookup | |
2166 | calls either return a std::string (e.g., cp_canonicalize_string) or | |
2167 | a malloc'ed buffer (libiberty's demangled), and we want to avoid | |
2168 | unnecessary reallocation/string copying. */ | |
2169 | class demangle_result_storage | |
2170 | { | |
2171 | public: | |
2172 | ||
2173 | /* Swap the std::string storage with STR, and return a pointer to | |
2174 | the beginning of the new string. */ | |
2175 | const char *swap_string (std::string &str) | |
2176 | { | |
2177 | std::swap (m_string, str); | |
2178 | return m_string.c_str (); | |
2179 | } | |
2180 | ||
2181 | /* Set the malloc storage to now point at PTR. Any previous malloc | |
2182 | storage is released. */ | |
2183 | const char *set_malloc_ptr (char *ptr) | |
2184 | { | |
2185 | m_malloc.reset (ptr); | |
2186 | return ptr; | |
2187 | } | |
2188 | ||
2189 | private: | |
2190 | ||
2191 | /* The storage. */ | |
2192 | std::string m_string; | |
2193 | gdb::unique_xmalloc_ptr<char> m_malloc; | |
2194 | }; | |
2195 | ||
2196 | const char * | |
2197 | demangle_for_lookup (const char *name, enum language lang, | |
2198 | demangle_result_storage &storage); | |
f8eba3c6 | 2199 | |
e623cf5d TT |
2200 | struct symbol *allocate_symbol (struct objfile *); |
2201 | ||
38bf1463 | 2202 | void initialize_objfile_symbol (struct symbol *); |
e623cf5d TT |
2203 | |
2204 | struct template_symbol *allocate_template_symbol (struct objfile *); | |
2205 | ||
b5ec771e PA |
2206 | /* Test to see if the symbol of language SYMBOL_LANGUAGE specified by |
2207 | SYMNAME (which is already demangled for C++ symbols) matches | |
2208 | SYM_TEXT in the first SYM_TEXT_LEN characters. If so, add it to | |
2209 | the current completion list. */ | |
2210 | void completion_list_add_name (completion_tracker &tracker, | |
2211 | language symbol_language, | |
2212 | const char *symname, | |
2213 | const lookup_name_info &lookup_name, | |
b5ec771e PA |
2214 | const char *text, const char *word); |
2215 | ||
fcaad03c KS |
2216 | /* A simple symbol searching class. */ |
2217 | ||
2218 | class symbol_searcher | |
2219 | { | |
2220 | public: | |
2221 | /* Returns the symbols found for the search. */ | |
2222 | const std::vector<block_symbol> & | |
2223 | matching_symbols () const | |
2224 | { | |
2225 | return m_symbols; | |
2226 | } | |
2227 | ||
2228 | /* Returns the minimal symbols found for the search. */ | |
2229 | const std::vector<bound_minimal_symbol> & | |
2230 | matching_msymbols () const | |
2231 | { | |
2232 | return m_minimal_symbols; | |
2233 | } | |
2234 | ||
2235 | /* Search for all symbols named NAME in LANGUAGE with DOMAIN, restricting | |
2236 | search to FILE_SYMTABS and SEARCH_PSPACE, both of which may be NULL | |
2237 | to search all symtabs and program spaces. */ | |
2238 | void find_all_symbols (const std::string &name, | |
2239 | const struct language_defn *language, | |
2240 | enum search_domain search_domain, | |
2241 | std::vector<symtab *> *search_symtabs, | |
2242 | struct program_space *search_pspace); | |
2243 | ||
2244 | /* Reset this object to perform another search. */ | |
2245 | void reset () | |
2246 | { | |
2247 | m_symbols.clear (); | |
2248 | m_minimal_symbols.clear (); | |
2249 | } | |
2250 | ||
2251 | private: | |
2252 | /* Matching debug symbols. */ | |
2253 | std::vector<block_symbol> m_symbols; | |
2254 | ||
2255 | /* Matching non-debug symbols. */ | |
2256 | std::vector<bound_minimal_symbol> m_minimal_symbols; | |
2257 | }; | |
2258 | ||
c906108c | 2259 | #endif /* !defined(SYMTAB_H) */ |