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