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