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 /* Classification types for a minimal symbol. These should be taken as
281 "advisory only", since if gdb can't easily figure out a
282 classification it simply selects mst_unknown. It may also have to
283 guess when it can't figure out which is a better match between two
284 types (mst_data versus mst_bss) for example. Since the minimal
285 symbol info is sometimes derived from the BFD library's view of a
286 file, we need to live with what information bfd supplies. */
288 enum minimal_symbol_type
290 mst_unknown
= 0, /* Unknown type, the default */
291 mst_text
, /* Generally executable instructions */
292 mst_text_gnu_ifunc
, /* Executable code returning address
293 of executable code */
294 mst_slot_got_plt
, /* GOT entries for .plt sections */
295 mst_data
, /* Generally initialized data */
296 mst_bss
, /* Generally uninitialized data */
297 mst_abs
, /* Generally absolute (nonrelocatable) */
298 /* GDB uses mst_solib_trampoline for the start address of a shared
299 library trampoline entry. Breakpoints for shared library functions
300 are put there if the shared library is not yet loaded.
301 After the shared library is loaded, lookup_minimal_symbol will
302 prefer the minimal symbol from the shared library (usually
303 a mst_text symbol) over the mst_solib_trampoline symbol, and the
304 breakpoints will be moved to their true address in the shared
305 library via breakpoint_re_set. */
306 mst_solib_trampoline
, /* Shared library trampoline code */
307 /* For the mst_file* types, the names are only guaranteed to be unique
308 within a given .o file. */
309 mst_file_text
, /* Static version of mst_text */
310 mst_file_data
, /* Static version of mst_data */
311 mst_file_bss
, /* Static version of mst_bss */
315 /* The number of enum minimal_symbol_type values, with some padding for
316 reasonable growth. */
317 #define MINSYM_TYPE_BITS 4
318 gdb_static_assert (nr_minsym_types
<= (1 << MINSYM_TYPE_BITS
));
320 /* Define a simple structure used to hold some very basic information about
321 all defined global symbols (text, data, bss, abs, etc). The only required
322 information is the general_symbol_info.
324 In many cases, even if a file was compiled with no special options for
325 debugging at all, as long as was not stripped it will contain sufficient
326 information to build a useful minimal symbol table using this structure.
327 Even when a file contains enough debugging information to build a full
328 symbol table, these minimal symbols are still useful for quickly mapping
329 between names and addresses, and vice versa. They are also sometimes
330 used to figure out what full symbol table entries need to be read in. */
332 struct minimal_symbol
335 /* The general symbol info required for all types of symbols.
337 The SYMBOL_VALUE_ADDRESS contains the address that this symbol
340 struct general_symbol_info mginfo
;
342 /* Size of this symbol. dbx_end_psymtab in dbxread.c uses this
343 information to calculate the end of the partial symtab based on the
344 address of the last symbol plus the size of the last symbol. */
348 /* Which source file is this symbol in? Only relevant for mst_file_*. */
349 const char *filename
;
351 /* Classification type for this minimal symbol. */
353 ENUM_BITFIELD(minimal_symbol_type
) type
: MINSYM_TYPE_BITS
;
355 /* Non-zero if this symbol was created by gdb.
356 Such symbols do not appear in the output of "info var|fun". */
357 unsigned int created_by_gdb
: 1;
359 /* Two flag bits provided for the use of the target. */
360 unsigned int target_flag_1
: 1;
361 unsigned int target_flag_2
: 1;
363 /* Nonzero iff the size of the minimal symbol has been set.
364 Symbol size information can sometimes not be determined, because
365 the object file format may not carry that piece of information. */
366 unsigned int has_size
: 1;
368 /* Minimal symbols with the same hash key are kept on a linked
369 list. This is the link. */
371 struct minimal_symbol
*hash_next
;
373 /* Minimal symbols are stored in two different hash tables. This is
374 the `next' pointer for the demangled hash table. */
376 struct minimal_symbol
*demangled_hash_next
;
379 #define MSYMBOL_TARGET_FLAG_1(msymbol) (msymbol)->target_flag_1
380 #define MSYMBOL_TARGET_FLAG_2(msymbol) (msymbol)->target_flag_2
381 #define MSYMBOL_SIZE(msymbol) ((msymbol)->size + 0)
382 #define SET_MSYMBOL_SIZE(msymbol, sz) \
385 (msymbol)->size = sz; \
386 (msymbol)->has_size = 1; \
388 #define MSYMBOL_HAS_SIZE(msymbol) ((msymbol)->has_size + 0)
389 #define MSYMBOL_TYPE(msymbol) (msymbol)->type
391 #define MSYMBOL_VALUE(symbol) (symbol)->mginfo.value.ivalue
392 /* The unrelocated address of the minimal symbol. */
393 #define MSYMBOL_VALUE_RAW_ADDRESS(symbol) ((symbol)->mginfo.value.address + 0)
394 /* The relocated address of the minimal symbol, using the section
395 offsets from OBJFILE. */
396 #define MSYMBOL_VALUE_ADDRESS(objfile, symbol) \
397 ((symbol)->mginfo.value.address \
398 + ANOFFSET ((objfile)->section_offsets, ((symbol)->mginfo.section)))
399 /* For a bound minsym, we can easily compute the address directly. */
400 #define BMSYMBOL_VALUE_ADDRESS(symbol) \
401 MSYMBOL_VALUE_ADDRESS ((symbol).objfile, (symbol).minsym)
402 #define SET_MSYMBOL_VALUE_ADDRESS(symbol, new_value) \
403 ((symbol)->mginfo.value.address = (new_value))
404 #define MSYMBOL_VALUE_BYTES(symbol) (symbol)->mginfo.value.bytes
405 #define MSYMBOL_BLOCK_VALUE(symbol) (symbol)->mginfo.value.block
406 #define MSYMBOL_VALUE_CHAIN(symbol) (symbol)->mginfo.value.chain
407 #define MSYMBOL_LANGUAGE(symbol) (symbol)->mginfo.language
408 #define MSYMBOL_SECTION(symbol) (symbol)->mginfo.section
409 #define MSYMBOL_OBJ_SECTION(objfile, symbol) \
410 (((symbol)->mginfo.section >= 0) \
411 ? (&(((objfile)->sections)[(symbol)->mginfo.section])) \
414 #define MSYMBOL_NATURAL_NAME(symbol) \
415 (symbol_natural_name (&(symbol)->mginfo))
416 #define MSYMBOL_LINKAGE_NAME(symbol) (symbol)->mginfo.name
417 #define MSYMBOL_PRINT_NAME(symbol) \
418 (demangle ? MSYMBOL_NATURAL_NAME (symbol) : MSYMBOL_LINKAGE_NAME (symbol))
419 #define MSYMBOL_DEMANGLED_NAME(symbol) \
420 (symbol_demangled_name (&(symbol)->mginfo))
421 #define MSYMBOL_SET_LANGUAGE(symbol,language,obstack) \
422 (symbol_set_language (&(symbol)->mginfo, (language), (obstack)))
423 #define MSYMBOL_SEARCH_NAME(symbol) \
424 (symbol_search_name (&(symbol)->mginfo))
425 #define MSYMBOL_MATCHES_SEARCH_NAME(symbol, name) \
426 (strcmp_iw (MSYMBOL_SEARCH_NAME (symbol), (name)) == 0)
427 #define MSYMBOL_SET_NAMES(symbol,linkage_name,len,copy_name,objfile) \
428 symbol_set_names (&(symbol)->mginfo, linkage_name, len, copy_name, objfile)
434 /* Represent one symbol name; a variable, constant, function or typedef. */
436 /* Different name domains for symbols. Looking up a symbol specifies a
437 domain and ignores symbol definitions in other name domains. */
439 typedef enum domain_enum_tag
441 /* UNDEF_DOMAIN is used when a domain has not been discovered or
442 none of the following apply. This usually indicates an error either
443 in the symbol information or in gdb's handling of symbols. */
447 /* VAR_DOMAIN is the usual domain. In C, this contains variables,
448 function names, typedef names and enum type values. */
452 /* STRUCT_DOMAIN is used in C to hold struct, union and enum type names.
453 Thus, if `struct foo' is used in a C program, it produces a symbol named
454 `foo' in the STRUCT_DOMAIN. */
458 /* MODULE_DOMAIN is used in Fortran to hold module type names. */
462 /* LABEL_DOMAIN may be used for names of labels (for gotos). */
466 /* Fortran common blocks. Their naming must be separate from VAR_DOMAIN.
467 They also always use LOC_COMMON_BLOCK. */
470 /* This must remain last. */
474 /* The number of bits in a symbol used to represent the domain. */
476 #define SYMBOL_DOMAIN_BITS 3
477 gdb_static_assert (NR_DOMAINS
<= (1 << SYMBOL_DOMAIN_BITS
));
479 extern const char *domain_name (domain_enum
);
481 /* Searching domains, used for `search_symbols'. Element numbers are
482 hardcoded in GDB, check all enum uses before changing it. */
486 /* Everything in VAR_DOMAIN minus FUNCTIONS_DOMAIN and
488 VARIABLES_DOMAIN
= 0,
490 /* All functions -- for some reason not methods, though. */
491 FUNCTIONS_DOMAIN
= 1,
493 /* All defined types */
500 extern const char *search_domain_name (enum search_domain
);
502 /* An address-class says where to find the value of a symbol. */
506 /* Not used; catches errors. */
510 /* Value is constant int SYMBOL_VALUE, host byteorder. */
514 /* Value is at fixed address SYMBOL_VALUE_ADDRESS. */
518 /* Value is in register. SYMBOL_VALUE is the register number
519 in the original debug format. SYMBOL_REGISTER_OPS holds a
520 function that can be called to transform this into the
521 actual register number this represents in a specific target
522 architecture (gdbarch).
524 For some symbol formats (stabs, for some compilers at least),
525 the compiler generates two symbols, an argument and a register.
526 In some cases we combine them to a single LOC_REGISTER in symbol
527 reading, but currently not for all cases (e.g. it's passed on the
528 stack and then loaded into a register). */
532 /* It's an argument; the value is at SYMBOL_VALUE offset in arglist. */
536 /* Value address is at SYMBOL_VALUE offset in arglist. */
540 /* Value is in specified register. Just like LOC_REGISTER except the
541 register holds the address of the argument instead of the argument
542 itself. This is currently used for the passing of structs and unions
543 on sparc and hppa. It is also used for call by reference where the
544 address is in a register, at least by mipsread.c. */
548 /* Value is a local variable at SYMBOL_VALUE offset in stack frame. */
552 /* Value not used; definition in SYMBOL_TYPE. Symbols in the domain
553 STRUCT_DOMAIN all have this class. */
557 /* Value is address SYMBOL_VALUE_ADDRESS in the code. */
561 /* In a symbol table, value is SYMBOL_BLOCK_VALUE of a `struct block'.
562 In a partial symbol table, SYMBOL_VALUE_ADDRESS is the start address
563 of the block. Function names have this class. */
567 /* Value is a constant byte-sequence pointed to by SYMBOL_VALUE_BYTES, in
568 target byte order. */
572 /* Value is at fixed address, but the address of the variable has
573 to be determined from the minimal symbol table whenever the
574 variable is referenced.
575 This happens if debugging information for a global symbol is
576 emitted and the corresponding minimal symbol is defined
577 in another object file or runtime common storage.
578 The linker might even remove the minimal symbol if the global
579 symbol is never referenced, in which case the symbol remains
582 GDB would normally find the symbol in the minimal symbol table if it will
583 not find it in the full symbol table. But a reference to an external
584 symbol in a local block shadowing other definition requires full symbol
585 without possibly having its address available for LOC_STATIC. Testcase
586 is provided as `gdb.dwarf2/dw2-unresolved.exp'.
588 This is also used for thread local storage (TLS) variables. In this case,
589 the address of the TLS variable must be determined when the variable is
590 referenced, from the MSYMBOL_VALUE_RAW_ADDRESS, which is the offset
591 of the TLS variable in the thread local storage of the shared
596 /* The variable does not actually exist in the program.
597 The value is ignored. */
601 /* The variable's address is computed by a set of location
602 functions (see "struct symbol_computed_ops" below). */
605 /* The variable uses general_symbol_info->value->common_block field.
606 It also always uses COMMON_BLOCK_DOMAIN. */
609 /* Not used, just notes the boundary of the enum. */
613 /* The number of bits needed for values in enum address_class, with some
614 padding for reasonable growth, and room for run-time registered address
615 classes. See symtab.c:MAX_SYMBOL_IMPLS.
616 This is a #define so that we can have a assertion elsewhere to
617 verify that we have reserved enough space for synthetic address
619 #define SYMBOL_ACLASS_BITS 5
620 gdb_static_assert (LOC_FINAL_VALUE
<= (1 << SYMBOL_ACLASS_BITS
));
622 /* The methods needed to implement LOC_COMPUTED. These methods can
623 use the symbol's .aux_value for additional per-symbol information.
625 At present this is only used to implement location expressions. */
627 struct symbol_computed_ops
630 /* Return the value of the variable SYMBOL, relative to the stack
631 frame FRAME. If the variable has been optimized out, return
634 Iff `read_needs_frame (SYMBOL)' is not SYMBOL_NEEDS_FRAME, then
635 FRAME may be zero. */
637 struct value
*(*read_variable
) (struct symbol
* symbol
,
638 struct frame_info
* frame
);
640 /* Read variable SYMBOL like read_variable at (callee) FRAME's function
641 entry. SYMBOL should be a function parameter, otherwise
642 NO_ENTRY_VALUE_ERROR will be thrown. */
643 struct value
*(*read_variable_at_entry
) (struct symbol
*symbol
,
644 struct frame_info
*frame
);
646 /* Find the "symbol_needs_kind" value for the given symbol. This
647 value determines whether reading the symbol needs memory (e.g., a
648 global variable), just registers (a thread-local), or a frame (a
650 enum symbol_needs_kind (*get_symbol_read_needs
) (struct symbol
* symbol
);
652 /* Write to STREAM a natural-language description of the location of
653 SYMBOL, in the context of ADDR. */
654 void (*describe_location
) (struct symbol
* symbol
, CORE_ADDR addr
,
655 struct ui_file
* stream
);
657 /* Non-zero if this symbol's address computation is dependent on PC. */
658 unsigned char location_has_loclist
;
660 /* Tracepoint support. Append bytecodes to the tracepoint agent
661 expression AX that push the address of the object SYMBOL. Set
662 VALUE appropriately. Note --- for objects in registers, this
663 needn't emit any code; as long as it sets VALUE properly, then
664 the caller will generate the right code in the process of
665 treating this as an lvalue or rvalue. */
667 void (*tracepoint_var_ref
) (struct symbol
*symbol
, struct agent_expr
*ax
,
668 struct axs_value
*value
);
670 /* Generate C code to compute the location of SYMBOL. The C code is
671 emitted to STREAM. GDBARCH is the current architecture and PC is
672 the PC at which SYMBOL's location should be evaluated.
673 REGISTERS_USED is a vector indexed by register number; the
674 generator function should set an element in this vector if the
675 corresponding register is needed by the location computation.
676 The generated C code must assign the location to a local
677 variable; this variable's name is RESULT_NAME. */
679 void (*generate_c_location
) (struct symbol
*symbol
, string_file
&stream
,
680 struct gdbarch
*gdbarch
,
681 unsigned char *registers_used
,
682 CORE_ADDR pc
, const char *result_name
);
686 /* The methods needed to implement LOC_BLOCK for inferior functions.
687 These methods can use the symbol's .aux_value for additional
688 per-symbol information. */
690 struct symbol_block_ops
692 /* Fill in *START and *LENGTH with DWARF block data of function
693 FRAMEFUNC valid for inferior context address PC. Set *LENGTH to
694 zero if such location is not valid for PC; *START is left
695 uninitialized in such case. */
696 void (*find_frame_base_location
) (struct symbol
*framefunc
, CORE_ADDR pc
,
697 const gdb_byte
**start
, size_t *length
);
699 /* Return the frame base address. FRAME is the frame for which we want to
700 compute the base address while FRAMEFUNC is the symbol for the
701 corresponding function. Return 0 on failure (FRAMEFUNC may not hold the
702 information we need).
704 This method is designed to work with static links (nested functions
705 handling). Static links are function properties whose evaluation returns
706 the frame base address for the enclosing frame. However, there are
707 multiple definitions for "frame base": the content of the frame base
708 register, the CFA as defined by DWARF unwinding information, ...
710 So this specific method is supposed to compute the frame base address such
711 as for nested fuctions, the static link computes the same address. For
712 instance, considering DWARF debugging information, the static link is
713 computed with DW_AT_static_link and this method must be used to compute
714 the corresponding DW_AT_frame_base attribute. */
715 CORE_ADDR (*get_frame_base
) (struct symbol
*framefunc
,
716 struct frame_info
*frame
);
719 /* Functions used with LOC_REGISTER and LOC_REGPARM_ADDR. */
721 struct symbol_register_ops
723 int (*register_number
) (struct symbol
*symbol
, struct gdbarch
*gdbarch
);
726 /* Objects of this type are used to find the address class and the
727 various computed ops vectors of a symbol. */
731 enum address_class aclass
;
733 /* Used with LOC_COMPUTED. */
734 const struct symbol_computed_ops
*ops_computed
;
736 /* Used with LOC_BLOCK. */
737 const struct symbol_block_ops
*ops_block
;
739 /* Used with LOC_REGISTER and LOC_REGPARM_ADDR. */
740 const struct symbol_register_ops
*ops_register
;
743 /* This structure is space critical. See space comments at the top. */
748 /* The general symbol info required for all types of symbols. */
750 struct general_symbol_info ginfo
;
752 /* Data type of value */
756 /* The owner of this symbol.
757 Which one to use is defined by symbol.is_objfile_owned. */
761 /* The symbol table containing this symbol. This is the file associated
762 with LINE. It can be NULL during symbols read-in but it is never NULL
763 during normal operation. */
764 struct symtab
*symtab
;
766 /* For types defined by the architecture. */
767 struct gdbarch
*arch
;
772 ENUM_BITFIELD(domain_enum_tag
) domain
: SYMBOL_DOMAIN_BITS
;
774 /* Address class. This holds an index into the 'symbol_impls'
775 table. The actual enum address_class value is stored there,
776 alongside any per-class ops vectors. */
778 unsigned int aclass_index
: SYMBOL_ACLASS_BITS
;
780 /* If non-zero then symbol is objfile-owned, use owner.symtab.
781 Otherwise symbol is arch-owned, use owner.arch. */
783 unsigned int is_objfile_owned
: 1;
785 /* Whether this is an argument. */
787 unsigned is_argument
: 1;
789 /* Whether this is an inlined function (class LOC_BLOCK only). */
790 unsigned is_inlined
: 1;
792 /* True if this is a C++ function symbol with template arguments.
793 In this case the symbol is really a "struct template_symbol". */
794 unsigned is_cplus_template_function
: 1;
796 /* Line number of this symbol's definition, except for inlined
797 functions. For an inlined function (class LOC_BLOCK and
798 SYMBOL_INLINED set) this is the line number of the function's call
799 site. Inlined function symbols are not definitions, and they are
800 never found by symbol table lookup.
801 If this symbol is arch-owned, LINE shall be zero.
803 FIXME: Should we really make the assumption that nobody will try
804 to debug files longer than 64K lines? What about machine
805 generated programs? */
809 /* An arbitrary data pointer, allowing symbol readers to record
810 additional information on a per-symbol basis. Note that this data
811 must be allocated using the same obstack as the symbol itself. */
812 /* So far it is only used by:
813 LOC_COMPUTED: to find the location information
814 LOC_BLOCK (DWARF2 function): information used internally by the
815 DWARF 2 code --- specifically, the location expression for the frame
816 base for this function. */
817 /* FIXME drow/2003-02-21: For the LOC_BLOCK case, it might be better
818 to add a magic symbol to the block containing this information,
819 or to have a generic debug info annotation slot for symbols. */
823 struct symbol
*hash_next
;
826 /* Several lookup functions return both a symbol and the block in which the
827 symbol is found. This structure is used in these cases. */
831 /* The symbol that was found, or NULL if no symbol was found. */
832 struct symbol
*symbol
;
834 /* If SYMBOL is not NULL, then this is the block in which the symbol is
836 const struct block
*block
;
839 extern const struct symbol_impl
*symbol_impls
;
841 /* For convenience. All fields are NULL. This means "there is no
843 extern const struct block_symbol null_block_symbol
;
845 /* Note: There is no accessor macro for symbol.owner because it is
848 #define SYMBOL_DOMAIN(symbol) (symbol)->domain
849 #define SYMBOL_IMPL(symbol) (symbol_impls[(symbol)->aclass_index])
850 #define SYMBOL_ACLASS_INDEX(symbol) (symbol)->aclass_index
851 #define SYMBOL_CLASS(symbol) (SYMBOL_IMPL (symbol).aclass)
852 #define SYMBOL_OBJFILE_OWNED(symbol) ((symbol)->is_objfile_owned)
853 #define SYMBOL_IS_ARGUMENT(symbol) (symbol)->is_argument
854 #define SYMBOL_INLINED(symbol) (symbol)->is_inlined
855 #define SYMBOL_IS_CPLUS_TEMPLATE_FUNCTION(symbol) \
856 (symbol)->is_cplus_template_function
857 #define SYMBOL_TYPE(symbol) (symbol)->type
858 #define SYMBOL_LINE(symbol) (symbol)->line
859 #define SYMBOL_COMPUTED_OPS(symbol) (SYMBOL_IMPL (symbol).ops_computed)
860 #define SYMBOL_BLOCK_OPS(symbol) (SYMBOL_IMPL (symbol).ops_block)
861 #define SYMBOL_REGISTER_OPS(symbol) (SYMBOL_IMPL (symbol).ops_register)
862 #define SYMBOL_LOCATION_BATON(symbol) (symbol)->aux_value
864 extern int register_symbol_computed_impl (enum address_class
,
865 const struct symbol_computed_ops
*);
867 extern int register_symbol_block_impl (enum address_class aclass
,
868 const struct symbol_block_ops
*ops
);
870 extern int register_symbol_register_impl (enum address_class
,
871 const struct symbol_register_ops
*);
873 /* Return the OBJFILE of SYMBOL.
874 It is an error to call this if symbol.is_objfile_owned is false, which
875 only happens for architecture-provided types. */
877 extern struct objfile
*symbol_objfile (const struct symbol
*symbol
);
879 /* Return the ARCH of SYMBOL. */
881 extern struct gdbarch
*symbol_arch (const struct symbol
*symbol
);
883 /* Return the SYMTAB of SYMBOL.
884 It is an error to call this if symbol.is_objfile_owned is false, which
885 only happens for architecture-provided types. */
887 extern struct symtab
*symbol_symtab (const struct symbol
*symbol
);
889 /* Set the symtab of SYMBOL to SYMTAB.
890 It is an error to call this if symbol.is_objfile_owned is false, which
891 only happens for architecture-provided types. */
893 extern void symbol_set_symtab (struct symbol
*symbol
, struct symtab
*symtab
);
895 /* An instance of this type is used to represent a C++ template
896 function. It includes a "struct symbol" as a kind of base class;
897 users downcast to "struct template_symbol *" when needed. A symbol
898 is really of this type iff SYMBOL_IS_CPLUS_TEMPLATE_FUNCTION is
901 struct template_symbol
903 /* The base class. */
906 /* The number of template arguments. */
907 int n_template_arguments
;
909 /* The template arguments. This is an array with
910 N_TEMPLATE_ARGUMENTS elements. */
911 struct symbol
**template_arguments
;
915 /* Each item represents a line-->pc (or the reverse) mapping. This is
916 somewhat more wasteful of space than one might wish, but since only
917 the files which are actually debugged are read in to core, we don't
920 struct linetable_entry
926 /* The order of entries in the linetable is significant. They should
927 be sorted by increasing values of the pc field. If there is more than
928 one entry for a given pc, then I'm not sure what should happen (and
929 I not sure whether we currently handle it the best way).
931 Example: a C for statement generally looks like this
933 10 0x100 - for the init/test part of a for stmt.
936 10 0x400 - for the increment part of a for stmt.
938 If an entry has a line number of zero, it marks the start of a PC
939 range for which no line number information is available. It is
940 acceptable, though wasteful of table space, for such a range to be
947 /* Actually NITEMS elements. If you don't like this use of the
948 `struct hack', you can shove it up your ANSI (seriously, if the
949 committee tells us how to do it, we can probably go along). */
950 struct linetable_entry item
[1];
953 /* How to relocate the symbols from each section in a symbol file.
954 Each struct contains an array of offsets.
955 The ordering and meaning of the offsets is file-type-dependent;
956 typically it is indexed by section numbers or symbol types or
959 To give us flexibility in changing the internal representation
960 of these offsets, the ANOFFSET macro must be used to insert and
961 extract offset values in the struct. */
963 struct section_offsets
965 CORE_ADDR offsets
[1]; /* As many as needed. */
968 #define ANOFFSET(secoff, whichone) \
970 ? (internal_error (__FILE__, __LINE__, \
971 _("Section index is uninitialized")), -1) \
972 : secoff->offsets[whichone])
974 /* The size of a section_offsets table for N sections. */
975 #define SIZEOF_N_SECTION_OFFSETS(n) \
976 (sizeof (struct section_offsets) \
977 + sizeof (((struct section_offsets *) 0)->offsets) * ((n)-1))
979 /* Each source file or header is represented by a struct symtab.
980 The name "symtab" is historical, another name for it is "filetab".
981 These objects are chained through the `next' field. */
985 /* Unordered chain of all filetabs in the compunit, with the exception
986 that the "main" source file is the first entry in the list. */
990 /* Backlink to containing compunit symtab. */
992 struct compunit_symtab
*compunit_symtab
;
994 /* Table mapping core addresses to line numbers for this file.
995 Can be NULL if none. Never shared between different symtabs. */
997 struct linetable
*linetable
;
999 /* Name of this source file. This pointer is never NULL. */
1001 const char *filename
;
1003 /* Total number of lines found in source file. */
1007 /* line_charpos[N] is the position of the (N-1)th line of the
1008 source file. "position" means something we can lseek() to; it
1009 is not guaranteed to be useful any other way. */
1013 /* Language of this source file. */
1015 enum language language
;
1017 /* Full name of file as found by searching the source path.
1018 NULL if not yet known. */
1023 #define SYMTAB_COMPUNIT(symtab) ((symtab)->compunit_symtab)
1024 #define SYMTAB_LINETABLE(symtab) ((symtab)->linetable)
1025 #define SYMTAB_LANGUAGE(symtab) ((symtab)->language)
1026 #define SYMTAB_BLOCKVECTOR(symtab) \
1027 COMPUNIT_BLOCKVECTOR (SYMTAB_COMPUNIT (symtab))
1028 #define SYMTAB_OBJFILE(symtab) \
1029 COMPUNIT_OBJFILE (SYMTAB_COMPUNIT (symtab))
1030 #define SYMTAB_PSPACE(symtab) (SYMTAB_OBJFILE (symtab)->pspace)
1031 #define SYMTAB_DIRNAME(symtab) \
1032 COMPUNIT_DIRNAME (SYMTAB_COMPUNIT (symtab))
1034 typedef struct symtab
*symtab_ptr
;
1035 DEF_VEC_P (symtab_ptr
);
1037 /* Compunit symtabs contain the actual "symbol table", aka blockvector, as well
1038 as the list of all source files (what gdb has historically associated with
1040 Additional information is recorded here that is common to all symtabs in a
1041 compilation unit (DWARF or otherwise).
1044 For the case of a program built out of these files:
1053 This is recorded as:
1055 objfile -> foo.c(cu) -> bar.c(cu) -> NULL
1069 where "foo.c(cu)" and "bar.c(cu)" are struct compunit_symtab objects,
1070 and the files foo.c, etc. are struct symtab objects. */
1072 struct compunit_symtab
1074 /* Unordered chain of all compunit symtabs of this objfile. */
1075 struct compunit_symtab
*next
;
1077 /* Object file from which this symtab information was read. */
1078 struct objfile
*objfile
;
1080 /* Name of the symtab.
1081 This is *not* intended to be a usable filename, and is
1082 for debugging purposes only. */
1085 /* Unordered list of file symtabs, except that by convention the "main"
1086 source file (e.g., .c, .cc) is guaranteed to be first.
1087 Each symtab is a file, either the "main" source file (e.g., .c, .cc)
1088 or header (e.g., .h). */
1089 struct symtab
*filetabs
;
1091 /* Last entry in FILETABS list.
1092 Subfiles are added to the end of the list so they accumulate in order,
1093 with the main source subfile living at the front.
1094 The main reason is so that the main source file symtab is at the head
1095 of the list, and the rest appear in order for debugging convenience. */
1096 struct symtab
*last_filetab
;
1098 /* Non-NULL string that identifies the format of the debugging information,
1099 such as "stabs", "dwarf 1", "dwarf 2", "coff", etc. This is mostly useful
1100 for automated testing of gdb but may also be information that is
1101 useful to the user. */
1102 const char *debugformat
;
1104 /* String of producer version information, or NULL if we don't know. */
1105 const char *producer
;
1107 /* Directory in which it was compiled, or NULL if we don't know. */
1108 const char *dirname
;
1110 /* List of all symbol scope blocks for this symtab. It is shared among
1111 all symtabs in a given compilation unit. */
1112 const struct blockvector
*blockvector
;
1114 /* Section in objfile->section_offsets for the blockvector and
1115 the linetable. Probably always SECT_OFF_TEXT. */
1116 int block_line_section
;
1118 /* Symtab has been compiled with both optimizations and debug info so that
1119 GDB may stop skipping prologues as variables locations are valid already
1120 at function entry points. */
1121 unsigned int locations_valid
: 1;
1123 /* DWARF unwinder for this CU is valid even for epilogues (PC at the return
1124 instruction). This is supported by GCC since 4.5.0. */
1125 unsigned int epilogue_unwind_valid
: 1;
1127 /* struct call_site entries for this compilation unit or NULL. */
1128 htab_t call_site_htab
;
1130 /* The macro table for this symtab. Like the blockvector, this
1131 is shared between different symtabs in a given compilation unit.
1132 It's debatable whether it *should* be shared among all the symtabs in
1133 the given compilation unit, but it currently is. */
1134 struct macro_table
*macro_table
;
1136 /* If non-NULL, then this points to a NULL-terminated vector of
1137 included compunits. When searching the static or global
1138 block of this compunit, the corresponding block of all
1139 included compunits will also be searched. Note that this
1140 list must be flattened -- the symbol reader is responsible for
1141 ensuring that this vector contains the transitive closure of all
1142 included compunits. */
1143 struct compunit_symtab
**includes
;
1145 /* If this is an included compunit, this points to one includer
1146 of the table. This user is considered the canonical compunit
1147 containing this one. An included compunit may itself be
1148 included by another. */
1149 struct compunit_symtab
*user
;
1152 #define COMPUNIT_OBJFILE(cust) ((cust)->objfile)
1153 #define COMPUNIT_FILETABS(cust) ((cust)->filetabs)
1154 #define COMPUNIT_DEBUGFORMAT(cust) ((cust)->debugformat)
1155 #define COMPUNIT_PRODUCER(cust) ((cust)->producer)
1156 #define COMPUNIT_DIRNAME(cust) ((cust)->dirname)
1157 #define COMPUNIT_BLOCKVECTOR(cust) ((cust)->blockvector)
1158 #define COMPUNIT_BLOCK_LINE_SECTION(cust) ((cust)->block_line_section)
1159 #define COMPUNIT_LOCATIONS_VALID(cust) ((cust)->locations_valid)
1160 #define COMPUNIT_EPILOGUE_UNWIND_VALID(cust) ((cust)->epilogue_unwind_valid)
1161 #define COMPUNIT_CALL_SITE_HTAB(cust) ((cust)->call_site_htab)
1162 #define COMPUNIT_MACRO_TABLE(cust) ((cust)->macro_table)
1164 /* Iterate over all file tables (struct symtab) within a compunit. */
1166 #define ALL_COMPUNIT_FILETABS(cu, s) \
1167 for ((s) = (cu) -> filetabs; (s) != NULL; (s) = (s) -> next)
1169 /* Return the primary symtab of CUST. */
1171 extern struct symtab
*
1172 compunit_primary_filetab (const struct compunit_symtab
*cust
);
1174 /* Return the language of CUST. */
1176 extern enum language
compunit_language (const struct compunit_symtab
*cust
);
1178 typedef struct compunit_symtab
*compunit_symtab_ptr
;
1179 DEF_VEC_P (compunit_symtab_ptr
);
1183 /* The virtual function table is now an array of structures which have the
1184 form { int16 offset, delta; void *pfn; }.
1186 In normal virtual function tables, OFFSET is unused.
1187 DELTA is the amount which is added to the apparent object's base
1188 address in order to point to the actual object to which the
1189 virtual function should be applied.
1190 PFN is a pointer to the virtual function.
1192 Note that this macro is g++ specific (FIXME). */
1194 #define VTBL_FNADDR_OFFSET 2
1196 /* External variables and functions for the objects described above. */
1198 /* True if we are nested inside psymtab_to_symtab. */
1200 extern int currently_reading_symtab
;
1202 /* symtab.c lookup functions */
1204 extern const char multiple_symbols_ask
[];
1205 extern const char multiple_symbols_all
[];
1206 extern const char multiple_symbols_cancel
[];
1208 const char *multiple_symbols_select_mode (void);
1210 int symbol_matches_domain (enum language symbol_language
,
1211 domain_enum symbol_domain
,
1212 domain_enum domain
);
1214 /* lookup a symbol table by source file name. */
1216 extern struct symtab
*lookup_symtab (const char *);
1218 /* An object of this type is passed as the 'is_a_field_of_this'
1219 argument to lookup_symbol and lookup_symbol_in_language. */
1221 struct field_of_this_result
1223 /* The type in which the field was found. If this is NULL then the
1224 symbol was not found in 'this'. If non-NULL, then one of the
1225 other fields will be non-NULL as well. */
1229 /* If the symbol was found as an ordinary field of 'this', then this
1230 is non-NULL and points to the particular field. */
1232 struct field
*field
;
1234 /* If the symbol was found as a function field of 'this', then this
1235 is non-NULL and points to the particular field. */
1237 struct fn_fieldlist
*fn_field
;
1240 /* Find the definition for a specified symbol name NAME
1241 in domain DOMAIN in language LANGUAGE, visible from lexical block BLOCK
1242 if non-NULL or from global/static blocks if BLOCK is NULL.
1243 Returns the struct symbol pointer, or NULL if no symbol is found.
1244 C++: if IS_A_FIELD_OF_THIS is non-NULL on entry, check to see if
1245 NAME is a field of the current implied argument `this'. If so fill in the
1246 fields of IS_A_FIELD_OF_THIS, otherwise the fields are set to NULL.
1247 The symbol's section is fixed up if necessary. */
1249 extern struct block_symbol
1250 lookup_symbol_in_language (const char *,
1251 const struct block
*,
1254 struct field_of_this_result
*);
1256 /* Same as lookup_symbol_in_language, but using the current language. */
1258 extern struct block_symbol
lookup_symbol (const char *,
1259 const struct block
*,
1261 struct field_of_this_result
*);
1263 /* A default version of lookup_symbol_nonlocal for use by languages
1264 that can't think of anything better to do.
1265 This implements the C lookup rules. */
1267 extern struct block_symbol
1268 basic_lookup_symbol_nonlocal (const struct language_defn
*langdef
,
1270 const struct block
*,
1273 /* Some helper functions for languages that need to write their own
1274 lookup_symbol_nonlocal functions. */
1276 /* Lookup a symbol in the static block associated to BLOCK, if there
1277 is one; do nothing if BLOCK is NULL or a global block.
1278 Upon success fixes up the symbol's section if necessary. */
1280 extern struct block_symbol
1281 lookup_symbol_in_static_block (const char *name
,
1282 const struct block
*block
,
1283 const domain_enum domain
);
1285 /* Search all static file-level symbols for NAME from DOMAIN.
1286 Upon success fixes up the symbol's section if necessary. */
1288 extern struct block_symbol
lookup_static_symbol (const char *name
,
1289 const domain_enum domain
);
1291 /* Lookup a symbol in all files' global blocks.
1293 If BLOCK is non-NULL then it is used for two things:
1294 1) If a target-specific lookup routine for libraries exists, then use the
1295 routine for the objfile of BLOCK, and
1296 2) The objfile of BLOCK is used to assist in determining the search order
1297 if the target requires it.
1298 See gdbarch_iterate_over_objfiles_in_search_order.
1300 Upon success fixes up the symbol's section if necessary. */
1302 extern struct block_symbol
1303 lookup_global_symbol (const char *name
,
1304 const struct block
*block
,
1305 const domain_enum domain
);
1307 /* Lookup a symbol in block BLOCK.
1308 Upon success fixes up the symbol's section if necessary. */
1310 extern struct symbol
*
1311 lookup_symbol_in_block (const char *name
,
1312 const struct block
*block
,
1313 const domain_enum domain
);
1315 /* Look up the `this' symbol for LANG in BLOCK. Return the symbol if
1316 found, or NULL if not found. */
1318 extern struct block_symbol
1319 lookup_language_this (const struct language_defn
*lang
,
1320 const struct block
*block
);
1322 /* Lookup a [struct, union, enum] by name, within a specified block. */
1324 extern struct type
*lookup_struct (const char *, const struct block
*);
1326 extern struct type
*lookup_union (const char *, const struct block
*);
1328 extern struct type
*lookup_enum (const char *, const struct block
*);
1330 /* from blockframe.c: */
1332 /* lookup the function symbol corresponding to the address. */
1334 extern struct symbol
*find_pc_function (CORE_ADDR
);
1336 /* lookup the function corresponding to the address and section. */
1338 extern struct symbol
*find_pc_sect_function (CORE_ADDR
, struct obj_section
*);
1340 extern int find_pc_partial_function_gnu_ifunc (CORE_ADDR pc
, const char **name
,
1343 int *is_gnu_ifunc_p
);
1345 /* lookup function from address, return name, start addr and end addr. */
1347 extern int find_pc_partial_function (CORE_ADDR
, const char **, CORE_ADDR
*,
1350 extern void clear_pc_function_cache (void);
1352 /* Expand symtab containing PC, SECTION if not already expanded. */
1354 extern void expand_symtab_containing_pc (CORE_ADDR
, struct obj_section
*);
1356 /* lookup full symbol table by address. */
1358 extern struct compunit_symtab
*find_pc_compunit_symtab (CORE_ADDR
);
1360 /* lookup full symbol table by address and section. */
1362 extern struct compunit_symtab
*
1363 find_pc_sect_compunit_symtab (CORE_ADDR
, struct obj_section
*);
1365 extern int find_pc_line_pc_range (CORE_ADDR
, CORE_ADDR
*, CORE_ADDR
*);
1367 extern void reread_symbols (void);
1369 /* Look up a type named NAME in STRUCT_DOMAIN in the current language.
1370 The type returned must not be opaque -- i.e., must have at least one field
1373 extern struct type
*lookup_transparent_type (const char *);
1375 extern struct type
*basic_lookup_transparent_type (const char *);
1377 /* Macro for name of symbol to indicate a file compiled with gcc. */
1378 #ifndef GCC_COMPILED_FLAG_SYMBOL
1379 #define GCC_COMPILED_FLAG_SYMBOL "gcc_compiled."
1382 /* Macro for name of symbol to indicate a file compiled with gcc2. */
1383 #ifndef GCC2_COMPILED_FLAG_SYMBOL
1384 #define GCC2_COMPILED_FLAG_SYMBOL "gcc2_compiled."
1387 extern int in_gnu_ifunc_stub (CORE_ADDR pc
);
1389 /* Functions for resolving STT_GNU_IFUNC symbols which are implemented only
1390 for ELF symbol files. */
1392 struct gnu_ifunc_fns
1394 /* See elf_gnu_ifunc_resolve_addr for its real implementation. */
1395 CORE_ADDR (*gnu_ifunc_resolve_addr
) (struct gdbarch
*gdbarch
, CORE_ADDR pc
);
1397 /* See elf_gnu_ifunc_resolve_name for its real implementation. */
1398 int (*gnu_ifunc_resolve_name
) (const char *function_name
,
1399 CORE_ADDR
*function_address_p
);
1401 /* See elf_gnu_ifunc_resolver_stop for its real implementation. */
1402 void (*gnu_ifunc_resolver_stop
) (struct breakpoint
*b
);
1404 /* See elf_gnu_ifunc_resolver_return_stop for its real implementation. */
1405 void (*gnu_ifunc_resolver_return_stop
) (struct breakpoint
*b
);
1408 #define gnu_ifunc_resolve_addr gnu_ifunc_fns_p->gnu_ifunc_resolve_addr
1409 #define gnu_ifunc_resolve_name gnu_ifunc_fns_p->gnu_ifunc_resolve_name
1410 #define gnu_ifunc_resolver_stop gnu_ifunc_fns_p->gnu_ifunc_resolver_stop
1411 #define gnu_ifunc_resolver_return_stop \
1412 gnu_ifunc_fns_p->gnu_ifunc_resolver_return_stop
1414 extern const struct gnu_ifunc_fns
*gnu_ifunc_fns_p
;
1416 extern CORE_ADDR
find_solib_trampoline_target (struct frame_info
*, CORE_ADDR
);
1418 struct symtab_and_line
1420 /* The program space of this sal. */
1421 struct program_space
*pspace
= NULL
;
1423 struct symtab
*symtab
= NULL
;
1424 struct symbol
*symbol
= NULL
;
1425 struct obj_section
*section
= NULL
;
1426 /* Line number. Line numbers start at 1 and proceed through symtab->nlines.
1427 0 is never a valid line number; it is used to indicate that line number
1428 information is not available. */
1433 bool explicit_pc
= false;
1434 bool explicit_line
= false;
1436 /* The probe associated with this symtab_and_line. */
1437 struct probe
*probe
= NULL
;
1438 /* If PROBE is not NULL, then this is the objfile in which the probe
1440 struct objfile
*objfile
= NULL
;
1445 /* Given a pc value, return line number it is in. Second arg nonzero means
1446 if pc is on the boundary use the previous statement's line number. */
1448 extern struct symtab_and_line
find_pc_line (CORE_ADDR
, int);
1450 /* Same function, but specify a section as well as an address. */
1452 extern struct symtab_and_line
find_pc_sect_line (CORE_ADDR
,
1453 struct obj_section
*, int);
1455 /* Wrapper around find_pc_line to just return the symtab. */
1457 extern struct symtab
*find_pc_line_symtab (CORE_ADDR
);
1459 /* Given a symtab and line number, return the pc there. */
1461 extern int find_line_pc (struct symtab
*, int, CORE_ADDR
*);
1463 extern int find_line_pc_range (struct symtab_and_line
, CORE_ADDR
*,
1466 extern void resolve_sal_pc (struct symtab_and_line
*);
1470 extern void clear_solib (void);
1474 extern int identify_source_line (struct symtab
*, int, int, CORE_ADDR
);
1476 /* Flags passed as 4th argument to print_source_lines. */
1478 enum print_source_lines_flag
1480 /* Do not print an error message. */
1481 PRINT_SOURCE_LINES_NOERROR
= (1 << 0),
1483 /* Print the filename in front of the source lines. */
1484 PRINT_SOURCE_LINES_FILENAME
= (1 << 1)
1486 DEF_ENUM_FLAGS_TYPE (enum print_source_lines_flag
, print_source_lines_flags
);
1488 extern void print_source_lines (struct symtab
*, int, int,
1489 print_source_lines_flags
);
1491 extern void forget_cached_source_info_for_objfile (struct objfile
*);
1492 extern void forget_cached_source_info (void);
1494 extern void select_source_symtab (struct symtab
*);
1496 /* The reason we're calling into a completion match list collector
1498 enum class complete_symbol_mode
1500 /* Completing an expression. */
1503 /* Completing a linespec. */
1507 extern void default_collect_symbol_completion_matches_break_on
1508 (completion_tracker
&tracker
,
1509 complete_symbol_mode mode
,
1510 const char *text
, const char *word
, const char *break_on
,
1511 enum type_code code
);
1512 extern void default_collect_symbol_completion_matches
1513 (completion_tracker
&tracker
,
1514 complete_symbol_mode
,
1518 extern void collect_symbol_completion_matches (completion_tracker
&tracker
,
1519 complete_symbol_mode
,
1520 const char *, const char *);
1521 extern void collect_symbol_completion_matches_type (completion_tracker
&tracker
,
1522 const char *, const char *,
1525 extern void collect_file_symbol_completion_matches (completion_tracker
&tracker
,
1526 complete_symbol_mode
,
1531 extern completion_list
1532 make_source_files_completion_list (const char *, const char *);
1536 int matching_obj_sections (struct obj_section
*, struct obj_section
*);
1538 extern struct symtab
*find_line_symtab (struct symtab
*, int, int *, int *);
1540 extern struct symtab_and_line
find_function_start_sal (struct symbol
*sym
,
1543 extern void skip_prologue_sal (struct symtab_and_line
*);
1547 extern CORE_ADDR
skip_prologue_using_sal (struct gdbarch
*gdbarch
,
1548 CORE_ADDR func_addr
);
1550 extern struct symbol
*fixup_symbol_section (struct symbol
*,
1553 /* If MSYMBOL is an text symbol, look for a function debug symbol with
1554 the same address. Returns NULL if not found. This is necessary in
1555 case a function is an alias to some other function, because debug
1556 information is only emitted for the alias target function's
1557 definition, not for the alias. */
1558 extern symbol
*find_function_alias_target (bound_minimal_symbol msymbol
);
1560 /* Symbol searching */
1561 /* Note: struct symbol_search, search_symbols, et.al. are declared here,
1562 instead of making them local to symtab.c, for gdbtk's sake. */
1564 /* When using search_symbols, a vector of the following structs is
1566 struct symbol_search
1568 symbol_search (int block_
, struct symbol
*symbol_
)
1572 msymbol
.minsym
= nullptr;
1573 msymbol
.objfile
= nullptr;
1576 symbol_search (int block_
, struct minimal_symbol
*minsym
,
1577 struct objfile
*objfile
)
1581 msymbol
.minsym
= minsym
;
1582 msymbol
.objfile
= objfile
;
1585 bool operator< (const symbol_search
&other
) const
1587 return compare_search_syms (*this, other
) < 0;
1590 bool operator== (const symbol_search
&other
) const
1592 return compare_search_syms (*this, other
) == 0;
1595 /* The block in which the match was found. Could be, for example,
1596 STATIC_BLOCK or GLOBAL_BLOCK. */
1599 /* Information describing what was found.
1601 If symbol is NOT NULL, then information was found for this match. */
1602 struct symbol
*symbol
;
1604 /* If msymbol is non-null, then a match was made on something for
1605 which only minimal_symbols exist. */
1606 struct bound_minimal_symbol msymbol
;
1610 static int compare_search_syms (const symbol_search
&sym_a
,
1611 const symbol_search
&sym_b
);
1614 extern std::vector
<symbol_search
> search_symbols (const char *,
1615 enum search_domain
, int,
1618 /* The name of the ``main'' function.
1619 FIXME: cagney/2001-03-20: Can't make main_name() const since some
1620 of the calling code currently assumes that the string isn't
1622 extern /*const */ char *main_name (void);
1623 extern enum language
main_language (void);
1625 /* Lookup symbol NAME from DOMAIN in MAIN_OBJFILE's global blocks.
1626 This searches MAIN_OBJFILE as well as any associated separate debug info
1627 objfiles of MAIN_OBJFILE.
1628 Upon success fixes up the symbol's section if necessary. */
1630 extern struct block_symbol
1631 lookup_global_symbol_from_objfile (struct objfile
*main_objfile
,
1633 const domain_enum domain
);
1635 /* Return 1 if the supplied producer string matches the ARM RealView
1636 compiler (armcc). */
1637 int producer_is_realview (const char *producer
);
1639 void fixup_section (struct general_symbol_info
*ginfo
,
1640 CORE_ADDR addr
, struct objfile
*objfile
);
1642 /* Look up objfile containing BLOCK. */
1644 struct objfile
*lookup_objfile_from_block (const struct block
*block
);
1646 extern unsigned int symtab_create_debug
;
1648 extern unsigned int symbol_lookup_debug
;
1650 extern int basenames_may_differ
;
1652 int compare_filenames_for_search (const char *filename
,
1653 const char *search_name
);
1655 int compare_glob_filenames_for_search (const char *filename
,
1656 const char *search_name
);
1658 bool iterate_over_some_symtabs (const char *name
,
1659 const char *real_path
,
1660 struct compunit_symtab
*first
,
1661 struct compunit_symtab
*after_last
,
1662 gdb::function_view
<bool (symtab
*)> callback
);
1664 void iterate_over_symtabs (const char *name
,
1665 gdb::function_view
<bool (symtab
*)> callback
);
1668 std::vector
<CORE_ADDR
> find_pcs_for_symtab_line
1669 (struct symtab
*symtab
, int line
, struct linetable_entry
**best_entry
);
1671 /* Prototype for callbacks for LA_ITERATE_OVER_SYMBOLS. The callback
1672 is called once per matching symbol SYM. The callback should return
1673 true to indicate that LA_ITERATE_OVER_SYMBOLS should continue
1674 iterating, or false to indicate that the iteration should end. */
1676 typedef bool (symbol_found_callback_ftype
) (symbol
*sym
);
1678 void iterate_over_symbols (const struct block
*block
, const char *name
,
1679 const domain_enum domain
,
1680 gdb::function_view
<symbol_found_callback_ftype
> callback
);
1682 /* Storage type used by demangle_for_lookup. demangle_for_lookup
1683 either returns a const char * pointer that points to either of the
1684 fields of this type, or a pointer to the input NAME. This is done
1685 this way because the underlying functions that demangle_for_lookup
1686 calls either return a std::string (e.g., cp_canonicalize_string) or
1687 a malloc'ed buffer (libiberty's demangled), and we want to avoid
1688 unnecessary reallocation/string copying. */
1689 class demangle_result_storage
1693 /* Swap the std::string storage with STR, and return a pointer to
1694 the beginning of the new string. */
1695 const char *swap_string (std::string
&str
)
1697 std::swap (m_string
, str
);
1698 return m_string
.c_str ();
1701 /* Set the malloc storage to now point at PTR. Any previous malloc
1702 storage is released. */
1703 const char *set_malloc_ptr (char *ptr
)
1705 m_malloc
.reset (ptr
);
1712 std::string m_string
;
1713 gdb::unique_xmalloc_ptr
<char> m_malloc
;
1717 demangle_for_lookup (const char *name
, enum language lang
,
1718 demangle_result_storage
&storage
);
1720 struct symbol
*allocate_symbol (struct objfile
*);
1722 void initialize_objfile_symbol (struct symbol
*);
1724 struct template_symbol
*allocate_template_symbol (struct objfile
*);
1726 #endif /* !defined(SYMTAB_H) */