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. */
140 const char *demangled_name;
144 /* Record the source code language that applies to this symbol.
145 This is used to select one of the fields from the language specific
148 ENUM_BITFIELD(language) language : LANGUAGE_BITS;
150 /* This is only used by Ada. If set, then the 'demangled_name' field
151 of language_specific is valid. Otherwise, the 'obstack' field is
153 unsigned int ada_mangled : 1;
155 /* Which section is this symbol in? This is an index into
156 section_offsets for this objfile. Negative means that the symbol
157 does not get relocated relative to a section. */
162 extern void symbol_set_demangled_name (struct general_symbol_info *,
166 extern const char *symbol_get_demangled_name
167 (const struct general_symbol_info *);
169 extern CORE_ADDR symbol_overlayed_address (CORE_ADDR, struct obj_section *);
171 /* Note that all the following SYMBOL_* macros are used with the
172 SYMBOL argument being either a partial symbol or
173 a full symbol. Both types have a ginfo field. In particular
174 the SYMBOL_SET_LANGUAGE, SYMBOL_DEMANGLED_NAME, etc.
175 macros cannot be entirely substituted by
176 functions, unless the callers are changed to pass in the ginfo
177 field only, instead of the SYMBOL parameter. */
179 #define SYMBOL_VALUE(symbol) (symbol)->ginfo.value.ivalue
180 #define SYMBOL_VALUE_ADDRESS(symbol) (symbol)->ginfo.value.address
181 #define SYMBOL_VALUE_BYTES(symbol) (symbol)->ginfo.value.bytes
182 #define SYMBOL_VALUE_COMMON_BLOCK(symbol) (symbol)->ginfo.value.common_block
183 #define SYMBOL_BLOCK_VALUE(symbol) (symbol)->ginfo.value.block
184 #define SYMBOL_VALUE_CHAIN(symbol) (symbol)->ginfo.value.chain
185 #define SYMBOL_LANGUAGE(symbol) (symbol)->ginfo.language
186 #define SYMBOL_SECTION(symbol) (symbol)->ginfo.section
187 #define SYMBOL_OBJ_SECTION(objfile, symbol) \
188 (((symbol)->ginfo.section >= 0) \
189 ? (&(((objfile)->sections)[(symbol)->ginfo.section])) \
192 /* Initializes the language dependent portion of a symbol
193 depending upon the language for the symbol. */
194 #define SYMBOL_SET_LANGUAGE(symbol,language,obstack) \
195 (symbol_set_language (&(symbol)->ginfo, (language), (obstack)))
196 extern void symbol_set_language (struct general_symbol_info *symbol,
197 enum language language,
198 struct obstack *obstack);
200 /* Set just the linkage name of a symbol; do not try to demangle
201 it. Used for constructs which do not have a mangled name,
202 e.g. struct tags. Unlike SYMBOL_SET_NAMES, linkage_name must
203 be terminated and either already on the objfile's obstack or
204 permanently allocated. */
205 #define SYMBOL_SET_LINKAGE_NAME(symbol,linkage_name) \
206 (symbol)->ginfo.name = (linkage_name)
208 /* Set the linkage and natural names of a symbol, by demangling
210 #define SYMBOL_SET_NAMES(symbol,linkage_name,len,copy_name,objfile) \
211 symbol_set_names (&(symbol)->ginfo, linkage_name, len, copy_name, objfile)
212 extern void symbol_set_names (struct general_symbol_info *symbol,
213 const char *linkage_name, int len, int copy_name,
214 struct objfile *objfile);
216 /* Now come lots of name accessor macros. Short version as to when to
217 use which: Use SYMBOL_NATURAL_NAME to refer to the name of the
218 symbol in the original source code. Use SYMBOL_LINKAGE_NAME if you
219 want to know what the linker thinks the symbol's name is. Use
220 SYMBOL_PRINT_NAME for output. Use SYMBOL_DEMANGLED_NAME if you
221 specifically need to know whether SYMBOL_NATURAL_NAME and
222 SYMBOL_LINKAGE_NAME are different. */
224 /* Return SYMBOL's "natural" name, i.e. the name that it was called in
225 the original source code. In languages like C++ where symbols may
226 be mangled for ease of manipulation by the linker, this is the
229 #define SYMBOL_NATURAL_NAME(symbol) \
230 (symbol_natural_name (&(symbol)->ginfo))
231 extern const char *symbol_natural_name
232 (const struct general_symbol_info *symbol);
234 /* Return SYMBOL's name from the point of view of the linker. In
235 languages like C++ where symbols may be mangled for ease of
236 manipulation by the linker, this is the mangled name; otherwise,
237 it's the same as SYMBOL_NATURAL_NAME. */
239 #define SYMBOL_LINKAGE_NAME(symbol) (symbol)->ginfo.name
241 /* Return the demangled name for a symbol based on the language for
242 that symbol. If no demangled name exists, return NULL. */
243 #define SYMBOL_DEMANGLED_NAME(symbol) \
244 (symbol_demangled_name (&(symbol)->ginfo))
245 extern const char *symbol_demangled_name
246 (const struct general_symbol_info *symbol);
248 /* Macro that returns a version of the name of a symbol that is
249 suitable for output. In C++ this is the "demangled" form of the
250 name if demangle is on and the "mangled" form of the name if
251 demangle is off. In other languages this is just the symbol name.
252 The result should never be NULL. Don't use this for internal
253 purposes (e.g. storing in a hashtable): it's only suitable for output.
255 N.B. symbol may be anything with a ginfo member,
256 e.g., struct symbol or struct minimal_symbol. */
258 #define SYMBOL_PRINT_NAME(symbol) \
259 (demangle ? SYMBOL_NATURAL_NAME (symbol) : SYMBOL_LINKAGE_NAME (symbol))
262 /* Macro that returns the name to be used when sorting and searching symbols.
263 In C++ and Java, we search for the demangled form of a name,
264 and so sort symbols accordingly. In Ada, however, we search by mangled
265 name. If there is no distinct demangled name, then SYMBOL_SEARCH_NAME
266 returns the same value (same pointer) as SYMBOL_LINKAGE_NAME. */
267 #define SYMBOL_SEARCH_NAME(symbol) \
268 (symbol_search_name (&(symbol)->ginfo))
269 extern const char *symbol_search_name (const struct general_symbol_info *);
271 /* Return non-zero if NAME matches the "search" name of SYMBOL.
272 Whitespace and trailing parentheses are ignored.
273 See strcmp_iw for details about its behavior. */
274 #define SYMBOL_MATCHES_SEARCH_NAME(symbol, name) \
275 (strcmp_iw (SYMBOL_SEARCH_NAME (symbol), (name)) == 0)
277 /* Classification types for a minimal symbol. These should be taken as
278 "advisory only", since if gdb can't easily figure out a
279 classification it simply selects mst_unknown. It may also have to
280 guess when it can't figure out which is a better match between two
281 types (mst_data versus mst_bss) for example. Since the minimal
282 symbol info is sometimes derived from the BFD library's view of a
283 file, we need to live with what information bfd supplies. */
285 enum minimal_symbol_type
287 mst_unknown = 0, /* Unknown type, the default */
288 mst_text, /* Generally executable instructions */
289 mst_text_gnu_ifunc, /* Executable code returning address
290 of executable code */
291 mst_slot_got_plt, /* GOT entries for .plt sections */
292 mst_data, /* Generally initialized data */
293 mst_bss, /* Generally uninitialized data */
294 mst_abs, /* Generally absolute (nonrelocatable) */
295 /* GDB uses mst_solib_trampoline for the start address of a shared
296 library trampoline entry. Breakpoints for shared library functions
297 are put there if the shared library is not yet loaded.
298 After the shared library is loaded, lookup_minimal_symbol will
299 prefer the minimal symbol from the shared library (usually
300 a mst_text symbol) over the mst_solib_trampoline symbol, and the
301 breakpoints will be moved to their true address in the shared
302 library via breakpoint_re_set. */
303 mst_solib_trampoline, /* Shared library trampoline code */
304 /* For the mst_file* types, the names are only guaranteed to be unique
305 within a given .o file. */
306 mst_file_text, /* Static version of mst_text */
307 mst_file_data, /* Static version of mst_data */
308 mst_file_bss, /* Static version of mst_bss */
312 /* The number of enum minimal_symbol_type values, with some padding for
313 reasonable growth. */
314 #define MINSYM_TYPE_BITS 4
315 gdb_static_assert (nr_minsym_types <= (1 << MINSYM_TYPE_BITS));
317 /* Define a simple structure used to hold some very basic information about
318 all defined global symbols (text, data, bss, abs, etc). The only required
319 information is the general_symbol_info.
321 In many cases, even if a file was compiled with no special options for
322 debugging at all, as long as was not stripped it will contain sufficient
323 information to build a useful minimal symbol table using this structure.
324 Even when a file contains enough debugging information to build a full
325 symbol table, these minimal symbols are still useful for quickly mapping
326 between names and addresses, and vice versa. They are also sometimes
327 used to figure out what full symbol table entries need to be read in. */
329 struct minimal_symbol
332 /* The general symbol info required for all types of symbols.
334 The SYMBOL_VALUE_ADDRESS contains the address that this symbol
337 struct general_symbol_info mginfo;
339 /* Size of this symbol. dbx_end_psymtab in dbxread.c uses this
340 information to calculate the end of the partial symtab based on the
341 address of the last symbol plus the size of the last symbol. */
345 /* Which source file is this symbol in? Only relevant for mst_file_*. */
346 const char *filename;
348 /* Classification type for this minimal symbol. */
350 ENUM_BITFIELD(minimal_symbol_type) type : MINSYM_TYPE_BITS;
352 /* Non-zero if this symbol was created by gdb.
353 Such symbols do not appear in the output of "info var|fun". */
354 unsigned int created_by_gdb : 1;
356 /* Two flag bits provided for the use of the target. */
357 unsigned int target_flag_1 : 1;
358 unsigned int target_flag_2 : 1;
360 /* Nonzero iff the size of the minimal symbol has been set.
361 Symbol size information can sometimes not be determined, because
362 the object file format may not carry that piece of information. */
363 unsigned int has_size : 1;
365 /* Minimal symbols with the same hash key are kept on a linked
366 list. This is the link. */
368 struct minimal_symbol *hash_next;
370 /* Minimal symbols are stored in two different hash tables. This is
371 the `next' pointer for the demangled hash table. */
373 struct minimal_symbol *demangled_hash_next;
376 #define MSYMBOL_TARGET_FLAG_1(msymbol) (msymbol)->target_flag_1
377 #define MSYMBOL_TARGET_FLAG_2(msymbol) (msymbol)->target_flag_2
378 #define MSYMBOL_SIZE(msymbol) ((msymbol)->size + 0)
379 #define SET_MSYMBOL_SIZE(msymbol, sz) \
382 (msymbol)->size = sz; \
383 (msymbol)->has_size = 1; \
385 #define MSYMBOL_HAS_SIZE(msymbol) ((msymbol)->has_size + 0)
386 #define MSYMBOL_TYPE(msymbol) (msymbol)->type
388 #define MSYMBOL_VALUE(symbol) (symbol)->mginfo.value.ivalue
389 /* The unrelocated address of the minimal symbol. */
390 #define MSYMBOL_VALUE_RAW_ADDRESS(symbol) ((symbol)->mginfo.value.address + 0)
391 /* The relocated address of the minimal symbol, using the section
392 offsets from OBJFILE. */
393 #define MSYMBOL_VALUE_ADDRESS(objfile, symbol) \
394 ((symbol)->mginfo.value.address \
395 + ANOFFSET ((objfile)->section_offsets, ((symbol)->mginfo.section)))
396 /* For a bound minsym, we can easily compute the address directly. */
397 #define BMSYMBOL_VALUE_ADDRESS(symbol) \
398 MSYMBOL_VALUE_ADDRESS ((symbol).objfile, (symbol).minsym)
399 #define SET_MSYMBOL_VALUE_ADDRESS(symbol, new_value) \
400 ((symbol)->mginfo.value.address = (new_value))
401 #define MSYMBOL_VALUE_BYTES(symbol) (symbol)->mginfo.value.bytes
402 #define MSYMBOL_BLOCK_VALUE(symbol) (symbol)->mginfo.value.block
403 #define MSYMBOL_VALUE_CHAIN(symbol) (symbol)->mginfo.value.chain
404 #define MSYMBOL_LANGUAGE(symbol) (symbol)->mginfo.language
405 #define MSYMBOL_SECTION(symbol) (symbol)->mginfo.section
406 #define MSYMBOL_OBJ_SECTION(objfile, symbol) \
407 (((symbol)->mginfo.section >= 0) \
408 ? (&(((objfile)->sections)[(symbol)->mginfo.section])) \
411 #define MSYMBOL_NATURAL_NAME(symbol) \
412 (symbol_natural_name (&(symbol)->mginfo))
413 #define MSYMBOL_LINKAGE_NAME(symbol) (symbol)->mginfo.name
414 #define MSYMBOL_PRINT_NAME(symbol) \
415 (demangle ? MSYMBOL_NATURAL_NAME (symbol) : MSYMBOL_LINKAGE_NAME (symbol))
416 #define MSYMBOL_DEMANGLED_NAME(symbol) \
417 (symbol_demangled_name (&(symbol)->mginfo))
418 #define MSYMBOL_SET_LANGUAGE(symbol,language,obstack) \
419 (symbol_set_language (&(symbol)->mginfo, (language), (obstack)))
420 #define MSYMBOL_SEARCH_NAME(symbol) \
421 (symbol_search_name (&(symbol)->mginfo))
422 #define MSYMBOL_MATCHES_SEARCH_NAME(symbol, name) \
423 (strcmp_iw (MSYMBOL_SEARCH_NAME (symbol), (name)) == 0)
424 #define MSYMBOL_SET_NAMES(symbol,linkage_name,len,copy_name,objfile) \
425 symbol_set_names (&(symbol)->mginfo, linkage_name, len, copy_name, objfile)
431 /* Represent one symbol name; a variable, constant, function or typedef. */
433 /* Different name domains for symbols. Looking up a symbol specifies a
434 domain and ignores symbol definitions in other name domains. */
436 typedef enum domain_enum_tag
438 /* UNDEF_DOMAIN is used when a domain has not been discovered or
439 none of the following apply. This usually indicates an error either
440 in the symbol information or in gdb's handling of symbols. */
444 /* VAR_DOMAIN is the usual domain. In C, this contains variables,
445 function names, typedef names and enum type values. */
449 /* STRUCT_DOMAIN is used in C to hold struct, union and enum type names.
450 Thus, if `struct foo' is used in a C program, it produces a symbol named
451 `foo' in the STRUCT_DOMAIN. */
455 /* MODULE_DOMAIN is used in Fortran to hold module type names. */
459 /* LABEL_DOMAIN may be used for names of labels (for gotos). */
463 /* Fortran common blocks. Their naming must be separate from VAR_DOMAIN.
464 They also always use LOC_COMMON_BLOCK. */
467 /* This must remain last. */
471 /* The number of bits in a symbol used to represent the domain. */
473 #define SYMBOL_DOMAIN_BITS 3
474 gdb_static_assert (NR_DOMAINS <= (1 << SYMBOL_DOMAIN_BITS));
476 extern const char *domain_name (domain_enum);
478 /* Searching domains, used for `search_symbols'. Element numbers are
479 hardcoded in GDB, check all enum uses before changing it. */
483 /* Everything in VAR_DOMAIN minus FUNCTIONS_DOMAIN and
485 VARIABLES_DOMAIN = 0,
487 /* All functions -- for some reason not methods, though. */
488 FUNCTIONS_DOMAIN = 1,
490 /* All defined types */
497 extern const char *search_domain_name (enum search_domain);
499 /* An address-class says where to find the value of a symbol. */
503 /* Not used; catches errors. */
507 /* Value is constant int SYMBOL_VALUE, host byteorder. */
511 /* Value is at fixed address SYMBOL_VALUE_ADDRESS. */
515 /* Value is in register. SYMBOL_VALUE is the register number
516 in the original debug format. SYMBOL_REGISTER_OPS holds a
517 function that can be called to transform this into the
518 actual register number this represents in a specific target
519 architecture (gdbarch).
521 For some symbol formats (stabs, for some compilers at least),
522 the compiler generates two symbols, an argument and a register.
523 In some cases we combine them to a single LOC_REGISTER in symbol
524 reading, but currently not for all cases (e.g. it's passed on the
525 stack and then loaded into a register). */
529 /* It's an argument; the value is at SYMBOL_VALUE offset in arglist. */
533 /* Value address is at SYMBOL_VALUE offset in arglist. */
537 /* Value is in specified register. Just like LOC_REGISTER except the
538 register holds the address of the argument instead of the argument
539 itself. This is currently used for the passing of structs and unions
540 on sparc and hppa. It is also used for call by reference where the
541 address is in a register, at least by mipsread.c. */
545 /* Value is a local variable at SYMBOL_VALUE offset in stack frame. */
549 /* Value not used; definition in SYMBOL_TYPE. Symbols in the domain
550 STRUCT_DOMAIN all have this class. */
554 /* Value is address SYMBOL_VALUE_ADDRESS in the code. */
558 /* In a symbol table, value is SYMBOL_BLOCK_VALUE of a `struct block'.
559 In a partial symbol table, SYMBOL_VALUE_ADDRESS is the start address
560 of the block. Function names have this class. */
564 /* Value is a constant byte-sequence pointed to by SYMBOL_VALUE_BYTES, in
565 target byte order. */
569 /* Value is at fixed address, but the address of the variable has
570 to be determined from the minimal symbol table whenever the
571 variable is referenced.
572 This happens if debugging information for a global symbol is
573 emitted and the corresponding minimal symbol is defined
574 in another object file or runtime common storage.
575 The linker might even remove the minimal symbol if the global
576 symbol is never referenced, in which case the symbol remains
579 GDB would normally find the symbol in the minimal symbol table if it will
580 not find it in the full symbol table. But a reference to an external
581 symbol in a local block shadowing other definition requires full symbol
582 without possibly having its address available for LOC_STATIC. Testcase
583 is provided as `gdb.dwarf2/dw2-unresolved.exp'.
585 This is also used for thread local storage (TLS) variables. In this case,
586 the address of the TLS variable must be determined when the variable is
587 referenced, from the MSYMBOL_VALUE_RAW_ADDRESS, which is the offset
588 of the TLS variable in the thread local storage of the shared
593 /* The variable does not actually exist in the program.
594 The value is ignored. */
598 /* The variable's address is computed by a set of location
599 functions (see "struct symbol_computed_ops" below). */
602 /* The variable uses general_symbol_info->value->common_block field.
603 It also always uses COMMON_BLOCK_DOMAIN. */
606 /* Not used, just notes the boundary of the enum. */
610 /* The number of bits needed for values in enum address_class, with some
611 padding for reasonable growth, and room for run-time registered address
612 classes. See symtab.c:MAX_SYMBOL_IMPLS.
613 This is a #define so that we can have a assertion elsewhere to
614 verify that we have reserved enough space for synthetic address
616 #define SYMBOL_ACLASS_BITS 5
617 gdb_static_assert (LOC_FINAL_VALUE <= (1 << SYMBOL_ACLASS_BITS));
619 /* The methods needed to implement LOC_COMPUTED. These methods can
620 use the symbol's .aux_value for additional per-symbol information.
622 At present this is only used to implement location expressions. */
624 struct symbol_computed_ops
627 /* Return the value of the variable SYMBOL, relative to the stack
628 frame FRAME. If the variable has been optimized out, return
631 Iff `read_needs_frame (SYMBOL)' is zero, then FRAME may be zero. */
633 struct value *(*read_variable) (struct symbol * symbol,
634 struct frame_info * frame);
636 /* Read variable SYMBOL like read_variable at (callee) FRAME's function
637 entry. SYMBOL should be a function parameter, otherwise
638 NO_ENTRY_VALUE_ERROR will be thrown. */
639 struct value *(*read_variable_at_entry) (struct symbol *symbol,
640 struct frame_info *frame);
642 /* Return non-zero if we need a frame to find the value of the SYMBOL. */
643 int (*read_needs_frame) (struct symbol * symbol);
645 /* Write to STREAM a natural-language description of the location of
646 SYMBOL, in the context of ADDR. */
647 void (*describe_location) (struct symbol * symbol, CORE_ADDR addr,
648 struct ui_file * stream);
650 /* Non-zero if this symbol's address computation is dependent on PC. */
651 unsigned char location_has_loclist;
653 /* Tracepoint support. Append bytecodes to the tracepoint agent
654 expression AX that push the address of the object SYMBOL. Set
655 VALUE appropriately. Note --- for objects in registers, this
656 needn't emit any code; as long as it sets VALUE properly, then
657 the caller will generate the right code in the process of
658 treating this as an lvalue or rvalue. */
660 void (*tracepoint_var_ref) (struct symbol *symbol, struct gdbarch *gdbarch,
661 struct agent_expr *ax, struct axs_value *value);
663 /* Generate C code to compute the location of SYMBOL. The C code is
664 emitted to STREAM. GDBARCH is the current architecture and PC is
665 the PC at which SYMBOL's location should be evaluated.
666 REGISTERS_USED is a vector indexed by register number; the
667 generator function should set an element in this vector if the
668 corresponding register is needed by the location computation.
669 The generated C code must assign the location to a local
670 variable; this variable's name is RESULT_NAME. */
672 void (*generate_c_location) (struct symbol *symbol, struct ui_file *stream,
673 struct gdbarch *gdbarch,
674 unsigned char *registers_used,
675 CORE_ADDR pc, const char *result_name);
679 /* The methods needed to implement LOC_BLOCK for inferior functions.
680 These methods can use the symbol's .aux_value for additional
681 per-symbol information. */
683 struct symbol_block_ops
685 /* Fill in *START and *LENGTH with DWARF block data of function
686 FRAMEFUNC valid for inferior context address PC. Set *LENGTH to
687 zero if such location is not valid for PC; *START is left
688 uninitialized in such case. */
689 void (*find_frame_base_location) (struct symbol *framefunc, CORE_ADDR pc,
690 const gdb_byte **start, size_t *length);
692 /* Return the frame base address. FRAME is the frame for which we want to
693 compute the base address while FRAMEFUNC is the symbol for the
694 corresponding function. Return 0 on failure (FRAMEFUNC may not hold the
695 information we need).
697 This method is designed to work with static links (nested functions
698 handling). Static links are function properties whose evaluation returns
699 the frame base address for the enclosing frame. However, there are
700 multiple definitions for "frame base": the content of the frame base
701 register, the CFA as defined by DWARF unwinding information, ...
703 So this specific method is supposed to compute the frame base address such
704 as for nested fuctions, the static link computes the same address. For
705 instance, considering DWARF debugging information, the static link is
706 computed with DW_AT_static_link and this method must be used to compute
707 the corresponding DW_AT_frame_base attribute. */
708 CORE_ADDR (*get_frame_base) (struct symbol *framefunc,
709 struct frame_info *frame);
712 /* Functions used with LOC_REGISTER and LOC_REGPARM_ADDR. */
714 struct symbol_register_ops
716 int (*register_number) (struct symbol *symbol, struct gdbarch *gdbarch);
719 /* Objects of this type are used to find the address class and the
720 various computed ops vectors of a symbol. */
724 enum address_class aclass;
726 /* Used with LOC_COMPUTED. */
727 const struct symbol_computed_ops *ops_computed;
729 /* Used with LOC_BLOCK. */
730 const struct symbol_block_ops *ops_block;
732 /* Used with LOC_REGISTER and LOC_REGPARM_ADDR. */
733 const struct symbol_register_ops *ops_register;
736 /* This structure is space critical. See space comments at the top. */
741 /* The general symbol info required for all types of symbols. */
743 struct general_symbol_info ginfo;
745 /* Data type of value */
749 /* The owner of this symbol.
750 Which one to use is defined by symbol.is_objfile_owned. */
754 /* The symbol table containing this symbol. This is the file associated
755 with LINE. It can be NULL during symbols read-in but it is never NULL
756 during normal operation. */
757 struct symtab *symtab;
759 /* For types defined by the architecture. */
760 struct gdbarch *arch;
765 ENUM_BITFIELD(domain_enum_tag) domain : SYMBOL_DOMAIN_BITS;
767 /* Address class. This holds an index into the 'symbol_impls'
768 table. The actual enum address_class value is stored there,
769 alongside any per-class ops vectors. */
771 unsigned int aclass_index : SYMBOL_ACLASS_BITS;
773 /* If non-zero then symbol is objfile-owned, use owner.symtab.
774 Otherwise symbol is arch-owned, use owner.arch. */
776 unsigned int is_objfile_owned : 1;
778 /* Whether this is an argument. */
780 unsigned is_argument : 1;
782 /* Whether this is an inlined function (class LOC_BLOCK only). */
783 unsigned is_inlined : 1;
785 /* True if this is a C++ function symbol with template arguments.
786 In this case the symbol is really a "struct template_symbol". */
787 unsigned is_cplus_template_function : 1;
789 /* Line number of this symbol's definition, except for inlined
790 functions. For an inlined function (class LOC_BLOCK and
791 SYMBOL_INLINED set) this is the line number of the function's call
792 site. Inlined function symbols are not definitions, and they are
793 never found by symbol table lookup.
794 If this symbol is arch-owned, LINE shall be zero.
796 FIXME: Should we really make the assumption that nobody will try
797 to debug files longer than 64K lines? What about machine
798 generated programs? */
802 /* An arbitrary data pointer, allowing symbol readers to record
803 additional information on a per-symbol basis. Note that this data
804 must be allocated using the same obstack as the symbol itself. */
805 /* So far it is only used by:
806 LOC_COMPUTED: to find the location information
807 LOC_BLOCK (DWARF2 function): information used internally by the
808 DWARF 2 code --- specifically, the location expression for the frame
809 base for this function. */
810 /* FIXME drow/2003-02-21: For the LOC_BLOCK case, it might be better
811 to add a magic symbol to the block containing this information,
812 or to have a generic debug info annotation slot for symbols. */
816 struct symbol *hash_next;
819 /* Several lookup functions return both a symbol and the block in which the
820 symbol is found. This structure is used in these cases. */
824 /* The symbol that was found, or NULL if no symbol was found. */
825 struct symbol *symbol;
827 /* If SYMBOL is not NULL, then this is the block in which the symbol is
829 const struct block *block;
832 extern const struct symbol_impl *symbol_impls;
834 /* Note: There is no accessor macro for symbol.owner because it is
837 #define SYMBOL_DOMAIN(symbol) (symbol)->domain
838 #define SYMBOL_IMPL(symbol) (symbol_impls[(symbol)->aclass_index])
839 #define SYMBOL_ACLASS_INDEX(symbol) (symbol)->aclass_index
840 #define SYMBOL_CLASS(symbol) (SYMBOL_IMPL (symbol).aclass)
841 #define SYMBOL_OBJFILE_OWNED(symbol) ((symbol)->is_objfile_owned)
842 #define SYMBOL_IS_ARGUMENT(symbol) (symbol)->is_argument
843 #define SYMBOL_INLINED(symbol) (symbol)->is_inlined
844 #define SYMBOL_IS_CPLUS_TEMPLATE_FUNCTION(symbol) \
845 (symbol)->is_cplus_template_function
846 #define SYMBOL_TYPE(symbol) (symbol)->type
847 #define SYMBOL_LINE(symbol) (symbol)->line
848 #define SYMBOL_COMPUTED_OPS(symbol) (SYMBOL_IMPL (symbol).ops_computed)
849 #define SYMBOL_BLOCK_OPS(symbol) (SYMBOL_IMPL (symbol).ops_block)
850 #define SYMBOL_REGISTER_OPS(symbol) (SYMBOL_IMPL (symbol).ops_register)
851 #define SYMBOL_LOCATION_BATON(symbol) (symbol)->aux_value
853 extern int register_symbol_computed_impl (enum address_class,
854 const struct symbol_computed_ops *);
856 extern int register_symbol_block_impl (enum address_class aclass,
857 const struct symbol_block_ops *ops);
859 extern int register_symbol_register_impl (enum address_class,
860 const struct symbol_register_ops *);
862 /* Return the OBJFILE of SYMBOL.
863 It is an error to call this if symbol.is_objfile_owned is false, which
864 only happens for architecture-provided types. */
866 extern struct objfile *symbol_objfile (const struct symbol *symbol);
868 /* Return the ARCH of SYMBOL. */
870 extern struct gdbarch *symbol_arch (const struct symbol *symbol);
872 /* Return the SYMTAB of SYMBOL.
873 It is an error to call this if symbol.is_objfile_owned is false, which
874 only happens for architecture-provided types. */
876 extern struct symtab *symbol_symtab (const struct symbol *symbol);
878 /* Set the symtab of SYMBOL to SYMTAB.
879 It is an error to call this if symbol.is_objfile_owned is false, which
880 only happens for architecture-provided types. */
882 extern void symbol_set_symtab (struct symbol *symbol, struct symtab *symtab);
884 /* An instance of this type is used to represent a C++ template
885 function. It includes a "struct symbol" as a kind of base class;
886 users downcast to "struct template_symbol *" when needed. A symbol
887 is really of this type iff SYMBOL_IS_CPLUS_TEMPLATE_FUNCTION is
890 struct template_symbol
892 /* The base class. */
895 /* The number of template arguments. */
896 int n_template_arguments;
898 /* The template arguments. This is an array with
899 N_TEMPLATE_ARGUMENTS elements. */
900 struct symbol **template_arguments;
904 /* Each item represents a line-->pc (or the reverse) mapping. This is
905 somewhat more wasteful of space than one might wish, but since only
906 the files which are actually debugged are read in to core, we don't
909 struct linetable_entry
915 /* The order of entries in the linetable is significant. They should
916 be sorted by increasing values of the pc field. If there is more than
917 one entry for a given pc, then I'm not sure what should happen (and
918 I not sure whether we currently handle it the best way).
920 Example: a C for statement generally looks like this
922 10 0x100 - for the init/test part of a for stmt.
925 10 0x400 - for the increment part of a for stmt.
927 If an entry has a line number of zero, it marks the start of a PC
928 range for which no line number information is available. It is
929 acceptable, though wasteful of table space, for such a range to be
936 /* Actually NITEMS elements. If you don't like this use of the
937 `struct hack', you can shove it up your ANSI (seriously, if the
938 committee tells us how to do it, we can probably go along). */
939 struct linetable_entry item[1];
942 /* How to relocate the symbols from each section in a symbol file.
943 Each struct contains an array of offsets.
944 The ordering and meaning of the offsets is file-type-dependent;
945 typically it is indexed by section numbers or symbol types or
948 To give us flexibility in changing the internal representation
949 of these offsets, the ANOFFSET macro must be used to insert and
950 extract offset values in the struct. */
952 struct section_offsets
954 CORE_ADDR offsets[1]; /* As many as needed. */
957 #define ANOFFSET(secoff, whichone) \
959 ? (internal_error (__FILE__, __LINE__, \
960 _("Section index is uninitialized")), -1) \
961 : secoff->offsets[whichone])
963 /* The size of a section_offsets table for N sections. */
964 #define SIZEOF_N_SECTION_OFFSETS(n) \
965 (sizeof (struct section_offsets) \
966 + sizeof (((struct section_offsets *) 0)->offsets) * ((n)-1))
968 /* Each source file or header is represented by a struct symtab.
969 The name "symtab" is historical, another name for it is "filetab".
970 These objects are chained through the `next' field. */
974 /* Unordered chain of all filetabs in the compunit, with the exception
975 that the "main" source file is the first entry in the list. */
979 /* Backlink to containing compunit symtab. */
981 struct compunit_symtab *compunit_symtab;
983 /* Table mapping core addresses to line numbers for this file.
984 Can be NULL if none. Never shared between different symtabs. */
986 struct linetable *linetable;
988 /* Name of this source file. This pointer is never NULL. */
990 const char *filename;
992 /* Total number of lines found in source file. */
996 /* line_charpos[N] is the position of the (N-1)th line of the
997 source file. "position" means something we can lseek() to; it
998 is not guaranteed to be useful any other way. */
1002 /* Language of this source file. */
1004 enum language language;
1006 /* Full name of file as found by searching the source path.
1007 NULL if not yet known. */
1012 #define SYMTAB_COMPUNIT(symtab) ((symtab)->compunit_symtab)
1013 #define SYMTAB_LINETABLE(symtab) ((symtab)->linetable)
1014 #define SYMTAB_LANGUAGE(symtab) ((symtab)->language)
1015 #define SYMTAB_BLOCKVECTOR(symtab) \
1016 COMPUNIT_BLOCKVECTOR (SYMTAB_COMPUNIT (symtab))
1017 #define SYMTAB_OBJFILE(symtab) \
1018 COMPUNIT_OBJFILE (SYMTAB_COMPUNIT (symtab))
1019 #define SYMTAB_PSPACE(symtab) (SYMTAB_OBJFILE (symtab)->pspace)
1020 #define SYMTAB_DIRNAME(symtab) \
1021 COMPUNIT_DIRNAME (SYMTAB_COMPUNIT (symtab))
1023 typedef struct symtab *symtab_ptr;
1024 DEF_VEC_P (symtab_ptr);
1026 /* Compunit symtabs contain the actual "symbol table", aka blockvector, as well
1027 as the list of all source files (what gdb has historically associated with
1029 Additional information is recorded here that is common to all symtabs in a
1030 compilation unit (DWARF or otherwise).
1033 For the case of a program built out of these files:
1042 This is recorded as:
1044 objfile -> foo.c(cu) -> bar.c(cu) -> NULL
1058 where "foo.c(cu)" and "bar.c(cu)" are struct compunit_symtab objects,
1059 and the files foo.c, etc. are struct symtab objects. */
1061 struct compunit_symtab
1063 /* Unordered chain of all compunit symtabs of this objfile. */
1064 struct compunit_symtab *next;
1066 /* Object file from which this symtab information was read. */
1067 struct objfile *objfile;
1069 /* Name of the symtab.
1070 This is *not* intended to be a usable filename, and is
1071 for debugging purposes only. */
1074 /* Unordered list of file symtabs, except that by convention the "main"
1075 source file (e.g., .c, .cc) is guaranteed to be first.
1076 Each symtab is a file, either the "main" source file (e.g., .c, .cc)
1077 or header (e.g., .h). */
1078 struct symtab *filetabs;
1080 /* Last entry in FILETABS list.
1081 Subfiles are added to the end of the list so they accumulate in order,
1082 with the main source subfile living at the front.
1083 The main reason is so that the main source file symtab is at the head
1084 of the list, and the rest appear in order for debugging convenience. */
1085 struct symtab *last_filetab;
1087 /* Non-NULL string that identifies the format of the debugging information,
1088 such as "stabs", "dwarf 1", "dwarf 2", "coff", etc. This is mostly useful
1089 for automated testing of gdb but may also be information that is
1090 useful to the user. */
1091 const char *debugformat;
1093 /* String of producer version information, or NULL if we don't know. */
1094 const char *producer;
1096 /* Directory in which it was compiled, or NULL if we don't know. */
1097 const char *dirname;
1099 /* List of all symbol scope blocks for this symtab. It is shared among
1100 all symtabs in a given compilation unit. */
1101 const struct blockvector *blockvector;
1103 /* Section in objfile->section_offsets for the blockvector and
1104 the linetable. Probably always SECT_OFF_TEXT. */
1105 int block_line_section;
1107 /* Symtab has been compiled with both optimizations and debug info so that
1108 GDB may stop skipping prologues as variables locations are valid already
1109 at function entry points. */
1110 unsigned int locations_valid : 1;
1112 /* DWARF unwinder for this CU is valid even for epilogues (PC at the return
1113 instruction). This is supported by GCC since 4.5.0. */
1114 unsigned int epilogue_unwind_valid : 1;
1116 /* struct call_site entries for this compilation unit or NULL. */
1117 htab_t call_site_htab;
1119 /* The macro table for this symtab. Like the blockvector, this
1120 is shared between different symtabs in a given compilation unit.
1121 It's debatable whether it *should* be shared among all the symtabs in
1122 the given compilation unit, but it currently is. */
1123 struct macro_table *macro_table;
1125 /* If non-NULL, then this points to a NULL-terminated vector of
1126 included compunits. When searching the static or global
1127 block of this compunit, the corresponding block of all
1128 included compunits will also be searched. Note that this
1129 list must be flattened -- the symbol reader is responsible for
1130 ensuring that this vector contains the transitive closure of all
1131 included compunits. */
1132 struct compunit_symtab **includes;
1134 /* If this is an included compunit, this points to one includer
1135 of the table. This user is considered the canonical compunit
1136 containing this one. An included compunit may itself be
1137 included by another. */
1138 struct compunit_symtab *user;
1141 #define COMPUNIT_OBJFILE(cust) ((cust)->objfile)
1142 #define COMPUNIT_FILETABS(cust) ((cust)->filetabs)
1143 #define COMPUNIT_DEBUGFORMAT(cust) ((cust)->debugformat)
1144 #define COMPUNIT_PRODUCER(cust) ((cust)->producer)
1145 #define COMPUNIT_DIRNAME(cust) ((cust)->dirname)
1146 #define COMPUNIT_BLOCKVECTOR(cust) ((cust)->blockvector)
1147 #define COMPUNIT_BLOCK_LINE_SECTION(cust) ((cust)->block_line_section)
1148 #define COMPUNIT_LOCATIONS_VALID(cust) ((cust)->locations_valid)
1149 #define COMPUNIT_EPILOGUE_UNWIND_VALID(cust) ((cust)->epilogue_unwind_valid)
1150 #define COMPUNIT_CALL_SITE_HTAB(cust) ((cust)->call_site_htab)
1151 #define COMPUNIT_MACRO_TABLE(cust) ((cust)->macro_table)
1153 /* Iterate over all file tables (struct symtab) within a compunit. */
1155 #define ALL_COMPUNIT_FILETABS(cu, s) \
1156 for ((s) = (cu) -> filetabs; (s) != NULL; (s) = (s) -> next)
1158 /* Return the primary symtab of CUST. */
1160 extern struct symtab *
1161 compunit_primary_filetab (const struct compunit_symtab *cust);
1163 /* Return the language of CUST. */
1165 extern enum language compunit_language (const struct compunit_symtab *cust);
1167 typedef struct compunit_symtab *compunit_symtab_ptr;
1168 DEF_VEC_P (compunit_symtab_ptr);
1172 /* The virtual function table is now an array of structures which have the
1173 form { int16 offset, delta; void *pfn; }.
1175 In normal virtual function tables, OFFSET is unused.
1176 DELTA is the amount which is added to the apparent object's base
1177 address in order to point to the actual object to which the
1178 virtual function should be applied.
1179 PFN is a pointer to the virtual function.
1181 Note that this macro is g++ specific (FIXME). */
1183 #define VTBL_FNADDR_OFFSET 2
1185 /* External variables and functions for the objects described above. */
1187 /* True if we are nested inside psymtab_to_symtab. */
1189 extern int currently_reading_symtab;
1191 /* symtab.c lookup functions */
1193 extern const char multiple_symbols_ask[];
1194 extern const char multiple_symbols_all[];
1195 extern const char multiple_symbols_cancel[];
1197 const char *multiple_symbols_select_mode (void);
1199 int symbol_matches_domain (enum language symbol_language,
1200 domain_enum symbol_domain,
1201 domain_enum domain);
1203 /* lookup a symbol table by source file name. */
1205 extern struct symtab *lookup_symtab (const char *);
1207 /* An object of this type is passed as the 'is_a_field_of_this'
1208 argument to lookup_symbol and lookup_symbol_in_language. */
1210 struct field_of_this_result
1212 /* The type in which the field was found. If this is NULL then the
1213 symbol was not found in 'this'. If non-NULL, then one of the
1214 other fields will be non-NULL as well. */
1218 /* If the symbol was found as an ordinary field of 'this', then this
1219 is non-NULL and points to the particular field. */
1221 struct field *field;
1223 /* If the symbol was found as a function field of 'this', then this
1224 is non-NULL and points to the particular field. */
1226 struct fn_fieldlist *fn_field;
1229 /* Find the definition for a specified symbol name NAME
1230 in domain DOMAIN in language LANGUAGE, visible from lexical block BLOCK
1231 if non-NULL or from global/static blocks if BLOCK is NULL.
1232 Returns the struct symbol pointer, or NULL if no symbol is found.
1233 C++: if IS_A_FIELD_OF_THIS is non-NULL on entry, check to see if
1234 NAME is a field of the current implied argument `this'. If so fill in the
1235 fields of IS_A_FIELD_OF_THIS, otherwise the fields are set to NULL.
1236 The symbol's section is fixed up if necessary. */
1238 extern struct block_symbol
1239 lookup_symbol_in_language (const char *,
1240 const struct block *,
1243 struct field_of_this_result *);
1245 /* Same as lookup_symbol_in_language, but using the current language. */
1247 extern struct block_symbol lookup_symbol (const char *,
1248 const struct block *,
1250 struct field_of_this_result *);
1252 /* A default version of lookup_symbol_nonlocal for use by languages
1253 that can't think of anything better to do.
1254 This implements the C lookup rules. */
1256 extern struct block_symbol
1257 basic_lookup_symbol_nonlocal (const struct language_defn *langdef,
1259 const struct block *,
1262 /* Some helper functions for languages that need to write their own
1263 lookup_symbol_nonlocal functions. */
1265 /* Lookup a symbol in the static block associated to BLOCK, if there
1266 is one; do nothing if BLOCK is NULL or a global block.
1267 Upon success fixes up the symbol's section if necessary. */
1269 extern struct block_symbol
1270 lookup_symbol_in_static_block (const char *name,
1271 const struct block *block,
1272 const domain_enum domain);
1274 /* Search all static file-level symbols for NAME from DOMAIN.
1275 Upon success fixes up the symbol's section if necessary. */
1277 extern struct block_symbol lookup_static_symbol (const char *name,
1278 const domain_enum domain);
1280 /* Lookup a symbol in all files' global blocks.
1282 If BLOCK is non-NULL then it is used for two things:
1283 1) If a target-specific lookup routine for libraries exists, then use the
1284 routine for the objfile of BLOCK, and
1285 2) The objfile of BLOCK is used to assist in determining the search order
1286 if the target requires it.
1287 See gdbarch_iterate_over_objfiles_in_search_order.
1289 Upon success fixes up the symbol's section if necessary. */
1291 extern struct block_symbol
1292 lookup_global_symbol (const char *name,
1293 const struct block *block,
1294 const domain_enum domain);
1296 /* Lookup a symbol in block BLOCK.
1297 Upon success fixes up the symbol's section if necessary. */
1299 extern struct symbol *
1300 lookup_symbol_in_block (const char *name,
1301 const struct block *block,
1302 const domain_enum domain);
1304 /* Look up the `this' symbol for LANG in BLOCK. Return the symbol if
1305 found, or NULL if not found. */
1307 extern struct block_symbol
1308 lookup_language_this (const struct language_defn *lang,
1309 const struct block *block);
1311 /* Lookup a [struct, union, enum] by name, within a specified block. */
1313 extern struct type *lookup_struct (const char *, const struct block *);
1315 extern struct type *lookup_union (const char *, const struct block *);
1317 extern struct type *lookup_enum (const char *, const struct block *);
1319 /* from blockframe.c: */
1321 /* lookup the function symbol corresponding to the address. */
1323 extern struct symbol *find_pc_function (CORE_ADDR);
1325 /* lookup the function corresponding to the address and section. */
1327 extern struct symbol *find_pc_sect_function (CORE_ADDR, struct obj_section *);
1329 extern int find_pc_partial_function_gnu_ifunc (CORE_ADDR pc, const char **name,
1332 int *is_gnu_ifunc_p);
1334 /* lookup function from address, return name, start addr and end addr. */
1336 extern int find_pc_partial_function (CORE_ADDR, const char **, CORE_ADDR *,
1339 extern void clear_pc_function_cache (void);
1341 /* Expand symtab containing PC, SECTION if not already expanded. */
1343 extern void expand_symtab_containing_pc (CORE_ADDR, struct obj_section *);
1345 /* lookup full symbol table by address. */
1347 extern struct compunit_symtab *find_pc_compunit_symtab (CORE_ADDR);
1349 /* lookup full symbol table by address and section. */
1351 extern struct compunit_symtab *
1352 find_pc_sect_compunit_symtab (CORE_ADDR, struct obj_section *);
1354 extern int find_pc_line_pc_range (CORE_ADDR, CORE_ADDR *, CORE_ADDR *);
1356 extern void reread_symbols (void);
1358 /* Look up a type named NAME in STRUCT_DOMAIN in the current language.
1359 The type returned must not be opaque -- i.e., must have at least one field
1362 extern struct type *lookup_transparent_type (const char *);
1364 extern struct type *basic_lookup_transparent_type (const char *);
1366 /* Macro for name of symbol to indicate a file compiled with gcc. */
1367 #ifndef GCC_COMPILED_FLAG_SYMBOL
1368 #define GCC_COMPILED_FLAG_SYMBOL "gcc_compiled."
1371 /* Macro for name of symbol to indicate a file compiled with gcc2. */
1372 #ifndef GCC2_COMPILED_FLAG_SYMBOL
1373 #define GCC2_COMPILED_FLAG_SYMBOL "gcc2_compiled."
1376 extern int in_gnu_ifunc_stub (CORE_ADDR pc);
1378 /* Functions for resolving STT_GNU_IFUNC symbols which are implemented only
1379 for ELF symbol files. */
1381 struct gnu_ifunc_fns
1383 /* See elf_gnu_ifunc_resolve_addr for its real implementation. */
1384 CORE_ADDR (*gnu_ifunc_resolve_addr) (struct gdbarch *gdbarch, CORE_ADDR pc);
1386 /* See elf_gnu_ifunc_resolve_name for its real implementation. */
1387 int (*gnu_ifunc_resolve_name) (const char *function_name,
1388 CORE_ADDR *function_address_p);
1390 /* See elf_gnu_ifunc_resolver_stop for its real implementation. */
1391 void (*gnu_ifunc_resolver_stop) (struct breakpoint *b);
1393 /* See elf_gnu_ifunc_resolver_return_stop for its real implementation. */
1394 void (*gnu_ifunc_resolver_return_stop) (struct breakpoint *b);
1397 #define gnu_ifunc_resolve_addr gnu_ifunc_fns_p->gnu_ifunc_resolve_addr
1398 #define gnu_ifunc_resolve_name gnu_ifunc_fns_p->gnu_ifunc_resolve_name
1399 #define gnu_ifunc_resolver_stop gnu_ifunc_fns_p->gnu_ifunc_resolver_stop
1400 #define gnu_ifunc_resolver_return_stop \
1401 gnu_ifunc_fns_p->gnu_ifunc_resolver_return_stop
1403 extern const struct gnu_ifunc_fns *gnu_ifunc_fns_p;
1405 extern CORE_ADDR find_solib_trampoline_target (struct frame_info *, CORE_ADDR);
1407 struct symtab_and_line
1409 /* The program space of this sal. */
1410 struct program_space *pspace;
1412 struct symtab *symtab;
1413 struct obj_section *section;
1414 /* Line number. Line numbers start at 1 and proceed through symtab->nlines.
1415 0 is never a valid line number; it is used to indicate that line number
1416 information is not available. */
1424 /* The probe associated with this symtab_and_line. */
1425 struct probe *probe;
1426 /* If PROBE is not NULL, then this is the objfile in which the probe
1428 struct objfile *objfile;
1431 extern void init_sal (struct symtab_and_line *sal);
1433 struct symtabs_and_lines
1435 struct symtab_and_line *sals;
1440 /* Given a pc value, return line number it is in. Second arg nonzero means
1441 if pc is on the boundary use the previous statement's line number. */
1443 extern struct symtab_and_line find_pc_line (CORE_ADDR, int);
1445 /* Same function, but specify a section as well as an address. */
1447 extern struct symtab_and_line find_pc_sect_line (CORE_ADDR,
1448 struct obj_section *, int);
1450 /* Wrapper around find_pc_line to just return the symtab. */
1452 extern struct symtab *find_pc_line_symtab (CORE_ADDR);
1454 /* Given a symtab and line number, return the pc there. */
1456 extern int find_line_pc (struct symtab *, int, CORE_ADDR *);
1458 extern int find_line_pc_range (struct symtab_and_line, CORE_ADDR *,
1461 extern void resolve_sal_pc (struct symtab_and_line *);
1465 extern void clear_solib (void);
1469 extern int identify_source_line (struct symtab *, int, int, CORE_ADDR);
1471 /* Flags passed as 4th argument to print_source_lines. */
1473 enum print_source_lines_flags
1475 /* Do not print an error message. */
1476 PRINT_SOURCE_LINES_NOERROR = (1 << 0),
1478 /* Print the filename in front of the source lines. */
1479 PRINT_SOURCE_LINES_FILENAME = (1 << 1)
1482 extern void print_source_lines (struct symtab *, int, int,
1483 enum print_source_lines_flags);
1485 extern void forget_cached_source_info_for_objfile (struct objfile *);
1486 extern void forget_cached_source_info (void);
1488 extern void select_source_symtab (struct symtab *);
1490 extern VEC (char_ptr) *default_make_symbol_completion_list_break_on
1491 (const char *text, const char *word, const char *break_on,
1492 enum type_code code);
1493 extern VEC (char_ptr) *default_make_symbol_completion_list (const char *,
1496 extern VEC (char_ptr) *make_symbol_completion_list (const char *, const char *);
1497 extern VEC (char_ptr) *make_symbol_completion_type (const char *, const char *,
1499 extern VEC (char_ptr) *make_symbol_completion_list_fn (struct cmd_list_element *,
1503 extern VEC (char_ptr) *make_file_symbol_completion_list (const char *,
1507 extern VEC (char_ptr) *make_source_files_completion_list (const char *,
1512 int matching_obj_sections (struct obj_section *, struct obj_section *);
1514 extern struct symtab *find_line_symtab (struct symtab *, int, int *, int *);
1516 extern struct symtab_and_line find_function_start_sal (struct symbol *sym,
1519 extern void skip_prologue_sal (struct symtab_and_line *);
1523 extern CORE_ADDR skip_prologue_using_sal (struct gdbarch *gdbarch,
1524 CORE_ADDR func_addr);
1526 extern struct symbol *fixup_symbol_section (struct symbol *,
1529 /* Symbol searching */
1530 /* Note: struct symbol_search, search_symbols, et.al. are declared here,
1531 instead of making them local to symtab.c, for gdbtk's sake. */
1533 /* When using search_symbols, a list of the following structs is returned.
1534 Callers must free the search list using free_search_symbols! */
1535 struct symbol_search
1537 /* The block in which the match was found. Could be, for example,
1538 STATIC_BLOCK or GLOBAL_BLOCK. */
1541 /* Information describing what was found.
1543 If symbol is NOT NULL, then information was found for this match. */
1544 struct symbol *symbol;
1546 /* If msymbol is non-null, then a match was made on something for
1547 which only minimal_symbols exist. */
1548 struct bound_minimal_symbol msymbol;
1550 /* A link to the next match, or NULL for the end. */
1551 struct symbol_search *next;
1554 extern void search_symbols (const char *, enum search_domain, int,
1555 const char **, struct symbol_search **);
1556 extern void free_search_symbols (struct symbol_search *);
1557 extern struct cleanup *make_cleanup_free_search_symbols (struct symbol_search
1560 /* The name of the ``main'' function.
1561 FIXME: cagney/2001-03-20: Can't make main_name() const since some
1562 of the calling code currently assumes that the string isn't
1564 extern /*const */ char *main_name (void);
1565 extern enum language main_language (void);
1567 /* Lookup symbol NAME from DOMAIN in MAIN_OBJFILE's global blocks.
1568 This searches MAIN_OBJFILE as well as any associated separate debug info
1569 objfiles of MAIN_OBJFILE.
1570 Upon success fixes up the symbol's section if necessary. */
1572 extern struct block_symbol
1573 lookup_global_symbol_from_objfile (struct objfile *main_objfile,
1575 const domain_enum domain);
1577 /* Return 1 if the supplied producer string matches the ARM RealView
1578 compiler (armcc). */
1579 int producer_is_realview (const char *producer);
1581 void fixup_section (struct general_symbol_info *ginfo,
1582 CORE_ADDR addr, struct objfile *objfile);
1584 /* Look up objfile containing BLOCK. */
1586 struct objfile *lookup_objfile_from_block (const struct block *block);
1588 extern unsigned int symtab_create_debug;
1590 extern unsigned int symbol_lookup_debug;
1592 extern int basenames_may_differ;
1594 int compare_filenames_for_search (const char *filename,
1595 const char *search_name);
1597 int iterate_over_some_symtabs (const char *name,
1598 const char *real_path,
1599 int (*callback) (struct symtab *symtab,
1602 struct compunit_symtab *first,
1603 struct compunit_symtab *after_last);
1605 void iterate_over_symtabs (const char *name,
1606 int (*callback) (struct symtab *symtab,
1610 DEF_VEC_I (CORE_ADDR);
1612 VEC (CORE_ADDR) *find_pcs_for_symtab_line (struct symtab *symtab, int line,
1613 struct linetable_entry **best_entry);
1615 /* Callback for LA_ITERATE_OVER_SYMBOLS. The callback will be called
1616 once per matching symbol SYM, with DATA being the argument of the
1617 same name that was passed to LA_ITERATE_OVER_SYMBOLS. The callback
1618 should return nonzero to indicate that LA_ITERATE_OVER_SYMBOLS
1619 should continue iterating, or zero to indicate that the iteration
1622 typedef int (symbol_found_callback_ftype) (struct symbol *sym, void *data);
1624 void iterate_over_symbols (const struct block *block, const char *name,
1625 const domain_enum domain,
1626 symbol_found_callback_ftype *callback,
1629 struct cleanup *demangle_for_lookup (const char *name, enum language lang,
1630 const char **result_name);
1632 struct symbol *allocate_symbol (struct objfile *);
1634 void initialize_objfile_symbol (struct symbol *);
1636 struct template_symbol *allocate_template_symbol (struct objfile *);
1638 #endif /* !defined(SYMTAB_H) */