1 /* Symbol table definitions for GDB.
3 Copyright (C) 1986-2015 Free Software Foundation, Inc.
5 This file is part of GDB.
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program. If not, see <http://www.gnu.org/licenses/>. */
20 #if !defined (SYMTAB_H)
27 /* Opaque declarations. */
42 struct cmd_list_element
;
44 /* Some of the structures in this file are space critical.
45 The space-critical structures are:
47 struct general_symbol_info
51 These structures are laid out to encourage good packing.
52 They use ENUM_BITFIELD and short int fields, and they order the
53 structure members so that fields less than a word are next
54 to each other so they can be packed together. */
56 /* Rearranged: used ENUM_BITFIELD and rearranged field order in
57 all the space critical structures (plus struct minimal_symbol).
58 Memory usage dropped from 99360768 bytes to 90001408 bytes.
59 I measured this with before-and-after tests of
60 "HEAD-old-gdb -readnow HEAD-old-gdb" and
61 "HEAD-new-gdb -readnow HEAD-old-gdb" on native i686-pc-linux-gnu,
62 red hat linux 8, with LD_LIBRARY_PATH=/usr/lib/debug,
63 typing "maint space 1" at the first command prompt.
65 Here is another measurement (from andrew c):
66 # no /usr/lib/debug, just plain glibc, like a normal user
68 (gdb) break internal_error
70 (gdb) maint internal-error
74 gdb gdb_6_0_branch 2003-08-19 space used: 8896512
75 gdb HEAD 2003-08-19 space used: 8904704
76 gdb HEAD 2003-08-21 space used: 8396800 (+symtab.h)
77 gdb HEAD 2003-08-21 space used: 8265728 (+gdbtypes.h)
79 The third line shows the savings from the optimizations in symtab.h.
80 The fourth line shows the savings from the optimizations in
81 gdbtypes.h. Both optimizations are in gdb HEAD now.
83 --chastain 2003-08-21 */
85 /* Define a structure for the information that is common to all symbol types,
86 including minimal symbols, partial symbols, and full symbols. In a
87 multilanguage environment, some language specific information may need to
88 be recorded along with each symbol. */
90 /* This structure is space critical. See space comments at the top. */
92 struct general_symbol_info
94 /* Name of the symbol. This is a required field. Storage for the
95 name is allocated on the objfile_obstack for the associated
96 objfile. For languages like C++ that make a distinction between
97 the mangled name and demangled name, this is the mangled
102 /* Value of the symbol. Which member of this union to use, and what
103 it means, depends on what kind of symbol this is and its
104 SYMBOL_CLASS. See comments there for more details. All of these
105 are in host byte order (though what they point to might be in
106 target byte order, e.g. LOC_CONST_BYTES). */
112 const struct block
*block
;
114 const gdb_byte
*bytes
;
118 /* A common block. Used with LOC_COMMON_BLOCK. */
120 const struct common_block
*common_block
;
122 /* For opaque typedef struct chain. */
124 struct symbol
*chain
;
128 /* Since one and only one language can apply, wrap the language specific
129 information inside a union. */
133 /* A pointer to an obstack that can be used for storage associated
134 with this symbol. This is only used by Ada, and only when the
135 'ada_mangled' field is zero. */
136 struct obstack
*obstack
;
138 /* This is used by languages which wish to store a demangled name.
139 currently used by Ada, C++, Java, and Objective C. */
142 const char *demangled_name
;
148 /* Record the source code language that applies to this symbol.
149 This is used to select one of the fields from the language specific
152 ENUM_BITFIELD(language
) language
: LANGUAGE_BITS
;
154 /* This is only used by Ada. If set, then the 'mangled_lang' field
155 of language_specific is valid. Otherwise, the 'obstack' field is
157 unsigned int ada_mangled
: 1;
159 /* Which section is this symbol in? This is an index into
160 section_offsets for this objfile. Negative means that the symbol
161 does not get relocated relative to a section. */
166 extern void symbol_set_demangled_name (struct general_symbol_info
*,
170 extern const char *symbol_get_demangled_name
171 (const struct general_symbol_info
*);
173 extern CORE_ADDR
symbol_overlayed_address (CORE_ADDR
, struct obj_section
*);
175 /* Note that all the following SYMBOL_* macros are used with the
176 SYMBOL argument being either a partial symbol or
177 a full symbol. Both types have a ginfo field. In particular
178 the SYMBOL_SET_LANGUAGE, SYMBOL_DEMANGLED_NAME, etc.
179 macros cannot be entirely substituted by
180 functions, unless the callers are changed to pass in the ginfo
181 field only, instead of the SYMBOL parameter. */
183 #define SYMBOL_VALUE(symbol) (symbol)->ginfo.value.ivalue
184 #define SYMBOL_VALUE_ADDRESS(symbol) (symbol)->ginfo.value.address
185 #define SYMBOL_VALUE_BYTES(symbol) (symbol)->ginfo.value.bytes
186 #define SYMBOL_VALUE_COMMON_BLOCK(symbol) (symbol)->ginfo.value.common_block
187 #define SYMBOL_BLOCK_VALUE(symbol) (symbol)->ginfo.value.block
188 #define SYMBOL_VALUE_CHAIN(symbol) (symbol)->ginfo.value.chain
189 #define SYMBOL_LANGUAGE(symbol) (symbol)->ginfo.language
190 #define SYMBOL_SECTION(symbol) (symbol)->ginfo.section
191 #define SYMBOL_OBJ_SECTION(objfile, symbol) \
192 (((symbol)->ginfo.section >= 0) \
193 ? (&(((objfile)->sections)[(symbol)->ginfo.section])) \
196 /* Initializes the language dependent portion of a symbol
197 depending upon the language for the symbol. */
198 #define SYMBOL_SET_LANGUAGE(symbol,language,obstack) \
199 (symbol_set_language (&(symbol)->ginfo, (language), (obstack)))
200 extern void symbol_set_language (struct general_symbol_info
*symbol
,
201 enum language language
,
202 struct obstack
*obstack
);
204 /* Set just the linkage name of a symbol; do not try to demangle
205 it. Used for constructs which do not have a mangled name,
206 e.g. struct tags. Unlike SYMBOL_SET_NAMES, linkage_name must
207 be terminated and either already on the objfile's obstack or
208 permanently allocated. */
209 #define SYMBOL_SET_LINKAGE_NAME(symbol,linkage_name) \
210 (symbol)->ginfo.name = (linkage_name)
212 /* Set the linkage and natural names of a symbol, by demangling
214 #define SYMBOL_SET_NAMES(symbol,linkage_name,len,copy_name,objfile) \
215 symbol_set_names (&(symbol)->ginfo, linkage_name, len, copy_name, objfile)
216 extern void symbol_set_names (struct general_symbol_info
*symbol
,
217 const char *linkage_name
, int len
, int copy_name
,
218 struct objfile
*objfile
);
220 /* Now come lots of name accessor macros. Short version as to when to
221 use which: Use SYMBOL_NATURAL_NAME to refer to the name of the
222 symbol in the original source code. Use SYMBOL_LINKAGE_NAME if you
223 want to know what the linker thinks the symbol's name is. Use
224 SYMBOL_PRINT_NAME for output. Use SYMBOL_DEMANGLED_NAME if you
225 specifically need to know whether SYMBOL_NATURAL_NAME and
226 SYMBOL_LINKAGE_NAME are different. */
228 /* Return SYMBOL's "natural" name, i.e. the name that it was called in
229 the original source code. In languages like C++ where symbols may
230 be mangled for ease of manipulation by the linker, this is the
233 #define SYMBOL_NATURAL_NAME(symbol) \
234 (symbol_natural_name (&(symbol)->ginfo))
235 extern const char *symbol_natural_name
236 (const struct general_symbol_info
*symbol
);
238 /* Return SYMBOL's name from the point of view of the linker. In
239 languages like C++ where symbols may be mangled for ease of
240 manipulation by the linker, this is the mangled name; otherwise,
241 it's the same as SYMBOL_NATURAL_NAME. */
243 #define SYMBOL_LINKAGE_NAME(symbol) (symbol)->ginfo.name
245 /* Return the demangled name for a symbol based on the language for
246 that symbol. If no demangled name exists, return NULL. */
247 #define SYMBOL_DEMANGLED_NAME(symbol) \
248 (symbol_demangled_name (&(symbol)->ginfo))
249 extern const char *symbol_demangled_name
250 (const struct general_symbol_info
*symbol
);
252 /* Macro that returns a version of the name of a symbol that is
253 suitable for output. In C++ this is the "demangled" form of the
254 name if demangle is on and the "mangled" form of the name if
255 demangle is off. In other languages this is just the symbol name.
256 The result should never be NULL. Don't use this for internal
257 purposes (e.g. storing in a hashtable): it's only suitable for output.
259 N.B. symbol may be anything with a ginfo member,
260 e.g., struct symbol or struct minimal_symbol. */
262 #define SYMBOL_PRINT_NAME(symbol) \
263 (demangle ? SYMBOL_NATURAL_NAME (symbol) : SYMBOL_LINKAGE_NAME (symbol))
266 /* Macro that returns the name to be used when sorting and searching symbols.
267 In C++ and Java, we search for the demangled form of a name,
268 and so sort symbols accordingly. In Ada, however, we search by mangled
269 name. If there is no distinct demangled name, then SYMBOL_SEARCH_NAME
270 returns the same value (same pointer) as SYMBOL_LINKAGE_NAME. */
271 #define SYMBOL_SEARCH_NAME(symbol) \
272 (symbol_search_name (&(symbol)->ginfo))
273 extern const char *symbol_search_name (const struct general_symbol_info
*);
275 /* Return non-zero if NAME matches the "search" name of SYMBOL.
276 Whitespace and trailing parentheses are ignored.
277 See strcmp_iw for details about its behavior. */
278 #define SYMBOL_MATCHES_SEARCH_NAME(symbol, name) \
279 (strcmp_iw (SYMBOL_SEARCH_NAME (symbol), (name)) == 0)
281 /* Classification types for a minimal symbol. These should be taken as
282 "advisory only", since if gdb can't easily figure out a
283 classification it simply selects mst_unknown. It may also have to
284 guess when it can't figure out which is a better match between two
285 types (mst_data versus mst_bss) for example. Since the minimal
286 symbol info is sometimes derived from the BFD library's view of a
287 file, we need to live with what information bfd supplies. */
289 enum minimal_symbol_type
291 mst_unknown
= 0, /* Unknown type, the default */
292 mst_text
, /* Generally executable instructions */
293 mst_text_gnu_ifunc
, /* Executable code returning address
294 of executable code */
295 mst_slot_got_plt
, /* GOT entries for .plt sections */
296 mst_data
, /* Generally initialized data */
297 mst_bss
, /* Generally uninitialized data */
298 mst_abs
, /* Generally absolute (nonrelocatable) */
299 /* GDB uses mst_solib_trampoline for the start address of a shared
300 library trampoline entry. Breakpoints for shared library functions
301 are put there if the shared library is not yet loaded.
302 After the shared library is loaded, lookup_minimal_symbol will
303 prefer the minimal symbol from the shared library (usually
304 a mst_text symbol) over the mst_solib_trampoline symbol, and the
305 breakpoints will be moved to their true address in the shared
306 library via breakpoint_re_set. */
307 mst_solib_trampoline
, /* Shared library trampoline code */
308 /* For the mst_file* types, the names are only guaranteed to be unique
309 within a given .o file. */
310 mst_file_text
, /* Static version of mst_text */
311 mst_file_data
, /* Static version of mst_data */
312 mst_file_bss
, /* Static version of mst_bss */
316 /* The number of enum minimal_symbol_type values, with some padding for
317 reasonable growth. */
318 #define MINSYM_TYPE_BITS 4
319 gdb_static_assert (nr_minsym_types
<= (1 << MINSYM_TYPE_BITS
));
321 /* Define a simple structure used to hold some very basic information about
322 all defined global symbols (text, data, bss, abs, etc). The only required
323 information is the general_symbol_info.
325 In many cases, even if a file was compiled with no special options for
326 debugging at all, as long as was not stripped it will contain sufficient
327 information to build a useful minimal symbol table using this structure.
328 Even when a file contains enough debugging information to build a full
329 symbol table, these minimal symbols are still useful for quickly mapping
330 between names and addresses, and vice versa. They are also sometimes
331 used to figure out what full symbol table entries need to be read in. */
333 struct minimal_symbol
336 /* The general symbol info required for all types of symbols.
338 The SYMBOL_VALUE_ADDRESS contains the address that this symbol
341 struct general_symbol_info mginfo
;
343 /* Size of this symbol. dbx_end_psymtab in dbxread.c uses this
344 information to calculate the end of the partial symtab based on the
345 address of the last symbol plus the size of the last symbol. */
349 /* Which source file is this symbol in? Only relevant for mst_file_*. */
350 const char *filename
;
352 /* Classification type for this minimal symbol. */
354 ENUM_BITFIELD(minimal_symbol_type
) type
: MINSYM_TYPE_BITS
;
356 /* Non-zero if this symbol was created by gdb.
357 Such symbols do not appear in the output of "info var|fun". */
358 unsigned int created_by_gdb
: 1;
360 /* Two flag bits provided for the use of the target. */
361 unsigned int target_flag_1
: 1;
362 unsigned int target_flag_2
: 1;
364 /* Nonzero iff the size of the minimal symbol has been set.
365 Symbol size information can sometimes not be determined, because
366 the object file format may not carry that piece of information. */
367 unsigned int has_size
: 1;
369 /* Minimal symbols with the same hash key are kept on a linked
370 list. This is the link. */
372 struct minimal_symbol
*hash_next
;
374 /* Minimal symbols are stored in two different hash tables. This is
375 the `next' pointer for the demangled hash table. */
377 struct minimal_symbol
*demangled_hash_next
;
380 #define MSYMBOL_TARGET_FLAG_1(msymbol) (msymbol)->target_flag_1
381 #define MSYMBOL_TARGET_FLAG_2(msymbol) (msymbol)->target_flag_2
382 #define MSYMBOL_SIZE(msymbol) ((msymbol)->size + 0)
383 #define SET_MSYMBOL_SIZE(msymbol, sz) \
386 (msymbol)->size = sz; \
387 (msymbol)->has_size = 1; \
389 #define MSYMBOL_HAS_SIZE(msymbol) ((msymbol)->has_size + 0)
390 #define MSYMBOL_TYPE(msymbol) (msymbol)->type
392 #define MSYMBOL_VALUE(symbol) (symbol)->mginfo.value.ivalue
393 /* The unrelocated address of the minimal symbol. */
394 #define MSYMBOL_VALUE_RAW_ADDRESS(symbol) ((symbol)->mginfo.value.address + 0)
395 /* The relocated address of the minimal symbol, using the section
396 offsets from OBJFILE. */
397 #define MSYMBOL_VALUE_ADDRESS(objfile, symbol) \
398 ((symbol)->mginfo.value.address \
399 + ANOFFSET ((objfile)->section_offsets, ((symbol)->mginfo.section)))
400 /* For a bound minsym, we can easily compute the address directly. */
401 #define BMSYMBOL_VALUE_ADDRESS(symbol) \
402 MSYMBOL_VALUE_ADDRESS ((symbol).objfile, (symbol).minsym)
403 #define SET_MSYMBOL_VALUE_ADDRESS(symbol, new_value) \
404 ((symbol)->mginfo.value.address = (new_value))
405 #define MSYMBOL_VALUE_BYTES(symbol) (symbol)->mginfo.value.bytes
406 #define MSYMBOL_BLOCK_VALUE(symbol) (symbol)->mginfo.value.block
407 #define MSYMBOL_VALUE_CHAIN(symbol) (symbol)->mginfo.value.chain
408 #define MSYMBOL_LANGUAGE(symbol) (symbol)->mginfo.language
409 #define MSYMBOL_SECTION(symbol) (symbol)->mginfo.section
410 #define MSYMBOL_OBJ_SECTION(objfile, symbol) \
411 (((symbol)->mginfo.section >= 0) \
412 ? (&(((objfile)->sections)[(symbol)->mginfo.section])) \
415 #define MSYMBOL_NATURAL_NAME(symbol) \
416 (symbol_natural_name (&(symbol)->mginfo))
417 #define MSYMBOL_LINKAGE_NAME(symbol) (symbol)->mginfo.name
418 #define MSYMBOL_PRINT_NAME(symbol) \
419 (demangle ? MSYMBOL_NATURAL_NAME (symbol) : MSYMBOL_LINKAGE_NAME (symbol))
420 #define MSYMBOL_DEMANGLED_NAME(symbol) \
421 (symbol_demangled_name (&(symbol)->mginfo))
422 #define MSYMBOL_SET_LANGUAGE(symbol,language,obstack) \
423 (symbol_set_language (&(symbol)->mginfo, (language), (obstack)))
424 #define MSYMBOL_SEARCH_NAME(symbol) \
425 (symbol_search_name (&(symbol)->mginfo))
426 #define MSYMBOL_MATCHES_SEARCH_NAME(symbol, name) \
427 (strcmp_iw (MSYMBOL_SEARCH_NAME (symbol), (name)) == 0)
428 #define MSYMBOL_SET_NAMES(symbol,linkage_name,len,copy_name,objfile) \
429 symbol_set_names (&(symbol)->mginfo, linkage_name, len, copy_name, objfile)
435 /* Represent one symbol name; a variable, constant, function or typedef. */
437 /* Different name domains for symbols. Looking up a symbol specifies a
438 domain and ignores symbol definitions in other name domains. */
440 typedef enum domain_enum_tag
442 /* UNDEF_DOMAIN is used when a domain has not been discovered or
443 none of the following apply. This usually indicates an error either
444 in the symbol information or in gdb's handling of symbols. */
448 /* VAR_DOMAIN is the usual domain. In C, this contains variables,
449 function names, typedef names and enum type values. */
453 /* STRUCT_DOMAIN is used in C to hold struct, union and enum type names.
454 Thus, if `struct foo' is used in a C program, it produces a symbol named
455 `foo' in the STRUCT_DOMAIN. */
459 /* MODULE_DOMAIN is used in Fortran to hold module type names. */
463 /* LABEL_DOMAIN may be used for names of labels (for gotos). */
467 /* Fortran common blocks. Their naming must be separate from VAR_DOMAIN.
468 They also always use LOC_COMMON_BLOCK. */
471 /* This must remain last. */
475 /* The number of bits in a symbol used to represent the domain. */
477 #define SYMBOL_DOMAIN_BITS 3
478 gdb_static_assert (NR_DOMAINS
<= (1 << SYMBOL_DOMAIN_BITS
));
480 extern const char *domain_name (domain_enum
);
482 /* Searching domains, used for `search_symbols'. Element numbers are
483 hardcoded in GDB, check all enum uses before changing it. */
487 /* Everything in VAR_DOMAIN minus FUNCTIONS_DOMAIN and
489 VARIABLES_DOMAIN
= 0,
491 /* All functions -- for some reason not methods, though. */
492 FUNCTIONS_DOMAIN
= 1,
494 /* All defined types */
501 extern const char *search_domain_name (enum search_domain
);
503 /* An address-class says where to find the value of a symbol. */
507 /* Not used; catches errors. */
511 /* Value is constant int SYMBOL_VALUE, host byteorder. */
515 /* Value is at fixed address SYMBOL_VALUE_ADDRESS. */
519 /* Value is in register. SYMBOL_VALUE is the register number
520 in the original debug format. SYMBOL_REGISTER_OPS holds a
521 function that can be called to transform this into the
522 actual register number this represents in a specific target
523 architecture (gdbarch).
525 For some symbol formats (stabs, for some compilers at least),
526 the compiler generates two symbols, an argument and a register.
527 In some cases we combine them to a single LOC_REGISTER in symbol
528 reading, but currently not for all cases (e.g. it's passed on the
529 stack and then loaded into a register). */
533 /* It's an argument; the value is at SYMBOL_VALUE offset in arglist. */
537 /* Value address is at SYMBOL_VALUE offset in arglist. */
541 /* Value is in specified register. Just like LOC_REGISTER except the
542 register holds the address of the argument instead of the argument
543 itself. This is currently used for the passing of structs and unions
544 on sparc and hppa. It is also used for call by reference where the
545 address is in a register, at least by mipsread.c. */
549 /* Value is a local variable at SYMBOL_VALUE offset in stack frame. */
553 /* Value not used; definition in SYMBOL_TYPE. Symbols in the domain
554 STRUCT_DOMAIN all have this class. */
558 /* Value is address SYMBOL_VALUE_ADDRESS in the code. */
562 /* In a symbol table, value is SYMBOL_BLOCK_VALUE of a `struct block'.
563 In a partial symbol table, SYMBOL_VALUE_ADDRESS is the start address
564 of the block. Function names have this class. */
568 /* Value is a constant byte-sequence pointed to by SYMBOL_VALUE_BYTES, in
569 target byte order. */
573 /* Value is at fixed address, but the address of the variable has
574 to be determined from the minimal symbol table whenever the
575 variable is referenced.
576 This happens if debugging information for a global symbol is
577 emitted and the corresponding minimal symbol is defined
578 in another object file or runtime common storage.
579 The linker might even remove the minimal symbol if the global
580 symbol is never referenced, in which case the symbol remains
583 GDB would normally find the symbol in the minimal symbol table if it will
584 not find it in the full symbol table. But a reference to an external
585 symbol in a local block shadowing other definition requires full symbol
586 without possibly having its address available for LOC_STATIC. Testcase
587 is provided as `gdb.dwarf2/dw2-unresolved.exp'.
589 This is also used for thread local storage (TLS) variables. In this case,
590 the address of the TLS variable must be determined when the variable is
591 referenced, from the MSYMBOL_VALUE_RAW_ADDRESS, which is the offset
592 of the TLS variable in the thread local storage of the shared
597 /* The variable does not actually exist in the program.
598 The value is ignored. */
602 /* The variable's address is computed by a set of location
603 functions (see "struct symbol_computed_ops" below). */
606 /* The variable uses general_symbol_info->value->common_block field.
607 It also always uses COMMON_BLOCK_DOMAIN. */
610 /* Not used, just notes the boundary of the enum. */
614 /* The number of bits needed for values in enum address_class, with some
615 padding for reasonable growth, and room for run-time registered address
616 classes. See symtab.c:MAX_SYMBOL_IMPLS.
617 This is a #define so that we can have a assertion elsewhere to
618 verify that we have reserved enough space for synthetic address
620 #define SYMBOL_ACLASS_BITS 5
621 gdb_static_assert (LOC_FINAL_VALUE
<= (1 << SYMBOL_ACLASS_BITS
));
623 /* The methods needed to implement LOC_COMPUTED. These methods can
624 use the symbol's .aux_value for additional per-symbol information.
626 At present this is only used to implement location expressions. */
628 struct symbol_computed_ops
631 /* Return the value of the variable SYMBOL, relative to the stack
632 frame FRAME. If the variable has been optimized out, return
635 Iff `read_needs_frame (SYMBOL)' is zero, then 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 /* Return non-zero if we need a frame to find the value of the SYMBOL. */
647 int (*read_needs_frame
) (struct symbol
* symbol
);
649 /* Write to STREAM a natural-language description of the location of
650 SYMBOL, in the context of ADDR. */
651 void (*describe_location
) (struct symbol
* symbol
, CORE_ADDR addr
,
652 struct ui_file
* stream
);
654 /* Non-zero if this symbol's address computation is dependent on PC. */
655 unsigned char location_has_loclist
;
657 /* Tracepoint support. Append bytecodes to the tracepoint agent
658 expression AX that push the address of the object SYMBOL. Set
659 VALUE appropriately. Note --- for objects in registers, this
660 needn't emit any code; as long as it sets VALUE properly, then
661 the caller will generate the right code in the process of
662 treating this as an lvalue or rvalue. */
664 void (*tracepoint_var_ref
) (struct symbol
*symbol
, struct gdbarch
*gdbarch
,
665 struct agent_expr
*ax
, struct axs_value
*value
);
667 /* Generate C code to compute the location of SYMBOL. The C code is
668 emitted to STREAM. GDBARCH is the current architecture and PC is
669 the PC at which SYMBOL's location should be evaluated.
670 REGISTERS_USED is a vector indexed by register number; the
671 generator function should set an element in this vector if the
672 corresponding register is needed by the location computation.
673 The generated C code must assign the location to a local
674 variable; this variable's name is RESULT_NAME. */
676 void (*generate_c_location
) (struct symbol
*symbol
, struct ui_file
*stream
,
677 struct gdbarch
*gdbarch
,
678 unsigned char *registers_used
,
679 CORE_ADDR pc
, const char *result_name
);
683 /* The methods needed to implement LOC_BLOCK for inferior functions.
684 These methods can use the symbol's .aux_value for additional
685 per-symbol information. */
687 struct symbol_block_ops
689 /* Fill in *START and *LENGTH with DWARF block data of function
690 FRAMEFUNC valid for inferior context address PC. Set *LENGTH to
691 zero if such location is not valid for PC; *START is left
692 uninitialized in such case. */
693 void (*find_frame_base_location
) (struct symbol
*framefunc
, CORE_ADDR pc
,
694 const gdb_byte
**start
, size_t *length
);
696 /* Return the frame base address. FRAME is the frame for which we want to
697 compute the base address while FRAMEFUNC is the symbol for the
698 corresponding function. Return 0 on failure (FRAMEFUNC may not hold the
699 information we need).
701 This method is designed to work with static links (nested functions
702 handling). Static links are function properties whose evaluation returns
703 the frame base address for the enclosing frame. However, there are
704 multiple definitions for "frame base": the content of the frame base
705 register, the CFA as defined by DWARF unwinding information, ...
707 So this specific method is supposed to compute the frame base address such
708 as for nested fuctions, the static link computes the same address. For
709 instance, considering DWARF debugging information, the static link is
710 computed with DW_AT_static_link and this method must be used to compute
711 the corresponding DW_AT_frame_base attribute. */
712 CORE_ADDR (*get_frame_base
) (struct symbol
*framefunc
,
713 struct frame_info
*frame
);
716 /* Functions used with LOC_REGISTER and LOC_REGPARM_ADDR. */
718 struct symbol_register_ops
720 int (*register_number
) (struct symbol
*symbol
, struct gdbarch
*gdbarch
);
723 /* Objects of this type are used to find the address class and the
724 various computed ops vectors of a symbol. */
728 enum address_class aclass
;
730 /* Used with LOC_COMPUTED. */
731 const struct symbol_computed_ops
*ops_computed
;
733 /* Used with LOC_BLOCK. */
734 const struct symbol_block_ops
*ops_block
;
736 /* Used with LOC_REGISTER and LOC_REGPARM_ADDR. */
737 const struct symbol_register_ops
*ops_register
;
740 /* This structure is space critical. See space comments at the top. */
745 /* The general symbol info required for all types of symbols. */
747 struct general_symbol_info ginfo
;
749 /* Data type of value */
753 /* The owner of this symbol.
754 Which one to use is defined by symbol.is_objfile_owned. */
758 /* The symbol table containing this symbol. This is the file associated
759 with LINE. It can be NULL during symbols read-in but it is never NULL
760 during normal operation. */
761 struct symtab
*symtab
;
763 /* For types defined by the architecture. */
764 struct gdbarch
*arch
;
769 ENUM_BITFIELD(domain_enum_tag
) domain
: SYMBOL_DOMAIN_BITS
;
771 /* Address class. This holds an index into the 'symbol_impls'
772 table. The actual enum address_class value is stored there,
773 alongside any per-class ops vectors. */
775 unsigned int aclass_index
: SYMBOL_ACLASS_BITS
;
777 /* If non-zero then symbol is objfile-owned, use owner.symtab.
778 Otherwise symbol is arch-owned, use owner.arch. */
780 unsigned int is_objfile_owned
: 1;
782 /* Whether this is an argument. */
784 unsigned is_argument
: 1;
786 /* Whether this is an inlined function (class LOC_BLOCK only). */
787 unsigned is_inlined
: 1;
789 /* True if this is a C++ function symbol with template arguments.
790 In this case the symbol is really a "struct template_symbol". */
791 unsigned is_cplus_template_function
: 1;
793 /* Line number of this symbol's definition, except for inlined
794 functions. For an inlined function (class LOC_BLOCK and
795 SYMBOL_INLINED set) this is the line number of the function's call
796 site. Inlined function symbols are not definitions, and they are
797 never found by symbol table lookup.
798 If this symbol is arch-owned, LINE shall be zero.
800 FIXME: Should we really make the assumption that nobody will try
801 to debug files longer than 64K lines? What about machine
802 generated programs? */
806 /* An arbitrary data pointer, allowing symbol readers to record
807 additional information on a per-symbol basis. Note that this data
808 must be allocated using the same obstack as the symbol itself. */
809 /* So far it is only used by:
810 LOC_COMPUTED: to find the location information
811 LOC_BLOCK (DWARF2 function): information used internally by the
812 DWARF 2 code --- specifically, the location expression for the frame
813 base for this function. */
814 /* FIXME drow/2003-02-21: For the LOC_BLOCK case, it might be better
815 to add a magic symbol to the block containing this information,
816 or to have a generic debug info annotation slot for symbols. */
820 struct symbol
*hash_next
;
823 /* Several lookup functions return both a symbol and the block in which the
824 symbol is found. This structure is used in these cases. */
828 /* The symbol that was found, or NULL if no symbol was found. */
829 struct symbol
*symbol
;
831 /* If SYMBOL is not NULL, then this is the block in which the symbol is
833 const struct block
*block
;
836 extern const struct symbol_impl
*symbol_impls
;
838 /* Note: There is no accessor macro for symbol.owner because it is
841 #define SYMBOL_DOMAIN(symbol) (symbol)->domain
842 #define SYMBOL_IMPL(symbol) (symbol_impls[(symbol)->aclass_index])
843 #define SYMBOL_ACLASS_INDEX(symbol) (symbol)->aclass_index
844 #define SYMBOL_CLASS(symbol) (SYMBOL_IMPL (symbol).aclass)
845 #define SYMBOL_OBJFILE_OWNED(symbol) ((symbol)->is_objfile_owned)
846 #define SYMBOL_IS_ARGUMENT(symbol) (symbol)->is_argument
847 #define SYMBOL_INLINED(symbol) (symbol)->is_inlined
848 #define SYMBOL_IS_CPLUS_TEMPLATE_FUNCTION(symbol) \
849 (symbol)->is_cplus_template_function
850 #define SYMBOL_TYPE(symbol) (symbol)->type
851 #define SYMBOL_LINE(symbol) (symbol)->line
852 #define SYMBOL_COMPUTED_OPS(symbol) (SYMBOL_IMPL (symbol).ops_computed)
853 #define SYMBOL_BLOCK_OPS(symbol) (SYMBOL_IMPL (symbol).ops_block)
854 #define SYMBOL_REGISTER_OPS(symbol) (SYMBOL_IMPL (symbol).ops_register)
855 #define SYMBOL_LOCATION_BATON(symbol) (symbol)->aux_value
857 extern int register_symbol_computed_impl (enum address_class
,
858 const struct symbol_computed_ops
*);
860 extern int register_symbol_block_impl (enum address_class aclass
,
861 const struct symbol_block_ops
*ops
);
863 extern int register_symbol_register_impl (enum address_class
,
864 const struct symbol_register_ops
*);
866 /* Return the OBJFILE of SYMBOL.
867 It is an error to call this if symbol.is_objfile_owned is false, which
868 only happens for architecture-provided types. */
870 extern struct objfile
*symbol_objfile (const struct symbol
*symbol
);
872 /* Return the ARCH of SYMBOL. */
874 extern struct gdbarch
*symbol_arch (const struct symbol
*symbol
);
876 /* Return the SYMTAB of SYMBOL.
877 It is an error to call this if symbol.is_objfile_owned is false, which
878 only happens for architecture-provided types. */
880 extern struct symtab
*symbol_symtab (const struct symbol
*symbol
);
882 /* Set the symtab of SYMBOL to SYMTAB.
883 It is an error to call this if symbol.is_objfile_owned is false, which
884 only happens for architecture-provided types. */
886 extern void symbol_set_symtab (struct symbol
*symbol
, struct symtab
*symtab
);
888 /* An instance of this type is used to represent a C++ template
889 function. It includes a "struct symbol" as a kind of base class;
890 users downcast to "struct template_symbol *" when needed. A symbol
891 is really of this type iff SYMBOL_IS_CPLUS_TEMPLATE_FUNCTION is
894 struct template_symbol
896 /* The base class. */
899 /* The number of template arguments. */
900 int n_template_arguments
;
902 /* The template arguments. This is an array with
903 N_TEMPLATE_ARGUMENTS elements. */
904 struct symbol
**template_arguments
;
908 /* Each item represents a line-->pc (or the reverse) mapping. This is
909 somewhat more wasteful of space than one might wish, but since only
910 the files which are actually debugged are read in to core, we don't
913 struct linetable_entry
919 /* The order of entries in the linetable is significant. They should
920 be sorted by increasing values of the pc field. If there is more than
921 one entry for a given pc, then I'm not sure what should happen (and
922 I not sure whether we currently handle it the best way).
924 Example: a C for statement generally looks like this
926 10 0x100 - for the init/test part of a for stmt.
929 10 0x400 - for the increment part of a for stmt.
931 If an entry has a line number of zero, it marks the start of a PC
932 range for which no line number information is available. It is
933 acceptable, though wasteful of table space, for such a range to be
940 /* Actually NITEMS elements. If you don't like this use of the
941 `struct hack', you can shove it up your ANSI (seriously, if the
942 committee tells us how to do it, we can probably go along). */
943 struct linetable_entry item
[1];
946 /* How to relocate the symbols from each section in a symbol file.
947 Each struct contains an array of offsets.
948 The ordering and meaning of the offsets is file-type-dependent;
949 typically it is indexed by section numbers or symbol types or
952 To give us flexibility in changing the internal representation
953 of these offsets, the ANOFFSET macro must be used to insert and
954 extract offset values in the struct. */
956 struct section_offsets
958 CORE_ADDR offsets
[1]; /* As many as needed. */
961 #define ANOFFSET(secoff, whichone) \
963 ? (internal_error (__FILE__, __LINE__, \
964 _("Section index is uninitialized")), -1) \
965 : secoff->offsets[whichone])
967 /* The size of a section_offsets table for N sections. */
968 #define SIZEOF_N_SECTION_OFFSETS(n) \
969 (sizeof (struct section_offsets) \
970 + sizeof (((struct section_offsets *) 0)->offsets) * ((n)-1))
972 /* Each source file or header is represented by a struct symtab.
973 The name "symtab" is historical, another name for it is "filetab".
974 These objects are chained through the `next' field. */
978 /* Unordered chain of all filetabs in the compunit, with the exception
979 that the "main" source file is the first entry in the list. */
983 /* Backlink to containing compunit symtab. */
985 struct compunit_symtab
*compunit_symtab
;
987 /* Table mapping core addresses to line numbers for this file.
988 Can be NULL if none. Never shared between different symtabs. */
990 struct linetable
*linetable
;
992 /* Name of this source file. This pointer is never NULL. */
994 const char *filename
;
996 /* Total number of lines found in source file. */
1000 /* line_charpos[N] is the position of the (N-1)th line of the
1001 source file. "position" means something we can lseek() to; it
1002 is not guaranteed to be useful any other way. */
1006 /* Language of this source file. */
1008 enum language language
;
1010 /* Full name of file as found by searching the source path.
1011 NULL if not yet known. */
1016 #define SYMTAB_COMPUNIT(symtab) ((symtab)->compunit_symtab)
1017 #define SYMTAB_LINETABLE(symtab) ((symtab)->linetable)
1018 #define SYMTAB_LANGUAGE(symtab) ((symtab)->language)
1019 #define SYMTAB_BLOCKVECTOR(symtab) \
1020 COMPUNIT_BLOCKVECTOR (SYMTAB_COMPUNIT (symtab))
1021 #define SYMTAB_OBJFILE(symtab) \
1022 COMPUNIT_OBJFILE (SYMTAB_COMPUNIT (symtab))
1023 #define SYMTAB_PSPACE(symtab) (SYMTAB_OBJFILE (symtab)->pspace)
1024 #define SYMTAB_DIRNAME(symtab) \
1025 COMPUNIT_DIRNAME (SYMTAB_COMPUNIT (symtab))
1027 typedef struct symtab
*symtab_ptr
;
1028 DEF_VEC_P (symtab_ptr
);
1030 /* Compunit symtabs contain the actual "symbol table", aka blockvector, as well
1031 as the list of all source files (what gdb has historically associated with
1033 Additional information is recorded here that is common to all symtabs in a
1034 compilation unit (DWARF or otherwise).
1037 For the case of a program built out of these files:
1046 This is recorded as:
1048 objfile -> foo.c(cu) -> bar.c(cu) -> NULL
1062 where "foo.c(cu)" and "bar.c(cu)" are struct compunit_symtab objects,
1063 and the files foo.c, etc. are struct symtab objects. */
1065 struct compunit_symtab
1067 /* Unordered chain of all compunit symtabs of this objfile. */
1068 struct compunit_symtab
*next
;
1070 /* Object file from which this symtab information was read. */
1071 struct objfile
*objfile
;
1073 /* Name of the symtab.
1074 This is *not* intended to be a usable filename, and is
1075 for debugging purposes only. */
1078 /* Unordered list of file symtabs, except that by convention the "main"
1079 source file (e.g., .c, .cc) is guaranteed to be first.
1080 Each symtab is a file, either the "main" source file (e.g., .c, .cc)
1081 or header (e.g., .h). */
1082 struct symtab
*filetabs
;
1084 /* Last entry in FILETABS list.
1085 Subfiles are added to the end of the list so they accumulate in order,
1086 with the main source subfile living at the front.
1087 The main reason is so that the main source file symtab is at the head
1088 of the list, and the rest appear in order for debugging convenience. */
1089 struct symtab
*last_filetab
;
1091 /* Non-NULL string that identifies the format of the debugging information,
1092 such as "stabs", "dwarf 1", "dwarf 2", "coff", etc. This is mostly useful
1093 for automated testing of gdb but may also be information that is
1094 useful to the user. */
1095 const char *debugformat
;
1097 /* String of producer version information, or NULL if we don't know. */
1098 const char *producer
;
1100 /* Directory in which it was compiled, or NULL if we don't know. */
1101 const char *dirname
;
1103 /* List of all symbol scope blocks for this symtab. It is shared among
1104 all symtabs in a given compilation unit. */
1105 const struct blockvector
*blockvector
;
1107 /* Section in objfile->section_offsets for the blockvector and
1108 the linetable. Probably always SECT_OFF_TEXT. */
1109 int block_line_section
;
1111 /* Symtab has been compiled with both optimizations and debug info so that
1112 GDB may stop skipping prologues as variables locations are valid already
1113 at function entry points. */
1114 unsigned int locations_valid
: 1;
1116 /* DWARF unwinder for this CU is valid even for epilogues (PC at the return
1117 instruction). This is supported by GCC since 4.5.0. */
1118 unsigned int epilogue_unwind_valid
: 1;
1120 /* struct call_site entries for this compilation unit or NULL. */
1121 htab_t call_site_htab
;
1123 /* The macro table for this symtab. Like the blockvector, this
1124 is shared between different symtabs in a given compilation unit.
1125 It's debatable whether it *should* be shared among all the symtabs in
1126 the given compilation unit, but it currently is. */
1127 struct macro_table
*macro_table
;
1129 /* If non-NULL, then this points to a NULL-terminated vector of
1130 included compunits. When searching the static or global
1131 block of this compunit, the corresponding block of all
1132 included compunits will also be searched. Note that this
1133 list must be flattened -- the symbol reader is responsible for
1134 ensuring that this vector contains the transitive closure of all
1135 included compunits. */
1136 struct compunit_symtab
**includes
;
1138 /* If this is an included compunit, this points to one includer
1139 of the table. This user is considered the canonical compunit
1140 containing this one. An included compunit may itself be
1141 included by another. */
1142 struct compunit_symtab
*user
;
1145 #define COMPUNIT_OBJFILE(cust) ((cust)->objfile)
1146 #define COMPUNIT_FILETABS(cust) ((cust)->filetabs)
1147 #define COMPUNIT_DEBUGFORMAT(cust) ((cust)->debugformat)
1148 #define COMPUNIT_PRODUCER(cust) ((cust)->producer)
1149 #define COMPUNIT_DIRNAME(cust) ((cust)->dirname)
1150 #define COMPUNIT_BLOCKVECTOR(cust) ((cust)->blockvector)
1151 #define COMPUNIT_BLOCK_LINE_SECTION(cust) ((cust)->block_line_section)
1152 #define COMPUNIT_LOCATIONS_VALID(cust) ((cust)->locations_valid)
1153 #define COMPUNIT_EPILOGUE_UNWIND_VALID(cust) ((cust)->epilogue_unwind_valid)
1154 #define COMPUNIT_CALL_SITE_HTAB(cust) ((cust)->call_site_htab)
1155 #define COMPUNIT_MACRO_TABLE(cust) ((cust)->macro_table)
1157 /* Iterate over all file tables (struct symtab) within a compunit. */
1159 #define ALL_COMPUNIT_FILETABS(cu, s) \
1160 for ((s) = (cu) -> filetabs; (s) != NULL; (s) = (s) -> next)
1162 /* Return the primary symtab of CUST. */
1164 extern struct symtab
*
1165 compunit_primary_filetab (const struct compunit_symtab
*cust
);
1167 /* Return the language of CUST. */
1169 extern enum language
compunit_language (const struct compunit_symtab
*cust
);
1171 typedef struct compunit_symtab
*compunit_symtab_ptr
;
1172 DEF_VEC_P (compunit_symtab_ptr
);
1176 /* The virtual function table is now an array of structures which have the
1177 form { int16 offset, delta; void *pfn; }.
1179 In normal virtual function tables, OFFSET is unused.
1180 DELTA is the amount which is added to the apparent object's base
1181 address in order to point to the actual object to which the
1182 virtual function should be applied.
1183 PFN is a pointer to the virtual function.
1185 Note that this macro is g++ specific (FIXME). */
1187 #define VTBL_FNADDR_OFFSET 2
1189 /* External variables and functions for the objects described above. */
1191 /* True if we are nested inside psymtab_to_symtab. */
1193 extern int currently_reading_symtab
;
1195 /* symtab.c lookup functions */
1197 extern const char multiple_symbols_ask
[];
1198 extern const char multiple_symbols_all
[];
1199 extern const char multiple_symbols_cancel
[];
1201 const char *multiple_symbols_select_mode (void);
1203 int symbol_matches_domain (enum language symbol_language
,
1204 domain_enum symbol_domain
,
1205 domain_enum domain
);
1207 /* lookup a symbol table by source file name. */
1209 extern struct symtab
*lookup_symtab (const char *);
1211 /* An object of this type is passed as the 'is_a_field_of_this'
1212 argument to lookup_symbol and lookup_symbol_in_language. */
1214 struct field_of_this_result
1216 /* The type in which the field was found. If this is NULL then the
1217 symbol was not found in 'this'. If non-NULL, then one of the
1218 other fields will be non-NULL as well. */
1222 /* If the symbol was found as an ordinary field of 'this', then this
1223 is non-NULL and points to the particular field. */
1225 struct field
*field
;
1227 /* If the symbol was found as a function field of 'this', then this
1228 is non-NULL and points to the particular field. */
1230 struct fn_fieldlist
*fn_field
;
1233 /* Find the definition for a specified symbol name NAME
1234 in domain DOMAIN in language LANGUAGE, visible from lexical block BLOCK
1235 if non-NULL or from global/static blocks if BLOCK is NULL.
1236 Returns the struct symbol pointer, or NULL if no symbol is found.
1237 C++: if IS_A_FIELD_OF_THIS is non-NULL on entry, check to see if
1238 NAME is a field of the current implied argument `this'. If so fill in the
1239 fields of IS_A_FIELD_OF_THIS, otherwise the fields are set to NULL.
1240 The symbol's section is fixed up if necessary. */
1242 extern struct block_symbol
1243 lookup_symbol_in_language (const char *,
1244 const struct block
*,
1247 struct field_of_this_result
*);
1249 /* Same as lookup_symbol_in_language, but using the current language. */
1251 extern struct block_symbol
lookup_symbol (const char *,
1252 const struct block
*,
1254 struct field_of_this_result
*);
1256 /* A default version of lookup_symbol_nonlocal for use by languages
1257 that can't think of anything better to do.
1258 This implements the C lookup rules. */
1260 extern struct block_symbol
1261 basic_lookup_symbol_nonlocal (const struct language_defn
*langdef
,
1263 const struct block
*,
1266 /* Some helper functions for languages that need to write their own
1267 lookup_symbol_nonlocal functions. */
1269 /* Lookup a symbol in the static block associated to BLOCK, if there
1270 is one; do nothing if BLOCK is NULL or a global block.
1271 Upon success fixes up the symbol's section if necessary. */
1273 extern struct block_symbol
1274 lookup_symbol_in_static_block (const char *name
,
1275 const struct block
*block
,
1276 const domain_enum domain
);
1278 /* Search all static file-level symbols for NAME from DOMAIN.
1279 Upon success fixes up the symbol's section if necessary. */
1281 extern struct block_symbol
lookup_static_symbol (const char *name
,
1282 const domain_enum domain
);
1284 /* Lookup a symbol in all files' global blocks.
1286 If BLOCK is non-NULL then it is used for two things:
1287 1) If a target-specific lookup routine for libraries exists, then use the
1288 routine for the objfile of BLOCK, and
1289 2) The objfile of BLOCK is used to assist in determining the search order
1290 if the target requires it.
1291 See gdbarch_iterate_over_objfiles_in_search_order.
1293 Upon success fixes up the symbol's section if necessary. */
1295 extern struct block_symbol
1296 lookup_global_symbol (const char *name
,
1297 const struct block
*block
,
1298 const domain_enum domain
);
1300 /* Lookup a symbol in block BLOCK.
1301 Upon success fixes up the symbol's section if necessary. */
1303 extern struct symbol
*
1304 lookup_symbol_in_block (const char *name
,
1305 const struct block
*block
,
1306 const domain_enum domain
);
1308 /* Look up the `this' symbol for LANG in BLOCK. Return the symbol if
1309 found, or NULL if not found. */
1311 extern struct block_symbol
1312 lookup_language_this (const struct language_defn
*lang
,
1313 const struct block
*block
);
1315 /* Lookup a [struct, union, enum] by name, within a specified block. */
1317 extern struct type
*lookup_struct (const char *, const struct block
*);
1319 extern struct type
*lookup_union (const char *, const struct block
*);
1321 extern struct type
*lookup_enum (const char *, const struct block
*);
1323 /* from blockframe.c: */
1325 /* lookup the function symbol corresponding to the address. */
1327 extern struct symbol
*find_pc_function (CORE_ADDR
);
1329 /* lookup the function corresponding to the address and section. */
1331 extern struct symbol
*find_pc_sect_function (CORE_ADDR
, struct obj_section
*);
1333 extern int find_pc_partial_function_gnu_ifunc (CORE_ADDR pc
, const char **name
,
1336 int *is_gnu_ifunc_p
);
1338 /* lookup function from address, return name, start addr and end addr. */
1340 extern int find_pc_partial_function (CORE_ADDR
, const char **, CORE_ADDR
*,
1343 extern void clear_pc_function_cache (void);
1345 /* Expand symtab containing PC, SECTION if not already expanded. */
1347 extern void expand_symtab_containing_pc (CORE_ADDR
, struct obj_section
*);
1349 /* lookup full symbol table by address. */
1351 extern struct compunit_symtab
*find_pc_compunit_symtab (CORE_ADDR
);
1353 /* lookup full symbol table by address and section. */
1355 extern struct compunit_symtab
*
1356 find_pc_sect_compunit_symtab (CORE_ADDR
, struct obj_section
*);
1358 extern int find_pc_line_pc_range (CORE_ADDR
, CORE_ADDR
*, CORE_ADDR
*);
1360 extern void reread_symbols (void);
1362 /* Look up a type named NAME in STRUCT_DOMAIN in the current language.
1363 The type returned must not be opaque -- i.e., must have at least one field
1366 extern struct type
*lookup_transparent_type (const char *);
1368 extern struct type
*basic_lookup_transparent_type (const char *);
1370 /* Macro for name of symbol to indicate a file compiled with gcc. */
1371 #ifndef GCC_COMPILED_FLAG_SYMBOL
1372 #define GCC_COMPILED_FLAG_SYMBOL "gcc_compiled."
1375 /* Macro for name of symbol to indicate a file compiled with gcc2. */
1376 #ifndef GCC2_COMPILED_FLAG_SYMBOL
1377 #define GCC2_COMPILED_FLAG_SYMBOL "gcc2_compiled."
1380 extern int in_gnu_ifunc_stub (CORE_ADDR pc
);
1382 /* Functions for resolving STT_GNU_IFUNC symbols which are implemented only
1383 for ELF symbol files. */
1385 struct gnu_ifunc_fns
1387 /* See elf_gnu_ifunc_resolve_addr for its real implementation. */
1388 CORE_ADDR (*gnu_ifunc_resolve_addr
) (struct gdbarch
*gdbarch
, CORE_ADDR pc
);
1390 /* See elf_gnu_ifunc_resolve_name for its real implementation. */
1391 int (*gnu_ifunc_resolve_name
) (const char *function_name
,
1392 CORE_ADDR
*function_address_p
);
1394 /* See elf_gnu_ifunc_resolver_stop for its real implementation. */
1395 void (*gnu_ifunc_resolver_stop
) (struct breakpoint
*b
);
1397 /* See elf_gnu_ifunc_resolver_return_stop for its real implementation. */
1398 void (*gnu_ifunc_resolver_return_stop
) (struct breakpoint
*b
);
1401 #define gnu_ifunc_resolve_addr gnu_ifunc_fns_p->gnu_ifunc_resolve_addr
1402 #define gnu_ifunc_resolve_name gnu_ifunc_fns_p->gnu_ifunc_resolve_name
1403 #define gnu_ifunc_resolver_stop gnu_ifunc_fns_p->gnu_ifunc_resolver_stop
1404 #define gnu_ifunc_resolver_return_stop \
1405 gnu_ifunc_fns_p->gnu_ifunc_resolver_return_stop
1407 extern const struct gnu_ifunc_fns
*gnu_ifunc_fns_p
;
1409 extern CORE_ADDR
find_solib_trampoline_target (struct frame_info
*, CORE_ADDR
);
1411 struct symtab_and_line
1413 /* The program space of this sal. */
1414 struct program_space
*pspace
;
1416 struct symtab
*symtab
;
1417 struct obj_section
*section
;
1418 /* Line number. Line numbers start at 1 and proceed through symtab->nlines.
1419 0 is never a valid line number; it is used to indicate that line number
1420 information is not available. */
1428 /* The probe associated with this symtab_and_line. */
1429 struct probe
*probe
;
1430 /* If PROBE is not NULL, then this is the objfile in which the probe
1432 struct objfile
*objfile
;
1435 extern void init_sal (struct symtab_and_line
*sal
);
1437 struct symtabs_and_lines
1439 struct symtab_and_line
*sals
;
1444 /* Given a pc value, return line number it is in. Second arg nonzero means
1445 if pc is on the boundary use the previous statement's line number. */
1447 extern struct symtab_and_line
find_pc_line (CORE_ADDR
, int);
1449 /* Same function, but specify a section as well as an address. */
1451 extern struct symtab_and_line
find_pc_sect_line (CORE_ADDR
,
1452 struct obj_section
*, int);
1454 /* Wrapper around find_pc_line to just return the symtab. */
1456 extern struct symtab
*find_pc_line_symtab (CORE_ADDR
);
1458 /* Given a symtab and line number, return the pc there. */
1460 extern int find_line_pc (struct symtab
*, int, CORE_ADDR
*);
1462 extern int find_line_pc_range (struct symtab_and_line
, CORE_ADDR
*,
1465 extern void resolve_sal_pc (struct symtab_and_line
*);
1469 extern void clear_solib (void);
1473 extern int identify_source_line (struct symtab
*, int, int, CORE_ADDR
);
1475 /* Flags passed as 4th argument to print_source_lines. */
1477 enum print_source_lines_flags
1479 /* Do not print an error message. */
1480 PRINT_SOURCE_LINES_NOERROR
= (1 << 0),
1482 /* Print the filename in front of the source lines. */
1483 PRINT_SOURCE_LINES_FILENAME
= (1 << 1)
1486 extern void print_source_lines (struct symtab
*, int, int,
1487 enum print_source_lines_flags
);
1489 extern void forget_cached_source_info_for_objfile (struct objfile
*);
1490 extern void forget_cached_source_info (void);
1492 extern void select_source_symtab (struct symtab
*);
1494 extern VEC (char_ptr
) *default_make_symbol_completion_list_break_on
1495 (const char *text
, const char *word
, const char *break_on
,
1496 enum type_code code
);
1497 extern VEC (char_ptr
) *default_make_symbol_completion_list (const char *,
1500 extern VEC (char_ptr
) *make_symbol_completion_list (const char *, const char *);
1501 extern VEC (char_ptr
) *make_symbol_completion_type (const char *, const char *,
1503 extern VEC (char_ptr
) *make_symbol_completion_list_fn (struct cmd_list_element
*,
1507 extern VEC (char_ptr
) *make_file_symbol_completion_list (const char *,
1511 extern VEC (char_ptr
) *make_source_files_completion_list (const char *,
1516 int matching_obj_sections (struct obj_section
*, struct obj_section
*);
1518 extern struct symtab
*find_line_symtab (struct symtab
*, int, int *, int *);
1520 extern struct symtab_and_line
find_function_start_sal (struct symbol
*sym
,
1523 extern void skip_prologue_sal (struct symtab_and_line
*);
1527 extern CORE_ADDR
skip_prologue_using_sal (struct gdbarch
*gdbarch
,
1528 CORE_ADDR func_addr
);
1530 extern struct symbol
*fixup_symbol_section (struct symbol
*,
1533 /* Symbol searching */
1534 /* Note: struct symbol_search, search_symbols, et.al. are declared here,
1535 instead of making them local to symtab.c, for gdbtk's sake. */
1537 /* When using search_symbols, a list of the following structs is returned.
1538 Callers must free the search list using free_search_symbols! */
1539 struct symbol_search
1541 /* The block in which the match was found. Could be, for example,
1542 STATIC_BLOCK or GLOBAL_BLOCK. */
1545 /* Information describing what was found.
1547 If symbol is NOT NULL, then information was found for this match. */
1548 struct symbol
*symbol
;
1550 /* If msymbol is non-null, then a match was made on something for
1551 which only minimal_symbols exist. */
1552 struct bound_minimal_symbol msymbol
;
1554 /* A link to the next match, or NULL for the end. */
1555 struct symbol_search
*next
;
1558 extern void search_symbols (const char *, enum search_domain
, int,
1559 const char **, struct symbol_search
**);
1560 extern void free_search_symbols (struct symbol_search
*);
1561 extern struct cleanup
*make_cleanup_free_search_symbols (struct symbol_search
1564 /* The name of the ``main'' function.
1565 FIXME: cagney/2001-03-20: Can't make main_name() const since some
1566 of the calling code currently assumes that the string isn't
1568 extern /*const */ char *main_name (void);
1569 extern enum language
main_language (void);
1571 /* Lookup symbol NAME from DOMAIN in MAIN_OBJFILE's global blocks.
1572 This searches MAIN_OBJFILE as well as any associated separate debug info
1573 objfiles of MAIN_OBJFILE.
1574 Upon success fixes up the symbol's section if necessary. */
1576 extern struct block_symbol
1577 lookup_global_symbol_from_objfile (struct objfile
*main_objfile
,
1579 const domain_enum domain
);
1581 /* Return 1 if the supplied producer string matches the ARM RealView
1582 compiler (armcc). */
1583 int producer_is_realview (const char *producer
);
1585 void fixup_section (struct general_symbol_info
*ginfo
,
1586 CORE_ADDR addr
, struct objfile
*objfile
);
1588 /* Look up objfile containing BLOCK. */
1590 struct objfile
*lookup_objfile_from_block (const struct block
*block
);
1592 extern unsigned int symtab_create_debug
;
1594 extern unsigned int symbol_lookup_debug
;
1596 extern int basenames_may_differ
;
1598 int compare_filenames_for_search (const char *filename
,
1599 const char *search_name
);
1601 int iterate_over_some_symtabs (const char *name
,
1602 const char *real_path
,
1603 int (*callback
) (struct symtab
*symtab
,
1606 struct compunit_symtab
*first
,
1607 struct compunit_symtab
*after_last
);
1609 void iterate_over_symtabs (const char *name
,
1610 int (*callback
) (struct symtab
*symtab
,
1614 DEF_VEC_I (CORE_ADDR
);
1616 VEC (CORE_ADDR
) *find_pcs_for_symtab_line (struct symtab
*symtab
, int line
,
1617 struct linetable_entry
**best_entry
);
1619 /* Callback for LA_ITERATE_OVER_SYMBOLS. The callback will be called
1620 once per matching symbol SYM, with DATA being the argument of the
1621 same name that was passed to LA_ITERATE_OVER_SYMBOLS. The callback
1622 should return nonzero to indicate that LA_ITERATE_OVER_SYMBOLS
1623 should continue iterating, or zero to indicate that the iteration
1626 typedef int (symbol_found_callback_ftype
) (struct symbol
*sym
, void *data
);
1628 void iterate_over_symbols (const struct block
*block
, const char *name
,
1629 const domain_enum domain
,
1630 symbol_found_callback_ftype
*callback
,
1633 struct cleanup
*demangle_for_lookup (const char *name
, enum language lang
,
1634 const char **result_name
);
1636 struct symbol
*allocate_symbol (struct objfile
*);
1638 void initialize_objfile_symbol (struct symbol
*);
1640 struct template_symbol
*allocate_template_symbol (struct objfile
*);
1642 #endif /* !defined(SYMTAB_H) */