1 /* Symbol table definitions for GDB.
3 Copyright (C) 1986-2017 Free Software Foundation, Inc.
5 This file is part of GDB.
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program. If not, see <http://www.gnu.org/licenses/>. */
20 #if !defined (SYMTAB_H)
26 #include "common/enum-flags.h"
27 #include "common/function-view.h"
28 #include "completer.h"
30 /* Opaque declarations. */
45 struct cmd_list_element
;
47 /* Some of the structures in this file are space critical.
48 The space-critical structures are:
50 struct general_symbol_info
54 These structures are laid out to encourage good packing.
55 They use ENUM_BITFIELD and short int fields, and they order the
56 structure members so that fields less than a word are next
57 to each other so they can be packed together. */
59 /* Rearranged: used ENUM_BITFIELD and rearranged field order in
60 all the space critical structures (plus struct minimal_symbol).
61 Memory usage dropped from 99360768 bytes to 90001408 bytes.
62 I measured this with before-and-after tests of
63 "HEAD-old-gdb -readnow HEAD-old-gdb" and
64 "HEAD-new-gdb -readnow HEAD-old-gdb" on native i686-pc-linux-gnu,
65 red hat linux 8, with LD_LIBRARY_PATH=/usr/lib/debug,
66 typing "maint space 1" at the first command prompt.
68 Here is another measurement (from andrew c):
69 # no /usr/lib/debug, just plain glibc, like a normal user
71 (gdb) break internal_error
73 (gdb) maint internal-error
77 gdb gdb_6_0_branch 2003-08-19 space used: 8896512
78 gdb HEAD 2003-08-19 space used: 8904704
79 gdb HEAD 2003-08-21 space used: 8396800 (+symtab.h)
80 gdb HEAD 2003-08-21 space used: 8265728 (+gdbtypes.h)
82 The third line shows the savings from the optimizations in symtab.h.
83 The fourth line shows the savings from the optimizations in
84 gdbtypes.h. Both optimizations are in gdb HEAD now.
86 --chastain 2003-08-21 */
88 /* Define a structure for the information that is common to all symbol types,
89 including minimal symbols, partial symbols, and full symbols. In a
90 multilanguage environment, some language specific information may need to
91 be recorded along with each symbol. */
93 /* This structure is space critical. See space comments at the top. */
95 struct general_symbol_info
97 /* Name of the symbol. This is a required field. Storage for the
98 name is allocated on the objfile_obstack for the associated
99 objfile. For languages like C++ that make a distinction between
100 the mangled name and demangled name, this is the mangled
105 /* Value of the symbol. Which member of this union to use, and what
106 it means, depends on what kind of symbol this is and its
107 SYMBOL_CLASS. See comments there for more details. All of these
108 are in host byte order (though what they point to might be in
109 target byte order, e.g. LOC_CONST_BYTES). */
115 const struct block
*block
;
117 const gdb_byte
*bytes
;
121 /* A common block. Used with LOC_COMMON_BLOCK. */
123 const struct common_block
*common_block
;
125 /* For opaque typedef struct chain. */
127 struct symbol
*chain
;
131 /* Since one and only one language can apply, wrap the language specific
132 information inside a union. */
136 /* A pointer to an obstack that can be used for storage associated
137 with this symbol. This is only used by Ada, and only when the
138 'ada_mangled' field is zero. */
139 struct obstack
*obstack
;
141 /* This is used by languages which wish to store a demangled name.
142 currently used by Ada, C++, and Objective C. */
143 const char *demangled_name
;
147 /* Record the source code language that applies to this symbol.
148 This is used to select one of the fields from the language specific
151 ENUM_BITFIELD(language
) language
: LANGUAGE_BITS
;
153 /* This is only used by Ada. If set, then the 'demangled_name' field
154 of language_specific is valid. Otherwise, the 'obstack' field is
156 unsigned int ada_mangled
: 1;
158 /* Which section is this symbol in? This is an index into
159 section_offsets for this objfile. Negative means that the symbol
160 does not get relocated relative to a section. */
165 extern void symbol_set_demangled_name (struct general_symbol_info
*,
169 extern const char *symbol_get_demangled_name
170 (const struct general_symbol_info
*);
172 extern CORE_ADDR
symbol_overlayed_address (CORE_ADDR
, struct obj_section
*);
174 /* Note that all the following SYMBOL_* macros are used with the
175 SYMBOL argument being either a partial symbol or
176 a full symbol. Both types have a ginfo field. In particular
177 the SYMBOL_SET_LANGUAGE, SYMBOL_DEMANGLED_NAME, etc.
178 macros cannot be entirely substituted by
179 functions, unless the callers are changed to pass in the ginfo
180 field only, instead of the SYMBOL parameter. */
182 #define SYMBOL_VALUE(symbol) (symbol)->ginfo.value.ivalue
183 #define SYMBOL_VALUE_ADDRESS(symbol) (symbol)->ginfo.value.address
184 #define SYMBOL_VALUE_BYTES(symbol) (symbol)->ginfo.value.bytes
185 #define SYMBOL_VALUE_COMMON_BLOCK(symbol) (symbol)->ginfo.value.common_block
186 #define SYMBOL_BLOCK_VALUE(symbol) (symbol)->ginfo.value.block
187 #define SYMBOL_VALUE_CHAIN(symbol) (symbol)->ginfo.value.chain
188 #define SYMBOL_LANGUAGE(symbol) (symbol)->ginfo.language
189 #define SYMBOL_SECTION(symbol) (symbol)->ginfo.section
190 #define SYMBOL_OBJ_SECTION(objfile, symbol) \
191 (((symbol)->ginfo.section >= 0) \
192 ? (&(((objfile)->sections)[(symbol)->ginfo.section])) \
195 /* Initializes the language dependent portion of a symbol
196 depending upon the language for the symbol. */
197 #define SYMBOL_SET_LANGUAGE(symbol,language,obstack) \
198 (symbol_set_language (&(symbol)->ginfo, (language), (obstack)))
199 extern void symbol_set_language (struct general_symbol_info
*symbol
,
200 enum language language
,
201 struct obstack
*obstack
);
203 /* Set just the linkage name of a symbol; do not try to demangle
204 it. Used for constructs which do not have a mangled name,
205 e.g. struct tags. Unlike SYMBOL_SET_NAMES, linkage_name must
206 be terminated and either already on the objfile's obstack or
207 permanently allocated. */
208 #define SYMBOL_SET_LINKAGE_NAME(symbol,linkage_name) \
209 (symbol)->ginfo.name = (linkage_name)
211 /* Set the linkage and natural names of a symbol, by demangling
213 #define SYMBOL_SET_NAMES(symbol,linkage_name,len,copy_name,objfile) \
214 symbol_set_names (&(symbol)->ginfo, linkage_name, len, copy_name, objfile)
215 extern void symbol_set_names (struct general_symbol_info
*symbol
,
216 const char *linkage_name
, int len
, int copy_name
,
217 struct objfile
*objfile
);
219 /* Now come lots of name accessor macros. Short version as to when to
220 use which: Use SYMBOL_NATURAL_NAME to refer to the name of the
221 symbol in the original source code. Use SYMBOL_LINKAGE_NAME if you
222 want to know what the linker thinks the symbol's name is. Use
223 SYMBOL_PRINT_NAME for output. Use SYMBOL_DEMANGLED_NAME if you
224 specifically need to know whether SYMBOL_NATURAL_NAME and
225 SYMBOL_LINKAGE_NAME are different. */
227 /* Return SYMBOL's "natural" name, i.e. the name that it was called in
228 the original source code. In languages like C++ where symbols may
229 be mangled for ease of manipulation by the linker, this is the
232 #define SYMBOL_NATURAL_NAME(symbol) \
233 (symbol_natural_name (&(symbol)->ginfo))
234 extern const char *symbol_natural_name
235 (const struct general_symbol_info
*symbol
);
237 /* Return SYMBOL's name from the point of view of the linker. In
238 languages like C++ where symbols may be mangled for ease of
239 manipulation by the linker, this is the mangled name; otherwise,
240 it's the same as SYMBOL_NATURAL_NAME. */
242 #define SYMBOL_LINKAGE_NAME(symbol) (symbol)->ginfo.name
244 /* Return the demangled name for a symbol based on the language for
245 that symbol. If no demangled name exists, return NULL. */
246 #define SYMBOL_DEMANGLED_NAME(symbol) \
247 (symbol_demangled_name (&(symbol)->ginfo))
248 extern const char *symbol_demangled_name
249 (const struct general_symbol_info
*symbol
);
251 /* Macro that returns a version of the name of a symbol that is
252 suitable for output. In C++ this is the "demangled" form of the
253 name if demangle is on and the "mangled" form of the name if
254 demangle is off. In other languages this is just the symbol name.
255 The result should never be NULL. Don't use this for internal
256 purposes (e.g. storing in a hashtable): it's only suitable for output.
258 N.B. symbol may be anything with a ginfo member,
259 e.g., struct symbol or struct minimal_symbol. */
261 #define SYMBOL_PRINT_NAME(symbol) \
262 (demangle ? SYMBOL_NATURAL_NAME (symbol) : SYMBOL_LINKAGE_NAME (symbol))
265 /* Macro that returns the name to be used when sorting and searching symbols.
266 In C++, we search for the demangled form of a name,
267 and so sort symbols accordingly. In Ada, however, we search by mangled
268 name. If there is no distinct demangled name, then SYMBOL_SEARCH_NAME
269 returns the same value (same pointer) as SYMBOL_LINKAGE_NAME. */
270 #define SYMBOL_SEARCH_NAME(symbol) \
271 (symbol_search_name (&(symbol)->ginfo))
272 extern const char *symbol_search_name (const struct general_symbol_info
*);
274 /* Return non-zero if NAME matches the "search" name of SYMBOL.
275 Whitespace and trailing parentheses are ignored.
276 See strcmp_iw for details about its behavior. */
277 #define SYMBOL_MATCHES_SEARCH_NAME(symbol, name) \
278 (strcmp_iw (SYMBOL_SEARCH_NAME (symbol), (name)) == 0)
280 /* Compute the hash of the given symbol search name of a symbol of
281 language LANGUAGE. */
282 extern unsigned int search_name_hash (enum language language
,
283 const char *search_name
);
285 /* Classification types for a minimal symbol. These should be taken as
286 "advisory only", since if gdb can't easily figure out a
287 classification it simply selects mst_unknown. It may also have to
288 guess when it can't figure out which is a better match between two
289 types (mst_data versus mst_bss) for example. Since the minimal
290 symbol info is sometimes derived from the BFD library's view of a
291 file, we need to live with what information bfd supplies. */
293 enum minimal_symbol_type
295 mst_unknown
= 0, /* Unknown type, the default */
296 mst_text
, /* Generally executable instructions */
297 mst_text_gnu_ifunc
, /* Executable code returning address
298 of executable code */
299 mst_slot_got_plt
, /* GOT entries for .plt sections */
300 mst_data
, /* Generally initialized data */
301 mst_bss
, /* Generally uninitialized data */
302 mst_abs
, /* Generally absolute (nonrelocatable) */
303 /* GDB uses mst_solib_trampoline for the start address of a shared
304 library trampoline entry. Breakpoints for shared library functions
305 are put there if the shared library is not yet loaded.
306 After the shared library is loaded, lookup_minimal_symbol will
307 prefer the minimal symbol from the shared library (usually
308 a mst_text symbol) over the mst_solib_trampoline symbol, and the
309 breakpoints will be moved to their true address in the shared
310 library via breakpoint_re_set. */
311 mst_solib_trampoline
, /* Shared library trampoline code */
312 /* For the mst_file* types, the names are only guaranteed to be unique
313 within a given .o file. */
314 mst_file_text
, /* Static version of mst_text */
315 mst_file_data
, /* Static version of mst_data */
316 mst_file_bss
, /* Static version of mst_bss */
320 /* The number of enum minimal_symbol_type values, with some padding for
321 reasonable growth. */
322 #define MINSYM_TYPE_BITS 4
323 gdb_static_assert (nr_minsym_types
<= (1 << MINSYM_TYPE_BITS
));
325 /* Define a simple structure used to hold some very basic information about
326 all defined global symbols (text, data, bss, abs, etc). The only required
327 information is the general_symbol_info.
329 In many cases, even if a file was compiled with no special options for
330 debugging at all, as long as was not stripped it will contain sufficient
331 information to build a useful minimal symbol table using this structure.
332 Even when a file contains enough debugging information to build a full
333 symbol table, these minimal symbols are still useful for quickly mapping
334 between names and addresses, and vice versa. They are also sometimes
335 used to figure out what full symbol table entries need to be read in. */
337 struct minimal_symbol
340 /* The general symbol info required for all types of symbols.
342 The SYMBOL_VALUE_ADDRESS contains the address that this symbol
345 struct general_symbol_info mginfo
;
347 /* Size of this symbol. dbx_end_psymtab in dbxread.c uses this
348 information to calculate the end of the partial symtab based on the
349 address of the last symbol plus the size of the last symbol. */
353 /* Which source file is this symbol in? Only relevant for mst_file_*. */
354 const char *filename
;
356 /* Classification type for this minimal symbol. */
358 ENUM_BITFIELD(minimal_symbol_type
) type
: MINSYM_TYPE_BITS
;
360 /* Non-zero if this symbol was created by gdb.
361 Such symbols do not appear in the output of "info var|fun". */
362 unsigned int created_by_gdb
: 1;
364 /* Two flag bits provided for the use of the target. */
365 unsigned int target_flag_1
: 1;
366 unsigned int target_flag_2
: 1;
368 /* Nonzero iff the size of the minimal symbol has been set.
369 Symbol size information can sometimes not be determined, because
370 the object file format may not carry that piece of information. */
371 unsigned int has_size
: 1;
373 /* Minimal symbols with the same hash key are kept on a linked
374 list. This is the link. */
376 struct minimal_symbol
*hash_next
;
378 /* Minimal symbols are stored in two different hash tables. This is
379 the `next' pointer for the demangled hash table. */
381 struct minimal_symbol
*demangled_hash_next
;
384 #define MSYMBOL_TARGET_FLAG_1(msymbol) (msymbol)->target_flag_1
385 #define MSYMBOL_TARGET_FLAG_2(msymbol) (msymbol)->target_flag_2
386 #define MSYMBOL_SIZE(msymbol) ((msymbol)->size + 0)
387 #define SET_MSYMBOL_SIZE(msymbol, sz) \
390 (msymbol)->size = sz; \
391 (msymbol)->has_size = 1; \
393 #define MSYMBOL_HAS_SIZE(msymbol) ((msymbol)->has_size + 0)
394 #define MSYMBOL_TYPE(msymbol) (msymbol)->type
396 #define MSYMBOL_VALUE(symbol) (symbol)->mginfo.value.ivalue
397 /* The unrelocated address of the minimal symbol. */
398 #define MSYMBOL_VALUE_RAW_ADDRESS(symbol) ((symbol)->mginfo.value.address + 0)
399 /* The relocated address of the minimal symbol, using the section
400 offsets from OBJFILE. */
401 #define MSYMBOL_VALUE_ADDRESS(objfile, symbol) \
402 ((symbol)->mginfo.value.address \
403 + ANOFFSET ((objfile)->section_offsets, ((symbol)->mginfo.section)))
404 /* For a bound minsym, we can easily compute the address directly. */
405 #define BMSYMBOL_VALUE_ADDRESS(symbol) \
406 MSYMBOL_VALUE_ADDRESS ((symbol).objfile, (symbol).minsym)
407 #define SET_MSYMBOL_VALUE_ADDRESS(symbol, new_value) \
408 ((symbol)->mginfo.value.address = (new_value))
409 #define MSYMBOL_VALUE_BYTES(symbol) (symbol)->mginfo.value.bytes
410 #define MSYMBOL_BLOCK_VALUE(symbol) (symbol)->mginfo.value.block
411 #define MSYMBOL_VALUE_CHAIN(symbol) (symbol)->mginfo.value.chain
412 #define MSYMBOL_LANGUAGE(symbol) (symbol)->mginfo.language
413 #define MSYMBOL_SECTION(symbol) (symbol)->mginfo.section
414 #define MSYMBOL_OBJ_SECTION(objfile, symbol) \
415 (((symbol)->mginfo.section >= 0) \
416 ? (&(((objfile)->sections)[(symbol)->mginfo.section])) \
419 #define MSYMBOL_NATURAL_NAME(symbol) \
420 (symbol_natural_name (&(symbol)->mginfo))
421 #define MSYMBOL_LINKAGE_NAME(symbol) (symbol)->mginfo.name
422 #define MSYMBOL_PRINT_NAME(symbol) \
423 (demangle ? MSYMBOL_NATURAL_NAME (symbol) : MSYMBOL_LINKAGE_NAME (symbol))
424 #define MSYMBOL_DEMANGLED_NAME(symbol) \
425 (symbol_demangled_name (&(symbol)->mginfo))
426 #define MSYMBOL_SET_LANGUAGE(symbol,language,obstack) \
427 (symbol_set_language (&(symbol)->mginfo, (language), (obstack)))
428 #define MSYMBOL_SEARCH_NAME(symbol) \
429 (symbol_search_name (&(symbol)->mginfo))
430 #define MSYMBOL_MATCHES_SEARCH_NAME(symbol, name) \
431 (strcmp_iw (MSYMBOL_SEARCH_NAME (symbol), (name)) == 0)
432 #define MSYMBOL_SET_NAMES(symbol,linkage_name,len,copy_name,objfile) \
433 symbol_set_names (&(symbol)->mginfo, linkage_name, len, copy_name, objfile)
439 /* Represent one symbol name; a variable, constant, function or typedef. */
441 /* Different name domains for symbols. Looking up a symbol specifies a
442 domain and ignores symbol definitions in other name domains. */
444 typedef enum domain_enum_tag
446 /* UNDEF_DOMAIN is used when a domain has not been discovered or
447 none of the following apply. This usually indicates an error either
448 in the symbol information or in gdb's handling of symbols. */
452 /* VAR_DOMAIN is the usual domain. In C, this contains variables,
453 function names, typedef names and enum type values. */
457 /* STRUCT_DOMAIN is used in C to hold struct, union and enum type names.
458 Thus, if `struct foo' is used in a C program, it produces a symbol named
459 `foo' in the STRUCT_DOMAIN. */
463 /* MODULE_DOMAIN is used in Fortran to hold module type names. */
467 /* LABEL_DOMAIN may be used for names of labels (for gotos). */
471 /* Fortran common blocks. Their naming must be separate from VAR_DOMAIN.
472 They also always use LOC_COMMON_BLOCK. */
475 /* This must remain last. */
479 /* The number of bits in a symbol used to represent the domain. */
481 #define SYMBOL_DOMAIN_BITS 3
482 gdb_static_assert (NR_DOMAINS
<= (1 << SYMBOL_DOMAIN_BITS
));
484 extern const char *domain_name (domain_enum
);
486 /* Searching domains, used for `search_symbols'. Element numbers are
487 hardcoded in GDB, check all enum uses before changing it. */
491 /* Everything in VAR_DOMAIN minus FUNCTIONS_DOMAIN and
493 VARIABLES_DOMAIN
= 0,
495 /* All functions -- for some reason not methods, though. */
496 FUNCTIONS_DOMAIN
= 1,
498 /* All defined types */
505 extern const char *search_domain_name (enum search_domain
);
507 /* An address-class says where to find the value of a symbol. */
511 /* Not used; catches errors. */
515 /* Value is constant int SYMBOL_VALUE, host byteorder. */
519 /* Value is at fixed address SYMBOL_VALUE_ADDRESS. */
523 /* Value is in register. SYMBOL_VALUE is the register number
524 in the original debug format. SYMBOL_REGISTER_OPS holds a
525 function that can be called to transform this into the
526 actual register number this represents in a specific target
527 architecture (gdbarch).
529 For some symbol formats (stabs, for some compilers at least),
530 the compiler generates two symbols, an argument and a register.
531 In some cases we combine them to a single LOC_REGISTER in symbol
532 reading, but currently not for all cases (e.g. it's passed on the
533 stack and then loaded into a register). */
537 /* It's an argument; the value is at SYMBOL_VALUE offset in arglist. */
541 /* Value address is at SYMBOL_VALUE offset in arglist. */
545 /* Value is in specified register. Just like LOC_REGISTER except the
546 register holds the address of the argument instead of the argument
547 itself. This is currently used for the passing of structs and unions
548 on sparc and hppa. It is also used for call by reference where the
549 address is in a register, at least by mipsread.c. */
553 /* Value is a local variable at SYMBOL_VALUE offset in stack frame. */
557 /* Value not used; definition in SYMBOL_TYPE. Symbols in the domain
558 STRUCT_DOMAIN all have this class. */
562 /* Value is address SYMBOL_VALUE_ADDRESS in the code. */
566 /* In a symbol table, value is SYMBOL_BLOCK_VALUE of a `struct block'.
567 In a partial symbol table, SYMBOL_VALUE_ADDRESS is the start address
568 of the block. Function names have this class. */
572 /* Value is a constant byte-sequence pointed to by SYMBOL_VALUE_BYTES, in
573 target byte order. */
577 /* Value is at fixed address, but the address of the variable has
578 to be determined from the minimal symbol table whenever the
579 variable is referenced.
580 This happens if debugging information for a global symbol is
581 emitted and the corresponding minimal symbol is defined
582 in another object file or runtime common storage.
583 The linker might even remove the minimal symbol if the global
584 symbol is never referenced, in which case the symbol remains
587 GDB would normally find the symbol in the minimal symbol table if it will
588 not find it in the full symbol table. But a reference to an external
589 symbol in a local block shadowing other definition requires full symbol
590 without possibly having its address available for LOC_STATIC. Testcase
591 is provided as `gdb.dwarf2/dw2-unresolved.exp'.
593 This is also used for thread local storage (TLS) variables. In this case,
594 the address of the TLS variable must be determined when the variable is
595 referenced, from the MSYMBOL_VALUE_RAW_ADDRESS, which is the offset
596 of the TLS variable in the thread local storage of the shared
601 /* The variable does not actually exist in the program.
602 The value is ignored. */
606 /* The variable's address is computed by a set of location
607 functions (see "struct symbol_computed_ops" below). */
610 /* The variable uses general_symbol_info->value->common_block field.
611 It also always uses COMMON_BLOCK_DOMAIN. */
614 /* Not used, just notes the boundary of the enum. */
618 /* The number of bits needed for values in enum address_class, with some
619 padding for reasonable growth, and room for run-time registered address
620 classes. See symtab.c:MAX_SYMBOL_IMPLS.
621 This is a #define so that we can have a assertion elsewhere to
622 verify that we have reserved enough space for synthetic address
624 #define SYMBOL_ACLASS_BITS 5
625 gdb_static_assert (LOC_FINAL_VALUE
<= (1 << SYMBOL_ACLASS_BITS
));
627 /* The methods needed to implement LOC_COMPUTED. These methods can
628 use the symbol's .aux_value for additional per-symbol information.
630 At present this is only used to implement location expressions. */
632 struct symbol_computed_ops
635 /* Return the value of the variable SYMBOL, relative to the stack
636 frame FRAME. If the variable has been optimized out, return
639 Iff `read_needs_frame (SYMBOL)' is not SYMBOL_NEEDS_FRAME, then
640 FRAME may be zero. */
642 struct value
*(*read_variable
) (struct symbol
* symbol
,
643 struct frame_info
* frame
);
645 /* Read variable SYMBOL like read_variable at (callee) FRAME's function
646 entry. SYMBOL should be a function parameter, otherwise
647 NO_ENTRY_VALUE_ERROR will be thrown. */
648 struct value
*(*read_variable_at_entry
) (struct symbol
*symbol
,
649 struct frame_info
*frame
);
651 /* Find the "symbol_needs_kind" value for the given symbol. This
652 value determines whether reading the symbol needs memory (e.g., a
653 global variable), just registers (a thread-local), or a frame (a
655 enum symbol_needs_kind (*get_symbol_read_needs
) (struct symbol
* symbol
);
657 /* Write to STREAM a natural-language description of the location of
658 SYMBOL, in the context of ADDR. */
659 void (*describe_location
) (struct symbol
* symbol
, CORE_ADDR addr
,
660 struct ui_file
* stream
);
662 /* Non-zero if this symbol's address computation is dependent on PC. */
663 unsigned char location_has_loclist
;
665 /* Tracepoint support. Append bytecodes to the tracepoint agent
666 expression AX that push the address of the object SYMBOL. Set
667 VALUE appropriately. Note --- for objects in registers, this
668 needn't emit any code; as long as it sets VALUE properly, then
669 the caller will generate the right code in the process of
670 treating this as an lvalue or rvalue. */
672 void (*tracepoint_var_ref
) (struct symbol
*symbol
, struct agent_expr
*ax
,
673 struct axs_value
*value
);
675 /* Generate C code to compute the location of SYMBOL. The C code is
676 emitted to STREAM. GDBARCH is the current architecture and PC is
677 the PC at which SYMBOL's location should be evaluated.
678 REGISTERS_USED is a vector indexed by register number; the
679 generator function should set an element in this vector if the
680 corresponding register is needed by the location computation.
681 The generated C code must assign the location to a local
682 variable; this variable's name is RESULT_NAME. */
684 void (*generate_c_location
) (struct symbol
*symbol
, string_file
&stream
,
685 struct gdbarch
*gdbarch
,
686 unsigned char *registers_used
,
687 CORE_ADDR pc
, const char *result_name
);
691 /* The methods needed to implement LOC_BLOCK for inferior functions.
692 These methods can use the symbol's .aux_value for additional
693 per-symbol information. */
695 struct symbol_block_ops
697 /* Fill in *START and *LENGTH with DWARF block data of function
698 FRAMEFUNC valid for inferior context address PC. Set *LENGTH to
699 zero if such location is not valid for PC; *START is left
700 uninitialized in such case. */
701 void (*find_frame_base_location
) (struct symbol
*framefunc
, CORE_ADDR pc
,
702 const gdb_byte
**start
, size_t *length
);
704 /* Return the frame base address. FRAME is the frame for which we want to
705 compute the base address while FRAMEFUNC is the symbol for the
706 corresponding function. Return 0 on failure (FRAMEFUNC may not hold the
707 information we need).
709 This method is designed to work with static links (nested functions
710 handling). Static links are function properties whose evaluation returns
711 the frame base address for the enclosing frame. However, there are
712 multiple definitions for "frame base": the content of the frame base
713 register, the CFA as defined by DWARF unwinding information, ...
715 So this specific method is supposed to compute the frame base address such
716 as for nested fuctions, the static link computes the same address. For
717 instance, considering DWARF debugging information, the static link is
718 computed with DW_AT_static_link and this method must be used to compute
719 the corresponding DW_AT_frame_base attribute. */
720 CORE_ADDR (*get_frame_base
) (struct symbol
*framefunc
,
721 struct frame_info
*frame
);
724 /* Functions used with LOC_REGISTER and LOC_REGPARM_ADDR. */
726 struct symbol_register_ops
728 int (*register_number
) (struct symbol
*symbol
, struct gdbarch
*gdbarch
);
731 /* Objects of this type are used to find the address class and the
732 various computed ops vectors of a symbol. */
736 enum address_class aclass
;
738 /* Used with LOC_COMPUTED. */
739 const struct symbol_computed_ops
*ops_computed
;
741 /* Used with LOC_BLOCK. */
742 const struct symbol_block_ops
*ops_block
;
744 /* Used with LOC_REGISTER and LOC_REGPARM_ADDR. */
745 const struct symbol_register_ops
*ops_register
;
748 /* This structure is space critical. See space comments at the top. */
753 /* The general symbol info required for all types of symbols. */
755 struct general_symbol_info ginfo
;
757 /* Data type of value */
761 /* The owner of this symbol.
762 Which one to use is defined by symbol.is_objfile_owned. */
766 /* The symbol table containing this symbol. This is the file associated
767 with LINE. It can be NULL during symbols read-in but it is never NULL
768 during normal operation. */
769 struct symtab
*symtab
;
771 /* For types defined by the architecture. */
772 struct gdbarch
*arch
;
777 ENUM_BITFIELD(domain_enum_tag
) domain
: SYMBOL_DOMAIN_BITS
;
779 /* Address class. This holds an index into the 'symbol_impls'
780 table. The actual enum address_class value is stored there,
781 alongside any per-class ops vectors. */
783 unsigned int aclass_index
: SYMBOL_ACLASS_BITS
;
785 /* If non-zero then symbol is objfile-owned, use owner.symtab.
786 Otherwise symbol is arch-owned, use owner.arch. */
788 unsigned int is_objfile_owned
: 1;
790 /* Whether this is an argument. */
792 unsigned is_argument
: 1;
794 /* Whether this is an inlined function (class LOC_BLOCK only). */
795 unsigned is_inlined
: 1;
797 /* True if this is a C++ function symbol with template arguments.
798 In this case the symbol is really a "struct template_symbol". */
799 unsigned is_cplus_template_function
: 1;
801 /* Line number of this symbol's definition, except for inlined
802 functions. For an inlined function (class LOC_BLOCK and
803 SYMBOL_INLINED set) this is the line number of the function's call
804 site. Inlined function symbols are not definitions, and they are
805 never found by symbol table lookup.
806 If this symbol is arch-owned, LINE shall be zero.
808 FIXME: Should we really make the assumption that nobody will try
809 to debug files longer than 64K lines? What about machine
810 generated programs? */
814 /* An arbitrary data pointer, allowing symbol readers to record
815 additional information on a per-symbol basis. Note that this data
816 must be allocated using the same obstack as the symbol itself. */
817 /* So far it is only used by:
818 LOC_COMPUTED: to find the location information
819 LOC_BLOCK (DWARF2 function): information used internally by the
820 DWARF 2 code --- specifically, the location expression for the frame
821 base for this function. */
822 /* FIXME drow/2003-02-21: For the LOC_BLOCK case, it might be better
823 to add a magic symbol to the block containing this information,
824 or to have a generic debug info annotation slot for symbols. */
828 struct symbol
*hash_next
;
831 /* Several lookup functions return both a symbol and the block in which the
832 symbol is found. This structure is used in these cases. */
836 /* The symbol that was found, or NULL if no symbol was found. */
837 struct symbol
*symbol
;
839 /* If SYMBOL is not NULL, then this is the block in which the symbol is
841 const struct block
*block
;
844 extern const struct symbol_impl
*symbol_impls
;
846 /* For convenience. All fields are NULL. This means "there is no
848 extern const struct block_symbol null_block_symbol
;
850 /* Note: There is no accessor macro for symbol.owner because it is
853 #define SYMBOL_DOMAIN(symbol) (symbol)->domain
854 #define SYMBOL_IMPL(symbol) (symbol_impls[(symbol)->aclass_index])
855 #define SYMBOL_ACLASS_INDEX(symbol) (symbol)->aclass_index
856 #define SYMBOL_CLASS(symbol) (SYMBOL_IMPL (symbol).aclass)
857 #define SYMBOL_OBJFILE_OWNED(symbol) ((symbol)->is_objfile_owned)
858 #define SYMBOL_IS_ARGUMENT(symbol) (symbol)->is_argument
859 #define SYMBOL_INLINED(symbol) (symbol)->is_inlined
860 #define SYMBOL_IS_CPLUS_TEMPLATE_FUNCTION(symbol) \
861 (symbol)->is_cplus_template_function
862 #define SYMBOL_TYPE(symbol) (symbol)->type
863 #define SYMBOL_LINE(symbol) (symbol)->line
864 #define SYMBOL_COMPUTED_OPS(symbol) (SYMBOL_IMPL (symbol).ops_computed)
865 #define SYMBOL_BLOCK_OPS(symbol) (SYMBOL_IMPL (symbol).ops_block)
866 #define SYMBOL_REGISTER_OPS(symbol) (SYMBOL_IMPL (symbol).ops_register)
867 #define SYMBOL_LOCATION_BATON(symbol) (symbol)->aux_value
869 extern int register_symbol_computed_impl (enum address_class
,
870 const struct symbol_computed_ops
*);
872 extern int register_symbol_block_impl (enum address_class aclass
,
873 const struct symbol_block_ops
*ops
);
875 extern int register_symbol_register_impl (enum address_class
,
876 const struct symbol_register_ops
*);
878 /* Return the OBJFILE of SYMBOL.
879 It is an error to call this if symbol.is_objfile_owned is false, which
880 only happens for architecture-provided types. */
882 extern struct objfile
*symbol_objfile (const struct symbol
*symbol
);
884 /* Return the ARCH of SYMBOL. */
886 extern struct gdbarch
*symbol_arch (const struct symbol
*symbol
);
888 /* Return the SYMTAB of SYMBOL.
889 It is an error to call this if symbol.is_objfile_owned is false, which
890 only happens for architecture-provided types. */
892 extern struct symtab
*symbol_symtab (const struct symbol
*symbol
);
894 /* Set the symtab of SYMBOL to SYMTAB.
895 It is an error to call this if symbol.is_objfile_owned is false, which
896 only happens for architecture-provided types. */
898 extern void symbol_set_symtab (struct symbol
*symbol
, struct symtab
*symtab
);
900 /* An instance of this type is used to represent a C++ template
901 function. It includes a "struct symbol" as a kind of base class;
902 users downcast to "struct template_symbol *" when needed. A symbol
903 is really of this type iff SYMBOL_IS_CPLUS_TEMPLATE_FUNCTION is
906 struct template_symbol
908 /* The base class. */
911 /* The number of template arguments. */
912 int n_template_arguments
;
914 /* The template arguments. This is an array with
915 N_TEMPLATE_ARGUMENTS elements. */
916 struct symbol
**template_arguments
;
920 /* Each item represents a line-->pc (or the reverse) mapping. This is
921 somewhat more wasteful of space than one might wish, but since only
922 the files which are actually debugged are read in to core, we don't
925 struct linetable_entry
931 /* The order of entries in the linetable is significant. They should
932 be sorted by increasing values of the pc field. If there is more than
933 one entry for a given pc, then I'm not sure what should happen (and
934 I not sure whether we currently handle it the best way).
936 Example: a C for statement generally looks like this
938 10 0x100 - for the init/test part of a for stmt.
941 10 0x400 - for the increment part of a for stmt.
943 If an entry has a line number of zero, it marks the start of a PC
944 range for which no line number information is available. It is
945 acceptable, though wasteful of table space, for such a range to be
952 /* Actually NITEMS elements. If you don't like this use of the
953 `struct hack', you can shove it up your ANSI (seriously, if the
954 committee tells us how to do it, we can probably go along). */
955 struct linetable_entry item
[1];
958 /* How to relocate the symbols from each section in a symbol file.
959 Each struct contains an array of offsets.
960 The ordering and meaning of the offsets is file-type-dependent;
961 typically it is indexed by section numbers or symbol types or
964 To give us flexibility in changing the internal representation
965 of these offsets, the ANOFFSET macro must be used to insert and
966 extract offset values in the struct. */
968 struct section_offsets
970 CORE_ADDR offsets
[1]; /* As many as needed. */
973 #define ANOFFSET(secoff, whichone) \
975 ? (internal_error (__FILE__, __LINE__, \
976 _("Section index is uninitialized")), -1) \
977 : secoff->offsets[whichone])
979 /* The size of a section_offsets table for N sections. */
980 #define SIZEOF_N_SECTION_OFFSETS(n) \
981 (sizeof (struct section_offsets) \
982 + sizeof (((struct section_offsets *) 0)->offsets) * ((n)-1))
984 /* Each source file or header is represented by a struct symtab.
985 The name "symtab" is historical, another name for it is "filetab".
986 These objects are chained through the `next' field. */
990 /* Unordered chain of all filetabs in the compunit, with the exception
991 that the "main" source file is the first entry in the list. */
995 /* Backlink to containing compunit symtab. */
997 struct compunit_symtab
*compunit_symtab
;
999 /* Table mapping core addresses to line numbers for this file.
1000 Can be NULL if none. Never shared between different symtabs. */
1002 struct linetable
*linetable
;
1004 /* Name of this source file. This pointer is never NULL. */
1006 const char *filename
;
1008 /* Total number of lines found in source file. */
1012 /* line_charpos[N] is the position of the (N-1)th line of the
1013 source file. "position" means something we can lseek() to; it
1014 is not guaranteed to be useful any other way. */
1018 /* Language of this source file. */
1020 enum language language
;
1022 /* Full name of file as found by searching the source path.
1023 NULL if not yet known. */
1028 #define SYMTAB_COMPUNIT(symtab) ((symtab)->compunit_symtab)
1029 #define SYMTAB_LINETABLE(symtab) ((symtab)->linetable)
1030 #define SYMTAB_LANGUAGE(symtab) ((symtab)->language)
1031 #define SYMTAB_BLOCKVECTOR(symtab) \
1032 COMPUNIT_BLOCKVECTOR (SYMTAB_COMPUNIT (symtab))
1033 #define SYMTAB_OBJFILE(symtab) \
1034 COMPUNIT_OBJFILE (SYMTAB_COMPUNIT (symtab))
1035 #define SYMTAB_PSPACE(symtab) (SYMTAB_OBJFILE (symtab)->pspace)
1036 #define SYMTAB_DIRNAME(symtab) \
1037 COMPUNIT_DIRNAME (SYMTAB_COMPUNIT (symtab))
1039 typedef struct symtab
*symtab_ptr
;
1040 DEF_VEC_P (symtab_ptr
);
1042 /* Compunit symtabs contain the actual "symbol table", aka blockvector, as well
1043 as the list of all source files (what gdb has historically associated with
1045 Additional information is recorded here that is common to all symtabs in a
1046 compilation unit (DWARF or otherwise).
1049 For the case of a program built out of these files:
1058 This is recorded as:
1060 objfile -> foo.c(cu) -> bar.c(cu) -> NULL
1074 where "foo.c(cu)" and "bar.c(cu)" are struct compunit_symtab objects,
1075 and the files foo.c, etc. are struct symtab objects. */
1077 struct compunit_symtab
1079 /* Unordered chain of all compunit symtabs of this objfile. */
1080 struct compunit_symtab
*next
;
1082 /* Object file from which this symtab information was read. */
1083 struct objfile
*objfile
;
1085 /* Name of the symtab.
1086 This is *not* intended to be a usable filename, and is
1087 for debugging purposes only. */
1090 /* Unordered list of file symtabs, except that by convention the "main"
1091 source file (e.g., .c, .cc) is guaranteed to be first.
1092 Each symtab is a file, either the "main" source file (e.g., .c, .cc)
1093 or header (e.g., .h). */
1094 struct symtab
*filetabs
;
1096 /* Last entry in FILETABS list.
1097 Subfiles are added to the end of the list so they accumulate in order,
1098 with the main source subfile living at the front.
1099 The main reason is so that the main source file symtab is at the head
1100 of the list, and the rest appear in order for debugging convenience. */
1101 struct symtab
*last_filetab
;
1103 /* Non-NULL string that identifies the format of the debugging information,
1104 such as "stabs", "dwarf 1", "dwarf 2", "coff", etc. This is mostly useful
1105 for automated testing of gdb but may also be information that is
1106 useful to the user. */
1107 const char *debugformat
;
1109 /* String of producer version information, or NULL if we don't know. */
1110 const char *producer
;
1112 /* Directory in which it was compiled, or NULL if we don't know. */
1113 const char *dirname
;
1115 /* List of all symbol scope blocks for this symtab. It is shared among
1116 all symtabs in a given compilation unit. */
1117 const struct blockvector
*blockvector
;
1119 /* Section in objfile->section_offsets for the blockvector and
1120 the linetable. Probably always SECT_OFF_TEXT. */
1121 int block_line_section
;
1123 /* Symtab has been compiled with both optimizations and debug info so that
1124 GDB may stop skipping prologues as variables locations are valid already
1125 at function entry points. */
1126 unsigned int locations_valid
: 1;
1128 /* DWARF unwinder for this CU is valid even for epilogues (PC at the return
1129 instruction). This is supported by GCC since 4.5.0. */
1130 unsigned int epilogue_unwind_valid
: 1;
1132 /* struct call_site entries for this compilation unit or NULL. */
1133 htab_t call_site_htab
;
1135 /* The macro table for this symtab. Like the blockvector, this
1136 is shared between different symtabs in a given compilation unit.
1137 It's debatable whether it *should* be shared among all the symtabs in
1138 the given compilation unit, but it currently is. */
1139 struct macro_table
*macro_table
;
1141 /* If non-NULL, then this points to a NULL-terminated vector of
1142 included compunits. When searching the static or global
1143 block of this compunit, the corresponding block of all
1144 included compunits will also be searched. Note that this
1145 list must be flattened -- the symbol reader is responsible for
1146 ensuring that this vector contains the transitive closure of all
1147 included compunits. */
1148 struct compunit_symtab
**includes
;
1150 /* If this is an included compunit, this points to one includer
1151 of the table. This user is considered the canonical compunit
1152 containing this one. An included compunit may itself be
1153 included by another. */
1154 struct compunit_symtab
*user
;
1157 #define COMPUNIT_OBJFILE(cust) ((cust)->objfile)
1158 #define COMPUNIT_FILETABS(cust) ((cust)->filetabs)
1159 #define COMPUNIT_DEBUGFORMAT(cust) ((cust)->debugformat)
1160 #define COMPUNIT_PRODUCER(cust) ((cust)->producer)
1161 #define COMPUNIT_DIRNAME(cust) ((cust)->dirname)
1162 #define COMPUNIT_BLOCKVECTOR(cust) ((cust)->blockvector)
1163 #define COMPUNIT_BLOCK_LINE_SECTION(cust) ((cust)->block_line_section)
1164 #define COMPUNIT_LOCATIONS_VALID(cust) ((cust)->locations_valid)
1165 #define COMPUNIT_EPILOGUE_UNWIND_VALID(cust) ((cust)->epilogue_unwind_valid)
1166 #define COMPUNIT_CALL_SITE_HTAB(cust) ((cust)->call_site_htab)
1167 #define COMPUNIT_MACRO_TABLE(cust) ((cust)->macro_table)
1169 /* Iterate over all file tables (struct symtab) within a compunit. */
1171 #define ALL_COMPUNIT_FILETABS(cu, s) \
1172 for ((s) = (cu) -> filetabs; (s) != NULL; (s) = (s) -> next)
1174 /* Return the primary symtab of CUST. */
1176 extern struct symtab
*
1177 compunit_primary_filetab (const struct compunit_symtab
*cust
);
1179 /* Return the language of CUST. */
1181 extern enum language
compunit_language (const struct compunit_symtab
*cust
);
1183 typedef struct compunit_symtab
*compunit_symtab_ptr
;
1184 DEF_VEC_P (compunit_symtab_ptr
);
1188 /* The virtual function table is now an array of structures which have the
1189 form { int16 offset, delta; void *pfn; }.
1191 In normal virtual function tables, OFFSET is unused.
1192 DELTA is the amount which is added to the apparent object's base
1193 address in order to point to the actual object to which the
1194 virtual function should be applied.
1195 PFN is a pointer to the virtual function.
1197 Note that this macro is g++ specific (FIXME). */
1199 #define VTBL_FNADDR_OFFSET 2
1201 /* External variables and functions for the objects described above. */
1203 /* True if we are nested inside psymtab_to_symtab. */
1205 extern int currently_reading_symtab
;
1207 /* symtab.c lookup functions */
1209 extern const char multiple_symbols_ask
[];
1210 extern const char multiple_symbols_all
[];
1211 extern const char multiple_symbols_cancel
[];
1213 const char *multiple_symbols_select_mode (void);
1215 int symbol_matches_domain (enum language symbol_language
,
1216 domain_enum symbol_domain
,
1217 domain_enum domain
);
1219 /* lookup a symbol table by source file name. */
1221 extern struct symtab
*lookup_symtab (const char *);
1223 /* An object of this type is passed as the 'is_a_field_of_this'
1224 argument to lookup_symbol and lookup_symbol_in_language. */
1226 struct field_of_this_result
1228 /* The type in which the field was found. If this is NULL then the
1229 symbol was not found in 'this'. If non-NULL, then one of the
1230 other fields will be non-NULL as well. */
1234 /* If the symbol was found as an ordinary field of 'this', then this
1235 is non-NULL and points to the particular field. */
1237 struct field
*field
;
1239 /* If the symbol was found as a function field of 'this', then this
1240 is non-NULL and points to the particular field. */
1242 struct fn_fieldlist
*fn_field
;
1245 /* Find the definition for a specified symbol name NAME
1246 in domain DOMAIN in language LANGUAGE, visible from lexical block BLOCK
1247 if non-NULL or from global/static blocks if BLOCK is NULL.
1248 Returns the struct symbol pointer, or NULL if no symbol is found.
1249 C++: if IS_A_FIELD_OF_THIS is non-NULL on entry, check to see if
1250 NAME is a field of the current implied argument `this'. If so fill in the
1251 fields of IS_A_FIELD_OF_THIS, otherwise the fields are set to NULL.
1252 The symbol's section is fixed up if necessary. */
1254 extern struct block_symbol
1255 lookup_symbol_in_language (const char *,
1256 const struct block
*,
1259 struct field_of_this_result
*);
1261 /* Same as lookup_symbol_in_language, but using the current language. */
1263 extern struct block_symbol
lookup_symbol (const char *,
1264 const struct block
*,
1266 struct field_of_this_result
*);
1268 /* A default version of lookup_symbol_nonlocal for use by languages
1269 that can't think of anything better to do.
1270 This implements the C lookup rules. */
1272 extern struct block_symbol
1273 basic_lookup_symbol_nonlocal (const struct language_defn
*langdef
,
1275 const struct block
*,
1278 /* Some helper functions for languages that need to write their own
1279 lookup_symbol_nonlocal functions. */
1281 /* Lookup a symbol in the static block associated to BLOCK, if there
1282 is one; do nothing if BLOCK is NULL or a global block.
1283 Upon success fixes up the symbol's section if necessary. */
1285 extern struct block_symbol
1286 lookup_symbol_in_static_block (const char *name
,
1287 const struct block
*block
,
1288 const domain_enum domain
);
1290 /* Search all static file-level symbols for NAME from DOMAIN.
1291 Upon success fixes up the symbol's section if necessary. */
1293 extern struct block_symbol
lookup_static_symbol (const char *name
,
1294 const domain_enum domain
);
1296 /* Lookup a symbol in all files' global blocks.
1298 If BLOCK is non-NULL then it is used for two things:
1299 1) If a target-specific lookup routine for libraries exists, then use the
1300 routine for the objfile of BLOCK, and
1301 2) The objfile of BLOCK is used to assist in determining the search order
1302 if the target requires it.
1303 See gdbarch_iterate_over_objfiles_in_search_order.
1305 Upon success fixes up the symbol's section if necessary. */
1307 extern struct block_symbol
1308 lookup_global_symbol (const char *name
,
1309 const struct block
*block
,
1310 const domain_enum domain
);
1312 /* Lookup a symbol in block BLOCK.
1313 Upon success fixes up the symbol's section if necessary. */
1315 extern struct symbol
*
1316 lookup_symbol_in_block (const char *name
,
1317 const struct block
*block
,
1318 const domain_enum domain
);
1320 /* Look up the `this' symbol for LANG in BLOCK. Return the symbol if
1321 found, or NULL if not found. */
1323 extern struct block_symbol
1324 lookup_language_this (const struct language_defn
*lang
,
1325 const struct block
*block
);
1327 /* Lookup a [struct, union, enum] by name, within a specified block. */
1329 extern struct type
*lookup_struct (const char *, const struct block
*);
1331 extern struct type
*lookup_union (const char *, const struct block
*);
1333 extern struct type
*lookup_enum (const char *, const struct block
*);
1335 /* from blockframe.c: */
1337 /* lookup the function symbol corresponding to the address. */
1339 extern struct symbol
*find_pc_function (CORE_ADDR
);
1341 /* lookup the function corresponding to the address and section. */
1343 extern struct symbol
*find_pc_sect_function (CORE_ADDR
, struct obj_section
*);
1345 extern int find_pc_partial_function_gnu_ifunc (CORE_ADDR pc
, const char **name
,
1348 int *is_gnu_ifunc_p
);
1350 /* lookup function from address, return name, start addr and end addr. */
1352 extern int find_pc_partial_function (CORE_ADDR
, const char **, CORE_ADDR
*,
1355 extern void clear_pc_function_cache (void);
1357 /* Expand symtab containing PC, SECTION if not already expanded. */
1359 extern void expand_symtab_containing_pc (CORE_ADDR
, struct obj_section
*);
1361 /* lookup full symbol table by address. */
1363 extern struct compunit_symtab
*find_pc_compunit_symtab (CORE_ADDR
);
1365 /* lookup full symbol table by address and section. */
1367 extern struct compunit_symtab
*
1368 find_pc_sect_compunit_symtab (CORE_ADDR
, struct obj_section
*);
1370 extern int find_pc_line_pc_range (CORE_ADDR
, CORE_ADDR
*, CORE_ADDR
*);
1372 extern void reread_symbols (void);
1374 /* Look up a type named NAME in STRUCT_DOMAIN in the current language.
1375 The type returned must not be opaque -- i.e., must have at least one field
1378 extern struct type
*lookup_transparent_type (const char *);
1380 extern struct type
*basic_lookup_transparent_type (const char *);
1382 /* Macro for name of symbol to indicate a file compiled with gcc. */
1383 #ifndef GCC_COMPILED_FLAG_SYMBOL
1384 #define GCC_COMPILED_FLAG_SYMBOL "gcc_compiled."
1387 /* Macro for name of symbol to indicate a file compiled with gcc2. */
1388 #ifndef GCC2_COMPILED_FLAG_SYMBOL
1389 #define GCC2_COMPILED_FLAG_SYMBOL "gcc2_compiled."
1392 extern int in_gnu_ifunc_stub (CORE_ADDR pc
);
1394 /* Functions for resolving STT_GNU_IFUNC symbols which are implemented only
1395 for ELF symbol files. */
1397 struct gnu_ifunc_fns
1399 /* See elf_gnu_ifunc_resolve_addr for its real implementation. */
1400 CORE_ADDR (*gnu_ifunc_resolve_addr
) (struct gdbarch
*gdbarch
, CORE_ADDR pc
);
1402 /* See elf_gnu_ifunc_resolve_name for its real implementation. */
1403 int (*gnu_ifunc_resolve_name
) (const char *function_name
,
1404 CORE_ADDR
*function_address_p
);
1406 /* See elf_gnu_ifunc_resolver_stop for its real implementation. */
1407 void (*gnu_ifunc_resolver_stop
) (struct breakpoint
*b
);
1409 /* See elf_gnu_ifunc_resolver_return_stop for its real implementation. */
1410 void (*gnu_ifunc_resolver_return_stop
) (struct breakpoint
*b
);
1413 #define gnu_ifunc_resolve_addr gnu_ifunc_fns_p->gnu_ifunc_resolve_addr
1414 #define gnu_ifunc_resolve_name gnu_ifunc_fns_p->gnu_ifunc_resolve_name
1415 #define gnu_ifunc_resolver_stop gnu_ifunc_fns_p->gnu_ifunc_resolver_stop
1416 #define gnu_ifunc_resolver_return_stop \
1417 gnu_ifunc_fns_p->gnu_ifunc_resolver_return_stop
1419 extern const struct gnu_ifunc_fns
*gnu_ifunc_fns_p
;
1421 extern CORE_ADDR
find_solib_trampoline_target (struct frame_info
*, CORE_ADDR
);
1423 struct symtab_and_line
1425 /* The program space of this sal. */
1426 struct program_space
*pspace
= NULL
;
1428 struct symtab
*symtab
= NULL
;
1429 struct symbol
*symbol
= NULL
;
1430 struct obj_section
*section
= NULL
;
1431 /* Line number. Line numbers start at 1 and proceed through symtab->nlines.
1432 0 is never a valid line number; it is used to indicate that line number
1433 information is not available. */
1438 bool explicit_pc
= false;
1439 bool explicit_line
= false;
1441 /* The probe associated with this symtab_and_line. */
1442 struct probe
*probe
= NULL
;
1443 /* If PROBE is not NULL, then this is the objfile in which the probe
1445 struct objfile
*objfile
= NULL
;
1450 /* Given a pc value, return line number it is in. Second arg nonzero means
1451 if pc is on the boundary use the previous statement's line number. */
1453 extern struct symtab_and_line
find_pc_line (CORE_ADDR
, int);
1455 /* Same function, but specify a section as well as an address. */
1457 extern struct symtab_and_line
find_pc_sect_line (CORE_ADDR
,
1458 struct obj_section
*, int);
1460 /* Wrapper around find_pc_line to just return the symtab. */
1462 extern struct symtab
*find_pc_line_symtab (CORE_ADDR
);
1464 /* Given a symtab and line number, return the pc there. */
1466 extern int find_line_pc (struct symtab
*, int, CORE_ADDR
*);
1468 extern int find_line_pc_range (struct symtab_and_line
, CORE_ADDR
*,
1471 extern void resolve_sal_pc (struct symtab_and_line
*);
1475 extern void clear_solib (void);
1479 extern int identify_source_line (struct symtab
*, int, int, CORE_ADDR
);
1481 /* Flags passed as 4th argument to print_source_lines. */
1483 enum print_source_lines_flag
1485 /* Do not print an error message. */
1486 PRINT_SOURCE_LINES_NOERROR
= (1 << 0),
1488 /* Print the filename in front of the source lines. */
1489 PRINT_SOURCE_LINES_FILENAME
= (1 << 1)
1491 DEF_ENUM_FLAGS_TYPE (enum print_source_lines_flag
, print_source_lines_flags
);
1493 extern void print_source_lines (struct symtab
*, int, int,
1494 print_source_lines_flags
);
1496 extern void forget_cached_source_info_for_objfile (struct objfile
*);
1497 extern void forget_cached_source_info (void);
1499 extern void select_source_symtab (struct symtab
*);
1501 /* The reason we're calling into a completion match list collector
1503 enum class complete_symbol_mode
1505 /* Completing an expression. */
1508 /* Completing a linespec. */
1512 extern void default_collect_symbol_completion_matches_break_on
1513 (completion_tracker
&tracker
,
1514 complete_symbol_mode mode
,
1515 const char *text
, const char *word
, const char *break_on
,
1516 enum type_code code
);
1517 extern void default_collect_symbol_completion_matches
1518 (completion_tracker
&tracker
,
1519 complete_symbol_mode
,
1523 extern void collect_symbol_completion_matches (completion_tracker
&tracker
,
1524 complete_symbol_mode
,
1525 const char *, const char *);
1526 extern void collect_symbol_completion_matches_type (completion_tracker
&tracker
,
1527 const char *, const char *,
1530 extern void collect_file_symbol_completion_matches (completion_tracker
&tracker
,
1531 complete_symbol_mode
,
1536 extern completion_list
1537 make_source_files_completion_list (const char *, const char *);
1541 int matching_obj_sections (struct obj_section
*, struct obj_section
*);
1543 extern struct symtab
*find_line_symtab (struct symtab
*, int, int *, int *);
1545 extern struct symtab_and_line
find_function_start_sal (struct symbol
*sym
,
1548 extern void skip_prologue_sal (struct symtab_and_line
*);
1552 extern CORE_ADDR
skip_prologue_using_sal (struct gdbarch
*gdbarch
,
1553 CORE_ADDR func_addr
);
1555 extern struct symbol
*fixup_symbol_section (struct symbol
*,
1558 /* If MSYMBOL is an text symbol, look for a function debug symbol with
1559 the same address. Returns NULL if not found. This is necessary in
1560 case a function is an alias to some other function, because debug
1561 information is only emitted for the alias target function's
1562 definition, not for the alias. */
1563 extern symbol
*find_function_alias_target (bound_minimal_symbol msymbol
);
1565 /* Symbol searching */
1566 /* Note: struct symbol_search, search_symbols, et.al. are declared here,
1567 instead of making them local to symtab.c, for gdbtk's sake. */
1569 /* When using search_symbols, a vector of the following structs is
1571 struct symbol_search
1573 symbol_search (int block_
, struct symbol
*symbol_
)
1577 msymbol
.minsym
= nullptr;
1578 msymbol
.objfile
= nullptr;
1581 symbol_search (int block_
, struct minimal_symbol
*minsym
,
1582 struct objfile
*objfile
)
1586 msymbol
.minsym
= minsym
;
1587 msymbol
.objfile
= objfile
;
1590 bool operator< (const symbol_search
&other
) const
1592 return compare_search_syms (*this, other
) < 0;
1595 bool operator== (const symbol_search
&other
) const
1597 return compare_search_syms (*this, other
) == 0;
1600 /* The block in which the match was found. Could be, for example,
1601 STATIC_BLOCK or GLOBAL_BLOCK. */
1604 /* Information describing what was found.
1606 If symbol is NOT NULL, then information was found for this match. */
1607 struct symbol
*symbol
;
1609 /* If msymbol is non-null, then a match was made on something for
1610 which only minimal_symbols exist. */
1611 struct bound_minimal_symbol msymbol
;
1615 static int compare_search_syms (const symbol_search
&sym_a
,
1616 const symbol_search
&sym_b
);
1619 extern std::vector
<symbol_search
> search_symbols (const char *,
1620 enum search_domain
, int,
1623 /* The name of the ``main'' function.
1624 FIXME: cagney/2001-03-20: Can't make main_name() const since some
1625 of the calling code currently assumes that the string isn't
1627 extern /*const */ char *main_name (void);
1628 extern enum language
main_language (void);
1630 /* Lookup symbol NAME from DOMAIN in MAIN_OBJFILE's global blocks.
1631 This searches MAIN_OBJFILE as well as any associated separate debug info
1632 objfiles of MAIN_OBJFILE.
1633 Upon success fixes up the symbol's section if necessary. */
1635 extern struct block_symbol
1636 lookup_global_symbol_from_objfile (struct objfile
*main_objfile
,
1638 const domain_enum domain
);
1640 /* Return 1 if the supplied producer string matches the ARM RealView
1641 compiler (armcc). */
1642 int producer_is_realview (const char *producer
);
1644 void fixup_section (struct general_symbol_info
*ginfo
,
1645 CORE_ADDR addr
, struct objfile
*objfile
);
1647 /* Look up objfile containing BLOCK. */
1649 struct objfile
*lookup_objfile_from_block (const struct block
*block
);
1651 extern unsigned int symtab_create_debug
;
1653 extern unsigned int symbol_lookup_debug
;
1655 extern int basenames_may_differ
;
1657 int compare_filenames_for_search (const char *filename
,
1658 const char *search_name
);
1660 int compare_glob_filenames_for_search (const char *filename
,
1661 const char *search_name
);
1663 bool iterate_over_some_symtabs (const char *name
,
1664 const char *real_path
,
1665 struct compunit_symtab
*first
,
1666 struct compunit_symtab
*after_last
,
1667 gdb::function_view
<bool (symtab
*)> callback
);
1669 void iterate_over_symtabs (const char *name
,
1670 gdb::function_view
<bool (symtab
*)> callback
);
1673 std::vector
<CORE_ADDR
> find_pcs_for_symtab_line
1674 (struct symtab
*symtab
, int line
, struct linetable_entry
**best_entry
);
1676 /* Prototype for callbacks for LA_ITERATE_OVER_SYMBOLS. The callback
1677 is called once per matching symbol SYM. The callback should return
1678 true to indicate that LA_ITERATE_OVER_SYMBOLS should continue
1679 iterating, or false to indicate that the iteration should end. */
1681 typedef bool (symbol_found_callback_ftype
) (symbol
*sym
);
1683 void iterate_over_symbols (const struct block
*block
, const char *name
,
1684 const domain_enum domain
,
1685 gdb::function_view
<symbol_found_callback_ftype
> callback
);
1687 /* Storage type used by demangle_for_lookup. demangle_for_lookup
1688 either returns a const char * pointer that points to either of the
1689 fields of this type, or a pointer to the input NAME. This is done
1690 this way because the underlying functions that demangle_for_lookup
1691 calls either return a std::string (e.g., cp_canonicalize_string) or
1692 a malloc'ed buffer (libiberty's demangled), and we want to avoid
1693 unnecessary reallocation/string copying. */
1694 class demangle_result_storage
1698 /* Swap the std::string storage with STR, and return a pointer to
1699 the beginning of the new string. */
1700 const char *swap_string (std::string
&str
)
1702 std::swap (m_string
, str
);
1703 return m_string
.c_str ();
1706 /* Set the malloc storage to now point at PTR. Any previous malloc
1707 storage is released. */
1708 const char *set_malloc_ptr (char *ptr
)
1710 m_malloc
.reset (ptr
);
1717 std::string m_string
;
1718 gdb::unique_xmalloc_ptr
<char> m_malloc
;
1722 demangle_for_lookup (const char *name
, enum language lang
,
1723 demangle_result_storage
&storage
);
1725 struct symbol
*allocate_symbol (struct objfile
*);
1727 void initialize_objfile_symbol (struct symbol
*);
1729 struct template_symbol
*allocate_template_symbol (struct objfile
*);
1731 #endif /* !defined(SYMTAB_H) */