1 /* Symbol table definitions for GDB.
2 Copyright 1986, 1988, 1989, 1990, 1991, 1992, 1993, 1994, 1995, 1996,
3 1997, 1998, 1999, 2000, 2001
4 Free Software Foundation, Inc.
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 2 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, write to the Free Software
20 Foundation, Inc., 59 Temple Place - Suite 330,
21 Boston, MA 02111-1307, USA. */
23 #if !defined (SYMTAB_H)
26 /* Some definitions and declarations to go with use of obstacks. */
29 #define obstack_chunk_alloc xmalloc
30 #define obstack_chunk_free xfree
33 /* Don't do this; it means that if some .o's are compiled with GNU C
34 and some are not (easy to do accidentally the way we configure
35 things; also it is a pain to have to "make clean" every time you
36 want to switch compilers), then GDB dies a horrible death. */
37 /* GNU C supports enums that are bitfields. Some compilers don't. */
38 #if 0 && defined(__GNUC__) && !defined(BYTE_BITFIELD)
39 #define BYTE_BITFIELD :8;
41 #define BYTE_BITFIELD /*nothing */
44 /* Define a structure for the information that is common to all symbol types,
45 including minimal symbols, partial symbols, and full symbols. In a
46 multilanguage environment, some language specific information may need to
47 be recorded along with each symbol.
49 These fields are ordered to encourage good packing, since we frequently
50 have tens or hundreds of thousands of these. */
52 struct general_symbol_info
54 /* Name of the symbol. This is a required field. Storage for the name is
55 allocated on the psymbol_obstack or symbol_obstack for the associated
60 /* Value of the symbol. Which member of this union to use, and what
61 it means, depends on what kind of symbol this is and its
62 SYMBOL_CLASS. See comments there for more details. All of these
63 are in host byte order (though what they point to might be in
64 target byte order, e.g. LOC_CONST_BYTES). */
68 /* The fact that this is a long not a LONGEST mainly limits the
69 range of a LOC_CONST. Since LOC_CONST_BYTES exists, I'm not
70 sure that is a big deal. */
79 /* for opaque typedef struct chain */
85 /* Since one and only one language can apply, wrap the language specific
86 information inside a union. */
90 struct cplus_specific
/* For C++ */
96 struct chill_specific
/* For Chill */
104 /* Record the source code language that applies to this symbol.
105 This is used to select one of the fields from the language specific
108 enum language language BYTE_BITFIELD
;
110 /* Which section is this symbol in? This is an index into
111 section_offsets for this objfile. Negative means that the symbol
112 does not get relocated relative to a section.
113 Disclaimer: currently this is just used for xcoff, so don't
114 expect all symbol-reading code to set it correctly (the ELF code
115 also tries to set it correctly). */
119 /* The bfd section associated with this symbol. */
121 asection
*bfd_section
;
124 extern CORE_ADDR
symbol_overlayed_address (CORE_ADDR
, asection
*);
126 #define SYMBOL_NAME(symbol) (symbol)->ginfo.name
127 #define SYMBOL_VALUE(symbol) (symbol)->ginfo.value.ivalue
128 #define SYMBOL_VALUE_ADDRESS(symbol) (symbol)->ginfo.value.address
129 #define SYMBOL_VALUE_BYTES(symbol) (symbol)->ginfo.value.bytes
130 #define SYMBOL_BLOCK_VALUE(symbol) (symbol)->ginfo.value.block
131 #define SYMBOL_VALUE_CHAIN(symbol) (symbol)->ginfo.value.chain
132 #define SYMBOL_LANGUAGE(symbol) (symbol)->ginfo.language
133 #define SYMBOL_SECTION(symbol) (symbol)->ginfo.section
134 #define SYMBOL_BFD_SECTION(symbol) (symbol)->ginfo.bfd_section
136 #define SYMBOL_CPLUS_DEMANGLED_NAME(symbol) \
137 (symbol)->ginfo.language_specific.cplus_specific.demangled_name
139 /* Macro that initializes the language dependent portion of a symbol
140 depending upon the language for the symbol. */
142 #define SYMBOL_INIT_LANGUAGE_SPECIFIC(symbol,language) \
144 SYMBOL_LANGUAGE (symbol) = language; \
145 if (SYMBOL_LANGUAGE (symbol) == language_cplus \
146 || SYMBOL_LANGUAGE (symbol) == language_java \
149 SYMBOL_CPLUS_DEMANGLED_NAME (symbol) = NULL; \
151 else if (SYMBOL_LANGUAGE (symbol) == language_chill) \
153 SYMBOL_CHILL_DEMANGLED_NAME (symbol) = NULL; \
157 memset (&(symbol)->ginfo.language_specific, 0, \
158 sizeof ((symbol)->ginfo.language_specific)); \
162 /* Macro that attempts to initialize the demangled name for a symbol,
163 based on the language of that symbol. If the language is set to
164 language_auto, it will attempt to find any demangling algorithm
165 that works and then set the language appropriately. If no demangling
166 of any kind is found, the language is set back to language_unknown,
167 so we can avoid doing this work again the next time we encounter
168 the symbol. Any required space to store the name is obtained from the
169 specified obstack. */
171 #define SYMBOL_INIT_DEMANGLED_NAME(symbol,obstack) \
173 char *demangled = NULL; \
174 if (SYMBOL_LANGUAGE (symbol) == language_unknown) \
175 SYMBOL_LANGUAGE (symbol) = language_auto; \
176 if (SYMBOL_LANGUAGE (symbol) == language_cplus \
177 || SYMBOL_LANGUAGE (symbol) == language_auto) \
180 cplus_demangle (SYMBOL_NAME (symbol), DMGL_PARAMS | DMGL_ANSI);\
181 if (demangled != NULL) \
183 SYMBOL_LANGUAGE (symbol) = language_cplus; \
184 SYMBOL_CPLUS_DEMANGLED_NAME (symbol) = \
185 obsavestring (demangled, strlen (demangled), (obstack)); \
190 SYMBOL_CPLUS_DEMANGLED_NAME (symbol) = NULL; \
193 if (SYMBOL_LANGUAGE (symbol) == language_java) \
196 cplus_demangle (SYMBOL_NAME (symbol), \
197 DMGL_PARAMS | DMGL_ANSI | DMGL_JAVA); \
198 if (demangled != NULL) \
200 SYMBOL_LANGUAGE (symbol) = language_java; \
201 SYMBOL_CPLUS_DEMANGLED_NAME (symbol) = \
202 obsavestring (demangled, strlen (demangled), (obstack)); \
207 SYMBOL_CPLUS_DEMANGLED_NAME (symbol) = NULL; \
210 if (demangled == NULL \
211 && (SYMBOL_LANGUAGE (symbol) == language_chill \
212 || SYMBOL_LANGUAGE (symbol) == language_auto)) \
215 chill_demangle (SYMBOL_NAME (symbol)); \
216 if (demangled != NULL) \
218 SYMBOL_LANGUAGE (symbol) = language_chill; \
219 SYMBOL_CHILL_DEMANGLED_NAME (symbol) = \
220 obsavestring (demangled, strlen (demangled), (obstack)); \
225 SYMBOL_CHILL_DEMANGLED_NAME (symbol) = NULL; \
230 /* Macro that returns the demangled name for a symbol based on the language
231 for that symbol. If no demangled name exists, returns NULL. */
233 #define SYMBOL_DEMANGLED_NAME(symbol) \
234 (SYMBOL_LANGUAGE (symbol) == language_cplus \
235 || SYMBOL_LANGUAGE (symbol) == language_java \
236 ? SYMBOL_CPLUS_DEMANGLED_NAME (symbol) \
237 : (SYMBOL_LANGUAGE (symbol) == language_chill \
238 ? SYMBOL_CHILL_DEMANGLED_NAME (symbol) \
241 #define SYMBOL_CHILL_DEMANGLED_NAME(symbol) \
242 (symbol)->ginfo.language_specific.chill_specific.demangled_name
244 /* Macro that returns the "natural source name" of a symbol. In C++ this is
245 the "demangled" form of the name if demangle is on and the "mangled" form
246 of the name if demangle is off. In other languages this is just the
247 symbol name. The result should never be NULL. */
249 #define SYMBOL_SOURCE_NAME(symbol) \
250 (demangle && SYMBOL_DEMANGLED_NAME (symbol) != NULL \
251 ? SYMBOL_DEMANGLED_NAME (symbol) \
252 : SYMBOL_NAME (symbol))
254 /* Macro that returns the "natural assembly name" of a symbol. In C++ this is
255 the "mangled" form of the name if demangle is off, or if demangle is on and
256 asm_demangle is off. Otherwise if asm_demangle is on it is the "demangled"
257 form. In other languages this is just the symbol name. The result should
260 #define SYMBOL_LINKAGE_NAME(symbol) \
261 (demangle && asm_demangle && SYMBOL_DEMANGLED_NAME (symbol) != NULL \
262 ? SYMBOL_DEMANGLED_NAME (symbol) \
263 : SYMBOL_NAME (symbol))
265 /* Macro that tests a symbol for a match against a specified name string.
266 First test the unencoded name, then looks for and test a C++ encoded
267 name if it exists. Note that whitespace is ignored while attempting to
268 match a C++ encoded name, so that "foo::bar(int,long)" is the same as
269 "foo :: bar (int, long)".
270 Evaluates to zero if the match fails, or nonzero if it succeeds. */
272 #define SYMBOL_MATCHES_NAME(symbol, name) \
273 (STREQ (SYMBOL_NAME (symbol), (name)) \
274 || (SYMBOL_DEMANGLED_NAME (symbol) != NULL \
275 && strcmp_iw (SYMBOL_DEMANGLED_NAME (symbol), (name)) == 0))
277 /* Macro that tests a symbol for an re-match against the last compiled regular
278 expression. First test the unencoded name, then look for and test a C++
279 encoded name if it exists.
280 Evaluates to zero if the match fails, or nonzero if it succeeds. */
282 #define SYMBOL_MATCHES_REGEXP(symbol) \
283 (re_exec (SYMBOL_NAME (symbol)) != 0 \
284 || (SYMBOL_DEMANGLED_NAME (symbol) != NULL \
285 && re_exec (SYMBOL_DEMANGLED_NAME (symbol)) != 0))
287 /* Define a simple structure used to hold some very basic information about
288 all defined global symbols (text, data, bss, abs, etc). The only required
289 information is the general_symbol_info.
291 In many cases, even if a file was compiled with no special options for
292 debugging at all, as long as was not stripped it will contain sufficient
293 information to build a useful minimal symbol table using this structure.
294 Even when a file contains enough debugging information to build a full
295 symbol table, these minimal symbols are still useful for quickly mapping
296 between names and addresses, and vice versa. They are also sometimes
297 used to figure out what full symbol table entries need to be read in. */
299 struct minimal_symbol
302 /* The general symbol info required for all types of symbols.
304 The SYMBOL_VALUE_ADDRESS contains the address that this symbol
307 struct general_symbol_info ginfo
;
309 /* The info field is available for caching machine-specific information
310 so it doesn't have to rederive the info constantly (over a serial line).
311 It is initialized to zero and stays that way until target-dependent code
312 sets it. Storage for any data pointed to by this field should be allo-
313 cated on the symbol_obstack for the associated objfile.
314 The type would be "void *" except for reasons of compatibility with older
315 compilers. This field is optional.
317 Currently, the AMD 29000 tdep.c uses it to remember things it has decoded
318 from the instructions in the function header, and the MIPS-16 code uses
319 it to identify 16-bit procedures. */
323 #ifdef SOFUN_ADDRESS_MAYBE_MISSING
324 /* Which source file is this symbol in? Only relevant for mst_file_*. */
328 /* Classification types for this symbol. These should be taken as "advisory
329 only", since if gdb can't easily figure out a classification it simply
330 selects mst_unknown. It may also have to guess when it can't figure out
331 which is a better match between two types (mst_data versus mst_bss) for
332 example. Since the minimal symbol info is sometimes derived from the
333 BFD library's view of a file, we need to live with what information bfd
336 enum minimal_symbol_type
338 mst_unknown
= 0, /* Unknown type, the default */
339 mst_text
, /* Generally executable instructions */
340 mst_data
, /* Generally initialized data */
341 mst_bss
, /* Generally uninitialized data */
342 mst_abs
, /* Generally absolute (nonrelocatable) */
343 /* GDB uses mst_solib_trampoline for the start address of a shared
344 library trampoline entry. Breakpoints for shared library functions
345 are put there if the shared library is not yet loaded.
346 After the shared library is loaded, lookup_minimal_symbol will
347 prefer the minimal symbol from the shared library (usually
348 a mst_text symbol) over the mst_solib_trampoline symbol, and the
349 breakpoints will be moved to their true address in the shared
350 library via breakpoint_re_set. */
351 mst_solib_trampoline
, /* Shared library trampoline code */
352 /* For the mst_file* types, the names are only guaranteed to be unique
353 within a given .o file. */
354 mst_file_text
, /* Static version of mst_text */
355 mst_file_data
, /* Static version of mst_data */
356 mst_file_bss
/* Static version of mst_bss */
360 /* Minimal symbols with the same hash key are kept on a linked
361 list. This is the link. */
363 struct minimal_symbol
*hash_next
;
365 /* Minimal symbols are stored in two different hash tables. This is
366 the `next' pointer for the demangled hash table. */
368 struct minimal_symbol
*demangled_hash_next
;
371 #define MSYMBOL_INFO(msymbol) (msymbol)->info
372 #define MSYMBOL_TYPE(msymbol) (msymbol)->type
376 /* All of the name-scope contours of the program
377 are represented by `struct block' objects.
378 All of these objects are pointed to by the blockvector.
380 Each block represents one name scope.
381 Each lexical context has its own block.
383 The blockvector begins with some special blocks.
384 The GLOBAL_BLOCK contains all the symbols defined in this compilation
385 whose scope is the entire program linked together.
386 The STATIC_BLOCK contains all the symbols whose scope is the
387 entire compilation excluding other separate compilations.
388 Blocks starting with the FIRST_LOCAL_BLOCK are not special.
390 Each block records a range of core addresses for the code that
391 is in the scope of the block. The STATIC_BLOCK and GLOBAL_BLOCK
392 give, for the range of code, the entire range of code produced
393 by the compilation that the symbol segment belongs to.
395 The blocks appear in the blockvector
396 in order of increasing starting-address,
397 and, within that, in order of decreasing ending-address.
399 This implies that within the body of one function
400 the blocks appear in the order of a depth-first tree walk. */
404 /* Number of blocks in the list. */
406 /* The blocks themselves. */
407 struct block
*block
[1];
410 #define BLOCKVECTOR_NBLOCKS(blocklist) (blocklist)->nblocks
411 #define BLOCKVECTOR_BLOCK(blocklist,n) (blocklist)->block[n]
413 /* Special block numbers */
415 #define GLOBAL_BLOCK 0
416 #define STATIC_BLOCK 1
417 #define FIRST_LOCAL_BLOCK 2
422 /* Addresses in the executable code that are in this block. */
427 /* The symbol that names this block, if the block is the body of a
428 function; otherwise, zero. */
430 struct symbol
*function
;
432 /* The `struct block' for the containing block, or 0 if none.
434 The superblock of a top-level local block (i.e. a function in the
435 case of C) is the STATIC_BLOCK. The superblock of the
436 STATIC_BLOCK is the GLOBAL_BLOCK. */
438 struct block
*superblock
;
440 /* Version of GCC used to compile the function corresponding
441 to this block, or 0 if not compiled with GCC. When possible,
442 GCC should be compatible with the native compiler, or if that
443 is not feasible, the differences should be fixed during symbol
444 reading. As of 16 Apr 93, this flag is never used to distinguish
445 between gcc2 and the native compiler.
447 If there is no function corresponding to this block, this meaning
448 of this flag is undefined. */
450 unsigned char gcc_compile_flag
;
452 /* Number of local symbols. */
456 /* The symbols. If some of them are arguments, then they must be
457 in the order in which we would like to print them. */
459 struct symbol
*sym
[1];
462 #define BLOCK_START(bl) (bl)->startaddr
463 #define BLOCK_END(bl) (bl)->endaddr
464 #define BLOCK_NSYMS(bl) (bl)->nsyms
465 #define BLOCK_SYM(bl, n) (bl)->sym[n]
466 #define BLOCK_FUNCTION(bl) (bl)->function
467 #define BLOCK_SUPERBLOCK(bl) (bl)->superblock
468 #define BLOCK_GCC_COMPILED(bl) (bl)->gcc_compile_flag
470 /* Macro to loop through all symbols in a block BL.
471 i counts which symbol we are looking at, and sym points to the current
473 #define ALL_BLOCK_SYMBOLS(bl, i, sym) \
474 for ((i) = 0, (sym) = BLOCK_SYM ((bl), (i)); \
475 (i) < BLOCK_NSYMS ((bl)); \
476 ++(i), (sym) = BLOCK_SYM ((bl), (i)))
478 /* Nonzero if symbols of block BL should be sorted alphabetically.
479 Don't sort a block which corresponds to a function. If we did the
480 sorting would have to preserve the order of the symbols for the
483 #define BLOCK_SHOULD_SORT(bl) ((bl)->nsyms >= 40 && BLOCK_FUNCTION (bl) == NULL)
486 /* Represent one symbol name; a variable, constant, function or typedef. */
488 /* Different name spaces for symbols. Looking up a symbol specifies a
489 namespace and ignores symbol definitions in other name spaces. */
493 /* UNDEF_NAMESPACE is used when a namespace has not been discovered or
494 none of the following apply. This usually indicates an error either
495 in the symbol information or in gdb's handling of symbols. */
499 /* VAR_NAMESPACE is the usual namespace. In C, this contains variables,
500 function names, typedef names and enum type values. */
504 /* STRUCT_NAMESPACE is used in C to hold struct, union and enum type names.
505 Thus, if `struct foo' is used in a C program, it produces a symbol named
506 `foo' in the STRUCT_NAMESPACE. */
510 /* LABEL_NAMESPACE may be used for names of labels (for gotos);
511 currently it is not used and labels are not recorded at all. */
515 /* Searching namespaces. These overlap with VAR_NAMESPACE, providing
516 some granularity with the search_symbols function. */
518 /* Everything in VAR_NAMESPACE minus FUNCTIONS_-, TYPES_-, and
522 /* All functions -- for some reason not methods, though. */
525 /* All defined types */
528 /* All class methods -- why is this separated out? */
534 /* An address-class says where to find the value of a symbol. */
538 /* Not used; catches errors */
542 /* Value is constant int SYMBOL_VALUE, host byteorder */
546 /* Value is at fixed address SYMBOL_VALUE_ADDRESS */
550 /* Value is in register. SYMBOL_VALUE is the register number. */
554 /* It's an argument; the value is at SYMBOL_VALUE offset in arglist. */
558 /* Value address is at SYMBOL_VALUE offset in arglist. */
562 /* Value is in register number SYMBOL_VALUE. Just like LOC_REGISTER
563 except this is an argument. Probably the cleaner way to handle
564 this would be to separate address_class (which would include
565 separate ARG and LOCAL to deal with FRAME_ARGS_ADDRESS versus
566 FRAME_LOCALS_ADDRESS), and an is_argument flag.
568 For some symbol formats (stabs, for some compilers at least),
569 the compiler generates two symbols, an argument and a register.
570 In some cases we combine them to a single LOC_REGPARM in symbol
571 reading, but currently not for all cases (e.g. it's passed on the
572 stack and then loaded into a register). */
576 /* Value is in specified register. Just like LOC_REGPARM except the
577 register holds the address of the argument instead of the argument
578 itself. This is currently used for the passing of structs and unions
579 on sparc and hppa. It is also used for call by reference where the
580 address is in a register, at least by mipsread.c. */
584 /* Value is a local variable at SYMBOL_VALUE offset in stack frame. */
588 /* Value not used; definition in SYMBOL_TYPE. Symbols in the namespace
589 STRUCT_NAMESPACE all have this class. */
593 /* Value is address SYMBOL_VALUE_ADDRESS in the code */
597 /* In a symbol table, value is SYMBOL_BLOCK_VALUE of a `struct block'.
598 In a partial symbol table, SYMBOL_VALUE_ADDRESS is the start address
599 of the block. Function names have this class. */
603 /* Value is a constant byte-sequence pointed to by SYMBOL_VALUE_BYTES, in
604 target byte order. */
608 /* Value is arg at SYMBOL_VALUE offset in stack frame. Differs from
609 LOC_LOCAL in that symbol is an argument; differs from LOC_ARG in
610 that we find it in the frame (FRAME_LOCALS_ADDRESS), not in the
611 arglist (FRAME_ARGS_ADDRESS). Added for i960, which passes args
612 in regs then copies to frame. */
616 /* Value is at SYMBOL_VALUE offset from the current value of
617 register number SYMBOL_BASEREG. This exists mainly for the same
618 things that LOC_LOCAL and LOC_ARG do; but we need to do this
619 instead because on 88k DWARF gives us the offset from the
620 frame/stack pointer, rather than the offset from the "canonical
621 frame address" used by COFF, stabs, etc., and we don't know how
622 to convert between these until we start examining prologues.
624 Note that LOC_BASEREG is much less general than a DWARF expression.
625 We don't need the generality (at least not yet), and storing a general
626 DWARF expression would presumably take up more space than the existing
631 /* Same as LOC_BASEREG but it is an argument. */
635 /* Value is at fixed address, but the address of the variable has
636 to be determined from the minimal symbol table whenever the
637 variable is referenced.
638 This happens if debugging information for a global symbol is
639 emitted and the corresponding minimal symbol is defined
640 in another object file or runtime common storage.
641 The linker might even remove the minimal symbol if the global
642 symbol is never referenced, in which case the symbol remains
647 /* Value is at a thread-specific location calculated by a
648 target-specific method. */
650 LOC_THREAD_LOCAL_STATIC
,
652 /* The variable does not actually exist in the program.
653 The value is ignored. */
657 /* The variable is static, but actually lives at * (address).
658 * I.e. do an extra indirection to get to it.
659 * This is used on HP-UX to get at globals that are allocated
660 * in shared libraries, where references from images other
661 * than the one where the global was allocated are done
662 * with a level of indirection.
669 /* Linked list of symbol's live ranges. */
675 struct range_list
*next
;
678 /* Linked list of aliases for a particular main/primary symbol. */
682 struct alias_list
*next
;
688 /* The general symbol info required for all types of symbols. */
690 struct general_symbol_info ginfo
;
692 /* Data type of value */
696 /* Name space code. */
699 /* FIXME: don't conflict with C++'s namespace */
700 /* would be safer to do a global change for all namespace identifiers. */
701 #define namespace _namespace
703 namespace_enum
namespace BYTE_BITFIELD
;
707 enum address_class aclass BYTE_BITFIELD
;
709 /* Line number of definition. FIXME: Should we really make the assumption
710 that nobody will try to debug files longer than 64K lines? What about
711 machine generated programs? */
715 /* Some symbols require an additional value to be recorded on a per-
716 symbol basis. Stash those values here. */
720 /* Used by LOC_BASEREG and LOC_BASEREG_ARG. */
726 /* Link to a list of aliases for this symbol.
727 Only a "primary/main symbol may have aliases. */
728 struct alias_list
*aliases
;
730 /* List of ranges where this symbol is active. This is only
731 used by alias symbols at the current time. */
732 struct range_list
*ranges
;
736 #define SYMBOL_NAMESPACE(symbol) (symbol)->namespace
737 #define SYMBOL_CLASS(symbol) (symbol)->aclass
738 #define SYMBOL_TYPE(symbol) (symbol)->type
739 #define SYMBOL_LINE(symbol) (symbol)->line
740 #define SYMBOL_BASEREG(symbol) (symbol)->aux_value.basereg
741 #define SYMBOL_ALIASES(symbol) (symbol)->aliases
742 #define SYMBOL_RANGES(symbol) (symbol)->ranges
744 /* A partial_symbol records the name, namespace, and address class of
745 symbols whose types we have not parsed yet. For functions, it also
746 contains their memory address, so we can find them from a PC value.
747 Each partial_symbol sits in a partial_symtab, all of which are chained
748 on a partial symtab list and which points to the corresponding
749 normal symtab once the partial_symtab has been referenced. */
751 struct partial_symbol
754 /* The general symbol info required for all types of symbols. */
756 struct general_symbol_info ginfo
;
758 /* Name space code. */
760 namespace_enum
namespace BYTE_BITFIELD
;
762 /* Address class (for info_symbols) */
764 enum address_class aclass BYTE_BITFIELD
;
768 #define PSYMBOL_NAMESPACE(psymbol) (psymbol)->namespace
769 #define PSYMBOL_CLASS(psymbol) (psymbol)->aclass
772 /* Source-file information. This describes the relation between source files,
773 line numbers and addresses in the program text. */
777 int length
; /* Number of source files described */
778 struct source
*source
[1]; /* Descriptions of the files */
781 /* Each item represents a line-->pc (or the reverse) mapping. This is
782 somewhat more wasteful of space than one might wish, but since only
783 the files which are actually debugged are read in to core, we don't
786 struct linetable_entry
792 /* The order of entries in the linetable is significant. They should
793 be sorted by increasing values of the pc field. If there is more than
794 one entry for a given pc, then I'm not sure what should happen (and
795 I not sure whether we currently handle it the best way).
797 Example: a C for statement generally looks like this
799 10 0x100 - for the init/test part of a for stmt.
802 10 0x400 - for the increment part of a for stmt.
810 /* Actually NITEMS elements. If you don't like this use of the
811 `struct hack', you can shove it up your ANSI (seriously, if the
812 committee tells us how to do it, we can probably go along). */
813 struct linetable_entry item
[1];
816 /* All the information on one source file. */
820 char *name
; /* Name of file */
821 struct linetable contents
;
824 /* How to relocate the symbols from each section in a symbol file.
825 Each struct contains an array of offsets.
826 The ordering and meaning of the offsets is file-type-dependent;
827 typically it is indexed by section numbers or symbol types or
830 To give us flexibility in changing the internal representation
831 of these offsets, the ANOFFSET macro must be used to insert and
832 extract offset values in the struct. */
834 struct section_offsets
836 CORE_ADDR offsets
[1]; /* As many as needed. */
839 #define ANOFFSET(secoff, whichone) \
841 ? (internal_error (__FILE__, __LINE__, "Section index is uninitialized"), -1) \
842 : secoff->offsets[whichone])
844 /* The maximum possible size of a section_offsets table. */
846 #define SIZEOF_SECTION_OFFSETS \
847 (sizeof (struct section_offsets) \
848 + sizeof (((struct section_offsets *) 0)->offsets) * (SECT_OFF_MAX-1))
850 /* Each source file or header is represented by a struct symtab.
851 These objects are chained through the `next' field. */
856 /* Chain of all existing symtabs. */
860 /* List of all symbol scope blocks for this symtab. May be shared
861 between different symtabs (and normally is for all the symtabs
862 in a given compilation unit). */
864 struct blockvector
*blockvector
;
866 /* Table mapping core addresses to line numbers for this file.
867 Can be NULL if none. Never shared between different symtabs. */
869 struct linetable
*linetable
;
871 /* Section in objfile->section_offsets for the blockvector and
872 the linetable. Probably always SECT_OFF_TEXT. */
874 int block_line_section
;
876 /* If several symtabs share a blockvector, exactly one of them
877 should be designated the primary, so that the blockvector
878 is relocated exactly once by objfile_relocate. */
882 /* Name of this source file. */
886 /* Directory in which it was compiled, or NULL if we don't know. */
890 /* This component says how to free the data we point to:
891 free_contents => do a tree walk and free each object.
892 free_nothing => do nothing; some other symtab will free
893 the data this one uses.
894 free_linetable => free just the linetable. FIXME: Is this redundant
895 with the primary field? */
899 free_nothing
, free_contents
, free_linetable
903 /* Pointer to one block of storage to be freed, if nonzero. */
904 /* This is IN ADDITION to the action indicated by free_code. */
908 /* Total number of lines found in source file. */
912 /* line_charpos[N] is the position of the (N-1)th line of the
913 source file. "position" means something we can lseek() to; it
914 is not guaranteed to be useful any other way. */
918 /* Language of this source file. */
920 enum language language
;
922 /* String that identifies the format of the debugging information, such
923 as "stabs", "dwarf 1", "dwarf 2", "coff", etc. This is mostly useful
924 for automated testing of gdb but may also be information that is
925 useful to the user. */
929 /* String of version information. May be zero. */
933 /* Full name of file as found by searching the source path.
934 NULL if not yet known. */
938 /* Object file from which this symbol information was read. */
940 struct objfile
*objfile
;
944 #define BLOCKVECTOR(symtab) (symtab)->blockvector
945 #define LINETABLE(symtab) (symtab)->linetable
948 /* Each source file that has not been fully read in is represented by
949 a partial_symtab. This contains the information on where in the
950 executable the debugging symbols for a specific file are, and a
951 list of names of global symbols which are located in this file.
952 They are all chained on partial symtab lists.
954 Even after the source file has been read into a symtab, the
955 partial_symtab remains around. They are allocated on an obstack,
956 psymbol_obstack. FIXME, this is bad for dynamic linking or VxWorks-
957 style execution of a bunch of .o's. */
959 struct partial_symtab
962 /* Chain of all existing partial symtabs. */
964 struct partial_symtab
*next
;
966 /* Name of the source file which this partial_symtab defines */
970 /* Information about the object file from which symbols should be read. */
972 struct objfile
*objfile
;
974 /* Set of relocation offsets to apply to each section. */
976 struct section_offsets
*section_offsets
;
978 /* Range of text addresses covered by this file; texthigh is the
979 beginning of the next section. */
984 /* Array of pointers to all of the partial_symtab's which this one
985 depends on. Since this array can only be set to previous or
986 the current (?) psymtab, this dependency tree is guaranteed not
987 to have any loops. "depends on" means that symbols must be read
988 for the dependencies before being read for this psymtab; this is
989 for type references in stabs, where if foo.c includes foo.h, declarations
990 in foo.h may use type numbers defined in foo.c. For other debugging
991 formats there may be no need to use dependencies. */
993 struct partial_symtab
**dependencies
;
995 int number_of_dependencies
;
997 /* Global symbol list. This list will be sorted after readin to
998 improve access. Binary search will be the usual method of
999 finding a symbol within it. globals_offset is an integer offset
1000 within global_psymbols[]. */
1005 /* Static symbol list. This list will *not* be sorted after readin;
1006 to find a symbol in it, exhaustive search must be used. This is
1007 reasonable because searches through this list will eventually
1008 lead to either the read in of a files symbols for real (assumed
1009 to take a *lot* of time; check) or an error (and we don't care
1010 how long errors take). This is an offset and size within
1011 static_psymbols[]. */
1016 /* Pointer to symtab eventually allocated for this source file, 0 if
1017 !readin or if we haven't looked for the symtab after it was readin. */
1019 struct symtab
*symtab
;
1021 /* Pointer to function which will read in the symtab corresponding to
1024 void (*read_symtab
) (struct partial_symtab
*);
1026 /* Information that lets read_symtab() locate the part of the symbol table
1027 that this psymtab corresponds to. This information is private to the
1028 format-dependent symbol reading routines. For further detail examine
1029 the various symbol reading modules. Should really be (void *) but is
1030 (char *) as with other such gdb variables. (FIXME) */
1032 char *read_symtab_private
;
1034 /* Non-zero if the symtab corresponding to this psymtab has been readin */
1036 unsigned char readin
;
1039 /* A fast way to get from a psymtab to its symtab (after the first time). */
1040 #define PSYMTAB_TO_SYMTAB(pst) \
1041 ((pst) -> symtab != NULL ? (pst) -> symtab : psymtab_to_symtab (pst))
1044 /* The virtual function table is now an array of structures which have the
1045 form { int16 offset, delta; void *pfn; }.
1047 In normal virtual function tables, OFFSET is unused.
1048 DELTA is the amount which is added to the apparent object's base
1049 address in order to point to the actual object to which the
1050 virtual function should be applied.
1051 PFN is a pointer to the virtual function.
1053 Note that this macro is g++ specific (FIXME). */
1055 #define VTBL_FNADDR_OFFSET 2
1057 /* External variables and functions for the objects described above. */
1059 /* This symtab variable specifies the current file for printing source lines */
1061 extern struct symtab
*current_source_symtab
;
1063 /* This is the next line to print for listing source lines. */
1065 extern int current_source_line
;
1067 /* See the comment in symfile.c about how current_objfile is used. */
1069 extern struct objfile
*current_objfile
;
1071 /* True if we are nested inside psymtab_to_symtab. */
1073 extern int currently_reading_symtab
;
1076 extern int demangle
;
1077 extern int asm_demangle
;
1079 /* symtab.c lookup functions */
1081 /* lookup a symbol table by source file name */
1083 extern struct symtab
*lookup_symtab (const char *);
1085 /* lookup a symbol by name (optional block, optional symtab) */
1087 extern struct symbol
*lookup_symbol (const char *, const struct block
*,
1088 const namespace_enum
, int *,
1091 /* lookup a symbol by name, within a specified block */
1093 extern struct symbol
*lookup_block_symbol (const struct block
*, const char *,
1094 const namespace_enum
);
1096 /* lookup a [struct, union, enum] by name, within a specified block */
1098 extern struct type
*lookup_struct (char *, struct block
*);
1100 extern struct type
*lookup_union (char *, struct block
*);
1102 extern struct type
*lookup_enum (char *, struct block
*);
1104 /* lookup the function corresponding to the block */
1106 extern struct symbol
*block_function (struct block
*);
1108 /* from blockframe.c: */
1110 /* lookup the function symbol corresponding to the address */
1112 extern struct symbol
*find_pc_function (CORE_ADDR
);
1114 /* lookup the function corresponding to the address and section */
1116 extern struct symbol
*find_pc_sect_function (CORE_ADDR
, asection
*);
1118 /* lookup function from address, return name, start addr and end addr */
1121 find_pc_partial_function (CORE_ADDR
, char **, CORE_ADDR
*, CORE_ADDR
*);
1123 extern void clear_pc_function_cache (void);
1126 find_pc_sect_partial_function (CORE_ADDR
, asection
*,
1127 char **, CORE_ADDR
*, CORE_ADDR
*);
1129 /* from symtab.c: */
1131 /* lookup partial symbol table by filename */
1133 extern struct partial_symtab
*lookup_partial_symtab (const char *);
1135 /* lookup partial symbol table by address */
1137 extern struct partial_symtab
*find_pc_psymtab (CORE_ADDR
);
1139 /* lookup partial symbol table by address and section */
1141 extern struct partial_symtab
*find_pc_sect_psymtab (CORE_ADDR
, asection
*);
1143 /* lookup full symbol table by address */
1145 extern struct symtab
*find_pc_symtab (CORE_ADDR
);
1147 /* lookup full symbol table by address and section */
1149 extern struct symtab
*find_pc_sect_symtab (CORE_ADDR
, asection
*);
1151 /* lookup partial symbol by address */
1153 extern struct partial_symbol
*find_pc_psymbol (struct partial_symtab
*,
1156 /* lookup partial symbol by address and section */
1158 extern struct partial_symbol
*find_pc_sect_psymbol (struct partial_symtab
*,
1159 CORE_ADDR
, asection
*);
1161 extern int find_pc_line_pc_range (CORE_ADDR
, CORE_ADDR
*, CORE_ADDR
*);
1163 extern int contained_in (struct block
*, struct block
*);
1165 extern void reread_symbols (void);
1167 extern struct type
*lookup_transparent_type (const char *);
1170 /* Macro for name of symbol to indicate a file compiled with gcc. */
1171 #ifndef GCC_COMPILED_FLAG_SYMBOL
1172 #define GCC_COMPILED_FLAG_SYMBOL "gcc_compiled."
1175 /* Macro for name of symbol to indicate a file compiled with gcc2. */
1176 #ifndef GCC2_COMPILED_FLAG_SYMBOL
1177 #define GCC2_COMPILED_FLAG_SYMBOL "gcc2_compiled."
1180 /* Functions for dealing with the minimal symbol table, really a misc
1181 address<->symbol mapping for things we don't have debug symbols for. */
1183 extern void prim_record_minimal_symbol (const char *, CORE_ADDR
,
1184 enum minimal_symbol_type
,
1187 extern struct minimal_symbol
*prim_record_minimal_symbol_and_info
1188 (const char *, CORE_ADDR
,
1189 enum minimal_symbol_type
,
1190 char *info
, int section
, asection
* bfd_section
, struct objfile
*);
1192 #ifdef SOFUN_ADDRESS_MAYBE_MISSING
1193 extern CORE_ADDR
find_stab_function_addr (char *, char *, struct objfile
*);
1196 extern unsigned int msymbol_hash_iw (const char *);
1198 extern unsigned int msymbol_hash (const char *);
1201 add_minsym_to_hash_table (struct minimal_symbol
*sym
,
1202 struct minimal_symbol
**table
);
1204 extern struct minimal_symbol
*lookup_minimal_symbol (const char *,
1208 extern struct minimal_symbol
*lookup_minimal_symbol_text (const char *,
1212 struct minimal_symbol
*lookup_minimal_symbol_solib_trampoline (const char *,
1217 extern struct minimal_symbol
*lookup_minimal_symbol_by_pc (CORE_ADDR
);
1219 extern struct minimal_symbol
*lookup_minimal_symbol_by_pc_section (CORE_ADDR
,
1223 extern struct minimal_symbol
1224 *lookup_solib_trampoline_symbol_by_pc (CORE_ADDR
);
1226 extern CORE_ADDR
find_solib_trampoline_target (CORE_ADDR
);
1228 extern void init_minimal_symbol_collection (void);
1230 extern struct cleanup
*make_cleanup_discard_minimal_symbols (void);
1232 extern void install_minimal_symbols (struct objfile
*);
1234 /* Sort all the minimal symbols in OBJFILE. */
1236 extern void msymbols_sort (struct objfile
*objfile
);
1238 struct symtab_and_line
1240 struct symtab
*symtab
;
1242 /* Line number. Line numbers start at 1 and proceed through symtab->nlines.
1243 0 is never a valid line number; it is used to indicate that line number
1244 information is not available. */
1251 #define INIT_SAL(sal) { \
1252 (sal)->symtab = 0; \
1253 (sal)->section = 0; \
1259 struct symtabs_and_lines
1261 struct symtab_and_line
*sals
;
1267 /* Some types and macros needed for exception catchpoints.
1268 Can't put these in target.h because symtab_and_line isn't
1269 known there. This file will be included by breakpoint.c,
1270 hppa-tdep.c, etc. */
1272 /* Enums for exception-handling support */
1273 enum exception_event_kind
1279 /* Type for returning info about an exception */
1280 struct exception_event_record
1282 enum exception_event_kind kind
;
1283 struct symtab_and_line throw_sal
;
1284 struct symtab_and_line catch_sal
;
1285 /* This may need to be extended in the future, if
1286 some platforms allow reporting more information,
1287 such as point of rethrow, type of exception object,
1288 type expected by catch clause, etc. */
1291 #define CURRENT_EXCEPTION_KIND (current_exception_event->kind)
1292 #define CURRENT_EXCEPTION_CATCH_SAL (current_exception_event->catch_sal)
1293 #define CURRENT_EXCEPTION_CATCH_LINE (current_exception_event->catch_sal.line)
1294 #define CURRENT_EXCEPTION_CATCH_FILE (current_exception_event->catch_sal.symtab->filename)
1295 #define CURRENT_EXCEPTION_CATCH_PC (current_exception_event->catch_sal.pc)
1296 #define CURRENT_EXCEPTION_THROW_SAL (current_exception_event->throw_sal)
1297 #define CURRENT_EXCEPTION_THROW_LINE (current_exception_event->throw_sal.line)
1298 #define CURRENT_EXCEPTION_THROW_FILE (current_exception_event->throw_sal.symtab->filename)
1299 #define CURRENT_EXCEPTION_THROW_PC (current_exception_event->throw_sal.pc)
1302 /* Given a pc value, return line number it is in. Second arg nonzero means
1303 if pc is on the boundary use the previous statement's line number. */
1305 extern struct symtab_and_line
find_pc_line (CORE_ADDR
, int);
1307 /* Same function, but specify a section as well as an address */
1309 extern struct symtab_and_line
find_pc_sect_line (CORE_ADDR
, asection
*, int);
1311 /* Given an address, return the nearest symbol at or below it in memory.
1312 Optionally return the symtab it's from through 2nd arg, and the
1313 address in inferior memory of the symbol through 3rd arg. */
1315 extern struct symbol
*find_addr_symbol (CORE_ADDR
, struct symtab
**,
1318 /* Given a symtab and line number, return the pc there. */
1320 extern int find_line_pc (struct symtab
*, int, CORE_ADDR
*);
1323 find_line_pc_range (struct symtab_and_line
, CORE_ADDR
*, CORE_ADDR
*);
1325 extern void resolve_sal_pc (struct symtab_and_line
*);
1327 /* Given a string, return the line specified by it. For commands like "list"
1328 and "breakpoint". */
1330 extern struct symtabs_and_lines
decode_line_spec (char *, int);
1332 extern struct symtabs_and_lines
decode_line_spec_1 (char *, int);
1336 void maintenance_print_symbols (char *, int);
1338 void maintenance_print_psymbols (char *, int);
1340 void maintenance_print_msymbols (char *, int);
1342 void maintenance_print_objfiles (char *, int);
1344 void maintenance_check_symtabs (char *, int);
1348 void maintenance_print_statistics (char *, int);
1350 extern void free_symtab (struct symtab
*);
1352 /* Symbol-reading stuff in symfile.c and solib.c. */
1354 extern struct symtab
*psymtab_to_symtab (struct partial_symtab
*);
1356 extern void clear_solib (void);
1360 extern int identify_source_line (struct symtab
*, int, int, CORE_ADDR
);
1362 extern void print_source_lines (struct symtab
*, int, int, int);
1364 extern void forget_cached_source_info (void);
1366 extern void select_source_symtab (struct symtab
*);
1368 extern char **make_symbol_completion_list (char *, char *);
1370 extern char **make_file_symbol_completion_list (char *, char *, char *);
1372 extern struct symbol
**make_symbol_overload_list (struct symbol
*);
1374 extern char **make_source_files_completion_list (char *, char *);
1378 extern struct partial_symtab
*find_main_psymtab (void);
1380 extern struct symtab
*find_line_symtab (struct symtab
*, int, int *, int *);
1382 extern struct symtab_and_line
find_function_start_sal (struct symbol
*sym
, int);
1386 extern struct blockvector
*blockvector_for_pc (CORE_ADDR
, int *);
1388 extern struct blockvector
*blockvector_for_pc_sect (CORE_ADDR
, asection
*,
1389 int *, struct symtab
*);
1393 extern void clear_symtab_users (void);
1395 extern enum language
deduce_language_from_filename (char *);
1399 extern int in_prologue (CORE_ADDR pc
, CORE_ADDR func_start
);
1401 extern struct symbol
*fixup_symbol_section (struct symbol
*,
1404 extern struct partial_symbol
*fixup_psymbol_section (struct partial_symbol
1406 struct objfile
*objfile
);
1408 /* Symbol searching */
1410 /* When using search_symbols, a list of the following structs is returned.
1411 Callers must free the search list using free_search_symbols! */
1412 struct symbol_search
1414 /* The block in which the match was found. Could be, for example,
1415 STATIC_BLOCK or GLOBAL_BLOCK. */
1418 /* Information describing what was found.
1420 If symtab abd symbol are NOT NULL, then information was found
1422 struct symtab
*symtab
;
1423 struct symbol
*symbol
;
1425 /* If msymbol is non-null, then a match was made on something for
1426 which only minimal_symbols exist. */
1427 struct minimal_symbol
*msymbol
;
1429 /* A link to the next match, or NULL for the end. */
1430 struct symbol_search
*next
;
1433 extern void search_symbols (char *, namespace_enum
, int, char **,
1434 struct symbol_search
**);
1435 extern void free_search_symbols (struct symbol_search
*);
1436 extern struct cleanup
*make_cleanup_free_search_symbols (struct symbol_search
*);
1438 /* The name of the ``main'' function.
1439 FIXME: cagney/2001-03-20: Can't make main_name() const since some
1440 of the calling code currently assumes that the string isn't
1442 extern void set_main_name (const char *name
);
1443 extern /*const*/ char *main_name (void);
1445 #endif /* !defined(SYMTAB_H) */