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