1 /* Symbol table definitions for GDB.
3 Copyright (C) 1986-2017 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. */
48 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 /* Expression matching. The same as FULL matching in most
64 languages. The same as WILD matching in Ada. */
68 /* Hash the given symbol search name according to LANGUAGE's
70 extern unsigned int search_name_hash (enum language language
,
71 const char *search_name
);
73 /* Ada-specific bits of a lookup_name_info object. This is lazily
74 constructed on demand. */
76 class ada_lookup_name_info final
80 explicit ada_lookup_name_info (const lookup_name_info
&lookup_name
);
82 /* Compare SYMBOL_SEARCH_NAME with our lookup name, using MATCH_TYPE
83 as name match type. Returns true if there's a match, false
84 otherwise. If non-NULL, store the matching results in MATCH. */
85 bool matches (const char *symbol_search_name
,
86 symbol_name_match_type match_type
,
87 completion_match
*match
) const;
89 /* The Ada-encoded lookup name. */
90 const std::string
&lookup_name () const
91 { return m_encoded_name
; }
93 /* Return true if we're supposed to be doing a wild match look
95 bool wild_match_p () const
96 { return m_wild_match_p
; }
98 /* Return true if we're looking up a name inside package
100 bool standard_p () const
101 { return m_standard_p
; }
104 /* The Ada-encoded lookup name. */
105 std::string m_encoded_name
;
107 /* Whether the user-provided lookup name was Ada encoded. If so,
108 then return encoded names in the 'matches' method's 'completion
109 match result' output. */
110 bool m_encoded_p
: 1;
112 /* True if really doing wild matching. Even if the user requests
113 wild matching, some cases require full matching. */
114 bool m_wild_match_p
: 1;
116 /* True if doing a verbatim match. This is true if the decoded
117 version of the symbol name is wrapped in '<'/'>'. This is an
118 escape hatch users can use to look up symbols the Ada encoding
119 does not understand. */
120 bool m_verbatim_p
: 1;
122 /* True if the user specified a symbol name that is inside package
123 Standard. Symbol names inside package Standard are handled
124 specially. We always do a non-wild match of the symbol name
125 without the "standard__" prefix, and only search static and
126 global symbols. This was primarily introduced in order to allow
127 the user to specifically access the standard exceptions using,
128 for instance, Standard.Constraint_Error when Constraint_Error is
129 ambiguous (due to the user defining its own Constraint_Error
130 entity inside its program). */
131 bool m_standard_p
: 1;
134 /* Language-specific bits of a lookup_name_info object, for languages
135 that do name searching using demangled names (C++/D/Go). This is
136 lazily constructed on demand. */
138 struct demangle_for_lookup_info final
141 demangle_for_lookup_info (const lookup_name_info
&lookup_name
,
144 /* The demangled lookup name. */
145 const std::string
&lookup_name () const
146 { return m_demangled_name
; }
149 /* The demangled lookup name. */
150 std::string m_demangled_name
;
153 /* Object that aggregates all information related to a symbol lookup
154 name. I.e., the name that is matched against the symbol's search
155 name. Caches per-language information so that it doesn't require
156 recomputing it for every symbol comparison, like for example the
157 Ada encoded name and the symbol's name hash for a given language.
158 The object is conceptually immutable once constructed, and thus has
159 no setters. This is to prevent some code path from tweaking some
160 property of the lookup name for some local reason and accidentally
161 altering the results of any continuing search(es).
162 lookup_name_info objects are generally passed around as a const
163 reference to reinforce that. (They're not passed around by value
164 because they're not small.) */
165 class lookup_name_info final
168 /* Create a new object. */
169 lookup_name_info (std::string name
,
170 symbol_name_match_type match_type
,
171 bool completion_mode
= false,
172 bool ignore_parameters
= false)
173 : m_match_type (match_type
),
174 m_completion_mode (completion_mode
),
175 m_ignore_parameters (ignore_parameters
),
176 m_name (std::move (name
))
179 /* Getters. See description of each corresponding field. */
180 symbol_name_match_type
match_type () const { return m_match_type
; }
181 bool completion_mode () const { return m_completion_mode
; }
182 const std::string
&name () const { return m_name
; }
183 const bool ignore_parameters () const { return m_ignore_parameters
; }
185 /* Return a version of this lookup name that is usable with
186 comparisons against symbols have no parameter info, such as
187 psymbols and GDB index symbols. */
188 lookup_name_info
make_ignore_params () const
190 return lookup_name_info (m_name
, m_match_type
, m_completion_mode
,
191 true /* ignore params */);
194 /* Get the search name hash for searches in language LANG. */
195 unsigned int search_name_hash (language lang
) const
197 /* Only compute each language's hash once. */
198 if (!m_demangled_hashes_p
[lang
])
200 m_demangled_hashes
[lang
]
201 = ::search_name_hash (lang
, language_lookup_name (lang
).c_str ());
202 m_demangled_hashes_p
[lang
] = true;
204 return m_demangled_hashes
[lang
];
207 /* Get the search name for searches in language LANG. */
208 const std::string
&language_lookup_name (language lang
) const
213 return ada ().lookup_name ();
215 return cplus ().lookup_name ();
217 return d ().lookup_name ();
219 return go ().lookup_name ();
225 /* Get the Ada-specific lookup info. */
226 const ada_lookup_name_info
&ada () const
232 /* Get the C++-specific lookup info. */
233 const demangle_for_lookup_info
&cplus () const
235 maybe_init (m_cplus
, language_cplus
);
239 /* Get the D-specific lookup info. */
240 const demangle_for_lookup_info
&d () const
242 maybe_init (m_d
, language_d
);
246 /* Get the Go-specific lookup info. */
247 const demangle_for_lookup_info
&go () const
249 maybe_init (m_go
, language_go
);
253 /* Get a reference to a lookup_name_info object that matches any
255 static const lookup_name_info
&match_any ();
258 /* Initialize FIELD, if not initialized yet. */
259 template<typename Field
, typename
... Args
>
260 void maybe_init (Field
&field
, Args
&&... args
) const
263 field
.emplace (*this, std::forward
<Args
> (args
)...);
266 /* The lookup info as passed to the ctor. */
267 symbol_name_match_type m_match_type
;
268 bool m_completion_mode
;
269 bool m_ignore_parameters
;
272 /* Language-specific info. These fields are filled lazily the first
273 time a lookup is done in the corresponding language. They're
274 mutable because lookup_name_info objects are typically passed
275 around by const reference (see intro), and they're conceptually
276 "cache" that can always be reconstructed from the non-mutable
278 mutable gdb::optional
<ada_lookup_name_info
> m_ada
;
279 mutable gdb::optional
<demangle_for_lookup_info
> m_cplus
;
280 mutable gdb::optional
<demangle_for_lookup_info
> m_d
;
281 mutable gdb::optional
<demangle_for_lookup_info
> m_go
;
283 /* The demangled hashes. Stored in an array with one entry for each
284 possible language. The second array records whether we've
285 already computed the each language's hash. (These are separate
286 arrays instead of a single array of optional<unsigned> to avoid
287 alignment padding). */
288 mutable std::array
<unsigned int, nr_languages
> m_demangled_hashes
;
289 mutable std::array
<bool, nr_languages
> m_demangled_hashes_p
{};
292 /* Comparison function for completion symbol lookup.
294 Returns true if the symbol name matches against LOOKUP_NAME.
296 SYMBOL_SEARCH_NAME should be a symbol's "search" name.
298 On success and if non-NULL, MATCH is set to point to the symbol
299 name as should be presented to the user as a completion match list
300 element. In most languages, this is the same as the symbol's
301 search name, but in some, like Ada, the display name is dynamically
302 computed within the comparison routine. */
303 typedef bool (symbol_name_matcher_ftype
)
304 (const char *symbol_search_name
,
305 const lookup_name_info
&lookup_name
,
306 completion_match
*match
);
308 /* Some of the structures in this file are space critical.
309 The space-critical structures are:
311 struct general_symbol_info
313 struct partial_symbol
315 These structures are laid out to encourage good packing.
316 They use ENUM_BITFIELD and short int fields, and they order the
317 structure members so that fields less than a word are next
318 to each other so they can be packed together. */
320 /* Rearranged: used ENUM_BITFIELD and rearranged field order in
321 all the space critical structures (plus struct minimal_symbol).
322 Memory usage dropped from 99360768 bytes to 90001408 bytes.
323 I measured this with before-and-after tests of
324 "HEAD-old-gdb -readnow HEAD-old-gdb" and
325 "HEAD-new-gdb -readnow HEAD-old-gdb" on native i686-pc-linux-gnu,
326 red hat linux 8, with LD_LIBRARY_PATH=/usr/lib/debug,
327 typing "maint space 1" at the first command prompt.
329 Here is another measurement (from andrew c):
330 # no /usr/lib/debug, just plain glibc, like a normal user
332 (gdb) break internal_error
334 (gdb) maint internal-error
338 gdb gdb_6_0_branch 2003-08-19 space used: 8896512
339 gdb HEAD 2003-08-19 space used: 8904704
340 gdb HEAD 2003-08-21 space used: 8396800 (+symtab.h)
341 gdb HEAD 2003-08-21 space used: 8265728 (+gdbtypes.h)
343 The third line shows the savings from the optimizations in symtab.h.
344 The fourth line shows the savings from the optimizations in
345 gdbtypes.h. Both optimizations are in gdb HEAD now.
347 --chastain 2003-08-21 */
349 /* Define a structure for the information that is common to all symbol types,
350 including minimal symbols, partial symbols, and full symbols. In a
351 multilanguage environment, some language specific information may need to
352 be recorded along with each symbol. */
354 /* This structure is space critical. See space comments at the top. */
356 struct general_symbol_info
358 /* Name of the symbol. This is a required field. Storage for the
359 name is allocated on the objfile_obstack for the associated
360 objfile. For languages like C++ that make a distinction between
361 the mangled name and demangled name, this is the mangled
366 /* Value of the symbol. Which member of this union to use, and what
367 it means, depends on what kind of symbol this is and its
368 SYMBOL_CLASS. See comments there for more details. All of these
369 are in host byte order (though what they point to might be in
370 target byte order, e.g. LOC_CONST_BYTES). */
376 const struct block
*block
;
378 const gdb_byte
*bytes
;
382 /* A common block. Used with LOC_COMMON_BLOCK. */
384 const struct common_block
*common_block
;
386 /* For opaque typedef struct chain. */
388 struct symbol
*chain
;
392 /* Since one and only one language can apply, wrap the language specific
393 information inside a union. */
397 /* A pointer to an obstack that can be used for storage associated
398 with this symbol. This is only used by Ada, and only when the
399 'ada_mangled' field is zero. */
400 struct obstack
*obstack
;
402 /* This is used by languages which wish to store a demangled name.
403 currently used by Ada, C++, and Objective C. */
404 const char *demangled_name
;
408 /* Record the source code language that applies to this symbol.
409 This is used to select one of the fields from the language specific
412 ENUM_BITFIELD(language
) language
: LANGUAGE_BITS
;
414 /* This is only used by Ada. If set, then the 'demangled_name' field
415 of language_specific is valid. Otherwise, the 'obstack' field is
417 unsigned int ada_mangled
: 1;
419 /* Which section is this symbol in? This is an index into
420 section_offsets for this objfile. Negative means that the symbol
421 does not get relocated relative to a section. */
426 extern void symbol_set_demangled_name (struct general_symbol_info
*,
430 extern const char *symbol_get_demangled_name
431 (const struct general_symbol_info
*);
433 extern CORE_ADDR
symbol_overlayed_address (CORE_ADDR
, struct obj_section
*);
435 /* Note that all the following SYMBOL_* macros are used with the
436 SYMBOL argument being either a partial symbol or
437 a full symbol. Both types have a ginfo field. In particular
438 the SYMBOL_SET_LANGUAGE, SYMBOL_DEMANGLED_NAME, etc.
439 macros cannot be entirely substituted by
440 functions, unless the callers are changed to pass in the ginfo
441 field only, instead of the SYMBOL parameter. */
443 #define SYMBOL_VALUE(symbol) (symbol)->ginfo.value.ivalue
444 #define SYMBOL_VALUE_ADDRESS(symbol) (symbol)->ginfo.value.address
445 #define SYMBOL_VALUE_BYTES(symbol) (symbol)->ginfo.value.bytes
446 #define SYMBOL_VALUE_COMMON_BLOCK(symbol) (symbol)->ginfo.value.common_block
447 #define SYMBOL_BLOCK_VALUE(symbol) (symbol)->ginfo.value.block
448 #define SYMBOL_VALUE_CHAIN(symbol) (symbol)->ginfo.value.chain
449 #define SYMBOL_LANGUAGE(symbol) (symbol)->ginfo.language
450 #define SYMBOL_SECTION(symbol) (symbol)->ginfo.section
451 #define SYMBOL_OBJ_SECTION(objfile, symbol) \
452 (((symbol)->ginfo.section >= 0) \
453 ? (&(((objfile)->sections)[(symbol)->ginfo.section])) \
456 /* Initializes the language dependent portion of a symbol
457 depending upon the language for the symbol. */
458 #define SYMBOL_SET_LANGUAGE(symbol,language,obstack) \
459 (symbol_set_language (&(symbol)->ginfo, (language), (obstack)))
460 extern void symbol_set_language (struct general_symbol_info
*symbol
,
461 enum language language
,
462 struct obstack
*obstack
);
464 /* Set just the linkage name of a symbol; do not try to demangle
465 it. Used for constructs which do not have a mangled name,
466 e.g. struct tags. Unlike SYMBOL_SET_NAMES, linkage_name must
467 be terminated and either already on the objfile's obstack or
468 permanently allocated. */
469 #define SYMBOL_SET_LINKAGE_NAME(symbol,linkage_name) \
470 (symbol)->ginfo.name = (linkage_name)
472 /* Set the linkage and natural names of a symbol, by demangling
474 #define SYMBOL_SET_NAMES(symbol,linkage_name,len,copy_name,objfile) \
475 symbol_set_names (&(symbol)->ginfo, linkage_name, len, copy_name, objfile)
476 extern void symbol_set_names (struct general_symbol_info
*symbol
,
477 const char *linkage_name
, int len
, int copy_name
,
478 struct objfile
*objfile
);
480 /* Now come lots of name accessor macros. Short version as to when to
481 use which: Use SYMBOL_NATURAL_NAME to refer to the name of the
482 symbol in the original source code. Use SYMBOL_LINKAGE_NAME if you
483 want to know what the linker thinks the symbol's name is. Use
484 SYMBOL_PRINT_NAME for output. Use SYMBOL_DEMANGLED_NAME if you
485 specifically need to know whether SYMBOL_NATURAL_NAME and
486 SYMBOL_LINKAGE_NAME are different. */
488 /* Return SYMBOL's "natural" name, i.e. the name that it was called in
489 the original source code. In languages like C++ where symbols may
490 be mangled for ease of manipulation by the linker, this is the
493 #define SYMBOL_NATURAL_NAME(symbol) \
494 (symbol_natural_name (&(symbol)->ginfo))
495 extern const char *symbol_natural_name
496 (const struct general_symbol_info
*symbol
);
498 /* Return SYMBOL's name from the point of view of the linker. In
499 languages like C++ where symbols may be mangled for ease of
500 manipulation by the linker, this is the mangled name; otherwise,
501 it's the same as SYMBOL_NATURAL_NAME. */
503 #define SYMBOL_LINKAGE_NAME(symbol) (symbol)->ginfo.name
505 /* Return the demangled name for a symbol based on the language for
506 that symbol. If no demangled name exists, return NULL. */
507 #define SYMBOL_DEMANGLED_NAME(symbol) \
508 (symbol_demangled_name (&(symbol)->ginfo))
509 extern const char *symbol_demangled_name
510 (const struct general_symbol_info
*symbol
);
512 /* Macro that returns a version of the name of a symbol that is
513 suitable for output. In C++ this is the "demangled" form of the
514 name if demangle is on and the "mangled" form of the name if
515 demangle is off. In other languages this is just the symbol name.
516 The result should never be NULL. Don't use this for internal
517 purposes (e.g. storing in a hashtable): it's only suitable for output.
519 N.B. symbol may be anything with a ginfo member,
520 e.g., struct symbol or struct minimal_symbol. */
522 #define SYMBOL_PRINT_NAME(symbol) \
523 (demangle ? SYMBOL_NATURAL_NAME (symbol) : SYMBOL_LINKAGE_NAME (symbol))
526 /* Macro that returns the name to be used when sorting and searching symbols.
527 In C++, we search for the demangled form of a name,
528 and so sort symbols accordingly. In Ada, however, we search by mangled
529 name. If there is no distinct demangled name, then SYMBOL_SEARCH_NAME
530 returns the same value (same pointer) as SYMBOL_LINKAGE_NAME. */
531 #define SYMBOL_SEARCH_NAME(symbol) \
532 (symbol_search_name (&(symbol)->ginfo))
533 extern const char *symbol_search_name (const struct general_symbol_info
*ginfo
);
535 /* Return true if NAME matches the "search" name of SYMBOL, according
536 to the symbol's language. */
537 #define SYMBOL_MATCHES_SEARCH_NAME(symbol, name) \
538 symbol_matches_search_name (&(symbol)->ginfo, (name))
540 /* Helper for SYMBOL_MATCHES_SEARCH_NAME that works with both symbols
542 extern bool symbol_matches_search_name
543 (const struct general_symbol_info
*gsymbol
,
544 const lookup_name_info
&name
);
546 /* Compute the hash of the given symbol search name of a symbol of
547 language LANGUAGE. */
548 extern unsigned int search_name_hash (enum language language
,
549 const char *search_name
);
551 /* Classification types for a minimal symbol. These should be taken as
552 "advisory only", since if gdb can't easily figure out a
553 classification it simply selects mst_unknown. It may also have to
554 guess when it can't figure out which is a better match between two
555 types (mst_data versus mst_bss) for example. Since the minimal
556 symbol info is sometimes derived from the BFD library's view of a
557 file, we need to live with what information bfd supplies. */
559 enum minimal_symbol_type
561 mst_unknown
= 0, /* Unknown type, the default */
562 mst_text
, /* Generally executable instructions */
563 mst_text_gnu_ifunc
, /* Executable code returning address
564 of executable code */
565 mst_slot_got_plt
, /* GOT entries for .plt sections */
566 mst_data
, /* Generally initialized data */
567 mst_bss
, /* Generally uninitialized data */
568 mst_abs
, /* Generally absolute (nonrelocatable) */
569 /* GDB uses mst_solib_trampoline for the start address of a shared
570 library trampoline entry. Breakpoints for shared library functions
571 are put there if the shared library is not yet loaded.
572 After the shared library is loaded, lookup_minimal_symbol will
573 prefer the minimal symbol from the shared library (usually
574 a mst_text symbol) over the mst_solib_trampoline symbol, and the
575 breakpoints will be moved to their true address in the shared
576 library via breakpoint_re_set. */
577 mst_solib_trampoline
, /* Shared library trampoline code */
578 /* For the mst_file* types, the names are only guaranteed to be unique
579 within a given .o file. */
580 mst_file_text
, /* Static version of mst_text */
581 mst_file_data
, /* Static version of mst_data */
582 mst_file_bss
, /* Static version of mst_bss */
586 /* The number of enum minimal_symbol_type values, with some padding for
587 reasonable growth. */
588 #define MINSYM_TYPE_BITS 4
589 gdb_static_assert (nr_minsym_types
<= (1 << MINSYM_TYPE_BITS
));
591 /* Define a simple structure used to hold some very basic information about
592 all defined global symbols (text, data, bss, abs, etc). The only required
593 information is the general_symbol_info.
595 In many cases, even if a file was compiled with no special options for
596 debugging at all, as long as was not stripped it will contain sufficient
597 information to build a useful minimal symbol table using this structure.
598 Even when a file contains enough debugging information to build a full
599 symbol table, these minimal symbols are still useful for quickly mapping
600 between names and addresses, and vice versa. They are also sometimes
601 used to figure out what full symbol table entries need to be read in. */
603 struct minimal_symbol
606 /* The general symbol info required for all types of symbols.
608 The SYMBOL_VALUE_ADDRESS contains the address that this symbol
611 struct general_symbol_info mginfo
;
613 /* Size of this symbol. dbx_end_psymtab in dbxread.c uses this
614 information to calculate the end of the partial symtab based on the
615 address of the last symbol plus the size of the last symbol. */
619 /* Which source file is this symbol in? Only relevant for mst_file_*. */
620 const char *filename
;
622 /* Classification type for this minimal symbol. */
624 ENUM_BITFIELD(minimal_symbol_type
) type
: MINSYM_TYPE_BITS
;
626 /* Non-zero if this symbol was created by gdb.
627 Such symbols do not appear in the output of "info var|fun". */
628 unsigned int created_by_gdb
: 1;
630 /* Two flag bits provided for the use of the target. */
631 unsigned int target_flag_1
: 1;
632 unsigned int target_flag_2
: 1;
634 /* Nonzero iff the size of the minimal symbol has been set.
635 Symbol size information can sometimes not be determined, because
636 the object file format may not carry that piece of information. */
637 unsigned int has_size
: 1;
639 /* Minimal symbols with the same hash key are kept on a linked
640 list. This is the link. */
642 struct minimal_symbol
*hash_next
;
644 /* Minimal symbols are stored in two different hash tables. This is
645 the `next' pointer for the demangled hash table. */
647 struct minimal_symbol
*demangled_hash_next
;
650 #define MSYMBOL_TARGET_FLAG_1(msymbol) (msymbol)->target_flag_1
651 #define MSYMBOL_TARGET_FLAG_2(msymbol) (msymbol)->target_flag_2
652 #define MSYMBOL_SIZE(msymbol) ((msymbol)->size + 0)
653 #define SET_MSYMBOL_SIZE(msymbol, sz) \
656 (msymbol)->size = sz; \
657 (msymbol)->has_size = 1; \
659 #define MSYMBOL_HAS_SIZE(msymbol) ((msymbol)->has_size + 0)
660 #define MSYMBOL_TYPE(msymbol) (msymbol)->type
662 #define MSYMBOL_VALUE(symbol) (symbol)->mginfo.value.ivalue
663 /* The unrelocated address of the minimal symbol. */
664 #define MSYMBOL_VALUE_RAW_ADDRESS(symbol) ((symbol)->mginfo.value.address + 0)
665 /* The relocated address of the minimal symbol, using the section
666 offsets from OBJFILE. */
667 #define MSYMBOL_VALUE_ADDRESS(objfile, symbol) \
668 ((symbol)->mginfo.value.address \
669 + ANOFFSET ((objfile)->section_offsets, ((symbol)->mginfo.section)))
670 /* For a bound minsym, we can easily compute the address directly. */
671 #define BMSYMBOL_VALUE_ADDRESS(symbol) \
672 MSYMBOL_VALUE_ADDRESS ((symbol).objfile, (symbol).minsym)
673 #define SET_MSYMBOL_VALUE_ADDRESS(symbol, new_value) \
674 ((symbol)->mginfo.value.address = (new_value))
675 #define MSYMBOL_VALUE_BYTES(symbol) (symbol)->mginfo.value.bytes
676 #define MSYMBOL_BLOCK_VALUE(symbol) (symbol)->mginfo.value.block
677 #define MSYMBOL_VALUE_CHAIN(symbol) (symbol)->mginfo.value.chain
678 #define MSYMBOL_LANGUAGE(symbol) (symbol)->mginfo.language
679 #define MSYMBOL_SECTION(symbol) (symbol)->mginfo.section
680 #define MSYMBOL_OBJ_SECTION(objfile, symbol) \
681 (((symbol)->mginfo.section >= 0) \
682 ? (&(((objfile)->sections)[(symbol)->mginfo.section])) \
685 #define MSYMBOL_NATURAL_NAME(symbol) \
686 (symbol_natural_name (&(symbol)->mginfo))
687 #define MSYMBOL_LINKAGE_NAME(symbol) (symbol)->mginfo.name
688 #define MSYMBOL_PRINT_NAME(symbol) \
689 (demangle ? MSYMBOL_NATURAL_NAME (symbol) : MSYMBOL_LINKAGE_NAME (symbol))
690 #define MSYMBOL_DEMANGLED_NAME(symbol) \
691 (symbol_demangled_name (&(symbol)->mginfo))
692 #define MSYMBOL_SET_LANGUAGE(symbol,language,obstack) \
693 (symbol_set_language (&(symbol)->mginfo, (language), (obstack)))
694 #define MSYMBOL_SEARCH_NAME(symbol) \
695 (symbol_search_name (&(symbol)->mginfo))
696 #define MSYMBOL_SET_NAMES(symbol,linkage_name,len,copy_name,objfile) \
697 symbol_set_names (&(symbol)->mginfo, linkage_name, len, copy_name, objfile)
703 /* Represent one symbol name; a variable, constant, function or typedef. */
705 /* Different name domains for symbols. Looking up a symbol specifies a
706 domain and ignores symbol definitions in other name domains. */
708 typedef enum domain_enum_tag
710 /* UNDEF_DOMAIN is used when a domain has not been discovered or
711 none of the following apply. This usually indicates an error either
712 in the symbol information or in gdb's handling of symbols. */
716 /* VAR_DOMAIN is the usual domain. In C, this contains variables,
717 function names, typedef names and enum type values. */
721 /* STRUCT_DOMAIN is used in C to hold struct, union and enum type names.
722 Thus, if `struct foo' is used in a C program, it produces a symbol named
723 `foo' in the STRUCT_DOMAIN. */
727 /* MODULE_DOMAIN is used in Fortran to hold module type names. */
731 /* LABEL_DOMAIN may be used for names of labels (for gotos). */
735 /* Fortran common blocks. Their naming must be separate from VAR_DOMAIN.
736 They also always use LOC_COMMON_BLOCK. */
739 /* This must remain last. */
743 /* The number of bits in a symbol used to represent the domain. */
745 #define SYMBOL_DOMAIN_BITS 3
746 gdb_static_assert (NR_DOMAINS
<= (1 << SYMBOL_DOMAIN_BITS
));
748 extern const char *domain_name (domain_enum
);
750 /* Searching domains, used for `search_symbols'. Element numbers are
751 hardcoded in GDB, check all enum uses before changing it. */
755 /* Everything in VAR_DOMAIN minus FUNCTIONS_DOMAIN and
757 VARIABLES_DOMAIN
= 0,
759 /* All functions -- for some reason not methods, though. */
760 FUNCTIONS_DOMAIN
= 1,
762 /* All defined types */
769 extern const char *search_domain_name (enum search_domain
);
771 /* An address-class says where to find the value of a symbol. */
775 /* Not used; catches errors. */
779 /* Value is constant int SYMBOL_VALUE, host byteorder. */
783 /* Value is at fixed address SYMBOL_VALUE_ADDRESS. */
787 /* Value is in register. SYMBOL_VALUE is the register number
788 in the original debug format. SYMBOL_REGISTER_OPS holds a
789 function that can be called to transform this into the
790 actual register number this represents in a specific target
791 architecture (gdbarch).
793 For some symbol formats (stabs, for some compilers at least),
794 the compiler generates two symbols, an argument and a register.
795 In some cases we combine them to a single LOC_REGISTER in symbol
796 reading, but currently not for all cases (e.g. it's passed on the
797 stack and then loaded into a register). */
801 /* It's an argument; the value is at SYMBOL_VALUE offset in arglist. */
805 /* Value address is at SYMBOL_VALUE offset in arglist. */
809 /* Value is in specified register. Just like LOC_REGISTER except the
810 register holds the address of the argument instead of the argument
811 itself. This is currently used for the passing of structs and unions
812 on sparc and hppa. It is also used for call by reference where the
813 address is in a register, at least by mipsread.c. */
817 /* Value is a local variable at SYMBOL_VALUE offset in stack frame. */
821 /* Value not used; definition in SYMBOL_TYPE. Symbols in the domain
822 STRUCT_DOMAIN all have this class. */
826 /* Value is address SYMBOL_VALUE_ADDRESS in the code. */
830 /* In a symbol table, value is SYMBOL_BLOCK_VALUE of a `struct block'.
831 In a partial symbol table, SYMBOL_VALUE_ADDRESS is the start address
832 of the block. Function names have this class. */
836 /* Value is a constant byte-sequence pointed to by SYMBOL_VALUE_BYTES, in
837 target byte order. */
841 /* Value is at fixed address, but the address of the variable has
842 to be determined from the minimal symbol table whenever the
843 variable is referenced.
844 This happens if debugging information for a global symbol is
845 emitted and the corresponding minimal symbol is defined
846 in another object file or runtime common storage.
847 The linker might even remove the minimal symbol if the global
848 symbol is never referenced, in which case the symbol remains
851 GDB would normally find the symbol in the minimal symbol table if it will
852 not find it in the full symbol table. But a reference to an external
853 symbol in a local block shadowing other definition requires full symbol
854 without possibly having its address available for LOC_STATIC. Testcase
855 is provided as `gdb.dwarf2/dw2-unresolved.exp'.
857 This is also used for thread local storage (TLS) variables. In this case,
858 the address of the TLS variable must be determined when the variable is
859 referenced, from the MSYMBOL_VALUE_RAW_ADDRESS, which is the offset
860 of the TLS variable in the thread local storage of the shared
865 /* The variable does not actually exist in the program.
866 The value is ignored. */
870 /* The variable's address is computed by a set of location
871 functions (see "struct symbol_computed_ops" below). */
874 /* The variable uses general_symbol_info->value->common_block field.
875 It also always uses COMMON_BLOCK_DOMAIN. */
878 /* Not used, just notes the boundary of the enum. */
882 /* The number of bits needed for values in enum address_class, with some
883 padding for reasonable growth, and room for run-time registered address
884 classes. See symtab.c:MAX_SYMBOL_IMPLS.
885 This is a #define so that we can have a assertion elsewhere to
886 verify that we have reserved enough space for synthetic address
888 #define SYMBOL_ACLASS_BITS 5
889 gdb_static_assert (LOC_FINAL_VALUE
<= (1 << SYMBOL_ACLASS_BITS
));
891 /* The methods needed to implement LOC_COMPUTED. These methods can
892 use the symbol's .aux_value for additional per-symbol information.
894 At present this is only used to implement location expressions. */
896 struct symbol_computed_ops
899 /* Return the value of the variable SYMBOL, relative to the stack
900 frame FRAME. If the variable has been optimized out, return
903 Iff `read_needs_frame (SYMBOL)' is not SYMBOL_NEEDS_FRAME, then
904 FRAME may be zero. */
906 struct value
*(*read_variable
) (struct symbol
* symbol
,
907 struct frame_info
* frame
);
909 /* Read variable SYMBOL like read_variable at (callee) FRAME's function
910 entry. SYMBOL should be a function parameter, otherwise
911 NO_ENTRY_VALUE_ERROR will be thrown. */
912 struct value
*(*read_variable_at_entry
) (struct symbol
*symbol
,
913 struct frame_info
*frame
);
915 /* Find the "symbol_needs_kind" value for the given symbol. This
916 value determines whether reading the symbol needs memory (e.g., a
917 global variable), just registers (a thread-local), or a frame (a
919 enum symbol_needs_kind (*get_symbol_read_needs
) (struct symbol
* symbol
);
921 /* Write to STREAM a natural-language description of the location of
922 SYMBOL, in the context of ADDR. */
923 void (*describe_location
) (struct symbol
* symbol
, CORE_ADDR addr
,
924 struct ui_file
* stream
);
926 /* Non-zero if this symbol's address computation is dependent on PC. */
927 unsigned char location_has_loclist
;
929 /* Tracepoint support. Append bytecodes to the tracepoint agent
930 expression AX that push the address of the object SYMBOL. Set
931 VALUE appropriately. Note --- for objects in registers, this
932 needn't emit any code; as long as it sets VALUE properly, then
933 the caller will generate the right code in the process of
934 treating this as an lvalue or rvalue. */
936 void (*tracepoint_var_ref
) (struct symbol
*symbol
, struct agent_expr
*ax
,
937 struct axs_value
*value
);
939 /* Generate C code to compute the location of SYMBOL. The C code is
940 emitted to STREAM. GDBARCH is the current architecture and PC is
941 the PC at which SYMBOL's location should be evaluated.
942 REGISTERS_USED is a vector indexed by register number; the
943 generator function should set an element in this vector if the
944 corresponding register is needed by the location computation.
945 The generated C code must assign the location to a local
946 variable; this variable's name is RESULT_NAME. */
948 void (*generate_c_location
) (struct symbol
*symbol
, string_file
&stream
,
949 struct gdbarch
*gdbarch
,
950 unsigned char *registers_used
,
951 CORE_ADDR pc
, const char *result_name
);
955 /* The methods needed to implement LOC_BLOCK for inferior functions.
956 These methods can use the symbol's .aux_value for additional
957 per-symbol information. */
959 struct symbol_block_ops
961 /* Fill in *START and *LENGTH with DWARF block data of function
962 FRAMEFUNC valid for inferior context address PC. Set *LENGTH to
963 zero if such location is not valid for PC; *START is left
964 uninitialized in such case. */
965 void (*find_frame_base_location
) (struct symbol
*framefunc
, CORE_ADDR pc
,
966 const gdb_byte
**start
, size_t *length
);
968 /* Return the frame base address. FRAME is the frame for which we want to
969 compute the base address while FRAMEFUNC is the symbol for the
970 corresponding function. Return 0 on failure (FRAMEFUNC may not hold the
971 information we need).
973 This method is designed to work with static links (nested functions
974 handling). Static links are function properties whose evaluation returns
975 the frame base address for the enclosing frame. However, there are
976 multiple definitions for "frame base": the content of the frame base
977 register, the CFA as defined by DWARF unwinding information, ...
979 So this specific method is supposed to compute the frame base address such
980 as for nested fuctions, the static link computes the same address. For
981 instance, considering DWARF debugging information, the static link is
982 computed with DW_AT_static_link and this method must be used to compute
983 the corresponding DW_AT_frame_base attribute. */
984 CORE_ADDR (*get_frame_base
) (struct symbol
*framefunc
,
985 struct frame_info
*frame
);
988 /* Functions used with LOC_REGISTER and LOC_REGPARM_ADDR. */
990 struct symbol_register_ops
992 int (*register_number
) (struct symbol
*symbol
, struct gdbarch
*gdbarch
);
995 /* Objects of this type are used to find the address class and the
996 various computed ops vectors of a symbol. */
1000 enum address_class aclass
;
1002 /* Used with LOC_COMPUTED. */
1003 const struct symbol_computed_ops
*ops_computed
;
1005 /* Used with LOC_BLOCK. */
1006 const struct symbol_block_ops
*ops_block
;
1008 /* Used with LOC_REGISTER and LOC_REGPARM_ADDR. */
1009 const struct symbol_register_ops
*ops_register
;
1012 /* This structure is space critical. See space comments at the top. */
1017 /* The general symbol info required for all types of symbols. */
1019 struct general_symbol_info ginfo
;
1021 /* Data type of value */
1025 /* The owner of this symbol.
1026 Which one to use is defined by symbol.is_objfile_owned. */
1030 /* The symbol table containing this symbol. This is the file associated
1031 with LINE. It can be NULL during symbols read-in but it is never NULL
1032 during normal operation. */
1033 struct symtab
*symtab
;
1035 /* For types defined by the architecture. */
1036 struct gdbarch
*arch
;
1041 ENUM_BITFIELD(domain_enum_tag
) domain
: SYMBOL_DOMAIN_BITS
;
1043 /* Address class. This holds an index into the 'symbol_impls'
1044 table. The actual enum address_class value is stored there,
1045 alongside any per-class ops vectors. */
1047 unsigned int aclass_index
: SYMBOL_ACLASS_BITS
;
1049 /* If non-zero then symbol is objfile-owned, use owner.symtab.
1050 Otherwise symbol is arch-owned, use owner.arch. */
1052 unsigned int is_objfile_owned
: 1;
1054 /* Whether this is an argument. */
1056 unsigned is_argument
: 1;
1058 /* Whether this is an inlined function (class LOC_BLOCK only). */
1059 unsigned is_inlined
: 1;
1061 /* True if this is a C++ function symbol with template arguments.
1062 In this case the symbol is really a "struct template_symbol". */
1063 unsigned is_cplus_template_function
: 1;
1065 /* True if this is a Rust virtual table. In this case, the symbol
1066 can be downcast to "struct rust_vtable_symbol". */
1068 unsigned is_rust_vtable
: 1;
1070 /* Line number of this symbol's definition, except for inlined
1071 functions. For an inlined function (class LOC_BLOCK and
1072 SYMBOL_INLINED set) this is the line number of the function's call
1073 site. Inlined function symbols are not definitions, and they are
1074 never found by symbol table lookup.
1075 If this symbol is arch-owned, LINE shall be zero.
1077 FIXME: Should we really make the assumption that nobody will try
1078 to debug files longer than 64K lines? What about machine
1079 generated programs? */
1081 unsigned short line
;
1083 /* An arbitrary data pointer, allowing symbol readers to record
1084 additional information on a per-symbol basis. Note that this data
1085 must be allocated using the same obstack as the symbol itself. */
1086 /* So far it is only used by:
1087 LOC_COMPUTED: to find the location information
1088 LOC_BLOCK (DWARF2 function): information used internally by the
1089 DWARF 2 code --- specifically, the location expression for the frame
1090 base for this function. */
1091 /* FIXME drow/2003-02-21: For the LOC_BLOCK case, it might be better
1092 to add a magic symbol to the block containing this information,
1093 or to have a generic debug info annotation slot for symbols. */
1097 struct symbol
*hash_next
;
1100 /* Several lookup functions return both a symbol and the block in which the
1101 symbol is found. This structure is used in these cases. */
1105 /* The symbol that was found, or NULL if no symbol was found. */
1106 struct symbol
*symbol
;
1108 /* If SYMBOL is not NULL, then this is the block in which the symbol is
1110 const struct block
*block
;
1113 extern const struct symbol_impl
*symbol_impls
;
1115 /* For convenience. All fields are NULL. This means "there is no
1117 extern const struct block_symbol null_block_symbol
;
1119 /* Note: There is no accessor macro for symbol.owner because it is
1122 #define SYMBOL_DOMAIN(symbol) (symbol)->domain
1123 #define SYMBOL_IMPL(symbol) (symbol_impls[(symbol)->aclass_index])
1124 #define SYMBOL_ACLASS_INDEX(symbol) (symbol)->aclass_index
1125 #define SYMBOL_CLASS(symbol) (SYMBOL_IMPL (symbol).aclass)
1126 #define SYMBOL_OBJFILE_OWNED(symbol) ((symbol)->is_objfile_owned)
1127 #define SYMBOL_IS_ARGUMENT(symbol) (symbol)->is_argument
1128 #define SYMBOL_INLINED(symbol) (symbol)->is_inlined
1129 #define SYMBOL_IS_CPLUS_TEMPLATE_FUNCTION(symbol) \
1130 (symbol)->is_cplus_template_function
1131 #define SYMBOL_TYPE(symbol) (symbol)->type
1132 #define SYMBOL_LINE(symbol) (symbol)->line
1133 #define SYMBOL_COMPUTED_OPS(symbol) (SYMBOL_IMPL (symbol).ops_computed)
1134 #define SYMBOL_BLOCK_OPS(symbol) (SYMBOL_IMPL (symbol).ops_block)
1135 #define SYMBOL_REGISTER_OPS(symbol) (SYMBOL_IMPL (symbol).ops_register)
1136 #define SYMBOL_LOCATION_BATON(symbol) (symbol)->aux_value
1138 extern int register_symbol_computed_impl (enum address_class
,
1139 const struct symbol_computed_ops
*);
1141 extern int register_symbol_block_impl (enum address_class aclass
,
1142 const struct symbol_block_ops
*ops
);
1144 extern int register_symbol_register_impl (enum address_class
,
1145 const struct symbol_register_ops
*);
1147 /* Return the OBJFILE of SYMBOL.
1148 It is an error to call this if symbol.is_objfile_owned is false, which
1149 only happens for architecture-provided types. */
1151 extern struct objfile
*symbol_objfile (const struct symbol
*symbol
);
1153 /* Return the ARCH of SYMBOL. */
1155 extern struct gdbarch
*symbol_arch (const struct symbol
*symbol
);
1157 /* Return the SYMTAB of SYMBOL.
1158 It is an error to call this if symbol.is_objfile_owned is false, which
1159 only happens for architecture-provided types. */
1161 extern struct symtab
*symbol_symtab (const struct symbol
*symbol
);
1163 /* Set the symtab of SYMBOL to SYMTAB.
1164 It is an error to call this if symbol.is_objfile_owned is false, which
1165 only happens for architecture-provided types. */
1167 extern void symbol_set_symtab (struct symbol
*symbol
, struct symtab
*symtab
);
1169 /* An instance of this type is used to represent a C++ template
1170 function. A symbol is really of this type iff
1171 SYMBOL_IS_CPLUS_TEMPLATE_FUNCTION is true. */
1173 struct template_symbol
: public symbol
1175 /* The number of template arguments. */
1176 int n_template_arguments
;
1178 /* The template arguments. This is an array with
1179 N_TEMPLATE_ARGUMENTS elements. */
1180 struct symbol
**template_arguments
;
1183 /* A symbol that represents a Rust virtual table object. */
1185 struct rust_vtable_symbol
: public symbol
1187 /* The concrete type for which this vtable was created; that is, in
1188 "impl Trait for Type", this is "Type". */
1189 struct type
*concrete_type
;
1193 /* Each item represents a line-->pc (or the reverse) mapping. This is
1194 somewhat more wasteful of space than one might wish, but since only
1195 the files which are actually debugged are read in to core, we don't
1196 waste much space. */
1198 struct linetable_entry
1204 /* The order of entries in the linetable is significant. They should
1205 be sorted by increasing values of the pc field. If there is more than
1206 one entry for a given pc, then I'm not sure what should happen (and
1207 I not sure whether we currently handle it the best way).
1209 Example: a C for statement generally looks like this
1211 10 0x100 - for the init/test part of a for stmt.
1214 10 0x400 - for the increment part of a for stmt.
1216 If an entry has a line number of zero, it marks the start of a PC
1217 range for which no line number information is available. It is
1218 acceptable, though wasteful of table space, for such a range to be
1225 /* Actually NITEMS elements. If you don't like this use of the
1226 `struct hack', you can shove it up your ANSI (seriously, if the
1227 committee tells us how to do it, we can probably go along). */
1228 struct linetable_entry item
[1];
1231 /* How to relocate the symbols from each section in a symbol file.
1232 Each struct contains an array of offsets.
1233 The ordering and meaning of the offsets is file-type-dependent;
1234 typically it is indexed by section numbers or symbol types or
1235 something like that.
1237 To give us flexibility in changing the internal representation
1238 of these offsets, the ANOFFSET macro must be used to insert and
1239 extract offset values in the struct. */
1241 struct section_offsets
1243 CORE_ADDR offsets
[1]; /* As many as needed. */
1246 #define ANOFFSET(secoff, whichone) \
1248 ? (internal_error (__FILE__, __LINE__, \
1249 _("Section index is uninitialized")), -1) \
1250 : secoff->offsets[whichone])
1252 /* The size of a section_offsets table for N sections. */
1253 #define SIZEOF_N_SECTION_OFFSETS(n) \
1254 (sizeof (struct section_offsets) \
1255 + sizeof (((struct section_offsets *) 0)->offsets) * ((n)-1))
1257 /* Each source file or header is represented by a struct symtab.
1258 The name "symtab" is historical, another name for it is "filetab".
1259 These objects are chained through the `next' field. */
1263 /* Unordered chain of all filetabs in the compunit, with the exception
1264 that the "main" source file is the first entry in the list. */
1266 struct symtab
*next
;
1268 /* Backlink to containing compunit symtab. */
1270 struct compunit_symtab
*compunit_symtab
;
1272 /* Table mapping core addresses to line numbers for this file.
1273 Can be NULL if none. Never shared between different symtabs. */
1275 struct linetable
*linetable
;
1277 /* Name of this source file. This pointer is never NULL. */
1279 const char *filename
;
1281 /* Total number of lines found in source file. */
1285 /* line_charpos[N] is the position of the (N-1)th line of the
1286 source file. "position" means something we can lseek() to; it
1287 is not guaranteed to be useful any other way. */
1291 /* Language of this source file. */
1293 enum language language
;
1295 /* Full name of file as found by searching the source path.
1296 NULL if not yet known. */
1301 #define SYMTAB_COMPUNIT(symtab) ((symtab)->compunit_symtab)
1302 #define SYMTAB_LINETABLE(symtab) ((symtab)->linetable)
1303 #define SYMTAB_LANGUAGE(symtab) ((symtab)->language)
1304 #define SYMTAB_BLOCKVECTOR(symtab) \
1305 COMPUNIT_BLOCKVECTOR (SYMTAB_COMPUNIT (symtab))
1306 #define SYMTAB_OBJFILE(symtab) \
1307 COMPUNIT_OBJFILE (SYMTAB_COMPUNIT (symtab))
1308 #define SYMTAB_PSPACE(symtab) (SYMTAB_OBJFILE (symtab)->pspace)
1309 #define SYMTAB_DIRNAME(symtab) \
1310 COMPUNIT_DIRNAME (SYMTAB_COMPUNIT (symtab))
1312 typedef struct symtab
*symtab_ptr
;
1313 DEF_VEC_P (symtab_ptr
);
1315 /* Compunit symtabs contain the actual "symbol table", aka blockvector, as well
1316 as the list of all source files (what gdb has historically associated with
1318 Additional information is recorded here that is common to all symtabs in a
1319 compilation unit (DWARF or otherwise).
1322 For the case of a program built out of these files:
1331 This is recorded as:
1333 objfile -> foo.c(cu) -> bar.c(cu) -> NULL
1347 where "foo.c(cu)" and "bar.c(cu)" are struct compunit_symtab objects,
1348 and the files foo.c, etc. are struct symtab objects. */
1350 struct compunit_symtab
1352 /* Unordered chain of all compunit symtabs of this objfile. */
1353 struct compunit_symtab
*next
;
1355 /* Object file from which this symtab information was read. */
1356 struct objfile
*objfile
;
1358 /* Name of the symtab.
1359 This is *not* intended to be a usable filename, and is
1360 for debugging purposes only. */
1363 /* Unordered list of file symtabs, except that by convention the "main"
1364 source file (e.g., .c, .cc) is guaranteed to be first.
1365 Each symtab is a file, either the "main" source file (e.g., .c, .cc)
1366 or header (e.g., .h). */
1367 struct symtab
*filetabs
;
1369 /* Last entry in FILETABS list.
1370 Subfiles are added to the end of the list so they accumulate in order,
1371 with the main source subfile living at the front.
1372 The main reason is so that the main source file symtab is at the head
1373 of the list, and the rest appear in order for debugging convenience. */
1374 struct symtab
*last_filetab
;
1376 /* Non-NULL string that identifies the format of the debugging information,
1377 such as "stabs", "dwarf 1", "dwarf 2", "coff", etc. This is mostly useful
1378 for automated testing of gdb but may also be information that is
1379 useful to the user. */
1380 const char *debugformat
;
1382 /* String of producer version information, or NULL if we don't know. */
1383 const char *producer
;
1385 /* Directory in which it was compiled, or NULL if we don't know. */
1386 const char *dirname
;
1388 /* List of all symbol scope blocks for this symtab. It is shared among
1389 all symtabs in a given compilation unit. */
1390 const struct blockvector
*blockvector
;
1392 /* Section in objfile->section_offsets for the blockvector and
1393 the linetable. Probably always SECT_OFF_TEXT. */
1394 int block_line_section
;
1396 /* Symtab has been compiled with both optimizations and debug info so that
1397 GDB may stop skipping prologues as variables locations are valid already
1398 at function entry points. */
1399 unsigned int locations_valid
: 1;
1401 /* DWARF unwinder for this CU is valid even for epilogues (PC at the return
1402 instruction). This is supported by GCC since 4.5.0. */
1403 unsigned int epilogue_unwind_valid
: 1;
1405 /* struct call_site entries for this compilation unit or NULL. */
1406 htab_t call_site_htab
;
1408 /* The macro table for this symtab. Like the blockvector, this
1409 is shared between different symtabs in a given compilation unit.
1410 It's debatable whether it *should* be shared among all the symtabs in
1411 the given compilation unit, but it currently is. */
1412 struct macro_table
*macro_table
;
1414 /* If non-NULL, then this points to a NULL-terminated vector of
1415 included compunits. When searching the static or global
1416 block of this compunit, the corresponding block of all
1417 included compunits will also be searched. Note that this
1418 list must be flattened -- the symbol reader is responsible for
1419 ensuring that this vector contains the transitive closure of all
1420 included compunits. */
1421 struct compunit_symtab
**includes
;
1423 /* If this is an included compunit, this points to one includer
1424 of the table. This user is considered the canonical compunit
1425 containing this one. An included compunit may itself be
1426 included by another. */
1427 struct compunit_symtab
*user
;
1430 #define COMPUNIT_OBJFILE(cust) ((cust)->objfile)
1431 #define COMPUNIT_FILETABS(cust) ((cust)->filetabs)
1432 #define COMPUNIT_DEBUGFORMAT(cust) ((cust)->debugformat)
1433 #define COMPUNIT_PRODUCER(cust) ((cust)->producer)
1434 #define COMPUNIT_DIRNAME(cust) ((cust)->dirname)
1435 #define COMPUNIT_BLOCKVECTOR(cust) ((cust)->blockvector)
1436 #define COMPUNIT_BLOCK_LINE_SECTION(cust) ((cust)->block_line_section)
1437 #define COMPUNIT_LOCATIONS_VALID(cust) ((cust)->locations_valid)
1438 #define COMPUNIT_EPILOGUE_UNWIND_VALID(cust) ((cust)->epilogue_unwind_valid)
1439 #define COMPUNIT_CALL_SITE_HTAB(cust) ((cust)->call_site_htab)
1440 #define COMPUNIT_MACRO_TABLE(cust) ((cust)->macro_table)
1442 /* Iterate over all file tables (struct symtab) within a compunit. */
1444 #define ALL_COMPUNIT_FILETABS(cu, s) \
1445 for ((s) = (cu) -> filetabs; (s) != NULL; (s) = (s) -> next)
1447 /* Return the primary symtab of CUST. */
1449 extern struct symtab
*
1450 compunit_primary_filetab (const struct compunit_symtab
*cust
);
1452 /* Return the language of CUST. */
1454 extern enum language
compunit_language (const struct compunit_symtab
*cust
);
1456 typedef struct compunit_symtab
*compunit_symtab_ptr
;
1457 DEF_VEC_P (compunit_symtab_ptr
);
1461 /* The virtual function table is now an array of structures which have the
1462 form { int16 offset, delta; void *pfn; }.
1464 In normal virtual function tables, OFFSET is unused.
1465 DELTA is the amount which is added to the apparent object's base
1466 address in order to point to the actual object to which the
1467 virtual function should be applied.
1468 PFN is a pointer to the virtual function.
1470 Note that this macro is g++ specific (FIXME). */
1472 #define VTBL_FNADDR_OFFSET 2
1474 /* External variables and functions for the objects described above. */
1476 /* True if we are nested inside psymtab_to_symtab. */
1478 extern int currently_reading_symtab
;
1480 /* symtab.c lookup functions */
1482 extern const char multiple_symbols_ask
[];
1483 extern const char multiple_symbols_all
[];
1484 extern const char multiple_symbols_cancel
[];
1486 const char *multiple_symbols_select_mode (void);
1488 int symbol_matches_domain (enum language symbol_language
,
1489 domain_enum symbol_domain
,
1490 domain_enum domain
);
1492 /* lookup a symbol table by source file name. */
1494 extern struct symtab
*lookup_symtab (const char *);
1496 /* An object of this type is passed as the 'is_a_field_of_this'
1497 argument to lookup_symbol and lookup_symbol_in_language. */
1499 struct field_of_this_result
1501 /* The type in which the field was found. If this is NULL then the
1502 symbol was not found in 'this'. If non-NULL, then one of the
1503 other fields will be non-NULL as well. */
1507 /* If the symbol was found as an ordinary field of 'this', then this
1508 is non-NULL and points to the particular field. */
1510 struct field
*field
;
1512 /* If the symbol was found as a function field of 'this', then this
1513 is non-NULL and points to the particular field. */
1515 struct fn_fieldlist
*fn_field
;
1518 /* Find the definition for a specified symbol name NAME
1519 in domain DOMAIN in language LANGUAGE, visible from lexical block BLOCK
1520 if non-NULL or from global/static blocks if BLOCK is NULL.
1521 Returns the struct symbol pointer, or NULL if no symbol is found.
1522 C++: if IS_A_FIELD_OF_THIS is non-NULL on entry, check to see if
1523 NAME is a field of the current implied argument `this'. If so fill in the
1524 fields of IS_A_FIELD_OF_THIS, otherwise the fields are set to NULL.
1525 The symbol's section is fixed up if necessary. */
1527 extern struct block_symbol
1528 lookup_symbol_in_language (const char *,
1529 const struct block
*,
1532 struct field_of_this_result
*);
1534 /* Same as lookup_symbol_in_language, but using the current language. */
1536 extern struct block_symbol
lookup_symbol (const char *,
1537 const struct block
*,
1539 struct field_of_this_result
*);
1541 /* A default version of lookup_symbol_nonlocal for use by languages
1542 that can't think of anything better to do.
1543 This implements the C lookup rules. */
1545 extern struct block_symbol
1546 basic_lookup_symbol_nonlocal (const struct language_defn
*langdef
,
1548 const struct block
*,
1551 /* Some helper functions for languages that need to write their own
1552 lookup_symbol_nonlocal functions. */
1554 /* Lookup a symbol in the static block associated to BLOCK, if there
1555 is one; do nothing if BLOCK is NULL or a global block.
1556 Upon success fixes up the symbol's section if necessary. */
1558 extern struct block_symbol
1559 lookup_symbol_in_static_block (const char *name
,
1560 const struct block
*block
,
1561 const domain_enum domain
);
1563 /* Search all static file-level symbols for NAME from DOMAIN.
1564 Upon success fixes up the symbol's section if necessary. */
1566 extern struct block_symbol
lookup_static_symbol (const char *name
,
1567 const domain_enum domain
);
1569 /* Lookup a symbol in all files' global blocks.
1571 If BLOCK is non-NULL then it is used for two things:
1572 1) If a target-specific lookup routine for libraries exists, then use the
1573 routine for the objfile of BLOCK, and
1574 2) The objfile of BLOCK is used to assist in determining the search order
1575 if the target requires it.
1576 See gdbarch_iterate_over_objfiles_in_search_order.
1578 Upon success fixes up the symbol's section if necessary. */
1580 extern struct block_symbol
1581 lookup_global_symbol (const char *name
,
1582 const struct block
*block
,
1583 const domain_enum domain
);
1585 /* Lookup a symbol in block BLOCK.
1586 Upon success fixes up the symbol's section if necessary. */
1588 extern struct symbol
*
1589 lookup_symbol_in_block (const char *name
,
1590 const struct block
*block
,
1591 const domain_enum domain
);
1593 /* Look up the `this' symbol for LANG in BLOCK. Return the symbol if
1594 found, or NULL if not found. */
1596 extern struct block_symbol
1597 lookup_language_this (const struct language_defn
*lang
,
1598 const struct block
*block
);
1600 /* Lookup a [struct, union, enum] by name, within a specified block. */
1602 extern struct type
*lookup_struct (const char *, const struct block
*);
1604 extern struct type
*lookup_union (const char *, const struct block
*);
1606 extern struct type
*lookup_enum (const char *, const struct block
*);
1608 /* from blockframe.c: */
1610 /* lookup the function symbol corresponding to the address. */
1612 extern struct symbol
*find_pc_function (CORE_ADDR
);
1614 /* lookup the function corresponding to the address and section. */
1616 extern struct symbol
*find_pc_sect_function (CORE_ADDR
, struct obj_section
*);
1618 /* Find the symbol at the given address. Returns NULL if no symbol
1619 found. Only exact matches for ADDRESS are considered. */
1621 extern struct symbol
*find_symbol_at_address (CORE_ADDR
);
1623 extern int find_pc_partial_function_gnu_ifunc (CORE_ADDR pc
, const char **name
,
1626 int *is_gnu_ifunc_p
);
1628 /* lookup function from address, return name, start addr and end addr. */
1630 extern int find_pc_partial_function (CORE_ADDR
, const char **, CORE_ADDR
*,
1633 extern void clear_pc_function_cache (void);
1635 /* Expand symtab containing PC, SECTION if not already expanded. */
1637 extern void expand_symtab_containing_pc (CORE_ADDR
, struct obj_section
*);
1639 /* lookup full symbol table by address. */
1641 extern struct compunit_symtab
*find_pc_compunit_symtab (CORE_ADDR
);
1643 /* lookup full symbol table by address and section. */
1645 extern struct compunit_symtab
*
1646 find_pc_sect_compunit_symtab (CORE_ADDR
, struct obj_section
*);
1648 extern int find_pc_line_pc_range (CORE_ADDR
, CORE_ADDR
*, CORE_ADDR
*);
1650 extern void reread_symbols (void);
1652 /* Look up a type named NAME in STRUCT_DOMAIN in the current language.
1653 The type returned must not be opaque -- i.e., must have at least one field
1656 extern struct type
*lookup_transparent_type (const char *);
1658 extern struct type
*basic_lookup_transparent_type (const char *);
1660 /* Macro for name of symbol to indicate a file compiled with gcc. */
1661 #ifndef GCC_COMPILED_FLAG_SYMBOL
1662 #define GCC_COMPILED_FLAG_SYMBOL "gcc_compiled."
1665 /* Macro for name of symbol to indicate a file compiled with gcc2. */
1666 #ifndef GCC2_COMPILED_FLAG_SYMBOL
1667 #define GCC2_COMPILED_FLAG_SYMBOL "gcc2_compiled."
1670 extern int in_gnu_ifunc_stub (CORE_ADDR pc
);
1672 /* Functions for resolving STT_GNU_IFUNC symbols which are implemented only
1673 for ELF symbol files. */
1675 struct gnu_ifunc_fns
1677 /* See elf_gnu_ifunc_resolve_addr for its real implementation. */
1678 CORE_ADDR (*gnu_ifunc_resolve_addr
) (struct gdbarch
*gdbarch
, CORE_ADDR pc
);
1680 /* See elf_gnu_ifunc_resolve_name for its real implementation. */
1681 int (*gnu_ifunc_resolve_name
) (const char *function_name
,
1682 CORE_ADDR
*function_address_p
);
1684 /* See elf_gnu_ifunc_resolver_stop for its real implementation. */
1685 void (*gnu_ifunc_resolver_stop
) (struct breakpoint
*b
);
1687 /* See elf_gnu_ifunc_resolver_return_stop for its real implementation. */
1688 void (*gnu_ifunc_resolver_return_stop
) (struct breakpoint
*b
);
1691 #define gnu_ifunc_resolve_addr gnu_ifunc_fns_p->gnu_ifunc_resolve_addr
1692 #define gnu_ifunc_resolve_name gnu_ifunc_fns_p->gnu_ifunc_resolve_name
1693 #define gnu_ifunc_resolver_stop gnu_ifunc_fns_p->gnu_ifunc_resolver_stop
1694 #define gnu_ifunc_resolver_return_stop \
1695 gnu_ifunc_fns_p->gnu_ifunc_resolver_return_stop
1697 extern const struct gnu_ifunc_fns
*gnu_ifunc_fns_p
;
1699 extern CORE_ADDR
find_solib_trampoline_target (struct frame_info
*, CORE_ADDR
);
1701 struct symtab_and_line
1703 /* The program space of this sal. */
1704 struct program_space
*pspace
= NULL
;
1706 struct symtab
*symtab
= NULL
;
1707 struct symbol
*symbol
= NULL
;
1708 struct obj_section
*section
= NULL
;
1709 /* Line number. Line numbers start at 1 and proceed through symtab->nlines.
1710 0 is never a valid line number; it is used to indicate that line number
1711 information is not available. */
1716 bool explicit_pc
= false;
1717 bool explicit_line
= false;
1719 /* The probe associated with this symtab_and_line. */
1720 struct probe
*probe
= NULL
;
1721 /* If PROBE is not NULL, then this is the objfile in which the probe
1723 struct objfile
*objfile
= NULL
;
1728 /* Given a pc value, return line number it is in. Second arg nonzero means
1729 if pc is on the boundary use the previous statement's line number. */
1731 extern struct symtab_and_line
find_pc_line (CORE_ADDR
, int);
1733 /* Same function, but specify a section as well as an address. */
1735 extern struct symtab_and_line
find_pc_sect_line (CORE_ADDR
,
1736 struct obj_section
*, int);
1738 /* Wrapper around find_pc_line to just return the symtab. */
1740 extern struct symtab
*find_pc_line_symtab (CORE_ADDR
);
1742 /* Given a symtab and line number, return the pc there. */
1744 extern int find_line_pc (struct symtab
*, int, CORE_ADDR
*);
1746 extern int find_line_pc_range (struct symtab_and_line
, CORE_ADDR
*,
1749 extern void resolve_sal_pc (struct symtab_and_line
*);
1753 extern void clear_solib (void);
1757 extern int identify_source_line (struct symtab
*, int, int, CORE_ADDR
);
1759 /* Flags passed as 4th argument to print_source_lines. */
1761 enum print_source_lines_flag
1763 /* Do not print an error message. */
1764 PRINT_SOURCE_LINES_NOERROR
= (1 << 0),
1766 /* Print the filename in front of the source lines. */
1767 PRINT_SOURCE_LINES_FILENAME
= (1 << 1)
1769 DEF_ENUM_FLAGS_TYPE (enum print_source_lines_flag
, print_source_lines_flags
);
1771 extern void print_source_lines (struct symtab
*, int, int,
1772 print_source_lines_flags
);
1774 extern void forget_cached_source_info_for_objfile (struct objfile
*);
1775 extern void forget_cached_source_info (void);
1777 extern void select_source_symtab (struct symtab
*);
1779 /* The reason we're calling into a completion match list collector
1781 enum class complete_symbol_mode
1783 /* Completing an expression. */
1786 /* Completing a linespec. */
1790 extern void default_collect_symbol_completion_matches_break_on
1791 (completion_tracker
&tracker
,
1792 complete_symbol_mode mode
,
1793 symbol_name_match_type name_match_type
,
1794 const char *text
, const char *word
, const char *break_on
,
1795 enum type_code code
);
1796 extern void default_collect_symbol_completion_matches
1797 (completion_tracker
&tracker
,
1798 complete_symbol_mode
,
1799 symbol_name_match_type name_match_type
,
1803 extern void collect_symbol_completion_matches
1804 (completion_tracker
&tracker
,
1805 complete_symbol_mode mode
,
1806 symbol_name_match_type name_match_type
,
1807 const char *, const char *);
1808 extern void collect_symbol_completion_matches_type (completion_tracker
&tracker
,
1809 const char *, const char *,
1812 extern void collect_file_symbol_completion_matches
1813 (completion_tracker
&tracker
,
1814 complete_symbol_mode
,
1815 symbol_name_match_type name_match_type
,
1816 const char *, const char *, const char *);
1818 extern completion_list
1819 make_source_files_completion_list (const char *, const char *);
1821 /* Return whether SYM is a function/method, as opposed to a data symbol. */
1823 extern bool symbol_is_function_or_method (symbol
*sym
);
1825 /* Return whether MSYMBOL is a function/method, as opposed to a data
1828 extern bool symbol_is_function_or_method (minimal_symbol
*msymbol
);
1830 /* Return whether SYM should be skipped in completion mode MODE. In
1831 linespec mode, we're only interested in functions/methods. */
1833 template<typename Symbol
>
1835 completion_skip_symbol (complete_symbol_mode mode
, Symbol
*sym
)
1837 return (mode
== complete_symbol_mode::LINESPEC
1838 && !symbol_is_function_or_method (sym
));
1843 int matching_obj_sections (struct obj_section
*, struct obj_section
*);
1845 extern struct symtab
*find_line_symtab (struct symtab
*, int, int *, int *);
1847 extern struct symtab_and_line
find_function_start_sal (struct symbol
*sym
,
1850 extern void skip_prologue_sal (struct symtab_and_line
*);
1854 extern CORE_ADDR
skip_prologue_using_sal (struct gdbarch
*gdbarch
,
1855 CORE_ADDR func_addr
);
1857 extern struct symbol
*fixup_symbol_section (struct symbol
*,
1860 /* If MSYMBOL is an text symbol, look for a function debug symbol with
1861 the same address. Returns NULL if not found. This is necessary in
1862 case a function is an alias to some other function, because debug
1863 information is only emitted for the alias target function's
1864 definition, not for the alias. */
1865 extern symbol
*find_function_alias_target (bound_minimal_symbol msymbol
);
1867 /* Symbol searching */
1868 /* Note: struct symbol_search, search_symbols, et.al. are declared here,
1869 instead of making them local to symtab.c, for gdbtk's sake. */
1871 /* When using search_symbols, a vector of the following structs is
1873 struct symbol_search
1875 symbol_search (int block_
, struct symbol
*symbol_
)
1879 msymbol
.minsym
= nullptr;
1880 msymbol
.objfile
= nullptr;
1883 symbol_search (int block_
, struct minimal_symbol
*minsym
,
1884 struct objfile
*objfile
)
1888 msymbol
.minsym
= minsym
;
1889 msymbol
.objfile
= objfile
;
1892 bool operator< (const symbol_search
&other
) const
1894 return compare_search_syms (*this, other
) < 0;
1897 bool operator== (const symbol_search
&other
) const
1899 return compare_search_syms (*this, other
) == 0;
1902 /* The block in which the match was found. Could be, for example,
1903 STATIC_BLOCK or GLOBAL_BLOCK. */
1906 /* Information describing what was found.
1908 If symbol is NOT NULL, then information was found for this match. */
1909 struct symbol
*symbol
;
1911 /* If msymbol is non-null, then a match was made on something for
1912 which only minimal_symbols exist. */
1913 struct bound_minimal_symbol msymbol
;
1917 static int compare_search_syms (const symbol_search
&sym_a
,
1918 const symbol_search
&sym_b
);
1921 extern std::vector
<symbol_search
> search_symbols (const char *,
1922 enum search_domain
, int,
1925 /* The name of the ``main'' function.
1926 FIXME: cagney/2001-03-20: Can't make main_name() const since some
1927 of the calling code currently assumes that the string isn't
1929 extern /*const */ char *main_name (void);
1930 extern enum language
main_language (void);
1932 /* Lookup symbol NAME from DOMAIN in MAIN_OBJFILE's global blocks.
1933 This searches MAIN_OBJFILE as well as any associated separate debug info
1934 objfiles of MAIN_OBJFILE.
1935 Upon success fixes up the symbol's section if necessary. */
1937 extern struct block_symbol
1938 lookup_global_symbol_from_objfile (struct objfile
*main_objfile
,
1940 const domain_enum domain
);
1942 /* Return 1 if the supplied producer string matches the ARM RealView
1943 compiler (armcc). */
1944 int producer_is_realview (const char *producer
);
1946 void fixup_section (struct general_symbol_info
*ginfo
,
1947 CORE_ADDR addr
, struct objfile
*objfile
);
1949 /* Look up objfile containing BLOCK. */
1951 struct objfile
*lookup_objfile_from_block (const struct block
*block
);
1953 extern unsigned int symtab_create_debug
;
1955 extern unsigned int symbol_lookup_debug
;
1957 extern int basenames_may_differ
;
1959 int compare_filenames_for_search (const char *filename
,
1960 const char *search_name
);
1962 int compare_glob_filenames_for_search (const char *filename
,
1963 const char *search_name
);
1965 bool iterate_over_some_symtabs (const char *name
,
1966 const char *real_path
,
1967 struct compunit_symtab
*first
,
1968 struct compunit_symtab
*after_last
,
1969 gdb::function_view
<bool (symtab
*)> callback
);
1971 void iterate_over_symtabs (const char *name
,
1972 gdb::function_view
<bool (symtab
*)> callback
);
1975 std::vector
<CORE_ADDR
> find_pcs_for_symtab_line
1976 (struct symtab
*symtab
, int line
, struct linetable_entry
**best_entry
);
1978 /* Prototype for callbacks for LA_ITERATE_OVER_SYMBOLS. The callback
1979 is called once per matching symbol SYM. The callback should return
1980 true to indicate that LA_ITERATE_OVER_SYMBOLS should continue
1981 iterating, or false to indicate that the iteration should end. */
1983 typedef bool (symbol_found_callback_ftype
) (symbol
*sym
);
1985 void iterate_over_symbols (const struct block
*block
,
1986 const lookup_name_info
&name
,
1987 const domain_enum domain
,
1988 gdb::function_view
<symbol_found_callback_ftype
> callback
);
1990 /* Storage type used by demangle_for_lookup. demangle_for_lookup
1991 either returns a const char * pointer that points to either of the
1992 fields of this type, or a pointer to the input NAME. This is done
1993 this way because the underlying functions that demangle_for_lookup
1994 calls either return a std::string (e.g., cp_canonicalize_string) or
1995 a malloc'ed buffer (libiberty's demangled), and we want to avoid
1996 unnecessary reallocation/string copying. */
1997 class demangle_result_storage
2001 /* Swap the std::string storage with STR, and return a pointer to
2002 the beginning of the new string. */
2003 const char *swap_string (std::string
&str
)
2005 std::swap (m_string
, str
);
2006 return m_string
.c_str ();
2009 /* Set the malloc storage to now point at PTR. Any previous malloc
2010 storage is released. */
2011 const char *set_malloc_ptr (char *ptr
)
2013 m_malloc
.reset (ptr
);
2020 std::string m_string
;
2021 gdb::unique_xmalloc_ptr
<char> m_malloc
;
2025 demangle_for_lookup (const char *name
, enum language lang
,
2026 demangle_result_storage
&storage
);
2028 struct symbol
*allocate_symbol (struct objfile
*);
2030 void initialize_objfile_symbol (struct symbol
*);
2032 struct template_symbol
*allocate_template_symbol (struct objfile
*);
2034 /* Test to see if the symbol of language SYMBOL_LANGUAGE specified by
2035 SYMNAME (which is already demangled for C++ symbols) matches
2036 SYM_TEXT in the first SYM_TEXT_LEN characters. If so, add it to
2037 the current completion list. */
2038 void completion_list_add_name (completion_tracker
&tracker
,
2039 language symbol_language
,
2040 const char *symname
,
2041 const lookup_name_info
&lookup_name
,
2042 const char *text
, const char *word
);
2044 #endif /* !defined(SYMTAB_H) */