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_obstack.h"
29 #include "gdb_regex.h"
30 #include "gdbsupport/enum-flags.h"
31 #include "gdbsupport/function-view.h"
32 #include "gdbsupport/gdb_optional.h"
33 #include "gdbsupport/gdb_string_view.h"
34 #include "gdbsupport/next-iterator.h"
35 #include "completer.h"
36 #include "gdb-demangle.h"
38 /* Opaque declarations. */
52 struct cmd_list_element
;
54 struct lookup_name_info
;
56 /* How to match a lookup name against a symbol search name. */
57 enum class symbol_name_match_type
59 /* Wild matching. Matches unqualified symbol names in all
60 namespace/module/packages, etc. */
63 /* Full matching. The lookup name indicates a fully-qualified name,
64 and only matches symbol search names in the specified
65 namespace/module/package. */
68 /* Search name matching. This is like FULL, but the search name did
69 not come from the user; instead it is already a search name
70 retrieved from a search_name () call.
71 For Ada, this avoids re-encoding an already-encoded search name
72 (which would potentially incorrectly lowercase letters in the
73 linkage/search name that should remain uppercase). For C++, it
74 avoids trying to demangle a name we already know is
78 /* Expression matching. The same as FULL matching in most
79 languages. The same as WILD matching in Ada. */
83 /* Hash the given symbol search name according to LANGUAGE's
85 extern unsigned int search_name_hash (enum language language
,
86 const char *search_name
);
88 /* Ada-specific bits of a lookup_name_info object. This is lazily
89 constructed on demand. */
91 class ada_lookup_name_info final
95 explicit ada_lookup_name_info (const lookup_name_info
&lookup_name
);
97 /* Compare SYMBOL_SEARCH_NAME with our lookup name, using MATCH_TYPE
98 as name match type. Returns true if there's a match, false
99 otherwise. If non-NULL, store the matching results in MATCH. */
100 bool matches (const char *symbol_search_name
,
101 symbol_name_match_type match_type
,
102 completion_match_result
*comp_match_res
) const;
104 /* The Ada-encoded lookup name. */
105 const std::string
&lookup_name () const
106 { return m_encoded_name
; }
108 /* Return true if we're supposed to be doing a wild match look
110 bool wild_match_p () const
111 { return m_wild_match_p
; }
113 /* Return true if we're looking up a name inside package
115 bool standard_p () const
116 { return m_standard_p
; }
118 /* Return true if doing a verbatim match. */
119 bool verbatim_p () const
120 { return m_verbatim_p
; }
123 /* The Ada-encoded lookup name. */
124 std::string m_encoded_name
;
126 /* Whether the user-provided lookup name was Ada encoded. If so,
127 then return encoded names in the 'matches' method's 'completion
128 match result' output. */
129 bool m_encoded_p
: 1;
131 /* True if really doing wild matching. Even if the user requests
132 wild matching, some cases require full matching. */
133 bool m_wild_match_p
: 1;
135 /* True if doing a verbatim match. This is true if the decoded
136 version of the symbol name is wrapped in '<'/'>'. This is an
137 escape hatch users can use to look up symbols the Ada encoding
138 does not understand. */
139 bool m_verbatim_p
: 1;
141 /* True if the user specified a symbol name that is inside package
142 Standard. Symbol names inside package Standard are handled
143 specially. We always do a non-wild match of the symbol name
144 without the "standard__" prefix, and only search static and
145 global symbols. This was primarily introduced in order to allow
146 the user to specifically access the standard exceptions using,
147 for instance, Standard.Constraint_Error when Constraint_Error is
148 ambiguous (due to the user defining its own Constraint_Error
149 entity inside its program). */
150 bool m_standard_p
: 1;
153 /* Language-specific bits of a lookup_name_info object, for languages
154 that do name searching using demangled names (C++/D/Go). This is
155 lazily constructed on demand. */
157 struct demangle_for_lookup_info final
160 demangle_for_lookup_info (const lookup_name_info
&lookup_name
,
163 /* The demangled lookup name. */
164 const std::string
&lookup_name () const
165 { return m_demangled_name
; }
168 /* The demangled lookup name. */
169 std::string m_demangled_name
;
172 /* Object that aggregates all information related to a symbol lookup
173 name. I.e., the name that is matched against the symbol's search
174 name. Caches per-language information so that it doesn't require
175 recomputing it for every symbol comparison, like for example the
176 Ada encoded name and the symbol's name hash for a given language.
177 The object is conceptually immutable once constructed, and thus has
178 no setters. This is to prevent some code path from tweaking some
179 property of the lookup name for some local reason and accidentally
180 altering the results of any continuing search(es).
181 lookup_name_info objects are generally passed around as a const
182 reference to reinforce that. (They're not passed around by value
183 because they're not small.) */
184 class lookup_name_info final
187 /* Create a new object. */
188 lookup_name_info (std::string name
,
189 symbol_name_match_type match_type
,
190 bool completion_mode
= false,
191 bool ignore_parameters
= false)
192 : m_match_type (match_type
),
193 m_completion_mode (completion_mode
),
194 m_ignore_parameters (ignore_parameters
),
195 m_name (std::move (name
))
198 /* Getters. See description of each corresponding field. */
199 symbol_name_match_type
match_type () const { return m_match_type
; }
200 bool completion_mode () const { return m_completion_mode
; }
201 const std::string
&name () const { return m_name
; }
202 const bool ignore_parameters () const { return m_ignore_parameters
; }
204 /* Return a version of this lookup name that is usable with
205 comparisons against symbols have no parameter info, such as
206 psymbols and GDB index symbols. */
207 lookup_name_info
make_ignore_params () const
209 return lookup_name_info (m_name
, m_match_type
, m_completion_mode
,
210 true /* ignore params */);
213 /* Get the search name hash for searches in language LANG. */
214 unsigned int search_name_hash (language lang
) const
216 /* Only compute each language's hash once. */
217 if (!m_demangled_hashes_p
[lang
])
219 m_demangled_hashes
[lang
]
220 = ::search_name_hash (lang
, language_lookup_name (lang
).c_str ());
221 m_demangled_hashes_p
[lang
] = true;
223 return m_demangled_hashes
[lang
];
226 /* Get the search name for searches in language LANG. */
227 const std::string
&language_lookup_name (language lang
) const
232 return ada ().lookup_name ();
234 return cplus ().lookup_name ();
236 return d ().lookup_name ();
238 return go ().lookup_name ();
244 /* Get the Ada-specific lookup info. */
245 const ada_lookup_name_info
&ada () const
251 /* Get the C++-specific lookup info. */
252 const demangle_for_lookup_info
&cplus () const
254 maybe_init (m_cplus
, language_cplus
);
258 /* Get the D-specific lookup info. */
259 const demangle_for_lookup_info
&d () const
261 maybe_init (m_d
, language_d
);
265 /* Get the Go-specific lookup info. */
266 const demangle_for_lookup_info
&go () const
268 maybe_init (m_go
, language_go
);
272 /* Get a reference to a lookup_name_info object that matches any
274 static const lookup_name_info
&match_any ();
277 /* Initialize FIELD, if not initialized yet. */
278 template<typename Field
, typename
... Args
>
279 void maybe_init (Field
&field
, Args
&&... args
) const
282 field
.emplace (*this, std::forward
<Args
> (args
)...);
285 /* The lookup info as passed to the ctor. */
286 symbol_name_match_type m_match_type
;
287 bool m_completion_mode
;
288 bool m_ignore_parameters
;
291 /* Language-specific info. These fields are filled lazily the first
292 time a lookup is done in the corresponding language. They're
293 mutable because lookup_name_info objects are typically passed
294 around by const reference (see intro), and they're conceptually
295 "cache" that can always be reconstructed from the non-mutable
297 mutable gdb::optional
<ada_lookup_name_info
> m_ada
;
298 mutable gdb::optional
<demangle_for_lookup_info
> m_cplus
;
299 mutable gdb::optional
<demangle_for_lookup_info
> m_d
;
300 mutable gdb::optional
<demangle_for_lookup_info
> m_go
;
302 /* The demangled hashes. Stored in an array with one entry for each
303 possible language. The second array records whether we've
304 already computed the each language's hash. (These are separate
305 arrays instead of a single array of optional<unsigned> to avoid
306 alignment padding). */
307 mutable std::array
<unsigned int, nr_languages
> m_demangled_hashes
;
308 mutable std::array
<bool, nr_languages
> m_demangled_hashes_p
{};
311 /* Comparison function for completion symbol lookup.
313 Returns true if the symbol name matches against LOOKUP_NAME.
315 SYMBOL_SEARCH_NAME should be a symbol's "search" name.
317 On success and if non-NULL, COMP_MATCH_RES->match is set to point
318 to the symbol name as should be presented to the user as a
319 completion match list element. In most languages, this is the same
320 as the symbol's search name, but in some, like Ada, the display
321 name is dynamically computed within the comparison routine.
323 Also, on success and if non-NULL, COMP_MATCH_RES->match_for_lcd
324 points the part of SYMBOL_SEARCH_NAME that was considered to match
325 LOOKUP_NAME. E.g., in C++, in linespec/wild mode, if the symbol is
326 "foo::function()" and LOOKUP_NAME is "function(", MATCH_FOR_LCD
327 points to "function()" inside SYMBOL_SEARCH_NAME. */
328 typedef bool (symbol_name_matcher_ftype
)
329 (const char *symbol_search_name
,
330 const lookup_name_info
&lookup_name
,
331 completion_match_result
*comp_match_res
);
333 /* Some of the structures in this file are space critical.
334 The space-critical structures are:
336 struct general_symbol_info
338 struct partial_symbol
340 These structures are laid out to encourage good packing.
341 They use ENUM_BITFIELD and short int fields, and they order the
342 structure members so that fields less than a word are next
343 to each other so they can be packed together. */
345 /* Rearranged: used ENUM_BITFIELD and rearranged field order in
346 all the space critical structures (plus struct minimal_symbol).
347 Memory usage dropped from 99360768 bytes to 90001408 bytes.
348 I measured this with before-and-after tests of
349 "HEAD-old-gdb -readnow HEAD-old-gdb" and
350 "HEAD-new-gdb -readnow HEAD-old-gdb" on native i686-pc-linux-gnu,
351 red hat linux 8, with LD_LIBRARY_PATH=/usr/lib/debug,
352 typing "maint space 1" at the first command prompt.
354 Here is another measurement (from andrew c):
355 # no /usr/lib/debug, just plain glibc, like a normal user
357 (gdb) break internal_error
359 (gdb) maint internal-error
363 gdb gdb_6_0_branch 2003-08-19 space used: 8896512
364 gdb HEAD 2003-08-19 space used: 8904704
365 gdb HEAD 2003-08-21 space used: 8396800 (+symtab.h)
366 gdb HEAD 2003-08-21 space used: 8265728 (+gdbtypes.h)
368 The third line shows the savings from the optimizations in symtab.h.
369 The fourth line shows the savings from the optimizations in
370 gdbtypes.h. Both optimizations are in gdb HEAD now.
372 --chastain 2003-08-21 */
374 /* Define a structure for the information that is common to all symbol types,
375 including minimal symbols, partial symbols, and full symbols. In a
376 multilanguage environment, some language specific information may need to
377 be recorded along with each symbol. */
379 /* This structure is space critical. See space comments at the top. */
381 struct general_symbol_info
383 /* Short version as to when to use which name accessor:
384 Use natural_name () to refer to the name of the symbol in the original
385 source code. Use linkage_name () if you want to know what the linker
386 thinks the symbol's name is. Use print_name () for output. Use
387 demangled_name () if you specifically need to know whether natural_name ()
388 and linkage_name () are different. */
390 const char *linkage_name () const
393 /* Return SYMBOL's "natural" name, i.e. the name that it was called in
394 the original source code. In languages like C++ where symbols may
395 be mangled for ease of manipulation by the linker, this is the
397 const char *natural_name () const;
399 /* Returns a version of the name of a symbol that is
400 suitable for output. In C++ this is the "demangled" form of the
401 name if demangle is on and the "mangled" form of the name if
402 demangle is off. In other languages this is just the symbol name.
403 The result should never be NULL. Don't use this for internal
404 purposes (e.g. storing in a hashtable): it's only suitable for output. */
405 const char *print_name () const
406 { return demangle
? natural_name () : linkage_name (); }
408 /* Return the demangled name for a symbol based on the language for
409 that symbol. If no demangled name exists, return NULL. */
410 const char *demangled_name () const;
412 /* Returns the name to be used when sorting and searching symbols.
413 In C++, we search for the demangled form of a name,
414 and so sort symbols accordingly. In Ada, however, we search by mangled
415 name. If there is no distinct demangled name, then this
416 returns the same value (same pointer) as linkage_name (). */
417 const char *search_name () const;
419 /* Set just the linkage name of a symbol; do not try to demangle
420 it. Used for constructs which do not have a mangled name,
421 e.g. struct tags. Unlike SYMBOL_SET_NAMES, linkage_name must
422 be terminated and either already on the objfile's obstack or
423 permanently allocated. */
424 void set_linkage_name (const char *linkage_name
)
425 { name
= linkage_name
; }
427 /* Name of the symbol. This is a required field. Storage for the
428 name is allocated on the objfile_obstack for the associated
429 objfile. For languages like C++ that make a distinction between
430 the mangled name and demangled name, this is the mangled
435 /* Value of the symbol. Which member of this union to use, and what
436 it means, depends on what kind of symbol this is and its
437 SYMBOL_CLASS. See comments there for more details. All of these
438 are in host byte order (though what they point to might be in
439 target byte order, e.g. LOC_CONST_BYTES). */
445 const struct block
*block
;
447 const gdb_byte
*bytes
;
451 /* A common block. Used with LOC_COMMON_BLOCK. */
453 const struct common_block
*common_block
;
455 /* For opaque typedef struct chain. */
457 struct symbol
*chain
;
461 /* Since one and only one language can apply, wrap the language specific
462 information inside a union. */
466 /* A pointer to an obstack that can be used for storage associated
467 with this symbol. This is only used by Ada, and only when the
468 'ada_mangled' field is zero. */
469 struct obstack
*obstack
;
471 /* This is used by languages which wish to store a demangled name.
472 currently used by Ada, C++, and Objective C. */
473 const char *demangled_name
;
477 /* Record the source code language that applies to this symbol.
478 This is used to select one of the fields from the language specific
481 ENUM_BITFIELD(language
) language
: LANGUAGE_BITS
;
483 /* This is only used by Ada. If set, then the 'demangled_name' field
484 of language_specific is valid. Otherwise, the 'obstack' field is
486 unsigned int ada_mangled
: 1;
488 /* Which section is this symbol in? This is an index into
489 section_offsets for this objfile. Negative means that the symbol
490 does not get relocated relative to a section. */
495 extern void symbol_set_demangled_name (struct general_symbol_info
*,
499 extern const char *symbol_get_demangled_name
500 (const struct general_symbol_info
*);
502 extern CORE_ADDR
symbol_overlayed_address (CORE_ADDR
, struct obj_section
*);
504 /* Return the address of SYM. The MAYBE_COPIED flag must be set on
505 SYM. If SYM appears in the main program's minimal symbols, then
506 that minsym's address is returned; otherwise, SYM's address is
507 returned. This should generally only be used via the
508 SYMBOL_VALUE_ADDRESS macro. */
510 extern CORE_ADDR
get_symbol_address (const struct symbol
*sym
);
512 /* Note that these macros only work with symbol, not partial_symbol. */
514 #define SYMBOL_VALUE(symbol) (symbol)->value.ivalue
515 #define SYMBOL_VALUE_ADDRESS(symbol) \
516 (((symbol)->maybe_copied) ? get_symbol_address (symbol) \
517 : ((symbol)->value.address))
518 #define SET_SYMBOL_VALUE_ADDRESS(symbol, new_value) \
519 ((symbol)->value.address = (new_value))
520 #define SYMBOL_VALUE_BYTES(symbol) (symbol)->value.bytes
521 #define SYMBOL_VALUE_COMMON_BLOCK(symbol) (symbol)->value.common_block
522 #define SYMBOL_BLOCK_VALUE(symbol) (symbol)->value.block
523 #define SYMBOL_VALUE_CHAIN(symbol) (symbol)->value.chain
524 #define SYMBOL_LANGUAGE(symbol) (symbol)->language
525 #define SYMBOL_SECTION(symbol) (symbol)->section
526 #define SYMBOL_OBJ_SECTION(objfile, symbol) \
527 (((symbol)->section >= 0) \
528 ? (&(((objfile)->sections)[(symbol)->section])) \
531 /* Initializes the language dependent portion of a symbol
532 depending upon the language for the symbol. */
533 #define SYMBOL_SET_LANGUAGE(symbol,language,obstack) \
534 (symbol_set_language ((symbol), (language), (obstack)))
535 extern void symbol_set_language (struct general_symbol_info
*symbol
,
536 enum language language
,
537 struct obstack
*obstack
);
539 /* Try to determine the demangled name for a symbol, based on the
540 language of that symbol. If the language is set to language_auto,
541 it will attempt to find any demangling algorithm that works and
542 then set the language appropriately. The returned name is allocated
543 by the demangler and should be xfree'd. */
545 extern char *symbol_find_demangled_name (struct general_symbol_info
*gsymbol
,
546 const char *mangled
);
548 /* Set the linkage and natural names of a symbol, by demangling
549 the linkage name. If linkage_name may not be nullterminated,
550 copy_name must be set to true. */
551 #define SYMBOL_SET_NAMES(symbol,linkage_name,copy_name,objfile) \
552 symbol_set_names ((symbol), linkage_name, copy_name, \
554 extern void symbol_set_names (struct general_symbol_info
*symbol
,
555 gdb::string_view linkage_name
, bool copy_name
,
556 struct objfile_per_bfd_storage
*per_bfd
,
557 gdb::optional
<hashval_t
> hash
558 = gdb::optional
<hashval_t
> ());
560 /* Return true if NAME matches the "search" name of SYMBOL, according
561 to the symbol's language. */
562 #define SYMBOL_MATCHES_SEARCH_NAME(symbol, name) \
563 symbol_matches_search_name ((symbol), (name))
565 /* Helper for SYMBOL_MATCHES_SEARCH_NAME that works with both symbols
567 extern bool symbol_matches_search_name
568 (const struct general_symbol_info
*gsymbol
,
569 const lookup_name_info
&name
);
571 /* Compute the hash of the given symbol search name of a symbol of
572 language LANGUAGE. */
573 extern unsigned int search_name_hash (enum language language
,
574 const char *search_name
);
576 /* Classification types for a minimal symbol. These should be taken as
577 "advisory only", since if gdb can't easily figure out a
578 classification it simply selects mst_unknown. It may also have to
579 guess when it can't figure out which is a better match between two
580 types (mst_data versus mst_bss) for example. Since the minimal
581 symbol info is sometimes derived from the BFD library's view of a
582 file, we need to live with what information bfd supplies. */
584 enum minimal_symbol_type
586 mst_unknown
= 0, /* Unknown type, the default */
587 mst_text
, /* Generally executable instructions */
589 /* A GNU ifunc symbol, in the .text section. GDB uses to know
590 whether the user is setting a breakpoint on a GNU ifunc function,
591 and thus GDB needs to actually set the breakpoint on the target
592 function. It is also used to know whether the program stepped
593 into an ifunc resolver -- the resolver may get a separate
594 symbol/alias under a different name, but it'll have the same
595 address as the ifunc symbol. */
596 mst_text_gnu_ifunc
, /* Executable code returning address
597 of executable code */
599 /* A GNU ifunc function descriptor symbol, in a data section
600 (typically ".opd"). Seen on architectures that use function
601 descriptors, like PPC64/ELFv1. In this case, this symbol's value
602 is the address of the descriptor. There'll be a corresponding
603 mst_text_gnu_ifunc synthetic symbol for the text/entry
605 mst_data_gnu_ifunc
, /* Executable code returning address
606 of executable code */
608 mst_slot_got_plt
, /* GOT entries for .plt sections */
609 mst_data
, /* Generally initialized data */
610 mst_bss
, /* Generally uninitialized data */
611 mst_abs
, /* Generally absolute (nonrelocatable) */
612 /* GDB uses mst_solib_trampoline for the start address of a shared
613 library trampoline entry. Breakpoints for shared library functions
614 are put there if the shared library is not yet loaded.
615 After the shared library is loaded, lookup_minimal_symbol will
616 prefer the minimal symbol from the shared library (usually
617 a mst_text symbol) over the mst_solib_trampoline symbol, and the
618 breakpoints will be moved to their true address in the shared
619 library via breakpoint_re_set. */
620 mst_solib_trampoline
, /* Shared library trampoline code */
621 /* For the mst_file* types, the names are only guaranteed to be unique
622 within a given .o file. */
623 mst_file_text
, /* Static version of mst_text */
624 mst_file_data
, /* Static version of mst_data */
625 mst_file_bss
, /* Static version of mst_bss */
629 /* The number of enum minimal_symbol_type values, with some padding for
630 reasonable growth. */
631 #define MINSYM_TYPE_BITS 4
632 gdb_static_assert (nr_minsym_types
<= (1 << MINSYM_TYPE_BITS
));
634 /* Define a simple structure used to hold some very basic information about
635 all defined global symbols (text, data, bss, abs, etc). The only required
636 information is the general_symbol_info.
638 In many cases, even if a file was compiled with no special options for
639 debugging at all, as long as was not stripped it will contain sufficient
640 information to build a useful minimal symbol table using this structure.
641 Even when a file contains enough debugging information to build a full
642 symbol table, these minimal symbols are still useful for quickly mapping
643 between names and addresses, and vice versa. They are also sometimes
644 used to figure out what full symbol table entries need to be read in. */
646 struct minimal_symbol
: public general_symbol_info
648 /* Size of this symbol. dbx_end_psymtab in dbxread.c uses this
649 information to calculate the end of the partial symtab based on the
650 address of the last symbol plus the size of the last symbol. */
654 /* Which source file is this symbol in? Only relevant for mst_file_*. */
655 const char *filename
;
657 /* Classification type for this minimal symbol. */
659 ENUM_BITFIELD(minimal_symbol_type
) type
: MINSYM_TYPE_BITS
;
661 /* Non-zero if this symbol was created by gdb.
662 Such symbols do not appear in the output of "info var|fun". */
663 unsigned int created_by_gdb
: 1;
665 /* Two flag bits provided for the use of the target. */
666 unsigned int target_flag_1
: 1;
667 unsigned int target_flag_2
: 1;
669 /* Nonzero iff the size of the minimal symbol has been set.
670 Symbol size information can sometimes not be determined, because
671 the object file format may not carry that piece of information. */
672 unsigned int has_size
: 1;
674 /* For data symbols only, if this is set, then the symbol might be
675 subject to copy relocation. In this case, a minimal symbol
676 matching the symbol's linkage name is first looked for in the
677 main objfile. If found, then that address is used; otherwise the
678 address in this symbol is used. */
680 unsigned maybe_copied
: 1;
682 /* Non-zero if this symbol ever had its demangled name set (even if
683 it was set to NULL). */
684 unsigned int name_set
: 1;
686 /* Minimal symbols with the same hash key are kept on a linked
687 list. This is the link. */
689 struct minimal_symbol
*hash_next
;
691 /* Minimal symbols are stored in two different hash tables. This is
692 the `next' pointer for the demangled hash table. */
694 struct minimal_symbol
*demangled_hash_next
;
696 /* True if this symbol is of some data type. */
698 bool data_p () const;
700 /* True if MSYMBOL is of some text type. */
702 bool text_p () const;
705 /* Return the address of MINSYM, which comes from OBJF. The
706 MAYBE_COPIED flag must be set on MINSYM. If MINSYM appears in the
707 main program's minimal symbols, then that minsym's address is
708 returned; otherwise, MINSYM's address is returned. This should
709 generally only be used via the MSYMBOL_VALUE_ADDRESS macro. */
711 extern CORE_ADDR
get_msymbol_address (struct objfile
*objf
,
712 const struct minimal_symbol
*minsym
);
714 #define MSYMBOL_TARGET_FLAG_1(msymbol) (msymbol)->target_flag_1
715 #define MSYMBOL_TARGET_FLAG_2(msymbol) (msymbol)->target_flag_2
716 #define MSYMBOL_SIZE(msymbol) ((msymbol)->size + 0)
717 #define SET_MSYMBOL_SIZE(msymbol, sz) \
720 (msymbol)->size = sz; \
721 (msymbol)->has_size = 1; \
723 #define MSYMBOL_HAS_SIZE(msymbol) ((msymbol)->has_size + 0)
724 #define MSYMBOL_TYPE(msymbol) (msymbol)->type
726 #define MSYMBOL_VALUE(symbol) (symbol)->value.ivalue
727 /* The unrelocated address of the minimal symbol. */
728 #define MSYMBOL_VALUE_RAW_ADDRESS(symbol) ((symbol)->value.address + 0)
729 /* The relocated address of the minimal symbol, using the section
730 offsets from OBJFILE. */
731 #define MSYMBOL_VALUE_ADDRESS(objfile, symbol) \
732 (((symbol)->maybe_copied) ? get_msymbol_address (objfile, symbol) \
733 : ((symbol)->value.address \
734 + ANOFFSET ((objfile)->section_offsets, ((symbol)->section))))
735 /* For a bound minsym, we can easily compute the address directly. */
736 #define BMSYMBOL_VALUE_ADDRESS(symbol) \
737 MSYMBOL_VALUE_ADDRESS ((symbol).objfile, (symbol).minsym)
738 #define SET_MSYMBOL_VALUE_ADDRESS(symbol, new_value) \
739 ((symbol)->value.address = (new_value))
740 #define MSYMBOL_VALUE_BYTES(symbol) (symbol)->value.bytes
741 #define MSYMBOL_BLOCK_VALUE(symbol) (symbol)->value.block
742 #define MSYMBOL_VALUE_CHAIN(symbol) (symbol)->value.chain
743 #define MSYMBOL_LANGUAGE(symbol) (symbol)->language
744 #define MSYMBOL_SECTION(symbol) (symbol)->section
745 #define MSYMBOL_OBJ_SECTION(objfile, symbol) \
746 (((symbol)->section >= 0) \
747 ? (&(((objfile)->sections)[(symbol)->section])) \
754 /* Represent one symbol name; a variable, constant, function or typedef. */
756 /* Different name domains for symbols. Looking up a symbol specifies a
757 domain and ignores symbol definitions in other name domains. */
759 typedef enum domain_enum_tag
761 /* UNDEF_DOMAIN is used when a domain has not been discovered or
762 none of the following apply. This usually indicates an error either
763 in the symbol information or in gdb's handling of symbols. */
767 /* VAR_DOMAIN is the usual domain. In C, this contains variables,
768 function names, typedef names and enum type values. */
772 /* STRUCT_DOMAIN is used in C to hold struct, union and enum type names.
773 Thus, if `struct foo' is used in a C program, it produces a symbol named
774 `foo' in the STRUCT_DOMAIN. */
778 /* MODULE_DOMAIN is used in Fortran to hold module type names. */
782 /* LABEL_DOMAIN may be used for names of labels (for gotos). */
786 /* Fortran common blocks. Their naming must be separate from VAR_DOMAIN.
787 They also always use LOC_COMMON_BLOCK. */
790 /* This must remain last. */
794 /* The number of bits in a symbol used to represent the domain. */
796 #define SYMBOL_DOMAIN_BITS 3
797 gdb_static_assert (NR_DOMAINS
<= (1 << SYMBOL_DOMAIN_BITS
));
799 extern const char *domain_name (domain_enum
);
801 /* Searching domains, used when searching for symbols. Element numbers are
802 hardcoded in GDB, check all enum uses before changing it. */
806 /* Everything in VAR_DOMAIN minus FUNCTIONS_DOMAIN and
808 VARIABLES_DOMAIN
= 0,
810 /* All functions -- for some reason not methods, though. */
811 FUNCTIONS_DOMAIN
= 1,
813 /* All defined types */
823 extern const char *search_domain_name (enum search_domain
);
825 /* An address-class says where to find the value of a symbol. */
829 /* Not used; catches errors. */
833 /* Value is constant int SYMBOL_VALUE, host byteorder. */
837 /* Value is at fixed address SYMBOL_VALUE_ADDRESS. */
841 /* Value is in register. SYMBOL_VALUE is the register number
842 in the original debug format. SYMBOL_REGISTER_OPS holds a
843 function that can be called to transform this into the
844 actual register number this represents in a specific target
845 architecture (gdbarch).
847 For some symbol formats (stabs, for some compilers at least),
848 the compiler generates two symbols, an argument and a register.
849 In some cases we combine them to a single LOC_REGISTER in symbol
850 reading, but currently not for all cases (e.g. it's passed on the
851 stack and then loaded into a register). */
855 /* It's an argument; the value is at SYMBOL_VALUE offset in arglist. */
859 /* Value address is at SYMBOL_VALUE offset in arglist. */
863 /* Value is in specified register. Just like LOC_REGISTER except the
864 register holds the address of the argument instead of the argument
865 itself. This is currently used for the passing of structs and unions
866 on sparc and hppa. It is also used for call by reference where the
867 address is in a register, at least by mipsread.c. */
871 /* Value is a local variable at SYMBOL_VALUE offset in stack frame. */
875 /* Value not used; definition in SYMBOL_TYPE. Symbols in the domain
876 STRUCT_DOMAIN all have this class. */
880 /* Value is address SYMBOL_VALUE_ADDRESS in the code. */
884 /* In a symbol table, value is SYMBOL_BLOCK_VALUE of a `struct block'.
885 In a partial symbol table, SYMBOL_VALUE_ADDRESS is the start address
886 of the block. Function names have this class. */
890 /* Value is a constant byte-sequence pointed to by SYMBOL_VALUE_BYTES, in
891 target byte order. */
895 /* Value is at fixed address, but the address of the variable has
896 to be determined from the minimal symbol table whenever the
897 variable is referenced.
898 This happens if debugging information for a global symbol is
899 emitted and the corresponding minimal symbol is defined
900 in another object file or runtime common storage.
901 The linker might even remove the minimal symbol if the global
902 symbol is never referenced, in which case the symbol remains
905 GDB would normally find the symbol in the minimal symbol table if it will
906 not find it in the full symbol table. But a reference to an external
907 symbol in a local block shadowing other definition requires full symbol
908 without possibly having its address available for LOC_STATIC. Testcase
909 is provided as `gdb.dwarf2/dw2-unresolved.exp'.
911 This is also used for thread local storage (TLS) variables. In this case,
912 the address of the TLS variable must be determined when the variable is
913 referenced, from the MSYMBOL_VALUE_RAW_ADDRESS, which is the offset
914 of the TLS variable in the thread local storage of the shared
919 /* The variable does not actually exist in the program.
920 The value is ignored. */
924 /* The variable's address is computed by a set of location
925 functions (see "struct symbol_computed_ops" below). */
928 /* The variable uses general_symbol_info->value->common_block field.
929 It also always uses COMMON_BLOCK_DOMAIN. */
932 /* Not used, just notes the boundary of the enum. */
936 /* The number of bits needed for values in enum address_class, with some
937 padding for reasonable growth, and room for run-time registered address
938 classes. See symtab.c:MAX_SYMBOL_IMPLS.
939 This is a #define so that we can have a assertion elsewhere to
940 verify that we have reserved enough space for synthetic address
942 #define SYMBOL_ACLASS_BITS 5
943 gdb_static_assert (LOC_FINAL_VALUE
<= (1 << SYMBOL_ACLASS_BITS
));
945 /* The methods needed to implement LOC_COMPUTED. These methods can
946 use the symbol's .aux_value for additional per-symbol information.
948 At present this is only used to implement location expressions. */
950 struct symbol_computed_ops
953 /* Return the value of the variable SYMBOL, relative to the stack
954 frame FRAME. If the variable has been optimized out, return
957 Iff `read_needs_frame (SYMBOL)' is not SYMBOL_NEEDS_FRAME, then
958 FRAME may be zero. */
960 struct value
*(*read_variable
) (struct symbol
* symbol
,
961 struct frame_info
* frame
);
963 /* Read variable SYMBOL like read_variable at (callee) FRAME's function
964 entry. SYMBOL should be a function parameter, otherwise
965 NO_ENTRY_VALUE_ERROR will be thrown. */
966 struct value
*(*read_variable_at_entry
) (struct symbol
*symbol
,
967 struct frame_info
*frame
);
969 /* Find the "symbol_needs_kind" value for the given symbol. This
970 value determines whether reading the symbol needs memory (e.g., a
971 global variable), just registers (a thread-local), or a frame (a
973 enum symbol_needs_kind (*get_symbol_read_needs
) (struct symbol
* symbol
);
975 /* Write to STREAM a natural-language description of the location of
976 SYMBOL, in the context of ADDR. */
977 void (*describe_location
) (struct symbol
* symbol
, CORE_ADDR addr
,
978 struct ui_file
* stream
);
980 /* Non-zero if this symbol's address computation is dependent on PC. */
981 unsigned char location_has_loclist
;
983 /* Tracepoint support. Append bytecodes to the tracepoint agent
984 expression AX that push the address of the object SYMBOL. Set
985 VALUE appropriately. Note --- for objects in registers, this
986 needn't emit any code; as long as it sets VALUE properly, then
987 the caller will generate the right code in the process of
988 treating this as an lvalue or rvalue. */
990 void (*tracepoint_var_ref
) (struct symbol
*symbol
, struct agent_expr
*ax
,
991 struct axs_value
*value
);
993 /* Generate C code to compute the location of SYMBOL. The C code is
994 emitted to STREAM. GDBARCH is the current architecture and PC is
995 the PC at which SYMBOL's location should be evaluated.
996 REGISTERS_USED is a vector indexed by register number; the
997 generator function should set an element in this vector if the
998 corresponding register is needed by the location computation.
999 The generated C code must assign the location to a local
1000 variable; this variable's name is RESULT_NAME. */
1002 void (*generate_c_location
) (struct symbol
*symbol
, string_file
*stream
,
1003 struct gdbarch
*gdbarch
,
1004 unsigned char *registers_used
,
1005 CORE_ADDR pc
, const char *result_name
);
1009 /* The methods needed to implement LOC_BLOCK for inferior functions.
1010 These methods can use the symbol's .aux_value for additional
1011 per-symbol information. */
1013 struct symbol_block_ops
1015 /* Fill in *START and *LENGTH with DWARF block data of function
1016 FRAMEFUNC valid for inferior context address PC. Set *LENGTH to
1017 zero if such location is not valid for PC; *START is left
1018 uninitialized in such case. */
1019 void (*find_frame_base_location
) (struct symbol
*framefunc
, CORE_ADDR pc
,
1020 const gdb_byte
**start
, size_t *length
);
1022 /* Return the frame base address. FRAME is the frame for which we want to
1023 compute the base address while FRAMEFUNC is the symbol for the
1024 corresponding function. Return 0 on failure (FRAMEFUNC may not hold the
1025 information we need).
1027 This method is designed to work with static links (nested functions
1028 handling). Static links are function properties whose evaluation returns
1029 the frame base address for the enclosing frame. However, there are
1030 multiple definitions for "frame base": the content of the frame base
1031 register, the CFA as defined by DWARF unwinding information, ...
1033 So this specific method is supposed to compute the frame base address such
1034 as for nested functions, the static link computes the same address. For
1035 instance, considering DWARF debugging information, the static link is
1036 computed with DW_AT_static_link and this method must be used to compute
1037 the corresponding DW_AT_frame_base attribute. */
1038 CORE_ADDR (*get_frame_base
) (struct symbol
*framefunc
,
1039 struct frame_info
*frame
);
1042 /* Functions used with LOC_REGISTER and LOC_REGPARM_ADDR. */
1044 struct symbol_register_ops
1046 int (*register_number
) (struct symbol
*symbol
, struct gdbarch
*gdbarch
);
1049 /* Objects of this type are used to find the address class and the
1050 various computed ops vectors of a symbol. */
1054 enum address_class aclass
;
1056 /* Used with LOC_COMPUTED. */
1057 const struct symbol_computed_ops
*ops_computed
;
1059 /* Used with LOC_BLOCK. */
1060 const struct symbol_block_ops
*ops_block
;
1062 /* Used with LOC_REGISTER and LOC_REGPARM_ADDR. */
1063 const struct symbol_register_ops
*ops_register
;
1066 /* struct symbol has some subclasses. This enum is used to
1067 differentiate between them. */
1069 enum symbol_subclass_kind
1071 /* Plain struct symbol. */
1074 /* struct template_symbol. */
1077 /* struct rust_vtable_symbol. */
1081 /* This structure is space critical. See space comments at the top. */
1083 struct symbol
: public general_symbol_info
, public allocate_on_obstack
1086 /* Class-initialization of bitfields is only allowed in C++20. */
1087 : domain (UNDEF_DOMAIN
),
1089 is_objfile_owned (0),
1093 subclass (SYMBOL_NONE
)
1095 /* We can't use an initializer list for members of a base class, and
1096 general_symbol_info needs to stay a POD type. */
1099 language_specific
.obstack
= nullptr;
1100 language
= language_unknown
;
1103 /* GCC 4.8.5 (on CentOS 7) does not correctly compile class-
1104 initialization of unions, so we initialize it manually here. */
1105 owner
.symtab
= nullptr;
1108 /* Data type of value */
1110 struct type
*type
= nullptr;
1112 /* The owner of this symbol.
1113 Which one to use is defined by symbol.is_objfile_owned. */
1117 /* The symbol table containing this symbol. This is the file associated
1118 with LINE. It can be NULL during symbols read-in but it is never NULL
1119 during normal operation. */
1120 struct symtab
*symtab
;
1122 /* For types defined by the architecture. */
1123 struct gdbarch
*arch
;
1128 ENUM_BITFIELD(domain_enum_tag
) domain
: SYMBOL_DOMAIN_BITS
;
1130 /* Address class. This holds an index into the 'symbol_impls'
1131 table. The actual enum address_class value is stored there,
1132 alongside any per-class ops vectors. */
1134 unsigned int aclass_index
: SYMBOL_ACLASS_BITS
;
1136 /* If non-zero then symbol is objfile-owned, use owner.symtab.
1137 Otherwise symbol is arch-owned, use owner.arch. */
1139 unsigned int is_objfile_owned
: 1;
1141 /* Whether this is an argument. */
1143 unsigned is_argument
: 1;
1145 /* Whether this is an inlined function (class LOC_BLOCK only). */
1146 unsigned is_inlined
: 1;
1148 /* For LOC_STATIC only, if this is set, then the symbol might be
1149 subject to copy relocation. In this case, a minimal symbol
1150 matching the symbol's linkage name is first looked for in the
1151 main objfile. If found, then that address is used; otherwise the
1152 address in this symbol is used. */
1154 unsigned maybe_copied
: 1;
1156 /* The concrete type of this symbol. */
1158 ENUM_BITFIELD (symbol_subclass_kind
) subclass
: 2;
1160 /* Line number of this symbol's definition, except for inlined
1161 functions. For an inlined function (class LOC_BLOCK and
1162 SYMBOL_INLINED set) this is the line number of the function's call
1163 site. Inlined function symbols are not definitions, and they are
1164 never found by symbol table lookup.
1165 If this symbol is arch-owned, LINE shall be zero.
1167 FIXME: Should we really make the assumption that nobody will try
1168 to debug files longer than 64K lines? What about machine
1169 generated programs? */
1171 unsigned short line
= 0;
1173 /* An arbitrary data pointer, allowing symbol readers to record
1174 additional information on a per-symbol basis. Note that this data
1175 must be allocated using the same obstack as the symbol itself. */
1176 /* So far it is only used by:
1177 LOC_COMPUTED: to find the location information
1178 LOC_BLOCK (DWARF2 function): information used internally by the
1179 DWARF 2 code --- specifically, the location expression for the frame
1180 base for this function. */
1181 /* FIXME drow/2003-02-21: For the LOC_BLOCK case, it might be better
1182 to add a magic symbol to the block containing this information,
1183 or to have a generic debug info annotation slot for symbols. */
1185 void *aux_value
= nullptr;
1187 struct symbol
*hash_next
= nullptr;
1190 /* Several lookup functions return both a symbol and the block in which the
1191 symbol is found. This structure is used in these cases. */
1195 /* The symbol that was found, or NULL if no symbol was found. */
1196 struct symbol
*symbol
;
1198 /* If SYMBOL is not NULL, then this is the block in which the symbol is
1200 const struct block
*block
;
1203 extern const struct symbol_impl
*symbol_impls
;
1205 /* Note: There is no accessor macro for symbol.owner because it is
1208 #define SYMBOL_DOMAIN(symbol) (symbol)->domain
1209 #define SYMBOL_IMPL(symbol) (symbol_impls[(symbol)->aclass_index])
1210 #define SYMBOL_ACLASS_INDEX(symbol) (symbol)->aclass_index
1211 #define SYMBOL_CLASS(symbol) (SYMBOL_IMPL (symbol).aclass)
1212 #define SYMBOL_OBJFILE_OWNED(symbol) ((symbol)->is_objfile_owned)
1213 #define SYMBOL_IS_ARGUMENT(symbol) (symbol)->is_argument
1214 #define SYMBOL_INLINED(symbol) (symbol)->is_inlined
1215 #define SYMBOL_IS_CPLUS_TEMPLATE_FUNCTION(symbol) \
1216 (((symbol)->subclass) == SYMBOL_TEMPLATE)
1217 #define SYMBOL_TYPE(symbol) (symbol)->type
1218 #define SYMBOL_LINE(symbol) (symbol)->line
1219 #define SYMBOL_COMPUTED_OPS(symbol) (SYMBOL_IMPL (symbol).ops_computed)
1220 #define SYMBOL_BLOCK_OPS(symbol) (SYMBOL_IMPL (symbol).ops_block)
1221 #define SYMBOL_REGISTER_OPS(symbol) (SYMBOL_IMPL (symbol).ops_register)
1222 #define SYMBOL_LOCATION_BATON(symbol) (symbol)->aux_value
1224 extern int register_symbol_computed_impl (enum address_class
,
1225 const struct symbol_computed_ops
*);
1227 extern int register_symbol_block_impl (enum address_class aclass
,
1228 const struct symbol_block_ops
*ops
);
1230 extern int register_symbol_register_impl (enum address_class
,
1231 const struct symbol_register_ops
*);
1233 /* Return the OBJFILE of SYMBOL.
1234 It is an error to call this if symbol.is_objfile_owned is false, which
1235 only happens for architecture-provided types. */
1237 extern struct objfile
*symbol_objfile (const struct symbol
*symbol
);
1239 /* Return the ARCH of SYMBOL. */
1241 extern struct gdbarch
*symbol_arch (const struct symbol
*symbol
);
1243 /* Return the SYMTAB of SYMBOL.
1244 It is an error to call this if symbol.is_objfile_owned is false, which
1245 only happens for architecture-provided types. */
1247 extern struct symtab
*symbol_symtab (const struct symbol
*symbol
);
1249 /* Set the symtab of SYMBOL to SYMTAB.
1250 It is an error to call this if symbol.is_objfile_owned is false, which
1251 only happens for architecture-provided types. */
1253 extern void symbol_set_symtab (struct symbol
*symbol
, struct symtab
*symtab
);
1255 /* An instance of this type is used to represent a C++ template
1256 function. A symbol is really of this type iff
1257 SYMBOL_IS_CPLUS_TEMPLATE_FUNCTION is true. */
1259 struct template_symbol
: public symbol
1261 /* The number of template arguments. */
1262 int n_template_arguments
= 0;
1264 /* The template arguments. This is an array with
1265 N_TEMPLATE_ARGUMENTS elements. */
1266 struct symbol
**template_arguments
= nullptr;
1269 /* A symbol that represents a Rust virtual table object. */
1271 struct rust_vtable_symbol
: public symbol
1273 /* The concrete type for which this vtable was created; that is, in
1274 "impl Trait for Type", this is "Type". */
1275 struct type
*concrete_type
= nullptr;
1279 /* Each item represents a line-->pc (or the reverse) mapping. This is
1280 somewhat more wasteful of space than one might wish, but since only
1281 the files which are actually debugged are read in to core, we don't
1282 waste much space. */
1284 struct linetable_entry
1290 /* The order of entries in the linetable is significant. They should
1291 be sorted by increasing values of the pc field. If there is more than
1292 one entry for a given pc, then I'm not sure what should happen (and
1293 I not sure whether we currently handle it the best way).
1295 Example: a C for statement generally looks like this
1297 10 0x100 - for the init/test part of a for stmt.
1300 10 0x400 - for the increment part of a for stmt.
1302 If an entry has a line number of zero, it marks the start of a PC
1303 range for which no line number information is available. It is
1304 acceptable, though wasteful of table space, for such a range to be
1311 /* Actually NITEMS elements. If you don't like this use of the
1312 `struct hack', you can shove it up your ANSI (seriously, if the
1313 committee tells us how to do it, we can probably go along). */
1314 struct linetable_entry item
[1];
1317 /* How to relocate the symbols from each section in a symbol file.
1318 Each struct contains an array of offsets.
1319 The ordering and meaning of the offsets is file-type-dependent;
1320 typically it is indexed by section numbers or symbol types or
1321 something like that.
1323 To give us flexibility in changing the internal representation
1324 of these offsets, the ANOFFSET macro must be used to insert and
1325 extract offset values in the struct. */
1327 struct section_offsets
1329 CORE_ADDR offsets
[1]; /* As many as needed. */
1332 #define ANOFFSET(secoff, whichone) \
1334 ? (internal_error (__FILE__, __LINE__, \
1335 _("Section index is uninitialized")), -1) \
1336 : secoff->offsets[whichone])
1338 /* The size of a section_offsets table for N sections. */
1339 #define SIZEOF_N_SECTION_OFFSETS(n) \
1340 (sizeof (struct section_offsets) \
1341 + sizeof (((struct section_offsets *) 0)->offsets) * ((n)-1))
1343 /* Each source file or header is represented by a struct symtab.
1344 The name "symtab" is historical, another name for it is "filetab".
1345 These objects are chained through the `next' field. */
1349 /* Unordered chain of all filetabs in the compunit, with the exception
1350 that the "main" source file is the first entry in the list. */
1352 struct symtab
*next
;
1354 /* Backlink to containing compunit symtab. */
1356 struct compunit_symtab
*compunit_symtab
;
1358 /* Table mapping core addresses to line numbers for this file.
1359 Can be NULL if none. Never shared between different symtabs. */
1361 struct linetable
*linetable
;
1363 /* Name of this source file. This pointer is never NULL. */
1365 const char *filename
;
1367 /* Language of this source file. */
1369 enum language language
;
1371 /* Full name of file as found by searching the source path.
1372 NULL if not yet known. */
1377 #define SYMTAB_COMPUNIT(symtab) ((symtab)->compunit_symtab)
1378 #define SYMTAB_LINETABLE(symtab) ((symtab)->linetable)
1379 #define SYMTAB_LANGUAGE(symtab) ((symtab)->language)
1380 #define SYMTAB_BLOCKVECTOR(symtab) \
1381 COMPUNIT_BLOCKVECTOR (SYMTAB_COMPUNIT (symtab))
1382 #define SYMTAB_OBJFILE(symtab) \
1383 COMPUNIT_OBJFILE (SYMTAB_COMPUNIT (symtab))
1384 #define SYMTAB_PSPACE(symtab) (SYMTAB_OBJFILE (symtab)->pspace)
1385 #define SYMTAB_DIRNAME(symtab) \
1386 COMPUNIT_DIRNAME (SYMTAB_COMPUNIT (symtab))
1388 /* Compunit symtabs contain the actual "symbol table", aka blockvector, as well
1389 as the list of all source files (what gdb has historically associated with
1391 Additional information is recorded here that is common to all symtabs in a
1392 compilation unit (DWARF or otherwise).
1395 For the case of a program built out of these files:
1404 This is recorded as:
1406 objfile -> foo.c(cu) -> bar.c(cu) -> NULL
1420 where "foo.c(cu)" and "bar.c(cu)" are struct compunit_symtab objects,
1421 and the files foo.c, etc. are struct symtab objects. */
1423 struct compunit_symtab
1425 /* Unordered chain of all compunit symtabs of this objfile. */
1426 struct compunit_symtab
*next
;
1428 /* Object file from which this symtab information was read. */
1429 struct objfile
*objfile
;
1431 /* Name of the symtab.
1432 This is *not* intended to be a usable filename, and is
1433 for debugging purposes only. */
1436 /* Unordered list of file symtabs, except that by convention the "main"
1437 source file (e.g., .c, .cc) is guaranteed to be first.
1438 Each symtab is a file, either the "main" source file (e.g., .c, .cc)
1439 or header (e.g., .h). */
1440 struct symtab
*filetabs
;
1442 /* Last entry in FILETABS list.
1443 Subfiles are added to the end of the list so they accumulate in order,
1444 with the main source subfile living at the front.
1445 The main reason is so that the main source file symtab is at the head
1446 of the list, and the rest appear in order for debugging convenience. */
1447 struct symtab
*last_filetab
;
1449 /* Non-NULL string that identifies the format of the debugging information,
1450 such as "stabs", "dwarf 1", "dwarf 2", "coff", etc. This is mostly useful
1451 for automated testing of gdb but may also be information that is
1452 useful to the user. */
1453 const char *debugformat
;
1455 /* String of producer version information, or NULL if we don't know. */
1456 const char *producer
;
1458 /* Directory in which it was compiled, or NULL if we don't know. */
1459 const char *dirname
;
1461 /* List of all symbol scope blocks for this symtab. It is shared among
1462 all symtabs in a given compilation unit. */
1463 const struct blockvector
*blockvector
;
1465 /* Section in objfile->section_offsets for the blockvector and
1466 the linetable. Probably always SECT_OFF_TEXT. */
1467 int block_line_section
;
1469 /* Symtab has been compiled with both optimizations and debug info so that
1470 GDB may stop skipping prologues as variables locations are valid already
1471 at function entry points. */
1472 unsigned int locations_valid
: 1;
1474 /* DWARF unwinder for this CU is valid even for epilogues (PC at the return
1475 instruction). This is supported by GCC since 4.5.0. */
1476 unsigned int epilogue_unwind_valid
: 1;
1478 /* struct call_site entries for this compilation unit or NULL. */
1479 htab_t call_site_htab
;
1481 /* The macro table for this symtab. Like the blockvector, this
1482 is shared between different symtabs in a given compilation unit.
1483 It's debatable whether it *should* be shared among all the symtabs in
1484 the given compilation unit, but it currently is. */
1485 struct macro_table
*macro_table
;
1487 /* If non-NULL, then this points to a NULL-terminated vector of
1488 included compunits. When searching the static or global
1489 block of this compunit, the corresponding block of all
1490 included compunits will also be searched. Note that this
1491 list must be flattened -- the symbol reader is responsible for
1492 ensuring that this vector contains the transitive closure of all
1493 included compunits. */
1494 struct compunit_symtab
**includes
;
1496 /* If this is an included compunit, this points to one includer
1497 of the table. This user is considered the canonical compunit
1498 containing this one. An included compunit may itself be
1499 included by another. */
1500 struct compunit_symtab
*user
;
1503 #define COMPUNIT_OBJFILE(cust) ((cust)->objfile)
1504 #define COMPUNIT_FILETABS(cust) ((cust)->filetabs)
1505 #define COMPUNIT_DEBUGFORMAT(cust) ((cust)->debugformat)
1506 #define COMPUNIT_PRODUCER(cust) ((cust)->producer)
1507 #define COMPUNIT_DIRNAME(cust) ((cust)->dirname)
1508 #define COMPUNIT_BLOCKVECTOR(cust) ((cust)->blockvector)
1509 #define COMPUNIT_BLOCK_LINE_SECTION(cust) ((cust)->block_line_section)
1510 #define COMPUNIT_LOCATIONS_VALID(cust) ((cust)->locations_valid)
1511 #define COMPUNIT_EPILOGUE_UNWIND_VALID(cust) ((cust)->epilogue_unwind_valid)
1512 #define COMPUNIT_CALL_SITE_HTAB(cust) ((cust)->call_site_htab)
1513 #define COMPUNIT_MACRO_TABLE(cust) ((cust)->macro_table)
1515 /* A range adapter to allowing iterating over all the file tables
1516 within a compunit. */
1518 struct compunit_filetabs
: public next_adapter
<struct symtab
>
1520 compunit_filetabs (struct compunit_symtab
*cu
)
1521 : next_adapter
<struct symtab
> (cu
->filetabs
)
1526 /* Return the primary symtab of CUST. */
1528 extern struct symtab
*
1529 compunit_primary_filetab (const struct compunit_symtab
*cust
);
1531 /* Return the language of CUST. */
1533 extern enum language
compunit_language (const struct compunit_symtab
*cust
);
1537 /* The virtual function table is now an array of structures which have the
1538 form { int16 offset, delta; void *pfn; }.
1540 In normal virtual function tables, OFFSET is unused.
1541 DELTA is the amount which is added to the apparent object's base
1542 address in order to point to the actual object to which the
1543 virtual function should be applied.
1544 PFN is a pointer to the virtual function.
1546 Note that this macro is g++ specific (FIXME). */
1548 #define VTBL_FNADDR_OFFSET 2
1550 /* External variables and functions for the objects described above. */
1552 /* True if we are nested inside psymtab_to_symtab. */
1554 extern int currently_reading_symtab
;
1556 /* symtab.c lookup functions */
1558 extern const char multiple_symbols_ask
[];
1559 extern const char multiple_symbols_all
[];
1560 extern const char multiple_symbols_cancel
[];
1562 const char *multiple_symbols_select_mode (void);
1564 bool symbol_matches_domain (enum language symbol_language
,
1565 domain_enum symbol_domain
,
1566 domain_enum domain
);
1568 /* lookup a symbol table by source file name. */
1570 extern struct symtab
*lookup_symtab (const char *);
1572 /* An object of this type is passed as the 'is_a_field_of_this'
1573 argument to lookup_symbol and lookup_symbol_in_language. */
1575 struct field_of_this_result
1577 /* The type in which the field was found. If this is NULL then the
1578 symbol was not found in 'this'. If non-NULL, then one of the
1579 other fields will be non-NULL as well. */
1583 /* If the symbol was found as an ordinary field of 'this', then this
1584 is non-NULL and points to the particular field. */
1586 struct field
*field
;
1588 /* If the symbol was found as a function field of 'this', then this
1589 is non-NULL and points to the particular field. */
1591 struct fn_fieldlist
*fn_field
;
1594 /* Find the definition for a specified symbol name NAME
1595 in domain DOMAIN in language LANGUAGE, visible from lexical block BLOCK
1596 if non-NULL or from global/static blocks if BLOCK is NULL.
1597 Returns the struct symbol pointer, or NULL if no symbol is found.
1598 C++: if IS_A_FIELD_OF_THIS is non-NULL on entry, check to see if
1599 NAME is a field of the current implied argument `this'. If so fill in the
1600 fields of IS_A_FIELD_OF_THIS, otherwise the fields are set to NULL.
1601 The symbol's section is fixed up if necessary. */
1603 extern struct block_symbol
1604 lookup_symbol_in_language (const char *,
1605 const struct block
*,
1608 struct field_of_this_result
*);
1610 /* Same as lookup_symbol_in_language, but using the current language. */
1612 extern struct block_symbol
lookup_symbol (const char *,
1613 const struct block
*,
1615 struct field_of_this_result
*);
1617 /* Find the definition for a specified symbol search name in domain
1618 DOMAIN, visible from lexical block BLOCK if non-NULL or from
1619 global/static blocks if BLOCK is NULL. The passed-in search name
1620 should not come from the user; instead it should already be a
1621 search name as retrieved from a search_name () call. See definition of
1622 symbol_name_match_type::SEARCH_NAME. Returns the struct symbol
1623 pointer, or NULL if no symbol is found. The symbol's section is
1624 fixed up if necessary. */
1626 extern struct block_symbol
lookup_symbol_search_name (const char *search_name
,
1627 const struct block
*block
,
1628 domain_enum domain
);
1630 /* A default version of lookup_symbol_nonlocal for use by languages
1631 that can't think of anything better to do.
1632 This implements the C lookup rules. */
1634 extern struct block_symbol
1635 basic_lookup_symbol_nonlocal (const struct language_defn
*langdef
,
1637 const struct block
*,
1640 /* Some helper functions for languages that need to write their own
1641 lookup_symbol_nonlocal functions. */
1643 /* Lookup a symbol in the static block associated to BLOCK, if there
1644 is one; do nothing if BLOCK is NULL or a global block.
1645 Upon success fixes up the symbol's section if necessary. */
1647 extern struct block_symbol
1648 lookup_symbol_in_static_block (const char *name
,
1649 const struct block
*block
,
1650 const domain_enum domain
);
1652 /* Search all static file-level symbols for NAME from DOMAIN.
1653 Upon success fixes up the symbol's section if necessary. */
1655 extern struct block_symbol
lookup_static_symbol (const char *name
,
1656 const domain_enum domain
);
1658 /* Lookup a symbol in all files' global blocks.
1660 If BLOCK is non-NULL then it is used for two things:
1661 1) If a target-specific lookup routine for libraries exists, then use the
1662 routine for the objfile of BLOCK, and
1663 2) The objfile of BLOCK is used to assist in determining the search order
1664 if the target requires it.
1665 See gdbarch_iterate_over_objfiles_in_search_order.
1667 Upon success fixes up the symbol's section if necessary. */
1669 extern struct block_symbol
1670 lookup_global_symbol (const char *name
,
1671 const struct block
*block
,
1672 const domain_enum domain
);
1674 /* Lookup a symbol in block BLOCK.
1675 Upon success fixes up the symbol's section if necessary. */
1677 extern struct symbol
*
1678 lookup_symbol_in_block (const char *name
,
1679 symbol_name_match_type match_type
,
1680 const struct block
*block
,
1681 const domain_enum domain
);
1683 /* Look up the `this' symbol for LANG in BLOCK. Return the symbol if
1684 found, or NULL if not found. */
1686 extern struct block_symbol
1687 lookup_language_this (const struct language_defn
*lang
,
1688 const struct block
*block
);
1690 /* Lookup a [struct, union, enum] by name, within a specified block. */
1692 extern struct type
*lookup_struct (const char *, const struct block
*);
1694 extern struct type
*lookup_union (const char *, const struct block
*);
1696 extern struct type
*lookup_enum (const char *, const struct block
*);
1698 /* from blockframe.c: */
1700 /* lookup the function symbol corresponding to the address. The
1701 return value will not be an inlined function; the containing
1702 function will be returned instead. */
1704 extern struct symbol
*find_pc_function (CORE_ADDR
);
1706 /* lookup the function corresponding to the address and section. The
1707 return value will not be an inlined function; the containing
1708 function will be returned instead. */
1710 extern struct symbol
*find_pc_sect_function (CORE_ADDR
, struct obj_section
*);
1712 /* lookup the function symbol corresponding to the address and
1713 section. The return value will be the closest enclosing function,
1714 which might be an inline function. */
1716 extern struct symbol
*find_pc_sect_containing_function
1717 (CORE_ADDR pc
, struct obj_section
*section
);
1719 /* Find the symbol at the given address. Returns NULL if no symbol
1720 found. Only exact matches for ADDRESS are considered. */
1722 extern struct symbol
*find_symbol_at_address (CORE_ADDR
);
1724 /* Finds the "function" (text symbol) that is smaller than PC but
1725 greatest of all of the potential text symbols in SECTION. Sets
1726 *NAME and/or *ADDRESS conditionally if that pointer is non-null.
1727 If ENDADDR is non-null, then set *ENDADDR to be the end of the
1728 function (exclusive). If the optional parameter BLOCK is non-null,
1729 then set *BLOCK to the address of the block corresponding to the
1730 function symbol, if such a symbol could be found during the lookup;
1731 nullptr is used as a return value for *BLOCK if no block is found.
1732 This function either succeeds or fails (not halfway succeeds). If
1733 it succeeds, it sets *NAME, *ADDRESS, and *ENDADDR to real
1734 information and returns true. If it fails, it sets *NAME, *ADDRESS
1735 and *ENDADDR to zero and returns false.
1737 If the function in question occupies non-contiguous ranges,
1738 *ADDRESS and *ENDADDR are (subject to the conditions noted above) set
1739 to the start and end of the range in which PC is found. Thus
1740 *ADDRESS <= PC < *ENDADDR with no intervening gaps (in which ranges
1741 from other functions might be found).
1743 This property allows find_pc_partial_function to be used (as it had
1744 been prior to the introduction of non-contiguous range support) by
1745 various tdep files for finding a start address and limit address
1746 for prologue analysis. This still isn't ideal, however, because we
1747 probably shouldn't be doing prologue analysis (in which
1748 instructions are scanned to determine frame size and stack layout)
1749 for any range that doesn't contain the entry pc. Moreover, a good
1750 argument can be made that prologue analysis ought to be performed
1751 starting from the entry pc even when PC is within some other range.
1752 This might suggest that *ADDRESS and *ENDADDR ought to be set to the
1753 limits of the entry pc range, but that will cause the
1754 *ADDRESS <= PC < *ENDADDR condition to be violated; many of the
1755 callers of find_pc_partial_function expect this condition to hold.
1757 Callers which require the start and/or end addresses for the range
1758 containing the entry pc should instead call
1759 find_function_entry_range_from_pc. */
1761 extern bool find_pc_partial_function (CORE_ADDR pc
, const char **name
,
1762 CORE_ADDR
*address
, CORE_ADDR
*endaddr
,
1763 const struct block
**block
= nullptr);
1765 /* Like find_pc_partial_function, above, but *ADDRESS and *ENDADDR are
1766 set to start and end addresses of the range containing the entry pc.
1768 Note that it is not necessarily the case that (for non-NULL ADDRESS
1769 and ENDADDR arguments) the *ADDRESS <= PC < *ENDADDR condition will
1772 See comment for find_pc_partial_function, above, for further
1775 extern bool find_function_entry_range_from_pc (CORE_ADDR pc
,
1778 CORE_ADDR
*endaddr
);
1780 /* Return the type of a function with its first instruction exactly at
1781 the PC address. Return NULL otherwise. */
1783 extern struct type
*find_function_type (CORE_ADDR pc
);
1785 /* See if we can figure out the function's actual type from the type
1786 that the resolver returns. RESOLVER_FUNADDR is the address of the
1789 extern struct type
*find_gnu_ifunc_target_type (CORE_ADDR resolver_funaddr
);
1791 /* Find the GNU ifunc minimal symbol that matches SYM. */
1792 extern bound_minimal_symbol
find_gnu_ifunc (const symbol
*sym
);
1794 extern void clear_pc_function_cache (void);
1796 /* Expand symtab containing PC, SECTION if not already expanded. */
1798 extern void expand_symtab_containing_pc (CORE_ADDR
, struct obj_section
*);
1800 /* lookup full symbol table by address. */
1802 extern struct compunit_symtab
*find_pc_compunit_symtab (CORE_ADDR
);
1804 /* lookup full symbol table by address and section. */
1806 extern struct compunit_symtab
*
1807 find_pc_sect_compunit_symtab (CORE_ADDR
, struct obj_section
*);
1809 extern bool find_pc_line_pc_range (CORE_ADDR
, CORE_ADDR
*, CORE_ADDR
*);
1811 extern void reread_symbols (void);
1813 /* Look up a type named NAME in STRUCT_DOMAIN in the current language.
1814 The type returned must not be opaque -- i.e., must have at least one field
1817 extern struct type
*lookup_transparent_type (const char *);
1819 extern struct type
*basic_lookup_transparent_type (const char *);
1821 /* Macro for name of symbol to indicate a file compiled with gcc. */
1822 #ifndef GCC_COMPILED_FLAG_SYMBOL
1823 #define GCC_COMPILED_FLAG_SYMBOL "gcc_compiled."
1826 /* Macro for name of symbol to indicate a file compiled with gcc2. */
1827 #ifndef GCC2_COMPILED_FLAG_SYMBOL
1828 #define GCC2_COMPILED_FLAG_SYMBOL "gcc2_compiled."
1831 extern bool in_gnu_ifunc_stub (CORE_ADDR pc
);
1833 /* Functions for resolving STT_GNU_IFUNC symbols which are implemented only
1834 for ELF symbol files. */
1836 struct gnu_ifunc_fns
1838 /* See elf_gnu_ifunc_resolve_addr for its real implementation. */
1839 CORE_ADDR (*gnu_ifunc_resolve_addr
) (struct gdbarch
*gdbarch
, CORE_ADDR pc
);
1841 /* See elf_gnu_ifunc_resolve_name for its real implementation. */
1842 bool (*gnu_ifunc_resolve_name
) (const char *function_name
,
1843 CORE_ADDR
*function_address_p
);
1845 /* See elf_gnu_ifunc_resolver_stop for its real implementation. */
1846 void (*gnu_ifunc_resolver_stop
) (struct breakpoint
*b
);
1848 /* See elf_gnu_ifunc_resolver_return_stop for its real implementation. */
1849 void (*gnu_ifunc_resolver_return_stop
) (struct breakpoint
*b
);
1852 #define gnu_ifunc_resolve_addr gnu_ifunc_fns_p->gnu_ifunc_resolve_addr
1853 #define gnu_ifunc_resolve_name gnu_ifunc_fns_p->gnu_ifunc_resolve_name
1854 #define gnu_ifunc_resolver_stop gnu_ifunc_fns_p->gnu_ifunc_resolver_stop
1855 #define gnu_ifunc_resolver_return_stop \
1856 gnu_ifunc_fns_p->gnu_ifunc_resolver_return_stop
1858 extern const struct gnu_ifunc_fns
*gnu_ifunc_fns_p
;
1860 extern CORE_ADDR
find_solib_trampoline_target (struct frame_info
*, CORE_ADDR
);
1862 struct symtab_and_line
1864 /* The program space of this sal. */
1865 struct program_space
*pspace
= NULL
;
1867 struct symtab
*symtab
= NULL
;
1868 struct symbol
*symbol
= NULL
;
1869 struct obj_section
*section
= NULL
;
1870 struct minimal_symbol
*msymbol
= NULL
;
1871 /* Line number. Line numbers start at 1 and proceed through symtab->nlines.
1872 0 is never a valid line number; it is used to indicate that line number
1873 information is not available. */
1878 bool explicit_pc
= false;
1879 bool explicit_line
= false;
1881 /* The probe associated with this symtab_and_line. */
1883 /* If PROBE is not NULL, then this is the objfile in which the probe
1885 struct objfile
*objfile
= NULL
;
1890 /* Given a pc value, return line number it is in. Second arg nonzero means
1891 if pc is on the boundary use the previous statement's line number. */
1893 extern struct symtab_and_line
find_pc_line (CORE_ADDR
, int);
1895 /* Same function, but specify a section as well as an address. */
1897 extern struct symtab_and_line
find_pc_sect_line (CORE_ADDR
,
1898 struct obj_section
*, int);
1900 /* Wrapper around find_pc_line to just return the symtab. */
1902 extern struct symtab
*find_pc_line_symtab (CORE_ADDR
);
1904 /* Given a symtab and line number, return the pc there. */
1906 extern bool find_line_pc (struct symtab
*, int, CORE_ADDR
*);
1908 extern bool find_line_pc_range (struct symtab_and_line
, CORE_ADDR
*,
1911 extern void resolve_sal_pc (struct symtab_and_line
*);
1915 extern void clear_solib (void);
1917 /* The reason we're calling into a completion match list collector
1919 enum class complete_symbol_mode
1921 /* Completing an expression. */
1924 /* Completing a linespec. */
1928 extern void default_collect_symbol_completion_matches_break_on
1929 (completion_tracker
&tracker
,
1930 complete_symbol_mode mode
,
1931 symbol_name_match_type name_match_type
,
1932 const char *text
, const char *word
, const char *break_on
,
1933 enum type_code code
);
1934 extern void default_collect_symbol_completion_matches
1935 (completion_tracker
&tracker
,
1936 complete_symbol_mode
,
1937 symbol_name_match_type name_match_type
,
1941 extern void collect_symbol_completion_matches
1942 (completion_tracker
&tracker
,
1943 complete_symbol_mode mode
,
1944 symbol_name_match_type name_match_type
,
1945 const char *, const char *);
1946 extern void collect_symbol_completion_matches_type (completion_tracker
&tracker
,
1947 const char *, const char *,
1950 extern void collect_file_symbol_completion_matches
1951 (completion_tracker
&tracker
,
1952 complete_symbol_mode
,
1953 symbol_name_match_type name_match_type
,
1954 const char *, const char *, const char *);
1956 extern completion_list
1957 make_source_files_completion_list (const char *, const char *);
1959 /* Return whether SYM is a function/method, as opposed to a data symbol. */
1961 extern bool symbol_is_function_or_method (symbol
*sym
);
1963 /* Return whether MSYMBOL is a function/method, as opposed to a data
1966 extern bool symbol_is_function_or_method (minimal_symbol
*msymbol
);
1968 /* Return whether SYM should be skipped in completion mode MODE. In
1969 linespec mode, we're only interested in functions/methods. */
1971 template<typename Symbol
>
1973 completion_skip_symbol (complete_symbol_mode mode
, Symbol
*sym
)
1975 return (mode
== complete_symbol_mode::LINESPEC
1976 && !symbol_is_function_or_method (sym
));
1981 bool matching_obj_sections (struct obj_section
*, struct obj_section
*);
1983 extern struct symtab
*find_line_symtab (struct symtab
*, int, int *, bool *);
1985 /* Given a function symbol SYM, find the symtab and line for the start
1986 of the function. If FUNFIRSTLINE is true, we want the first line
1987 of real code inside the function. */
1988 extern symtab_and_line
find_function_start_sal (symbol
*sym
, bool
1991 /* Same, but start with a function address/section instead of a
1993 extern symtab_and_line
find_function_start_sal (CORE_ADDR func_addr
,
1994 obj_section
*section
,
1997 extern void skip_prologue_sal (struct symtab_and_line
*);
2001 extern CORE_ADDR
skip_prologue_using_sal (struct gdbarch
*gdbarch
,
2002 CORE_ADDR func_addr
);
2004 extern struct symbol
*fixup_symbol_section (struct symbol
*,
2007 /* If MSYMBOL is an text symbol, look for a function debug symbol with
2008 the same address. Returns NULL if not found. This is necessary in
2009 case a function is an alias to some other function, because debug
2010 information is only emitted for the alias target function's
2011 definition, not for the alias. */
2012 extern symbol
*find_function_alias_target (bound_minimal_symbol msymbol
);
2014 /* Symbol searching */
2016 /* When using the symbol_searcher struct to search for symbols, a vector of
2017 the following structs is returned. */
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 /* In order to search for global symbols of a particular kind matching
2067 particular regular expressions, create an instance of this structure and
2068 call the SEARCH member function. */
2069 class global_symbol_searcher
2074 global_symbol_searcher (enum search_domain kind
,
2075 const char *symbol_name_regexp
)
2077 m_symbol_name_regexp (symbol_name_regexp
)
2079 /* The symbol searching is designed to only find one kind of thing. */
2080 gdb_assert (m_kind
!= ALL_DOMAIN
);
2083 /* Set the optional regexp that matches against the symbol type. */
2084 void set_symbol_type_regexp (const char *regexp
)
2086 m_symbol_type_regexp
= regexp
;
2089 /* Set the flag to exclude minsyms from the search results. */
2090 void set_exclude_minsyms (bool exclude_minsyms
)
2092 m_exclude_minsyms
= exclude_minsyms
;
2095 /* Search the symbols from all objfiles in the current program space
2096 looking for matches as defined by the current state of this object.
2098 Within each file the results are sorted locally; each symtab's global
2099 and static blocks are separately alphabetized. Duplicate entries are
2101 std::vector
<symbol_search
> search () const;
2103 /* The set of source files to search in for matching symbols. This is
2104 currently public so that it can be populated after this object has
2105 been constructed. */
2106 std::vector
<const char *> filenames
;
2109 /* The kind of symbols are we searching for.
2110 VARIABLES_DOMAIN - Search all symbols, excluding functions, type
2111 names, and constants (enums).
2112 FUNCTIONS_DOMAIN - Search all functions..
2113 TYPES_DOMAIN - Search all type names.
2114 MODULES_DOMAIN - Search all Fortran modules.
2115 ALL_DOMAIN - Not valid for this function. */
2116 enum search_domain m_kind
;
2118 /* Regular expression to match against the symbol name. */
2119 const char *m_symbol_name_regexp
= nullptr;
2121 /* Regular expression to match against the symbol type. */
2122 const char *m_symbol_type_regexp
= nullptr;
2124 /* When this flag is false then minsyms that match M_SYMBOL_REGEXP will
2125 be included in the results, otherwise they are excluded. */
2126 bool m_exclude_minsyms
= false;
2129 /* When searching for Fortran symbols within modules (functions/variables)
2130 we return a vector of this type. The first item in the pair is the
2131 module symbol, and the second item is the symbol for the function or
2132 variable we found. */
2133 typedef std::pair
<symbol_search
, symbol_search
> module_symbol_search
;
2135 /* Searches the symbols to find function and variables symbols (depending
2136 on KIND) within Fortran modules. The MODULE_REGEXP matches against the
2137 name of the module, REGEXP matches against the name of the symbol within
2138 the module, and TYPE_REGEXP matches against the type of the symbol
2139 within the module. */
2140 extern std::vector
<module_symbol_search
> search_module_symbols
2141 (const char *module_regexp
, const char *regexp
,
2142 const char *type_regexp
, search_domain kind
);
2144 /* Convert a global or static symbol SYM (based on BLOCK, which should be
2145 either GLOBAL_BLOCK or STATIC_BLOCK) into a string for use in 'info'
2146 type commands (e.g. 'info variables', 'info functions', etc). KIND is
2147 the type of symbol that was searched for which gave us SYM. */
2149 extern std::string
symbol_to_info_string (struct symbol
*sym
, int block
,
2150 enum search_domain kind
);
2152 extern bool treg_matches_sym_type_name (const compiled_regex
&treg
,
2153 const struct symbol
*sym
);
2155 /* The name of the ``main'' function. */
2156 extern const char *main_name ();
2157 extern enum language
main_language (void);
2159 /* Lookup symbol NAME from DOMAIN in MAIN_OBJFILE's global or static blocks,
2160 as specified by BLOCK_INDEX.
2161 This searches MAIN_OBJFILE as well as any associated separate debug info
2162 objfiles of MAIN_OBJFILE.
2163 BLOCK_INDEX can be GLOBAL_BLOCK or STATIC_BLOCK.
2164 Upon success fixes up the symbol's section if necessary. */
2166 extern struct block_symbol
2167 lookup_global_symbol_from_objfile (struct objfile
*main_objfile
,
2168 enum block_enum block_index
,
2170 const domain_enum domain
);
2172 /* Return 1 if the supplied producer string matches the ARM RealView
2173 compiler (armcc). */
2174 bool producer_is_realview (const char *producer
);
2176 void fixup_section (struct general_symbol_info
*ginfo
,
2177 CORE_ADDR addr
, struct objfile
*objfile
);
2179 /* Look up objfile containing BLOCK. */
2181 struct objfile
*lookup_objfile_from_block (const struct block
*block
);
2183 extern unsigned int symtab_create_debug
;
2185 extern unsigned int symbol_lookup_debug
;
2187 extern bool basenames_may_differ
;
2189 bool compare_filenames_for_search (const char *filename
,
2190 const char *search_name
);
2192 bool compare_glob_filenames_for_search (const char *filename
,
2193 const char *search_name
);
2195 bool iterate_over_some_symtabs (const char *name
,
2196 const char *real_path
,
2197 struct compunit_symtab
*first
,
2198 struct compunit_symtab
*after_last
,
2199 gdb::function_view
<bool (symtab
*)> callback
);
2201 void iterate_over_symtabs (const char *name
,
2202 gdb::function_view
<bool (symtab
*)> callback
);
2205 std::vector
<CORE_ADDR
> find_pcs_for_symtab_line
2206 (struct symtab
*symtab
, int line
, struct linetable_entry
**best_entry
);
2208 /* Prototype for callbacks for LA_ITERATE_OVER_SYMBOLS. The callback
2209 is called once per matching symbol SYM. The callback should return
2210 true to indicate that LA_ITERATE_OVER_SYMBOLS should continue
2211 iterating, or false to indicate that the iteration should end. */
2213 typedef bool (symbol_found_callback_ftype
) (struct block_symbol
*bsym
);
2215 /* Iterate over the symbols named NAME, matching DOMAIN, in BLOCK.
2217 For each symbol that matches, CALLBACK is called. The symbol is
2218 passed to the callback.
2220 If CALLBACK returns false, the iteration ends and this function
2221 returns false. Otherwise, the search continues, and the function
2222 eventually returns true. */
2224 bool iterate_over_symbols (const struct block
*block
,
2225 const lookup_name_info
&name
,
2226 const domain_enum domain
,
2227 gdb::function_view
<symbol_found_callback_ftype
> callback
);
2229 /* Like iterate_over_symbols, but if all calls to CALLBACK return
2230 true, then calls CALLBACK one additional time with a block_symbol
2231 that has a valid block but a NULL symbol. */
2233 bool iterate_over_symbols_terminated
2234 (const struct block
*block
,
2235 const lookup_name_info
&name
,
2236 const domain_enum domain
,
2237 gdb::function_view
<symbol_found_callback_ftype
> callback
);
2239 /* Storage type used by demangle_for_lookup. demangle_for_lookup
2240 either returns a const char * pointer that points to either of the
2241 fields of this type, or a pointer to the input NAME. This is done
2242 this way because the underlying functions that demangle_for_lookup
2243 calls either return a std::string (e.g., cp_canonicalize_string) or
2244 a malloc'ed buffer (libiberty's demangled), and we want to avoid
2245 unnecessary reallocation/string copying. */
2246 class demangle_result_storage
2250 /* Swap the std::string storage with STR, and return a pointer to
2251 the beginning of the new string. */
2252 const char *swap_string (std::string
&str
)
2254 std::swap (m_string
, str
);
2255 return m_string
.c_str ();
2258 /* Set the malloc storage to now point at PTR. Any previous malloc
2259 storage is released. */
2260 const char *set_malloc_ptr (char *ptr
)
2262 m_malloc
.reset (ptr
);
2269 std::string m_string
;
2270 gdb::unique_xmalloc_ptr
<char> m_malloc
;
2274 demangle_for_lookup (const char *name
, enum language lang
,
2275 demangle_result_storage
&storage
);
2277 struct symbol
*allocate_symbol (struct objfile
*);
2279 void initialize_objfile_symbol (struct symbol
*);
2281 struct template_symbol
*allocate_template_symbol (struct objfile
*);
2283 /* Test to see if the symbol of language SYMBOL_LANGUAGE specified by
2284 SYMNAME (which is already demangled for C++ symbols) matches
2285 SYM_TEXT in the first SYM_TEXT_LEN characters. If so, add it to
2286 the current completion list. */
2287 void completion_list_add_name (completion_tracker
&tracker
,
2288 language symbol_language
,
2289 const char *symname
,
2290 const lookup_name_info
&lookup_name
,
2291 const char *text
, const char *word
);
2293 /* A simple symbol searching class. */
2295 class symbol_searcher
2298 /* Returns the symbols found for the search. */
2299 const std::vector
<block_symbol
> &
2300 matching_symbols () const
2305 /* Returns the minimal symbols found for the search. */
2306 const std::vector
<bound_minimal_symbol
> &
2307 matching_msymbols () const
2309 return m_minimal_symbols
;
2312 /* Search for all symbols named NAME in LANGUAGE with DOMAIN, restricting
2313 search to FILE_SYMTABS and SEARCH_PSPACE, both of which may be NULL
2314 to search all symtabs and program spaces. */
2315 void find_all_symbols (const std::string
&name
,
2316 const struct language_defn
*language
,
2317 enum search_domain search_domain
,
2318 std::vector
<symtab
*> *search_symtabs
,
2319 struct program_space
*search_pspace
);
2321 /* Reset this object to perform another search. */
2325 m_minimal_symbols
.clear ();
2329 /* Matching debug symbols. */
2330 std::vector
<block_symbol
> m_symbols
;
2332 /* Matching non-debug symbols. */
2333 std::vector
<bound_minimal_symbol
> m_minimal_symbols
;
2336 #endif /* !defined(SYMTAB_H) */