1 /* Symbol table definitions for GDB.
3 Copyright (C) 1986, 1988-2004, 2007-2012 Free Software Foundation,
6 This file is part of GDB.
8 This program is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 3 of the License, or
11 (at your option) any later version.
13 This program is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with this program. If not, see <http://www.gnu.org/licenses/>. */
21 #if !defined (SYMTAB_H)
26 /* Opaque declarations. */
39 /* Some of the structures in this file are space critical.
40 The space-critical structures are:
42 struct general_symbol_info
46 These structures are laid out to encourage good packing.
47 They use ENUM_BITFIELD and short int fields, and they order the
48 structure members so that fields less than a word are next
49 to each other so they can be packed together. */
51 /* Rearranged: used ENUM_BITFIELD and rearranged field order in
52 all the space critical structures (plus struct minimal_symbol).
53 Memory usage dropped from 99360768 bytes to 90001408 bytes.
54 I measured this with before-and-after tests of
55 "HEAD-old-gdb -readnow HEAD-old-gdb" and
56 "HEAD-new-gdb -readnow HEAD-old-gdb" on native i686-pc-linux-gnu,
57 red hat linux 8, with LD_LIBRARY_PATH=/usr/lib/debug,
58 typing "maint space 1" at the first command prompt.
60 Here is another measurement (from andrew c):
61 # no /usr/lib/debug, just plain glibc, like a normal user
63 (gdb) break internal_error
65 (gdb) maint internal-error
69 gdb gdb_6_0_branch 2003-08-19 space used: 8896512
70 gdb HEAD 2003-08-19 space used: 8904704
71 gdb HEAD 2003-08-21 space used: 8396800 (+symtab.h)
72 gdb HEAD 2003-08-21 space used: 8265728 (+gdbtypes.h)
74 The third line shows the savings from the optimizations in symtab.h.
75 The fourth line shows the savings from the optimizations in
76 gdbtypes.h. Both optimizations are in gdb HEAD now.
78 --chastain 2003-08-21 */
80 /* Struct for storing C++ specific information. Allocated when needed. */
84 const char *demangled_name
;
87 /* Define a structure for the information that is common to all symbol types,
88 including minimal symbols, partial symbols, and full symbols. In a
89 multilanguage environment, some language specific information may need to
90 be recorded along with each symbol. */
92 /* This structure is space critical. See space comments at the top. */
94 struct general_symbol_info
96 /* Name of the symbol. This is a required field. Storage for the
97 name is allocated on the objfile_obstack for the associated
98 objfile. For languages like C++ that make a distinction between
99 the mangled name and demangled name, this is the mangled
104 /* Value of the symbol. Which member of this union to use, and what
105 it means, depends on what kind of symbol this is and its
106 SYMBOL_CLASS. See comments there for more details. All of these
107 are in host byte order (though what they point to might be in
108 target byte order, e.g. LOC_CONST_BYTES). */
112 /* The fact that this is a long not a LONGEST mainly limits the
113 range of a LOC_CONST. Since LOC_CONST_BYTES exists, I'm not
114 sure that is a big deal. */
123 /* For opaque typedef struct chain. */
125 struct symbol
*chain
;
129 /* Since one and only one language can apply, wrap the language specific
130 information inside a union. */
134 /* This is used by languages which wish to store a demangled name.
135 currently used by Ada, Java, and Objective C. */
138 const char *demangled_name
;
142 struct cplus_specific
*cplus_specific
;
146 /* Record the source code language that applies to this symbol.
147 This is used to select one of the fields from the language specific
150 ENUM_BITFIELD(language
) language
: 8;
152 /* Which section is this symbol in? This is an index into
153 section_offsets for this objfile. Negative means that the symbol
154 does not get relocated relative to a section.
155 Disclaimer: currently this is just used for xcoff, so don't
156 expect all symbol-reading code to set it correctly (the ELF code
157 also tries to set it correctly). */
161 /* The section associated with this symbol. It can be NULL. */
163 struct obj_section
*obj_section
;
166 extern void symbol_set_demangled_name (struct general_symbol_info
*, char *,
169 extern const char *symbol_get_demangled_name
170 (const struct general_symbol_info
*);
172 extern CORE_ADDR
symbol_overlayed_address (CORE_ADDR
, struct obj_section
*);
174 /* Note that all the following SYMBOL_* macros are used with the
175 SYMBOL argument being either a partial symbol, a minimal symbol or
176 a full symbol. All three types have a ginfo field. In particular
177 the SYMBOL_SET_LANGUAGE, SYMBOL_DEMANGLED_NAME, etc.
178 macros cannot be entirely substituted by
179 functions, unless the callers are changed to pass in the ginfo
180 field only, instead of the SYMBOL parameter. */
182 #define SYMBOL_VALUE(symbol) (symbol)->ginfo.value.ivalue
183 #define SYMBOL_VALUE_ADDRESS(symbol) (symbol)->ginfo.value.address
184 #define SYMBOL_VALUE_BYTES(symbol) (symbol)->ginfo.value.bytes
185 #define SYMBOL_BLOCK_VALUE(symbol) (symbol)->ginfo.value.block
186 #define SYMBOL_VALUE_CHAIN(symbol) (symbol)->ginfo.value.chain
187 #define SYMBOL_LANGUAGE(symbol) (symbol)->ginfo.language
188 #define SYMBOL_SECTION(symbol) (symbol)->ginfo.section
189 #define SYMBOL_OBJ_SECTION(symbol) (symbol)->ginfo.obj_section
191 /* Initializes the language dependent portion of a symbol
192 depending upon the language for the symbol. */
193 #define SYMBOL_SET_LANGUAGE(symbol,language) \
194 (symbol_set_language (&(symbol)->ginfo, (language)))
195 extern void symbol_set_language (struct general_symbol_info
*symbol
,
196 enum language language
);
198 /* Set just the linkage name of a symbol; do not try to demangle
199 it. Used for constructs which do not have a mangled name,
200 e.g. struct tags. Unlike SYMBOL_SET_NAMES, linkage_name must
201 be terminated and either already on the objfile's obstack or
202 permanently allocated. */
203 #define SYMBOL_SET_LINKAGE_NAME(symbol,linkage_name) \
204 (symbol)->ginfo.name = (linkage_name)
206 /* Set the linkage and natural names of a symbol, by demangling
208 #define SYMBOL_SET_NAMES(symbol,linkage_name,len,copy_name,objfile) \
209 symbol_set_names (&(symbol)->ginfo, linkage_name, len, copy_name, objfile)
210 extern void symbol_set_names (struct general_symbol_info
*symbol
,
211 const char *linkage_name
, int len
, int copy_name
,
212 struct objfile
*objfile
);
214 /* Now come lots of name accessor macros. Short version as to when to
215 use which: Use SYMBOL_NATURAL_NAME to refer to the name of the
216 symbol in the original source code. Use SYMBOL_LINKAGE_NAME if you
217 want to know what the linker thinks the symbol's name is. Use
218 SYMBOL_PRINT_NAME for output. Use SYMBOL_DEMANGLED_NAME if you
219 specifically need to know whether SYMBOL_NATURAL_NAME and
220 SYMBOL_LINKAGE_NAME are different. */
222 /* Return SYMBOL's "natural" name, i.e. the name that it was called in
223 the original source code. In languages like C++ where symbols may
224 be mangled for ease of manipulation by the linker, this is the
227 #define SYMBOL_NATURAL_NAME(symbol) \
228 (symbol_natural_name (&(symbol)->ginfo))
229 extern const char *symbol_natural_name
230 (const struct general_symbol_info
*symbol
);
232 /* Return SYMBOL's name from the point of view of the linker. In
233 languages like C++ where symbols may be mangled for ease of
234 manipulation by the linker, this is the mangled name; otherwise,
235 it's the same as SYMBOL_NATURAL_NAME. */
237 #define SYMBOL_LINKAGE_NAME(symbol) (symbol)->ginfo.name
239 /* Return the demangled name for a symbol based on the language for
240 that symbol. If no demangled name exists, return NULL. */
241 #define SYMBOL_DEMANGLED_NAME(symbol) \
242 (symbol_demangled_name (&(symbol)->ginfo))
243 extern const char *symbol_demangled_name
244 (const struct general_symbol_info
*symbol
);
246 /* Macro that returns a version of the name of a symbol that is
247 suitable for output. In C++ this is the "demangled" form of the
248 name if demangle is on and the "mangled" form of the name if
249 demangle is off. In other languages this is just the symbol name.
250 The result should never be NULL. Don't use this for internal
251 purposes (e.g. storing in a hashtable): it's only suitable for output.
253 N.B. symbol may be anything with a ginfo member,
254 e.g., struct symbol or struct minimal_symbol. */
256 #define SYMBOL_PRINT_NAME(symbol) \
257 (demangle ? SYMBOL_NATURAL_NAME (symbol) : SYMBOL_LINKAGE_NAME (symbol))
260 /* Macro that returns the name to be used when sorting and searching symbols.
261 In C++, Chill, and Java, we search for the demangled form of a name,
262 and so sort symbols accordingly. In Ada, however, we search by mangled
263 name. If there is no distinct demangled name, then SYMBOL_SEARCH_NAME
264 returns the same value (same pointer) as SYMBOL_LINKAGE_NAME. */
265 #define SYMBOL_SEARCH_NAME(symbol) \
266 (symbol_search_name (&(symbol)->ginfo))
267 extern const char *symbol_search_name (const struct general_symbol_info
*);
269 /* Return non-zero if NAME matches the "search" name of SYMBOL.
270 Whitespace and trailing parentheses are ignored.
271 See strcmp_iw for details about its behavior. */
272 #define SYMBOL_MATCHES_SEARCH_NAME(symbol, name) \
273 (strcmp_iw (SYMBOL_SEARCH_NAME (symbol), (name)) == 0)
275 /* Classification types for a minimal symbol. These should be taken as
276 "advisory only", since if gdb can't easily figure out a
277 classification it simply selects mst_unknown. It may also have to
278 guess when it can't figure out which is a better match between two
279 types (mst_data versus mst_bss) for example. Since the minimal
280 symbol info is sometimes derived from the BFD library's view of a
281 file, we need to live with what information bfd supplies. */
283 enum minimal_symbol_type
285 mst_unknown
= 0, /* Unknown type, the default */
286 mst_text
, /* Generally executable instructions */
287 mst_text_gnu_ifunc
, /* Executable code returning address
288 of executable code */
289 mst_slot_got_plt
, /* GOT entries for .plt sections */
290 mst_data
, /* Generally initialized data */
291 mst_bss
, /* Generally uninitialized data */
292 mst_abs
, /* Generally absolute (nonrelocatable) */
293 /* GDB uses mst_solib_trampoline for the start address of a shared
294 library trampoline entry. Breakpoints for shared library functions
295 are put there if the shared library is not yet loaded.
296 After the shared library is loaded, lookup_minimal_symbol will
297 prefer the minimal symbol from the shared library (usually
298 a mst_text symbol) over the mst_solib_trampoline symbol, and the
299 breakpoints will be moved to their true address in the shared
300 library via breakpoint_re_set. */
301 mst_solib_trampoline
, /* Shared library trampoline code */
302 /* For the mst_file* types, the names are only guaranteed to be unique
303 within a given .o file. */
304 mst_file_text
, /* Static version of mst_text */
305 mst_file_data
, /* Static version of mst_data */
306 mst_file_bss
/* Static version of mst_bss */
309 /* Define a simple structure used to hold some very basic information about
310 all defined global symbols (text, data, bss, abs, etc). The only required
311 information is the general_symbol_info.
313 In many cases, even if a file was compiled with no special options for
314 debugging at all, as long as was not stripped it will contain sufficient
315 information to build a useful minimal symbol table using this structure.
316 Even when a file contains enough debugging information to build a full
317 symbol table, these minimal symbols are still useful for quickly mapping
318 between names and addresses, and vice versa. They are also sometimes
319 used to figure out what full symbol table entries need to be read in. */
321 struct minimal_symbol
324 /* The general symbol info required for all types of symbols.
326 The SYMBOL_VALUE_ADDRESS contains the address that this symbol
329 struct general_symbol_info ginfo
;
331 /* Size of this symbol. end_psymtab in dbxread.c uses this
332 information to calculate the end of the partial symtab based on the
333 address of the last symbol plus the size of the last symbol. */
337 /* Which source file is this symbol in? Only relevant for mst_file_*. */
338 const char *filename
;
340 /* Classification type for this minimal symbol. */
342 ENUM_BITFIELD(minimal_symbol_type
) type
: 8;
344 /* Two flag bits provided for the use of the target. */
345 unsigned int target_flag_1
: 1;
346 unsigned int target_flag_2
: 1;
348 /* Minimal symbols with the same hash key are kept on a linked
349 list. This is the link. */
351 struct minimal_symbol
*hash_next
;
353 /* Minimal symbols are stored in two different hash tables. This is
354 the `next' pointer for the demangled hash table. */
356 struct minimal_symbol
*demangled_hash_next
;
359 #define MSYMBOL_TARGET_FLAG_1(msymbol) (msymbol)->target_flag_1
360 #define MSYMBOL_TARGET_FLAG_2(msymbol) (msymbol)->target_flag_2
361 #define MSYMBOL_SIZE(msymbol) (msymbol)->size
362 #define MSYMBOL_TYPE(msymbol) (msymbol)->type
368 /* Represent one symbol name; a variable, constant, function or typedef. */
370 /* Different name domains for symbols. Looking up a symbol specifies a
371 domain and ignores symbol definitions in other name domains. */
373 typedef enum domain_enum_tag
375 /* UNDEF_DOMAIN is used when a domain has not been discovered or
376 none of the following apply. This usually indicates an error either
377 in the symbol information or in gdb's handling of symbols. */
381 /* VAR_DOMAIN is the usual domain. In C, this contains variables,
382 function names, typedef names and enum type values. */
386 /* STRUCT_DOMAIN is used in C to hold struct, union and enum type names.
387 Thus, if `struct foo' is used in a C program, it produces a symbol named
388 `foo' in the STRUCT_DOMAIN. */
392 /* LABEL_DOMAIN may be used for names of labels (for gotos). */
397 /* Searching domains, used for `search_symbols'. Element numbers are
398 hardcoded in GDB, check all enum uses before changing it. */
402 /* Everything in VAR_DOMAIN minus FUNCTIONS_DOMAIN and
404 VARIABLES_DOMAIN
= 0,
406 /* All functions -- for some reason not methods, though. */
407 FUNCTIONS_DOMAIN
= 1,
409 /* All defined types */
416 /* An address-class says where to find the value of a symbol. */
420 /* Not used; catches errors. */
424 /* Value is constant int SYMBOL_VALUE, host byteorder. */
428 /* Value is at fixed address SYMBOL_VALUE_ADDRESS. */
432 /* Value is in register. SYMBOL_VALUE is the register number
433 in the original debug format. SYMBOL_REGISTER_OPS holds a
434 function that can be called to transform this into the
435 actual register number this represents in a specific target
436 architecture (gdbarch).
438 For some symbol formats (stabs, for some compilers at least),
439 the compiler generates two symbols, an argument and a register.
440 In some cases we combine them to a single LOC_REGISTER in symbol
441 reading, but currently not for all cases (e.g. it's passed on the
442 stack and then loaded into a register). */
446 /* It's an argument; the value is at SYMBOL_VALUE offset in arglist. */
450 /* Value address is at SYMBOL_VALUE offset in arglist. */
454 /* Value is in specified register. Just like LOC_REGISTER except the
455 register holds the address of the argument instead of the argument
456 itself. This is currently used for the passing of structs and unions
457 on sparc and hppa. It is also used for call by reference where the
458 address is in a register, at least by mipsread.c. */
462 /* Value is a local variable at SYMBOL_VALUE offset in stack frame. */
466 /* Value not used; definition in SYMBOL_TYPE. Symbols in the domain
467 STRUCT_DOMAIN all have this class. */
471 /* Value is address SYMBOL_VALUE_ADDRESS in the code. */
475 /* In a symbol table, value is SYMBOL_BLOCK_VALUE of a `struct block'.
476 In a partial symbol table, SYMBOL_VALUE_ADDRESS is the start address
477 of the block. Function names have this class. */
481 /* Value is a constant byte-sequence pointed to by SYMBOL_VALUE_BYTES, in
482 target byte order. */
486 /* Value is at fixed address, but the address of the variable has
487 to be determined from the minimal symbol table whenever the
488 variable is referenced.
489 This happens if debugging information for a global symbol is
490 emitted and the corresponding minimal symbol is defined
491 in another object file or runtime common storage.
492 The linker might even remove the minimal symbol if the global
493 symbol is never referenced, in which case the symbol remains
496 GDB would normally find the symbol in the minimal symbol table if it will
497 not find it in the full symbol table. But a reference to an external
498 symbol in a local block shadowing other definition requires full symbol
499 without possibly having its address available for LOC_STATIC. Testcase
500 is provided as `gdb.dwarf2/dw2-unresolved.exp'. */
504 /* The variable does not actually exist in the program.
505 The value is ignored. */
509 /* The variable's address is computed by a set of location
510 functions (see "struct symbol_computed_ops" below). */
514 /* The methods needed to implement LOC_COMPUTED. These methods can
515 use the symbol's .aux_value for additional per-symbol information.
517 At present this is only used to implement location expressions. */
519 struct symbol_computed_ops
522 /* Return the value of the variable SYMBOL, relative to the stack
523 frame FRAME. If the variable has been optimized out, return
526 Iff `read_needs_frame (SYMBOL)' is zero, then FRAME may be zero. */
528 struct value
*(*read_variable
) (struct symbol
* symbol
,
529 struct frame_info
* frame
);
531 /* Read variable SYMBOL like read_variable at (callee) FRAME's function
532 entry. SYMBOL should be a function parameter, otherwise
533 NO_ENTRY_VALUE_ERROR will be thrown. */
534 struct value
*(*read_variable_at_entry
) (struct symbol
*symbol
,
535 struct frame_info
*frame
);
537 /* Return non-zero if we need a frame to find the value of the SYMBOL. */
538 int (*read_needs_frame
) (struct symbol
* symbol
);
540 /* Write to STREAM a natural-language description of the location of
541 SYMBOL, in the context of ADDR. */
542 void (*describe_location
) (struct symbol
* symbol
, CORE_ADDR addr
,
543 struct ui_file
* stream
);
545 /* Tracepoint support. Append bytecodes to the tracepoint agent
546 expression AX that push the address of the object SYMBOL. Set
547 VALUE appropriately. Note --- for objects in registers, this
548 needn't emit any code; as long as it sets VALUE properly, then
549 the caller will generate the right code in the process of
550 treating this as an lvalue or rvalue. */
552 void (*tracepoint_var_ref
) (struct symbol
*symbol
, struct gdbarch
*gdbarch
,
553 struct agent_expr
*ax
, struct axs_value
*value
);
556 /* Functions used with LOC_REGISTER and LOC_REGPARM_ADDR. */
558 struct symbol_register_ops
560 int (*register_number
) (struct symbol
*symbol
, struct gdbarch
*gdbarch
);
563 /* This structure is space critical. See space comments at the top. */
568 /* The general symbol info required for all types of symbols. */
570 struct general_symbol_info ginfo
;
572 /* Data type of value */
576 /* The symbol table containing this symbol. This is the file
577 associated with LINE. It can be NULL during symbols read-in but it is
578 never NULL during normal operation. */
579 struct symtab
*symtab
;
583 ENUM_BITFIELD(domain_enum_tag
) domain
: 6;
586 /* NOTE: cagney/2003-11-02: The fields "aclass" and "ops" contain
587 overlapping information. By creating a per-aclass ops vector, or
588 using the aclass as an index into an ops table, the aclass and
589 ops fields can be merged. The latter, for instance, would shave
590 32-bits from each symbol (relative to a symbol lookup, any table
591 index overhead would be in the noise). */
593 ENUM_BITFIELD(address_class
) aclass
: 6;
595 /* Whether this is an argument. */
597 unsigned is_argument
: 1;
599 /* Whether this is an inlined function (class LOC_BLOCK only). */
600 unsigned is_inlined
: 1;
602 /* True if this is a C++ function symbol with template arguments.
603 In this case the symbol is really a "struct template_symbol". */
604 unsigned is_cplus_template_function
: 1;
606 /* Line number of this symbol's definition, except for inlined
607 functions. For an inlined function (class LOC_BLOCK and
608 SYMBOL_INLINED set) this is the line number of the function's call
609 site. Inlined function symbols are not definitions, and they are
610 never found by symbol table lookup.
612 FIXME: Should we really make the assumption that nobody will try
613 to debug files longer than 64K lines? What about machine
614 generated programs? */
618 /* Method's for symbol's of this class. */
619 /* NOTE: cagney/2003-11-02: See comment above attached to "aclass". */
623 /* Used with LOC_COMPUTED. */
624 const struct symbol_computed_ops
*ops_computed
;
626 /* Used with LOC_REGISTER and LOC_REGPARM_ADDR. */
627 const struct symbol_register_ops
*ops_register
;
630 /* An arbitrary data pointer, allowing symbol readers to record
631 additional information on a per-symbol basis. Note that this data
632 must be allocated using the same obstack as the symbol itself. */
633 /* So far it is only used by LOC_COMPUTED to
634 find the location information. For a LOC_BLOCK symbol
635 for a function in a compilation unit compiled with DWARF 2
636 information, this is information used internally by the DWARF 2
637 code --- specifically, the location expression for the frame
638 base for this function. */
639 /* FIXME drow/2003-02-21: For the LOC_BLOCK case, it might be better
640 to add a magic symbol to the block containing this information,
641 or to have a generic debug info annotation slot for symbols. */
645 struct symbol
*hash_next
;
649 #define SYMBOL_DOMAIN(symbol) (symbol)->domain
650 #define SYMBOL_CLASS(symbol) (symbol)->aclass
651 #define SYMBOL_IS_ARGUMENT(symbol) (symbol)->is_argument
652 #define SYMBOL_INLINED(symbol) (symbol)->is_inlined
653 #define SYMBOL_IS_CPLUS_TEMPLATE_FUNCTION(symbol) \
654 (symbol)->is_cplus_template_function
655 #define SYMBOL_TYPE(symbol) (symbol)->type
656 #define SYMBOL_LINE(symbol) (symbol)->line
657 #define SYMBOL_SYMTAB(symbol) (symbol)->symtab
658 #define SYMBOL_COMPUTED_OPS(symbol) (symbol)->ops.ops_computed
659 #define SYMBOL_REGISTER_OPS(symbol) (symbol)->ops.ops_register
660 #define SYMBOL_LOCATION_BATON(symbol) (symbol)->aux_value
662 /* An instance of this type is used to represent a C++ template
663 function. It includes a "struct symbol" as a kind of base class;
664 users downcast to "struct template_symbol *" when needed. A symbol
665 is really of this type iff SYMBOL_IS_CPLUS_TEMPLATE_FUNCTION is
668 struct template_symbol
670 /* The base class. */
673 /* The number of template arguments. */
674 int n_template_arguments
;
676 /* The template arguments. This is an array with
677 N_TEMPLATE_ARGUMENTS elements. */
678 struct symbol
**template_arguments
;
682 /* Each item represents a line-->pc (or the reverse) mapping. This is
683 somewhat more wasteful of space than one might wish, but since only
684 the files which are actually debugged are read in to core, we don't
687 struct linetable_entry
693 /* The order of entries in the linetable is significant. They should
694 be sorted by increasing values of the pc field. If there is more than
695 one entry for a given pc, then I'm not sure what should happen (and
696 I not sure whether we currently handle it the best way).
698 Example: a C for statement generally looks like this
700 10 0x100 - for the init/test part of a for stmt.
703 10 0x400 - for the increment part of a for stmt.
705 If an entry has a line number of zero, it marks the start of a PC
706 range for which no line number information is available. It is
707 acceptable, though wasteful of table space, for such a range to be
714 /* Actually NITEMS elements. If you don't like this use of the
715 `struct hack', you can shove it up your ANSI (seriously, if the
716 committee tells us how to do it, we can probably go along). */
717 struct linetable_entry item
[1];
720 /* How to relocate the symbols from each section in a symbol file.
721 Each struct contains an array of offsets.
722 The ordering and meaning of the offsets is file-type-dependent;
723 typically it is indexed by section numbers or symbol types or
726 To give us flexibility in changing the internal representation
727 of these offsets, the ANOFFSET macro must be used to insert and
728 extract offset values in the struct. */
730 struct section_offsets
732 CORE_ADDR offsets
[1]; /* As many as needed. */
735 #define ANOFFSET(secoff, whichone) \
737 ? (internal_error (__FILE__, __LINE__, \
738 _("Section index is uninitialized")), -1) \
739 : secoff->offsets[whichone])
741 /* The size of a section_offsets table for N sections. */
742 #define SIZEOF_N_SECTION_OFFSETS(n) \
743 (sizeof (struct section_offsets) \
744 + sizeof (((struct section_offsets *) 0)->offsets) * ((n)-1))
746 /* Each source file or header is represented by a struct symtab.
747 These objects are chained through the `next' field. */
751 /* Unordered chain of all existing symtabs of this objfile. */
755 /* List of all symbol scope blocks for this symtab. May be shared
756 between different symtabs (and normally is for all the symtabs
757 in a given compilation unit). */
759 struct blockvector
*blockvector
;
761 /* Table mapping core addresses to line numbers for this file.
762 Can be NULL if none. Never shared between different symtabs. */
764 struct linetable
*linetable
;
766 /* Section in objfile->section_offsets for the blockvector and
767 the linetable. Probably always SECT_OFF_TEXT. */
769 int block_line_section
;
771 /* If several symtabs share a blockvector, exactly one of them
772 should be designated the primary, so that the blockvector
773 is relocated exactly once by objfile_relocate. */
775 unsigned int primary
: 1;
777 /* Symtab has been compiled with both optimizations and debug info so that
778 GDB may stop skipping prologues as variables locations are valid already
779 at function entry points. */
781 unsigned int locations_valid
: 1;
783 /* DWARF unwinder for this CU is valid even for epilogues (PC at the return
784 instruction). This is supported by GCC since 4.5.0. */
786 unsigned int epilogue_unwind_valid
: 1;
788 /* The macro table for this symtab. Like the blockvector, this
789 may be shared between different symtabs --- and normally is for
790 all the symtabs in a given compilation unit. */
791 struct macro_table
*macro_table
;
793 /* Name of this source file. */
797 /* Directory in which it was compiled, or NULL if we don't know. */
801 /* Total number of lines found in source file. */
805 /* line_charpos[N] is the position of the (N-1)th line of the
806 source file. "position" means something we can lseek() to; it
807 is not guaranteed to be useful any other way. */
811 /* Language of this source file. */
813 enum language language
;
815 /* String that identifies the format of the debugging information, such
816 as "stabs", "dwarf 1", "dwarf 2", "coff", etc. This is mostly useful
817 for automated testing of gdb but may also be information that is
818 useful to the user. */
820 const char *debugformat
;
822 /* String of producer version information. May be zero. */
824 const char *producer
;
826 /* Full name of file as found by searching the source path.
827 NULL if not yet known. */
831 /* Object file from which this symbol information was read. */
833 struct objfile
*objfile
;
835 /* struct call_site entries for this compilation unit or NULL. */
837 htab_t call_site_htab
;
840 #define BLOCKVECTOR(symtab) (symtab)->blockvector
841 #define LINETABLE(symtab) (symtab)->linetable
842 #define SYMTAB_PSPACE(symtab) (symtab)->objfile->pspace
845 /* The virtual function table is now an array of structures which have the
846 form { int16 offset, delta; void *pfn; }.
848 In normal virtual function tables, OFFSET is unused.
849 DELTA is the amount which is added to the apparent object's base
850 address in order to point to the actual object to which the
851 virtual function should be applied.
852 PFN is a pointer to the virtual function.
854 Note that this macro is g++ specific (FIXME). */
856 #define VTBL_FNADDR_OFFSET 2
858 /* External variables and functions for the objects described above. */
860 /* True if we are nested inside psymtab_to_symtab. */
862 extern int currently_reading_symtab
;
864 /* symtab.c lookup functions */
866 extern const char multiple_symbols_ask
[];
867 extern const char multiple_symbols_all
[];
868 extern const char multiple_symbols_cancel
[];
870 const char *multiple_symbols_select_mode (void);
872 int symbol_matches_domain (enum language symbol_language
,
873 domain_enum symbol_domain
,
876 /* lookup a symbol table by source file name. */
878 extern struct symtab
*lookup_symtab (const char *);
880 /* lookup a symbol by name (optional block) in language. */
882 extern struct symbol
*lookup_symbol_in_language (const char *,
883 const struct block
*,
888 /* lookup a symbol by name (optional block, optional symtab)
889 in the current language. */
891 extern struct symbol
*lookup_symbol (const char *, const struct block
*,
892 const domain_enum
, int *);
894 /* A default version of lookup_symbol_nonlocal for use by languages
895 that can't think of anything better to do. */
897 extern struct symbol
*basic_lookup_symbol_nonlocal (const char *,
898 const struct block
*,
901 /* Some helper functions for languages that need to write their own
902 lookup_symbol_nonlocal functions. */
904 /* Lookup a symbol in the static block associated to BLOCK, if there
905 is one; do nothing if BLOCK is NULL or a global block. */
907 extern struct symbol
*lookup_symbol_static (const char *name
,
908 const struct block
*block
,
909 const domain_enum domain
);
911 /* Lookup a symbol in all files' global blocks (searching psymtabs if
914 extern struct symbol
*lookup_symbol_global (const char *name
,
915 const struct block
*block
,
916 const domain_enum domain
);
918 /* Lookup a symbol within the block BLOCK. This, unlike
919 lookup_symbol_block, will set SYMTAB and BLOCK_FOUND correctly, and
920 will fix up the symbol if necessary. */
922 extern struct symbol
*lookup_symbol_aux_block (const char *name
,
923 const struct block
*block
,
924 const domain_enum domain
);
926 extern struct symbol
*lookup_language_this (const struct language_defn
*lang
,
927 const struct block
*block
);
929 /* Lookup a symbol only in the file static scope of all the objfiles. */
931 struct symbol
*lookup_static_symbol_aux (const char *name
,
932 const domain_enum domain
);
935 /* lookup a symbol by name, within a specified block. */
937 extern struct symbol
*lookup_block_symbol (const struct block
*, const char *,
940 /* lookup a [struct, union, enum] by name, within a specified block. */
942 extern struct type
*lookup_struct (const char *, struct block
*);
944 extern struct type
*lookup_union (const char *, struct block
*);
946 extern struct type
*lookup_enum (const char *, struct block
*);
948 /* from blockframe.c: */
950 /* lookup the function symbol corresponding to the address. */
952 extern struct symbol
*find_pc_function (CORE_ADDR
);
954 /* lookup the function corresponding to the address and section. */
956 extern struct symbol
*find_pc_sect_function (CORE_ADDR
, struct obj_section
*);
958 extern int find_pc_partial_function_gnu_ifunc (CORE_ADDR pc
, const char **name
,
961 int *is_gnu_ifunc_p
);
963 /* lookup function from address, return name, start addr and end addr. */
965 extern int find_pc_partial_function (CORE_ADDR
, const char **, CORE_ADDR
*,
968 extern void clear_pc_function_cache (void);
970 /* lookup partial symbol table by address and section. */
972 extern struct symtab
*find_pc_sect_symtab_via_partial (CORE_ADDR
,
973 struct obj_section
*);
975 /* lookup full symbol table by address. */
977 extern struct symtab
*find_pc_symtab (CORE_ADDR
);
979 /* lookup full symbol table by address and section. */
981 extern struct symtab
*find_pc_sect_symtab (CORE_ADDR
, struct obj_section
*);
983 extern int find_pc_line_pc_range (CORE_ADDR
, CORE_ADDR
*, CORE_ADDR
*);
985 extern void reread_symbols (void);
987 extern struct type
*lookup_transparent_type (const char *);
988 extern struct type
*basic_lookup_transparent_type (const char *);
991 /* Macro for name of symbol to indicate a file compiled with gcc. */
992 #ifndef GCC_COMPILED_FLAG_SYMBOL
993 #define GCC_COMPILED_FLAG_SYMBOL "gcc_compiled."
996 /* Macro for name of symbol to indicate a file compiled with gcc2. */
997 #ifndef GCC2_COMPILED_FLAG_SYMBOL
998 #define GCC2_COMPILED_FLAG_SYMBOL "gcc2_compiled."
1001 extern int in_gnu_ifunc_stub (CORE_ADDR pc
);
1003 /* Functions for resolving STT_GNU_IFUNC symbols which are implemented only
1004 for ELF symbol files. */
1006 struct gnu_ifunc_fns
1008 /* See elf_gnu_ifunc_resolve_addr for its real implementation. */
1009 CORE_ADDR (*gnu_ifunc_resolve_addr
) (struct gdbarch
*gdbarch
, CORE_ADDR pc
);
1011 /* See elf_gnu_ifunc_resolve_name for its real implementation. */
1012 int (*gnu_ifunc_resolve_name
) (const char *function_name
,
1013 CORE_ADDR
*function_address_p
);
1015 /* See elf_gnu_ifunc_resolver_stop for its real implementation. */
1016 void (*gnu_ifunc_resolver_stop
) (struct breakpoint
*b
);
1018 /* See elf_gnu_ifunc_resolver_return_stop for its real implementation. */
1019 void (*gnu_ifunc_resolver_return_stop
) (struct breakpoint
*b
);
1022 #define gnu_ifunc_resolve_addr gnu_ifunc_fns_p->gnu_ifunc_resolve_addr
1023 #define gnu_ifunc_resolve_name gnu_ifunc_fns_p->gnu_ifunc_resolve_name
1024 #define gnu_ifunc_resolver_stop gnu_ifunc_fns_p->gnu_ifunc_resolver_stop
1025 #define gnu_ifunc_resolver_return_stop \
1026 gnu_ifunc_fns_p->gnu_ifunc_resolver_return_stop
1028 extern const struct gnu_ifunc_fns
*gnu_ifunc_fns_p
;
1030 extern CORE_ADDR
find_solib_trampoline_target (struct frame_info
*, CORE_ADDR
);
1032 struct symtab_and_line
1034 /* The program space of this sal. */
1035 struct program_space
*pspace
;
1037 struct symtab
*symtab
;
1038 struct obj_section
*section
;
1039 /* Line number. Line numbers start at 1 and proceed through symtab->nlines.
1040 0 is never a valid line number; it is used to indicate that line number
1041 information is not available. */
1050 extern void init_sal (struct symtab_and_line
*sal
);
1052 struct symtabs_and_lines
1054 struct symtab_and_line
*sals
;
1060 /* Some types and macros needed for exception catchpoints.
1061 Can't put these in target.h because symtab_and_line isn't
1062 known there. This file will be included by breakpoint.c,
1063 hppa-tdep.c, etc. */
1065 /* Enums for exception-handling support. */
1066 enum exception_event_kind
1074 /* Given a pc value, return line number it is in. Second arg nonzero means
1075 if pc is on the boundary use the previous statement's line number. */
1077 extern struct symtab_and_line
find_pc_line (CORE_ADDR
, int);
1079 /* Same function, but specify a section as well as an address. */
1081 extern struct symtab_and_line
find_pc_sect_line (CORE_ADDR
,
1082 struct obj_section
*, int);
1084 /* Given a symtab and line number, return the pc there. */
1086 extern int find_line_pc (struct symtab
*, int, CORE_ADDR
*);
1088 extern int find_line_pc_range (struct symtab_and_line
, CORE_ADDR
*,
1091 extern void resolve_sal_pc (struct symtab_and_line
*);
1093 /* Given a string, return the line specified by it. For commands like "list"
1094 and "breakpoint". */
1096 extern struct symtabs_and_lines
decode_line_spec (char *, int);
1098 extern struct symtabs_and_lines
decode_line_spec_1 (char *, int);
1102 void maintenance_print_symbols (char *, int);
1104 void maintenance_print_psymbols (char *, int);
1106 void maintenance_print_msymbols (char *, int);
1108 void maintenance_print_objfiles (char *, int);
1110 void maintenance_info_symtabs (char *, int);
1112 void maintenance_info_psymtabs (char *, int);
1114 void maintenance_check_symtabs (char *, int);
1118 void maintenance_print_statistics (char *, int);
1120 /* Symbol-reading stuff in symfile.c and solib.c. */
1122 extern void clear_solib (void);
1126 extern int identify_source_line (struct symtab
*, int, int, CORE_ADDR
);
1128 extern void print_source_lines (struct symtab
*, int, int, int);
1130 extern void forget_cached_source_info_for_objfile (struct objfile
*);
1131 extern void forget_cached_source_info (void);
1133 extern void select_source_symtab (struct symtab
*);
1135 extern char **default_make_symbol_completion_list_break_on
1136 (char *text
, char *word
, const char *break_on
);
1137 extern char **default_make_symbol_completion_list (char *, char *);
1138 extern char **make_symbol_completion_list (char *, char *);
1139 extern char **make_symbol_completion_list_fn (struct cmd_list_element
*,
1142 extern char **make_file_symbol_completion_list (char *, char *, char *);
1144 extern char **make_source_files_completion_list (char *, char *);
1148 int matching_obj_sections (struct obj_section
*, struct obj_section
*);
1150 extern const char *find_main_filename (void);
1152 extern struct symtab
*find_line_symtab (struct symtab
*, int, int *, int *);
1154 extern struct symtab_and_line
find_function_start_sal (struct symbol
*sym
,
1157 extern void skip_prologue_sal (struct symtab_and_line
*);
1161 extern void clear_symtab_users (int add_flags
);
1163 extern enum language
deduce_language_from_filename (const char *);
1167 extern int in_prologue (struct gdbarch
*gdbarch
,
1168 CORE_ADDR pc
, CORE_ADDR func_start
);
1170 extern CORE_ADDR
skip_prologue_using_sal (struct gdbarch
*gdbarch
,
1171 CORE_ADDR func_addr
);
1173 extern struct symbol
*fixup_symbol_section (struct symbol
*,
1176 /* Symbol searching */
1178 /* When using search_symbols, a list of the following structs is returned.
1179 Callers must free the search list using free_search_symbols! */
1180 struct symbol_search
1182 /* The block in which the match was found. Could be, for example,
1183 STATIC_BLOCK or GLOBAL_BLOCK. */
1186 /* Information describing what was found.
1188 If symtab abd symbol are NOT NULL, then information was found
1190 struct symtab
*symtab
;
1191 struct symbol
*symbol
;
1193 /* If msymbol is non-null, then a match was made on something for
1194 which only minimal_symbols exist. */
1195 struct minimal_symbol
*msymbol
;
1197 /* A link to the next match, or NULL for the end. */
1198 struct symbol_search
*next
;
1201 extern void search_symbols (char *, enum search_domain
, int, char **,
1202 struct symbol_search
**);
1203 extern void free_search_symbols (struct symbol_search
*);
1204 extern struct cleanup
*make_cleanup_free_search_symbols (struct symbol_search
1207 /* The name of the ``main'' function.
1208 FIXME: cagney/2001-03-20: Can't make main_name() const since some
1209 of the calling code currently assumes that the string isn't
1211 extern void set_main_name (const char *name
);
1212 extern /*const */ char *main_name (void);
1213 extern enum language language_of_main
;
1215 /* Check global symbols in objfile. */
1216 struct symbol
*lookup_global_symbol_from_objfile (const struct objfile
*,
1218 const domain_enum domain
);
1220 /* Return 1 if the supplied producer string matches the ARM RealView
1221 compiler (armcc). */
1222 int producer_is_realview (const char *producer
);
1224 void fixup_section (struct general_symbol_info
*ginfo
,
1225 CORE_ADDR addr
, struct objfile
*objfile
);
1227 struct objfile
*lookup_objfile_from_block (const struct block
*block
);
1229 extern int basenames_may_differ
;
1231 int compare_filenames_for_search (const char *filename
,
1232 const char *search_name
,
1235 int iterate_over_some_symtabs (const char *name
,
1236 const char *full_path
,
1237 const char *real_path
,
1238 int (*callback
) (struct symtab
*symtab
,
1241 struct symtab
*first
,
1242 struct symtab
*after_last
);
1244 void iterate_over_symtabs (const char *name
,
1245 int (*callback
) (struct symtab
*symtab
,
1249 DEF_VEC_I (CORE_ADDR
);
1251 VEC (CORE_ADDR
) *find_pcs_for_symtab_line (struct symtab
*symtab
, int line
,
1252 struct linetable_entry
**best_entry
);
1254 /* Callback for LA_ITERATE_OVER_SYMBOLS. The callback will be called
1255 once per matching symbol SYM, with DATA being the argument of the
1256 same name that was passed to LA_ITERATE_OVER_SYMBOLS. The callback
1257 should return nonzero to indicate that LA_ITERATE_OVER_SYMBOLS
1258 should continue iterating, or zero to indicate that the iteration
1261 typedef int (symbol_found_callback_ftype
) (struct symbol
*sym
, void *data
);
1263 void iterate_over_symbols (const struct block
*block
, const char *name
,
1264 const domain_enum domain
,
1265 symbol_found_callback_ftype
*callback
,
1268 struct cleanup
*demangle_for_lookup (const char *name
, enum language lang
,
1269 const char **result_name
);
1271 #endif /* !defined(SYMTAB_H) */