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)
27 #include "common/enum-flags.h"
28 #include "common/function-view.h"
29 #include "common/gdb_optional.h"
30 #include "completer.h"
32 /* Opaque declarations. */
47 struct cmd_list_element
;
48 struct lookup_name_info
;
50 /* How to match a lookup name against a symbol search name. */
51 enum class symbol_name_match_type
53 /* Wild matching. Matches unqualified symbol names in all
54 namespace/module/packages, etc. */
57 /* Full matching. The lookup name indicates a fully-qualified name,
58 and only matches symbol search names in the specified
59 namespace/module/package. */
62 /* Expression matching. The same as FULL matching in most
63 languages. The same as WILD matching in Ada. */
67 /* Hash the given symbol search name according to LANGUAGE's
69 extern unsigned int search_name_hash (enum language language
,
70 const char *search_name
);
72 /* Ada-specific bits of a lookup_name_info object. This is lazily
73 constructed on demand. */
75 class ada_lookup_name_info final
79 explicit ada_lookup_name_info (const lookup_name_info
&lookup_name
);
81 /* Compare SYMBOL_SEARCH_NAME with our lookup name, using MATCH_TYPE
82 as name match type. Returns true if there's a match, false
83 otherwise. If non-NULL, store the matching results in MATCH. */
84 bool matches (const char *symbol_search_name
,
85 symbol_name_match_type match_type
,
86 completion_match
*match
) const;
88 /* The Ada-encoded lookup name. */
89 const std::string
&lookup_name () const
90 { return m_encoded_name
; }
92 /* Return true if we're supposed to be doing a wild match look
94 bool wild_match_p () const
95 { return m_wild_match_p
; }
97 /* Return true if we're looking up a name inside package
99 bool standard_p () const
100 { return m_standard_p
; }
103 /* The Ada-encoded lookup name. */
104 std::string m_encoded_name
;
106 /* Whether the user-provided lookup name was Ada encoded. If so,
107 then return encoded names in the 'matches' method's 'completion
108 match result' output. */
109 bool m_encoded_p
: 1;
111 /* True if really doing wild matching. Even if the user requests
112 wild matching, some cases require full matching. */
113 bool m_wild_match_p
: 1;
115 /* True if doing a verbatim match. This is true if the decoded
116 version of the symbol name is wrapped in '<'/'>'. This is an
117 escape hatch users can use to look up symbols the Ada encoding
118 does not understand. */
119 bool m_verbatim_p
: 1;
121 /* True if the user specified a symbol name that is inside package
122 Standard. Symbol names inside package Standard are handled
123 specially. We always do a non-wild match of the symbol name
124 without the "standard__" prefix, and only search static and
125 global symbols. This was primarily introduced in order to allow
126 the user to specifically access the standard exceptions using,
127 for instance, Standard.Constraint_Error when Constraint_Error is
128 ambiguous (due to the user defining its own Constraint_Error
129 entity inside its program). */
130 bool m_standard_p
: 1;
133 /* Language-specific bits of a lookup_name_info object, for languages
134 that do name searching using demangled names (C++/D/Go). This is
135 lazily constructed on demand. */
137 struct demangle_for_lookup_info final
140 demangle_for_lookup_info (const lookup_name_info
&lookup_name
,
143 /* The demangled lookup name. */
144 const std::string
&lookup_name () const
145 { return m_demangled_name
; }
148 /* The demangled lookup name. */
149 std::string m_demangled_name
;
152 /* Object that aggregates all information related to a symbol lookup
153 name. I.e., the name that is matched against the symbol's search
154 name. Caches per-language information so that it doesn't require
155 recomputing it for every symbol comparison, like for example the
156 Ada encoded name and the symbol's name hash for a given language.
157 The object is conceptually immutable once constructed, and thus has
158 no setters. This is to prevent some code path from tweaking some
159 property of the lookup name for some local reason and accidentally
160 altering the results of any continuing search(es).
161 lookup_name_info objects are generally passed around as a const
162 reference to reinforce that. (They're not passed around by value
163 because they're not small.) */
164 class lookup_name_info final
167 /* Create a new object. */
168 lookup_name_info (std::string name
,
169 symbol_name_match_type match_type
,
170 bool completion_mode
= false,
171 bool ignore_parameters
= false)
172 : m_match_type (match_type
),
173 m_completion_mode (completion_mode
),
174 m_ignore_parameters (ignore_parameters
),
175 m_name (std::move (name
))
178 /* Getters. See description of each corresponding field. */
179 symbol_name_match_type
match_type () const { return m_match_type
; }
180 bool completion_mode () const { return m_completion_mode
; }
181 const std::string
&name () const { return m_name
; }
182 const bool ignore_parameters () const { return m_ignore_parameters
; }
184 /* Return a version of this lookup name that is usable with
185 comparisons against symbols have no parameter info, such as
186 psymbols and GDB index symbols. */
187 lookup_name_info
make_ignore_params () const
189 return lookup_name_info (m_name
, m_match_type
, m_completion_mode
,
190 true /* ignore params */);
193 /* Get the search name hash for searches in language LANG. */
194 unsigned int search_name_hash (language lang
) const
196 /* Only compute each language's hash once. */
197 if (!m_demangled_hashes_p
[lang
])
199 m_demangled_hashes
[lang
]
200 = ::search_name_hash (lang
, language_lookup_name (lang
).c_str ());
201 m_demangled_hashes_p
[lang
] = true;
203 return m_demangled_hashes
[lang
];
206 /* Get the search name for searches in language LANG. */
207 const std::string
&language_lookup_name (language lang
) const
212 return ada ().lookup_name ();
214 return cplus ().lookup_name ();
216 return d ().lookup_name ();
218 return go ().lookup_name ();
224 /* Get the Ada-specific lookup info. */
225 const ada_lookup_name_info
&ada () const
231 /* Get the C++-specific lookup info. */
232 const demangle_for_lookup_info
&cplus () const
234 maybe_init (m_cplus
, language_cplus
);
238 /* Get the D-specific lookup info. */
239 const demangle_for_lookup_info
&d () const
241 maybe_init (m_d
, language_d
);
245 /* Get the Go-specific lookup info. */
246 const demangle_for_lookup_info
&go () const
248 maybe_init (m_go
, language_go
);
252 /* Get a reference to a lookup_name_info object that matches any
254 static const lookup_name_info
&match_any ();
257 /* Initialize FIELD, if not initialized yet. */
258 template<typename Field
, typename
... Args
>
259 void maybe_init (Field
&field
, Args
&&... args
) const
262 field
.emplace (*this, std::forward
<Args
> (args
)...);
265 /* The lookup info as passed to the ctor. */
266 symbol_name_match_type m_match_type
;
267 bool m_completion_mode
;
268 bool m_ignore_parameters
;
271 /* Language-specific info. These fields are filled lazily the first
272 time a lookup is done in the corresponding language. They're
273 mutable because lookup_name_info objects are typically passed
274 around by const reference (see intro), and they're conceptually
275 "cache" that can always be reconstructed from the non-mutable
277 mutable gdb::optional
<ada_lookup_name_info
> m_ada
;
278 mutable gdb::optional
<demangle_for_lookup_info
> m_cplus
;
279 mutable gdb::optional
<demangle_for_lookup_info
> m_d
;
280 mutable gdb::optional
<demangle_for_lookup_info
> m_go
;
282 /* The demangled hashes. Stored in an array with one entry for each
283 possible language. The second array records whether we've
284 already computed the each language's hash. (These are separate
285 arrays instead of a single array of optional<unsigned> to avoid
286 alignment padding). */
287 mutable std::array
<unsigned int, nr_languages
> m_demangled_hashes
;
288 mutable std::array
<bool, nr_languages
> m_demangled_hashes_p
{};
291 /* Comparison function for completion symbol lookup.
293 Returns true if the symbol name matches against LOOKUP_NAME.
295 SYMBOL_SEARCH_NAME should be a symbol's "search" name.
297 On success and if non-NULL, MATCH is set to point to the symbol
298 name as should be presented to the user as a completion match list
299 element. In most languages, this is the same as the symbol's
300 search name, but in some, like Ada, the display name is dynamically
301 computed within the comparison routine. */
302 typedef bool (symbol_name_matcher_ftype
)
303 (const char *symbol_search_name
,
304 const lookup_name_info
&lookup_name
,
305 completion_match
*match
);
307 /* Some of the structures in this file are space critical.
308 The space-critical structures are:
310 struct general_symbol_info
312 struct partial_symbol
314 These structures are laid out to encourage good packing.
315 They use ENUM_BITFIELD and short int fields, and they order the
316 structure members so that fields less than a word are next
317 to each other so they can be packed together. */
319 /* Rearranged: used ENUM_BITFIELD and rearranged field order in
320 all the space critical structures (plus struct minimal_symbol).
321 Memory usage dropped from 99360768 bytes to 90001408 bytes.
322 I measured this with before-and-after tests of
323 "HEAD-old-gdb -readnow HEAD-old-gdb" and
324 "HEAD-new-gdb -readnow HEAD-old-gdb" on native i686-pc-linux-gnu,
325 red hat linux 8, with LD_LIBRARY_PATH=/usr/lib/debug,
326 typing "maint space 1" at the first command prompt.
328 Here is another measurement (from andrew c):
329 # no /usr/lib/debug, just plain glibc, like a normal user
331 (gdb) break internal_error
333 (gdb) maint internal-error
337 gdb gdb_6_0_branch 2003-08-19 space used: 8896512
338 gdb HEAD 2003-08-19 space used: 8904704
339 gdb HEAD 2003-08-21 space used: 8396800 (+symtab.h)
340 gdb HEAD 2003-08-21 space used: 8265728 (+gdbtypes.h)
342 The third line shows the savings from the optimizations in symtab.h.
343 The fourth line shows the savings from the optimizations in
344 gdbtypes.h. Both optimizations are in gdb HEAD now.
346 --chastain 2003-08-21 */
348 /* Define a structure for the information that is common to all symbol types,
349 including minimal symbols, partial symbols, and full symbols. In a
350 multilanguage environment, some language specific information may need to
351 be recorded along with each symbol. */
353 /* This structure is space critical. See space comments at the top. */
355 struct general_symbol_info
357 /* Name of the symbol. This is a required field. Storage for the
358 name is allocated on the objfile_obstack for the associated
359 objfile. For languages like C++ that make a distinction between
360 the mangled name and demangled name, this is the mangled
365 /* Value of the symbol. Which member of this union to use, and what
366 it means, depends on what kind of symbol this is and its
367 SYMBOL_CLASS. See comments there for more details. All of these
368 are in host byte order (though what they point to might be in
369 target byte order, e.g. LOC_CONST_BYTES). */
375 const struct block
*block
;
377 const gdb_byte
*bytes
;
381 /* A common block. Used with LOC_COMMON_BLOCK. */
383 const struct common_block
*common_block
;
385 /* For opaque typedef struct chain. */
387 struct symbol
*chain
;
391 /* Since one and only one language can apply, wrap the language specific
392 information inside a union. */
396 /* A pointer to an obstack that can be used for storage associated
397 with this symbol. This is only used by Ada, and only when the
398 'ada_mangled' field is zero. */
399 struct obstack
*obstack
;
401 /* This is used by languages which wish to store a demangled name.
402 currently used by Ada, C++, and Objective C. */
403 const char *demangled_name
;
407 /* Record the source code language that applies to this symbol.
408 This is used to select one of the fields from the language specific
411 ENUM_BITFIELD(language
) language
: LANGUAGE_BITS
;
413 /* This is only used by Ada. If set, then the 'demangled_name' field
414 of language_specific is valid. Otherwise, the 'obstack' field is
416 unsigned int ada_mangled
: 1;
418 /* Which section is this symbol in? This is an index into
419 section_offsets for this objfile. Negative means that the symbol
420 does not get relocated relative to a section. */
425 extern void symbol_set_demangled_name (struct general_symbol_info
*,
429 extern const char *symbol_get_demangled_name
430 (const struct general_symbol_info
*);
432 extern CORE_ADDR
symbol_overlayed_address (CORE_ADDR
, struct obj_section
*);
434 /* Note that all the following SYMBOL_* macros are used with the
435 SYMBOL argument being either a partial symbol or
436 a full symbol. Both types have a ginfo field. In particular
437 the SYMBOL_SET_LANGUAGE, SYMBOL_DEMANGLED_NAME, etc.
438 macros cannot be entirely substituted by
439 functions, unless the callers are changed to pass in the ginfo
440 field only, instead of the SYMBOL parameter. */
442 #define SYMBOL_VALUE(symbol) (symbol)->ginfo.value.ivalue
443 #define SYMBOL_VALUE_ADDRESS(symbol) (symbol)->ginfo.value.address
444 #define SYMBOL_VALUE_BYTES(symbol) (symbol)->ginfo.value.bytes
445 #define SYMBOL_VALUE_COMMON_BLOCK(symbol) (symbol)->ginfo.value.common_block
446 #define SYMBOL_BLOCK_VALUE(symbol) (symbol)->ginfo.value.block
447 #define SYMBOL_VALUE_CHAIN(symbol) (symbol)->ginfo.value.chain
448 #define SYMBOL_LANGUAGE(symbol) (symbol)->ginfo.language
449 #define SYMBOL_SECTION(symbol) (symbol)->ginfo.section
450 #define SYMBOL_OBJ_SECTION(objfile, symbol) \
451 (((symbol)->ginfo.section >= 0) \
452 ? (&(((objfile)->sections)[(symbol)->ginfo.section])) \
455 /* Initializes the language dependent portion of a symbol
456 depending upon the language for the symbol. */
457 #define SYMBOL_SET_LANGUAGE(symbol,language,obstack) \
458 (symbol_set_language (&(symbol)->ginfo, (language), (obstack)))
459 extern void symbol_set_language (struct general_symbol_info
*symbol
,
460 enum language language
,
461 struct obstack
*obstack
);
463 /* Set just the linkage name of a symbol; do not try to demangle
464 it. Used for constructs which do not have a mangled name,
465 e.g. struct tags. Unlike SYMBOL_SET_NAMES, linkage_name must
466 be terminated and either already on the objfile's obstack or
467 permanently allocated. */
468 #define SYMBOL_SET_LINKAGE_NAME(symbol,linkage_name) \
469 (symbol)->ginfo.name = (linkage_name)
471 /* Set the linkage and natural names of a symbol, by demangling
473 #define SYMBOL_SET_NAMES(symbol,linkage_name,len,copy_name,objfile) \
474 symbol_set_names (&(symbol)->ginfo, linkage_name, len, copy_name, objfile)
475 extern void symbol_set_names (struct general_symbol_info
*symbol
,
476 const char *linkage_name
, int len
, int copy_name
,
477 struct objfile
*objfile
);
479 /* Now come lots of name accessor macros. Short version as to when to
480 use which: Use SYMBOL_NATURAL_NAME to refer to the name of the
481 symbol in the original source code. Use SYMBOL_LINKAGE_NAME if you
482 want to know what the linker thinks the symbol's name is. Use
483 SYMBOL_PRINT_NAME for output. Use SYMBOL_DEMANGLED_NAME if you
484 specifically need to know whether SYMBOL_NATURAL_NAME and
485 SYMBOL_LINKAGE_NAME are different. */
487 /* Return SYMBOL's "natural" name, i.e. the name that it was called in
488 the original source code. In languages like C++ where symbols may
489 be mangled for ease of manipulation by the linker, this is the
492 #define SYMBOL_NATURAL_NAME(symbol) \
493 (symbol_natural_name (&(symbol)->ginfo))
494 extern const char *symbol_natural_name
495 (const struct general_symbol_info
*symbol
);
497 /* Return SYMBOL's name from the point of view of the linker. In
498 languages like C++ where symbols may be mangled for ease of
499 manipulation by the linker, this is the mangled name; otherwise,
500 it's the same as SYMBOL_NATURAL_NAME. */
502 #define SYMBOL_LINKAGE_NAME(symbol) (symbol)->ginfo.name
504 /* Return the demangled name for a symbol based on the language for
505 that symbol. If no demangled name exists, return NULL. */
506 #define SYMBOL_DEMANGLED_NAME(symbol) \
507 (symbol_demangled_name (&(symbol)->ginfo))
508 extern const char *symbol_demangled_name
509 (const struct general_symbol_info
*symbol
);
511 /* Macro that returns a version of the name of a symbol that is
512 suitable for output. In C++ this is the "demangled" form of the
513 name if demangle is on and the "mangled" form of the name if
514 demangle is off. In other languages this is just the symbol name.
515 The result should never be NULL. Don't use this for internal
516 purposes (e.g. storing in a hashtable): it's only suitable for output.
518 N.B. symbol may be anything with a ginfo member,
519 e.g., struct symbol or struct minimal_symbol. */
521 #define SYMBOL_PRINT_NAME(symbol) \
522 (demangle ? SYMBOL_NATURAL_NAME (symbol) : SYMBOL_LINKAGE_NAME (symbol))
525 /* Macro that returns the name to be used when sorting and searching symbols.
526 In C++, we search for the demangled form of a name,
527 and so sort symbols accordingly. In Ada, however, we search by mangled
528 name. If there is no distinct demangled name, then SYMBOL_SEARCH_NAME
529 returns the same value (same pointer) as SYMBOL_LINKAGE_NAME. */
530 #define SYMBOL_SEARCH_NAME(symbol) \
531 (symbol_search_name (&(symbol)->ginfo))
532 extern const char *symbol_search_name (const struct general_symbol_info
*ginfo
);
534 /* Return true if NAME matches the "search" name of SYMBOL, according
535 to the symbol's language. */
536 #define SYMBOL_MATCHES_SEARCH_NAME(symbol, name) \
537 symbol_matches_search_name (&(symbol)->ginfo, (name))
539 /* Helper for SYMBOL_MATCHES_SEARCH_NAME that works with both symbols
541 extern bool symbol_matches_search_name
542 (const struct general_symbol_info
*gsymbol
,
543 const lookup_name_info
&name
);
545 /* Compute the hash of the given symbol search name of a symbol of
546 language LANGUAGE. */
547 extern unsigned int search_name_hash (enum language language
,
548 const char *search_name
);
550 /* Classification types for a minimal symbol. These should be taken as
551 "advisory only", since if gdb can't easily figure out a
552 classification it simply selects mst_unknown. It may also have to
553 guess when it can't figure out which is a better match between two
554 types (mst_data versus mst_bss) for example. Since the minimal
555 symbol info is sometimes derived from the BFD library's view of a
556 file, we need to live with what information bfd supplies. */
558 enum minimal_symbol_type
560 mst_unknown
= 0, /* Unknown type, the default */
561 mst_text
, /* Generally executable instructions */
562 mst_text_gnu_ifunc
, /* Executable code returning address
563 of executable code */
564 mst_slot_got_plt
, /* GOT entries for .plt sections */
565 mst_data
, /* Generally initialized data */
566 mst_bss
, /* Generally uninitialized data */
567 mst_abs
, /* Generally absolute (nonrelocatable) */
568 /* GDB uses mst_solib_trampoline for the start address of a shared
569 library trampoline entry. Breakpoints for shared library functions
570 are put there if the shared library is not yet loaded.
571 After the shared library is loaded, lookup_minimal_symbol will
572 prefer the minimal symbol from the shared library (usually
573 a mst_text symbol) over the mst_solib_trampoline symbol, and the
574 breakpoints will be moved to their true address in the shared
575 library via breakpoint_re_set. */
576 mst_solib_trampoline
, /* Shared library trampoline code */
577 /* For the mst_file* types, the names are only guaranteed to be unique
578 within a given .o file. */
579 mst_file_text
, /* Static version of mst_text */
580 mst_file_data
, /* Static version of mst_data */
581 mst_file_bss
, /* Static version of mst_bss */
585 /* The number of enum minimal_symbol_type values, with some padding for
586 reasonable growth. */
587 #define MINSYM_TYPE_BITS 4
588 gdb_static_assert (nr_minsym_types
<= (1 << MINSYM_TYPE_BITS
));
590 /* Define a simple structure used to hold some very basic information about
591 all defined global symbols (text, data, bss, abs, etc). The only required
592 information is the general_symbol_info.
594 In many cases, even if a file was compiled with no special options for
595 debugging at all, as long as was not stripped it will contain sufficient
596 information to build a useful minimal symbol table using this structure.
597 Even when a file contains enough debugging information to build a full
598 symbol table, these minimal symbols are still useful for quickly mapping
599 between names and addresses, and vice versa. They are also sometimes
600 used to figure out what full symbol table entries need to be read in. */
602 struct minimal_symbol
605 /* The general symbol info required for all types of symbols.
607 The SYMBOL_VALUE_ADDRESS contains the address that this symbol
610 struct general_symbol_info mginfo
;
612 /* Size of this symbol. dbx_end_psymtab in dbxread.c uses this
613 information to calculate the end of the partial symtab based on the
614 address of the last symbol plus the size of the last symbol. */
618 /* Which source file is this symbol in? Only relevant for mst_file_*. */
619 const char *filename
;
621 /* Classification type for this minimal symbol. */
623 ENUM_BITFIELD(minimal_symbol_type
) type
: MINSYM_TYPE_BITS
;
625 /* Non-zero if this symbol was created by gdb.
626 Such symbols do not appear in the output of "info var|fun". */
627 unsigned int created_by_gdb
: 1;
629 /* Two flag bits provided for the use of the target. */
630 unsigned int target_flag_1
: 1;
631 unsigned int target_flag_2
: 1;
633 /* Nonzero iff the size of the minimal symbol has been set.
634 Symbol size information can sometimes not be determined, because
635 the object file format may not carry that piece of information. */
636 unsigned int has_size
: 1;
638 /* Minimal symbols with the same hash key are kept on a linked
639 list. This is the link. */
641 struct minimal_symbol
*hash_next
;
643 /* Minimal symbols are stored in two different hash tables. This is
644 the `next' pointer for the demangled hash table. */
646 struct minimal_symbol
*demangled_hash_next
;
649 #define MSYMBOL_TARGET_FLAG_1(msymbol) (msymbol)->target_flag_1
650 #define MSYMBOL_TARGET_FLAG_2(msymbol) (msymbol)->target_flag_2
651 #define MSYMBOL_SIZE(msymbol) ((msymbol)->size + 0)
652 #define SET_MSYMBOL_SIZE(msymbol, sz) \
655 (msymbol)->size = sz; \
656 (msymbol)->has_size = 1; \
658 #define MSYMBOL_HAS_SIZE(msymbol) ((msymbol)->has_size + 0)
659 #define MSYMBOL_TYPE(msymbol) (msymbol)->type
661 #define MSYMBOL_VALUE(symbol) (symbol)->mginfo.value.ivalue
662 /* The unrelocated address of the minimal symbol. */
663 #define MSYMBOL_VALUE_RAW_ADDRESS(symbol) ((symbol)->mginfo.value.address + 0)
664 /* The relocated address of the minimal symbol, using the section
665 offsets from OBJFILE. */
666 #define MSYMBOL_VALUE_ADDRESS(objfile, symbol) \
667 ((symbol)->mginfo.value.address \
668 + ANOFFSET ((objfile)->section_offsets, ((symbol)->mginfo.section)))
669 /* For a bound minsym, we can easily compute the address directly. */
670 #define BMSYMBOL_VALUE_ADDRESS(symbol) \
671 MSYMBOL_VALUE_ADDRESS ((symbol).objfile, (symbol).minsym)
672 #define SET_MSYMBOL_VALUE_ADDRESS(symbol, new_value) \
673 ((symbol)->mginfo.value.address = (new_value))
674 #define MSYMBOL_VALUE_BYTES(symbol) (symbol)->mginfo.value.bytes
675 #define MSYMBOL_BLOCK_VALUE(symbol) (symbol)->mginfo.value.block
676 #define MSYMBOL_VALUE_CHAIN(symbol) (symbol)->mginfo.value.chain
677 #define MSYMBOL_LANGUAGE(symbol) (symbol)->mginfo.language
678 #define MSYMBOL_SECTION(symbol) (symbol)->mginfo.section
679 #define MSYMBOL_OBJ_SECTION(objfile, symbol) \
680 (((symbol)->mginfo.section >= 0) \
681 ? (&(((objfile)->sections)[(symbol)->mginfo.section])) \
684 #define MSYMBOL_NATURAL_NAME(symbol) \
685 (symbol_natural_name (&(symbol)->mginfo))
686 #define MSYMBOL_LINKAGE_NAME(symbol) (symbol)->mginfo.name
687 #define MSYMBOL_PRINT_NAME(symbol) \
688 (demangle ? MSYMBOL_NATURAL_NAME (symbol) : MSYMBOL_LINKAGE_NAME (symbol))
689 #define MSYMBOL_DEMANGLED_NAME(symbol) \
690 (symbol_demangled_name (&(symbol)->mginfo))
691 #define MSYMBOL_SET_LANGUAGE(symbol,language,obstack) \
692 (symbol_set_language (&(symbol)->mginfo, (language), (obstack)))
693 #define MSYMBOL_SEARCH_NAME(symbol) \
694 (symbol_search_name (&(symbol)->mginfo))
695 #define MSYMBOL_SET_NAMES(symbol,linkage_name,len,copy_name,objfile) \
696 symbol_set_names (&(symbol)->mginfo, linkage_name, len, copy_name, objfile)
702 /* Represent one symbol name; a variable, constant, function or typedef. */
704 /* Different name domains for symbols. Looking up a symbol specifies a
705 domain and ignores symbol definitions in other name domains. */
707 typedef enum domain_enum_tag
709 /* UNDEF_DOMAIN is used when a domain has not been discovered or
710 none of the following apply. This usually indicates an error either
711 in the symbol information or in gdb's handling of symbols. */
715 /* VAR_DOMAIN is the usual domain. In C, this contains variables,
716 function names, typedef names and enum type values. */
720 /* STRUCT_DOMAIN is used in C to hold struct, union and enum type names.
721 Thus, if `struct foo' is used in a C program, it produces a symbol named
722 `foo' in the STRUCT_DOMAIN. */
726 /* MODULE_DOMAIN is used in Fortran to hold module type names. */
730 /* LABEL_DOMAIN may be used for names of labels (for gotos). */
734 /* Fortran common blocks. Their naming must be separate from VAR_DOMAIN.
735 They also always use LOC_COMMON_BLOCK. */
738 /* This must remain last. */
742 /* The number of bits in a symbol used to represent the domain. */
744 #define SYMBOL_DOMAIN_BITS 3
745 gdb_static_assert (NR_DOMAINS
<= (1 << SYMBOL_DOMAIN_BITS
));
747 extern const char *domain_name (domain_enum
);
749 /* Searching domains, used for `search_symbols'. Element numbers are
750 hardcoded in GDB, check all enum uses before changing it. */
754 /* Everything in VAR_DOMAIN minus FUNCTIONS_DOMAIN and
756 VARIABLES_DOMAIN
= 0,
758 /* All functions -- for some reason not methods, though. */
759 FUNCTIONS_DOMAIN
= 1,
761 /* All defined types */
768 extern const char *search_domain_name (enum search_domain
);
770 /* An address-class says where to find the value of a symbol. */
774 /* Not used; catches errors. */
778 /* Value is constant int SYMBOL_VALUE, host byteorder. */
782 /* Value is at fixed address SYMBOL_VALUE_ADDRESS. */
786 /* Value is in register. SYMBOL_VALUE is the register number
787 in the original debug format. SYMBOL_REGISTER_OPS holds a
788 function that can be called to transform this into the
789 actual register number this represents in a specific target
790 architecture (gdbarch).
792 For some symbol formats (stabs, for some compilers at least),
793 the compiler generates two symbols, an argument and a register.
794 In some cases we combine them to a single LOC_REGISTER in symbol
795 reading, but currently not for all cases (e.g. it's passed on the
796 stack and then loaded into a register). */
800 /* It's an argument; the value is at SYMBOL_VALUE offset in arglist. */
804 /* Value address is at SYMBOL_VALUE offset in arglist. */
808 /* Value is in specified register. Just like LOC_REGISTER except the
809 register holds the address of the argument instead of the argument
810 itself. This is currently used for the passing of structs and unions
811 on sparc and hppa. It is also used for call by reference where the
812 address is in a register, at least by mipsread.c. */
816 /* Value is a local variable at SYMBOL_VALUE offset in stack frame. */
820 /* Value not used; definition in SYMBOL_TYPE. Symbols in the domain
821 STRUCT_DOMAIN all have this class. */
825 /* Value is address SYMBOL_VALUE_ADDRESS in the code. */
829 /* In a symbol table, value is SYMBOL_BLOCK_VALUE of a `struct block'.
830 In a partial symbol table, SYMBOL_VALUE_ADDRESS is the start address
831 of the block. Function names have this class. */
835 /* Value is a constant byte-sequence pointed to by SYMBOL_VALUE_BYTES, in
836 target byte order. */
840 /* Value is at fixed address, but the address of the variable has
841 to be determined from the minimal symbol table whenever the
842 variable is referenced.
843 This happens if debugging information for a global symbol is
844 emitted and the corresponding minimal symbol is defined
845 in another object file or runtime common storage.
846 The linker might even remove the minimal symbol if the global
847 symbol is never referenced, in which case the symbol remains
850 GDB would normally find the symbol in the minimal symbol table if it will
851 not find it in the full symbol table. But a reference to an external
852 symbol in a local block shadowing other definition requires full symbol
853 without possibly having its address available for LOC_STATIC. Testcase
854 is provided as `gdb.dwarf2/dw2-unresolved.exp'.
856 This is also used for thread local storage (TLS) variables. In this case,
857 the address of the TLS variable must be determined when the variable is
858 referenced, from the MSYMBOL_VALUE_RAW_ADDRESS, which is the offset
859 of the TLS variable in the thread local storage of the shared
864 /* The variable does not actually exist in the program.
865 The value is ignored. */
869 /* The variable's address is computed by a set of location
870 functions (see "struct symbol_computed_ops" below). */
873 /* The variable uses general_symbol_info->value->common_block field.
874 It also always uses COMMON_BLOCK_DOMAIN. */
877 /* Not used, just notes the boundary of the enum. */
881 /* The number of bits needed for values in enum address_class, with some
882 padding for reasonable growth, and room for run-time registered address
883 classes. See symtab.c:MAX_SYMBOL_IMPLS.
884 This is a #define so that we can have a assertion elsewhere to
885 verify that we have reserved enough space for synthetic address
887 #define SYMBOL_ACLASS_BITS 5
888 gdb_static_assert (LOC_FINAL_VALUE
<= (1 << SYMBOL_ACLASS_BITS
));
890 /* The methods needed to implement LOC_COMPUTED. These methods can
891 use the symbol's .aux_value for additional per-symbol information.
893 At present this is only used to implement location expressions. */
895 struct symbol_computed_ops
898 /* Return the value of the variable SYMBOL, relative to the stack
899 frame FRAME. If the variable has been optimized out, return
902 Iff `read_needs_frame (SYMBOL)' is not SYMBOL_NEEDS_FRAME, then
903 FRAME may be zero. */
905 struct value
*(*read_variable
) (struct symbol
* symbol
,
906 struct frame_info
* frame
);
908 /* Read variable SYMBOL like read_variable at (callee) FRAME's function
909 entry. SYMBOL should be a function parameter, otherwise
910 NO_ENTRY_VALUE_ERROR will be thrown. */
911 struct value
*(*read_variable_at_entry
) (struct symbol
*symbol
,
912 struct frame_info
*frame
);
914 /* Find the "symbol_needs_kind" value for the given symbol. This
915 value determines whether reading the symbol needs memory (e.g., a
916 global variable), just registers (a thread-local), or a frame (a
918 enum symbol_needs_kind (*get_symbol_read_needs
) (struct symbol
* symbol
);
920 /* Write to STREAM a natural-language description of the location of
921 SYMBOL, in the context of ADDR. */
922 void (*describe_location
) (struct symbol
* symbol
, CORE_ADDR addr
,
923 struct ui_file
* stream
);
925 /* Non-zero if this symbol's address computation is dependent on PC. */
926 unsigned char location_has_loclist
;
928 /* Tracepoint support. Append bytecodes to the tracepoint agent
929 expression AX that push the address of the object SYMBOL. Set
930 VALUE appropriately. Note --- for objects in registers, this
931 needn't emit any code; as long as it sets VALUE properly, then
932 the caller will generate the right code in the process of
933 treating this as an lvalue or rvalue. */
935 void (*tracepoint_var_ref
) (struct symbol
*symbol
, struct agent_expr
*ax
,
936 struct axs_value
*value
);
938 /* Generate C code to compute the location of SYMBOL. The C code is
939 emitted to STREAM. GDBARCH is the current architecture and PC is
940 the PC at which SYMBOL's location should be evaluated.
941 REGISTERS_USED is a vector indexed by register number; the
942 generator function should set an element in this vector if the
943 corresponding register is needed by the location computation.
944 The generated C code must assign the location to a local
945 variable; this variable's name is RESULT_NAME. */
947 void (*generate_c_location
) (struct symbol
*symbol
, string_file
&stream
,
948 struct gdbarch
*gdbarch
,
949 unsigned char *registers_used
,
950 CORE_ADDR pc
, const char *result_name
);
954 /* The methods needed to implement LOC_BLOCK for inferior functions.
955 These methods can use the symbol's .aux_value for additional
956 per-symbol information. */
958 struct symbol_block_ops
960 /* Fill in *START and *LENGTH with DWARF block data of function
961 FRAMEFUNC valid for inferior context address PC. Set *LENGTH to
962 zero if such location is not valid for PC; *START is left
963 uninitialized in such case. */
964 void (*find_frame_base_location
) (struct symbol
*framefunc
, CORE_ADDR pc
,
965 const gdb_byte
**start
, size_t *length
);
967 /* Return the frame base address. FRAME is the frame for which we want to
968 compute the base address while FRAMEFUNC is the symbol for the
969 corresponding function. Return 0 on failure (FRAMEFUNC may not hold the
970 information we need).
972 This method is designed to work with static links (nested functions
973 handling). Static links are function properties whose evaluation returns
974 the frame base address for the enclosing frame. However, there are
975 multiple definitions for "frame base": the content of the frame base
976 register, the CFA as defined by DWARF unwinding information, ...
978 So this specific method is supposed to compute the frame base address such
979 as for nested fuctions, the static link computes the same address. For
980 instance, considering DWARF debugging information, the static link is
981 computed with DW_AT_static_link and this method must be used to compute
982 the corresponding DW_AT_frame_base attribute. */
983 CORE_ADDR (*get_frame_base
) (struct symbol
*framefunc
,
984 struct frame_info
*frame
);
987 /* Functions used with LOC_REGISTER and LOC_REGPARM_ADDR. */
989 struct symbol_register_ops
991 int (*register_number
) (struct symbol
*symbol
, struct gdbarch
*gdbarch
);
994 /* Objects of this type are used to find the address class and the
995 various computed ops vectors of a symbol. */
999 enum address_class aclass
;
1001 /* Used with LOC_COMPUTED. */
1002 const struct symbol_computed_ops
*ops_computed
;
1004 /* Used with LOC_BLOCK. */
1005 const struct symbol_block_ops
*ops_block
;
1007 /* Used with LOC_REGISTER and LOC_REGPARM_ADDR. */
1008 const struct symbol_register_ops
*ops_register
;
1011 /* This structure is space critical. See space comments at the top. */
1016 /* The general symbol info required for all types of symbols. */
1018 struct general_symbol_info ginfo
;
1020 /* Data type of value */
1024 /* The owner of this symbol.
1025 Which one to use is defined by symbol.is_objfile_owned. */
1029 /* The symbol table containing this symbol. This is the file associated
1030 with LINE. It can be NULL during symbols read-in but it is never NULL
1031 during normal operation. */
1032 struct symtab
*symtab
;
1034 /* For types defined by the architecture. */
1035 struct gdbarch
*arch
;
1040 ENUM_BITFIELD(domain_enum_tag
) domain
: SYMBOL_DOMAIN_BITS
;
1042 /* Address class. This holds an index into the 'symbol_impls'
1043 table. The actual enum address_class value is stored there,
1044 alongside any per-class ops vectors. */
1046 unsigned int aclass_index
: SYMBOL_ACLASS_BITS
;
1048 /* If non-zero then symbol is objfile-owned, use owner.symtab.
1049 Otherwise symbol is arch-owned, use owner.arch. */
1051 unsigned int is_objfile_owned
: 1;
1053 /* Whether this is an argument. */
1055 unsigned is_argument
: 1;
1057 /* Whether this is an inlined function (class LOC_BLOCK only). */
1058 unsigned is_inlined
: 1;
1060 /* True if this is a C++ function symbol with template arguments.
1061 In this case the symbol is really a "struct template_symbol". */
1062 unsigned is_cplus_template_function
: 1;
1064 /* Line number of this symbol's definition, except for inlined
1065 functions. For an inlined function (class LOC_BLOCK and
1066 SYMBOL_INLINED set) this is the line number of the function's call
1067 site. Inlined function symbols are not definitions, and they are
1068 never found by symbol table lookup.
1069 If this symbol is arch-owned, LINE shall be zero.
1071 FIXME: Should we really make the assumption that nobody will try
1072 to debug files longer than 64K lines? What about machine
1073 generated programs? */
1075 unsigned short line
;
1077 /* An arbitrary data pointer, allowing symbol readers to record
1078 additional information on a per-symbol basis. Note that this data
1079 must be allocated using the same obstack as the symbol itself. */
1080 /* So far it is only used by:
1081 LOC_COMPUTED: to find the location information
1082 LOC_BLOCK (DWARF2 function): information used internally by the
1083 DWARF 2 code --- specifically, the location expression for the frame
1084 base for this function. */
1085 /* FIXME drow/2003-02-21: For the LOC_BLOCK case, it might be better
1086 to add a magic symbol to the block containing this information,
1087 or to have a generic debug info annotation slot for symbols. */
1091 struct symbol
*hash_next
;
1094 /* Several lookup functions return both a symbol and the block in which the
1095 symbol is found. This structure is used in these cases. */
1099 /* The symbol that was found, or NULL if no symbol was found. */
1100 struct symbol
*symbol
;
1102 /* If SYMBOL is not NULL, then this is the block in which the symbol is
1104 const struct block
*block
;
1107 extern const struct symbol_impl
*symbol_impls
;
1109 /* For convenience. All fields are NULL. This means "there is no
1111 extern const struct block_symbol null_block_symbol
;
1113 /* Note: There is no accessor macro for symbol.owner because it is
1116 #define SYMBOL_DOMAIN(symbol) (symbol)->domain
1117 #define SYMBOL_IMPL(symbol) (symbol_impls[(symbol)->aclass_index])
1118 #define SYMBOL_ACLASS_INDEX(symbol) (symbol)->aclass_index
1119 #define SYMBOL_CLASS(symbol) (SYMBOL_IMPL (symbol).aclass)
1120 #define SYMBOL_OBJFILE_OWNED(symbol) ((symbol)->is_objfile_owned)
1121 #define SYMBOL_IS_ARGUMENT(symbol) (symbol)->is_argument
1122 #define SYMBOL_INLINED(symbol) (symbol)->is_inlined
1123 #define SYMBOL_IS_CPLUS_TEMPLATE_FUNCTION(symbol) \
1124 (symbol)->is_cplus_template_function
1125 #define SYMBOL_TYPE(symbol) (symbol)->type
1126 #define SYMBOL_LINE(symbol) (symbol)->line
1127 #define SYMBOL_COMPUTED_OPS(symbol) (SYMBOL_IMPL (symbol).ops_computed)
1128 #define SYMBOL_BLOCK_OPS(symbol) (SYMBOL_IMPL (symbol).ops_block)
1129 #define SYMBOL_REGISTER_OPS(symbol) (SYMBOL_IMPL (symbol).ops_register)
1130 #define SYMBOL_LOCATION_BATON(symbol) (symbol)->aux_value
1132 extern int register_symbol_computed_impl (enum address_class
,
1133 const struct symbol_computed_ops
*);
1135 extern int register_symbol_block_impl (enum address_class aclass
,
1136 const struct symbol_block_ops
*ops
);
1138 extern int register_symbol_register_impl (enum address_class
,
1139 const struct symbol_register_ops
*);
1141 /* Return the OBJFILE of SYMBOL.
1142 It is an error to call this if symbol.is_objfile_owned is false, which
1143 only happens for architecture-provided types. */
1145 extern struct objfile
*symbol_objfile (const struct symbol
*symbol
);
1147 /* Return the ARCH of SYMBOL. */
1149 extern struct gdbarch
*symbol_arch (const struct symbol
*symbol
);
1151 /* Return the SYMTAB of SYMBOL.
1152 It is an error to call this if symbol.is_objfile_owned is false, which
1153 only happens for architecture-provided types. */
1155 extern struct symtab
*symbol_symtab (const struct symbol
*symbol
);
1157 /* Set the symtab of SYMBOL to SYMTAB.
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 void symbol_set_symtab (struct symbol
*symbol
, struct symtab
*symtab
);
1163 /* An instance of this type is used to represent a C++ template
1164 function. It includes a "struct symbol" as a kind of base class;
1165 users downcast to "struct template_symbol *" when needed. A symbol
1166 is really of this type iff SYMBOL_IS_CPLUS_TEMPLATE_FUNCTION is
1169 struct template_symbol
1171 /* The base class. */
1174 /* The number of template arguments. */
1175 int n_template_arguments
;
1177 /* The template arguments. This is an array with
1178 N_TEMPLATE_ARGUMENTS elements. */
1179 struct symbol
**template_arguments
;
1183 /* Each item represents a line-->pc (or the reverse) mapping. This is
1184 somewhat more wasteful of space than one might wish, but since only
1185 the files which are actually debugged are read in to core, we don't
1186 waste much space. */
1188 struct linetable_entry
1194 /* The order of entries in the linetable is significant. They should
1195 be sorted by increasing values of the pc field. If there is more than
1196 one entry for a given pc, then I'm not sure what should happen (and
1197 I not sure whether we currently handle it the best way).
1199 Example: a C for statement generally looks like this
1201 10 0x100 - for the init/test part of a for stmt.
1204 10 0x400 - for the increment part of a for stmt.
1206 If an entry has a line number of zero, it marks the start of a PC
1207 range for which no line number information is available. It is
1208 acceptable, though wasteful of table space, for such a range to be
1215 /* Actually NITEMS elements. If you don't like this use of the
1216 `struct hack', you can shove it up your ANSI (seriously, if the
1217 committee tells us how to do it, we can probably go along). */
1218 struct linetable_entry item
[1];
1221 /* How to relocate the symbols from each section in a symbol file.
1222 Each struct contains an array of offsets.
1223 The ordering and meaning of the offsets is file-type-dependent;
1224 typically it is indexed by section numbers or symbol types or
1225 something like that.
1227 To give us flexibility in changing the internal representation
1228 of these offsets, the ANOFFSET macro must be used to insert and
1229 extract offset values in the struct. */
1231 struct section_offsets
1233 CORE_ADDR offsets
[1]; /* As many as needed. */
1236 #define ANOFFSET(secoff, whichone) \
1238 ? (internal_error (__FILE__, __LINE__, \
1239 _("Section index is uninitialized")), -1) \
1240 : secoff->offsets[whichone])
1242 /* The size of a section_offsets table for N sections. */
1243 #define SIZEOF_N_SECTION_OFFSETS(n) \
1244 (sizeof (struct section_offsets) \
1245 + sizeof (((struct section_offsets *) 0)->offsets) * ((n)-1))
1247 /* Each source file or header is represented by a struct symtab.
1248 The name "symtab" is historical, another name for it is "filetab".
1249 These objects are chained through the `next' field. */
1253 /* Unordered chain of all filetabs in the compunit, with the exception
1254 that the "main" source file is the first entry in the list. */
1256 struct symtab
*next
;
1258 /* Backlink to containing compunit symtab. */
1260 struct compunit_symtab
*compunit_symtab
;
1262 /* Table mapping core addresses to line numbers for this file.
1263 Can be NULL if none. Never shared between different symtabs. */
1265 struct linetable
*linetable
;
1267 /* Name of this source file. This pointer is never NULL. */
1269 const char *filename
;
1271 /* Total number of lines found in source file. */
1275 /* line_charpos[N] is the position of the (N-1)th line of the
1276 source file. "position" means something we can lseek() to; it
1277 is not guaranteed to be useful any other way. */
1281 /* Language of this source file. */
1283 enum language language
;
1285 /* Full name of file as found by searching the source path.
1286 NULL if not yet known. */
1291 #define SYMTAB_COMPUNIT(symtab) ((symtab)->compunit_symtab)
1292 #define SYMTAB_LINETABLE(symtab) ((symtab)->linetable)
1293 #define SYMTAB_LANGUAGE(symtab) ((symtab)->language)
1294 #define SYMTAB_BLOCKVECTOR(symtab) \
1295 COMPUNIT_BLOCKVECTOR (SYMTAB_COMPUNIT (symtab))
1296 #define SYMTAB_OBJFILE(symtab) \
1297 COMPUNIT_OBJFILE (SYMTAB_COMPUNIT (symtab))
1298 #define SYMTAB_PSPACE(symtab) (SYMTAB_OBJFILE (symtab)->pspace)
1299 #define SYMTAB_DIRNAME(symtab) \
1300 COMPUNIT_DIRNAME (SYMTAB_COMPUNIT (symtab))
1302 typedef struct symtab
*symtab_ptr
;
1303 DEF_VEC_P (symtab_ptr
);
1305 /* Compunit symtabs contain the actual "symbol table", aka blockvector, as well
1306 as the list of all source files (what gdb has historically associated with
1308 Additional information is recorded here that is common to all symtabs in a
1309 compilation unit (DWARF or otherwise).
1312 For the case of a program built out of these files:
1321 This is recorded as:
1323 objfile -> foo.c(cu) -> bar.c(cu) -> NULL
1337 where "foo.c(cu)" and "bar.c(cu)" are struct compunit_symtab objects,
1338 and the files foo.c, etc. are struct symtab objects. */
1340 struct compunit_symtab
1342 /* Unordered chain of all compunit symtabs of this objfile. */
1343 struct compunit_symtab
*next
;
1345 /* Object file from which this symtab information was read. */
1346 struct objfile
*objfile
;
1348 /* Name of the symtab.
1349 This is *not* intended to be a usable filename, and is
1350 for debugging purposes only. */
1353 /* Unordered list of file symtabs, except that by convention the "main"
1354 source file (e.g., .c, .cc) is guaranteed to be first.
1355 Each symtab is a file, either the "main" source file (e.g., .c, .cc)
1356 or header (e.g., .h). */
1357 struct symtab
*filetabs
;
1359 /* Last entry in FILETABS list.
1360 Subfiles are added to the end of the list so they accumulate in order,
1361 with the main source subfile living at the front.
1362 The main reason is so that the main source file symtab is at the head
1363 of the list, and the rest appear in order for debugging convenience. */
1364 struct symtab
*last_filetab
;
1366 /* Non-NULL string that identifies the format of the debugging information,
1367 such as "stabs", "dwarf 1", "dwarf 2", "coff", etc. This is mostly useful
1368 for automated testing of gdb but may also be information that is
1369 useful to the user. */
1370 const char *debugformat
;
1372 /* String of producer version information, or NULL if we don't know. */
1373 const char *producer
;
1375 /* Directory in which it was compiled, or NULL if we don't know. */
1376 const char *dirname
;
1378 /* List of all symbol scope blocks for this symtab. It is shared among
1379 all symtabs in a given compilation unit. */
1380 const struct blockvector
*blockvector
;
1382 /* Section in objfile->section_offsets for the blockvector and
1383 the linetable. Probably always SECT_OFF_TEXT. */
1384 int block_line_section
;
1386 /* Symtab has been compiled with both optimizations and debug info so that
1387 GDB may stop skipping prologues as variables locations are valid already
1388 at function entry points. */
1389 unsigned int locations_valid
: 1;
1391 /* DWARF unwinder for this CU is valid even for epilogues (PC at the return
1392 instruction). This is supported by GCC since 4.5.0. */
1393 unsigned int epilogue_unwind_valid
: 1;
1395 /* struct call_site entries for this compilation unit or NULL. */
1396 htab_t call_site_htab
;
1398 /* The macro table for this symtab. Like the blockvector, this
1399 is shared between different symtabs in a given compilation unit.
1400 It's debatable whether it *should* be shared among all the symtabs in
1401 the given compilation unit, but it currently is. */
1402 struct macro_table
*macro_table
;
1404 /* If non-NULL, then this points to a NULL-terminated vector of
1405 included compunits. When searching the static or global
1406 block of this compunit, the corresponding block of all
1407 included compunits will also be searched. Note that this
1408 list must be flattened -- the symbol reader is responsible for
1409 ensuring that this vector contains the transitive closure of all
1410 included compunits. */
1411 struct compunit_symtab
**includes
;
1413 /* If this is an included compunit, this points to one includer
1414 of the table. This user is considered the canonical compunit
1415 containing this one. An included compunit may itself be
1416 included by another. */
1417 struct compunit_symtab
*user
;
1420 #define COMPUNIT_OBJFILE(cust) ((cust)->objfile)
1421 #define COMPUNIT_FILETABS(cust) ((cust)->filetabs)
1422 #define COMPUNIT_DEBUGFORMAT(cust) ((cust)->debugformat)
1423 #define COMPUNIT_PRODUCER(cust) ((cust)->producer)
1424 #define COMPUNIT_DIRNAME(cust) ((cust)->dirname)
1425 #define COMPUNIT_BLOCKVECTOR(cust) ((cust)->blockvector)
1426 #define COMPUNIT_BLOCK_LINE_SECTION(cust) ((cust)->block_line_section)
1427 #define COMPUNIT_LOCATIONS_VALID(cust) ((cust)->locations_valid)
1428 #define COMPUNIT_EPILOGUE_UNWIND_VALID(cust) ((cust)->epilogue_unwind_valid)
1429 #define COMPUNIT_CALL_SITE_HTAB(cust) ((cust)->call_site_htab)
1430 #define COMPUNIT_MACRO_TABLE(cust) ((cust)->macro_table)
1432 /* Iterate over all file tables (struct symtab) within a compunit. */
1434 #define ALL_COMPUNIT_FILETABS(cu, s) \
1435 for ((s) = (cu) -> filetabs; (s) != NULL; (s) = (s) -> next)
1437 /* Return the primary symtab of CUST. */
1439 extern struct symtab
*
1440 compunit_primary_filetab (const struct compunit_symtab
*cust
);
1442 /* Return the language of CUST. */
1444 extern enum language
compunit_language (const struct compunit_symtab
*cust
);
1446 typedef struct compunit_symtab
*compunit_symtab_ptr
;
1447 DEF_VEC_P (compunit_symtab_ptr
);
1451 /* The virtual function table is now an array of structures which have the
1452 form { int16 offset, delta; void *pfn; }.
1454 In normal virtual function tables, OFFSET is unused.
1455 DELTA is the amount which is added to the apparent object's base
1456 address in order to point to the actual object to which the
1457 virtual function should be applied.
1458 PFN is a pointer to the virtual function.
1460 Note that this macro is g++ specific (FIXME). */
1462 #define VTBL_FNADDR_OFFSET 2
1464 /* External variables and functions for the objects described above. */
1466 /* True if we are nested inside psymtab_to_symtab. */
1468 extern int currently_reading_symtab
;
1470 /* symtab.c lookup functions */
1472 extern const char multiple_symbols_ask
[];
1473 extern const char multiple_symbols_all
[];
1474 extern const char multiple_symbols_cancel
[];
1476 const char *multiple_symbols_select_mode (void);
1478 int symbol_matches_domain (enum language symbol_language
,
1479 domain_enum symbol_domain
,
1480 domain_enum domain
);
1482 /* lookup a symbol table by source file name. */
1484 extern struct symtab
*lookup_symtab (const char *);
1486 /* An object of this type is passed as the 'is_a_field_of_this'
1487 argument to lookup_symbol and lookup_symbol_in_language. */
1489 struct field_of_this_result
1491 /* The type in which the field was found. If this is NULL then the
1492 symbol was not found in 'this'. If non-NULL, then one of the
1493 other fields will be non-NULL as well. */
1497 /* If the symbol was found as an ordinary field of 'this', then this
1498 is non-NULL and points to the particular field. */
1500 struct field
*field
;
1502 /* If the symbol was found as a function field of 'this', then this
1503 is non-NULL and points to the particular field. */
1505 struct fn_fieldlist
*fn_field
;
1508 /* Find the definition for a specified symbol name NAME
1509 in domain DOMAIN in language LANGUAGE, visible from lexical block BLOCK
1510 if non-NULL or from global/static blocks if BLOCK is NULL.
1511 Returns the struct symbol pointer, or NULL if no symbol is found.
1512 C++: if IS_A_FIELD_OF_THIS is non-NULL on entry, check to see if
1513 NAME is a field of the current implied argument `this'. If so fill in the
1514 fields of IS_A_FIELD_OF_THIS, otherwise the fields are set to NULL.
1515 The symbol's section is fixed up if necessary. */
1517 extern struct block_symbol
1518 lookup_symbol_in_language (const char *,
1519 const struct block
*,
1522 struct field_of_this_result
*);
1524 /* Same as lookup_symbol_in_language, but using the current language. */
1526 extern struct block_symbol
lookup_symbol (const char *,
1527 const struct block
*,
1529 struct field_of_this_result
*);
1531 /* A default version of lookup_symbol_nonlocal for use by languages
1532 that can't think of anything better to do.
1533 This implements the C lookup rules. */
1535 extern struct block_symbol
1536 basic_lookup_symbol_nonlocal (const struct language_defn
*langdef
,
1538 const struct block
*,
1541 /* Some helper functions for languages that need to write their own
1542 lookup_symbol_nonlocal functions. */
1544 /* Lookup a symbol in the static block associated to BLOCK, if there
1545 is one; do nothing if BLOCK is NULL or a global block.
1546 Upon success fixes up the symbol's section if necessary. */
1548 extern struct block_symbol
1549 lookup_symbol_in_static_block (const char *name
,
1550 const struct block
*block
,
1551 const domain_enum domain
);
1553 /* Search all static file-level symbols for NAME from DOMAIN.
1554 Upon success fixes up the symbol's section if necessary. */
1556 extern struct block_symbol
lookup_static_symbol (const char *name
,
1557 const domain_enum domain
);
1559 /* Lookup a symbol in all files' global blocks.
1561 If BLOCK is non-NULL then it is used for two things:
1562 1) If a target-specific lookup routine for libraries exists, then use the
1563 routine for the objfile of BLOCK, and
1564 2) The objfile of BLOCK is used to assist in determining the search order
1565 if the target requires it.
1566 See gdbarch_iterate_over_objfiles_in_search_order.
1568 Upon success fixes up the symbol's section if necessary. */
1570 extern struct block_symbol
1571 lookup_global_symbol (const char *name
,
1572 const struct block
*block
,
1573 const domain_enum domain
);
1575 /* Lookup a symbol in block BLOCK.
1576 Upon success fixes up the symbol's section if necessary. */
1578 extern struct symbol
*
1579 lookup_symbol_in_block (const char *name
,
1580 const struct block
*block
,
1581 const domain_enum domain
);
1583 /* Look up the `this' symbol for LANG in BLOCK. Return the symbol if
1584 found, or NULL if not found. */
1586 extern struct block_symbol
1587 lookup_language_this (const struct language_defn
*lang
,
1588 const struct block
*block
);
1590 /* Lookup a [struct, union, enum] by name, within a specified block. */
1592 extern struct type
*lookup_struct (const char *, const struct block
*);
1594 extern struct type
*lookup_union (const char *, const struct block
*);
1596 extern struct type
*lookup_enum (const char *, const struct block
*);
1598 /* from blockframe.c: */
1600 /* lookup the function symbol corresponding to the address. */
1602 extern struct symbol
*find_pc_function (CORE_ADDR
);
1604 /* lookup the function corresponding to the address and section. */
1606 extern struct symbol
*find_pc_sect_function (CORE_ADDR
, struct obj_section
*);
1608 extern int find_pc_partial_function_gnu_ifunc (CORE_ADDR pc
, const char **name
,
1611 int *is_gnu_ifunc_p
);
1613 /* lookup function from address, return name, start addr and end addr. */
1615 extern int find_pc_partial_function (CORE_ADDR
, const char **, CORE_ADDR
*,
1618 extern void clear_pc_function_cache (void);
1620 /* Expand symtab containing PC, SECTION if not already expanded. */
1622 extern void expand_symtab_containing_pc (CORE_ADDR
, struct obj_section
*);
1624 /* lookup full symbol table by address. */
1626 extern struct compunit_symtab
*find_pc_compunit_symtab (CORE_ADDR
);
1628 /* lookup full symbol table by address and section. */
1630 extern struct compunit_symtab
*
1631 find_pc_sect_compunit_symtab (CORE_ADDR
, struct obj_section
*);
1633 extern int find_pc_line_pc_range (CORE_ADDR
, CORE_ADDR
*, CORE_ADDR
*);
1635 extern void reread_symbols (void);
1637 /* Look up a type named NAME in STRUCT_DOMAIN in the current language.
1638 The type returned must not be opaque -- i.e., must have at least one field
1641 extern struct type
*lookup_transparent_type (const char *);
1643 extern struct type
*basic_lookup_transparent_type (const char *);
1645 /* Macro for name of symbol to indicate a file compiled with gcc. */
1646 #ifndef GCC_COMPILED_FLAG_SYMBOL
1647 #define GCC_COMPILED_FLAG_SYMBOL "gcc_compiled."
1650 /* Macro for name of symbol to indicate a file compiled with gcc2. */
1651 #ifndef GCC2_COMPILED_FLAG_SYMBOL
1652 #define GCC2_COMPILED_FLAG_SYMBOL "gcc2_compiled."
1655 extern int in_gnu_ifunc_stub (CORE_ADDR pc
);
1657 /* Functions for resolving STT_GNU_IFUNC symbols which are implemented only
1658 for ELF symbol files. */
1660 struct gnu_ifunc_fns
1662 /* See elf_gnu_ifunc_resolve_addr for its real implementation. */
1663 CORE_ADDR (*gnu_ifunc_resolve_addr
) (struct gdbarch
*gdbarch
, CORE_ADDR pc
);
1665 /* See elf_gnu_ifunc_resolve_name for its real implementation. */
1666 int (*gnu_ifunc_resolve_name
) (const char *function_name
,
1667 CORE_ADDR
*function_address_p
);
1669 /* See elf_gnu_ifunc_resolver_stop for its real implementation. */
1670 void (*gnu_ifunc_resolver_stop
) (struct breakpoint
*b
);
1672 /* See elf_gnu_ifunc_resolver_return_stop for its real implementation. */
1673 void (*gnu_ifunc_resolver_return_stop
) (struct breakpoint
*b
);
1676 #define gnu_ifunc_resolve_addr gnu_ifunc_fns_p->gnu_ifunc_resolve_addr
1677 #define gnu_ifunc_resolve_name gnu_ifunc_fns_p->gnu_ifunc_resolve_name
1678 #define gnu_ifunc_resolver_stop gnu_ifunc_fns_p->gnu_ifunc_resolver_stop
1679 #define gnu_ifunc_resolver_return_stop \
1680 gnu_ifunc_fns_p->gnu_ifunc_resolver_return_stop
1682 extern const struct gnu_ifunc_fns
*gnu_ifunc_fns_p
;
1684 extern CORE_ADDR
find_solib_trampoline_target (struct frame_info
*, CORE_ADDR
);
1686 struct symtab_and_line
1688 /* The program space of this sal. */
1689 struct program_space
*pspace
= NULL
;
1691 struct symtab
*symtab
= NULL
;
1692 struct symbol
*symbol
= NULL
;
1693 struct obj_section
*section
= NULL
;
1694 /* Line number. Line numbers start at 1 and proceed through symtab->nlines.
1695 0 is never a valid line number; it is used to indicate that line number
1696 information is not available. */
1701 bool explicit_pc
= false;
1702 bool explicit_line
= false;
1704 /* The probe associated with this symtab_and_line. */
1705 struct probe
*probe
= NULL
;
1706 /* If PROBE is not NULL, then this is the objfile in which the probe
1708 struct objfile
*objfile
= NULL
;
1713 /* Given a pc value, return line number it is in. Second arg nonzero means
1714 if pc is on the boundary use the previous statement's line number. */
1716 extern struct symtab_and_line
find_pc_line (CORE_ADDR
, int);
1718 /* Same function, but specify a section as well as an address. */
1720 extern struct symtab_and_line
find_pc_sect_line (CORE_ADDR
,
1721 struct obj_section
*, int);
1723 /* Wrapper around find_pc_line to just return the symtab. */
1725 extern struct symtab
*find_pc_line_symtab (CORE_ADDR
);
1727 /* Given a symtab and line number, return the pc there. */
1729 extern int find_line_pc (struct symtab
*, int, CORE_ADDR
*);
1731 extern int find_line_pc_range (struct symtab_and_line
, CORE_ADDR
*,
1734 extern void resolve_sal_pc (struct symtab_and_line
*);
1738 extern void clear_solib (void);
1742 extern int identify_source_line (struct symtab
*, int, int, CORE_ADDR
);
1744 /* Flags passed as 4th argument to print_source_lines. */
1746 enum print_source_lines_flag
1748 /* Do not print an error message. */
1749 PRINT_SOURCE_LINES_NOERROR
= (1 << 0),
1751 /* Print the filename in front of the source lines. */
1752 PRINT_SOURCE_LINES_FILENAME
= (1 << 1)
1754 DEF_ENUM_FLAGS_TYPE (enum print_source_lines_flag
, print_source_lines_flags
);
1756 extern void print_source_lines (struct symtab
*, int, int,
1757 print_source_lines_flags
);
1759 extern void forget_cached_source_info_for_objfile (struct objfile
*);
1760 extern void forget_cached_source_info (void);
1762 extern void select_source_symtab (struct symtab
*);
1764 /* The reason we're calling into a completion match list collector
1766 enum class complete_symbol_mode
1768 /* Completing an expression. */
1771 /* Completing a linespec. */
1775 extern void default_collect_symbol_completion_matches_break_on
1776 (completion_tracker
&tracker
,
1777 complete_symbol_mode mode
,
1778 symbol_name_match_type name_match_type
,
1779 const char *text
, const char *word
, const char *break_on
,
1780 enum type_code code
);
1781 extern void default_collect_symbol_completion_matches
1782 (completion_tracker
&tracker
,
1783 complete_symbol_mode
,
1784 symbol_name_match_type name_match_type
,
1788 extern void collect_symbol_completion_matches
1789 (completion_tracker
&tracker
,
1790 complete_symbol_mode mode
,
1791 symbol_name_match_type name_match_type
,
1792 const char *, const char *);
1793 extern void collect_symbol_completion_matches_type (completion_tracker
&tracker
,
1794 const char *, const char *,
1797 extern void collect_file_symbol_completion_matches
1798 (completion_tracker
&tracker
,
1799 complete_symbol_mode
,
1800 symbol_name_match_type name_match_type
,
1801 const char *, const char *, const char *);
1803 extern completion_list
1804 make_source_files_completion_list (const char *, const char *);
1806 /* Return whether SYM is a function/method, as opposed to a data symbol. */
1808 extern bool symbol_is_function_or_method (symbol
*sym
);
1810 /* Return whether MSYMBOL is a function/method, as opposed to a data
1813 extern bool symbol_is_function_or_method (minimal_symbol
*msymbol
);
1815 /* Return whether SYM should be skipped in completion mode MODE. In
1816 linespec mode, we're only interested in functions/methods. */
1818 template<typename Symbol
>
1820 completion_skip_symbol (complete_symbol_mode mode
, Symbol
*sym
)
1822 return (mode
== complete_symbol_mode::LINESPEC
1823 && !symbol_is_function_or_method (sym
));
1828 int matching_obj_sections (struct obj_section
*, struct obj_section
*);
1830 extern struct symtab
*find_line_symtab (struct symtab
*, int, int *, int *);
1832 extern struct symtab_and_line
find_function_start_sal (struct symbol
*sym
,
1835 extern void skip_prologue_sal (struct symtab_and_line
*);
1839 extern CORE_ADDR
skip_prologue_using_sal (struct gdbarch
*gdbarch
,
1840 CORE_ADDR func_addr
);
1842 extern struct symbol
*fixup_symbol_section (struct symbol
*,
1845 /* If MSYMBOL is an text symbol, look for a function debug symbol with
1846 the same address. Returns NULL if not found. This is necessary in
1847 case a function is an alias to some other function, because debug
1848 information is only emitted for the alias target function's
1849 definition, not for the alias. */
1850 extern symbol
*find_function_alias_target (bound_minimal_symbol msymbol
);
1852 /* Symbol searching */
1853 /* Note: struct symbol_search, search_symbols, et.al. are declared here,
1854 instead of making them local to symtab.c, for gdbtk's sake. */
1856 /* When using search_symbols, a vector of the following structs is
1858 struct symbol_search
1860 symbol_search (int block_
, struct symbol
*symbol_
)
1864 msymbol
.minsym
= nullptr;
1865 msymbol
.objfile
= nullptr;
1868 symbol_search (int block_
, struct minimal_symbol
*minsym
,
1869 struct objfile
*objfile
)
1873 msymbol
.minsym
= minsym
;
1874 msymbol
.objfile
= objfile
;
1877 bool operator< (const symbol_search
&other
) const
1879 return compare_search_syms (*this, other
) < 0;
1882 bool operator== (const symbol_search
&other
) const
1884 return compare_search_syms (*this, other
) == 0;
1887 /* The block in which the match was found. Could be, for example,
1888 STATIC_BLOCK or GLOBAL_BLOCK. */
1891 /* Information describing what was found.
1893 If symbol is NOT NULL, then information was found for this match. */
1894 struct symbol
*symbol
;
1896 /* If msymbol is non-null, then a match was made on something for
1897 which only minimal_symbols exist. */
1898 struct bound_minimal_symbol msymbol
;
1902 static int compare_search_syms (const symbol_search
&sym_a
,
1903 const symbol_search
&sym_b
);
1906 extern std::vector
<symbol_search
> search_symbols (const char *,
1907 enum search_domain
, int,
1910 /* The name of the ``main'' function.
1911 FIXME: cagney/2001-03-20: Can't make main_name() const since some
1912 of the calling code currently assumes that the string isn't
1914 extern /*const */ char *main_name (void);
1915 extern enum language
main_language (void);
1917 /* Lookup symbol NAME from DOMAIN in MAIN_OBJFILE's global blocks.
1918 This searches MAIN_OBJFILE as well as any associated separate debug info
1919 objfiles of MAIN_OBJFILE.
1920 Upon success fixes up the symbol's section if necessary. */
1922 extern struct block_symbol
1923 lookup_global_symbol_from_objfile (struct objfile
*main_objfile
,
1925 const domain_enum domain
);
1927 /* Return 1 if the supplied producer string matches the ARM RealView
1928 compiler (armcc). */
1929 int producer_is_realview (const char *producer
);
1931 void fixup_section (struct general_symbol_info
*ginfo
,
1932 CORE_ADDR addr
, struct objfile
*objfile
);
1934 /* Look up objfile containing BLOCK. */
1936 struct objfile
*lookup_objfile_from_block (const struct block
*block
);
1938 extern unsigned int symtab_create_debug
;
1940 extern unsigned int symbol_lookup_debug
;
1942 extern int basenames_may_differ
;
1944 int compare_filenames_for_search (const char *filename
,
1945 const char *search_name
);
1947 int compare_glob_filenames_for_search (const char *filename
,
1948 const char *search_name
);
1950 bool iterate_over_some_symtabs (const char *name
,
1951 const char *real_path
,
1952 struct compunit_symtab
*first
,
1953 struct compunit_symtab
*after_last
,
1954 gdb::function_view
<bool (symtab
*)> callback
);
1956 void iterate_over_symtabs (const char *name
,
1957 gdb::function_view
<bool (symtab
*)> callback
);
1960 std::vector
<CORE_ADDR
> find_pcs_for_symtab_line
1961 (struct symtab
*symtab
, int line
, struct linetable_entry
**best_entry
);
1963 /* Prototype for callbacks for LA_ITERATE_OVER_SYMBOLS. The callback
1964 is called once per matching symbol SYM. The callback should return
1965 true to indicate that LA_ITERATE_OVER_SYMBOLS should continue
1966 iterating, or false to indicate that the iteration should end. */
1968 typedef bool (symbol_found_callback_ftype
) (symbol
*sym
);
1970 void iterate_over_symbols (const struct block
*block
,
1971 const lookup_name_info
&name
,
1972 const domain_enum domain
,
1973 gdb::function_view
<symbol_found_callback_ftype
> callback
);
1975 /* Storage type used by demangle_for_lookup. demangle_for_lookup
1976 either returns a const char * pointer that points to either of the
1977 fields of this type, or a pointer to the input NAME. This is done
1978 this way because the underlying functions that demangle_for_lookup
1979 calls either return a std::string (e.g., cp_canonicalize_string) or
1980 a malloc'ed buffer (libiberty's demangled), and we want to avoid
1981 unnecessary reallocation/string copying. */
1982 class demangle_result_storage
1986 /* Swap the std::string storage with STR, and return a pointer to
1987 the beginning of the new string. */
1988 const char *swap_string (std::string
&str
)
1990 std::swap (m_string
, str
);
1991 return m_string
.c_str ();
1994 /* Set the malloc storage to now point at PTR. Any previous malloc
1995 storage is released. */
1996 const char *set_malloc_ptr (char *ptr
)
1998 m_malloc
.reset (ptr
);
2005 std::string m_string
;
2006 gdb::unique_xmalloc_ptr
<char> m_malloc
;
2010 demangle_for_lookup (const char *name
, enum language lang
,
2011 demangle_result_storage
&storage
);
2013 struct symbol
*allocate_symbol (struct objfile
*);
2015 void initialize_objfile_symbol (struct symbol
*);
2017 struct template_symbol
*allocate_template_symbol (struct objfile
*);
2019 /* Test to see if the symbol of language SYMBOL_LANGUAGE specified by
2020 SYMNAME (which is already demangled for C++ symbols) matches
2021 SYM_TEXT in the first SYM_TEXT_LEN characters. If so, add it to
2022 the current completion list. */
2023 void completion_list_add_name (completion_tracker
&tracker
,
2024 language symbol_language
,
2025 const char *symname
,
2026 const lookup_name_info
&lookup_name
,
2027 const char *text
, const char *word
);
2029 #endif /* !defined(SYMTAB_H) */