1 /* Symbol table definitions for GDB.
3 Copyright (C) 1986-2019 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)
26 #include "gdbsupport/gdb_vecs.h"
28 #include "gdb_regex.h"
29 #include "gdbsupport/enum-flags.h"
30 #include "gdbsupport/function-view.h"
31 #include "gdbsupport/gdb_optional.h"
32 #include "gdbsupport/gdb_string_view.h"
33 #include "gdbsupport/next-iterator.h"
34 #include "completer.h"
36 /* Opaque declarations. */
50 struct cmd_list_element
;
52 struct lookup_name_info
;
54 /* How to match a lookup name against a symbol search name. */
55 enum class symbol_name_match_type
57 /* Wild matching. Matches unqualified symbol names in all
58 namespace/module/packages, etc. */
61 /* Full matching. The lookup name indicates a fully-qualified name,
62 and only matches symbol search names in the specified
63 namespace/module/package. */
66 /* Search name matching. This is like FULL, but the search name did
67 not come from the user; instead it is already a search name
68 retrieved from a SYMBOL_SEARCH_NAME/MSYMBOL_SEARCH_NAME call.
69 For Ada, this avoids re-encoding an already-encoded search name
70 (which would potentially incorrectly lowercase letters in the
71 linkage/search name that should remain uppercase). For C++, it
72 avoids trying to demangle a name we already know is
76 /* Expression matching. The same as FULL matching in most
77 languages. The same as WILD matching in Ada. */
81 /* Hash the given symbol search name according to LANGUAGE's
83 extern unsigned int search_name_hash (enum language language
,
84 const char *search_name
);
86 /* Ada-specific bits of a lookup_name_info object. This is lazily
87 constructed on demand. */
89 class ada_lookup_name_info final
93 explicit ada_lookup_name_info (const lookup_name_info
&lookup_name
);
95 /* Compare SYMBOL_SEARCH_NAME with our lookup name, using MATCH_TYPE
96 as name match type. Returns true if there's a match, false
97 otherwise. If non-NULL, store the matching results in MATCH. */
98 bool matches (const char *symbol_search_name
,
99 symbol_name_match_type match_type
,
100 completion_match_result
*comp_match_res
) const;
102 /* The Ada-encoded lookup name. */
103 const std::string
&lookup_name () const
104 { return m_encoded_name
; }
106 /* Return true if we're supposed to be doing a wild match look
108 bool wild_match_p () const
109 { return m_wild_match_p
; }
111 /* Return true if we're looking up a name inside package
113 bool standard_p () const
114 { return m_standard_p
; }
116 /* Return true if doing a verbatim match. */
117 bool verbatim_p () const
118 { return m_verbatim_p
; }
121 /* The Ada-encoded lookup name. */
122 std::string m_encoded_name
;
124 /* Whether the user-provided lookup name was Ada encoded. If so,
125 then return encoded names in the 'matches' method's 'completion
126 match result' output. */
127 bool m_encoded_p
: 1;
129 /* True if really doing wild matching. Even if the user requests
130 wild matching, some cases require full matching. */
131 bool m_wild_match_p
: 1;
133 /* True if doing a verbatim match. This is true if the decoded
134 version of the symbol name is wrapped in '<'/'>'. This is an
135 escape hatch users can use to look up symbols the Ada encoding
136 does not understand. */
137 bool m_verbatim_p
: 1;
139 /* True if the user specified a symbol name that is inside package
140 Standard. Symbol names inside package Standard are handled
141 specially. We always do a non-wild match of the symbol name
142 without the "standard__" prefix, and only search static and
143 global symbols. This was primarily introduced in order to allow
144 the user to specifically access the standard exceptions using,
145 for instance, Standard.Constraint_Error when Constraint_Error is
146 ambiguous (due to the user defining its own Constraint_Error
147 entity inside its program). */
148 bool m_standard_p
: 1;
151 /* Language-specific bits of a lookup_name_info object, for languages
152 that do name searching using demangled names (C++/D/Go). This is
153 lazily constructed on demand. */
155 struct demangle_for_lookup_info final
158 demangle_for_lookup_info (const lookup_name_info
&lookup_name
,
161 /* The demangled lookup name. */
162 const std::string
&lookup_name () const
163 { return m_demangled_name
; }
166 /* The demangled lookup name. */
167 std::string m_demangled_name
;
170 /* Object that aggregates all information related to a symbol lookup
171 name. I.e., the name that is matched against the symbol's search
172 name. Caches per-language information so that it doesn't require
173 recomputing it for every symbol comparison, like for example the
174 Ada encoded name and the symbol's name hash for a given language.
175 The object is conceptually immutable once constructed, and thus has
176 no setters. This is to prevent some code path from tweaking some
177 property of the lookup name for some local reason and accidentally
178 altering the results of any continuing search(es).
179 lookup_name_info objects are generally passed around as a const
180 reference to reinforce that. (They're not passed around by value
181 because they're not small.) */
182 class lookup_name_info final
185 /* Create a new object. */
186 lookup_name_info (std::string name
,
187 symbol_name_match_type match_type
,
188 bool completion_mode
= false,
189 bool ignore_parameters
= false)
190 : m_match_type (match_type
),
191 m_completion_mode (completion_mode
),
192 m_ignore_parameters (ignore_parameters
),
193 m_name (std::move (name
))
196 /* Getters. See description of each corresponding field. */
197 symbol_name_match_type
match_type () const { return m_match_type
; }
198 bool completion_mode () const { return m_completion_mode
; }
199 const std::string
&name () const { return m_name
; }
200 const bool ignore_parameters () const { return m_ignore_parameters
; }
202 /* Return a version of this lookup name that is usable with
203 comparisons against symbols have no parameter info, such as
204 psymbols and GDB index symbols. */
205 lookup_name_info
make_ignore_params () const
207 return lookup_name_info (m_name
, m_match_type
, m_completion_mode
,
208 true /* ignore params */);
211 /* Get the search name hash for searches in language LANG. */
212 unsigned int search_name_hash (language lang
) const
214 /* Only compute each language's hash once. */
215 if (!m_demangled_hashes_p
[lang
])
217 m_demangled_hashes
[lang
]
218 = ::search_name_hash (lang
, language_lookup_name (lang
).c_str ());
219 m_demangled_hashes_p
[lang
] = true;
221 return m_demangled_hashes
[lang
];
224 /* Get the search name for searches in language LANG. */
225 const std::string
&language_lookup_name (language lang
) const
230 return ada ().lookup_name ();
232 return cplus ().lookup_name ();
234 return d ().lookup_name ();
236 return go ().lookup_name ();
242 /* Get the Ada-specific lookup info. */
243 const ada_lookup_name_info
&ada () const
249 /* Get the C++-specific lookup info. */
250 const demangle_for_lookup_info
&cplus () const
252 maybe_init (m_cplus
, language_cplus
);
256 /* Get the D-specific lookup info. */
257 const demangle_for_lookup_info
&d () const
259 maybe_init (m_d
, language_d
);
263 /* Get the Go-specific lookup info. */
264 const demangle_for_lookup_info
&go () const
266 maybe_init (m_go
, language_go
);
270 /* Get a reference to a lookup_name_info object that matches any
272 static const lookup_name_info
&match_any ();
275 /* Initialize FIELD, if not initialized yet. */
276 template<typename Field
, typename
... Args
>
277 void maybe_init (Field
&field
, Args
&&... args
) const
280 field
.emplace (*this, std::forward
<Args
> (args
)...);
283 /* The lookup info as passed to the ctor. */
284 symbol_name_match_type m_match_type
;
285 bool m_completion_mode
;
286 bool m_ignore_parameters
;
289 /* Language-specific info. These fields are filled lazily the first
290 time a lookup is done in the corresponding language. They're
291 mutable because lookup_name_info objects are typically passed
292 around by const reference (see intro), and they're conceptually
293 "cache" that can always be reconstructed from the non-mutable
295 mutable gdb::optional
<ada_lookup_name_info
> m_ada
;
296 mutable gdb::optional
<demangle_for_lookup_info
> m_cplus
;
297 mutable gdb::optional
<demangle_for_lookup_info
> m_d
;
298 mutable gdb::optional
<demangle_for_lookup_info
> m_go
;
300 /* The demangled hashes. Stored in an array with one entry for each
301 possible language. The second array records whether we've
302 already computed the each language's hash. (These are separate
303 arrays instead of a single array of optional<unsigned> to avoid
304 alignment padding). */
305 mutable std::array
<unsigned int, nr_languages
> m_demangled_hashes
;
306 mutable std::array
<bool, nr_languages
> m_demangled_hashes_p
{};
309 /* Comparison function for completion symbol lookup.
311 Returns true if the symbol name matches against LOOKUP_NAME.
313 SYMBOL_SEARCH_NAME should be a symbol's "search" name.
315 On success and if non-NULL, COMP_MATCH_RES->match is set to point
316 to the symbol name as should be presented to the user as a
317 completion match list element. In most languages, this is the same
318 as the symbol's search name, but in some, like Ada, the display
319 name is dynamically computed within the comparison routine.
321 Also, on success and if non-NULL, COMP_MATCH_RES->match_for_lcd
322 points the part of SYMBOL_SEARCH_NAME that was considered to match
323 LOOKUP_NAME. E.g., in C++, in linespec/wild mode, if the symbol is
324 "foo::function()" and LOOKUP_NAME is "function(", MATCH_FOR_LCD
325 points to "function()" inside SYMBOL_SEARCH_NAME. */
326 typedef bool (symbol_name_matcher_ftype
)
327 (const char *symbol_search_name
,
328 const lookup_name_info
&lookup_name
,
329 completion_match_result
*comp_match_res
);
331 /* Some of the structures in this file are space critical.
332 The space-critical structures are:
334 struct general_symbol_info
336 struct partial_symbol
338 These structures are laid out to encourage good packing.
339 They use ENUM_BITFIELD and short int fields, and they order the
340 structure members so that fields less than a word are next
341 to each other so they can be packed together. */
343 /* Rearranged: used ENUM_BITFIELD and rearranged field order in
344 all the space critical structures (plus struct minimal_symbol).
345 Memory usage dropped from 99360768 bytes to 90001408 bytes.
346 I measured this with before-and-after tests of
347 "HEAD-old-gdb -readnow HEAD-old-gdb" and
348 "HEAD-new-gdb -readnow HEAD-old-gdb" on native i686-pc-linux-gnu,
349 red hat linux 8, with LD_LIBRARY_PATH=/usr/lib/debug,
350 typing "maint space 1" at the first command prompt.
352 Here is another measurement (from andrew c):
353 # no /usr/lib/debug, just plain glibc, like a normal user
355 (gdb) break internal_error
357 (gdb) maint internal-error
361 gdb gdb_6_0_branch 2003-08-19 space used: 8896512
362 gdb HEAD 2003-08-19 space used: 8904704
363 gdb HEAD 2003-08-21 space used: 8396800 (+symtab.h)
364 gdb HEAD 2003-08-21 space used: 8265728 (+gdbtypes.h)
366 The third line shows the savings from the optimizations in symtab.h.
367 The fourth line shows the savings from the optimizations in
368 gdbtypes.h. Both optimizations are in gdb HEAD now.
370 --chastain 2003-08-21 */
372 /* Define a structure for the information that is common to all symbol types,
373 including minimal symbols, partial symbols, and full symbols. In a
374 multilanguage environment, some language specific information may need to
375 be recorded along with each symbol. */
377 /* This structure is space critical. See space comments at the top. */
379 struct general_symbol_info
381 /* Name of the symbol. This is a required field. Storage for the
382 name is allocated on the objfile_obstack for the associated
383 objfile. For languages like C++ that make a distinction between
384 the mangled name and demangled name, this is the mangled
389 /* Value of the symbol. Which member of this union to use, and what
390 it means, depends on what kind of symbol this is and its
391 SYMBOL_CLASS. See comments there for more details. All of these
392 are in host byte order (though what they point to might be in
393 target byte order, e.g. LOC_CONST_BYTES). */
399 const struct block
*block
;
401 const gdb_byte
*bytes
;
405 /* A common block. Used with LOC_COMMON_BLOCK. */
407 const struct common_block
*common_block
;
409 /* For opaque typedef struct chain. */
411 struct symbol
*chain
;
415 /* Since one and only one language can apply, wrap the language specific
416 information inside a union. */
420 /* A pointer to an obstack that can be used for storage associated
421 with this symbol. This is only used by Ada, and only when the
422 'ada_mangled' field is zero. */
423 struct obstack
*obstack
;
425 /* This is used by languages which wish to store a demangled name.
426 currently used by Ada, C++, and Objective C. */
427 const char *demangled_name
;
431 /* Record the source code language that applies to this symbol.
432 This is used to select one of the fields from the language specific
435 ENUM_BITFIELD(language
) language
: LANGUAGE_BITS
;
437 /* This is only used by Ada. If set, then the 'demangled_name' field
438 of language_specific is valid. Otherwise, the 'obstack' field is
440 unsigned int ada_mangled
: 1;
442 /* Which section is this symbol in? This is an index into
443 section_offsets for this objfile. Negative means that the symbol
444 does not get relocated relative to a section. */
449 extern void symbol_set_demangled_name (struct general_symbol_info
*,
453 extern const char *symbol_get_demangled_name
454 (const struct general_symbol_info
*);
456 extern CORE_ADDR
symbol_overlayed_address (CORE_ADDR
, struct obj_section
*);
458 /* Return the address of SYM. The MAYBE_COPIED flag must be set on
459 SYM. If SYM appears in the main program's minimal symbols, then
460 that minsym's address is returned; otherwise, SYM's address is
461 returned. This should generally only be used via the
462 SYMBOL_VALUE_ADDRESS macro. */
464 extern CORE_ADDR
get_symbol_address (const struct symbol
*sym
);
466 /* Note that all the following SYMBOL_* macros are used with the
467 SYMBOL argument being either a partial symbol or
468 a full symbol. Both types have a ginfo field. In particular
469 the SYMBOL_SET_LANGUAGE, SYMBOL_DEMANGLED_NAME, etc.
470 macros cannot be entirely substituted by
471 functions, unless the callers are changed to pass in the ginfo
472 field only, instead of the SYMBOL parameter. */
474 #define SYMBOL_VALUE(symbol) (symbol)->ginfo.value.ivalue
475 #define SYMBOL_VALUE_ADDRESS(symbol) \
476 (((symbol)->maybe_copied) ? get_symbol_address (symbol) \
477 : ((symbol)->ginfo.value.address))
478 #define SET_SYMBOL_VALUE_ADDRESS(symbol, new_value) \
479 ((symbol)->ginfo.value.address = (new_value))
480 #define SYMBOL_VALUE_BYTES(symbol) (symbol)->ginfo.value.bytes
481 #define SYMBOL_VALUE_COMMON_BLOCK(symbol) (symbol)->ginfo.value.common_block
482 #define SYMBOL_BLOCK_VALUE(symbol) (symbol)->ginfo.value.block
483 #define SYMBOL_VALUE_CHAIN(symbol) (symbol)->ginfo.value.chain
484 #define SYMBOL_LANGUAGE(symbol) (symbol)->ginfo.language
485 #define SYMBOL_SECTION(symbol) (symbol)->ginfo.section
486 #define SYMBOL_OBJ_SECTION(objfile, symbol) \
487 (((symbol)->ginfo.section >= 0) \
488 ? (&(((objfile)->sections)[(symbol)->ginfo.section])) \
491 /* Initializes the language dependent portion of a symbol
492 depending upon the language for the symbol. */
493 #define SYMBOL_SET_LANGUAGE(symbol,language,obstack) \
494 (symbol_set_language (&(symbol)->ginfo, (language), (obstack)))
495 extern void symbol_set_language (struct general_symbol_info
*symbol
,
496 enum language language
,
497 struct obstack
*obstack
);
499 /* Set just the linkage name of a symbol; do not try to demangle
500 it. Used for constructs which do not have a mangled name,
501 e.g. struct tags. Unlike SYMBOL_SET_NAMES, linkage_name must
502 be terminated and either already on the objfile's obstack or
503 permanently allocated. */
504 #define SYMBOL_SET_LINKAGE_NAME(symbol,linkage_name) \
505 (symbol)->ginfo.name = (linkage_name)
507 /* Set the linkage and natural names of a symbol, by demangling
508 the linkage name. If linkage_name may not be nullterminated,
509 copy_name must be set to true. */
510 #define SYMBOL_SET_NAMES(symbol,linkage_name,copy_name,objfile) \
511 symbol_set_names (&(symbol)->ginfo, linkage_name, copy_name, \
513 extern void symbol_set_names (struct general_symbol_info
*symbol
,
514 gdb::string_view linkage_name
, bool copy_name
,
515 struct objfile_per_bfd_storage
*per_bfd
);
517 /* Now come lots of name accessor macros. Short version as to when to
518 use which: Use SYMBOL_NATURAL_NAME to refer to the name of the
519 symbol in the original source code. Use SYMBOL_LINKAGE_NAME if you
520 want to know what the linker thinks the symbol's name is. Use
521 SYMBOL_PRINT_NAME for output. Use SYMBOL_DEMANGLED_NAME if you
522 specifically need to know whether SYMBOL_NATURAL_NAME and
523 SYMBOL_LINKAGE_NAME are different. */
525 /* Return SYMBOL's "natural" name, i.e. the name that it was called in
526 the original source code. In languages like C++ where symbols may
527 be mangled for ease of manipulation by the linker, this is the
530 #define SYMBOL_NATURAL_NAME(symbol) \
531 (symbol_natural_name (&(symbol)->ginfo))
532 extern const char *symbol_natural_name
533 (const struct general_symbol_info
*symbol
);
535 /* Return SYMBOL's name from the point of view of the linker. In
536 languages like C++ where symbols may be mangled for ease of
537 manipulation by the linker, this is the mangled name; otherwise,
538 it's the same as SYMBOL_NATURAL_NAME. */
540 #define SYMBOL_LINKAGE_NAME(symbol) (symbol)->ginfo.name
542 /* Return the demangled name for a symbol based on the language for
543 that symbol. If no demangled name exists, return NULL. */
544 #define SYMBOL_DEMANGLED_NAME(symbol) \
545 (symbol_demangled_name (&(symbol)->ginfo))
546 extern const char *symbol_demangled_name
547 (const struct general_symbol_info
*symbol
);
549 /* Macro that returns a version of the name of a symbol that is
550 suitable for output. In C++ this is the "demangled" form of the
551 name if demangle is on and the "mangled" form of the name if
552 demangle is off. In other languages this is just the symbol name.
553 The result should never be NULL. Don't use this for internal
554 purposes (e.g. storing in a hashtable): it's only suitable for output.
556 N.B. symbol may be anything with a ginfo member,
557 e.g., struct symbol or struct minimal_symbol. */
559 #define SYMBOL_PRINT_NAME(symbol) \
560 (demangle ? SYMBOL_NATURAL_NAME (symbol) : SYMBOL_LINKAGE_NAME (symbol))
561 extern bool demangle
;
563 /* Macro that returns the name to be used when sorting and searching symbols.
564 In C++, we search for the demangled form of a name,
565 and so sort symbols accordingly. In Ada, however, we search by mangled
566 name. If there is no distinct demangled name, then SYMBOL_SEARCH_NAME
567 returns the same value (same pointer) as SYMBOL_LINKAGE_NAME. */
568 #define SYMBOL_SEARCH_NAME(symbol) \
569 (symbol_search_name (&(symbol)->ginfo))
570 extern const char *symbol_search_name (const struct general_symbol_info
*ginfo
);
572 /* Return true if NAME matches the "search" name of SYMBOL, according
573 to the symbol's language. */
574 #define SYMBOL_MATCHES_SEARCH_NAME(symbol, name) \
575 symbol_matches_search_name (&(symbol)->ginfo, (name))
577 /* Helper for SYMBOL_MATCHES_SEARCH_NAME that works with both symbols
579 extern bool symbol_matches_search_name
580 (const struct general_symbol_info
*gsymbol
,
581 const lookup_name_info
&name
);
583 /* Compute the hash of the given symbol search name of a symbol of
584 language LANGUAGE. */
585 extern unsigned int search_name_hash (enum language language
,
586 const char *search_name
);
588 /* Classification types for a minimal symbol. These should be taken as
589 "advisory only", since if gdb can't easily figure out a
590 classification it simply selects mst_unknown. It may also have to
591 guess when it can't figure out which is a better match between two
592 types (mst_data versus mst_bss) for example. Since the minimal
593 symbol info is sometimes derived from the BFD library's view of a
594 file, we need to live with what information bfd supplies. */
596 enum minimal_symbol_type
598 mst_unknown
= 0, /* Unknown type, the default */
599 mst_text
, /* Generally executable instructions */
601 /* A GNU ifunc symbol, in the .text section. GDB uses to know
602 whether the user is setting a breakpoint on a GNU ifunc function,
603 and thus GDB needs to actually set the breakpoint on the target
604 function. It is also used to know whether the program stepped
605 into an ifunc resolver -- the resolver may get a separate
606 symbol/alias under a different name, but it'll have the same
607 address as the ifunc symbol. */
608 mst_text_gnu_ifunc
, /* Executable code returning address
609 of executable code */
611 /* A GNU ifunc function descriptor symbol, in a data section
612 (typically ".opd"). Seen on architectures that use function
613 descriptors, like PPC64/ELFv1. In this case, this symbol's value
614 is the address of the descriptor. There'll be a corresponding
615 mst_text_gnu_ifunc synthetic symbol for the text/entry
617 mst_data_gnu_ifunc
, /* Executable code returning address
618 of executable code */
620 mst_slot_got_plt
, /* GOT entries for .plt sections */
621 mst_data
, /* Generally initialized data */
622 mst_bss
, /* Generally uninitialized data */
623 mst_abs
, /* Generally absolute (nonrelocatable) */
624 /* GDB uses mst_solib_trampoline for the start address of a shared
625 library trampoline entry. Breakpoints for shared library functions
626 are put there if the shared library is not yet loaded.
627 After the shared library is loaded, lookup_minimal_symbol will
628 prefer the minimal symbol from the shared library (usually
629 a mst_text symbol) over the mst_solib_trampoline symbol, and the
630 breakpoints will be moved to their true address in the shared
631 library via breakpoint_re_set. */
632 mst_solib_trampoline
, /* Shared library trampoline code */
633 /* For the mst_file* types, the names are only guaranteed to be unique
634 within a given .o file. */
635 mst_file_text
, /* Static version of mst_text */
636 mst_file_data
, /* Static version of mst_data */
637 mst_file_bss
, /* Static version of mst_bss */
641 /* The number of enum minimal_symbol_type values, with some padding for
642 reasonable growth. */
643 #define MINSYM_TYPE_BITS 4
644 gdb_static_assert (nr_minsym_types
<= (1 << MINSYM_TYPE_BITS
));
646 /* Define a simple structure used to hold some very basic information about
647 all defined global symbols (text, data, bss, abs, etc). The only required
648 information is the general_symbol_info.
650 In many cases, even if a file was compiled with no special options for
651 debugging at all, as long as was not stripped it will contain sufficient
652 information to build a useful minimal symbol table using this structure.
653 Even when a file contains enough debugging information to build a full
654 symbol table, these minimal symbols are still useful for quickly mapping
655 between names and addresses, and vice versa. They are also sometimes
656 used to figure out what full symbol table entries need to be read in. */
658 struct minimal_symbol
: public general_symbol_info
660 /* Size of this symbol. dbx_end_psymtab in dbxread.c uses this
661 information to calculate the end of the partial symtab based on the
662 address of the last symbol plus the size of the last symbol. */
666 /* Which source file is this symbol in? Only relevant for mst_file_*. */
667 const char *filename
;
669 /* Classification type for this minimal symbol. */
671 ENUM_BITFIELD(minimal_symbol_type
) type
: MINSYM_TYPE_BITS
;
673 /* Non-zero if this symbol was created by gdb.
674 Such symbols do not appear in the output of "info var|fun". */
675 unsigned int created_by_gdb
: 1;
677 /* Two flag bits provided for the use of the target. */
678 unsigned int target_flag_1
: 1;
679 unsigned int target_flag_2
: 1;
681 /* Nonzero iff the size of the minimal symbol has been set.
682 Symbol size information can sometimes not be determined, because
683 the object file format may not carry that piece of information. */
684 unsigned int has_size
: 1;
686 /* For data symbols only, if this is set, then the symbol might be
687 subject to copy relocation. In this case, a minimal symbol
688 matching the symbol's linkage name is first looked for in the
689 main objfile. If found, then that address is used; otherwise the
690 address in this symbol is used. */
692 unsigned maybe_copied
: 1;
694 /* Minimal symbols with the same hash key are kept on a linked
695 list. This is the link. */
697 struct minimal_symbol
*hash_next
;
699 /* Minimal symbols are stored in two different hash tables. This is
700 the `next' pointer for the demangled hash table. */
702 struct minimal_symbol
*demangled_hash_next
;
704 /* True if this symbol is of some data type. */
706 bool data_p () const;
708 /* True if MSYMBOL is of some text type. */
710 bool text_p () const;
713 /* Return the address of MINSYM, which comes from OBJF. The
714 MAYBE_COPIED flag must be set on MINSYM. If MINSYM appears in the
715 main program's minimal symbols, then that minsym's address is
716 returned; otherwise, MINSYM's address is returned. This should
717 generally only be used via the MSYMBOL_VALUE_ADDRESS macro. */
719 extern CORE_ADDR
get_msymbol_address (struct objfile
*objf
,
720 const struct minimal_symbol
*minsym
);
722 #define MSYMBOL_TARGET_FLAG_1(msymbol) (msymbol)->target_flag_1
723 #define MSYMBOL_TARGET_FLAG_2(msymbol) (msymbol)->target_flag_2
724 #define MSYMBOL_SIZE(msymbol) ((msymbol)->size + 0)
725 #define SET_MSYMBOL_SIZE(msymbol, sz) \
728 (msymbol)->size = sz; \
729 (msymbol)->has_size = 1; \
731 #define MSYMBOL_HAS_SIZE(msymbol) ((msymbol)->has_size + 0)
732 #define MSYMBOL_TYPE(msymbol) (msymbol)->type
734 #define MSYMBOL_VALUE(symbol) (symbol)->value.ivalue
735 /* The unrelocated address of the minimal symbol. */
736 #define MSYMBOL_VALUE_RAW_ADDRESS(symbol) ((symbol)->value.address + 0)
737 /* The relocated address of the minimal symbol, using the section
738 offsets from OBJFILE. */
739 #define MSYMBOL_VALUE_ADDRESS(objfile, symbol) \
740 (((symbol)->maybe_copied) ? get_msymbol_address (objfile, symbol) \
741 : ((symbol)->value.address \
742 + ANOFFSET ((objfile)->section_offsets, ((symbol)->section))))
743 /* For a bound minsym, we can easily compute the address directly. */
744 #define BMSYMBOL_VALUE_ADDRESS(symbol) \
745 MSYMBOL_VALUE_ADDRESS ((symbol).objfile, (symbol).minsym)
746 #define SET_MSYMBOL_VALUE_ADDRESS(symbol, new_value) \
747 ((symbol)->value.address = (new_value))
748 #define MSYMBOL_VALUE_BYTES(symbol) (symbol)->value.bytes
749 #define MSYMBOL_BLOCK_VALUE(symbol) (symbol)->value.block
750 #define MSYMBOL_VALUE_CHAIN(symbol) (symbol)->value.chain
751 #define MSYMBOL_LANGUAGE(symbol) (symbol)->language
752 #define MSYMBOL_SECTION(symbol) (symbol)->section
753 #define MSYMBOL_OBJ_SECTION(objfile, symbol) \
754 (((symbol)->section >= 0) \
755 ? (&(((objfile)->sections)[(symbol)->section])) \
758 #define MSYMBOL_NATURAL_NAME(symbol) \
759 (symbol_natural_name (symbol))
760 #define MSYMBOL_LINKAGE_NAME(symbol) (symbol)->name
761 #define MSYMBOL_PRINT_NAME(symbol) \
762 (demangle ? MSYMBOL_NATURAL_NAME (symbol) : MSYMBOL_LINKAGE_NAME (symbol))
763 #define MSYMBOL_DEMANGLED_NAME(symbol) \
764 (symbol_demangled_name (symbol))
765 #define MSYMBOL_SEARCH_NAME(symbol) \
766 (symbol_search_name (symbol))
772 /* Represent one symbol name; a variable, constant, function or typedef. */
774 /* Different name domains for symbols. Looking up a symbol specifies a
775 domain and ignores symbol definitions in other name domains. */
777 typedef enum domain_enum_tag
779 /* UNDEF_DOMAIN is used when a domain has not been discovered or
780 none of the following apply. This usually indicates an error either
781 in the symbol information or in gdb's handling of symbols. */
785 /* VAR_DOMAIN is the usual domain. In C, this contains variables,
786 function names, typedef names and enum type values. */
790 /* STRUCT_DOMAIN is used in C to hold struct, union and enum type names.
791 Thus, if `struct foo' is used in a C program, it produces a symbol named
792 `foo' in the STRUCT_DOMAIN. */
796 /* MODULE_DOMAIN is used in Fortran to hold module type names. */
800 /* LABEL_DOMAIN may be used for names of labels (for gotos). */
804 /* Fortran common blocks. Their naming must be separate from VAR_DOMAIN.
805 They also always use LOC_COMMON_BLOCK. */
808 /* This must remain last. */
812 /* The number of bits in a symbol used to represent the domain. */
814 #define SYMBOL_DOMAIN_BITS 3
815 gdb_static_assert (NR_DOMAINS
<= (1 << SYMBOL_DOMAIN_BITS
));
817 extern const char *domain_name (domain_enum
);
819 /* Searching domains, used for `search_symbols'. Element numbers are
820 hardcoded in GDB, check all enum uses before changing it. */
824 /* Everything in VAR_DOMAIN minus FUNCTIONS_DOMAIN and
826 VARIABLES_DOMAIN
= 0,
828 /* All functions -- for some reason not methods, though. */
829 FUNCTIONS_DOMAIN
= 1,
831 /* All defined types */
838 extern const char *search_domain_name (enum search_domain
);
840 /* An address-class says where to find the value of a symbol. */
844 /* Not used; catches errors. */
848 /* Value is constant int SYMBOL_VALUE, host byteorder. */
852 /* Value is at fixed address SYMBOL_VALUE_ADDRESS. */
856 /* Value is in register. SYMBOL_VALUE is the register number
857 in the original debug format. SYMBOL_REGISTER_OPS holds a
858 function that can be called to transform this into the
859 actual register number this represents in a specific target
860 architecture (gdbarch).
862 For some symbol formats (stabs, for some compilers at least),
863 the compiler generates two symbols, an argument and a register.
864 In some cases we combine them to a single LOC_REGISTER in symbol
865 reading, but currently not for all cases (e.g. it's passed on the
866 stack and then loaded into a register). */
870 /* It's an argument; the value is at SYMBOL_VALUE offset in arglist. */
874 /* Value address is at SYMBOL_VALUE offset in arglist. */
878 /* Value is in specified register. Just like LOC_REGISTER except the
879 register holds the address of the argument instead of the argument
880 itself. This is currently used for the passing of structs and unions
881 on sparc and hppa. It is also used for call by reference where the
882 address is in a register, at least by mipsread.c. */
886 /* Value is a local variable at SYMBOL_VALUE offset in stack frame. */
890 /* Value not used; definition in SYMBOL_TYPE. Symbols in the domain
891 STRUCT_DOMAIN all have this class. */
895 /* Value is address SYMBOL_VALUE_ADDRESS in the code. */
899 /* In a symbol table, value is SYMBOL_BLOCK_VALUE of a `struct block'.
900 In a partial symbol table, SYMBOL_VALUE_ADDRESS is the start address
901 of the block. Function names have this class. */
905 /* Value is a constant byte-sequence pointed to by SYMBOL_VALUE_BYTES, in
906 target byte order. */
910 /* Value is at fixed address, but the address of the variable has
911 to be determined from the minimal symbol table whenever the
912 variable is referenced.
913 This happens if debugging information for a global symbol is
914 emitted and the corresponding minimal symbol is defined
915 in another object file or runtime common storage.
916 The linker might even remove the minimal symbol if the global
917 symbol is never referenced, in which case the symbol remains
920 GDB would normally find the symbol in the minimal symbol table if it will
921 not find it in the full symbol table. But a reference to an external
922 symbol in a local block shadowing other definition requires full symbol
923 without possibly having its address available for LOC_STATIC. Testcase
924 is provided as `gdb.dwarf2/dw2-unresolved.exp'.
926 This is also used for thread local storage (TLS) variables. In this case,
927 the address of the TLS variable must be determined when the variable is
928 referenced, from the MSYMBOL_VALUE_RAW_ADDRESS, which is the offset
929 of the TLS variable in the thread local storage of the shared
934 /* The variable does not actually exist in the program.
935 The value is ignored. */
939 /* The variable's address is computed by a set of location
940 functions (see "struct symbol_computed_ops" below). */
943 /* The variable uses general_symbol_info->value->common_block field.
944 It also always uses COMMON_BLOCK_DOMAIN. */
947 /* Not used, just notes the boundary of the enum. */
951 /* The number of bits needed for values in enum address_class, with some
952 padding for reasonable growth, and room for run-time registered address
953 classes. See symtab.c:MAX_SYMBOL_IMPLS.
954 This is a #define so that we can have a assertion elsewhere to
955 verify that we have reserved enough space for synthetic address
957 #define SYMBOL_ACLASS_BITS 5
958 gdb_static_assert (LOC_FINAL_VALUE
<= (1 << SYMBOL_ACLASS_BITS
));
960 /* The methods needed to implement LOC_COMPUTED. These methods can
961 use the symbol's .aux_value for additional per-symbol information.
963 At present this is only used to implement location expressions. */
965 struct symbol_computed_ops
968 /* Return the value of the variable SYMBOL, relative to the stack
969 frame FRAME. If the variable has been optimized out, return
972 Iff `read_needs_frame (SYMBOL)' is not SYMBOL_NEEDS_FRAME, then
973 FRAME may be zero. */
975 struct value
*(*read_variable
) (struct symbol
* symbol
,
976 struct frame_info
* frame
);
978 /* Read variable SYMBOL like read_variable at (callee) FRAME's function
979 entry. SYMBOL should be a function parameter, otherwise
980 NO_ENTRY_VALUE_ERROR will be thrown. */
981 struct value
*(*read_variable_at_entry
) (struct symbol
*symbol
,
982 struct frame_info
*frame
);
984 /* Find the "symbol_needs_kind" value for the given symbol. This
985 value determines whether reading the symbol needs memory (e.g., a
986 global variable), just registers (a thread-local), or a frame (a
988 enum symbol_needs_kind (*get_symbol_read_needs
) (struct symbol
* symbol
);
990 /* Write to STREAM a natural-language description of the location of
991 SYMBOL, in the context of ADDR. */
992 void (*describe_location
) (struct symbol
* symbol
, CORE_ADDR addr
,
993 struct ui_file
* stream
);
995 /* Non-zero if this symbol's address computation is dependent on PC. */
996 unsigned char location_has_loclist
;
998 /* Tracepoint support. Append bytecodes to the tracepoint agent
999 expression AX that push the address of the object SYMBOL. Set
1000 VALUE appropriately. Note --- for objects in registers, this
1001 needn't emit any code; as long as it sets VALUE properly, then
1002 the caller will generate the right code in the process of
1003 treating this as an lvalue or rvalue. */
1005 void (*tracepoint_var_ref
) (struct symbol
*symbol
, struct agent_expr
*ax
,
1006 struct axs_value
*value
);
1008 /* Generate C code to compute the location of SYMBOL. The C code is
1009 emitted to STREAM. GDBARCH is the current architecture and PC is
1010 the PC at which SYMBOL's location should be evaluated.
1011 REGISTERS_USED is a vector indexed by register number; the
1012 generator function should set an element in this vector if the
1013 corresponding register is needed by the location computation.
1014 The generated C code must assign the location to a local
1015 variable; this variable's name is RESULT_NAME. */
1017 void (*generate_c_location
) (struct symbol
*symbol
, string_file
*stream
,
1018 struct gdbarch
*gdbarch
,
1019 unsigned char *registers_used
,
1020 CORE_ADDR pc
, const char *result_name
);
1024 /* The methods needed to implement LOC_BLOCK for inferior functions.
1025 These methods can use the symbol's .aux_value for additional
1026 per-symbol information. */
1028 struct symbol_block_ops
1030 /* Fill in *START and *LENGTH with DWARF block data of function
1031 FRAMEFUNC valid for inferior context address PC. Set *LENGTH to
1032 zero if such location is not valid for PC; *START is left
1033 uninitialized in such case. */
1034 void (*find_frame_base_location
) (struct symbol
*framefunc
, CORE_ADDR pc
,
1035 const gdb_byte
**start
, size_t *length
);
1037 /* Return the frame base address. FRAME is the frame for which we want to
1038 compute the base address while FRAMEFUNC is the symbol for the
1039 corresponding function. Return 0 on failure (FRAMEFUNC may not hold the
1040 information we need).
1042 This method is designed to work with static links (nested functions
1043 handling). Static links are function properties whose evaluation returns
1044 the frame base address for the enclosing frame. However, there are
1045 multiple definitions for "frame base": the content of the frame base
1046 register, the CFA as defined by DWARF unwinding information, ...
1048 So this specific method is supposed to compute the frame base address such
1049 as for nested functions, the static link computes the same address. For
1050 instance, considering DWARF debugging information, the static link is
1051 computed with DW_AT_static_link and this method must be used to compute
1052 the corresponding DW_AT_frame_base attribute. */
1053 CORE_ADDR (*get_frame_base
) (struct symbol
*framefunc
,
1054 struct frame_info
*frame
);
1057 /* Functions used with LOC_REGISTER and LOC_REGPARM_ADDR. */
1059 struct symbol_register_ops
1061 int (*register_number
) (struct symbol
*symbol
, struct gdbarch
*gdbarch
);
1064 /* Objects of this type are used to find the address class and the
1065 various computed ops vectors of a symbol. */
1069 enum address_class aclass
;
1071 /* Used with LOC_COMPUTED. */
1072 const struct symbol_computed_ops
*ops_computed
;
1074 /* Used with LOC_BLOCK. */
1075 const struct symbol_block_ops
*ops_block
;
1077 /* Used with LOC_REGISTER and LOC_REGPARM_ADDR. */
1078 const struct symbol_register_ops
*ops_register
;
1081 /* struct symbol has some subclasses. This enum is used to
1082 differentiate between them. */
1084 enum symbol_subclass_kind
1086 /* Plain struct symbol. */
1089 /* struct template_symbol. */
1092 /* struct rust_vtable_symbol. */
1096 /* This structure is space critical. See space comments at the top. */
1101 /* The general symbol info required for all types of symbols. */
1103 struct general_symbol_info ginfo
;
1105 /* Data type of value */
1109 /* The owner of this symbol.
1110 Which one to use is defined by symbol.is_objfile_owned. */
1114 /* The symbol table containing this symbol. This is the file associated
1115 with LINE. It can be NULL during symbols read-in but it is never NULL
1116 during normal operation. */
1117 struct symtab
*symtab
;
1119 /* For types defined by the architecture. */
1120 struct gdbarch
*arch
;
1125 ENUM_BITFIELD(domain_enum_tag
) domain
: SYMBOL_DOMAIN_BITS
;
1127 /* Address class. This holds an index into the 'symbol_impls'
1128 table. The actual enum address_class value is stored there,
1129 alongside any per-class ops vectors. */
1131 unsigned int aclass_index
: SYMBOL_ACLASS_BITS
;
1133 /* If non-zero then symbol is objfile-owned, use owner.symtab.
1134 Otherwise symbol is arch-owned, use owner.arch. */
1136 unsigned int is_objfile_owned
: 1;
1138 /* Whether this is an argument. */
1140 unsigned is_argument
: 1;
1142 /* Whether this is an inlined function (class LOC_BLOCK only). */
1143 unsigned is_inlined
: 1;
1145 /* For LOC_STATIC only, if this is set, then the symbol might be
1146 subject to copy relocation. In this case, a minimal symbol
1147 matching the symbol's linkage name is first looked for in the
1148 main objfile. If found, then that address is used; otherwise the
1149 address in this symbol is used. */
1151 unsigned maybe_copied
: 1;
1153 /* The concrete type of this symbol. */
1155 ENUM_BITFIELD (symbol_subclass_kind
) subclass
: 2;
1157 /* Line number of this symbol's definition, except for inlined
1158 functions. For an inlined function (class LOC_BLOCK and
1159 SYMBOL_INLINED set) this is the line number of the function's call
1160 site. Inlined function symbols are not definitions, and they are
1161 never found by symbol table lookup.
1162 If this symbol is arch-owned, LINE shall be zero.
1164 FIXME: Should we really make the assumption that nobody will try
1165 to debug files longer than 64K lines? What about machine
1166 generated programs? */
1168 unsigned short line
;
1170 /* An arbitrary data pointer, allowing symbol readers to record
1171 additional information on a per-symbol basis. Note that this data
1172 must be allocated using the same obstack as the symbol itself. */
1173 /* So far it is only used by:
1174 LOC_COMPUTED: to find the location information
1175 LOC_BLOCK (DWARF2 function): information used internally by the
1176 DWARF 2 code --- specifically, the location expression for the frame
1177 base for this function. */
1178 /* FIXME drow/2003-02-21: For the LOC_BLOCK case, it might be better
1179 to add a magic symbol to the block containing this information,
1180 or to have a generic debug info annotation slot for symbols. */
1184 struct symbol
*hash_next
;
1187 /* Several lookup functions return both a symbol and the block in which the
1188 symbol is found. This structure is used in these cases. */
1192 /* The symbol that was found, or NULL if no symbol was found. */
1193 struct symbol
*symbol
;
1195 /* If SYMBOL is not NULL, then this is the block in which the symbol is
1197 const struct block
*block
;
1200 extern const struct symbol_impl
*symbol_impls
;
1202 /* Note: There is no accessor macro for symbol.owner because it is
1205 #define SYMBOL_DOMAIN(symbol) (symbol)->domain
1206 #define SYMBOL_IMPL(symbol) (symbol_impls[(symbol)->aclass_index])
1207 #define SYMBOL_ACLASS_INDEX(symbol) (symbol)->aclass_index
1208 #define SYMBOL_CLASS(symbol) (SYMBOL_IMPL (symbol).aclass)
1209 #define SYMBOL_OBJFILE_OWNED(symbol) ((symbol)->is_objfile_owned)
1210 #define SYMBOL_IS_ARGUMENT(symbol) (symbol)->is_argument
1211 #define SYMBOL_INLINED(symbol) (symbol)->is_inlined
1212 #define SYMBOL_IS_CPLUS_TEMPLATE_FUNCTION(symbol) \
1213 (((symbol)->subclass) == SYMBOL_TEMPLATE)
1214 #define SYMBOL_TYPE(symbol) (symbol)->type
1215 #define SYMBOL_LINE(symbol) (symbol)->line
1216 #define SYMBOL_COMPUTED_OPS(symbol) (SYMBOL_IMPL (symbol).ops_computed)
1217 #define SYMBOL_BLOCK_OPS(symbol) (SYMBOL_IMPL (symbol).ops_block)
1218 #define SYMBOL_REGISTER_OPS(symbol) (SYMBOL_IMPL (symbol).ops_register)
1219 #define SYMBOL_LOCATION_BATON(symbol) (symbol)->aux_value
1221 extern int register_symbol_computed_impl (enum address_class
,
1222 const struct symbol_computed_ops
*);
1224 extern int register_symbol_block_impl (enum address_class aclass
,
1225 const struct symbol_block_ops
*ops
);
1227 extern int register_symbol_register_impl (enum address_class
,
1228 const struct symbol_register_ops
*);
1230 /* Return the OBJFILE of SYMBOL.
1231 It is an error to call this if symbol.is_objfile_owned is false, which
1232 only happens for architecture-provided types. */
1234 extern struct objfile
*symbol_objfile (const struct symbol
*symbol
);
1236 /* Return the ARCH of SYMBOL. */
1238 extern struct gdbarch
*symbol_arch (const struct symbol
*symbol
);
1240 /* Return the SYMTAB of SYMBOL.
1241 It is an error to call this if symbol.is_objfile_owned is false, which
1242 only happens for architecture-provided types. */
1244 extern struct symtab
*symbol_symtab (const struct symbol
*symbol
);
1246 /* Set the symtab of SYMBOL to SYMTAB.
1247 It is an error to call this if symbol.is_objfile_owned is false, which
1248 only happens for architecture-provided types. */
1250 extern void symbol_set_symtab (struct symbol
*symbol
, struct symtab
*symtab
);
1252 /* An instance of this type is used to represent a C++ template
1253 function. A symbol is really of this type iff
1254 SYMBOL_IS_CPLUS_TEMPLATE_FUNCTION is true. */
1256 struct template_symbol
: public symbol
1258 /* The number of template arguments. */
1259 int n_template_arguments
;
1261 /* The template arguments. This is an array with
1262 N_TEMPLATE_ARGUMENTS elements. */
1263 struct symbol
**template_arguments
;
1266 /* A symbol that represents a Rust virtual table object. */
1268 struct rust_vtable_symbol
: public symbol
1270 /* The concrete type for which this vtable was created; that is, in
1271 "impl Trait for Type", this is "Type". */
1272 struct type
*concrete_type
;
1276 /* Each item represents a line-->pc (or the reverse) mapping. This is
1277 somewhat more wasteful of space than one might wish, but since only
1278 the files which are actually debugged are read in to core, we don't
1279 waste much space. */
1281 struct linetable_entry
1287 /* The order of entries in the linetable is significant. They should
1288 be sorted by increasing values of the pc field. If there is more than
1289 one entry for a given pc, then I'm not sure what should happen (and
1290 I not sure whether we currently handle it the best way).
1292 Example: a C for statement generally looks like this
1294 10 0x100 - for the init/test part of a for stmt.
1297 10 0x400 - for the increment part of a for stmt.
1299 If an entry has a line number of zero, it marks the start of a PC
1300 range for which no line number information is available. It is
1301 acceptable, though wasteful of table space, for such a range to be
1308 /* Actually NITEMS elements. If you don't like this use of the
1309 `struct hack', you can shove it up your ANSI (seriously, if the
1310 committee tells us how to do it, we can probably go along). */
1311 struct linetable_entry item
[1];
1314 /* How to relocate the symbols from each section in a symbol file.
1315 Each struct contains an array of offsets.
1316 The ordering and meaning of the offsets is file-type-dependent;
1317 typically it is indexed by section numbers or symbol types or
1318 something like that.
1320 To give us flexibility in changing the internal representation
1321 of these offsets, the ANOFFSET macro must be used to insert and
1322 extract offset values in the struct. */
1324 struct section_offsets
1326 CORE_ADDR offsets
[1]; /* As many as needed. */
1329 #define ANOFFSET(secoff, whichone) \
1331 ? (internal_error (__FILE__, __LINE__, \
1332 _("Section index is uninitialized")), -1) \
1333 : secoff->offsets[whichone])
1335 /* The size of a section_offsets table for N sections. */
1336 #define SIZEOF_N_SECTION_OFFSETS(n) \
1337 (sizeof (struct section_offsets) \
1338 + sizeof (((struct section_offsets *) 0)->offsets) * ((n)-1))
1340 /* Each source file or header is represented by a struct symtab.
1341 The name "symtab" is historical, another name for it is "filetab".
1342 These objects are chained through the `next' field. */
1346 /* Unordered chain of all filetabs in the compunit, with the exception
1347 that the "main" source file is the first entry in the list. */
1349 struct symtab
*next
;
1351 /* Backlink to containing compunit symtab. */
1353 struct compunit_symtab
*compunit_symtab
;
1355 /* Table mapping core addresses to line numbers for this file.
1356 Can be NULL if none. Never shared between different symtabs. */
1358 struct linetable
*linetable
;
1360 /* Name of this source file. This pointer is never NULL. */
1362 const char *filename
;
1364 /* Language of this source file. */
1366 enum language language
;
1368 /* Full name of file as found by searching the source path.
1369 NULL if not yet known. */
1374 #define SYMTAB_COMPUNIT(symtab) ((symtab)->compunit_symtab)
1375 #define SYMTAB_LINETABLE(symtab) ((symtab)->linetable)
1376 #define SYMTAB_LANGUAGE(symtab) ((symtab)->language)
1377 #define SYMTAB_BLOCKVECTOR(symtab) \
1378 COMPUNIT_BLOCKVECTOR (SYMTAB_COMPUNIT (symtab))
1379 #define SYMTAB_OBJFILE(symtab) \
1380 COMPUNIT_OBJFILE (SYMTAB_COMPUNIT (symtab))
1381 #define SYMTAB_PSPACE(symtab) (SYMTAB_OBJFILE (symtab)->pspace)
1382 #define SYMTAB_DIRNAME(symtab) \
1383 COMPUNIT_DIRNAME (SYMTAB_COMPUNIT (symtab))
1385 /* Compunit symtabs contain the actual "symbol table", aka blockvector, as well
1386 as the list of all source files (what gdb has historically associated with
1388 Additional information is recorded here that is common to all symtabs in a
1389 compilation unit (DWARF or otherwise).
1392 For the case of a program built out of these files:
1401 This is recorded as:
1403 objfile -> foo.c(cu) -> bar.c(cu) -> NULL
1417 where "foo.c(cu)" and "bar.c(cu)" are struct compunit_symtab objects,
1418 and the files foo.c, etc. are struct symtab objects. */
1420 struct compunit_symtab
1422 /* Unordered chain of all compunit symtabs of this objfile. */
1423 struct compunit_symtab
*next
;
1425 /* Object file from which this symtab information was read. */
1426 struct objfile
*objfile
;
1428 /* Name of the symtab.
1429 This is *not* intended to be a usable filename, and is
1430 for debugging purposes only. */
1433 /* Unordered list of file symtabs, except that by convention the "main"
1434 source file (e.g., .c, .cc) is guaranteed to be first.
1435 Each symtab is a file, either the "main" source file (e.g., .c, .cc)
1436 or header (e.g., .h). */
1437 struct symtab
*filetabs
;
1439 /* Last entry in FILETABS list.
1440 Subfiles are added to the end of the list so they accumulate in order,
1441 with the main source subfile living at the front.
1442 The main reason is so that the main source file symtab is at the head
1443 of the list, and the rest appear in order for debugging convenience. */
1444 struct symtab
*last_filetab
;
1446 /* Non-NULL string that identifies the format of the debugging information,
1447 such as "stabs", "dwarf 1", "dwarf 2", "coff", etc. This is mostly useful
1448 for automated testing of gdb but may also be information that is
1449 useful to the user. */
1450 const char *debugformat
;
1452 /* String of producer version information, or NULL if we don't know. */
1453 const char *producer
;
1455 /* Directory in which it was compiled, or NULL if we don't know. */
1456 const char *dirname
;
1458 /* List of all symbol scope blocks for this symtab. It is shared among
1459 all symtabs in a given compilation unit. */
1460 const struct blockvector
*blockvector
;
1462 /* Section in objfile->section_offsets for the blockvector and
1463 the linetable. Probably always SECT_OFF_TEXT. */
1464 int block_line_section
;
1466 /* Symtab has been compiled with both optimizations and debug info so that
1467 GDB may stop skipping prologues as variables locations are valid already
1468 at function entry points. */
1469 unsigned int locations_valid
: 1;
1471 /* DWARF unwinder for this CU is valid even for epilogues (PC at the return
1472 instruction). This is supported by GCC since 4.5.0. */
1473 unsigned int epilogue_unwind_valid
: 1;
1475 /* struct call_site entries for this compilation unit or NULL. */
1476 htab_t call_site_htab
;
1478 /* The macro table for this symtab. Like the blockvector, this
1479 is shared between different symtabs in a given compilation unit.
1480 It's debatable whether it *should* be shared among all the symtabs in
1481 the given compilation unit, but it currently is. */
1482 struct macro_table
*macro_table
;
1484 /* If non-NULL, then this points to a NULL-terminated vector of
1485 included compunits. When searching the static or global
1486 block of this compunit, the corresponding block of all
1487 included compunits will also be searched. Note that this
1488 list must be flattened -- the symbol reader is responsible for
1489 ensuring that this vector contains the transitive closure of all
1490 included compunits. */
1491 struct compunit_symtab
**includes
;
1493 /* If this is an included compunit, this points to one includer
1494 of the table. This user is considered the canonical compunit
1495 containing this one. An included compunit may itself be
1496 included by another. */
1497 struct compunit_symtab
*user
;
1500 #define COMPUNIT_OBJFILE(cust) ((cust)->objfile)
1501 #define COMPUNIT_FILETABS(cust) ((cust)->filetabs)
1502 #define COMPUNIT_DEBUGFORMAT(cust) ((cust)->debugformat)
1503 #define COMPUNIT_PRODUCER(cust) ((cust)->producer)
1504 #define COMPUNIT_DIRNAME(cust) ((cust)->dirname)
1505 #define COMPUNIT_BLOCKVECTOR(cust) ((cust)->blockvector)
1506 #define COMPUNIT_BLOCK_LINE_SECTION(cust) ((cust)->block_line_section)
1507 #define COMPUNIT_LOCATIONS_VALID(cust) ((cust)->locations_valid)
1508 #define COMPUNIT_EPILOGUE_UNWIND_VALID(cust) ((cust)->epilogue_unwind_valid)
1509 #define COMPUNIT_CALL_SITE_HTAB(cust) ((cust)->call_site_htab)
1510 #define COMPUNIT_MACRO_TABLE(cust) ((cust)->macro_table)
1512 /* A range adapter to allowing iterating over all the file tables
1513 within a compunit. */
1515 struct compunit_filetabs
: public next_adapter
<struct symtab
>
1517 compunit_filetabs (struct compunit_symtab
*cu
)
1518 : next_adapter
<struct symtab
> (cu
->filetabs
)
1523 /* Return the primary symtab of CUST. */
1525 extern struct symtab
*
1526 compunit_primary_filetab (const struct compunit_symtab
*cust
);
1528 /* Return the language of CUST. */
1530 extern enum language
compunit_language (const struct compunit_symtab
*cust
);
1534 /* The virtual function table is now an array of structures which have the
1535 form { int16 offset, delta; void *pfn; }.
1537 In normal virtual function tables, OFFSET is unused.
1538 DELTA is the amount which is added to the apparent object's base
1539 address in order to point to the actual object to which the
1540 virtual function should be applied.
1541 PFN is a pointer to the virtual function.
1543 Note that this macro is g++ specific (FIXME). */
1545 #define VTBL_FNADDR_OFFSET 2
1547 /* External variables and functions for the objects described above. */
1549 /* True if we are nested inside psymtab_to_symtab. */
1551 extern int currently_reading_symtab
;
1553 /* symtab.c lookup functions */
1555 extern const char multiple_symbols_ask
[];
1556 extern const char multiple_symbols_all
[];
1557 extern const char multiple_symbols_cancel
[];
1559 const char *multiple_symbols_select_mode (void);
1561 bool symbol_matches_domain (enum language symbol_language
,
1562 domain_enum symbol_domain
,
1563 domain_enum domain
);
1565 /* lookup a symbol table by source file name. */
1567 extern struct symtab
*lookup_symtab (const char *);
1569 /* An object of this type is passed as the 'is_a_field_of_this'
1570 argument to lookup_symbol and lookup_symbol_in_language. */
1572 struct field_of_this_result
1574 /* The type in which the field was found. If this is NULL then the
1575 symbol was not found in 'this'. If non-NULL, then one of the
1576 other fields will be non-NULL as well. */
1580 /* If the symbol was found as an ordinary field of 'this', then this
1581 is non-NULL and points to the particular field. */
1583 struct field
*field
;
1585 /* If the symbol was found as a function field of 'this', then this
1586 is non-NULL and points to the particular field. */
1588 struct fn_fieldlist
*fn_field
;
1591 /* Find the definition for a specified symbol name NAME
1592 in domain DOMAIN in language LANGUAGE, visible from lexical block BLOCK
1593 if non-NULL or from global/static blocks if BLOCK is NULL.
1594 Returns the struct symbol pointer, or NULL if no symbol is found.
1595 C++: if IS_A_FIELD_OF_THIS is non-NULL on entry, check to see if
1596 NAME is a field of the current implied argument `this'. If so fill in the
1597 fields of IS_A_FIELD_OF_THIS, otherwise the fields are set to NULL.
1598 The symbol's section is fixed up if necessary. */
1600 extern struct block_symbol
1601 lookup_symbol_in_language (const char *,
1602 const struct block
*,
1605 struct field_of_this_result
*);
1607 /* Same as lookup_symbol_in_language, but using the current language. */
1609 extern struct block_symbol
lookup_symbol (const char *,
1610 const struct block
*,
1612 struct field_of_this_result
*);
1614 /* Find the definition for a specified symbol search name in domain
1615 DOMAIN, visible from lexical block BLOCK if non-NULL or from
1616 global/static blocks if BLOCK is NULL. The passed-in search name
1617 should not come from the user; instead it should already be a
1618 search name as retrieved from a
1619 SYMBOL_SEARCH_NAME/MSYMBOL_SEARCH_NAME call. See definition of
1620 symbol_name_match_type::SEARCH_NAME. Returns the struct symbol
1621 pointer, or NULL if no symbol is found. The symbol's section is
1622 fixed up if necessary. */
1624 extern struct block_symbol
lookup_symbol_search_name (const char *search_name
,
1625 const struct block
*block
,
1626 domain_enum domain
);
1628 /* A default version of lookup_symbol_nonlocal for use by languages
1629 that can't think of anything better to do.
1630 This implements the C lookup rules. */
1632 extern struct block_symbol
1633 basic_lookup_symbol_nonlocal (const struct language_defn
*langdef
,
1635 const struct block
*,
1638 /* Some helper functions for languages that need to write their own
1639 lookup_symbol_nonlocal functions. */
1641 /* Lookup a symbol in the static block associated to BLOCK, if there
1642 is one; do nothing if BLOCK is NULL or a global block.
1643 Upon success fixes up the symbol's section if necessary. */
1645 extern struct block_symbol
1646 lookup_symbol_in_static_block (const char *name
,
1647 const struct block
*block
,
1648 const domain_enum domain
);
1650 /* Search all static file-level symbols for NAME from DOMAIN.
1651 Upon success fixes up the symbol's section if necessary. */
1653 extern struct block_symbol
lookup_static_symbol (const char *name
,
1654 const domain_enum domain
);
1656 /* Lookup a symbol in all files' global blocks.
1658 If BLOCK is non-NULL then it is used for two things:
1659 1) If a target-specific lookup routine for libraries exists, then use the
1660 routine for the objfile of BLOCK, and
1661 2) The objfile of BLOCK is used to assist in determining the search order
1662 if the target requires it.
1663 See gdbarch_iterate_over_objfiles_in_search_order.
1665 Upon success fixes up the symbol's section if necessary. */
1667 extern struct block_symbol
1668 lookup_global_symbol (const char *name
,
1669 const struct block
*block
,
1670 const domain_enum domain
);
1672 /* Lookup a symbol in block BLOCK.
1673 Upon success fixes up the symbol's section if necessary. */
1675 extern struct symbol
*
1676 lookup_symbol_in_block (const char *name
,
1677 symbol_name_match_type match_type
,
1678 const struct block
*block
,
1679 const domain_enum domain
);
1681 /* Look up the `this' symbol for LANG in BLOCK. Return the symbol if
1682 found, or NULL if not found. */
1684 extern struct block_symbol
1685 lookup_language_this (const struct language_defn
*lang
,
1686 const struct block
*block
);
1688 /* Lookup a [struct, union, enum] by name, within a specified block. */
1690 extern struct type
*lookup_struct (const char *, const struct block
*);
1692 extern struct type
*lookup_union (const char *, const struct block
*);
1694 extern struct type
*lookup_enum (const char *, const struct block
*);
1696 /* from blockframe.c: */
1698 /* lookup the function symbol corresponding to the address. The
1699 return value will not be an inlined function; the containing
1700 function will be returned instead. */
1702 extern struct symbol
*find_pc_function (CORE_ADDR
);
1704 /* lookup the function corresponding to the address and section. The
1705 return value will not be an inlined function; the containing
1706 function will be returned instead. */
1708 extern struct symbol
*find_pc_sect_function (CORE_ADDR
, struct obj_section
*);
1710 /* lookup the function symbol corresponding to the address and
1711 section. The return value will be the closest enclosing function,
1712 which might be an inline function. */
1714 extern struct symbol
*find_pc_sect_containing_function
1715 (CORE_ADDR pc
, struct obj_section
*section
);
1717 /* Find the symbol at the given address. Returns NULL if no symbol
1718 found. Only exact matches for ADDRESS are considered. */
1720 extern struct symbol
*find_symbol_at_address (CORE_ADDR
);
1722 /* Finds the "function" (text symbol) that is smaller than PC but
1723 greatest of all of the potential text symbols in SECTION. Sets
1724 *NAME and/or *ADDRESS conditionally if that pointer is non-null.
1725 If ENDADDR is non-null, then set *ENDADDR to be the end of the
1726 function (exclusive). If the optional parameter BLOCK is non-null,
1727 then set *BLOCK to the address of the block corresponding to the
1728 function symbol, if such a symbol could be found during the lookup;
1729 nullptr is used as a return value for *BLOCK if no block is found.
1730 This function either succeeds or fails (not halfway succeeds). If
1731 it succeeds, it sets *NAME, *ADDRESS, and *ENDADDR to real
1732 information and returns true. If it fails, it sets *NAME, *ADDRESS
1733 and *ENDADDR to zero and returns false.
1735 If the function in question occupies non-contiguous ranges,
1736 *ADDRESS and *ENDADDR are (subject to the conditions noted above) set
1737 to the start and end of the range in which PC is found. Thus
1738 *ADDRESS <= PC < *ENDADDR with no intervening gaps (in which ranges
1739 from other functions might be found).
1741 This property allows find_pc_partial_function to be used (as it had
1742 been prior to the introduction of non-contiguous range support) by
1743 various tdep files for finding a start address and limit address
1744 for prologue analysis. This still isn't ideal, however, because we
1745 probably shouldn't be doing prologue analysis (in which
1746 instructions are scanned to determine frame size and stack layout)
1747 for any range that doesn't contain the entry pc. Moreover, a good
1748 argument can be made that prologue analysis ought to be performed
1749 starting from the entry pc even when PC is within some other range.
1750 This might suggest that *ADDRESS and *ENDADDR ought to be set to the
1751 limits of the entry pc range, but that will cause the
1752 *ADDRESS <= PC < *ENDADDR condition to be violated; many of the
1753 callers of find_pc_partial_function expect this condition to hold.
1755 Callers which require the start and/or end addresses for the range
1756 containing the entry pc should instead call
1757 find_function_entry_range_from_pc. */
1759 extern bool find_pc_partial_function (CORE_ADDR pc
, const char **name
,
1760 CORE_ADDR
*address
, CORE_ADDR
*endaddr
,
1761 const struct block
**block
= nullptr);
1763 /* Like find_pc_partial_function, above, but *ADDRESS and *ENDADDR are
1764 set to start and end addresses of the range containing the entry pc.
1766 Note that it is not necessarily the case that (for non-NULL ADDRESS
1767 and ENDADDR arguments) the *ADDRESS <= PC < *ENDADDR condition will
1770 See comment for find_pc_partial_function, above, for further
1773 extern bool find_function_entry_range_from_pc (CORE_ADDR pc
,
1776 CORE_ADDR
*endaddr
);
1778 /* Return the type of a function with its first instruction exactly at
1779 the PC address. Return NULL otherwise. */
1781 extern struct type
*find_function_type (CORE_ADDR pc
);
1783 /* See if we can figure out the function's actual type from the type
1784 that the resolver returns. RESOLVER_FUNADDR is the address of the
1787 extern struct type
*find_gnu_ifunc_target_type (CORE_ADDR resolver_funaddr
);
1789 /* Find the GNU ifunc minimal symbol that matches SYM. */
1790 extern bound_minimal_symbol
find_gnu_ifunc (const symbol
*sym
);
1792 extern void clear_pc_function_cache (void);
1794 /* Expand symtab containing PC, SECTION if not already expanded. */
1796 extern void expand_symtab_containing_pc (CORE_ADDR
, struct obj_section
*);
1798 /* lookup full symbol table by address. */
1800 extern struct compunit_symtab
*find_pc_compunit_symtab (CORE_ADDR
);
1802 /* lookup full symbol table by address and section. */
1804 extern struct compunit_symtab
*
1805 find_pc_sect_compunit_symtab (CORE_ADDR
, struct obj_section
*);
1807 extern bool find_pc_line_pc_range (CORE_ADDR
, CORE_ADDR
*, CORE_ADDR
*);
1809 extern void reread_symbols (void);
1811 /* Look up a type named NAME in STRUCT_DOMAIN in the current language.
1812 The type returned must not be opaque -- i.e., must have at least one field
1815 extern struct type
*lookup_transparent_type (const char *);
1817 extern struct type
*basic_lookup_transparent_type (const char *);
1819 /* Macro for name of symbol to indicate a file compiled with gcc. */
1820 #ifndef GCC_COMPILED_FLAG_SYMBOL
1821 #define GCC_COMPILED_FLAG_SYMBOL "gcc_compiled."
1824 /* Macro for name of symbol to indicate a file compiled with gcc2. */
1825 #ifndef GCC2_COMPILED_FLAG_SYMBOL
1826 #define GCC2_COMPILED_FLAG_SYMBOL "gcc2_compiled."
1829 extern bool in_gnu_ifunc_stub (CORE_ADDR pc
);
1831 /* Functions for resolving STT_GNU_IFUNC symbols which are implemented only
1832 for ELF symbol files. */
1834 struct gnu_ifunc_fns
1836 /* See elf_gnu_ifunc_resolve_addr for its real implementation. */
1837 CORE_ADDR (*gnu_ifunc_resolve_addr
) (struct gdbarch
*gdbarch
, CORE_ADDR pc
);
1839 /* See elf_gnu_ifunc_resolve_name for its real implementation. */
1840 bool (*gnu_ifunc_resolve_name
) (const char *function_name
,
1841 CORE_ADDR
*function_address_p
);
1843 /* See elf_gnu_ifunc_resolver_stop for its real implementation. */
1844 void (*gnu_ifunc_resolver_stop
) (struct breakpoint
*b
);
1846 /* See elf_gnu_ifunc_resolver_return_stop for its real implementation. */
1847 void (*gnu_ifunc_resolver_return_stop
) (struct breakpoint
*b
);
1850 #define gnu_ifunc_resolve_addr gnu_ifunc_fns_p->gnu_ifunc_resolve_addr
1851 #define gnu_ifunc_resolve_name gnu_ifunc_fns_p->gnu_ifunc_resolve_name
1852 #define gnu_ifunc_resolver_stop gnu_ifunc_fns_p->gnu_ifunc_resolver_stop
1853 #define gnu_ifunc_resolver_return_stop \
1854 gnu_ifunc_fns_p->gnu_ifunc_resolver_return_stop
1856 extern const struct gnu_ifunc_fns
*gnu_ifunc_fns_p
;
1858 extern CORE_ADDR
find_solib_trampoline_target (struct frame_info
*, CORE_ADDR
);
1860 struct symtab_and_line
1862 /* The program space of this sal. */
1863 struct program_space
*pspace
= NULL
;
1865 struct symtab
*symtab
= NULL
;
1866 struct symbol
*symbol
= NULL
;
1867 struct obj_section
*section
= NULL
;
1868 struct minimal_symbol
*msymbol
= NULL
;
1869 /* Line number. Line numbers start at 1 and proceed through symtab->nlines.
1870 0 is never a valid line number; it is used to indicate that line number
1871 information is not available. */
1876 bool explicit_pc
= false;
1877 bool explicit_line
= false;
1879 /* The probe associated with this symtab_and_line. */
1881 /* If PROBE is not NULL, then this is the objfile in which the probe
1883 struct objfile
*objfile
= NULL
;
1888 /* Given a pc value, return line number it is in. Second arg nonzero means
1889 if pc is on the boundary use the previous statement's line number. */
1891 extern struct symtab_and_line
find_pc_line (CORE_ADDR
, int);
1893 /* Same function, but specify a section as well as an address. */
1895 extern struct symtab_and_line
find_pc_sect_line (CORE_ADDR
,
1896 struct obj_section
*, int);
1898 /* Wrapper around find_pc_line to just return the symtab. */
1900 extern struct symtab
*find_pc_line_symtab (CORE_ADDR
);
1902 /* Given a symtab and line number, return the pc there. */
1904 extern bool find_line_pc (struct symtab
*, int, CORE_ADDR
*);
1906 extern bool find_line_pc_range (struct symtab_and_line
, CORE_ADDR
*,
1909 extern void resolve_sal_pc (struct symtab_and_line
*);
1913 extern void clear_solib (void);
1915 /* The reason we're calling into a completion match list collector
1917 enum class complete_symbol_mode
1919 /* Completing an expression. */
1922 /* Completing a linespec. */
1926 extern void default_collect_symbol_completion_matches_break_on
1927 (completion_tracker
&tracker
,
1928 complete_symbol_mode mode
,
1929 symbol_name_match_type name_match_type
,
1930 const char *text
, const char *word
, const char *break_on
,
1931 enum type_code code
);
1932 extern void default_collect_symbol_completion_matches
1933 (completion_tracker
&tracker
,
1934 complete_symbol_mode
,
1935 symbol_name_match_type name_match_type
,
1939 extern void collect_symbol_completion_matches
1940 (completion_tracker
&tracker
,
1941 complete_symbol_mode mode
,
1942 symbol_name_match_type name_match_type
,
1943 const char *, const char *);
1944 extern void collect_symbol_completion_matches_type (completion_tracker
&tracker
,
1945 const char *, const char *,
1948 extern void collect_file_symbol_completion_matches
1949 (completion_tracker
&tracker
,
1950 complete_symbol_mode
,
1951 symbol_name_match_type name_match_type
,
1952 const char *, const char *, const char *);
1954 extern completion_list
1955 make_source_files_completion_list (const char *, const char *);
1957 /* Return whether SYM is a function/method, as opposed to a data symbol. */
1959 extern bool symbol_is_function_or_method (symbol
*sym
);
1961 /* Return whether MSYMBOL is a function/method, as opposed to a data
1964 extern bool symbol_is_function_or_method (minimal_symbol
*msymbol
);
1966 /* Return whether SYM should be skipped in completion mode MODE. In
1967 linespec mode, we're only interested in functions/methods. */
1969 template<typename Symbol
>
1971 completion_skip_symbol (complete_symbol_mode mode
, Symbol
*sym
)
1973 return (mode
== complete_symbol_mode::LINESPEC
1974 && !symbol_is_function_or_method (sym
));
1979 bool matching_obj_sections (struct obj_section
*, struct obj_section
*);
1981 extern struct symtab
*find_line_symtab (struct symtab
*, int, int *, bool *);
1983 /* Given a function symbol SYM, find the symtab and line for the start
1984 of the function. If FUNFIRSTLINE is true, we want the first line
1985 of real code inside the function. */
1986 extern symtab_and_line
find_function_start_sal (symbol
*sym
, bool
1989 /* Same, but start with a function address/section instead of a
1991 extern symtab_and_line
find_function_start_sal (CORE_ADDR func_addr
,
1992 obj_section
*section
,
1995 extern void skip_prologue_sal (struct symtab_and_line
*);
1999 extern CORE_ADDR
skip_prologue_using_sal (struct gdbarch
*gdbarch
,
2000 CORE_ADDR func_addr
);
2002 extern struct symbol
*fixup_symbol_section (struct symbol
*,
2005 /* If MSYMBOL is an text symbol, look for a function debug symbol with
2006 the same address. Returns NULL if not found. This is necessary in
2007 case a function is an alias to some other function, because debug
2008 information is only emitted for the alias target function's
2009 definition, not for the alias. */
2010 extern symbol
*find_function_alias_target (bound_minimal_symbol msymbol
);
2012 /* Symbol searching */
2013 /* Note: struct symbol_search, search_symbols, et.al. are declared here,
2014 instead of making them local to symtab.c, for gdbtk's sake. */
2016 /* When using search_symbols, a vector of the following structs is
2018 struct symbol_search
2020 symbol_search (int block_
, struct symbol
*symbol_
)
2024 msymbol
.minsym
= nullptr;
2025 msymbol
.objfile
= nullptr;
2028 symbol_search (int block_
, struct minimal_symbol
*minsym
,
2029 struct objfile
*objfile
)
2033 msymbol
.minsym
= minsym
;
2034 msymbol
.objfile
= objfile
;
2037 bool operator< (const symbol_search
&other
) const
2039 return compare_search_syms (*this, other
) < 0;
2042 bool operator== (const symbol_search
&other
) const
2044 return compare_search_syms (*this, other
) == 0;
2047 /* The block in which the match was found. Could be, for example,
2048 STATIC_BLOCK or GLOBAL_BLOCK. */
2051 /* Information describing what was found.
2053 If symbol is NOT NULL, then information was found for this match. */
2054 struct symbol
*symbol
;
2056 /* If msymbol is non-null, then a match was made on something for
2057 which only minimal_symbols exist. */
2058 struct bound_minimal_symbol msymbol
;
2062 static int compare_search_syms (const symbol_search
&sym_a
,
2063 const symbol_search
&sym_b
);
2066 extern std::vector
<symbol_search
> search_symbols (const char *,
2072 extern bool treg_matches_sym_type_name (const compiled_regex
&treg
,
2073 const struct symbol
*sym
);
2075 /* The name of the ``main'' function. */
2076 extern const char *main_name ();
2077 extern enum language
main_language (void);
2079 /* Lookup symbol NAME from DOMAIN in MAIN_OBJFILE's global or static blocks,
2080 as specified by BLOCK_INDEX.
2081 This searches MAIN_OBJFILE as well as any associated separate debug info
2082 objfiles of MAIN_OBJFILE.
2083 BLOCK_INDEX can be GLOBAL_BLOCK or STATIC_BLOCK.
2084 Upon success fixes up the symbol's section if necessary. */
2086 extern struct block_symbol
2087 lookup_global_symbol_from_objfile (struct objfile
*main_objfile
,
2088 enum block_enum block_index
,
2090 const domain_enum domain
);
2092 /* Return 1 if the supplied producer string matches the ARM RealView
2093 compiler (armcc). */
2094 bool producer_is_realview (const char *producer
);
2096 void fixup_section (struct general_symbol_info
*ginfo
,
2097 CORE_ADDR addr
, struct objfile
*objfile
);
2099 /* Look up objfile containing BLOCK. */
2101 struct objfile
*lookup_objfile_from_block (const struct block
*block
);
2103 extern unsigned int symtab_create_debug
;
2105 extern unsigned int symbol_lookup_debug
;
2107 extern bool basenames_may_differ
;
2109 bool compare_filenames_for_search (const char *filename
,
2110 const char *search_name
);
2112 bool compare_glob_filenames_for_search (const char *filename
,
2113 const char *search_name
);
2115 bool iterate_over_some_symtabs (const char *name
,
2116 const char *real_path
,
2117 struct compunit_symtab
*first
,
2118 struct compunit_symtab
*after_last
,
2119 gdb::function_view
<bool (symtab
*)> callback
);
2121 void iterate_over_symtabs (const char *name
,
2122 gdb::function_view
<bool (symtab
*)> callback
);
2125 std::vector
<CORE_ADDR
> find_pcs_for_symtab_line
2126 (struct symtab
*symtab
, int line
, struct linetable_entry
**best_entry
);
2128 /* Prototype for callbacks for LA_ITERATE_OVER_SYMBOLS. The callback
2129 is called once per matching symbol SYM. The callback should return
2130 true to indicate that LA_ITERATE_OVER_SYMBOLS should continue
2131 iterating, or false to indicate that the iteration should end. */
2133 typedef bool (symbol_found_callback_ftype
) (struct block_symbol
*bsym
);
2135 /* Iterate over the symbols named NAME, matching DOMAIN, in BLOCK.
2137 For each symbol that matches, CALLBACK is called. The symbol is
2138 passed to the callback.
2140 If CALLBACK returns false, the iteration ends and this function
2141 returns false. Otherwise, the search continues, and the function
2142 eventually returns true. */
2144 bool iterate_over_symbols (const struct block
*block
,
2145 const lookup_name_info
&name
,
2146 const domain_enum domain
,
2147 gdb::function_view
<symbol_found_callback_ftype
> callback
);
2149 /* Like iterate_over_symbols, but if all calls to CALLBACK return
2150 true, then calls CALLBACK one additional time with a block_symbol
2151 that has a valid block but a NULL symbol. */
2153 bool iterate_over_symbols_terminated
2154 (const struct block
*block
,
2155 const lookup_name_info
&name
,
2156 const domain_enum domain
,
2157 gdb::function_view
<symbol_found_callback_ftype
> callback
);
2159 /* Storage type used by demangle_for_lookup. demangle_for_lookup
2160 either returns a const char * pointer that points to either of the
2161 fields of this type, or a pointer to the input NAME. This is done
2162 this way because the underlying functions that demangle_for_lookup
2163 calls either return a std::string (e.g., cp_canonicalize_string) or
2164 a malloc'ed buffer (libiberty's demangled), and we want to avoid
2165 unnecessary reallocation/string copying. */
2166 class demangle_result_storage
2170 /* Swap the std::string storage with STR, and return a pointer to
2171 the beginning of the new string. */
2172 const char *swap_string (std::string
&str
)
2174 std::swap (m_string
, str
);
2175 return m_string
.c_str ();
2178 /* Set the malloc storage to now point at PTR. Any previous malloc
2179 storage is released. */
2180 const char *set_malloc_ptr (char *ptr
)
2182 m_malloc
.reset (ptr
);
2189 std::string m_string
;
2190 gdb::unique_xmalloc_ptr
<char> m_malloc
;
2194 demangle_for_lookup (const char *name
, enum language lang
,
2195 demangle_result_storage
&storage
);
2197 struct symbol
*allocate_symbol (struct objfile
*);
2199 void initialize_objfile_symbol (struct symbol
*);
2201 struct template_symbol
*allocate_template_symbol (struct objfile
*);
2203 /* Test to see if the symbol of language SYMBOL_LANGUAGE specified by
2204 SYMNAME (which is already demangled for C++ symbols) matches
2205 SYM_TEXT in the first SYM_TEXT_LEN characters. If so, add it to
2206 the current completion list. */
2207 void completion_list_add_name (completion_tracker
&tracker
,
2208 language symbol_language
,
2209 const char *symname
,
2210 const lookup_name_info
&lookup_name
,
2211 const char *text
, const char *word
);
2213 /* A simple symbol searching class. */
2215 class symbol_searcher
2218 /* Returns the symbols found for the search. */
2219 const std::vector
<block_symbol
> &
2220 matching_symbols () const
2225 /* Returns the minimal symbols found for the search. */
2226 const std::vector
<bound_minimal_symbol
> &
2227 matching_msymbols () const
2229 return m_minimal_symbols
;
2232 /* Search for all symbols named NAME in LANGUAGE with DOMAIN, restricting
2233 search to FILE_SYMTABS and SEARCH_PSPACE, both of which may be NULL
2234 to search all symtabs and program spaces. */
2235 void find_all_symbols (const std::string
&name
,
2236 const struct language_defn
*language
,
2237 enum search_domain search_domain
,
2238 std::vector
<symtab
*> *search_symtabs
,
2239 struct program_space
*search_pspace
);
2241 /* Reset this object to perform another search. */
2245 m_minimal_symbols
.clear ();
2249 /* Matching debug symbols. */
2250 std::vector
<block_symbol
> m_symbols
;
2252 /* Matching non-debug symbols. */
2253 std::vector
<bound_minimal_symbol
> m_minimal_symbols
;
2256 #endif /* !defined(SYMTAB_H) */