1 /* Symbol table definitions for GDB.
3 Copyright (C) 1986-2022 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 "gdbsupport/gdb_vecs.h"
29 #include "gdbsupport/gdb_obstack.h"
30 #include "gdbsupport/gdb_regex.h"
31 #include "gdbsupport/enum-flags.h"
32 #include "gdbsupport/function-view.h"
33 #include "gdbsupport/gdb_optional.h"
34 #include "gdbsupport/gdb_string_view.h"
35 #include "gdbsupport/next-iterator.h"
36 #include "gdbsupport/iterator-range.h"
37 #include "completer.h"
38 #include "gdb-demangle.h"
39 #include "split-name.h"
41 /* Opaque declarations. */
55 struct cmd_list_element
;
57 struct lookup_name_info
;
59 /* How to match a lookup name against a symbol search name. */
60 enum class symbol_name_match_type
62 /* Wild matching. Matches unqualified symbol names in all
63 namespace/module/packages, etc. */
66 /* Full matching. The lookup name indicates a fully-qualified name,
67 and only matches symbol search names in the specified
68 namespace/module/package. */
71 /* Search name matching. This is like FULL, but the search name did
72 not come from the user; instead it is already a search name
73 retrieved from a search_name () call.
74 For Ada, this avoids re-encoding an already-encoded search name
75 (which would potentially incorrectly lowercase letters in the
76 linkage/search name that should remain uppercase). For C++, it
77 avoids trying to demangle a name we already know is
81 /* Expression matching. The same as FULL matching in most
82 languages. The same as WILD matching in Ada. */
86 /* Hash the given symbol search name according to LANGUAGE's
88 extern unsigned int search_name_hash (enum language language
,
89 const char *search_name
);
91 /* Ada-specific bits of a lookup_name_info object. This is lazily
92 constructed on demand. */
94 class ada_lookup_name_info final
98 explicit ada_lookup_name_info (const lookup_name_info
&lookup_name
);
100 /* Compare SYMBOL_SEARCH_NAME with our lookup name, using MATCH_TYPE
101 as name match type. Returns true if there's a match, false
102 otherwise. If non-NULL, store the matching results in MATCH. */
103 bool matches (const char *symbol_search_name
,
104 symbol_name_match_type match_type
,
105 completion_match_result
*comp_match_res
) const;
107 /* The Ada-encoded lookup name. */
108 const std::string
&lookup_name () const
109 { return m_encoded_name
; }
111 /* Return true if we're supposed to be doing a wild match look
113 bool wild_match_p () const
114 { return m_wild_match_p
; }
116 /* Return true if we're looking up a name inside package
118 bool standard_p () const
119 { return m_standard_p
; }
121 /* Return true if doing a verbatim match. */
122 bool verbatim_p () const
123 { return m_verbatim_p
; }
125 /* A wrapper for ::split_name that handles some Ada-specific
127 std::vector
<gdb::string_view
> split_name () const
129 if (m_verbatim_p
|| m_standard_p
)
131 std::vector
<gdb::string_view
> result
;
133 result
.emplace_back ("standard");
134 result
.emplace_back (m_encoded_name
);
137 return ::split_name (m_encoded_name
.c_str (), split_style::UNDERSCORE
);
141 /* The Ada-encoded lookup name. */
142 std::string m_encoded_name
;
144 /* Whether the user-provided lookup name was Ada encoded. If so,
145 then return encoded names in the 'matches' method's 'completion
146 match result' output. */
147 bool m_encoded_p
: 1;
149 /* True if really doing wild matching. Even if the user requests
150 wild matching, some cases require full matching. */
151 bool m_wild_match_p
: 1;
153 /* True if doing a verbatim match. This is true if the decoded
154 version of the symbol name is wrapped in '<'/'>'. This is an
155 escape hatch users can use to look up symbols the Ada encoding
156 does not understand. */
157 bool m_verbatim_p
: 1;
159 /* True if the user specified a symbol name that is inside package
160 Standard. Symbol names inside package Standard are handled
161 specially. We always do a non-wild match of the symbol name
162 without the "standard__" prefix, and only search static and
163 global symbols. This was primarily introduced in order to allow
164 the user to specifically access the standard exceptions using,
165 for instance, Standard.Constraint_Error when Constraint_Error is
166 ambiguous (due to the user defining its own Constraint_Error
167 entity inside its program). */
168 bool m_standard_p
: 1;
171 /* Language-specific bits of a lookup_name_info object, for languages
172 that do name searching using demangled names (C++/D/Go). This is
173 lazily constructed on demand. */
175 struct demangle_for_lookup_info final
178 demangle_for_lookup_info (const lookup_name_info
&lookup_name
,
181 /* The demangled lookup name. */
182 const std::string
&lookup_name () const
183 { return m_demangled_name
; }
186 /* The demangled lookup name. */
187 std::string m_demangled_name
;
190 /* Object that aggregates all information related to a symbol lookup
191 name. I.e., the name that is matched against the symbol's search
192 name. Caches per-language information so that it doesn't require
193 recomputing it for every symbol comparison, like for example the
194 Ada encoded name and the symbol's name hash for a given language.
195 The object is conceptually immutable once constructed, and thus has
196 no setters. This is to prevent some code path from tweaking some
197 property of the lookup name for some local reason and accidentally
198 altering the results of any continuing search(es).
199 lookup_name_info objects are generally passed around as a const
200 reference to reinforce that. (They're not passed around by value
201 because they're not small.) */
202 class lookup_name_info final
205 /* We delete this overload so that the callers are required to
206 explicitly handle the lifetime of the name. */
207 lookup_name_info (std::string
&&name
,
208 symbol_name_match_type match_type
,
209 bool completion_mode
= false,
210 bool ignore_parameters
= false) = delete;
212 /* This overload requires that NAME have a lifetime at least as long
213 as the lifetime of this object. */
214 lookup_name_info (const std::string
&name
,
215 symbol_name_match_type match_type
,
216 bool completion_mode
= false,
217 bool ignore_parameters
= false)
218 : m_match_type (match_type
),
219 m_completion_mode (completion_mode
),
220 m_ignore_parameters (ignore_parameters
),
224 /* This overload requires that NAME have a lifetime at least as long
225 as the lifetime of this object. */
226 lookup_name_info (const char *name
,
227 symbol_name_match_type match_type
,
228 bool completion_mode
= false,
229 bool ignore_parameters
= false)
230 : m_match_type (match_type
),
231 m_completion_mode (completion_mode
),
232 m_ignore_parameters (ignore_parameters
),
236 /* Getters. See description of each corresponding field. */
237 symbol_name_match_type
match_type () const { return m_match_type
; }
238 bool completion_mode () const { return m_completion_mode
; }
239 gdb::string_view
name () const { return m_name
; }
240 const bool ignore_parameters () const { return m_ignore_parameters
; }
242 /* Like the "name" method but guarantees that the returned string is
244 const char *c_str () const
246 /* Actually this is always guaranteed due to how the class is
248 return m_name
.data ();
251 /* Return a version of this lookup name that is usable with
252 comparisons against symbols have no parameter info, such as
253 psymbols and GDB index symbols. */
254 lookup_name_info
make_ignore_params () const
256 return lookup_name_info (c_str (), m_match_type
, m_completion_mode
,
257 true /* ignore params */);
260 /* Get the search name hash for searches in language LANG. */
261 unsigned int search_name_hash (language lang
) const
263 /* Only compute each language's hash once. */
264 if (!m_demangled_hashes_p
[lang
])
266 m_demangled_hashes
[lang
]
267 = ::search_name_hash (lang
, language_lookup_name (lang
));
268 m_demangled_hashes_p
[lang
] = true;
270 return m_demangled_hashes
[lang
];
273 /* Get the search name for searches in language LANG. */
274 const char *language_lookup_name (language lang
) const
279 return ada ().lookup_name ().c_str ();
281 return cplus ().lookup_name ().c_str ();
283 return d ().lookup_name ().c_str ();
285 return go ().lookup_name ().c_str ();
287 return m_name
.data ();
291 /* A wrapper for ::split_name (see split-name.h) that splits this
292 name, and that handles any language-specific peculiarities. */
293 std::vector
<gdb::string_view
> split_name (language lang
) const
295 if (lang
== language_ada
)
296 return ada ().split_name ();
297 split_style style
= split_style::NONE
;
302 style
= split_style::CXX
;
306 style
= split_style::DOT
;
309 return ::split_name (language_lookup_name (lang
), style
);
312 /* Get the Ada-specific lookup info. */
313 const ada_lookup_name_info
&ada () const
319 /* Get the C++-specific lookup info. */
320 const demangle_for_lookup_info
&cplus () const
322 maybe_init (m_cplus
, language_cplus
);
326 /* Get the D-specific lookup info. */
327 const demangle_for_lookup_info
&d () const
329 maybe_init (m_d
, language_d
);
333 /* Get the Go-specific lookup info. */
334 const demangle_for_lookup_info
&go () const
336 maybe_init (m_go
, language_go
);
340 /* Get a reference to a lookup_name_info object that matches any
342 static const lookup_name_info
&match_any ();
345 /* Initialize FIELD, if not initialized yet. */
346 template<typename Field
, typename
... Args
>
347 void maybe_init (Field
&field
, Args
&&... args
) const
350 field
.emplace (*this, std::forward
<Args
> (args
)...);
353 /* The lookup info as passed to the ctor. */
354 symbol_name_match_type m_match_type
;
355 bool m_completion_mode
;
356 bool m_ignore_parameters
;
357 gdb::string_view m_name
;
359 /* Language-specific info. These fields are filled lazily the first
360 time a lookup is done in the corresponding language. They're
361 mutable because lookup_name_info objects are typically passed
362 around by const reference (see intro), and they're conceptually
363 "cache" that can always be reconstructed from the non-mutable
365 mutable gdb::optional
<ada_lookup_name_info
> m_ada
;
366 mutable gdb::optional
<demangle_for_lookup_info
> m_cplus
;
367 mutable gdb::optional
<demangle_for_lookup_info
> m_d
;
368 mutable gdb::optional
<demangle_for_lookup_info
> m_go
;
370 /* The demangled hashes. Stored in an array with one entry for each
371 possible language. The second array records whether we've
372 already computed the each language's hash. (These are separate
373 arrays instead of a single array of optional<unsigned> to avoid
374 alignment padding). */
375 mutable std::array
<unsigned int, nr_languages
> m_demangled_hashes
;
376 mutable std::array
<bool, nr_languages
> m_demangled_hashes_p
{};
379 /* Comparison function for completion symbol lookup.
381 Returns true if the symbol name matches against LOOKUP_NAME.
383 SYMBOL_SEARCH_NAME should be a symbol's "search" name.
385 On success and if non-NULL, COMP_MATCH_RES->match is set to point
386 to the symbol name as should be presented to the user as a
387 completion match list element. In most languages, this is the same
388 as the symbol's search name, but in some, like Ada, the display
389 name is dynamically computed within the comparison routine.
391 Also, on success and if non-NULL, COMP_MATCH_RES->match_for_lcd
392 points the part of SYMBOL_SEARCH_NAME that was considered to match
393 LOOKUP_NAME. E.g., in C++, in linespec/wild mode, if the symbol is
394 "foo::function()" and LOOKUP_NAME is "function(", MATCH_FOR_LCD
395 points to "function()" inside SYMBOL_SEARCH_NAME. */
396 typedef bool (symbol_name_matcher_ftype
)
397 (const char *symbol_search_name
,
398 const lookup_name_info
&lookup_name
,
399 completion_match_result
*comp_match_res
);
401 /* Some of the structures in this file are space critical.
402 The space-critical structures are:
404 struct general_symbol_info
406 struct partial_symbol
408 These structures are laid out to encourage good packing.
409 They use ENUM_BITFIELD and short int fields, and they order the
410 structure members so that fields less than a word are next
411 to each other so they can be packed together. */
413 /* Rearranged: used ENUM_BITFIELD and rearranged field order in
414 all the space critical structures (plus struct minimal_symbol).
415 Memory usage dropped from 99360768 bytes to 90001408 bytes.
416 I measured this with before-and-after tests of
417 "HEAD-old-gdb -readnow HEAD-old-gdb" and
418 "HEAD-new-gdb -readnow HEAD-old-gdb" on native i686-pc-linux-gnu,
419 red hat linux 8, with LD_LIBRARY_PATH=/usr/lib/debug,
420 typing "maint space 1" at the first command prompt.
422 Here is another measurement (from andrew c):
423 # no /usr/lib/debug, just plain glibc, like a normal user
425 (gdb) break internal_error
427 (gdb) maint internal-error
431 gdb gdb_6_0_branch 2003-08-19 space used: 8896512
432 gdb HEAD 2003-08-19 space used: 8904704
433 gdb HEAD 2003-08-21 space used: 8396800 (+symtab.h)
434 gdb HEAD 2003-08-21 space used: 8265728 (+gdbtypes.h)
436 The third line shows the savings from the optimizations in symtab.h.
437 The fourth line shows the savings from the optimizations in
438 gdbtypes.h. Both optimizations are in gdb HEAD now.
440 --chastain 2003-08-21 */
442 /* Define a structure for the information that is common to all symbol types,
443 including minimal symbols, partial symbols, and full symbols. In a
444 multilanguage environment, some language specific information may need to
445 be recorded along with each symbol. */
447 /* This structure is space critical. See space comments at the top. */
449 struct general_symbol_info
451 /* Short version as to when to use which name accessor:
452 Use natural_name () to refer to the name of the symbol in the original
453 source code. Use linkage_name () if you want to know what the linker
454 thinks the symbol's name is. Use print_name () for output. Use
455 demangled_name () if you specifically need to know whether natural_name ()
456 and linkage_name () are different. */
458 const char *linkage_name () const
461 /* Return SYMBOL's "natural" name, i.e. the name that it was called in
462 the original source code. In languages like C++ where symbols may
463 be mangled for ease of manipulation by the linker, this is the
465 const char *natural_name () const;
467 /* Returns a version of the name of a symbol that is
468 suitable for output. In C++ this is the "demangled" form of the
469 name if demangle is on and the "mangled" form of the name if
470 demangle is off. In other languages this is just the symbol name.
471 The result should never be NULL. Don't use this for internal
472 purposes (e.g. storing in a hashtable): it's only suitable for output. */
473 const char *print_name () const
474 { return demangle
? natural_name () : linkage_name (); }
476 /* Return the demangled name for a symbol based on the language for
477 that symbol. If no demangled name exists, return NULL. */
478 const char *demangled_name () const;
480 /* Returns the name to be used when sorting and searching symbols.
481 In C++, we search for the demangled form of a name,
482 and so sort symbols accordingly. In Ada, however, we search by mangled
483 name. If there is no distinct demangled name, then this
484 returns the same value (same pointer) as linkage_name (). */
485 const char *search_name () const;
487 /* Set just the linkage name of a symbol; do not try to demangle
488 it. Used for constructs which do not have a mangled name,
489 e.g. struct tags. Unlike compute_and_set_names, linkage_name must
490 be terminated and either already on the objfile's obstack or
491 permanently allocated. */
492 void set_linkage_name (const char *linkage_name
)
493 { m_name
= linkage_name
; }
495 /* Set the demangled name of this symbol to NAME. NAME must be
496 already correctly allocated. If the symbol's language is Ada,
497 then the name is ignored and the obstack is set. */
498 void set_demangled_name (const char *name
, struct obstack
*obstack
);
500 enum language
language () const
501 { return m_language
; }
503 /* Initializes the language dependent portion of a symbol
504 depending upon the language for the symbol. */
505 void set_language (enum language language
, struct obstack
*obstack
);
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 void compute_and_set_names (gdb::string_view linkage_name
, bool copy_name
,
511 struct objfile_per_bfd_storage
*per_bfd
,
512 gdb::optional
<hashval_t
> hash
513 = gdb::optional
<hashval_t
> ());
515 CORE_ADDR
value_address () const
517 return m_value
.address
;
520 void set_value_address (CORE_ADDR address
)
522 m_value
.address
= address
;
525 /* Name of the symbol. This is a required field. Storage for the
526 name is allocated on the objfile_obstack for the associated
527 objfile. For languages like C++ that make a distinction between
528 the mangled name and demangled name, this is the mangled
533 /* Value of the symbol. Which member of this union to use, and what
534 it means, depends on what kind of symbol this is and its
535 SYMBOL_CLASS. See comments there for more details. All of these
536 are in host byte order (though what they point to might be in
537 target byte order, e.g. LOC_CONST_BYTES). */
543 const struct block
*block
;
545 const gdb_byte
*bytes
;
549 /* A common block. Used with LOC_COMMON_BLOCK. */
551 const struct common_block
*common_block
;
553 /* For opaque typedef struct chain. */
555 struct symbol
*chain
;
559 /* Since one and only one language can apply, wrap the language specific
560 information inside a union. */
564 /* A pointer to an obstack that can be used for storage associated
565 with this symbol. This is only used by Ada, and only when the
566 'ada_mangled' field is zero. */
567 struct obstack
*obstack
;
569 /* This is used by languages which wish to store a demangled name.
570 currently used by Ada, C++, and Objective C. */
571 const char *demangled_name
;
575 /* Record the source code language that applies to this symbol.
576 This is used to select one of the fields from the language specific
579 ENUM_BITFIELD(language
) m_language
: LANGUAGE_BITS
;
581 /* This is only used by Ada. If set, then the 'demangled_name' field
582 of language_specific is valid. Otherwise, the 'obstack' field is
584 unsigned int ada_mangled
: 1;
586 /* Which section is this symbol in? This is an index into
587 section_offsets for this objfile. Negative means that the symbol
588 does not get relocated relative to a section. */
592 /* Set the index into the obj_section list (within the containing
593 objfile) for the section that contains this symbol. See M_SECTION
596 void set_section_index (short idx
)
599 /* Return the index into the obj_section list (within the containing
600 objfile) for the section that contains this symbol. See M_SECTION
603 short section_index () const
604 { return m_section
; }
606 /* Return the obj_section from OBJFILE for this symbol. The symbol
607 returned is based on the SECTION member variable, and can be nullptr
608 if SECTION is negative. */
610 struct obj_section
*obj_section (const struct objfile
*objfile
) const;
613 extern CORE_ADDR
symbol_overlayed_address (CORE_ADDR
, struct obj_section
*);
615 /* Return the address of SYM. The MAYBE_COPIED flag must be set on
616 SYM. If SYM appears in the main program's minimal symbols, then
617 that minsym's address is returned; otherwise, SYM's address is
618 returned. This should generally only be used via the
619 SYMBOL_VALUE_ADDRESS macro. */
621 extern CORE_ADDR
get_symbol_address (const struct symbol
*sym
);
623 /* Try to determine the demangled name for a symbol, based on the
624 language of that symbol. If the language is set to language_auto,
625 it will attempt to find any demangling algorithm that works and
626 then set the language appropriately. The returned name is allocated
627 by the demangler and should be xfree'd. */
629 extern gdb::unique_xmalloc_ptr
<char> symbol_find_demangled_name
630 (struct general_symbol_info
*gsymbol
, const char *mangled
);
632 /* Return true if NAME matches the "search" name of GSYMBOL, according
633 to the symbol's language. */
634 extern bool symbol_matches_search_name
635 (const struct general_symbol_info
*gsymbol
,
636 const lookup_name_info
&name
);
638 /* Compute the hash of the given symbol search name of a symbol of
639 language LANGUAGE. */
640 extern unsigned int search_name_hash (enum language language
,
641 const char *search_name
);
643 /* Classification types for a minimal symbol. These should be taken as
644 "advisory only", since if gdb can't easily figure out a
645 classification it simply selects mst_unknown. It may also have to
646 guess when it can't figure out which is a better match between two
647 types (mst_data versus mst_bss) for example. Since the minimal
648 symbol info is sometimes derived from the BFD library's view of a
649 file, we need to live with what information bfd supplies. */
651 enum minimal_symbol_type
653 mst_unknown
= 0, /* Unknown type, the default */
654 mst_text
, /* Generally executable instructions */
656 /* A GNU ifunc symbol, in the .text section. GDB uses to know
657 whether the user is setting a breakpoint on a GNU ifunc function,
658 and thus GDB needs to actually set the breakpoint on the target
659 function. It is also used to know whether the program stepped
660 into an ifunc resolver -- the resolver may get a separate
661 symbol/alias under a different name, but it'll have the same
662 address as the ifunc symbol. */
663 mst_text_gnu_ifunc
, /* Executable code returning address
664 of executable code */
666 /* A GNU ifunc function descriptor symbol, in a data section
667 (typically ".opd"). Seen on architectures that use function
668 descriptors, like PPC64/ELFv1. In this case, this symbol's value
669 is the address of the descriptor. There'll be a corresponding
670 mst_text_gnu_ifunc synthetic symbol for the text/entry
672 mst_data_gnu_ifunc
, /* Executable code returning address
673 of executable code */
675 mst_slot_got_plt
, /* GOT entries for .plt sections */
676 mst_data
, /* Generally initialized data */
677 mst_bss
, /* Generally uninitialized data */
678 mst_abs
, /* Generally absolute (nonrelocatable) */
679 /* GDB uses mst_solib_trampoline for the start address of a shared
680 library trampoline entry. Breakpoints for shared library functions
681 are put there if the shared library is not yet loaded.
682 After the shared library is loaded, lookup_minimal_symbol will
683 prefer the minimal symbol from the shared library (usually
684 a mst_text symbol) over the mst_solib_trampoline symbol, and the
685 breakpoints will be moved to their true address in the shared
686 library via breakpoint_re_set. */
687 mst_solib_trampoline
, /* Shared library trampoline code */
688 /* For the mst_file* types, the names are only guaranteed to be unique
689 within a given .o file. */
690 mst_file_text
, /* Static version of mst_text */
691 mst_file_data
, /* Static version of mst_data */
692 mst_file_bss
, /* Static version of mst_bss */
696 /* The number of enum minimal_symbol_type values, with some padding for
697 reasonable growth. */
698 #define MINSYM_TYPE_BITS 4
699 gdb_static_assert (nr_minsym_types
<= (1 << MINSYM_TYPE_BITS
));
701 /* Return the address of MINSYM, which comes from OBJF. The
702 MAYBE_COPIED flag must be set on MINSYM. If MINSYM appears in the
703 main program's minimal symbols, then that minsym's address is
704 returned; otherwise, MINSYM's address is returned. This should
705 generally only be used via the MSYMBOL_VALUE_ADDRESS macro. */
707 extern CORE_ADDR
get_msymbol_address (struct objfile
*objf
,
708 const struct minimal_symbol
*minsym
);
710 /* Define a simple structure used to hold some very basic information about
711 all defined global symbols (text, data, bss, abs, etc). The only required
712 information is the general_symbol_info.
714 In many cases, even if a file was compiled with no special options for
715 debugging at all, as long as was not stripped it will contain sufficient
716 information to build a useful minimal symbol table using this structure.
717 Even when a file contains enough debugging information to build a full
718 symbol table, these minimal symbols are still useful for quickly mapping
719 between names and addresses, and vice versa. They are also sometimes
720 used to figure out what full symbol table entries need to be read in. */
722 struct minimal_symbol
: public general_symbol_info
724 LONGEST
value_longest () const
726 return m_value
.ivalue
;
729 /* The relocated address of the minimal symbol, using the section
730 offsets from OBJFILE. */
731 CORE_ADDR
value_address (objfile
*objfile
) const;
733 /* The unrelocated address of the minimal symbol. */
734 CORE_ADDR
value_raw_address () const
736 return m_value
.address
;
739 /* Return this minimal symbol's type. */
741 minimal_symbol_type
type () const
746 /* Set this minimal symbol's type. */
748 void set_type (minimal_symbol_type type
)
753 /* Return this minimal symbol's size. */
755 unsigned long size () const
760 /* Set this minimal symbol's size. */
762 void set_size (unsigned long size
)
768 /* Return true if this minimal symbol's size is known. */
770 bool has_size () const
775 /* Return this minimal symbol's first target-specific flag. */
777 bool target_flag_1 () const
779 return m_target_flag_1
;
782 /* Set this minimal symbol's first target-specific flag. */
784 void set_target_flag_1 (bool target_flag_1
)
786 m_target_flag_1
= target_flag_1
;
789 /* Return this minimal symbol's second target-specific flag. */
791 bool target_flag_2 () const
793 return m_target_flag_2
;
796 /* Set this minimal symbol's second target-specific flag. */
798 void set_target_flag_2 (bool target_flag_2
)
800 m_target_flag_2
= target_flag_2
;
803 /* Size of this symbol. dbx_end_psymtab in dbxread.c uses this
804 information to calculate the end of the partial symtab based on the
805 address of the last symbol plus the size of the last symbol. */
807 unsigned long m_size
;
809 /* Which source file is this symbol in? Only relevant for mst_file_*. */
810 const char *filename
;
812 /* Classification type for this minimal symbol. */
814 ENUM_BITFIELD(minimal_symbol_type
) m_type
: MINSYM_TYPE_BITS
;
816 /* Non-zero if this symbol was created by gdb.
817 Such symbols do not appear in the output of "info var|fun". */
818 unsigned int created_by_gdb
: 1;
820 /* Two flag bits provided for the use of the target. */
821 unsigned int m_target_flag_1
: 1;
822 unsigned int m_target_flag_2
: 1;
824 /* Nonzero iff the size of the minimal symbol has been set.
825 Symbol size information can sometimes not be determined, because
826 the object file format may not carry that piece of information. */
827 unsigned int m_has_size
: 1;
829 /* For data symbols only, if this is set, then the symbol might be
830 subject to copy relocation. In this case, a minimal symbol
831 matching the symbol's linkage name is first looked for in the
832 main objfile. If found, then that address is used; otherwise the
833 address in this symbol is used. */
835 unsigned maybe_copied
: 1;
837 /* Non-zero if this symbol ever had its demangled name set (even if
838 it was set to NULL). */
839 unsigned int name_set
: 1;
841 /* Minimal symbols with the same hash key are kept on a linked
842 list. This is the link. */
844 struct minimal_symbol
*hash_next
;
846 /* Minimal symbols are stored in two different hash tables. This is
847 the `next' pointer for the demangled hash table. */
849 struct minimal_symbol
*demangled_hash_next
;
851 /* True if this symbol is of some data type. */
853 bool data_p () const;
855 /* True if MSYMBOL is of some text type. */
857 bool text_p () const;
864 /* Represent one symbol name; a variable, constant, function or typedef. */
866 /* Different name domains for symbols. Looking up a symbol specifies a
867 domain and ignores symbol definitions in other name domains. */
869 typedef enum domain_enum_tag
871 /* UNDEF_DOMAIN is used when a domain has not been discovered or
872 none of the following apply. This usually indicates an error either
873 in the symbol information or in gdb's handling of symbols. */
877 /* VAR_DOMAIN is the usual domain. In C, this contains variables,
878 function names, typedef names and enum type values. */
882 /* STRUCT_DOMAIN is used in C to hold struct, union and enum type names.
883 Thus, if `struct foo' is used in a C program, it produces a symbol named
884 `foo' in the STRUCT_DOMAIN. */
888 /* MODULE_DOMAIN is used in Fortran to hold module type names. */
892 /* LABEL_DOMAIN may be used for names of labels (for gotos). */
896 /* Fortran common blocks. Their naming must be separate from VAR_DOMAIN.
897 They also always use LOC_COMMON_BLOCK. */
900 /* This must remain last. */
904 /* The number of bits in a symbol used to represent the domain. */
906 #define SYMBOL_DOMAIN_BITS 3
907 gdb_static_assert (NR_DOMAINS
<= (1 << SYMBOL_DOMAIN_BITS
));
909 extern const char *domain_name (domain_enum
);
911 /* Searching domains, used when searching for symbols. Element numbers are
912 hardcoded in GDB, check all enum uses before changing it. */
916 /* Everything in VAR_DOMAIN minus FUNCTIONS_DOMAIN and
918 VARIABLES_DOMAIN
= 0,
920 /* All functions -- for some reason not methods, though. */
921 FUNCTIONS_DOMAIN
= 1,
923 /* All defined types */
933 extern const char *search_domain_name (enum search_domain
);
935 /* An address-class says where to find the value of a symbol. */
939 /* Not used; catches errors. */
943 /* Value is constant int SYMBOL_VALUE, host byteorder. */
947 /* Value is at fixed address SYMBOL_VALUE_ADDRESS. */
951 /* Value is in register. SYMBOL_VALUE is the register number
952 in the original debug format. SYMBOL_REGISTER_OPS holds a
953 function that can be called to transform this into the
954 actual register number this represents in a specific target
955 architecture (gdbarch).
957 For some symbol formats (stabs, for some compilers at least),
958 the compiler generates two symbols, an argument and a register.
959 In some cases we combine them to a single LOC_REGISTER in symbol
960 reading, but currently not for all cases (e.g. it's passed on the
961 stack and then loaded into a register). */
965 /* It's an argument; the value is at SYMBOL_VALUE offset in arglist. */
969 /* Value address is at SYMBOL_VALUE offset in arglist. */
973 /* Value is in specified register. Just like LOC_REGISTER except the
974 register holds the address of the argument instead of the argument
975 itself. This is currently used for the passing of structs and unions
976 on sparc and hppa. It is also used for call by reference where the
977 address is in a register, at least by mipsread.c. */
981 /* Value is a local variable at SYMBOL_VALUE offset in stack frame. */
985 /* Value not used; definition in SYMBOL_TYPE. Symbols in the domain
986 STRUCT_DOMAIN all have this class. */
990 /* Value is address SYMBOL_VALUE_ADDRESS in the code. */
994 /* In a symbol table, value is SYMBOL_BLOCK_VALUE of a `struct block'.
995 In a partial symbol table, SYMBOL_VALUE_ADDRESS is the start address
996 of the block. Function names have this class. */
1000 /* Value is a constant byte-sequence pointed to by SYMBOL_VALUE_BYTES, in
1001 target byte order. */
1005 /* Value is at fixed address, but the address of the variable has
1006 to be determined from the minimal symbol table whenever the
1007 variable is referenced.
1008 This happens if debugging information for a global symbol is
1009 emitted and the corresponding minimal symbol is defined
1010 in another object file or runtime common storage.
1011 The linker might even remove the minimal symbol if the global
1012 symbol is never referenced, in which case the symbol remains
1015 GDB would normally find the symbol in the minimal symbol table if it will
1016 not find it in the full symbol table. But a reference to an external
1017 symbol in a local block shadowing other definition requires full symbol
1018 without possibly having its address available for LOC_STATIC. Testcase
1019 is provided as `gdb.dwarf2/dw2-unresolved.exp'.
1021 This is also used for thread local storage (TLS) variables. In this case,
1022 the address of the TLS variable must be determined when the variable is
1023 referenced, from the MSYMBOL_VALUE_RAW_ADDRESS, which is the offset
1024 of the TLS variable in the thread local storage of the shared
1029 /* The variable does not actually exist in the program.
1030 The value is ignored. */
1034 /* The variable's address is computed by a set of location
1035 functions (see "struct symbol_computed_ops" below). */
1038 /* The variable uses general_symbol_info->value->common_block field.
1039 It also always uses COMMON_BLOCK_DOMAIN. */
1042 /* Not used, just notes the boundary of the enum. */
1046 /* The number of bits needed for values in enum address_class, with some
1047 padding for reasonable growth, and room for run-time registered address
1048 classes. See symtab.c:MAX_SYMBOL_IMPLS.
1049 This is a #define so that we can have a assertion elsewhere to
1050 verify that we have reserved enough space for synthetic address
1052 #define SYMBOL_ACLASS_BITS 5
1053 gdb_static_assert (LOC_FINAL_VALUE
<= (1 << SYMBOL_ACLASS_BITS
));
1055 /* The methods needed to implement LOC_COMPUTED. These methods can
1056 use the symbol's .aux_value for additional per-symbol information.
1058 At present this is only used to implement location expressions. */
1060 struct symbol_computed_ops
1063 /* Return the value of the variable SYMBOL, relative to the stack
1064 frame FRAME. If the variable has been optimized out, return
1067 Iff `read_needs_frame (SYMBOL)' is not SYMBOL_NEEDS_FRAME, then
1068 FRAME may be zero. */
1070 struct value
*(*read_variable
) (struct symbol
* symbol
,
1071 struct frame_info
* frame
);
1073 /* Read variable SYMBOL like read_variable at (callee) FRAME's function
1074 entry. SYMBOL should be a function parameter, otherwise
1075 NO_ENTRY_VALUE_ERROR will be thrown. */
1076 struct value
*(*read_variable_at_entry
) (struct symbol
*symbol
,
1077 struct frame_info
*frame
);
1079 /* Find the "symbol_needs_kind" value for the given symbol. This
1080 value determines whether reading the symbol needs memory (e.g., a
1081 global variable), just registers (a thread-local), or a frame (a
1083 enum symbol_needs_kind (*get_symbol_read_needs
) (struct symbol
* symbol
);
1085 /* Write to STREAM a natural-language description of the location of
1086 SYMBOL, in the context of ADDR. */
1087 void (*describe_location
) (struct symbol
* symbol
, CORE_ADDR addr
,
1088 struct ui_file
* stream
);
1090 /* Non-zero if this symbol's address computation is dependent on PC. */
1091 unsigned char location_has_loclist
;
1093 /* Tracepoint support. Append bytecodes to the tracepoint agent
1094 expression AX that push the address of the object SYMBOL. Set
1095 VALUE appropriately. Note --- for objects in registers, this
1096 needn't emit any code; as long as it sets VALUE properly, then
1097 the caller will generate the right code in the process of
1098 treating this as an lvalue or rvalue. */
1100 void (*tracepoint_var_ref
) (struct symbol
*symbol
, struct agent_expr
*ax
,
1101 struct axs_value
*value
);
1103 /* Generate C code to compute the location of SYMBOL. The C code is
1104 emitted to STREAM. GDBARCH is the current architecture and PC is
1105 the PC at which SYMBOL's location should be evaluated.
1106 REGISTERS_USED is a vector indexed by register number; the
1107 generator function should set an element in this vector if the
1108 corresponding register is needed by the location computation.
1109 The generated C code must assign the location to a local
1110 variable; this variable's name is RESULT_NAME. */
1112 void (*generate_c_location
) (struct symbol
*symbol
, string_file
*stream
,
1113 struct gdbarch
*gdbarch
,
1114 std::vector
<bool> ®isters_used
,
1115 CORE_ADDR pc
, const char *result_name
);
1119 /* The methods needed to implement LOC_BLOCK for inferior functions.
1120 These methods can use the symbol's .aux_value for additional
1121 per-symbol information. */
1123 struct symbol_block_ops
1125 /* Fill in *START and *LENGTH with DWARF block data of function
1126 FRAMEFUNC valid for inferior context address PC. Set *LENGTH to
1127 zero if such location is not valid for PC; *START is left
1128 uninitialized in such case. */
1129 void (*find_frame_base_location
) (struct symbol
*framefunc
, CORE_ADDR pc
,
1130 const gdb_byte
**start
, size_t *length
);
1132 /* Return the frame base address. FRAME is the frame for which we want to
1133 compute the base address while FRAMEFUNC is the symbol for the
1134 corresponding function. Return 0 on failure (FRAMEFUNC may not hold the
1135 information we need).
1137 This method is designed to work with static links (nested functions
1138 handling). Static links are function properties whose evaluation returns
1139 the frame base address for the enclosing frame. However, there are
1140 multiple definitions for "frame base": the content of the frame base
1141 register, the CFA as defined by DWARF unwinding information, ...
1143 So this specific method is supposed to compute the frame base address such
1144 as for nested functions, the static link computes the same address. For
1145 instance, considering DWARF debugging information, the static link is
1146 computed with DW_AT_static_link and this method must be used to compute
1147 the corresponding DW_AT_frame_base attribute. */
1148 CORE_ADDR (*get_frame_base
) (struct symbol
*framefunc
,
1149 struct frame_info
*frame
);
1152 /* Functions used with LOC_REGISTER and LOC_REGPARM_ADDR. */
1154 struct symbol_register_ops
1156 int (*register_number
) (struct symbol
*symbol
, struct gdbarch
*gdbarch
);
1159 /* Objects of this type are used to find the address class and the
1160 various computed ops vectors of a symbol. */
1164 enum address_class aclass
;
1166 /* Used with LOC_COMPUTED. */
1167 const struct symbol_computed_ops
*ops_computed
;
1169 /* Used with LOC_BLOCK. */
1170 const struct symbol_block_ops
*ops_block
;
1172 /* Used with LOC_REGISTER and LOC_REGPARM_ADDR. */
1173 const struct symbol_register_ops
*ops_register
;
1176 /* struct symbol has some subclasses. This enum is used to
1177 differentiate between them. */
1179 enum symbol_subclass_kind
1181 /* Plain struct symbol. */
1184 /* struct template_symbol. */
1187 /* struct rust_vtable_symbol. */
1191 extern gdb::array_view
<const struct symbol_impl
> symbol_impls
;
1193 /* This structure is space critical. See space comments at the top. */
1195 struct symbol
: public general_symbol_info
, public allocate_on_obstack
1198 /* Class-initialization of bitfields is only allowed in C++20. */
1199 : m_domain (UNDEF_DOMAIN
),
1201 m_is_objfile_owned (1),
1205 subclass (SYMBOL_NONE
),
1206 m_artificial (false)
1208 /* We can't use an initializer list for members of a base class, and
1209 general_symbol_info needs to stay a POD type. */
1212 language_specific
.obstack
= nullptr;
1213 m_language
= language_unknown
;
1216 /* GCC 4.8.5 (on CentOS 7) does not correctly compile class-
1217 initialization of unions, so we initialize it manually here. */
1218 owner
.symtab
= nullptr;
1221 symbol (const symbol
&) = default;
1222 symbol
&operator= (const symbol
&) = default;
1224 void set_aclass_index (unsigned int aclass_index
)
1226 m_aclass_index
= aclass_index
;
1229 const symbol_impl
&impl () const
1231 return symbol_impls
[this->m_aclass_index
];
1234 address_class
aclass () const
1236 return this->impl ().aclass
;
1239 domain_enum
domain () const
1244 void set_domain (domain_enum domain
)
1249 bool is_objfile_owned () const
1251 return m_is_objfile_owned
;
1254 void set_is_objfile_owned (bool is_objfile_owned
)
1256 m_is_objfile_owned
= is_objfile_owned
;
1259 bool is_argument () const
1261 return m_is_argument
;
1264 void set_is_argument (bool is_argument
)
1266 m_is_argument
= is_argument
;
1269 bool is_inlined () const
1271 return m_is_inlined
;
1274 void set_is_inlined (bool is_inlined
)
1276 m_is_inlined
= is_inlined
;
1279 bool is_cplus_template_function () const
1281 return this->subclass
== SYMBOL_TEMPLATE
;
1284 struct type
*type () const
1289 void set_type (struct type
*type
)
1294 unsigned short line () const
1299 void set_line (unsigned short line
)
1304 LONGEST
value_longest () const
1306 return m_value
.ivalue
;
1309 void set_value_longest (LONGEST value
)
1311 m_value
.ivalue
= value
;
1314 CORE_ADDR
value_address () const
1316 if (this->maybe_copied
)
1317 return get_symbol_address (this);
1319 return m_value
.address
;
1322 void set_value_address (CORE_ADDR address
)
1324 m_value
.address
= address
;
1327 const gdb_byte
*value_bytes () const
1329 return m_value
.bytes
;
1332 void set_value_bytes (const gdb_byte
*bytes
)
1334 m_value
.bytes
= bytes
;
1337 const common_block
*value_common_block () const
1339 return m_value
.common_block
;
1342 void set_value_common_block (const common_block
*common_block
)
1344 m_value
.common_block
= common_block
;
1347 const block
*value_block () const
1349 return m_value
.block
;
1352 void set_value_block (const block
*block
)
1354 m_value
.block
= block
;
1357 symbol
*value_chain () const
1359 return m_value
.chain
;
1362 void set_value_chain (symbol
*sym
)
1364 m_value
.chain
= sym
;
1367 /* Return true if this symbol was marked as artificial. */
1368 bool is_artificial () const
1370 return m_artificial
;
1373 /* Set the 'artificial' flag on this symbol. */
1374 void set_is_artificial (bool artificial
)
1376 m_artificial
= artificial
;
1379 /* Return the OBJFILE of this symbol. It is an error to call this
1380 if is_objfile_owned is false, which only happens for
1381 architecture-provided types. */
1383 struct objfile
*objfile () const;
1385 /* Data type of value */
1387 struct type
*m_type
= nullptr;
1389 /* The owner of this symbol.
1390 Which one to use is defined by symbol.is_objfile_owned. */
1394 /* The symbol table containing this symbol. This is the file associated
1395 with LINE. It can be NULL during symbols read-in but it is never NULL
1396 during normal operation. */
1397 struct symtab
*symtab
;
1399 /* For types defined by the architecture. */
1400 struct gdbarch
*arch
;
1405 ENUM_BITFIELD(domain_enum_tag
) m_domain
: SYMBOL_DOMAIN_BITS
;
1407 /* Address class. This holds an index into the 'symbol_impls'
1408 table. The actual enum address_class value is stored there,
1409 alongside any per-class ops vectors. */
1411 unsigned int m_aclass_index
: SYMBOL_ACLASS_BITS
;
1413 /* If non-zero then symbol is objfile-owned, use owner.symtab.
1414 Otherwise symbol is arch-owned, use owner.arch. */
1416 unsigned int m_is_objfile_owned
: 1;
1418 /* Whether this is an argument. */
1420 unsigned m_is_argument
: 1;
1422 /* Whether this is an inlined function (class LOC_BLOCK only). */
1423 unsigned m_is_inlined
: 1;
1425 /* For LOC_STATIC only, if this is set, then the symbol might be
1426 subject to copy relocation. In this case, a minimal symbol
1427 matching the symbol's linkage name is first looked for in the
1428 main objfile. If found, then that address is used; otherwise the
1429 address in this symbol is used. */
1431 unsigned maybe_copied
: 1;
1433 /* The concrete type of this symbol. */
1435 ENUM_BITFIELD (symbol_subclass_kind
) subclass
: 2;
1437 /* Whether this symbol is artificial. */
1439 bool m_artificial
: 1;
1441 /* Line number of this symbol's definition, except for inlined
1442 functions. For an inlined function (class LOC_BLOCK and
1443 SYMBOL_INLINED set) this is the line number of the function's call
1444 site. Inlined function symbols are not definitions, and they are
1445 never found by symbol table lookup.
1446 If this symbol is arch-owned, LINE shall be zero.
1448 FIXME: Should we really make the assumption that nobody will try
1449 to debug files longer than 64K lines? What about machine
1450 generated programs? */
1452 unsigned short m_line
= 0;
1454 /* An arbitrary data pointer, allowing symbol readers to record
1455 additional information on a per-symbol basis. Note that this data
1456 must be allocated using the same obstack as the symbol itself. */
1457 /* So far it is only used by:
1458 LOC_COMPUTED: to find the location information
1459 LOC_BLOCK (DWARF2 function): information used internally by the
1460 DWARF 2 code --- specifically, the location expression for the frame
1461 base for this function. */
1462 /* FIXME drow/2003-02-21: For the LOC_BLOCK case, it might be better
1463 to add a magic symbol to the block containing this information,
1464 or to have a generic debug info annotation slot for symbols. */
1466 void *aux_value
= nullptr;
1468 struct symbol
*hash_next
= nullptr;
1471 /* Several lookup functions return both a symbol and the block in which the
1472 symbol is found. This structure is used in these cases. */
1476 /* The symbol that was found, or NULL if no symbol was found. */
1477 struct symbol
*symbol
;
1479 /* If SYMBOL is not NULL, then this is the block in which the symbol is
1481 const struct block
*block
;
1484 /* Note: There is no accessor macro for symbol.owner because it is
1487 #define SYMBOL_COMPUTED_OPS(symbol) ((symbol)->impl ().ops_computed)
1488 #define SYMBOL_BLOCK_OPS(symbol) ((symbol)->impl ().ops_block)
1489 #define SYMBOL_REGISTER_OPS(symbol) ((symbol)->impl ().ops_register)
1490 #define SYMBOL_LOCATION_BATON(symbol) (symbol)->aux_value
1492 extern int register_symbol_computed_impl (enum address_class
,
1493 const struct symbol_computed_ops
*);
1495 extern int register_symbol_block_impl (enum address_class aclass
,
1496 const struct symbol_block_ops
*ops
);
1498 extern int register_symbol_register_impl (enum address_class
,
1499 const struct symbol_register_ops
*);
1501 /* Return the ARCH of SYMBOL. */
1503 extern struct gdbarch
*symbol_arch (const struct symbol
*symbol
);
1505 /* Return the SYMTAB of SYMBOL.
1506 It is an error to call this if symbol.is_objfile_owned is false, which
1507 only happens for architecture-provided types. */
1509 extern struct symtab
*symbol_symtab (const struct symbol
*symbol
);
1511 /* Set the symtab of SYMBOL to SYMTAB.
1512 It is an error to call this if symbol.is_objfile_owned is false, which
1513 only happens for architecture-provided types. */
1515 extern void symbol_set_symtab (struct symbol
*symbol
, struct symtab
*symtab
);
1517 /* An instance of this type is used to represent a C++ template
1518 function. A symbol is really of this type iff
1519 symbol::is_cplus_template_function is true. */
1521 struct template_symbol
: public symbol
1523 /* The number of template arguments. */
1524 int n_template_arguments
= 0;
1526 /* The template arguments. This is an array with
1527 N_TEMPLATE_ARGUMENTS elements. */
1528 struct symbol
**template_arguments
= nullptr;
1531 /* A symbol that represents a Rust virtual table object. */
1533 struct rust_vtable_symbol
: public symbol
1535 /* The concrete type for which this vtable was created; that is, in
1536 "impl Trait for Type", this is "Type". */
1537 struct type
*concrete_type
= nullptr;
1541 /* Each item represents a line-->pc (or the reverse) mapping. This is
1542 somewhat more wasteful of space than one might wish, but since only
1543 the files which are actually debugged are read in to core, we don't
1544 waste much space. */
1546 struct linetable_entry
1548 /* The line number for this entry. */
1551 /* True if this PC is a good location to place a breakpoint for LINE. */
1552 unsigned is_stmt
: 1;
1554 /* True if this location is a good location to place a breakpoint after a
1555 function prologue. */
1556 bool prologue_end
: 1;
1558 /* The address for this entry. */
1562 /* The order of entries in the linetable is significant. They should
1563 be sorted by increasing values of the pc field. If there is more than
1564 one entry for a given pc, then I'm not sure what should happen (and
1565 I not sure whether we currently handle it the best way).
1567 Example: a C for statement generally looks like this
1569 10 0x100 - for the init/test part of a for stmt.
1572 10 0x400 - for the increment part of a for stmt.
1574 If an entry has a line number of zero, it marks the start of a PC
1575 range for which no line number information is available. It is
1576 acceptable, though wasteful of table space, for such a range to be
1583 /* Actually NITEMS elements. If you don't like this use of the
1584 `struct hack', you can shove it up your ANSI (seriously, if the
1585 committee tells us how to do it, we can probably go along). */
1586 struct linetable_entry item
[1];
1589 /* How to relocate the symbols from each section in a symbol file.
1590 The ordering and meaning of the offsets is file-type-dependent;
1591 typically it is indexed by section numbers or symbol types or
1592 something like that. */
1594 typedef std::vector
<CORE_ADDR
> section_offsets
;
1596 /* Each source file or header is represented by a struct symtab.
1597 The name "symtab" is historical, another name for it is "filetab".
1598 These objects are chained through the `next' field. */
1602 struct compunit_symtab
*compunit () const
1607 void set_compunit (struct compunit_symtab
*compunit
)
1609 m_compunit
= compunit
;
1612 struct linetable
*linetable () const
1617 void set_linetable (struct linetable
*linetable
)
1619 m_linetable
= linetable
;
1622 enum language
language () const
1627 void set_language (enum language language
)
1629 m_language
= language
;
1632 /* Unordered chain of all filetabs in the compunit, with the exception
1633 that the "main" source file is the first entry in the list. */
1635 struct symtab
*next
;
1637 /* Backlink to containing compunit symtab. */
1639 struct compunit_symtab
*m_compunit
;
1641 /* Table mapping core addresses to line numbers for this file.
1642 Can be NULL if none. Never shared between different symtabs. */
1644 struct linetable
*m_linetable
;
1646 /* Name of this source file. This pointer is never NULL. */
1648 const char *filename
;
1650 /* Language of this source file. */
1652 enum language m_language
;
1654 /* Full name of file as found by searching the source path.
1655 NULL if not yet known. */
1660 /* A range adapter to allowing iterating over all the file tables in a list. */
1662 using symtab_range
= next_range
<symtab
>;
1664 /* Compunit symtabs contain the actual "symbol table", aka blockvector, as well
1665 as the list of all source files (what gdb has historically associated with
1667 Additional information is recorded here that is common to all symtabs in a
1668 compilation unit (DWARF or otherwise).
1671 For the case of a program built out of these files:
1680 This is recorded as:
1682 objfile -> foo.c(cu) -> bar.c(cu) -> NULL
1696 where "foo.c(cu)" and "bar.c(cu)" are struct compunit_symtab objects,
1697 and the files foo.c, etc. are struct symtab objects. */
1699 struct compunit_symtab
1701 struct objfile
*objfile () const
1706 void set_objfile (struct objfile
*objfile
)
1708 m_objfile
= objfile
;
1711 symtab_range
filetabs () const
1713 return symtab_range (m_filetabs
);
1716 void add_filetab (symtab
*filetab
)
1718 if (m_filetabs
== nullptr)
1720 m_filetabs
= filetab
;
1721 m_last_filetab
= filetab
;
1725 m_last_filetab
->next
= filetab
;
1726 m_last_filetab
= filetab
;
1730 const char *debugformat () const
1732 return m_debugformat
;
1735 void set_debugformat (const char *debugformat
)
1737 m_debugformat
= debugformat
;
1740 const char *producer () const
1745 void set_producer (const char *producer
)
1747 m_producer
= producer
;
1750 const char *dirname () const
1755 void set_dirname (const char *dirname
)
1757 m_dirname
= dirname
;
1760 const struct blockvector
*blockvector () const
1762 return m_blockvector
;
1765 void set_blockvector (const struct blockvector
*blockvector
)
1767 m_blockvector
= blockvector
;
1770 int block_line_section () const
1772 return m_block_line_section
;
1775 void set_block_line_section (int block_line_section
)
1777 m_block_line_section
= block_line_section
;
1780 bool locations_valid () const
1782 return m_locations_valid
;
1785 void set_locations_valid (bool locations_valid
)
1787 m_locations_valid
= locations_valid
;
1790 bool epilogue_unwind_valid () const
1792 return m_epilogue_unwind_valid
;
1795 void set_epilogue_unwind_valid (bool epilogue_unwind_valid
)
1797 m_epilogue_unwind_valid
= epilogue_unwind_valid
;
1800 struct macro_table
*macro_table () const
1802 return m_macro_table
;
1805 void set_macro_table (struct macro_table
*macro_table
)
1807 m_macro_table
= macro_table
;
1810 /* Make PRIMARY_FILETAB the primary filetab of this compunit symtab.
1812 PRIMARY_FILETAB must already be a filetab of this compunit symtab. */
1814 void set_primary_filetab (symtab
*primary_filetab
);
1816 /* Return the primary filetab of the compunit. */
1817 symtab
*primary_filetab () const;
1819 /* Set m_call_site_htab. */
1820 void set_call_site_htab (htab_t call_site_htab
);
1822 /* Find call_site info for PC. */
1823 call_site
*find_call_site (CORE_ADDR pc
) const;
1825 /* Unordered chain of all compunit symtabs of this objfile. */
1826 struct compunit_symtab
*next
;
1828 /* Object file from which this symtab information was read. */
1829 struct objfile
*m_objfile
;
1831 /* Name of the symtab.
1832 This is *not* intended to be a usable filename, and is
1833 for debugging purposes only. */
1836 /* Unordered list of file symtabs, except that by convention the "main"
1837 source file (e.g., .c, .cc) is guaranteed to be first.
1838 Each symtab is a file, either the "main" source file (e.g., .c, .cc)
1839 or header (e.g., .h). */
1842 /* Last entry in FILETABS list.
1843 Subfiles are added to the end of the list so they accumulate in order,
1844 with the main source subfile living at the front.
1845 The main reason is so that the main source file symtab is at the head
1846 of the list, and the rest appear in order for debugging convenience. */
1847 symtab
*m_last_filetab
;
1849 /* Non-NULL string that identifies the format of the debugging information,
1850 such as "stabs", "dwarf 1", "dwarf 2", "coff", etc. This is mostly useful
1851 for automated testing of gdb but may also be information that is
1852 useful to the user. */
1853 const char *m_debugformat
;
1855 /* String of producer version information, or NULL if we don't know. */
1856 const char *m_producer
;
1858 /* Directory in which it was compiled, or NULL if we don't know. */
1859 const char *m_dirname
;
1861 /* List of all symbol scope blocks for this symtab. It is shared among
1862 all symtabs in a given compilation unit. */
1863 const struct blockvector
*m_blockvector
;
1865 /* Section in objfile->section_offsets for the blockvector and
1866 the linetable. Probably always SECT_OFF_TEXT. */
1867 int m_block_line_section
;
1869 /* Symtab has been compiled with both optimizations and debug info so that
1870 GDB may stop skipping prologues as variables locations are valid already
1871 at function entry points. */
1872 unsigned int m_locations_valid
: 1;
1874 /* DWARF unwinder for this CU is valid even for epilogues (PC at the return
1875 instruction). This is supported by GCC since 4.5.0. */
1876 unsigned int m_epilogue_unwind_valid
: 1;
1878 /* struct call_site entries for this compilation unit or NULL. */
1879 htab_t m_call_site_htab
;
1881 /* The macro table for this symtab. Like the blockvector, this
1882 is shared between different symtabs in a given compilation unit.
1883 It's debatable whether it *should* be shared among all the symtabs in
1884 the given compilation unit, but it currently is. */
1885 struct macro_table
*m_macro_table
;
1887 /* If non-NULL, then this points to a NULL-terminated vector of
1888 included compunits. When searching the static or global
1889 block of this compunit, the corresponding block of all
1890 included compunits will also be searched. Note that this
1891 list must be flattened -- the symbol reader is responsible for
1892 ensuring that this vector contains the transitive closure of all
1893 included compunits. */
1894 struct compunit_symtab
**includes
;
1896 /* If this is an included compunit, this points to one includer
1897 of the table. This user is considered the canonical compunit
1898 containing this one. An included compunit may itself be
1899 included by another. */
1900 struct compunit_symtab
*user
;
1903 using compunit_symtab_range
= next_range
<compunit_symtab
>;
1905 /* Return the language of CUST. */
1907 extern enum language
compunit_language (const struct compunit_symtab
*cust
);
1909 /* Return true if this symtab is the "main" symtab of its compunit_symtab. */
1912 is_main_symtab_of_compunit_symtab (struct symtab
*symtab
)
1914 return symtab
== symtab
->compunit ()->primary_filetab ();
1918 /* The virtual function table is now an array of structures which have the
1919 form { int16 offset, delta; void *pfn; }.
1921 In normal virtual function tables, OFFSET is unused.
1922 DELTA is the amount which is added to the apparent object's base
1923 address in order to point to the actual object to which the
1924 virtual function should be applied.
1925 PFN is a pointer to the virtual function.
1927 Note that this macro is g++ specific (FIXME). */
1929 #define VTBL_FNADDR_OFFSET 2
1931 /* External variables and functions for the objects described above. */
1933 /* True if we are nested inside psymtab_to_symtab. */
1935 extern int currently_reading_symtab
;
1937 /* symtab.c lookup functions */
1939 extern const char multiple_symbols_ask
[];
1940 extern const char multiple_symbols_all
[];
1941 extern const char multiple_symbols_cancel
[];
1943 const char *multiple_symbols_select_mode (void);
1945 bool symbol_matches_domain (enum language symbol_language
,
1946 domain_enum symbol_domain
,
1947 domain_enum domain
);
1949 /* lookup a symbol table by source file name. */
1951 extern struct symtab
*lookup_symtab (const char *);
1953 /* An object of this type is passed as the 'is_a_field_of_this'
1954 argument to lookup_symbol and lookup_symbol_in_language. */
1956 struct field_of_this_result
1958 /* The type in which the field was found. If this is NULL then the
1959 symbol was not found in 'this'. If non-NULL, then one of the
1960 other fields will be non-NULL as well. */
1964 /* If the symbol was found as an ordinary field of 'this', then this
1965 is non-NULL and points to the particular field. */
1967 struct field
*field
;
1969 /* If the symbol was found as a function field of 'this', then this
1970 is non-NULL and points to the particular field. */
1972 struct fn_fieldlist
*fn_field
;
1975 /* Find the definition for a specified symbol name NAME
1976 in domain DOMAIN in language LANGUAGE, visible from lexical block BLOCK
1977 if non-NULL or from global/static blocks if BLOCK is NULL.
1978 Returns the struct symbol pointer, or NULL if no symbol is found.
1979 C++: if IS_A_FIELD_OF_THIS is non-NULL on entry, check to see if
1980 NAME is a field of the current implied argument `this'. If so fill in the
1981 fields of IS_A_FIELD_OF_THIS, otherwise the fields are set to NULL.
1982 The symbol's section is fixed up if necessary. */
1984 extern struct block_symbol
1985 lookup_symbol_in_language (const char *,
1986 const struct block
*,
1989 struct field_of_this_result
*);
1991 /* Same as lookup_symbol_in_language, but using the current language. */
1993 extern struct block_symbol
lookup_symbol (const char *,
1994 const struct block
*,
1996 struct field_of_this_result
*);
1998 /* Find the definition for a specified symbol search name in domain
1999 DOMAIN, visible from lexical block BLOCK if non-NULL or from
2000 global/static blocks if BLOCK is NULL. The passed-in search name
2001 should not come from the user; instead it should already be a
2002 search name as retrieved from a search_name () call. See definition of
2003 symbol_name_match_type::SEARCH_NAME. Returns the struct symbol
2004 pointer, or NULL if no symbol is found. The symbol's section is
2005 fixed up if necessary. */
2007 extern struct block_symbol
lookup_symbol_search_name (const char *search_name
,
2008 const struct block
*block
,
2009 domain_enum domain
);
2011 /* Some helper functions for languages that need to write their own
2012 lookup_symbol_nonlocal functions. */
2014 /* Lookup a symbol in the static block associated to BLOCK, if there
2015 is one; do nothing if BLOCK is NULL or a global block.
2016 Upon success fixes up the symbol's section if necessary. */
2018 extern struct block_symbol
2019 lookup_symbol_in_static_block (const char *name
,
2020 const struct block
*block
,
2021 const domain_enum domain
);
2023 /* Search all static file-level symbols for NAME from DOMAIN.
2024 Upon success fixes up the symbol's section if necessary. */
2026 extern struct block_symbol
lookup_static_symbol (const char *name
,
2027 const domain_enum domain
);
2029 /* Lookup a symbol in all files' global blocks.
2031 If BLOCK is non-NULL then it is used for two things:
2032 1) If a target-specific lookup routine for libraries exists, then use the
2033 routine for the objfile of BLOCK, and
2034 2) The objfile of BLOCK is used to assist in determining the search order
2035 if the target requires it.
2036 See gdbarch_iterate_over_objfiles_in_search_order.
2038 Upon success fixes up the symbol's section if necessary. */
2040 extern struct block_symbol
2041 lookup_global_symbol (const char *name
,
2042 const struct block
*block
,
2043 const domain_enum domain
);
2045 /* Lookup a symbol in block BLOCK.
2046 Upon success fixes up the symbol's section if necessary. */
2048 extern struct symbol
*
2049 lookup_symbol_in_block (const char *name
,
2050 symbol_name_match_type match_type
,
2051 const struct block
*block
,
2052 const domain_enum domain
);
2054 /* Look up the `this' symbol for LANG in BLOCK. Return the symbol if
2055 found, or NULL if not found. */
2057 extern struct block_symbol
2058 lookup_language_this (const struct language_defn
*lang
,
2059 const struct block
*block
);
2061 /* Lookup a [struct, union, enum] by name, within a specified block. */
2063 extern struct type
*lookup_struct (const char *, const struct block
*);
2065 extern struct type
*lookup_union (const char *, const struct block
*);
2067 extern struct type
*lookup_enum (const char *, const struct block
*);
2069 /* from blockframe.c: */
2071 /* lookup the function symbol corresponding to the address. The
2072 return value will not be an inlined function; the containing
2073 function will be returned instead. */
2075 extern struct symbol
*find_pc_function (CORE_ADDR
);
2077 /* lookup the function corresponding to the address and section. The
2078 return value will not be an inlined function; the containing
2079 function will be returned instead. */
2081 extern struct symbol
*find_pc_sect_function (CORE_ADDR
, struct obj_section
*);
2083 /* lookup the function symbol corresponding to the address and
2084 section. The return value will be the closest enclosing function,
2085 which might be an inline function. */
2087 extern struct symbol
*find_pc_sect_containing_function
2088 (CORE_ADDR pc
, struct obj_section
*section
);
2090 /* Find the symbol at the given address. Returns NULL if no symbol
2091 found. Only exact matches for ADDRESS are considered. */
2093 extern struct symbol
*find_symbol_at_address (CORE_ADDR
);
2095 /* Finds the "function" (text symbol) that is smaller than PC but
2096 greatest of all of the potential text symbols in SECTION. Sets
2097 *NAME and/or *ADDRESS conditionally if that pointer is non-null.
2098 If ENDADDR is non-null, then set *ENDADDR to be the end of the
2099 function (exclusive). If the optional parameter BLOCK is non-null,
2100 then set *BLOCK to the address of the block corresponding to the
2101 function symbol, if such a symbol could be found during the lookup;
2102 nullptr is used as a return value for *BLOCK if no block is found.
2103 This function either succeeds or fails (not halfway succeeds). If
2104 it succeeds, it sets *NAME, *ADDRESS, and *ENDADDR to real
2105 information and returns true. If it fails, it sets *NAME, *ADDRESS
2106 and *ENDADDR to zero and returns false.
2108 If the function in question occupies non-contiguous ranges,
2109 *ADDRESS and *ENDADDR are (subject to the conditions noted above) set
2110 to the start and end of the range in which PC is found. Thus
2111 *ADDRESS <= PC < *ENDADDR with no intervening gaps (in which ranges
2112 from other functions might be found).
2114 This property allows find_pc_partial_function to be used (as it had
2115 been prior to the introduction of non-contiguous range support) by
2116 various tdep files for finding a start address and limit address
2117 for prologue analysis. This still isn't ideal, however, because we
2118 probably shouldn't be doing prologue analysis (in which
2119 instructions are scanned to determine frame size and stack layout)
2120 for any range that doesn't contain the entry pc. Moreover, a good
2121 argument can be made that prologue analysis ought to be performed
2122 starting from the entry pc even when PC is within some other range.
2123 This might suggest that *ADDRESS and *ENDADDR ought to be set to the
2124 limits of the entry pc range, but that will cause the
2125 *ADDRESS <= PC < *ENDADDR condition to be violated; many of the
2126 callers of find_pc_partial_function expect this condition to hold.
2128 Callers which require the start and/or end addresses for the range
2129 containing the entry pc should instead call
2130 find_function_entry_range_from_pc. */
2132 extern bool find_pc_partial_function (CORE_ADDR pc
, const char **name
,
2133 CORE_ADDR
*address
, CORE_ADDR
*endaddr
,
2134 const struct block
**block
= nullptr);
2136 /* Like find_pc_partial_function, above, but returns the underlying
2137 general_symbol_info (rather than the name) as an out parameter. */
2139 extern bool find_pc_partial_function_sym
2140 (CORE_ADDR pc
, const general_symbol_info
**sym
,
2141 CORE_ADDR
*address
, CORE_ADDR
*endaddr
,
2142 const struct block
**block
= nullptr);
2144 /* Like find_pc_partial_function, above, but *ADDRESS and *ENDADDR are
2145 set to start and end addresses of the range containing the entry pc.
2147 Note that it is not necessarily the case that (for non-NULL ADDRESS
2148 and ENDADDR arguments) the *ADDRESS <= PC < *ENDADDR condition will
2151 See comment for find_pc_partial_function, above, for further
2154 extern bool find_function_entry_range_from_pc (CORE_ADDR pc
,
2157 CORE_ADDR
*endaddr
);
2159 /* Return the type of a function with its first instruction exactly at
2160 the PC address. Return NULL otherwise. */
2162 extern struct type
*find_function_type (CORE_ADDR pc
);
2164 /* See if we can figure out the function's actual type from the type
2165 that the resolver returns. RESOLVER_FUNADDR is the address of the
2168 extern struct type
*find_gnu_ifunc_target_type (CORE_ADDR resolver_funaddr
);
2170 /* Find the GNU ifunc minimal symbol that matches SYM. */
2171 extern bound_minimal_symbol
find_gnu_ifunc (const symbol
*sym
);
2173 extern void clear_pc_function_cache (void);
2175 /* Expand symtab containing PC, SECTION if not already expanded. */
2177 extern void expand_symtab_containing_pc (CORE_ADDR
, struct obj_section
*);
2179 /* lookup full symbol table by address. */
2181 extern struct compunit_symtab
*find_pc_compunit_symtab (CORE_ADDR
);
2183 /* lookup full symbol table by address and section. */
2185 extern struct compunit_symtab
*
2186 find_pc_sect_compunit_symtab (CORE_ADDR
, struct obj_section
*);
2188 extern bool find_pc_line_pc_range (CORE_ADDR
, CORE_ADDR
*, CORE_ADDR
*);
2190 extern void reread_symbols (int from_tty
);
2192 /* Look up a type named NAME in STRUCT_DOMAIN in the current language.
2193 The type returned must not be opaque -- i.e., must have at least one field
2196 extern struct type
*lookup_transparent_type (const char *);
2198 extern struct type
*basic_lookup_transparent_type (const char *);
2200 /* Macro for name of symbol to indicate a file compiled with gcc. */
2201 #ifndef GCC_COMPILED_FLAG_SYMBOL
2202 #define GCC_COMPILED_FLAG_SYMBOL "gcc_compiled."
2205 /* Macro for name of symbol to indicate a file compiled with gcc2. */
2206 #ifndef GCC2_COMPILED_FLAG_SYMBOL
2207 #define GCC2_COMPILED_FLAG_SYMBOL "gcc2_compiled."
2210 extern bool in_gnu_ifunc_stub (CORE_ADDR pc
);
2212 /* Functions for resolving STT_GNU_IFUNC symbols which are implemented only
2213 for ELF symbol files. */
2215 struct gnu_ifunc_fns
2217 /* See elf_gnu_ifunc_resolve_addr for its real implementation. */
2218 CORE_ADDR (*gnu_ifunc_resolve_addr
) (struct gdbarch
*gdbarch
, CORE_ADDR pc
);
2220 /* See elf_gnu_ifunc_resolve_name for its real implementation. */
2221 bool (*gnu_ifunc_resolve_name
) (const char *function_name
,
2222 CORE_ADDR
*function_address_p
);
2224 /* See elf_gnu_ifunc_resolver_stop for its real implementation. */
2225 void (*gnu_ifunc_resolver_stop
) (struct breakpoint
*b
);
2227 /* See elf_gnu_ifunc_resolver_return_stop for its real implementation. */
2228 void (*gnu_ifunc_resolver_return_stop
) (struct breakpoint
*b
);
2231 #define gnu_ifunc_resolve_addr gnu_ifunc_fns_p->gnu_ifunc_resolve_addr
2232 #define gnu_ifunc_resolve_name gnu_ifunc_fns_p->gnu_ifunc_resolve_name
2233 #define gnu_ifunc_resolver_stop gnu_ifunc_fns_p->gnu_ifunc_resolver_stop
2234 #define gnu_ifunc_resolver_return_stop \
2235 gnu_ifunc_fns_p->gnu_ifunc_resolver_return_stop
2237 extern const struct gnu_ifunc_fns
*gnu_ifunc_fns_p
;
2239 extern CORE_ADDR
find_solib_trampoline_target (struct frame_info
*, CORE_ADDR
);
2241 struct symtab_and_line
2243 /* The program space of this sal. */
2244 struct program_space
*pspace
= NULL
;
2246 struct symtab
*symtab
= NULL
;
2247 struct symbol
*symbol
= NULL
;
2248 struct obj_section
*section
= NULL
;
2249 struct minimal_symbol
*msymbol
= NULL
;
2250 /* Line number. Line numbers start at 1 and proceed through symtab->nlines.
2251 0 is never a valid line number; it is used to indicate that line number
2252 information is not available. */
2257 bool explicit_pc
= false;
2258 bool explicit_line
= false;
2260 /* If the line number information is valid, then this indicates if this
2261 line table entry had the is-stmt flag set or not. */
2262 bool is_stmt
= false;
2264 /* The probe associated with this symtab_and_line. */
2266 /* If PROBE is not NULL, then this is the objfile in which the probe
2268 struct objfile
*objfile
= NULL
;
2273 /* Given a pc value, return line number it is in. Second arg nonzero means
2274 if pc is on the boundary use the previous statement's line number. */
2276 extern struct symtab_and_line
find_pc_line (CORE_ADDR
, int);
2278 /* Same function, but specify a section as well as an address. */
2280 extern struct symtab_and_line
find_pc_sect_line (CORE_ADDR
,
2281 struct obj_section
*, int);
2283 /* Wrapper around find_pc_line to just return the symtab. */
2285 extern struct symtab
*find_pc_line_symtab (CORE_ADDR
);
2287 /* Given a symtab and line number, return the pc there. */
2289 extern bool find_line_pc (struct symtab
*, int, CORE_ADDR
*);
2291 extern bool find_line_pc_range (struct symtab_and_line
, CORE_ADDR
*,
2294 extern void resolve_sal_pc (struct symtab_and_line
*);
2298 extern void clear_solib (void);
2300 /* The reason we're calling into a completion match list collector
2302 enum class complete_symbol_mode
2304 /* Completing an expression. */
2307 /* Completing a linespec. */
2311 extern void default_collect_symbol_completion_matches_break_on
2312 (completion_tracker
&tracker
,
2313 complete_symbol_mode mode
,
2314 symbol_name_match_type name_match_type
,
2315 const char *text
, const char *word
, const char *break_on
,
2316 enum type_code code
);
2317 extern void collect_symbol_completion_matches
2318 (completion_tracker
&tracker
,
2319 complete_symbol_mode mode
,
2320 symbol_name_match_type name_match_type
,
2321 const char *, const char *);
2322 extern void collect_symbol_completion_matches_type (completion_tracker
&tracker
,
2323 const char *, const char *,
2326 extern void collect_file_symbol_completion_matches
2327 (completion_tracker
&tracker
,
2328 complete_symbol_mode
,
2329 symbol_name_match_type name_match_type
,
2330 const char *, const char *, const char *);
2332 extern completion_list
2333 make_source_files_completion_list (const char *, const char *);
2335 /* Return whether SYM is a function/method, as opposed to a data symbol. */
2337 extern bool symbol_is_function_or_method (symbol
*sym
);
2339 /* Return whether MSYMBOL is a function/method, as opposed to a data
2342 extern bool symbol_is_function_or_method (minimal_symbol
*msymbol
);
2344 /* Return whether SYM should be skipped in completion mode MODE. In
2345 linespec mode, we're only interested in functions/methods. */
2347 template<typename Symbol
>
2349 completion_skip_symbol (complete_symbol_mode mode
, Symbol
*sym
)
2351 return (mode
== complete_symbol_mode::LINESPEC
2352 && !symbol_is_function_or_method (sym
));
2357 bool matching_obj_sections (struct obj_section
*, struct obj_section
*);
2359 extern struct symtab
*find_line_symtab (struct symtab
*, int, int *, bool *);
2361 /* Given a function symbol SYM, find the symtab and line for the start
2362 of the function. If FUNFIRSTLINE is true, we want the first line
2363 of real code inside the function. */
2364 extern symtab_and_line
find_function_start_sal (symbol
*sym
, bool
2367 /* Same, but start with a function address/section instead of a
2369 extern symtab_and_line
find_function_start_sal (CORE_ADDR func_addr
,
2370 obj_section
*section
,
2373 extern void skip_prologue_sal (struct symtab_and_line
*);
2377 extern CORE_ADDR
skip_prologue_using_sal (struct gdbarch
*gdbarch
,
2378 CORE_ADDR func_addr
);
2380 extern struct symbol
*fixup_symbol_section (struct symbol
*,
2383 /* If MSYMBOL is an text symbol, look for a function debug symbol with
2384 the same address. Returns NULL if not found. This is necessary in
2385 case a function is an alias to some other function, because debug
2386 information is only emitted for the alias target function's
2387 definition, not for the alias. */
2388 extern symbol
*find_function_alias_target (bound_minimal_symbol msymbol
);
2390 /* Symbol searching */
2392 /* When using the symbol_searcher struct to search for symbols, a vector of
2393 the following structs is returned. */
2394 struct symbol_search
2396 symbol_search (int block_
, struct symbol
*symbol_
)
2400 msymbol
.minsym
= nullptr;
2401 msymbol
.objfile
= nullptr;
2404 symbol_search (int block_
, struct minimal_symbol
*minsym
,
2405 struct objfile
*objfile
)
2409 msymbol
.minsym
= minsym
;
2410 msymbol
.objfile
= objfile
;
2413 bool operator< (const symbol_search
&other
) const
2415 return compare_search_syms (*this, other
) < 0;
2418 bool operator== (const symbol_search
&other
) const
2420 return compare_search_syms (*this, other
) == 0;
2423 /* The block in which the match was found. Could be, for example,
2424 STATIC_BLOCK or GLOBAL_BLOCK. */
2427 /* Information describing what was found.
2429 If symbol is NOT NULL, then information was found for this match. */
2430 struct symbol
*symbol
;
2432 /* If msymbol is non-null, then a match was made on something for
2433 which only minimal_symbols exist. */
2434 struct bound_minimal_symbol msymbol
;
2438 static int compare_search_syms (const symbol_search
&sym_a
,
2439 const symbol_search
&sym_b
);
2442 /* In order to search for global symbols of a particular kind matching
2443 particular regular expressions, create an instance of this structure and
2444 call the SEARCH member function. */
2445 class global_symbol_searcher
2450 global_symbol_searcher (enum search_domain kind
,
2451 const char *symbol_name_regexp
)
2453 m_symbol_name_regexp (symbol_name_regexp
)
2455 /* The symbol searching is designed to only find one kind of thing. */
2456 gdb_assert (m_kind
!= ALL_DOMAIN
);
2459 /* Set the optional regexp that matches against the symbol type. */
2460 void set_symbol_type_regexp (const char *regexp
)
2462 m_symbol_type_regexp
= regexp
;
2465 /* Set the flag to exclude minsyms from the search results. */
2466 void set_exclude_minsyms (bool exclude_minsyms
)
2468 m_exclude_minsyms
= exclude_minsyms
;
2471 /* Set the maximum number of search results to be returned. */
2472 void set_max_search_results (size_t max_search_results
)
2474 m_max_search_results
= max_search_results
;
2477 /* Search the symbols from all objfiles in the current program space
2478 looking for matches as defined by the current state of this object.
2480 Within each file the results are sorted locally; each symtab's global
2481 and static blocks are separately alphabetized. Duplicate entries are
2483 std::vector
<symbol_search
> search () const;
2485 /* The set of source files to search in for matching symbols. This is
2486 currently public so that it can be populated after this object has
2487 been constructed. */
2488 std::vector
<const char *> filenames
;
2491 /* The kind of symbols are we searching for.
2492 VARIABLES_DOMAIN - Search all symbols, excluding functions, type
2493 names, and constants (enums).
2494 FUNCTIONS_DOMAIN - Search all functions..
2495 TYPES_DOMAIN - Search all type names.
2496 MODULES_DOMAIN - Search all Fortran modules.
2497 ALL_DOMAIN - Not valid for this function. */
2498 enum search_domain m_kind
;
2500 /* Regular expression to match against the symbol name. */
2501 const char *m_symbol_name_regexp
= nullptr;
2503 /* Regular expression to match against the symbol type. */
2504 const char *m_symbol_type_regexp
= nullptr;
2506 /* When this flag is false then minsyms that match M_SYMBOL_REGEXP will
2507 be included in the results, otherwise they are excluded. */
2508 bool m_exclude_minsyms
= false;
2510 /* Maximum number of search results. We currently impose a hard limit
2511 of SIZE_MAX, there is no "unlimited". */
2512 size_t m_max_search_results
= SIZE_MAX
;
2514 /* Expand symtabs in OBJFILE that match PREG, are of type M_KIND. Return
2515 true if any msymbols were seen that we should later consider adding to
2516 the results list. */
2517 bool expand_symtabs (objfile
*objfile
,
2518 const gdb::optional
<compiled_regex
> &preg
) const;
2520 /* Add symbols from symtabs in OBJFILE that match PREG, and TREG, and are
2521 of type M_KIND, to the results set RESULTS_SET. Return false if we
2522 stop adding results early due to having already found too many results
2523 (based on M_MAX_SEARCH_RESULTS limit), otherwise return true.
2524 Returning true does not indicate that any results were added, just
2525 that we didn't _not_ add a result due to reaching MAX_SEARCH_RESULTS. */
2526 bool add_matching_symbols (objfile
*objfile
,
2527 const gdb::optional
<compiled_regex
> &preg
,
2528 const gdb::optional
<compiled_regex
> &treg
,
2529 std::set
<symbol_search
> *result_set
) const;
2531 /* Add msymbols from OBJFILE that match PREG and M_KIND, to the results
2532 vector RESULTS. Return false if we stop adding results early due to
2533 having already found too many results (based on max search results
2534 limit M_MAX_SEARCH_RESULTS), otherwise return true. Returning true
2535 does not indicate that any results were added, just that we didn't
2536 _not_ add a result due to reaching MAX_SEARCH_RESULTS. */
2537 bool add_matching_msymbols (objfile
*objfile
,
2538 const gdb::optional
<compiled_regex
> &preg
,
2539 std::vector
<symbol_search
> *results
) const;
2541 /* Return true if MSYMBOL is of type KIND. */
2542 static bool is_suitable_msymbol (const enum search_domain kind
,
2543 const minimal_symbol
*msymbol
);
2546 /* When searching for Fortran symbols within modules (functions/variables)
2547 we return a vector of this type. The first item in the pair is the
2548 module symbol, and the second item is the symbol for the function or
2549 variable we found. */
2550 typedef std::pair
<symbol_search
, symbol_search
> module_symbol_search
;
2552 /* Searches the symbols to find function and variables symbols (depending
2553 on KIND) within Fortran modules. The MODULE_REGEXP matches against the
2554 name of the module, REGEXP matches against the name of the symbol within
2555 the module, and TYPE_REGEXP matches against the type of the symbol
2556 within the module. */
2557 extern std::vector
<module_symbol_search
> search_module_symbols
2558 (const char *module_regexp
, const char *regexp
,
2559 const char *type_regexp
, search_domain kind
);
2561 /* Convert a global or static symbol SYM (based on BLOCK, which should be
2562 either GLOBAL_BLOCK or STATIC_BLOCK) into a string for use in 'info'
2563 type commands (e.g. 'info variables', 'info functions', etc). KIND is
2564 the type of symbol that was searched for which gave us SYM. */
2566 extern std::string
symbol_to_info_string (struct symbol
*sym
, int block
,
2567 enum search_domain kind
);
2569 extern bool treg_matches_sym_type_name (const compiled_regex
&treg
,
2570 const struct symbol
*sym
);
2572 /* The name of the ``main'' function. */
2573 extern const char *main_name ();
2574 extern enum language
main_language (void);
2576 /* Lookup symbol NAME from DOMAIN in MAIN_OBJFILE's global or static blocks,
2577 as specified by BLOCK_INDEX.
2578 This searches MAIN_OBJFILE as well as any associated separate debug info
2579 objfiles of MAIN_OBJFILE.
2580 BLOCK_INDEX can be GLOBAL_BLOCK or STATIC_BLOCK.
2581 Upon success fixes up the symbol's section if necessary. */
2583 extern struct block_symbol
2584 lookup_global_symbol_from_objfile (struct objfile
*main_objfile
,
2585 enum block_enum block_index
,
2587 const domain_enum domain
);
2589 /* Return 1 if the supplied producer string matches the ARM RealView
2590 compiler (armcc). */
2591 bool producer_is_realview (const char *producer
);
2593 void fixup_section (struct general_symbol_info
*ginfo
,
2594 CORE_ADDR addr
, struct objfile
*objfile
);
2596 extern unsigned int symtab_create_debug
;
2598 extern unsigned int symbol_lookup_debug
;
2600 extern bool basenames_may_differ
;
2602 bool compare_filenames_for_search (const char *filename
,
2603 const char *search_name
);
2605 bool compare_glob_filenames_for_search (const char *filename
,
2606 const char *search_name
);
2608 bool iterate_over_some_symtabs (const char *name
,
2609 const char *real_path
,
2610 struct compunit_symtab
*first
,
2611 struct compunit_symtab
*after_last
,
2612 gdb::function_view
<bool (symtab
*)> callback
);
2614 void iterate_over_symtabs (const char *name
,
2615 gdb::function_view
<bool (symtab
*)> callback
);
2618 std::vector
<CORE_ADDR
> find_pcs_for_symtab_line
2619 (struct symtab
*symtab
, int line
, struct linetable_entry
**best_entry
);
2621 /* Prototype for callbacks for LA_ITERATE_OVER_SYMBOLS. The callback
2622 is called once per matching symbol SYM. The callback should return
2623 true to indicate that LA_ITERATE_OVER_SYMBOLS should continue
2624 iterating, or false to indicate that the iteration should end. */
2626 typedef bool (symbol_found_callback_ftype
) (struct block_symbol
*bsym
);
2628 /* Iterate over the symbols named NAME, matching DOMAIN, in BLOCK.
2630 For each symbol that matches, CALLBACK is called. The symbol is
2631 passed to the callback.
2633 If CALLBACK returns false, the iteration ends and this function
2634 returns false. Otherwise, the search continues, and the function
2635 eventually returns true. */
2637 bool iterate_over_symbols (const struct block
*block
,
2638 const lookup_name_info
&name
,
2639 const domain_enum domain
,
2640 gdb::function_view
<symbol_found_callback_ftype
> callback
);
2642 /* Like iterate_over_symbols, but if all calls to CALLBACK return
2643 true, then calls CALLBACK one additional time with a block_symbol
2644 that has a valid block but a NULL symbol. */
2646 bool iterate_over_symbols_terminated
2647 (const struct block
*block
,
2648 const lookup_name_info
&name
,
2649 const domain_enum domain
,
2650 gdb::function_view
<symbol_found_callback_ftype
> callback
);
2652 /* Storage type used by demangle_for_lookup. demangle_for_lookup
2653 either returns a const char * pointer that points to either of the
2654 fields of this type, or a pointer to the input NAME. This is done
2655 this way to avoid depending on the precise details of the storage
2657 class demangle_result_storage
2661 /* Swap the malloc storage to STR, and return a pointer to the
2662 beginning of the new string. */
2663 const char *set_malloc_ptr (gdb::unique_xmalloc_ptr
<char> &&str
)
2665 m_malloc
= std::move (str
);
2666 return m_malloc
.get ();
2669 /* Set the malloc storage to now point at PTR. Any previous malloc
2670 storage is released. */
2671 const char *set_malloc_ptr (char *ptr
)
2673 m_malloc
.reset (ptr
);
2680 gdb::unique_xmalloc_ptr
<char> m_malloc
;
2684 demangle_for_lookup (const char *name
, enum language lang
,
2685 demangle_result_storage
&storage
);
2687 /* Test to see if the symbol of language SYMBOL_LANGUAGE specified by
2688 SYMNAME (which is already demangled for C++ symbols) matches
2689 SYM_TEXT in the first SYM_TEXT_LEN characters. If so, add it to
2690 the current completion list and return true. Otherwise, return
2692 bool completion_list_add_name (completion_tracker
&tracker
,
2693 language symbol_language
,
2694 const char *symname
,
2695 const lookup_name_info
&lookup_name
,
2696 const char *text
, const char *word
);
2698 /* A simple symbol searching class. */
2700 class symbol_searcher
2703 /* Returns the symbols found for the search. */
2704 const std::vector
<block_symbol
> &
2705 matching_symbols () const
2710 /* Returns the minimal symbols found for the search. */
2711 const std::vector
<bound_minimal_symbol
> &
2712 matching_msymbols () const
2714 return m_minimal_symbols
;
2717 /* Search for all symbols named NAME in LANGUAGE with DOMAIN, restricting
2718 search to FILE_SYMTABS and SEARCH_PSPACE, both of which may be NULL
2719 to search all symtabs and program spaces. */
2720 void find_all_symbols (const std::string
&name
,
2721 const struct language_defn
*language
,
2722 enum search_domain search_domain
,
2723 std::vector
<symtab
*> *search_symtabs
,
2724 struct program_space
*search_pspace
);
2726 /* Reset this object to perform another search. */
2730 m_minimal_symbols
.clear ();
2734 /* Matching debug symbols. */
2735 std::vector
<block_symbol
> m_symbols
;
2737 /* Matching non-debug symbols. */
2738 std::vector
<bound_minimal_symbol
> m_minimal_symbols
;
2741 /* Class used to encapsulate the filename filtering for the "info sources"
2744 struct info_sources_filter
2746 /* If filename filtering is being used (see M_C_REGEXP) then which part
2747 of the filename is being filtered against? */
2750 /* Match against the full filename. */
2753 /* Match only against the directory part of the full filename. */
2756 /* Match only against the basename part of the full filename. */
2760 /* Create a filter of MATCH_TYPE using regular expression REGEXP. If
2761 REGEXP is nullptr then all files will match the filter and MATCH_TYPE
2764 The string pointed too by REGEXP must remain live and unchanged for
2765 this lifetime of this object as the object only retains a copy of the
2767 info_sources_filter (match_on match_type
, const char *regexp
);
2769 DISABLE_COPY_AND_ASSIGN (info_sources_filter
);
2771 /* Does FULLNAME match the filter defined by this object, return true if
2772 it does, otherwise, return false. If there is no filtering defined
2773 then this function will always return true. */
2774 bool matches (const char *fullname
) const;
2778 /* The type of filtering in place. */
2779 match_on m_match_type
;
2781 /* Points to the original regexp used to create this filter. */
2782 const char *m_regexp
;
2784 /* A compiled version of M_REGEXP. This object is only given a value if
2785 M_REGEXP is not nullptr and is not the empty string. */
2786 gdb::optional
<compiled_regex
> m_c_regexp
;
2789 /* Perform the core of the 'info sources' command.
2791 FILTER is used to perform regular expression based filtering on the
2792 source files that will be displayed.
2794 Output is written to UIOUT in CLI or MI style as appropriate. */
2796 extern void info_sources_worker (struct ui_out
*uiout
,
2797 bool group_by_objfile
,
2798 const info_sources_filter
&filter
);
2800 #endif /* !defined(SYMTAB_H) */