1 /* Symbol table definitions for GDB.
3 Copyright (C) 1986-2018 Free Software Foundation, Inc.
5 This file is part of GDB.
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
9 the Free Software Foundation; either version 3 of the License, or
10 (at your option) any later version.
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.
17 You should have received a copy of the GNU General Public License
18 along with this program. If not, see <http://www.gnu.org/licenses/>. */
20 #if !defined (SYMTAB_H)
28 #include "common/enum-flags.h"
29 #include "common/function-view.h"
30 #include "common/gdb_optional.h"
31 #include "completer.h"
33 /* Opaque declarations. */
47 struct cmd_list_element;
49 struct lookup_name_info;
51 /* How to match a lookup name against a symbol search name. */
52 enum class symbol_name_match_type
54 /* Wild matching. Matches unqualified symbol names in all
55 namespace/module/packages, etc. */
58 /* Full matching. The lookup name indicates a fully-qualified name,
59 and only matches symbol search names in the specified
60 namespace/module/package. */
63 /* Search name matching. This is like FULL, but the search name did
64 not come from the user; instead it is already a search name
65 retrieved from a SYMBOL_SEARCH_NAME/MSYMBOL_SEARCH_NAME call.
66 For Ada, this avoids re-encoding an already-encoded search name
67 (which would potentially incorrectly lowercase letters in the
68 linkage/search name that should remain uppercase). For C++, it
69 avoids trying to demangle a name we already know is
73 /* Expression matching. The same as FULL matching in most
74 languages. The same as WILD matching in Ada. */
78 /* Hash the given symbol search name according to LANGUAGE's
80 extern unsigned int search_name_hash (enum language language,
81 const char *search_name);
83 /* Ada-specific bits of a lookup_name_info object. This is lazily
84 constructed on demand. */
86 class ada_lookup_name_info final
90 explicit ada_lookup_name_info (const lookup_name_info &lookup_name);
92 /* Compare SYMBOL_SEARCH_NAME with our lookup name, using MATCH_TYPE
93 as name match type. Returns true if there's a match, false
94 otherwise. If non-NULL, store the matching results in MATCH. */
95 bool matches (const char *symbol_search_name,
96 symbol_name_match_type match_type,
97 completion_match_result *comp_match_res) const;
99 /* The Ada-encoded lookup name. */
100 const std::string &lookup_name () const
101 { return m_encoded_name; }
103 /* Return true if we're supposed to be doing a wild match look
105 bool wild_match_p () const
106 { return m_wild_match_p; }
108 /* Return true if we're looking up a name inside package
110 bool standard_p () const
111 { return m_standard_p; }
113 /* Return true if doing a verbatim match. */
114 bool verbatim_p () const
115 { return m_verbatim_p; }
118 /* The Ada-encoded lookup name. */
119 std::string m_encoded_name;
121 /* Whether the user-provided lookup name was Ada encoded. If so,
122 then return encoded names in the 'matches' method's 'completion
123 match result' output. */
124 bool m_encoded_p : 1;
126 /* True if really doing wild matching. Even if the user requests
127 wild matching, some cases require full matching. */
128 bool m_wild_match_p : 1;
130 /* True if doing a verbatim match. This is true if the decoded
131 version of the symbol name is wrapped in '<'/'>'. This is an
132 escape hatch users can use to look up symbols the Ada encoding
133 does not understand. */
134 bool m_verbatim_p : 1;
136 /* True if the user specified a symbol name that is inside package
137 Standard. Symbol names inside package Standard are handled
138 specially. We always do a non-wild match of the symbol name
139 without the "standard__" prefix, and only search static and
140 global symbols. This was primarily introduced in order to allow
141 the user to specifically access the standard exceptions using,
142 for instance, Standard.Constraint_Error when Constraint_Error is
143 ambiguous (due to the user defining its own Constraint_Error
144 entity inside its program). */
145 bool m_standard_p : 1;
148 /* Language-specific bits of a lookup_name_info object, for languages
149 that do name searching using demangled names (C++/D/Go). This is
150 lazily constructed on demand. */
152 struct demangle_for_lookup_info final
155 demangle_for_lookup_info (const lookup_name_info &lookup_name,
158 /* The demangled lookup name. */
159 const std::string &lookup_name () const
160 { return m_demangled_name; }
163 /* The demangled lookup name. */
164 std::string m_demangled_name;
167 /* Object that aggregates all information related to a symbol lookup
168 name. I.e., the name that is matched against the symbol's search
169 name. Caches per-language information so that it doesn't require
170 recomputing it for every symbol comparison, like for example the
171 Ada encoded name and the symbol's name hash for a given language.
172 The object is conceptually immutable once constructed, and thus has
173 no setters. This is to prevent some code path from tweaking some
174 property of the lookup name for some local reason and accidentally
175 altering the results of any continuing search(es).
176 lookup_name_info objects are generally passed around as a const
177 reference to reinforce that. (They're not passed around by value
178 because they're not small.) */
179 class lookup_name_info final
182 /* Create a new object. */
183 lookup_name_info (std::string name,
184 symbol_name_match_type match_type,
185 bool completion_mode = false,
186 bool ignore_parameters = false)
187 : m_match_type (match_type),
188 m_completion_mode (completion_mode),
189 m_ignore_parameters (ignore_parameters),
190 m_name (std::move (name))
193 /* Getters. See description of each corresponding field. */
194 symbol_name_match_type match_type () const { return m_match_type; }
195 bool completion_mode () const { return m_completion_mode; }
196 const std::string &name () const { return m_name; }
197 const bool ignore_parameters () const { return m_ignore_parameters; }
199 /* Return a version of this lookup name that is usable with
200 comparisons against symbols have no parameter info, such as
201 psymbols and GDB index symbols. */
202 lookup_name_info make_ignore_params () const
204 return lookup_name_info (m_name, m_match_type, m_completion_mode,
205 true /* ignore params */);
208 /* Get the search name hash for searches in language LANG. */
209 unsigned int search_name_hash (language lang) const
211 /* Only compute each language's hash once. */
212 if (!m_demangled_hashes_p[lang])
214 m_demangled_hashes[lang]
215 = ::search_name_hash (lang, language_lookup_name (lang).c_str ());
216 m_demangled_hashes_p[lang] = true;
218 return m_demangled_hashes[lang];
221 /* Get the search name for searches in language LANG. */
222 const std::string &language_lookup_name (language lang) const
227 return ada ().lookup_name ();
229 return cplus ().lookup_name ();
231 return d ().lookup_name ();
233 return go ().lookup_name ();
239 /* Get the Ada-specific lookup info. */
240 const ada_lookup_name_info &ada () const
246 /* Get the C++-specific lookup info. */
247 const demangle_for_lookup_info &cplus () const
249 maybe_init (m_cplus, language_cplus);
253 /* Get the D-specific lookup info. */
254 const demangle_for_lookup_info &d () const
256 maybe_init (m_d, language_d);
260 /* Get the Go-specific lookup info. */
261 const demangle_for_lookup_info &go () const
263 maybe_init (m_go, language_go);
267 /* Get a reference to a lookup_name_info object that matches any
269 static const lookup_name_info &match_any ();
272 /* Initialize FIELD, if not initialized yet. */
273 template<typename Field, typename... Args>
274 void maybe_init (Field &field, Args&&... args) const
277 field.emplace (*this, std::forward<Args> (args)...);
280 /* The lookup info as passed to the ctor. */
281 symbol_name_match_type m_match_type;
282 bool m_completion_mode;
283 bool m_ignore_parameters;
286 /* Language-specific info. These fields are filled lazily the first
287 time a lookup is done in the corresponding language. They're
288 mutable because lookup_name_info objects are typically passed
289 around by const reference (see intro), and they're conceptually
290 "cache" that can always be reconstructed from the non-mutable
292 mutable gdb::optional<ada_lookup_name_info> m_ada;
293 mutable gdb::optional<demangle_for_lookup_info> m_cplus;
294 mutable gdb::optional<demangle_for_lookup_info> m_d;
295 mutable gdb::optional<demangle_for_lookup_info> m_go;
297 /* The demangled hashes. Stored in an array with one entry for each
298 possible language. The second array records whether we've
299 already computed the each language's hash. (These are separate
300 arrays instead of a single array of optional<unsigned> to avoid
301 alignment padding). */
302 mutable std::array<unsigned int, nr_languages> m_demangled_hashes;
303 mutable std::array<bool, nr_languages> m_demangled_hashes_p {};
306 /* Comparison function for completion symbol lookup.
308 Returns true if the symbol name matches against LOOKUP_NAME.
310 SYMBOL_SEARCH_NAME should be a symbol's "search" name.
312 On success and if non-NULL, COMP_MATCH_RES->match is set to point
313 to the symbol name as should be presented to the user as a
314 completion match list element. In most languages, this is the same
315 as the symbol's search name, but in some, like Ada, the display
316 name is dynamically computed within the comparison routine.
318 Also, on success and if non-NULL, COMP_MATCH_RES->match_for_lcd
319 points the part of SYMBOL_SEARCH_NAME that was considered to match
320 LOOKUP_NAME. E.g., in C++, in linespec/wild mode, if the symbol is
321 "foo::function()" and LOOKUP_NAME is "function(", MATCH_FOR_LCD
322 points to "function()" inside SYMBOL_SEARCH_NAME. */
323 typedef bool (symbol_name_matcher_ftype)
324 (const char *symbol_search_name,
325 const lookup_name_info &lookup_name,
326 completion_match_result *comp_match_res);
328 /* Some of the structures in this file are space critical.
329 The space-critical structures are:
331 struct general_symbol_info
333 struct partial_symbol
335 These structures are laid out to encourage good packing.
336 They use ENUM_BITFIELD and short int fields, and they order the
337 structure members so that fields less than a word are next
338 to each other so they can be packed together. */
340 /* Rearranged: used ENUM_BITFIELD and rearranged field order in
341 all the space critical structures (plus struct minimal_symbol).
342 Memory usage dropped from 99360768 bytes to 90001408 bytes.
343 I measured this with before-and-after tests of
344 "HEAD-old-gdb -readnow HEAD-old-gdb" and
345 "HEAD-new-gdb -readnow HEAD-old-gdb" on native i686-pc-linux-gnu,
346 red hat linux 8, with LD_LIBRARY_PATH=/usr/lib/debug,
347 typing "maint space 1" at the first command prompt.
349 Here is another measurement (from andrew c):
350 # no /usr/lib/debug, just plain glibc, like a normal user
352 (gdb) break internal_error
354 (gdb) maint internal-error
358 gdb gdb_6_0_branch 2003-08-19 space used: 8896512
359 gdb HEAD 2003-08-19 space used: 8904704
360 gdb HEAD 2003-08-21 space used: 8396800 (+symtab.h)
361 gdb HEAD 2003-08-21 space used: 8265728 (+gdbtypes.h)
363 The third line shows the savings from the optimizations in symtab.h.
364 The fourth line shows the savings from the optimizations in
365 gdbtypes.h. Both optimizations are in gdb HEAD now.
367 --chastain 2003-08-21 */
369 /* Define a structure for the information that is common to all symbol types,
370 including minimal symbols, partial symbols, and full symbols. In a
371 multilanguage environment, some language specific information may need to
372 be recorded along with each symbol. */
374 /* This structure is space critical. See space comments at the top. */
376 struct general_symbol_info
378 /* Name of the symbol. This is a required field. Storage for the
379 name is allocated on the objfile_obstack for the associated
380 objfile. For languages like C++ that make a distinction between
381 the mangled name and demangled name, this is the mangled
386 /* Value of the symbol. Which member of this union to use, and what
387 it means, depends on what kind of symbol this is and its
388 SYMBOL_CLASS. See comments there for more details. All of these
389 are in host byte order (though what they point to might be in
390 target byte order, e.g. LOC_CONST_BYTES). */
396 const struct block *block;
398 const gdb_byte *bytes;
402 /* A common block. Used with LOC_COMMON_BLOCK. */
404 const struct common_block *common_block;
406 /* For opaque typedef struct chain. */
408 struct symbol *chain;
412 /* Since one and only one language can apply, wrap the language specific
413 information inside a union. */
417 /* A pointer to an obstack that can be used for storage associated
418 with this symbol. This is only used by Ada, and only when the
419 'ada_mangled' field is zero. */
420 struct obstack *obstack;
422 /* This is used by languages which wish to store a demangled name.
423 currently used by Ada, C++, and Objective C. */
424 const char *demangled_name;
428 /* Record the source code language that applies to this symbol.
429 This is used to select one of the fields from the language specific
432 ENUM_BITFIELD(language) language : LANGUAGE_BITS;
434 /* This is only used by Ada. If set, then the 'demangled_name' field
435 of language_specific is valid. Otherwise, the 'obstack' field is
437 unsigned int ada_mangled : 1;
439 /* Which section is this symbol in? This is an index into
440 section_offsets for this objfile. Negative means that the symbol
441 does not get relocated relative to a section. */
446 extern void symbol_set_demangled_name (struct general_symbol_info *,
450 extern const char *symbol_get_demangled_name
451 (const struct general_symbol_info *);
453 extern CORE_ADDR symbol_overlayed_address (CORE_ADDR, struct obj_section *);
455 /* Note that all the following SYMBOL_* macros are used with the
456 SYMBOL argument being either a partial symbol or
457 a full symbol. Both types have a ginfo field. In particular
458 the SYMBOL_SET_LANGUAGE, SYMBOL_DEMANGLED_NAME, etc.
459 macros cannot be entirely substituted by
460 functions, unless the callers are changed to pass in the ginfo
461 field only, instead of the SYMBOL parameter. */
463 #define SYMBOL_VALUE(symbol) (symbol)->ginfo.value.ivalue
464 #define SYMBOL_VALUE_ADDRESS(symbol) (symbol)->ginfo.value.address
465 #define SYMBOL_VALUE_BYTES(symbol) (symbol)->ginfo.value.bytes
466 #define SYMBOL_VALUE_COMMON_BLOCK(symbol) (symbol)->ginfo.value.common_block
467 #define SYMBOL_BLOCK_VALUE(symbol) (symbol)->ginfo.value.block
468 #define SYMBOL_VALUE_CHAIN(symbol) (symbol)->ginfo.value.chain
469 #define SYMBOL_LANGUAGE(symbol) (symbol)->ginfo.language
470 #define SYMBOL_SECTION(symbol) (symbol)->ginfo.section
471 #define SYMBOL_OBJ_SECTION(objfile, symbol) \
472 (((symbol)->ginfo.section >= 0) \
473 ? (&(((objfile)->sections)[(symbol)->ginfo.section])) \
476 /* Initializes the language dependent portion of a symbol
477 depending upon the language for the symbol. */
478 #define SYMBOL_SET_LANGUAGE(symbol,language,obstack) \
479 (symbol_set_language (&(symbol)->ginfo, (language), (obstack)))
480 extern void symbol_set_language (struct general_symbol_info *symbol,
481 enum language language,
482 struct obstack *obstack);
484 /* Set just the linkage name of a symbol; do not try to demangle
485 it. Used for constructs which do not have a mangled name,
486 e.g. struct tags. Unlike SYMBOL_SET_NAMES, linkage_name must
487 be terminated and either already on the objfile's obstack or
488 permanently allocated. */
489 #define SYMBOL_SET_LINKAGE_NAME(symbol,linkage_name) \
490 (symbol)->ginfo.name = (linkage_name)
492 /* Set the linkage and natural names of a symbol, by demangling
494 #define SYMBOL_SET_NAMES(symbol,linkage_name,len,copy_name,objfile) \
495 symbol_set_names (&(symbol)->ginfo, linkage_name, len, copy_name, objfile)
496 extern void symbol_set_names (struct general_symbol_info *symbol,
497 const char *linkage_name, int len, int copy_name,
498 struct objfile *objfile);
500 /* Now come lots of name accessor macros. Short version as to when to
501 use which: Use SYMBOL_NATURAL_NAME to refer to the name of the
502 symbol in the original source code. Use SYMBOL_LINKAGE_NAME if you
503 want to know what the linker thinks the symbol's name is. Use
504 SYMBOL_PRINT_NAME for output. Use SYMBOL_DEMANGLED_NAME if you
505 specifically need to know whether SYMBOL_NATURAL_NAME and
506 SYMBOL_LINKAGE_NAME are different. */
508 /* Return SYMBOL's "natural" name, i.e. the name that it was called in
509 the original source code. In languages like C++ where symbols may
510 be mangled for ease of manipulation by the linker, this is the
513 #define SYMBOL_NATURAL_NAME(symbol) \
514 (symbol_natural_name (&(symbol)->ginfo))
515 extern const char *symbol_natural_name
516 (const struct general_symbol_info *symbol);
518 /* Return SYMBOL's name from the point of view of the linker. In
519 languages like C++ where symbols may be mangled for ease of
520 manipulation by the linker, this is the mangled name; otherwise,
521 it's the same as SYMBOL_NATURAL_NAME. */
523 #define SYMBOL_LINKAGE_NAME(symbol) (symbol)->ginfo.name
525 /* Return the demangled name for a symbol based on the language for
526 that symbol. If no demangled name exists, return NULL. */
527 #define SYMBOL_DEMANGLED_NAME(symbol) \
528 (symbol_demangled_name (&(symbol)->ginfo))
529 extern const char *symbol_demangled_name
530 (const struct general_symbol_info *symbol);
532 /* Macro that returns a version of the name of a symbol that is
533 suitable for output. In C++ this is the "demangled" form of the
534 name if demangle is on and the "mangled" form of the name if
535 demangle is off. In other languages this is just the symbol name.
536 The result should never be NULL. Don't use this for internal
537 purposes (e.g. storing in a hashtable): it's only suitable for output.
539 N.B. symbol may be anything with a ginfo member,
540 e.g., struct symbol or struct minimal_symbol. */
542 #define SYMBOL_PRINT_NAME(symbol) \
543 (demangle ? SYMBOL_NATURAL_NAME (symbol) : SYMBOL_LINKAGE_NAME (symbol))
546 /* Macro that returns the name to be used when sorting and searching symbols.
547 In C++, we search for the demangled form of a name,
548 and so sort symbols accordingly. In Ada, however, we search by mangled
549 name. If there is no distinct demangled name, then SYMBOL_SEARCH_NAME
550 returns the same value (same pointer) as SYMBOL_LINKAGE_NAME. */
551 #define SYMBOL_SEARCH_NAME(symbol) \
552 (symbol_search_name (&(symbol)->ginfo))
553 extern const char *symbol_search_name (const struct general_symbol_info *ginfo);
555 /* Return true if NAME matches the "search" name of SYMBOL, according
556 to the symbol's language. */
557 #define SYMBOL_MATCHES_SEARCH_NAME(symbol, name) \
558 symbol_matches_search_name (&(symbol)->ginfo, (name))
560 /* Helper for SYMBOL_MATCHES_SEARCH_NAME that works with both symbols
562 extern bool symbol_matches_search_name
563 (const struct general_symbol_info *gsymbol,
564 const lookup_name_info &name);
566 /* Compute the hash of the given symbol search name of a symbol of
567 language LANGUAGE. */
568 extern unsigned int search_name_hash (enum language language,
569 const char *search_name);
571 /* Classification types for a minimal symbol. These should be taken as
572 "advisory only", since if gdb can't easily figure out a
573 classification it simply selects mst_unknown. It may also have to
574 guess when it can't figure out which is a better match between two
575 types (mst_data versus mst_bss) for example. Since the minimal
576 symbol info is sometimes derived from the BFD library's view of a
577 file, we need to live with what information bfd supplies. */
579 enum minimal_symbol_type
581 mst_unknown = 0, /* Unknown type, the default */
582 mst_text, /* Generally executable instructions */
584 /* A GNU ifunc symbol, in the .text section. GDB uses to know
585 whether the user is setting a breakpoint on a GNU ifunc function,
586 and thus GDB needs to actually set the breakpoint on the target
587 function. It is also used to know whether the program stepped
588 into an ifunc resolver -- the resolver may get a separate
589 symbol/alias under a different name, but it'll have the same
590 address as the ifunc symbol. */
591 mst_text_gnu_ifunc, /* Executable code returning address
592 of executable code */
594 /* A GNU ifunc function descriptor symbol, in a data section
595 (typically ".opd"). Seen on architectures that use function
596 descriptors, like PPC64/ELFv1. In this case, this symbol's value
597 is the address of the descriptor. There'll be a corresponding
598 mst_text_gnu_ifunc synthetic symbol for the text/entry
600 mst_data_gnu_ifunc, /* Executable code returning address
601 of executable code */
603 mst_slot_got_plt, /* GOT entries for .plt sections */
604 mst_data, /* Generally initialized data */
605 mst_bss, /* Generally uninitialized data */
606 mst_abs, /* Generally absolute (nonrelocatable) */
607 /* GDB uses mst_solib_trampoline for the start address of a shared
608 library trampoline entry. Breakpoints for shared library functions
609 are put there if the shared library is not yet loaded.
610 After the shared library is loaded, lookup_minimal_symbol will
611 prefer the minimal symbol from the shared library (usually
612 a mst_text symbol) over the mst_solib_trampoline symbol, and the
613 breakpoints will be moved to their true address in the shared
614 library via breakpoint_re_set. */
615 mst_solib_trampoline, /* Shared library trampoline code */
616 /* For the mst_file* types, the names are only guaranteed to be unique
617 within a given .o file. */
618 mst_file_text, /* Static version of mst_text */
619 mst_file_data, /* Static version of mst_data */
620 mst_file_bss, /* Static version of mst_bss */
624 /* The number of enum minimal_symbol_type values, with some padding for
625 reasonable growth. */
626 #define MINSYM_TYPE_BITS 4
627 gdb_static_assert (nr_minsym_types <= (1 << MINSYM_TYPE_BITS));
629 /* Define a simple structure used to hold some very basic information about
630 all defined global symbols (text, data, bss, abs, etc). The only required
631 information is the general_symbol_info.
633 In many cases, even if a file was compiled with no special options for
634 debugging at all, as long as was not stripped it will contain sufficient
635 information to build a useful minimal symbol table using this structure.
636 Even when a file contains enough debugging information to build a full
637 symbol table, these minimal symbols are still useful for quickly mapping
638 between names and addresses, and vice versa. They are also sometimes
639 used to figure out what full symbol table entries need to be read in. */
641 struct minimal_symbol
644 /* The general symbol info required for all types of symbols.
646 The SYMBOL_VALUE_ADDRESS contains the address that this symbol
649 struct general_symbol_info mginfo;
651 /* Size of this symbol. dbx_end_psymtab in dbxread.c uses this
652 information to calculate the end of the partial symtab based on the
653 address of the last symbol plus the size of the last symbol. */
657 /* Which source file is this symbol in? Only relevant for mst_file_*. */
658 const char *filename;
660 /* Classification type for this minimal symbol. */
662 ENUM_BITFIELD(minimal_symbol_type) type : MINSYM_TYPE_BITS;
664 /* Non-zero if this symbol was created by gdb.
665 Such symbols do not appear in the output of "info var|fun". */
666 unsigned int created_by_gdb : 1;
668 /* Two flag bits provided for the use of the target. */
669 unsigned int target_flag_1 : 1;
670 unsigned int target_flag_2 : 1;
672 /* Nonzero iff the size of the minimal symbol has been set.
673 Symbol size information can sometimes not be determined, because
674 the object file format may not carry that piece of information. */
675 unsigned int has_size : 1;
677 /* Minimal symbols with the same hash key are kept on a linked
678 list. This is the link. */
680 struct minimal_symbol *hash_next;
682 /* Minimal symbols are stored in two different hash tables. This is
683 the `next' pointer for the demangled hash table. */
685 struct minimal_symbol *demangled_hash_next;
688 #define MSYMBOL_TARGET_FLAG_1(msymbol) (msymbol)->target_flag_1
689 #define MSYMBOL_TARGET_FLAG_2(msymbol) (msymbol)->target_flag_2
690 #define MSYMBOL_SIZE(msymbol) ((msymbol)->size + 0)
691 #define SET_MSYMBOL_SIZE(msymbol, sz) \
694 (msymbol)->size = sz; \
695 (msymbol)->has_size = 1; \
697 #define MSYMBOL_HAS_SIZE(msymbol) ((msymbol)->has_size + 0)
698 #define MSYMBOL_TYPE(msymbol) (msymbol)->type
700 #define MSYMBOL_VALUE(symbol) (symbol)->mginfo.value.ivalue
701 /* The unrelocated address of the minimal symbol. */
702 #define MSYMBOL_VALUE_RAW_ADDRESS(symbol) ((symbol)->mginfo.value.address + 0)
703 /* The relocated address of the minimal symbol, using the section
704 offsets from OBJFILE. */
705 #define MSYMBOL_VALUE_ADDRESS(objfile, symbol) \
706 ((symbol)->mginfo.value.address \
707 + ANOFFSET ((objfile)->section_offsets, ((symbol)->mginfo.section)))
708 /* For a bound minsym, we can easily compute the address directly. */
709 #define BMSYMBOL_VALUE_ADDRESS(symbol) \
710 MSYMBOL_VALUE_ADDRESS ((symbol).objfile, (symbol).minsym)
711 #define SET_MSYMBOL_VALUE_ADDRESS(symbol, new_value) \
712 ((symbol)->mginfo.value.address = (new_value))
713 #define MSYMBOL_VALUE_BYTES(symbol) (symbol)->mginfo.value.bytes
714 #define MSYMBOL_BLOCK_VALUE(symbol) (symbol)->mginfo.value.block
715 #define MSYMBOL_VALUE_CHAIN(symbol) (symbol)->mginfo.value.chain
716 #define MSYMBOL_LANGUAGE(symbol) (symbol)->mginfo.language
717 #define MSYMBOL_SECTION(symbol) (symbol)->mginfo.section
718 #define MSYMBOL_OBJ_SECTION(objfile, symbol) \
719 (((symbol)->mginfo.section >= 0) \
720 ? (&(((objfile)->sections)[(symbol)->mginfo.section])) \
723 #define MSYMBOL_NATURAL_NAME(symbol) \
724 (symbol_natural_name (&(symbol)->mginfo))
725 #define MSYMBOL_LINKAGE_NAME(symbol) (symbol)->mginfo.name
726 #define MSYMBOL_PRINT_NAME(symbol) \
727 (demangle ? MSYMBOL_NATURAL_NAME (symbol) : MSYMBOL_LINKAGE_NAME (symbol))
728 #define MSYMBOL_DEMANGLED_NAME(symbol) \
729 (symbol_demangled_name (&(symbol)->mginfo))
730 #define MSYMBOL_SET_LANGUAGE(symbol,language,obstack) \
731 (symbol_set_language (&(symbol)->mginfo, (language), (obstack)))
732 #define MSYMBOL_SEARCH_NAME(symbol) \
733 (symbol_search_name (&(symbol)->mginfo))
734 #define MSYMBOL_SET_NAMES(symbol,linkage_name,len,copy_name,objfile) \
735 symbol_set_names (&(symbol)->mginfo, linkage_name, len, copy_name, objfile)
741 /* Represent one symbol name; a variable, constant, function or typedef. */
743 /* Different name domains for symbols. Looking up a symbol specifies a
744 domain and ignores symbol definitions in other name domains. */
746 typedef enum domain_enum_tag
748 /* UNDEF_DOMAIN is used when a domain has not been discovered or
749 none of the following apply. This usually indicates an error either
750 in the symbol information or in gdb's handling of symbols. */
754 /* VAR_DOMAIN is the usual domain. In C, this contains variables,
755 function names, typedef names and enum type values. */
759 /* STRUCT_DOMAIN is used in C to hold struct, union and enum type names.
760 Thus, if `struct foo' is used in a C program, it produces a symbol named
761 `foo' in the STRUCT_DOMAIN. */
765 /* MODULE_DOMAIN is used in Fortran to hold module type names. */
769 /* LABEL_DOMAIN may be used for names of labels (for gotos). */
773 /* Fortran common blocks. Their naming must be separate from VAR_DOMAIN.
774 They also always use LOC_COMMON_BLOCK. */
777 /* This must remain last. */
781 /* The number of bits in a symbol used to represent the domain. */
783 #define SYMBOL_DOMAIN_BITS 3
784 gdb_static_assert (NR_DOMAINS <= (1 << SYMBOL_DOMAIN_BITS));
786 extern const char *domain_name (domain_enum);
788 /* Searching domains, used for `search_symbols'. Element numbers are
789 hardcoded in GDB, check all enum uses before changing it. */
793 /* Everything in VAR_DOMAIN minus FUNCTIONS_DOMAIN and
795 VARIABLES_DOMAIN = 0,
797 /* All functions -- for some reason not methods, though. */
798 FUNCTIONS_DOMAIN = 1,
800 /* All defined types */
807 extern const char *search_domain_name (enum search_domain);
809 /* An address-class says where to find the value of a symbol. */
813 /* Not used; catches errors. */
817 /* Value is constant int SYMBOL_VALUE, host byteorder. */
821 /* Value is at fixed address SYMBOL_VALUE_ADDRESS. */
825 /* Value is in register. SYMBOL_VALUE is the register number
826 in the original debug format. SYMBOL_REGISTER_OPS holds a
827 function that can be called to transform this into the
828 actual register number this represents in a specific target
829 architecture (gdbarch).
831 For some symbol formats (stabs, for some compilers at least),
832 the compiler generates two symbols, an argument and a register.
833 In some cases we combine them to a single LOC_REGISTER in symbol
834 reading, but currently not for all cases (e.g. it's passed on the
835 stack and then loaded into a register). */
839 /* It's an argument; the value is at SYMBOL_VALUE offset in arglist. */
843 /* Value address is at SYMBOL_VALUE offset in arglist. */
847 /* Value is in specified register. Just like LOC_REGISTER except the
848 register holds the address of the argument instead of the argument
849 itself. This is currently used for the passing of structs and unions
850 on sparc and hppa. It is also used for call by reference where the
851 address is in a register, at least by mipsread.c. */
855 /* Value is a local variable at SYMBOL_VALUE offset in stack frame. */
859 /* Value not used; definition in SYMBOL_TYPE. Symbols in the domain
860 STRUCT_DOMAIN all have this class. */
864 /* Value is address SYMBOL_VALUE_ADDRESS in the code. */
868 /* In a symbol table, value is SYMBOL_BLOCK_VALUE of a `struct block'.
869 In a partial symbol table, SYMBOL_VALUE_ADDRESS is the start address
870 of the block. Function names have this class. */
874 /* Value is a constant byte-sequence pointed to by SYMBOL_VALUE_BYTES, in
875 target byte order. */
879 /* Value is at fixed address, but the address of the variable has
880 to be determined from the minimal symbol table whenever the
881 variable is referenced.
882 This happens if debugging information for a global symbol is
883 emitted and the corresponding minimal symbol is defined
884 in another object file or runtime common storage.
885 The linker might even remove the minimal symbol if the global
886 symbol is never referenced, in which case the symbol remains
889 GDB would normally find the symbol in the minimal symbol table if it will
890 not find it in the full symbol table. But a reference to an external
891 symbol in a local block shadowing other definition requires full symbol
892 without possibly having its address available for LOC_STATIC. Testcase
893 is provided as `gdb.dwarf2/dw2-unresolved.exp'.
895 This is also used for thread local storage (TLS) variables. In this case,
896 the address of the TLS variable must be determined when the variable is
897 referenced, from the MSYMBOL_VALUE_RAW_ADDRESS, which is the offset
898 of the TLS variable in the thread local storage of the shared
903 /* The variable does not actually exist in the program.
904 The value is ignored. */
908 /* The variable's address is computed by a set of location
909 functions (see "struct symbol_computed_ops" below). */
912 /* The variable uses general_symbol_info->value->common_block field.
913 It also always uses COMMON_BLOCK_DOMAIN. */
916 /* Not used, just notes the boundary of the enum. */
920 /* The number of bits needed for values in enum address_class, with some
921 padding for reasonable growth, and room for run-time registered address
922 classes. See symtab.c:MAX_SYMBOL_IMPLS.
923 This is a #define so that we can have a assertion elsewhere to
924 verify that we have reserved enough space for synthetic address
926 #define SYMBOL_ACLASS_BITS 5
927 gdb_static_assert (LOC_FINAL_VALUE <= (1 << SYMBOL_ACLASS_BITS));
929 /* The methods needed to implement LOC_COMPUTED. These methods can
930 use the symbol's .aux_value for additional per-symbol information.
932 At present this is only used to implement location expressions. */
934 struct symbol_computed_ops
937 /* Return the value of the variable SYMBOL, relative to the stack
938 frame FRAME. If the variable has been optimized out, return
941 Iff `read_needs_frame (SYMBOL)' is not SYMBOL_NEEDS_FRAME, then
942 FRAME may be zero. */
944 struct value *(*read_variable) (struct symbol * symbol,
945 struct frame_info * frame);
947 /* Read variable SYMBOL like read_variable at (callee) FRAME's function
948 entry. SYMBOL should be a function parameter, otherwise
949 NO_ENTRY_VALUE_ERROR will be thrown. */
950 struct value *(*read_variable_at_entry) (struct symbol *symbol,
951 struct frame_info *frame);
953 /* Find the "symbol_needs_kind" value for the given symbol. This
954 value determines whether reading the symbol needs memory (e.g., a
955 global variable), just registers (a thread-local), or a frame (a
957 enum symbol_needs_kind (*get_symbol_read_needs) (struct symbol * symbol);
959 /* Write to STREAM a natural-language description of the location of
960 SYMBOL, in the context of ADDR. */
961 void (*describe_location) (struct symbol * symbol, CORE_ADDR addr,
962 struct ui_file * stream);
964 /* Non-zero if this symbol's address computation is dependent on PC. */
965 unsigned char location_has_loclist;
967 /* Tracepoint support. Append bytecodes to the tracepoint agent
968 expression AX that push the address of the object SYMBOL. Set
969 VALUE appropriately. Note --- for objects in registers, this
970 needn't emit any code; as long as it sets VALUE properly, then
971 the caller will generate the right code in the process of
972 treating this as an lvalue or rvalue. */
974 void (*tracepoint_var_ref) (struct symbol *symbol, struct agent_expr *ax,
975 struct axs_value *value);
977 /* Generate C code to compute the location of SYMBOL. The C code is
978 emitted to STREAM. GDBARCH is the current architecture and PC is
979 the PC at which SYMBOL's location should be evaluated.
980 REGISTERS_USED is a vector indexed by register number; the
981 generator function should set an element in this vector if the
982 corresponding register is needed by the location computation.
983 The generated C code must assign the location to a local
984 variable; this variable's name is RESULT_NAME. */
986 void (*generate_c_location) (struct symbol *symbol, string_file &stream,
987 struct gdbarch *gdbarch,
988 unsigned char *registers_used,
989 CORE_ADDR pc, const char *result_name);
993 /* The methods needed to implement LOC_BLOCK for inferior functions.
994 These methods can use the symbol's .aux_value for additional
995 per-symbol information. */
997 struct symbol_block_ops
999 /* Fill in *START and *LENGTH with DWARF block data of function
1000 FRAMEFUNC valid for inferior context address PC. Set *LENGTH to
1001 zero if such location is not valid for PC; *START is left
1002 uninitialized in such case. */
1003 void (*find_frame_base_location) (struct symbol *framefunc, CORE_ADDR pc,
1004 const gdb_byte **start, size_t *length);
1006 /* Return the frame base address. FRAME is the frame for which we want to
1007 compute the base address while FRAMEFUNC is the symbol for the
1008 corresponding function. Return 0 on failure (FRAMEFUNC may not hold the
1009 information we need).
1011 This method is designed to work with static links (nested functions
1012 handling). Static links are function properties whose evaluation returns
1013 the frame base address for the enclosing frame. However, there are
1014 multiple definitions for "frame base": the content of the frame base
1015 register, the CFA as defined by DWARF unwinding information, ...
1017 So this specific method is supposed to compute the frame base address such
1018 as for nested fuctions, the static link computes the same address. For
1019 instance, considering DWARF debugging information, the static link is
1020 computed with DW_AT_static_link and this method must be used to compute
1021 the corresponding DW_AT_frame_base attribute. */
1022 CORE_ADDR (*get_frame_base) (struct symbol *framefunc,
1023 struct frame_info *frame);
1026 /* Functions used with LOC_REGISTER and LOC_REGPARM_ADDR. */
1028 struct symbol_register_ops
1030 int (*register_number) (struct symbol *symbol, struct gdbarch *gdbarch);
1033 /* Objects of this type are used to find the address class and the
1034 various computed ops vectors of a symbol. */
1038 enum address_class aclass;
1040 /* Used with LOC_COMPUTED. */
1041 const struct symbol_computed_ops *ops_computed;
1043 /* Used with LOC_BLOCK. */
1044 const struct symbol_block_ops *ops_block;
1046 /* Used with LOC_REGISTER and LOC_REGPARM_ADDR. */
1047 const struct symbol_register_ops *ops_register;
1050 /* struct symbol has some subclasses. This enum is used to
1051 differentiate between them. */
1053 enum symbol_subclass_kind
1055 /* Plain struct symbol. */
1058 /* struct template_symbol. */
1061 /* struct rust_vtable_symbol. */
1065 /* This structure is space critical. See space comments at the top. */
1070 /* The general symbol info required for all types of symbols. */
1072 struct general_symbol_info ginfo;
1074 /* Data type of value */
1078 /* The owner of this symbol.
1079 Which one to use is defined by symbol.is_objfile_owned. */
1083 /* The symbol table containing this symbol. This is the file associated
1084 with LINE. It can be NULL during symbols read-in but it is never NULL
1085 during normal operation. */
1086 struct symtab *symtab;
1088 /* For types defined by the architecture. */
1089 struct gdbarch *arch;
1094 ENUM_BITFIELD(domain_enum_tag) domain : SYMBOL_DOMAIN_BITS;
1096 /* Address class. This holds an index into the 'symbol_impls'
1097 table. The actual enum address_class value is stored there,
1098 alongside any per-class ops vectors. */
1100 unsigned int aclass_index : SYMBOL_ACLASS_BITS;
1102 /* If non-zero then symbol is objfile-owned, use owner.symtab.
1103 Otherwise symbol is arch-owned, use owner.arch. */
1105 unsigned int is_objfile_owned : 1;
1107 /* Whether this is an argument. */
1109 unsigned is_argument : 1;
1111 /* Whether this is an inlined function (class LOC_BLOCK only). */
1112 unsigned is_inlined : 1;
1114 /* The concrete type of this symbol. */
1116 ENUM_BITFIELD (symbol_subclass_kind) subclass : 2;
1118 /* Line number of this symbol's definition, except for inlined
1119 functions. For an inlined function (class LOC_BLOCK and
1120 SYMBOL_INLINED set) this is the line number of the function's call
1121 site. Inlined function symbols are not definitions, and they are
1122 never found by symbol table lookup.
1123 If this symbol is arch-owned, LINE shall be zero.
1125 FIXME: Should we really make the assumption that nobody will try
1126 to debug files longer than 64K lines? What about machine
1127 generated programs? */
1129 unsigned short line;
1131 /* An arbitrary data pointer, allowing symbol readers to record
1132 additional information on a per-symbol basis. Note that this data
1133 must be allocated using the same obstack as the symbol itself. */
1134 /* So far it is only used by:
1135 LOC_COMPUTED: to find the location information
1136 LOC_BLOCK (DWARF2 function): information used internally by the
1137 DWARF 2 code --- specifically, the location expression for the frame
1138 base for this function. */
1139 /* FIXME drow/2003-02-21: For the LOC_BLOCK case, it might be better
1140 to add a magic symbol to the block containing this information,
1141 or to have a generic debug info annotation slot for symbols. */
1145 struct symbol *hash_next;
1148 /* Several lookup functions return both a symbol and the block in which the
1149 symbol is found. This structure is used in these cases. */
1153 /* The symbol that was found, or NULL if no symbol was found. */
1154 struct symbol *symbol;
1156 /* If SYMBOL is not NULL, then this is the block in which the symbol is
1158 const struct block *block;
1161 extern const struct symbol_impl *symbol_impls;
1163 /* For convenience. All fields are NULL. This means "there is no
1165 extern const struct block_symbol null_block_symbol;
1167 /* Note: There is no accessor macro for symbol.owner because it is
1170 #define SYMBOL_DOMAIN(symbol) (symbol)->domain
1171 #define SYMBOL_IMPL(symbol) (symbol_impls[(symbol)->aclass_index])
1172 #define SYMBOL_ACLASS_INDEX(symbol) (symbol)->aclass_index
1173 #define SYMBOL_CLASS(symbol) (SYMBOL_IMPL (symbol).aclass)
1174 #define SYMBOL_OBJFILE_OWNED(symbol) ((symbol)->is_objfile_owned)
1175 #define SYMBOL_IS_ARGUMENT(symbol) (symbol)->is_argument
1176 #define SYMBOL_INLINED(symbol) (symbol)->is_inlined
1177 #define SYMBOL_IS_CPLUS_TEMPLATE_FUNCTION(symbol) \
1178 (((symbol)->subclass) == SYMBOL_TEMPLATE)
1179 #define SYMBOL_TYPE(symbol) (symbol)->type
1180 #define SYMBOL_LINE(symbol) (symbol)->line
1181 #define SYMBOL_COMPUTED_OPS(symbol) (SYMBOL_IMPL (symbol).ops_computed)
1182 #define SYMBOL_BLOCK_OPS(symbol) (SYMBOL_IMPL (symbol).ops_block)
1183 #define SYMBOL_REGISTER_OPS(symbol) (SYMBOL_IMPL (symbol).ops_register)
1184 #define SYMBOL_LOCATION_BATON(symbol) (symbol)->aux_value
1186 extern int register_symbol_computed_impl (enum address_class,
1187 const struct symbol_computed_ops *);
1189 extern int register_symbol_block_impl (enum address_class aclass,
1190 const struct symbol_block_ops *ops);
1192 extern int register_symbol_register_impl (enum address_class,
1193 const struct symbol_register_ops *);
1195 /* Return the OBJFILE of SYMBOL.
1196 It is an error to call this if symbol.is_objfile_owned is false, which
1197 only happens for architecture-provided types. */
1199 extern struct objfile *symbol_objfile (const struct symbol *symbol);
1201 /* Return the ARCH of SYMBOL. */
1203 extern struct gdbarch *symbol_arch (const struct symbol *symbol);
1205 /* Return the SYMTAB of SYMBOL.
1206 It is an error to call this if symbol.is_objfile_owned is false, which
1207 only happens for architecture-provided types. */
1209 extern struct symtab *symbol_symtab (const struct symbol *symbol);
1211 /* Set the symtab of SYMBOL to SYMTAB.
1212 It is an error to call this if symbol.is_objfile_owned is false, which
1213 only happens for architecture-provided types. */
1215 extern void symbol_set_symtab (struct symbol *symbol, struct symtab *symtab);
1217 /* An instance of this type is used to represent a C++ template
1218 function. A symbol is really of this type iff
1219 SYMBOL_IS_CPLUS_TEMPLATE_FUNCTION is true. */
1221 struct template_symbol : public symbol
1223 /* The number of template arguments. */
1224 int n_template_arguments;
1226 /* The template arguments. This is an array with
1227 N_TEMPLATE_ARGUMENTS elements. */
1228 struct symbol **template_arguments;
1231 /* A symbol that represents a Rust virtual table object. */
1233 struct rust_vtable_symbol : public symbol
1235 /* The concrete type for which this vtable was created; that is, in
1236 "impl Trait for Type", this is "Type". */
1237 struct type *concrete_type;
1241 /* Each item represents a line-->pc (or the reverse) mapping. This is
1242 somewhat more wasteful of space than one might wish, but since only
1243 the files which are actually debugged are read in to core, we don't
1244 waste much space. */
1246 struct linetable_entry
1252 /* The order of entries in the linetable is significant. They should
1253 be sorted by increasing values of the pc field. If there is more than
1254 one entry for a given pc, then I'm not sure what should happen (and
1255 I not sure whether we currently handle it the best way).
1257 Example: a C for statement generally looks like this
1259 10 0x100 - for the init/test part of a for stmt.
1262 10 0x400 - for the increment part of a for stmt.
1264 If an entry has a line number of zero, it marks the start of a PC
1265 range for which no line number information is available. It is
1266 acceptable, though wasteful of table space, for such a range to be
1273 /* Actually NITEMS elements. If you don't like this use of the
1274 `struct hack', you can shove it up your ANSI (seriously, if the
1275 committee tells us how to do it, we can probably go along). */
1276 struct linetable_entry item[1];
1279 /* How to relocate the symbols from each section in a symbol file.
1280 Each struct contains an array of offsets.
1281 The ordering and meaning of the offsets is file-type-dependent;
1282 typically it is indexed by section numbers or symbol types or
1283 something like that.
1285 To give us flexibility in changing the internal representation
1286 of these offsets, the ANOFFSET macro must be used to insert and
1287 extract offset values in the struct. */
1289 struct section_offsets
1291 CORE_ADDR offsets[1]; /* As many as needed. */
1294 #define ANOFFSET(secoff, whichone) \
1296 ? (internal_error (__FILE__, __LINE__, \
1297 _("Section index is uninitialized")), -1) \
1298 : secoff->offsets[whichone])
1300 /* The size of a section_offsets table for N sections. */
1301 #define SIZEOF_N_SECTION_OFFSETS(n) \
1302 (sizeof (struct section_offsets) \
1303 + sizeof (((struct section_offsets *) 0)->offsets) * ((n)-1))
1305 /* Each source file or header is represented by a struct symtab.
1306 The name "symtab" is historical, another name for it is "filetab".
1307 These objects are chained through the `next' field. */
1311 /* Unordered chain of all filetabs in the compunit, with the exception
1312 that the "main" source file is the first entry in the list. */
1314 struct symtab *next;
1316 /* Backlink to containing compunit symtab. */
1318 struct compunit_symtab *compunit_symtab;
1320 /* Table mapping core addresses to line numbers for this file.
1321 Can be NULL if none. Never shared between different symtabs. */
1323 struct linetable *linetable;
1325 /* Name of this source file. This pointer is never NULL. */
1327 const char *filename;
1329 /* Total number of lines found in source file. */
1333 /* line_charpos[N] is the position of the (N-1)th line of the
1334 source file. "position" means something we can lseek() to; it
1335 is not guaranteed to be useful any other way. */
1339 /* Language of this source file. */
1341 enum language language;
1343 /* Full name of file as found by searching the source path.
1344 NULL if not yet known. */
1349 #define SYMTAB_COMPUNIT(symtab) ((symtab)->compunit_symtab)
1350 #define SYMTAB_LINETABLE(symtab) ((symtab)->linetable)
1351 #define SYMTAB_LANGUAGE(symtab) ((symtab)->language)
1352 #define SYMTAB_BLOCKVECTOR(symtab) \
1353 COMPUNIT_BLOCKVECTOR (SYMTAB_COMPUNIT (symtab))
1354 #define SYMTAB_OBJFILE(symtab) \
1355 COMPUNIT_OBJFILE (SYMTAB_COMPUNIT (symtab))
1356 #define SYMTAB_PSPACE(symtab) (SYMTAB_OBJFILE (symtab)->pspace)
1357 #define SYMTAB_DIRNAME(symtab) \
1358 COMPUNIT_DIRNAME (SYMTAB_COMPUNIT (symtab))
1360 typedef struct symtab *symtab_ptr;
1361 DEF_VEC_P (symtab_ptr);
1363 /* Compunit symtabs contain the actual "symbol table", aka blockvector, as well
1364 as the list of all source files (what gdb has historically associated with
1366 Additional information is recorded here that is common to all symtabs in a
1367 compilation unit (DWARF or otherwise).
1370 For the case of a program built out of these files:
1379 This is recorded as:
1381 objfile -> foo.c(cu) -> bar.c(cu) -> NULL
1395 where "foo.c(cu)" and "bar.c(cu)" are struct compunit_symtab objects,
1396 and the files foo.c, etc. are struct symtab objects. */
1398 struct compunit_symtab
1400 /* Unordered chain of all compunit symtabs of this objfile. */
1401 struct compunit_symtab *next;
1403 /* Object file from which this symtab information was read. */
1404 struct objfile *objfile;
1406 /* Name of the symtab.
1407 This is *not* intended to be a usable filename, and is
1408 for debugging purposes only. */
1411 /* Unordered list of file symtabs, except that by convention the "main"
1412 source file (e.g., .c, .cc) is guaranteed to be first.
1413 Each symtab is a file, either the "main" source file (e.g., .c, .cc)
1414 or header (e.g., .h). */
1415 struct symtab *filetabs;
1417 /* Last entry in FILETABS list.
1418 Subfiles are added to the end of the list so they accumulate in order,
1419 with the main source subfile living at the front.
1420 The main reason is so that the main source file symtab is at the head
1421 of the list, and the rest appear in order for debugging convenience. */
1422 struct symtab *last_filetab;
1424 /* Non-NULL string that identifies the format of the debugging information,
1425 such as "stabs", "dwarf 1", "dwarf 2", "coff", etc. This is mostly useful
1426 for automated testing of gdb but may also be information that is
1427 useful to the user. */
1428 const char *debugformat;
1430 /* String of producer version information, or NULL if we don't know. */
1431 const char *producer;
1433 /* Directory in which it was compiled, or NULL if we don't know. */
1434 const char *dirname;
1436 /* List of all symbol scope blocks for this symtab. It is shared among
1437 all symtabs in a given compilation unit. */
1438 const struct blockvector *blockvector;
1440 /* Section in objfile->section_offsets for the blockvector and
1441 the linetable. Probably always SECT_OFF_TEXT. */
1442 int block_line_section;
1444 /* Symtab has been compiled with both optimizations and debug info so that
1445 GDB may stop skipping prologues as variables locations are valid already
1446 at function entry points. */
1447 unsigned int locations_valid : 1;
1449 /* DWARF unwinder for this CU is valid even for epilogues (PC at the return
1450 instruction). This is supported by GCC since 4.5.0. */
1451 unsigned int epilogue_unwind_valid : 1;
1453 /* struct call_site entries for this compilation unit or NULL. */
1454 htab_t call_site_htab;
1456 /* The macro table for this symtab. Like the blockvector, this
1457 is shared between different symtabs in a given compilation unit.
1458 It's debatable whether it *should* be shared among all the symtabs in
1459 the given compilation unit, but it currently is. */
1460 struct macro_table *macro_table;
1462 /* If non-NULL, then this points to a NULL-terminated vector of
1463 included compunits. When searching the static or global
1464 block of this compunit, the corresponding block of all
1465 included compunits will also be searched. Note that this
1466 list must be flattened -- the symbol reader is responsible for
1467 ensuring that this vector contains the transitive closure of all
1468 included compunits. */
1469 struct compunit_symtab **includes;
1471 /* If this is an included compunit, this points to one includer
1472 of the table. This user is considered the canonical compunit
1473 containing this one. An included compunit may itself be
1474 included by another. */
1475 struct compunit_symtab *user;
1478 #define COMPUNIT_OBJFILE(cust) ((cust)->objfile)
1479 #define COMPUNIT_FILETABS(cust) ((cust)->filetabs)
1480 #define COMPUNIT_DEBUGFORMAT(cust) ((cust)->debugformat)
1481 #define COMPUNIT_PRODUCER(cust) ((cust)->producer)
1482 #define COMPUNIT_DIRNAME(cust) ((cust)->dirname)
1483 #define COMPUNIT_BLOCKVECTOR(cust) ((cust)->blockvector)
1484 #define COMPUNIT_BLOCK_LINE_SECTION(cust) ((cust)->block_line_section)
1485 #define COMPUNIT_LOCATIONS_VALID(cust) ((cust)->locations_valid)
1486 #define COMPUNIT_EPILOGUE_UNWIND_VALID(cust) ((cust)->epilogue_unwind_valid)
1487 #define COMPUNIT_CALL_SITE_HTAB(cust) ((cust)->call_site_htab)
1488 #define COMPUNIT_MACRO_TABLE(cust) ((cust)->macro_table)
1490 /* Iterate over all file tables (struct symtab) within a compunit. */
1492 #define ALL_COMPUNIT_FILETABS(cu, s) \
1493 for ((s) = (cu) -> filetabs; (s) != NULL; (s) = (s) -> next)
1495 /* Return the primary symtab of CUST. */
1497 extern struct symtab *
1498 compunit_primary_filetab (const struct compunit_symtab *cust);
1500 /* Return the language of CUST. */
1502 extern enum language compunit_language (const struct compunit_symtab *cust);
1504 typedef struct compunit_symtab *compunit_symtab_ptr;
1505 DEF_VEC_P (compunit_symtab_ptr);
1509 /* The virtual function table is now an array of structures which have the
1510 form { int16 offset, delta; void *pfn; }.
1512 In normal virtual function tables, OFFSET is unused.
1513 DELTA is the amount which is added to the apparent object's base
1514 address in order to point to the actual object to which the
1515 virtual function should be applied.
1516 PFN is a pointer to the virtual function.
1518 Note that this macro is g++ specific (FIXME). */
1520 #define VTBL_FNADDR_OFFSET 2
1522 /* External variables and functions for the objects described above. */
1524 /* True if we are nested inside psymtab_to_symtab. */
1526 extern int currently_reading_symtab;
1528 /* symtab.c lookup functions */
1530 extern const char multiple_symbols_ask[];
1531 extern const char multiple_symbols_all[];
1532 extern const char multiple_symbols_cancel[];
1534 const char *multiple_symbols_select_mode (void);
1536 int symbol_matches_domain (enum language symbol_language,
1537 domain_enum symbol_domain,
1538 domain_enum domain);
1540 /* lookup a symbol table by source file name. */
1542 extern struct symtab *lookup_symtab (const char *);
1544 /* An object of this type is passed as the 'is_a_field_of_this'
1545 argument to lookup_symbol and lookup_symbol_in_language. */
1547 struct field_of_this_result
1549 /* The type in which the field was found. If this is NULL then the
1550 symbol was not found in 'this'. If non-NULL, then one of the
1551 other fields will be non-NULL as well. */
1555 /* If the symbol was found as an ordinary field of 'this', then this
1556 is non-NULL and points to the particular field. */
1558 struct field *field;
1560 /* If the symbol was found as a function field of 'this', then this
1561 is non-NULL and points to the particular field. */
1563 struct fn_fieldlist *fn_field;
1566 /* Find the definition for a specified symbol name NAME
1567 in domain DOMAIN in language LANGUAGE, visible from lexical block BLOCK
1568 if non-NULL or from global/static blocks if BLOCK is NULL.
1569 Returns the struct symbol pointer, or NULL if no symbol is found.
1570 C++: if IS_A_FIELD_OF_THIS is non-NULL on entry, check to see if
1571 NAME is a field of the current implied argument `this'. If so fill in the
1572 fields of IS_A_FIELD_OF_THIS, otherwise the fields are set to NULL.
1573 The symbol's section is fixed up if necessary. */
1575 extern struct block_symbol
1576 lookup_symbol_in_language (const char *,
1577 const struct block *,
1580 struct field_of_this_result *);
1582 /* Same as lookup_symbol_in_language, but using the current language. */
1584 extern struct block_symbol lookup_symbol (const char *,
1585 const struct block *,
1587 struct field_of_this_result *);
1589 /* Find the definition for a specified symbol search name in domain
1590 DOMAIN, visible from lexical block BLOCK if non-NULL or from
1591 global/static blocks if BLOCK is NULL. The passed-in search name
1592 should not come from the user; instead it should already be a
1593 search name as retrieved from a
1594 SYMBOL_SEARCH_NAME/MSYMBOL_SEARCH_NAME call. See definition of
1595 symbol_name_match_type::SEARCH_NAME. Returns the struct symbol
1596 pointer, or NULL if no symbol is found. The symbol's section is
1597 fixed up if necessary. */
1599 extern struct block_symbol lookup_symbol_search_name (const char *search_name,
1600 const struct block *block,
1601 domain_enum domain);
1603 /* A default version of lookup_symbol_nonlocal for use by languages
1604 that can't think of anything better to do.
1605 This implements the C lookup rules. */
1607 extern struct block_symbol
1608 basic_lookup_symbol_nonlocal (const struct language_defn *langdef,
1610 const struct block *,
1613 /* Some helper functions for languages that need to write their own
1614 lookup_symbol_nonlocal functions. */
1616 /* Lookup a symbol in the static block associated to BLOCK, if there
1617 is one; do nothing if BLOCK is NULL or a global block.
1618 Upon success fixes up the symbol's section if necessary. */
1620 extern struct block_symbol
1621 lookup_symbol_in_static_block (const char *name,
1622 const struct block *block,
1623 const domain_enum domain);
1625 /* Search all static file-level symbols for NAME from DOMAIN.
1626 Upon success fixes up the symbol's section if necessary. */
1628 extern struct block_symbol lookup_static_symbol (const char *name,
1629 const domain_enum domain);
1631 /* Lookup a symbol in all files' global blocks.
1633 If BLOCK is non-NULL then it is used for two things:
1634 1) If a target-specific lookup routine for libraries exists, then use the
1635 routine for the objfile of BLOCK, and
1636 2) The objfile of BLOCK is used to assist in determining the search order
1637 if the target requires it.
1638 See gdbarch_iterate_over_objfiles_in_search_order.
1640 Upon success fixes up the symbol's section if necessary. */
1642 extern struct block_symbol
1643 lookup_global_symbol (const char *name,
1644 const struct block *block,
1645 const domain_enum domain);
1647 /* Lookup a symbol in block BLOCK.
1648 Upon success fixes up the symbol's section if necessary. */
1650 extern struct symbol *
1651 lookup_symbol_in_block (const char *name,
1652 symbol_name_match_type match_type,
1653 const struct block *block,
1654 const domain_enum domain);
1656 /* Look up the `this' symbol for LANG in BLOCK. Return the symbol if
1657 found, or NULL if not found. */
1659 extern struct block_symbol
1660 lookup_language_this (const struct language_defn *lang,
1661 const struct block *block);
1663 /* Lookup a [struct, union, enum] by name, within a specified block. */
1665 extern struct type *lookup_struct (const char *, const struct block *);
1667 extern struct type *lookup_union (const char *, const struct block *);
1669 extern struct type *lookup_enum (const char *, const struct block *);
1671 /* from blockframe.c: */
1673 /* lookup the function symbol corresponding to the address. The
1674 return value will not be an inlined function; the containing
1675 function will be returned instead. */
1677 extern struct symbol *find_pc_function (CORE_ADDR);
1679 /* lookup the function corresponding to the address and section. The
1680 return value will not be an inlined function; the containing
1681 function will be returned instead. */
1683 extern struct symbol *find_pc_sect_function (CORE_ADDR, struct obj_section *);
1685 /* lookup the function symbol corresponding to the address and
1686 section. The return value will be the closest enclosing function,
1687 which might be an inline function. */
1689 extern struct symbol *find_pc_sect_containing_function
1690 (CORE_ADDR pc, struct obj_section *section);
1692 /* Find the symbol at the given address. Returns NULL if no symbol
1693 found. Only exact matches for ADDRESS are considered. */
1695 extern struct symbol *find_symbol_at_address (CORE_ADDR);
1697 /* Finds the "function" (text symbol) that is smaller than PC but
1698 greatest of all of the potential text symbols in SECTION. Sets
1699 *NAME and/or *ADDRESS conditionally if that pointer is non-null.
1700 If ENDADDR is non-null, then set *ENDADDR to be the end of the
1701 function (exclusive). If the optional parameter BLOCK is non-null,
1702 then set *BLOCK to the address of the block corresponding to the
1703 function symbol, if such a symbol could be found during the lookup;
1704 nullptr is used as a return value for *BLOCK if no block is found.
1705 This function either succeeds or fails (not halfway succeeds). If
1706 it succeeds, it sets *NAME, *ADDRESS, and *ENDADDR to real
1707 information and returns 1. If it fails, it sets *NAME, *ADDRESS
1708 and *ENDADDR to zero and returns 0.
1710 If the function in question occupies non-contiguous ranges,
1711 *ADDRESS and *ENDADDR are (subject to the conditions noted above) set
1712 to the start and end of the range in which PC is found. Thus
1713 *ADDRESS <= PC < *ENDADDR with no intervening gaps (in which ranges
1714 from other functions might be found).
1716 This property allows find_pc_partial_function to be used (as it had
1717 been prior to the introduction of non-contiguous range support) by
1718 various tdep files for finding a start address and limit address
1719 for prologue analysis. This still isn't ideal, however, because we
1720 probably shouldn't be doing prologue analysis (in which
1721 instructions are scanned to determine frame size and stack layout)
1722 for any range that doesn't contain the entry pc. Moreover, a good
1723 argument can be made that prologue analysis ought to be performed
1724 starting from the entry pc even when PC is within some other range.
1725 This might suggest that *ADDRESS and *ENDADDR ought to be set to the
1726 limits of the entry pc range, but that will cause the
1727 *ADDRESS <= PC < *ENDADDR condition to be violated; many of the
1728 callers of find_pc_partial_function expect this condition to hold.
1730 Callers which require the start and/or end addresses for the range
1731 containing the entry pc should instead call
1732 find_function_entry_range_from_pc. */
1734 extern int find_pc_partial_function (CORE_ADDR pc, const char **name,
1735 CORE_ADDR *address, CORE_ADDR *endaddr,
1736 const struct block **block = nullptr);
1738 /* Like find_pc_partial_function, above, but *ADDRESS and *ENDADDR are
1739 set to start and end addresses of the range containing the entry pc.
1741 Note that it is not necessarily the case that (for non-NULL ADDRESS
1742 and ENDADDR arguments) the *ADDRESS <= PC < *ENDADDR condition will
1745 See comment for find_pc_partial_function, above, for further
1748 extern bool find_function_entry_range_from_pc (CORE_ADDR pc,
1751 CORE_ADDR *endaddr);
1753 /* Return the type of a function with its first instruction exactly at
1754 the PC address. Return NULL otherwise. */
1756 extern struct type *find_function_type (CORE_ADDR pc);
1758 /* See if we can figure out the function's actual type from the type
1759 that the resolver returns. RESOLVER_FUNADDR is the address of the
1762 extern struct type *find_gnu_ifunc_target_type (CORE_ADDR resolver_funaddr);
1764 /* Find the GNU ifunc minimal symbol that matches SYM. */
1765 extern bound_minimal_symbol find_gnu_ifunc (const symbol *sym);
1767 extern void clear_pc_function_cache (void);
1769 /* Expand symtab containing PC, SECTION if not already expanded. */
1771 extern void expand_symtab_containing_pc (CORE_ADDR, struct obj_section *);
1773 /* lookup full symbol table by address. */
1775 extern struct compunit_symtab *find_pc_compunit_symtab (CORE_ADDR);
1777 /* lookup full symbol table by address and section. */
1779 extern struct compunit_symtab *
1780 find_pc_sect_compunit_symtab (CORE_ADDR, struct obj_section *);
1782 extern int find_pc_line_pc_range (CORE_ADDR, CORE_ADDR *, CORE_ADDR *);
1784 extern void reread_symbols (void);
1786 /* Look up a type named NAME in STRUCT_DOMAIN in the current language.
1787 The type returned must not be opaque -- i.e., must have at least one field
1790 extern struct type *lookup_transparent_type (const char *);
1792 extern struct type *basic_lookup_transparent_type (const char *);
1794 /* Macro for name of symbol to indicate a file compiled with gcc. */
1795 #ifndef GCC_COMPILED_FLAG_SYMBOL
1796 #define GCC_COMPILED_FLAG_SYMBOL "gcc_compiled."
1799 /* Macro for name of symbol to indicate a file compiled with gcc2. */
1800 #ifndef GCC2_COMPILED_FLAG_SYMBOL
1801 #define GCC2_COMPILED_FLAG_SYMBOL "gcc2_compiled."
1804 extern int in_gnu_ifunc_stub (CORE_ADDR pc);
1806 /* Functions for resolving STT_GNU_IFUNC symbols which are implemented only
1807 for ELF symbol files. */
1809 struct gnu_ifunc_fns
1811 /* See elf_gnu_ifunc_resolve_addr for its real implementation. */
1812 CORE_ADDR (*gnu_ifunc_resolve_addr) (struct gdbarch *gdbarch, CORE_ADDR pc);
1814 /* See elf_gnu_ifunc_resolve_name for its real implementation. */
1815 int (*gnu_ifunc_resolve_name) (const char *function_name,
1816 CORE_ADDR *function_address_p);
1818 /* See elf_gnu_ifunc_resolver_stop for its real implementation. */
1819 void (*gnu_ifunc_resolver_stop) (struct breakpoint *b);
1821 /* See elf_gnu_ifunc_resolver_return_stop for its real implementation. */
1822 void (*gnu_ifunc_resolver_return_stop) (struct breakpoint *b);
1825 #define gnu_ifunc_resolve_addr gnu_ifunc_fns_p->gnu_ifunc_resolve_addr
1826 #define gnu_ifunc_resolve_name gnu_ifunc_fns_p->gnu_ifunc_resolve_name
1827 #define gnu_ifunc_resolver_stop gnu_ifunc_fns_p->gnu_ifunc_resolver_stop
1828 #define gnu_ifunc_resolver_return_stop \
1829 gnu_ifunc_fns_p->gnu_ifunc_resolver_return_stop
1831 extern const struct gnu_ifunc_fns *gnu_ifunc_fns_p;
1833 extern CORE_ADDR find_solib_trampoline_target (struct frame_info *, CORE_ADDR);
1835 struct symtab_and_line
1837 /* The program space of this sal. */
1838 struct program_space *pspace = NULL;
1840 struct symtab *symtab = NULL;
1841 struct symbol *symbol = NULL;
1842 struct obj_section *section = NULL;
1843 struct minimal_symbol *msymbol = NULL;
1844 /* Line number. Line numbers start at 1 and proceed through symtab->nlines.
1845 0 is never a valid line number; it is used to indicate that line number
1846 information is not available. */
1851 bool explicit_pc = false;
1852 bool explicit_line = false;
1854 /* The probe associated with this symtab_and_line. */
1856 /* If PROBE is not NULL, then this is the objfile in which the probe
1858 struct objfile *objfile = NULL;
1863 /* Given a pc value, return line number it is in. Second arg nonzero means
1864 if pc is on the boundary use the previous statement's line number. */
1866 extern struct symtab_and_line find_pc_line (CORE_ADDR, int);
1868 /* Same function, but specify a section as well as an address. */
1870 extern struct symtab_and_line find_pc_sect_line (CORE_ADDR,
1871 struct obj_section *, int);
1873 /* Wrapper around find_pc_line to just return the symtab. */
1875 extern struct symtab *find_pc_line_symtab (CORE_ADDR);
1877 /* Given a symtab and line number, return the pc there. */
1879 extern int find_line_pc (struct symtab *, int, CORE_ADDR *);
1881 extern int find_line_pc_range (struct symtab_and_line, CORE_ADDR *,
1884 extern void resolve_sal_pc (struct symtab_and_line *);
1888 extern void clear_solib (void);
1892 extern int identify_source_line (struct symtab *, int, int, CORE_ADDR);
1894 /* Flags passed as 4th argument to print_source_lines. */
1896 enum print_source_lines_flag
1898 /* Do not print an error message. */
1899 PRINT_SOURCE_LINES_NOERROR = (1 << 0),
1901 /* Print the filename in front of the source lines. */
1902 PRINT_SOURCE_LINES_FILENAME = (1 << 1)
1904 DEF_ENUM_FLAGS_TYPE (enum print_source_lines_flag, print_source_lines_flags);
1906 extern void print_source_lines (struct symtab *, int, int,
1907 print_source_lines_flags);
1909 extern void forget_cached_source_info_for_objfile (struct objfile *);
1910 extern void forget_cached_source_info (void);
1912 extern void select_source_symtab (struct symtab *);
1914 /* The reason we're calling into a completion match list collector
1916 enum class complete_symbol_mode
1918 /* Completing an expression. */
1921 /* Completing a linespec. */
1925 extern void default_collect_symbol_completion_matches_break_on
1926 (completion_tracker &tracker,
1927 complete_symbol_mode mode,
1928 symbol_name_match_type name_match_type,
1929 const char *text, const char *word, const char *break_on,
1930 enum type_code code);
1931 extern void default_collect_symbol_completion_matches
1932 (completion_tracker &tracker,
1933 complete_symbol_mode,
1934 symbol_name_match_type name_match_type,
1938 extern void collect_symbol_completion_matches
1939 (completion_tracker &tracker,
1940 complete_symbol_mode mode,
1941 symbol_name_match_type name_match_type,
1942 const char *, const char *);
1943 extern void collect_symbol_completion_matches_type (completion_tracker &tracker,
1944 const char *, const char *,
1947 extern void collect_file_symbol_completion_matches
1948 (completion_tracker &tracker,
1949 complete_symbol_mode,
1950 symbol_name_match_type name_match_type,
1951 const char *, const char *, const char *);
1953 extern completion_list
1954 make_source_files_completion_list (const char *, const char *);
1956 /* Return whether SYM is a function/method, as opposed to a data symbol. */
1958 extern bool symbol_is_function_or_method (symbol *sym);
1960 /* Return whether MSYMBOL is a function/method, as opposed to a data
1963 extern bool symbol_is_function_or_method (minimal_symbol *msymbol);
1965 /* Return whether SYM should be skipped in completion mode MODE. In
1966 linespec mode, we're only interested in functions/methods. */
1968 template<typename Symbol>
1970 completion_skip_symbol (complete_symbol_mode mode, Symbol *sym)
1972 return (mode == complete_symbol_mode::LINESPEC
1973 && !symbol_is_function_or_method (sym));
1978 int matching_obj_sections (struct obj_section *, struct obj_section *);
1980 extern struct symtab *find_line_symtab (struct symtab *, int, int *, int *);
1982 /* Given a function symbol SYM, find the symtab and line for the start
1983 of the function. If FUNFIRSTLINE is true, we want the first line
1984 of real code inside the function. */
1985 extern symtab_and_line find_function_start_sal (symbol *sym, bool
1988 /* Same, but start with a function address/section instead of a
1990 extern symtab_and_line find_function_start_sal (CORE_ADDR func_addr,
1991 obj_section *section,
1994 extern void skip_prologue_sal (struct symtab_and_line *);
1998 extern CORE_ADDR skip_prologue_using_sal (struct gdbarch *gdbarch,
1999 CORE_ADDR func_addr);
2001 extern struct symbol *fixup_symbol_section (struct symbol *,
2004 /* If MSYMBOL is an text symbol, look for a function debug symbol with
2005 the same address. Returns NULL if not found. This is necessary in
2006 case a function is an alias to some other function, because debug
2007 information is only emitted for the alias target function's
2008 definition, not for the alias. */
2009 extern symbol *find_function_alias_target (bound_minimal_symbol msymbol);
2011 /* Symbol searching */
2012 /* Note: struct symbol_search, search_symbols, et.al. are declared here,
2013 instead of making them local to symtab.c, for gdbtk's sake. */
2015 /* When using search_symbols, a vector of the following structs is
2017 struct symbol_search
2019 symbol_search (int block_, struct symbol *symbol_)
2023 msymbol.minsym = nullptr;
2024 msymbol.objfile = nullptr;
2027 symbol_search (int block_, struct minimal_symbol *minsym,
2028 struct objfile *objfile)
2032 msymbol.minsym = minsym;
2033 msymbol.objfile = objfile;
2036 bool operator< (const symbol_search &other) const
2038 return compare_search_syms (*this, other) < 0;
2041 bool operator== (const symbol_search &other) const
2043 return compare_search_syms (*this, other) == 0;
2046 /* The block in which the match was found. Could be, for example,
2047 STATIC_BLOCK or GLOBAL_BLOCK. */
2050 /* Information describing what was found.
2052 If symbol is NOT NULL, then information was found for this match. */
2053 struct symbol *symbol;
2055 /* If msymbol is non-null, then a match was made on something for
2056 which only minimal_symbols exist. */
2057 struct bound_minimal_symbol msymbol;
2061 static int compare_search_syms (const symbol_search &sym_a,
2062 const symbol_search &sym_b);
2065 extern std::vector<symbol_search> search_symbols (const char *,
2066 enum search_domain, int,
2069 /* The name of the ``main'' function.
2070 FIXME: cagney/2001-03-20: Can't make main_name() const since some
2071 of the calling code currently assumes that the string isn't
2073 extern /*const */ char *main_name (void);
2074 extern enum language main_language (void);
2076 /* Lookup symbol NAME from DOMAIN in MAIN_OBJFILE's global blocks.
2077 This searches MAIN_OBJFILE as well as any associated separate debug info
2078 objfiles of MAIN_OBJFILE.
2079 Upon success fixes up the symbol's section if necessary. */
2081 extern struct block_symbol
2082 lookup_global_symbol_from_objfile (struct objfile *main_objfile,
2084 const domain_enum domain);
2086 /* Return 1 if the supplied producer string matches the ARM RealView
2087 compiler (armcc). */
2088 int producer_is_realview (const char *producer);
2090 void fixup_section (struct general_symbol_info *ginfo,
2091 CORE_ADDR addr, struct objfile *objfile);
2093 /* Look up objfile containing BLOCK. */
2095 struct objfile *lookup_objfile_from_block (const struct block *block);
2097 extern unsigned int symtab_create_debug;
2099 extern unsigned int symbol_lookup_debug;
2101 extern int basenames_may_differ;
2103 int compare_filenames_for_search (const char *filename,
2104 const char *search_name);
2106 int compare_glob_filenames_for_search (const char *filename,
2107 const char *search_name);
2109 bool iterate_over_some_symtabs (const char *name,
2110 const char *real_path,
2111 struct compunit_symtab *first,
2112 struct compunit_symtab *after_last,
2113 gdb::function_view<bool (symtab *)> callback);
2115 void iterate_over_symtabs (const char *name,
2116 gdb::function_view<bool (symtab *)> callback);
2119 std::vector<CORE_ADDR> find_pcs_for_symtab_line
2120 (struct symtab *symtab, int line, struct linetable_entry **best_entry);
2122 /* Prototype for callbacks for LA_ITERATE_OVER_SYMBOLS. The callback
2123 is called once per matching symbol SYM. The callback should return
2124 true to indicate that LA_ITERATE_OVER_SYMBOLS should continue
2125 iterating, or false to indicate that the iteration should end. */
2127 typedef bool (symbol_found_callback_ftype) (symbol *sym);
2129 void iterate_over_symbols (const struct block *block,
2130 const lookup_name_info &name,
2131 const domain_enum domain,
2132 gdb::function_view<symbol_found_callback_ftype> callback);
2134 /* Storage type used by demangle_for_lookup. demangle_for_lookup
2135 either returns a const char * pointer that points to either of the
2136 fields of this type, or a pointer to the input NAME. This is done
2137 this way because the underlying functions that demangle_for_lookup
2138 calls either return a std::string (e.g., cp_canonicalize_string) or
2139 a malloc'ed buffer (libiberty's demangled), and we want to avoid
2140 unnecessary reallocation/string copying. */
2141 class demangle_result_storage
2145 /* Swap the std::string storage with STR, and return a pointer to
2146 the beginning of the new string. */
2147 const char *swap_string (std::string &str)
2149 std::swap (m_string, str);
2150 return m_string.c_str ();
2153 /* Set the malloc storage to now point at PTR. Any previous malloc
2154 storage is released. */
2155 const char *set_malloc_ptr (char *ptr)
2157 m_malloc.reset (ptr);
2164 std::string m_string;
2165 gdb::unique_xmalloc_ptr<char> m_malloc;
2169 demangle_for_lookup (const char *name, enum language lang,
2170 demangle_result_storage &storage);
2172 struct symbol *allocate_symbol (struct objfile *);
2174 void initialize_objfile_symbol (struct symbol *);
2176 struct template_symbol *allocate_template_symbol (struct objfile *);
2178 /* Test to see if the symbol of language SYMBOL_LANGUAGE specified by
2179 SYMNAME (which is already demangled for C++ symbols) matches
2180 SYM_TEXT in the first SYM_TEXT_LEN characters. If so, add it to
2181 the current completion list. */
2182 void completion_list_add_name (completion_tracker &tracker,
2183 language symbol_language,
2184 const char *symname,
2185 const lookup_name_info &lookup_name,
2186 const char *text, const char *word);
2188 #endif /* !defined(SYMTAB_H) */