1 /* Symbol table definitions for GDB.
3 Copyright (C) 1986-2016 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"
28 /* Opaque declarations. */
43 struct cmd_list_element;
45 /* Some of the structures in this file are space critical.
46 The space-critical structures are:
48 struct general_symbol_info
52 These structures are laid out to encourage good packing.
53 They use ENUM_BITFIELD and short int fields, and they order the
54 structure members so that fields less than a word are next
55 to each other so they can be packed together. */
57 /* Rearranged: used ENUM_BITFIELD and rearranged field order in
58 all the space critical structures (plus struct minimal_symbol).
59 Memory usage dropped from 99360768 bytes to 90001408 bytes.
60 I measured this with before-and-after tests of
61 "HEAD-old-gdb -readnow HEAD-old-gdb" and
62 "HEAD-new-gdb -readnow HEAD-old-gdb" on native i686-pc-linux-gnu,
63 red hat linux 8, with LD_LIBRARY_PATH=/usr/lib/debug,
64 typing "maint space 1" at the first command prompt.
66 Here is another measurement (from andrew c):
67 # no /usr/lib/debug, just plain glibc, like a normal user
69 (gdb) break internal_error
71 (gdb) maint internal-error
75 gdb gdb_6_0_branch 2003-08-19 space used: 8896512
76 gdb HEAD 2003-08-19 space used: 8904704
77 gdb HEAD 2003-08-21 space used: 8396800 (+symtab.h)
78 gdb HEAD 2003-08-21 space used: 8265728 (+gdbtypes.h)
80 The third line shows the savings from the optimizations in symtab.h.
81 The fourth line shows the savings from the optimizations in
82 gdbtypes.h. Both optimizations are in gdb HEAD now.
84 --chastain 2003-08-21 */
86 /* Define a structure for the information that is common to all symbol types,
87 including minimal symbols, partial symbols, and full symbols. In a
88 multilanguage environment, some language specific information may need to
89 be recorded along with each symbol. */
91 /* This structure is space critical. See space comments at the top. */
93 struct general_symbol_info
95 /* Name of the symbol. This is a required field. Storage for the
96 name is allocated on the objfile_obstack for the associated
97 objfile. For languages like C++ that make a distinction between
98 the mangled name and demangled name, this is the mangled
103 /* Value of the symbol. Which member of this union to use, and what
104 it means, depends on what kind of symbol this is and its
105 SYMBOL_CLASS. See comments there for more details. All of these
106 are in host byte order (though what they point to might be in
107 target byte order, e.g. LOC_CONST_BYTES). */
113 const struct block *block;
115 const gdb_byte *bytes;
119 /* A common block. Used with LOC_COMMON_BLOCK. */
121 const struct common_block *common_block;
123 /* For opaque typedef struct chain. */
125 struct symbol *chain;
129 /* Since one and only one language can apply, wrap the language specific
130 information inside a union. */
134 /* A pointer to an obstack that can be used for storage associated
135 with this symbol. This is only used by Ada, and only when the
136 'ada_mangled' field is zero. */
137 struct obstack *obstack;
139 /* This is used by languages which wish to store a demangled name.
140 currently used by Ada, C++, and Objective C. */
141 const char *demangled_name;
145 /* Record the source code language that applies to this symbol.
146 This is used to select one of the fields from the language specific
149 ENUM_BITFIELD(language) language : LANGUAGE_BITS;
151 /* This is only used by Ada. If set, then the 'demangled_name' field
152 of language_specific is valid. Otherwise, the 'obstack' field is
154 unsigned int ada_mangled : 1;
156 /* Which section is this symbol in? This is an index into
157 section_offsets for this objfile. Negative means that the symbol
158 does not get relocated relative to a section. */
163 extern void symbol_set_demangled_name (struct general_symbol_info *,
167 extern const char *symbol_get_demangled_name
168 (const struct general_symbol_info *);
170 extern CORE_ADDR symbol_overlayed_address (CORE_ADDR, struct obj_section *);
172 /* Note that all the following SYMBOL_* macros are used with the
173 SYMBOL argument being either a partial symbol or
174 a full symbol. Both types have a ginfo field. In particular
175 the SYMBOL_SET_LANGUAGE, SYMBOL_DEMANGLED_NAME, etc.
176 macros cannot be entirely substituted by
177 functions, unless the callers are changed to pass in the ginfo
178 field only, instead of the SYMBOL parameter. */
180 #define SYMBOL_VALUE(symbol) (symbol)->ginfo.value.ivalue
181 #define SYMBOL_VALUE_ADDRESS(symbol) (symbol)->ginfo.value.address
182 #define SYMBOL_VALUE_BYTES(symbol) (symbol)->ginfo.value.bytes
183 #define SYMBOL_VALUE_COMMON_BLOCK(symbol) (symbol)->ginfo.value.common_block
184 #define SYMBOL_BLOCK_VALUE(symbol) (symbol)->ginfo.value.block
185 #define SYMBOL_VALUE_CHAIN(symbol) (symbol)->ginfo.value.chain
186 #define SYMBOL_LANGUAGE(symbol) (symbol)->ginfo.language
187 #define SYMBOL_SECTION(symbol) (symbol)->ginfo.section
188 #define SYMBOL_OBJ_SECTION(objfile, symbol) \
189 (((symbol)->ginfo.section >= 0) \
190 ? (&(((objfile)->sections)[(symbol)->ginfo.section])) \
193 /* Initializes the language dependent portion of a symbol
194 depending upon the language for the symbol. */
195 #define SYMBOL_SET_LANGUAGE(symbol,language,obstack) \
196 (symbol_set_language (&(symbol)->ginfo, (language), (obstack)))
197 extern void symbol_set_language (struct general_symbol_info *symbol,
198 enum language language,
199 struct obstack *obstack);
201 /* Set just the linkage name of a symbol; do not try to demangle
202 it. Used for constructs which do not have a mangled name,
203 e.g. struct tags. Unlike SYMBOL_SET_NAMES, linkage_name must
204 be terminated and either already on the objfile's obstack or
205 permanently allocated. */
206 #define SYMBOL_SET_LINKAGE_NAME(symbol,linkage_name) \
207 (symbol)->ginfo.name = (linkage_name)
209 /* Set the linkage and natural names of a symbol, by demangling
211 #define SYMBOL_SET_NAMES(symbol,linkage_name,len,copy_name,objfile) \
212 symbol_set_names (&(symbol)->ginfo, linkage_name, len, copy_name, objfile)
213 extern void symbol_set_names (struct general_symbol_info *symbol,
214 const char *linkage_name, int len, int copy_name,
215 struct objfile *objfile);
217 /* Now come lots of name accessor macros. Short version as to when to
218 use which: Use SYMBOL_NATURAL_NAME to refer to the name of the
219 symbol in the original source code. Use SYMBOL_LINKAGE_NAME if you
220 want to know what the linker thinks the symbol's name is. Use
221 SYMBOL_PRINT_NAME for output. Use SYMBOL_DEMANGLED_NAME if you
222 specifically need to know whether SYMBOL_NATURAL_NAME and
223 SYMBOL_LINKAGE_NAME are different. */
225 /* Return SYMBOL's "natural" name, i.e. the name that it was called in
226 the original source code. In languages like C++ where symbols may
227 be mangled for ease of manipulation by the linker, this is the
230 #define SYMBOL_NATURAL_NAME(symbol) \
231 (symbol_natural_name (&(symbol)->ginfo))
232 extern const char *symbol_natural_name
233 (const struct general_symbol_info *symbol);
235 /* Return SYMBOL's name from the point of view of the linker. In
236 languages like C++ where symbols may be mangled for ease of
237 manipulation by the linker, this is the mangled name; otherwise,
238 it's the same as SYMBOL_NATURAL_NAME. */
240 #define SYMBOL_LINKAGE_NAME(symbol) (symbol)->ginfo.name
242 /* Return the demangled name for a symbol based on the language for
243 that symbol. If no demangled name exists, return NULL. */
244 #define SYMBOL_DEMANGLED_NAME(symbol) \
245 (symbol_demangled_name (&(symbol)->ginfo))
246 extern const char *symbol_demangled_name
247 (const struct general_symbol_info *symbol);
249 /* Macro that returns a version of the name of a symbol that is
250 suitable for output. In C++ this is the "demangled" form of the
251 name if demangle is on and the "mangled" form of the name if
252 demangle is off. In other languages this is just the symbol name.
253 The result should never be NULL. Don't use this for internal
254 purposes (e.g. storing in a hashtable): it's only suitable for output.
256 N.B. symbol may be anything with a ginfo member,
257 e.g., struct symbol or struct minimal_symbol. */
259 #define SYMBOL_PRINT_NAME(symbol) \
260 (demangle ? SYMBOL_NATURAL_NAME (symbol) : SYMBOL_LINKAGE_NAME (symbol))
263 /* Macro that returns the name to be used when sorting and searching symbols.
264 In C++, we search for the demangled form of a name,
265 and so sort symbols accordingly. In Ada, however, we search by mangled
266 name. If there is no distinct demangled name, then SYMBOL_SEARCH_NAME
267 returns the same value (same pointer) as SYMBOL_LINKAGE_NAME. */
268 #define SYMBOL_SEARCH_NAME(symbol) \
269 (symbol_search_name (&(symbol)->ginfo))
270 extern const char *symbol_search_name (const struct general_symbol_info *);
272 /* Return non-zero if NAME matches the "search" name of SYMBOL.
273 Whitespace and trailing parentheses are ignored.
274 See strcmp_iw for details about its behavior. */
275 #define SYMBOL_MATCHES_SEARCH_NAME(symbol, name) \
276 (strcmp_iw (SYMBOL_SEARCH_NAME (symbol), (name)) == 0)
278 /* Classification types for a minimal symbol. These should be taken as
279 "advisory only", since if gdb can't easily figure out a
280 classification it simply selects mst_unknown. It may also have to
281 guess when it can't figure out which is a better match between two
282 types (mst_data versus mst_bss) for example. Since the minimal
283 symbol info is sometimes derived from the BFD library's view of a
284 file, we need to live with what information bfd supplies. */
286 enum minimal_symbol_type
288 mst_unknown = 0, /* Unknown type, the default */
289 mst_text, /* Generally executable instructions */
290 mst_text_gnu_ifunc, /* Executable code returning address
291 of executable code */
292 mst_slot_got_plt, /* GOT entries for .plt sections */
293 mst_data, /* Generally initialized data */
294 mst_bss, /* Generally uninitialized data */
295 mst_abs, /* Generally absolute (nonrelocatable) */
296 /* GDB uses mst_solib_trampoline for the start address of a shared
297 library trampoline entry. Breakpoints for shared library functions
298 are put there if the shared library is not yet loaded.
299 After the shared library is loaded, lookup_minimal_symbol will
300 prefer the minimal symbol from the shared library (usually
301 a mst_text symbol) over the mst_solib_trampoline symbol, and the
302 breakpoints will be moved to their true address in the shared
303 library via breakpoint_re_set. */
304 mst_solib_trampoline, /* Shared library trampoline code */
305 /* For the mst_file* types, the names are only guaranteed to be unique
306 within a given .o file. */
307 mst_file_text, /* Static version of mst_text */
308 mst_file_data, /* Static version of mst_data */
309 mst_file_bss, /* Static version of mst_bss */
313 /* The number of enum minimal_symbol_type values, with some padding for
314 reasonable growth. */
315 #define MINSYM_TYPE_BITS 4
316 gdb_static_assert (nr_minsym_types <= (1 << MINSYM_TYPE_BITS));
318 /* Define a simple structure used to hold some very basic information about
319 all defined global symbols (text, data, bss, abs, etc). The only required
320 information is the general_symbol_info.
322 In many cases, even if a file was compiled with no special options for
323 debugging at all, as long as was not stripped it will contain sufficient
324 information to build a useful minimal symbol table using this structure.
325 Even when a file contains enough debugging information to build a full
326 symbol table, these minimal symbols are still useful for quickly mapping
327 between names and addresses, and vice versa. They are also sometimes
328 used to figure out what full symbol table entries need to be read in. */
330 struct minimal_symbol
333 /* The general symbol info required for all types of symbols.
335 The SYMBOL_VALUE_ADDRESS contains the address that this symbol
338 struct general_symbol_info mginfo;
340 /* Size of this symbol. dbx_end_psymtab in dbxread.c uses this
341 information to calculate the end of the partial symtab based on the
342 address of the last symbol plus the size of the last symbol. */
346 /* Which source file is this symbol in? Only relevant for mst_file_*. */
347 const char *filename;
349 /* Classification type for this minimal symbol. */
351 ENUM_BITFIELD(minimal_symbol_type) type : MINSYM_TYPE_BITS;
353 /* Non-zero if this symbol was created by gdb.
354 Such symbols do not appear in the output of "info var|fun". */
355 unsigned int created_by_gdb : 1;
357 /* Two flag bits provided for the use of the target. */
358 unsigned int target_flag_1 : 1;
359 unsigned int target_flag_2 : 1;
361 /* Nonzero iff the size of the minimal symbol has been set.
362 Symbol size information can sometimes not be determined, because
363 the object file format may not carry that piece of information. */
364 unsigned int has_size : 1;
366 /* Minimal symbols with the same hash key are kept on a linked
367 list. This is the link. */
369 struct minimal_symbol *hash_next;
371 /* Minimal symbols are stored in two different hash tables. This is
372 the `next' pointer for the demangled hash table. */
374 struct minimal_symbol *demangled_hash_next;
377 #define MSYMBOL_TARGET_FLAG_1(msymbol) (msymbol)->target_flag_1
378 #define MSYMBOL_TARGET_FLAG_2(msymbol) (msymbol)->target_flag_2
379 #define MSYMBOL_SIZE(msymbol) ((msymbol)->size + 0)
380 #define SET_MSYMBOL_SIZE(msymbol, sz) \
383 (msymbol)->size = sz; \
384 (msymbol)->has_size = 1; \
386 #define MSYMBOL_HAS_SIZE(msymbol) ((msymbol)->has_size + 0)
387 #define MSYMBOL_TYPE(msymbol) (msymbol)->type
389 #define MSYMBOL_VALUE(symbol) (symbol)->mginfo.value.ivalue
390 /* The unrelocated address of the minimal symbol. */
391 #define MSYMBOL_VALUE_RAW_ADDRESS(symbol) ((symbol)->mginfo.value.address + 0)
392 /* The relocated address of the minimal symbol, using the section
393 offsets from OBJFILE. */
394 #define MSYMBOL_VALUE_ADDRESS(objfile, symbol) \
395 ((symbol)->mginfo.value.address \
396 + ANOFFSET ((objfile)->section_offsets, ((symbol)->mginfo.section)))
397 /* For a bound minsym, we can easily compute the address directly. */
398 #define BMSYMBOL_VALUE_ADDRESS(symbol) \
399 MSYMBOL_VALUE_ADDRESS ((symbol).objfile, (symbol).minsym)
400 #define SET_MSYMBOL_VALUE_ADDRESS(symbol, new_value) \
401 ((symbol)->mginfo.value.address = (new_value))
402 #define MSYMBOL_VALUE_BYTES(symbol) (symbol)->mginfo.value.bytes
403 #define MSYMBOL_BLOCK_VALUE(symbol) (symbol)->mginfo.value.block
404 #define MSYMBOL_VALUE_CHAIN(symbol) (symbol)->mginfo.value.chain
405 #define MSYMBOL_LANGUAGE(symbol) (symbol)->mginfo.language
406 #define MSYMBOL_SECTION(symbol) (symbol)->mginfo.section
407 #define MSYMBOL_OBJ_SECTION(objfile, symbol) \
408 (((symbol)->mginfo.section >= 0) \
409 ? (&(((objfile)->sections)[(symbol)->mginfo.section])) \
412 #define MSYMBOL_NATURAL_NAME(symbol) \
413 (symbol_natural_name (&(symbol)->mginfo))
414 #define MSYMBOL_LINKAGE_NAME(symbol) (symbol)->mginfo.name
415 #define MSYMBOL_PRINT_NAME(symbol) \
416 (demangle ? MSYMBOL_NATURAL_NAME (symbol) : MSYMBOL_LINKAGE_NAME (symbol))
417 #define MSYMBOL_DEMANGLED_NAME(symbol) \
418 (symbol_demangled_name (&(symbol)->mginfo))
419 #define MSYMBOL_SET_LANGUAGE(symbol,language,obstack) \
420 (symbol_set_language (&(symbol)->mginfo, (language), (obstack)))
421 #define MSYMBOL_SEARCH_NAME(symbol) \
422 (symbol_search_name (&(symbol)->mginfo))
423 #define MSYMBOL_MATCHES_SEARCH_NAME(symbol, name) \
424 (strcmp_iw (MSYMBOL_SEARCH_NAME (symbol), (name)) == 0)
425 #define MSYMBOL_SET_NAMES(symbol,linkage_name,len,copy_name,objfile) \
426 symbol_set_names (&(symbol)->mginfo, linkage_name, len, copy_name, objfile)
432 /* Represent one symbol name; a variable, constant, function or typedef. */
434 /* Different name domains for symbols. Looking up a symbol specifies a
435 domain and ignores symbol definitions in other name domains. */
437 typedef enum domain_enum_tag
439 /* UNDEF_DOMAIN is used when a domain has not been discovered or
440 none of the following apply. This usually indicates an error either
441 in the symbol information or in gdb's handling of symbols. */
445 /* VAR_DOMAIN is the usual domain. In C, this contains variables,
446 function names, typedef names and enum type values. */
450 /* STRUCT_DOMAIN is used in C to hold struct, union and enum type names.
451 Thus, if `struct foo' is used in a C program, it produces a symbol named
452 `foo' in the STRUCT_DOMAIN. */
456 /* MODULE_DOMAIN is used in Fortran to hold module type names. */
460 /* LABEL_DOMAIN may be used for names of labels (for gotos). */
464 /* Fortran common blocks. Their naming must be separate from VAR_DOMAIN.
465 They also always use LOC_COMMON_BLOCK. */
468 /* This must remain last. */
472 /* The number of bits in a symbol used to represent the domain. */
474 #define SYMBOL_DOMAIN_BITS 3
475 gdb_static_assert (NR_DOMAINS <= (1 << SYMBOL_DOMAIN_BITS));
477 extern const char *domain_name (domain_enum);
479 /* Searching domains, used for `search_symbols'. Element numbers are
480 hardcoded in GDB, check all enum uses before changing it. */
484 /* Everything in VAR_DOMAIN minus FUNCTIONS_DOMAIN and
486 VARIABLES_DOMAIN = 0,
488 /* All functions -- for some reason not methods, though. */
489 FUNCTIONS_DOMAIN = 1,
491 /* All defined types */
498 extern const char *search_domain_name (enum search_domain);
500 /* An address-class says where to find the value of a symbol. */
504 /* Not used; catches errors. */
508 /* Value is constant int SYMBOL_VALUE, host byteorder. */
512 /* Value is at fixed address SYMBOL_VALUE_ADDRESS. */
516 /* Value is in register. SYMBOL_VALUE is the register number
517 in the original debug format. SYMBOL_REGISTER_OPS holds a
518 function that can be called to transform this into the
519 actual register number this represents in a specific target
520 architecture (gdbarch).
522 For some symbol formats (stabs, for some compilers at least),
523 the compiler generates two symbols, an argument and a register.
524 In some cases we combine them to a single LOC_REGISTER in symbol
525 reading, but currently not for all cases (e.g. it's passed on the
526 stack and then loaded into a register). */
530 /* It's an argument; the value is at SYMBOL_VALUE offset in arglist. */
534 /* Value address is at SYMBOL_VALUE offset in arglist. */
538 /* Value is in specified register. Just like LOC_REGISTER except the
539 register holds the address of the argument instead of the argument
540 itself. This is currently used for the passing of structs and unions
541 on sparc and hppa. It is also used for call by reference where the
542 address is in a register, at least by mipsread.c. */
546 /* Value is a local variable at SYMBOL_VALUE offset in stack frame. */
550 /* Value not used; definition in SYMBOL_TYPE. Symbols in the domain
551 STRUCT_DOMAIN all have this class. */
555 /* Value is address SYMBOL_VALUE_ADDRESS in the code. */
559 /* In a symbol table, value is SYMBOL_BLOCK_VALUE of a `struct block'.
560 In a partial symbol table, SYMBOL_VALUE_ADDRESS is the start address
561 of the block. Function names have this class. */
565 /* Value is a constant byte-sequence pointed to by SYMBOL_VALUE_BYTES, in
566 target byte order. */
570 /* Value is at fixed address, but the address of the variable has
571 to be determined from the minimal symbol table whenever the
572 variable is referenced.
573 This happens if debugging information for a global symbol is
574 emitted and the corresponding minimal symbol is defined
575 in another object file or runtime common storage.
576 The linker might even remove the minimal symbol if the global
577 symbol is never referenced, in which case the symbol remains
580 GDB would normally find the symbol in the minimal symbol table if it will
581 not find it in the full symbol table. But a reference to an external
582 symbol in a local block shadowing other definition requires full symbol
583 without possibly having its address available for LOC_STATIC. Testcase
584 is provided as `gdb.dwarf2/dw2-unresolved.exp'.
586 This is also used for thread local storage (TLS) variables. In this case,
587 the address of the TLS variable must be determined when the variable is
588 referenced, from the MSYMBOL_VALUE_RAW_ADDRESS, which is the offset
589 of the TLS variable in the thread local storage of the shared
594 /* The variable does not actually exist in the program.
595 The value is ignored. */
599 /* The variable's address is computed by a set of location
600 functions (see "struct symbol_computed_ops" below). */
603 /* The variable uses general_symbol_info->value->common_block field.
604 It also always uses COMMON_BLOCK_DOMAIN. */
607 /* Not used, just notes the boundary of the enum. */
611 /* The number of bits needed for values in enum address_class, with some
612 padding for reasonable growth, and room for run-time registered address
613 classes. See symtab.c:MAX_SYMBOL_IMPLS.
614 This is a #define so that we can have a assertion elsewhere to
615 verify that we have reserved enough space for synthetic address
617 #define SYMBOL_ACLASS_BITS 5
618 gdb_static_assert (LOC_FINAL_VALUE <= (1 << SYMBOL_ACLASS_BITS));
620 /* The methods needed to implement LOC_COMPUTED. These methods can
621 use the symbol's .aux_value for additional per-symbol information.
623 At present this is only used to implement location expressions. */
625 struct symbol_computed_ops
628 /* Return the value of the variable SYMBOL, relative to the stack
629 frame FRAME. If the variable has been optimized out, return
632 Iff `read_needs_frame (SYMBOL)' is not SYMBOL_NEEDS_FRAME, then
633 FRAME may be zero. */
635 struct value *(*read_variable) (struct symbol * symbol,
636 struct frame_info * frame);
638 /* Read variable SYMBOL like read_variable at (callee) FRAME's function
639 entry. SYMBOL should be a function parameter, otherwise
640 NO_ENTRY_VALUE_ERROR will be thrown. */
641 struct value *(*read_variable_at_entry) (struct symbol *symbol,
642 struct frame_info *frame);
644 /* Find the "symbol_needs_kind" value for the given symbol. This
645 value determines whether reading the symbol needs memory (e.g., a
646 global variable), just registers (a thread-local), or a frame (a
648 enum symbol_needs_kind (*get_symbol_read_needs) (struct symbol * symbol);
650 /* Write to STREAM a natural-language description of the location of
651 SYMBOL, in the context of ADDR. */
652 void (*describe_location) (struct symbol * symbol, CORE_ADDR addr,
653 struct ui_file * stream);
655 /* Non-zero if this symbol's address computation is dependent on PC. */
656 unsigned char location_has_loclist;
658 /* Tracepoint support. Append bytecodes to the tracepoint agent
659 expression AX that push the address of the object SYMBOL. Set
660 VALUE appropriately. Note --- for objects in registers, this
661 needn't emit any code; as long as it sets VALUE properly, then
662 the caller will generate the right code in the process of
663 treating this as an lvalue or rvalue. */
665 void (*tracepoint_var_ref) (struct symbol *symbol, struct gdbarch *gdbarch,
666 struct agent_expr *ax, struct axs_value *value);
668 /* Generate C code to compute the location of SYMBOL. The C code is
669 emitted to STREAM. GDBARCH is the current architecture and PC is
670 the PC at which SYMBOL's location should be evaluated.
671 REGISTERS_USED is a vector indexed by register number; the
672 generator function should set an element in this vector if the
673 corresponding register is needed by the location computation.
674 The generated C code must assign the location to a local
675 variable; this variable's name is RESULT_NAME. */
677 void (*generate_c_location) (struct symbol *symbol, struct ui_file *stream,
678 struct gdbarch *gdbarch,
679 unsigned char *registers_used,
680 CORE_ADDR pc, const char *result_name);
684 /* The methods needed to implement LOC_BLOCK for inferior functions.
685 These methods can use the symbol's .aux_value for additional
686 per-symbol information. */
688 struct symbol_block_ops
690 /* Fill in *START and *LENGTH with DWARF block data of function
691 FRAMEFUNC valid for inferior context address PC. Set *LENGTH to
692 zero if such location is not valid for PC; *START is left
693 uninitialized in such case. */
694 void (*find_frame_base_location) (struct symbol *framefunc, CORE_ADDR pc,
695 const gdb_byte **start, size_t *length);
697 /* Return the frame base address. FRAME is the frame for which we want to
698 compute the base address while FRAMEFUNC is the symbol for the
699 corresponding function. Return 0 on failure (FRAMEFUNC may not hold the
700 information we need).
702 This method is designed to work with static links (nested functions
703 handling). Static links are function properties whose evaluation returns
704 the frame base address for the enclosing frame. However, there are
705 multiple definitions for "frame base": the content of the frame base
706 register, the CFA as defined by DWARF unwinding information, ...
708 So this specific method is supposed to compute the frame base address such
709 as for nested fuctions, the static link computes the same address. For
710 instance, considering DWARF debugging information, the static link is
711 computed with DW_AT_static_link and this method must be used to compute
712 the corresponding DW_AT_frame_base attribute. */
713 CORE_ADDR (*get_frame_base) (struct symbol *framefunc,
714 struct frame_info *frame);
717 /* Functions used with LOC_REGISTER and LOC_REGPARM_ADDR. */
719 struct symbol_register_ops
721 int (*register_number) (struct symbol *symbol, struct gdbarch *gdbarch);
724 /* Objects of this type are used to find the address class and the
725 various computed ops vectors of a symbol. */
729 enum address_class aclass;
731 /* Used with LOC_COMPUTED. */
732 const struct symbol_computed_ops *ops_computed;
734 /* Used with LOC_BLOCK. */
735 const struct symbol_block_ops *ops_block;
737 /* Used with LOC_REGISTER and LOC_REGPARM_ADDR. */
738 const struct symbol_register_ops *ops_register;
741 /* This structure is space critical. See space comments at the top. */
746 /* The general symbol info required for all types of symbols. */
748 struct general_symbol_info ginfo;
750 /* Data type of value */
754 /* The owner of this symbol.
755 Which one to use is defined by symbol.is_objfile_owned. */
759 /* The symbol table containing this symbol. This is the file associated
760 with LINE. It can be NULL during symbols read-in but it is never NULL
761 during normal operation. */
762 struct symtab *symtab;
764 /* For types defined by the architecture. */
765 struct gdbarch *arch;
770 ENUM_BITFIELD(domain_enum_tag) domain : SYMBOL_DOMAIN_BITS;
772 /* Address class. This holds an index into the 'symbol_impls'
773 table. The actual enum address_class value is stored there,
774 alongside any per-class ops vectors. */
776 unsigned int aclass_index : SYMBOL_ACLASS_BITS;
778 /* If non-zero then symbol is objfile-owned, use owner.symtab.
779 Otherwise symbol is arch-owned, use owner.arch. */
781 unsigned int is_objfile_owned : 1;
783 /* Whether this is an argument. */
785 unsigned is_argument : 1;
787 /* Whether this is an inlined function (class LOC_BLOCK only). */
788 unsigned is_inlined : 1;
790 /* True if this is a C++ function symbol with template arguments.
791 In this case the symbol is really a "struct template_symbol". */
792 unsigned is_cplus_template_function : 1;
794 /* Line number of this symbol's definition, except for inlined
795 functions. For an inlined function (class LOC_BLOCK and
796 SYMBOL_INLINED set) this is the line number of the function's call
797 site. Inlined function symbols are not definitions, and they are
798 never found by symbol table lookup.
799 If this symbol is arch-owned, LINE shall be zero.
801 FIXME: Should we really make the assumption that nobody will try
802 to debug files longer than 64K lines? What about machine
803 generated programs? */
807 /* An arbitrary data pointer, allowing symbol readers to record
808 additional information on a per-symbol basis. Note that this data
809 must be allocated using the same obstack as the symbol itself. */
810 /* So far it is only used by:
811 LOC_COMPUTED: to find the location information
812 LOC_BLOCK (DWARF2 function): information used internally by the
813 DWARF 2 code --- specifically, the location expression for the frame
814 base for this function. */
815 /* FIXME drow/2003-02-21: For the LOC_BLOCK case, it might be better
816 to add a magic symbol to the block containing this information,
817 or to have a generic debug info annotation slot for symbols. */
821 struct symbol *hash_next;
824 /* Several lookup functions return both a symbol and the block in which the
825 symbol is found. This structure is used in these cases. */
829 /* The symbol that was found, or NULL if no symbol was found. */
830 struct symbol *symbol;
832 /* If SYMBOL is not NULL, then this is the block in which the symbol is
834 const struct block *block;
837 extern const struct symbol_impl *symbol_impls;
839 /* For convenience. All fields are NULL. This means "there is no
841 extern const struct block_symbol null_block_symbol;
843 /* Note: There is no accessor macro for symbol.owner because it is
846 #define SYMBOL_DOMAIN(symbol) (symbol)->domain
847 #define SYMBOL_IMPL(symbol) (symbol_impls[(symbol)->aclass_index])
848 #define SYMBOL_ACLASS_INDEX(symbol) (symbol)->aclass_index
849 #define SYMBOL_CLASS(symbol) (SYMBOL_IMPL (symbol).aclass)
850 #define SYMBOL_OBJFILE_OWNED(symbol) ((symbol)->is_objfile_owned)
851 #define SYMBOL_IS_ARGUMENT(symbol) (symbol)->is_argument
852 #define SYMBOL_INLINED(symbol) (symbol)->is_inlined
853 #define SYMBOL_IS_CPLUS_TEMPLATE_FUNCTION(symbol) \
854 (symbol)->is_cplus_template_function
855 #define SYMBOL_TYPE(symbol) (symbol)->type
856 #define SYMBOL_LINE(symbol) (symbol)->line
857 #define SYMBOL_COMPUTED_OPS(symbol) (SYMBOL_IMPL (symbol).ops_computed)
858 #define SYMBOL_BLOCK_OPS(symbol) (SYMBOL_IMPL (symbol).ops_block)
859 #define SYMBOL_REGISTER_OPS(symbol) (SYMBOL_IMPL (symbol).ops_register)
860 #define SYMBOL_LOCATION_BATON(symbol) (symbol)->aux_value
862 extern int register_symbol_computed_impl (enum address_class,
863 const struct symbol_computed_ops *);
865 extern int register_symbol_block_impl (enum address_class aclass,
866 const struct symbol_block_ops *ops);
868 extern int register_symbol_register_impl (enum address_class,
869 const struct symbol_register_ops *);
871 /* Return the OBJFILE of SYMBOL.
872 It is an error to call this if symbol.is_objfile_owned is false, which
873 only happens for architecture-provided types. */
875 extern struct objfile *symbol_objfile (const struct symbol *symbol);
877 /* Return the ARCH of SYMBOL. */
879 extern struct gdbarch *symbol_arch (const struct symbol *symbol);
881 /* Return the SYMTAB of SYMBOL.
882 It is an error to call this if symbol.is_objfile_owned is false, which
883 only happens for architecture-provided types. */
885 extern struct symtab *symbol_symtab (const struct symbol *symbol);
887 /* Set the symtab of SYMBOL to SYMTAB.
888 It is an error to call this if symbol.is_objfile_owned is false, which
889 only happens for architecture-provided types. */
891 extern void symbol_set_symtab (struct symbol *symbol, struct symtab *symtab);
893 /* An instance of this type is used to represent a C++ template
894 function. It includes a "struct symbol" as a kind of base class;
895 users downcast to "struct template_symbol *" when needed. A symbol
896 is really of this type iff SYMBOL_IS_CPLUS_TEMPLATE_FUNCTION is
899 struct template_symbol
901 /* The base class. */
904 /* The number of template arguments. */
905 int n_template_arguments;
907 /* The template arguments. This is an array with
908 N_TEMPLATE_ARGUMENTS elements. */
909 struct symbol **template_arguments;
913 /* Each item represents a line-->pc (or the reverse) mapping. This is
914 somewhat more wasteful of space than one might wish, but since only
915 the files which are actually debugged are read in to core, we don't
918 struct linetable_entry
924 /* The order of entries in the linetable is significant. They should
925 be sorted by increasing values of the pc field. If there is more than
926 one entry for a given pc, then I'm not sure what should happen (and
927 I not sure whether we currently handle it the best way).
929 Example: a C for statement generally looks like this
931 10 0x100 - for the init/test part of a for stmt.
934 10 0x400 - for the increment part of a for stmt.
936 If an entry has a line number of zero, it marks the start of a PC
937 range for which no line number information is available. It is
938 acceptable, though wasteful of table space, for such a range to be
945 /* Actually NITEMS elements. If you don't like this use of the
946 `struct hack', you can shove it up your ANSI (seriously, if the
947 committee tells us how to do it, we can probably go along). */
948 struct linetable_entry item[1];
951 /* How to relocate the symbols from each section in a symbol file.
952 Each struct contains an array of offsets.
953 The ordering and meaning of the offsets is file-type-dependent;
954 typically it is indexed by section numbers or symbol types or
957 To give us flexibility in changing the internal representation
958 of these offsets, the ANOFFSET macro must be used to insert and
959 extract offset values in the struct. */
961 struct section_offsets
963 CORE_ADDR offsets[1]; /* As many as needed. */
966 #define ANOFFSET(secoff, whichone) \
968 ? (internal_error (__FILE__, __LINE__, \
969 _("Section index is uninitialized")), -1) \
970 : secoff->offsets[whichone])
972 /* The size of a section_offsets table for N sections. */
973 #define SIZEOF_N_SECTION_OFFSETS(n) \
974 (sizeof (struct section_offsets) \
975 + sizeof (((struct section_offsets *) 0)->offsets) * ((n)-1))
977 /* Each source file or header is represented by a struct symtab.
978 The name "symtab" is historical, another name for it is "filetab".
979 These objects are chained through the `next' field. */
983 /* Unordered chain of all filetabs in the compunit, with the exception
984 that the "main" source file is the first entry in the list. */
988 /* Backlink to containing compunit symtab. */
990 struct compunit_symtab *compunit_symtab;
992 /* Table mapping core addresses to line numbers for this file.
993 Can be NULL if none. Never shared between different symtabs. */
995 struct linetable *linetable;
997 /* Name of this source file. This pointer is never NULL. */
999 const char *filename;
1001 /* Total number of lines found in source file. */
1005 /* line_charpos[N] is the position of the (N-1)th line of the
1006 source file. "position" means something we can lseek() to; it
1007 is not guaranteed to be useful any other way. */
1011 /* Language of this source file. */
1013 enum language language;
1015 /* Full name of file as found by searching the source path.
1016 NULL if not yet known. */
1021 #define SYMTAB_COMPUNIT(symtab) ((symtab)->compunit_symtab)
1022 #define SYMTAB_LINETABLE(symtab) ((symtab)->linetable)
1023 #define SYMTAB_LANGUAGE(symtab) ((symtab)->language)
1024 #define SYMTAB_BLOCKVECTOR(symtab) \
1025 COMPUNIT_BLOCKVECTOR (SYMTAB_COMPUNIT (symtab))
1026 #define SYMTAB_OBJFILE(symtab) \
1027 COMPUNIT_OBJFILE (SYMTAB_COMPUNIT (symtab))
1028 #define SYMTAB_PSPACE(symtab) (SYMTAB_OBJFILE (symtab)->pspace)
1029 #define SYMTAB_DIRNAME(symtab) \
1030 COMPUNIT_DIRNAME (SYMTAB_COMPUNIT (symtab))
1032 typedef struct symtab *symtab_ptr;
1033 DEF_VEC_P (symtab_ptr);
1035 /* Compunit symtabs contain the actual "symbol table", aka blockvector, as well
1036 as the list of all source files (what gdb has historically associated with
1038 Additional information is recorded here that is common to all symtabs in a
1039 compilation unit (DWARF or otherwise).
1042 For the case of a program built out of these files:
1051 This is recorded as:
1053 objfile -> foo.c(cu) -> bar.c(cu) -> NULL
1067 where "foo.c(cu)" and "bar.c(cu)" are struct compunit_symtab objects,
1068 and the files foo.c, etc. are struct symtab objects. */
1070 struct compunit_symtab
1072 /* Unordered chain of all compunit symtabs of this objfile. */
1073 struct compunit_symtab *next;
1075 /* Object file from which this symtab information was read. */
1076 struct objfile *objfile;
1078 /* Name of the symtab.
1079 This is *not* intended to be a usable filename, and is
1080 for debugging purposes only. */
1083 /* Unordered list of file symtabs, except that by convention the "main"
1084 source file (e.g., .c, .cc) is guaranteed to be first.
1085 Each symtab is a file, either the "main" source file (e.g., .c, .cc)
1086 or header (e.g., .h). */
1087 struct symtab *filetabs;
1089 /* Last entry in FILETABS list.
1090 Subfiles are added to the end of the list so they accumulate in order,
1091 with the main source subfile living at the front.
1092 The main reason is so that the main source file symtab is at the head
1093 of the list, and the rest appear in order for debugging convenience. */
1094 struct symtab *last_filetab;
1096 /* Non-NULL string that identifies the format of the debugging information,
1097 such as "stabs", "dwarf 1", "dwarf 2", "coff", etc. This is mostly useful
1098 for automated testing of gdb but may also be information that is
1099 useful to the user. */
1100 const char *debugformat;
1102 /* String of producer version information, or NULL if we don't know. */
1103 const char *producer;
1105 /* Directory in which it was compiled, or NULL if we don't know. */
1106 const char *dirname;
1108 /* List of all symbol scope blocks for this symtab. It is shared among
1109 all symtabs in a given compilation unit. */
1110 const struct blockvector *blockvector;
1112 /* Section in objfile->section_offsets for the blockvector and
1113 the linetable. Probably always SECT_OFF_TEXT. */
1114 int block_line_section;
1116 /* Symtab has been compiled with both optimizations and debug info so that
1117 GDB may stop skipping prologues as variables locations are valid already
1118 at function entry points. */
1119 unsigned int locations_valid : 1;
1121 /* DWARF unwinder for this CU is valid even for epilogues (PC at the return
1122 instruction). This is supported by GCC since 4.5.0. */
1123 unsigned int epilogue_unwind_valid : 1;
1125 /* struct call_site entries for this compilation unit or NULL. */
1126 htab_t call_site_htab;
1128 /* The macro table for this symtab. Like the blockvector, this
1129 is shared between different symtabs in a given compilation unit.
1130 It's debatable whether it *should* be shared among all the symtabs in
1131 the given compilation unit, but it currently is. */
1132 struct macro_table *macro_table;
1134 /* If non-NULL, then this points to a NULL-terminated vector of
1135 included compunits. When searching the static or global
1136 block of this compunit, the corresponding block of all
1137 included compunits will also be searched. Note that this
1138 list must be flattened -- the symbol reader is responsible for
1139 ensuring that this vector contains the transitive closure of all
1140 included compunits. */
1141 struct compunit_symtab **includes;
1143 /* If this is an included compunit, this points to one includer
1144 of the table. This user is considered the canonical compunit
1145 containing this one. An included compunit may itself be
1146 included by another. */
1147 struct compunit_symtab *user;
1150 #define COMPUNIT_OBJFILE(cust) ((cust)->objfile)
1151 #define COMPUNIT_FILETABS(cust) ((cust)->filetabs)
1152 #define COMPUNIT_DEBUGFORMAT(cust) ((cust)->debugformat)
1153 #define COMPUNIT_PRODUCER(cust) ((cust)->producer)
1154 #define COMPUNIT_DIRNAME(cust) ((cust)->dirname)
1155 #define COMPUNIT_BLOCKVECTOR(cust) ((cust)->blockvector)
1156 #define COMPUNIT_BLOCK_LINE_SECTION(cust) ((cust)->block_line_section)
1157 #define COMPUNIT_LOCATIONS_VALID(cust) ((cust)->locations_valid)
1158 #define COMPUNIT_EPILOGUE_UNWIND_VALID(cust) ((cust)->epilogue_unwind_valid)
1159 #define COMPUNIT_CALL_SITE_HTAB(cust) ((cust)->call_site_htab)
1160 #define COMPUNIT_MACRO_TABLE(cust) ((cust)->macro_table)
1162 /* Iterate over all file tables (struct symtab) within a compunit. */
1164 #define ALL_COMPUNIT_FILETABS(cu, s) \
1165 for ((s) = (cu) -> filetabs; (s) != NULL; (s) = (s) -> next)
1167 /* Return the primary symtab of CUST. */
1169 extern struct symtab *
1170 compunit_primary_filetab (const struct compunit_symtab *cust);
1172 /* Return the language of CUST. */
1174 extern enum language compunit_language (const struct compunit_symtab *cust);
1176 typedef struct compunit_symtab *compunit_symtab_ptr;
1177 DEF_VEC_P (compunit_symtab_ptr);
1181 /* The virtual function table is now an array of structures which have the
1182 form { int16 offset, delta; void *pfn; }.
1184 In normal virtual function tables, OFFSET is unused.
1185 DELTA is the amount which is added to the apparent object's base
1186 address in order to point to the actual object to which the
1187 virtual function should be applied.
1188 PFN is a pointer to the virtual function.
1190 Note that this macro is g++ specific (FIXME). */
1192 #define VTBL_FNADDR_OFFSET 2
1194 /* External variables and functions for the objects described above. */
1196 /* True if we are nested inside psymtab_to_symtab. */
1198 extern int currently_reading_symtab;
1200 /* symtab.c lookup functions */
1202 extern const char multiple_symbols_ask[];
1203 extern const char multiple_symbols_all[];
1204 extern const char multiple_symbols_cancel[];
1206 const char *multiple_symbols_select_mode (void);
1208 int symbol_matches_domain (enum language symbol_language,
1209 domain_enum symbol_domain,
1210 domain_enum domain);
1212 /* lookup a symbol table by source file name. */
1214 extern struct symtab *lookup_symtab (const char *);
1216 /* An object of this type is passed as the 'is_a_field_of_this'
1217 argument to lookup_symbol and lookup_symbol_in_language. */
1219 struct field_of_this_result
1221 /* The type in which the field was found. If this is NULL then the
1222 symbol was not found in 'this'. If non-NULL, then one of the
1223 other fields will be non-NULL as well. */
1227 /* If the symbol was found as an ordinary field of 'this', then this
1228 is non-NULL and points to the particular field. */
1230 struct field *field;
1232 /* If the symbol was found as a function field of 'this', then this
1233 is non-NULL and points to the particular field. */
1235 struct fn_fieldlist *fn_field;
1238 /* Find the definition for a specified symbol name NAME
1239 in domain DOMAIN in language LANGUAGE, visible from lexical block BLOCK
1240 if non-NULL or from global/static blocks if BLOCK is NULL.
1241 Returns the struct symbol pointer, or NULL if no symbol is found.
1242 C++: if IS_A_FIELD_OF_THIS is non-NULL on entry, check to see if
1243 NAME is a field of the current implied argument `this'. If so fill in the
1244 fields of IS_A_FIELD_OF_THIS, otherwise the fields are set to NULL.
1245 The symbol's section is fixed up if necessary. */
1247 extern struct block_symbol
1248 lookup_symbol_in_language (const char *,
1249 const struct block *,
1252 struct field_of_this_result *);
1254 /* Same as lookup_symbol_in_language, but using the current language. */
1256 extern struct block_symbol lookup_symbol (const char *,
1257 const struct block *,
1259 struct field_of_this_result *);
1261 /* A default version of lookup_symbol_nonlocal for use by languages
1262 that can't think of anything better to do.
1263 This implements the C lookup rules. */
1265 extern struct block_symbol
1266 basic_lookup_symbol_nonlocal (const struct language_defn *langdef,
1268 const struct block *,
1271 /* Some helper functions for languages that need to write their own
1272 lookup_symbol_nonlocal functions. */
1274 /* Lookup a symbol in the static block associated to BLOCK, if there
1275 is one; do nothing if BLOCK is NULL or a global block.
1276 Upon success fixes up the symbol's section if necessary. */
1278 extern struct block_symbol
1279 lookup_symbol_in_static_block (const char *name,
1280 const struct block *block,
1281 const domain_enum domain);
1283 /* Search all static file-level symbols for NAME from DOMAIN.
1284 Upon success fixes up the symbol's section if necessary. */
1286 extern struct block_symbol lookup_static_symbol (const char *name,
1287 const domain_enum domain);
1289 /* Lookup a symbol in all files' global blocks.
1291 If BLOCK is non-NULL then it is used for two things:
1292 1) If a target-specific lookup routine for libraries exists, then use the
1293 routine for the objfile of BLOCK, and
1294 2) The objfile of BLOCK is used to assist in determining the search order
1295 if the target requires it.
1296 See gdbarch_iterate_over_objfiles_in_search_order.
1298 Upon success fixes up the symbol's section if necessary. */
1300 extern struct block_symbol
1301 lookup_global_symbol (const char *name,
1302 const struct block *block,
1303 const domain_enum domain);
1305 /* Lookup a symbol in block BLOCK.
1306 Upon success fixes up the symbol's section if necessary. */
1308 extern struct symbol *
1309 lookup_symbol_in_block (const char *name,
1310 const struct block *block,
1311 const domain_enum domain);
1313 /* Look up the `this' symbol for LANG in BLOCK. Return the symbol if
1314 found, or NULL if not found. */
1316 extern struct block_symbol
1317 lookup_language_this (const struct language_defn *lang,
1318 const struct block *block);
1320 /* Lookup a [struct, union, enum] by name, within a specified block. */
1322 extern struct type *lookup_struct (const char *, const struct block *);
1324 extern struct type *lookup_union (const char *, const struct block *);
1326 extern struct type *lookup_enum (const char *, const struct block *);
1328 /* from blockframe.c: */
1330 /* lookup the function symbol corresponding to the address. */
1332 extern struct symbol *find_pc_function (CORE_ADDR);
1334 /* lookup the function corresponding to the address and section. */
1336 extern struct symbol *find_pc_sect_function (CORE_ADDR, struct obj_section *);
1338 extern int find_pc_partial_function_gnu_ifunc (CORE_ADDR pc, const char **name,
1341 int *is_gnu_ifunc_p);
1343 /* lookup function from address, return name, start addr and end addr. */
1345 extern int find_pc_partial_function (CORE_ADDR, const char **, CORE_ADDR *,
1348 extern void clear_pc_function_cache (void);
1350 /* Expand symtab containing PC, SECTION if not already expanded. */
1352 extern void expand_symtab_containing_pc (CORE_ADDR, struct obj_section *);
1354 /* lookup full symbol table by address. */
1356 extern struct compunit_symtab *find_pc_compunit_symtab (CORE_ADDR);
1358 /* lookup full symbol table by address and section. */
1360 extern struct compunit_symtab *
1361 find_pc_sect_compunit_symtab (CORE_ADDR, struct obj_section *);
1363 extern int find_pc_line_pc_range (CORE_ADDR, CORE_ADDR *, CORE_ADDR *);
1365 extern void reread_symbols (void);
1367 /* Look up a type named NAME in STRUCT_DOMAIN in the current language.
1368 The type returned must not be opaque -- i.e., must have at least one field
1371 extern struct type *lookup_transparent_type (const char *);
1373 extern struct type *basic_lookup_transparent_type (const char *);
1375 /* Macro for name of symbol to indicate a file compiled with gcc. */
1376 #ifndef GCC_COMPILED_FLAG_SYMBOL
1377 #define GCC_COMPILED_FLAG_SYMBOL "gcc_compiled."
1380 /* Macro for name of symbol to indicate a file compiled with gcc2. */
1381 #ifndef GCC2_COMPILED_FLAG_SYMBOL
1382 #define GCC2_COMPILED_FLAG_SYMBOL "gcc2_compiled."
1385 extern int in_gnu_ifunc_stub (CORE_ADDR pc);
1387 /* Functions for resolving STT_GNU_IFUNC symbols which are implemented only
1388 for ELF symbol files. */
1390 struct gnu_ifunc_fns
1392 /* See elf_gnu_ifunc_resolve_addr for its real implementation. */
1393 CORE_ADDR (*gnu_ifunc_resolve_addr) (struct gdbarch *gdbarch, CORE_ADDR pc);
1395 /* See elf_gnu_ifunc_resolve_name for its real implementation. */
1396 int (*gnu_ifunc_resolve_name) (const char *function_name,
1397 CORE_ADDR *function_address_p);
1399 /* See elf_gnu_ifunc_resolver_stop for its real implementation. */
1400 void (*gnu_ifunc_resolver_stop) (struct breakpoint *b);
1402 /* See elf_gnu_ifunc_resolver_return_stop for its real implementation. */
1403 void (*gnu_ifunc_resolver_return_stop) (struct breakpoint *b);
1406 #define gnu_ifunc_resolve_addr gnu_ifunc_fns_p->gnu_ifunc_resolve_addr
1407 #define gnu_ifunc_resolve_name gnu_ifunc_fns_p->gnu_ifunc_resolve_name
1408 #define gnu_ifunc_resolver_stop gnu_ifunc_fns_p->gnu_ifunc_resolver_stop
1409 #define gnu_ifunc_resolver_return_stop \
1410 gnu_ifunc_fns_p->gnu_ifunc_resolver_return_stop
1412 extern const struct gnu_ifunc_fns *gnu_ifunc_fns_p;
1414 extern CORE_ADDR find_solib_trampoline_target (struct frame_info *, CORE_ADDR);
1416 struct symtab_and_line
1418 /* The program space of this sal. */
1419 struct program_space *pspace;
1421 struct symtab *symtab;
1422 struct obj_section *section;
1423 /* Line number. Line numbers start at 1 and proceed through symtab->nlines.
1424 0 is never a valid line number; it is used to indicate that line number
1425 information is not available. */
1433 /* The probe associated with this symtab_and_line. */
1434 struct probe *probe;
1435 /* If PROBE is not NULL, then this is the objfile in which the probe
1437 struct objfile *objfile;
1440 extern void init_sal (struct symtab_and_line *sal);
1442 struct symtabs_and_lines
1444 struct symtab_and_line *sals;
1449 /* Given a pc value, return line number it is in. Second arg nonzero means
1450 if pc is on the boundary use the previous statement's line number. */
1452 extern struct symtab_and_line find_pc_line (CORE_ADDR, int);
1454 /* Same function, but specify a section as well as an address. */
1456 extern struct symtab_and_line find_pc_sect_line (CORE_ADDR,
1457 struct obj_section *, int);
1459 /* Wrapper around find_pc_line to just return the symtab. */
1461 extern struct symtab *find_pc_line_symtab (CORE_ADDR);
1463 /* Given a symtab and line number, return the pc there. */
1465 extern int find_line_pc (struct symtab *, int, CORE_ADDR *);
1467 extern int find_line_pc_range (struct symtab_and_line, CORE_ADDR *,
1470 extern void resolve_sal_pc (struct symtab_and_line *);
1474 extern void clear_solib (void);
1478 extern int identify_source_line (struct symtab *, int, int, CORE_ADDR);
1480 /* Flags passed as 4th argument to print_source_lines. */
1482 enum print_source_lines_flag
1484 /* Do not print an error message. */
1485 PRINT_SOURCE_LINES_NOERROR = (1 << 0),
1487 /* Print the filename in front of the source lines. */
1488 PRINT_SOURCE_LINES_FILENAME = (1 << 1)
1490 DEF_ENUM_FLAGS_TYPE (enum print_source_lines_flag, print_source_lines_flags);
1492 extern void print_source_lines (struct symtab *, int, int,
1493 print_source_lines_flags);
1495 extern void forget_cached_source_info_for_objfile (struct objfile *);
1496 extern void forget_cached_source_info (void);
1498 extern void select_source_symtab (struct symtab *);
1500 extern VEC (char_ptr) *default_make_symbol_completion_list_break_on
1501 (const char *text, const char *word, const char *break_on,
1502 enum type_code code);
1503 extern VEC (char_ptr) *default_make_symbol_completion_list (const char *,
1506 extern VEC (char_ptr) *make_symbol_completion_list (const char *, const char *);
1507 extern VEC (char_ptr) *make_symbol_completion_type (const char *, const char *,
1509 extern VEC (char_ptr) *make_symbol_completion_list_fn (struct cmd_list_element *,
1513 extern VEC (char_ptr) *make_file_symbol_completion_list (const char *,
1517 extern VEC (char_ptr) *make_source_files_completion_list (const char *,
1522 int matching_obj_sections (struct obj_section *, struct obj_section *);
1524 extern struct symtab *find_line_symtab (struct symtab *, int, int *, int *);
1526 extern struct symtab_and_line find_function_start_sal (struct symbol *sym,
1529 extern void skip_prologue_sal (struct symtab_and_line *);
1533 extern CORE_ADDR skip_prologue_using_sal (struct gdbarch *gdbarch,
1534 CORE_ADDR func_addr);
1536 extern struct symbol *fixup_symbol_section (struct symbol *,
1539 /* Symbol searching */
1540 /* Note: struct symbol_search, search_symbols, et.al. are declared here,
1541 instead of making them local to symtab.c, for gdbtk's sake. */
1543 /* When using search_symbols, a list of the following structs is returned.
1544 Callers must free the search list using free_search_symbols! */
1545 struct symbol_search
1547 /* The block in which the match was found. Could be, for example,
1548 STATIC_BLOCK or GLOBAL_BLOCK. */
1551 /* Information describing what was found.
1553 If symbol is NOT NULL, then information was found for this match. */
1554 struct symbol *symbol;
1556 /* If msymbol is non-null, then a match was made on something for
1557 which only minimal_symbols exist. */
1558 struct bound_minimal_symbol msymbol;
1560 /* A link to the next match, or NULL for the end. */
1561 struct symbol_search *next;
1564 extern void search_symbols (const char *, enum search_domain, int,
1565 const char **, struct symbol_search **);
1566 extern void free_search_symbols (struct symbol_search *);
1567 extern struct cleanup *make_cleanup_free_search_symbols (struct symbol_search
1570 /* The name of the ``main'' function.
1571 FIXME: cagney/2001-03-20: Can't make main_name() const since some
1572 of the calling code currently assumes that the string isn't
1574 extern /*const */ char *main_name (void);
1575 extern enum language main_language (void);
1577 /* Lookup symbol NAME from DOMAIN in MAIN_OBJFILE's global blocks.
1578 This searches MAIN_OBJFILE as well as any associated separate debug info
1579 objfiles of MAIN_OBJFILE.
1580 Upon success fixes up the symbol's section if necessary. */
1582 extern struct block_symbol
1583 lookup_global_symbol_from_objfile (struct objfile *main_objfile,
1585 const domain_enum domain);
1587 /* Return 1 if the supplied producer string matches the ARM RealView
1588 compiler (armcc). */
1589 int producer_is_realview (const char *producer);
1591 void fixup_section (struct general_symbol_info *ginfo,
1592 CORE_ADDR addr, struct objfile *objfile);
1594 /* Look up objfile containing BLOCK. */
1596 struct objfile *lookup_objfile_from_block (const struct block *block);
1598 extern unsigned int symtab_create_debug;
1600 extern unsigned int symbol_lookup_debug;
1602 extern int basenames_may_differ;
1604 int compare_filenames_for_search (const char *filename,
1605 const char *search_name);
1607 int compare_glob_filenames_for_search (const char *filename,
1608 const char *search_name);
1610 int iterate_over_some_symtabs (const char *name,
1611 const char *real_path,
1612 int (*callback) (struct symtab *symtab,
1615 struct compunit_symtab *first,
1616 struct compunit_symtab *after_last);
1618 void iterate_over_symtabs (const char *name,
1619 int (*callback) (struct symtab *symtab,
1623 VEC (CORE_ADDR) *find_pcs_for_symtab_line (struct symtab *symtab, int line,
1624 struct linetable_entry **best_entry);
1626 /* Callback for LA_ITERATE_OVER_SYMBOLS. The callback will be called
1627 once per matching symbol SYM, with DATA being the argument of the
1628 same name that was passed to LA_ITERATE_OVER_SYMBOLS. The callback
1629 should return nonzero to indicate that LA_ITERATE_OVER_SYMBOLS
1630 should continue iterating, or zero to indicate that the iteration
1633 typedef int (symbol_found_callback_ftype) (struct symbol *sym, void *data);
1635 void iterate_over_symbols (const struct block *block, const char *name,
1636 const domain_enum domain,
1637 symbol_found_callback_ftype *callback,
1640 /* Storage type used by demangle_for_lookup. demangle_for_lookup
1641 either returns a const char * pointer that points to either of the
1642 fields of this type, or a pointer to the input NAME. This is done
1643 this way because the underlying functions that demangle_for_lookup
1644 calls either return a std::string (e.g., cp_canonicalize_string) or
1645 a malloc'ed buffer (libiberty's demangled), and we want to avoid
1646 unnecessary reallocation/string copying. */
1647 class demangle_result_storage
1651 /* Swap the std::string storage with STR, and return a pointer to
1652 the beginning of the new string. */
1653 const char *swap_string (std::string &str)
1655 std::swap (m_string, str);
1656 return m_string.c_str ();
1659 /* Set the malloc storage to now point at PTR. Any previous malloc
1660 storage is released. */
1661 const char *set_malloc_ptr (char *ptr)
1663 m_malloc.reset (ptr);
1670 std::string m_string;
1671 gdb::unique_xmalloc_ptr<char> m_malloc;
1675 demangle_for_lookup (const char *name, enum language lang,
1676 demangle_result_storage &storage);
1678 struct symbol *allocate_symbol (struct objfile *);
1680 void initialize_objfile_symbol (struct symbol *);
1682 struct template_symbol *allocate_template_symbol (struct objfile *);
1684 #endif /* !defined(SYMTAB_H) */