1 /* Symbol table definitions for GDB.
2 Copyright 1986, 1988, 1989, 1990, 1991, 1992, 1993, 1994, 1995, 1996,
3 1997, 1998, 1999, 2000, 2001, 2002
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 /* Opaque declarations. */
29 /* Don't do this; it means that if some .o's are compiled with GNU C
30 and some are not (easy to do accidentally the way we configure
31 things; also it is a pain to have to "make clean" every time you
32 want to switch compilers), then GDB dies a horrible death. */
33 /* GNU C supports enums that are bitfields. Some compilers don't. */
34 #if 0 && defined(__GNUC__) && !defined(BYTE_BITFIELD)
35 #define BYTE_BITFIELD :8;
37 #define BYTE_BITFIELD /*nothing */
40 /* Define a structure for the information that is common to all symbol types,
41 including minimal symbols, partial symbols, and full symbols. In a
42 multilanguage environment, some language specific information may need to
43 be recorded along with each symbol.
45 These fields are ordered to encourage good packing, since we frequently
46 have tens or hundreds of thousands of these. */
48 struct general_symbol_info
50 /* Name of the symbol. This is a required field. Storage for the name is
51 allocated on the psymbol_obstack or symbol_obstack for the associated
56 /* Value of the symbol. Which member of this union to use, and what
57 it means, depends on what kind of symbol this is and its
58 SYMBOL_CLASS. See comments there for more details. All of these
59 are in host byte order (though what they point to might be in
60 target byte order, e.g. LOC_CONST_BYTES). */
64 /* The fact that this is a long not a LONGEST mainly limits the
65 range of a LOC_CONST. Since LOC_CONST_BYTES exists, I'm not
66 sure that is a big deal. */
75 /* for opaque typedef struct chain */
81 /* Since one and only one language can apply, wrap the language specific
82 information inside a union. */
86 struct cplus_specific
/* For C++ */
98 /* OBSOLETE struct chill_specific *//* For Chill */
100 /* OBSOLETE char *demangled_name; */
102 /* OBSOLETE chill_specific; */
107 /* Record the source code language that applies to this symbol.
108 This is used to select one of the fields from the language specific
111 enum language language BYTE_BITFIELD
;
113 /* Which section is this symbol in? This is an index into
114 section_offsets for this objfile. Negative means that the symbol
115 does not get relocated relative to a section.
116 Disclaimer: currently this is just used for xcoff, so don't
117 expect all symbol-reading code to set it correctly (the ELF code
118 also tries to set it correctly). */
122 /* The bfd section associated with this symbol. */
124 asection
*bfd_section
;
127 extern CORE_ADDR
symbol_overlayed_address (CORE_ADDR
, asection
*);
129 #define SYMBOL_NAME(symbol) (symbol)->ginfo.name
130 #define SYMBOL_VALUE(symbol) (symbol)->ginfo.value.ivalue
131 #define SYMBOL_VALUE_ADDRESS(symbol) (symbol)->ginfo.value.address
132 #define SYMBOL_VALUE_BYTES(symbol) (symbol)->ginfo.value.bytes
133 #define SYMBOL_BLOCK_VALUE(symbol) (symbol)->ginfo.value.block
134 #define SYMBOL_VALUE_CHAIN(symbol) (symbol)->ginfo.value.chain
135 #define SYMBOL_LANGUAGE(symbol) (symbol)->ginfo.language
136 #define SYMBOL_SECTION(symbol) (symbol)->ginfo.section
137 #define SYMBOL_BFD_SECTION(symbol) (symbol)->ginfo.bfd_section
139 #define SYMBOL_CPLUS_DEMANGLED_NAME(symbol) \
140 (symbol)->ginfo.language_specific.cplus_specific.demangled_name
142 /* Macro that initializes the language dependent portion of a symbol
143 depending upon the language for the symbol. */
145 #define SYMBOL_INIT_LANGUAGE_SPECIFIC(symbol,language) \
147 SYMBOL_LANGUAGE (symbol) = language; \
148 if (SYMBOL_LANGUAGE (symbol) == language_cplus \
149 || SYMBOL_LANGUAGE (symbol) == language_java \
152 SYMBOL_CPLUS_DEMANGLED_NAME (symbol) = NULL; \
154 else if (SYMBOL_LANGUAGE (symbol) == language_objc) \
156 SYMBOL_OBJC_DEMANGLED_NAME (symbol) = NULL; \
158 /* OBSOLETE else if (SYMBOL_LANGUAGE (symbol) == language_chill) */ \
160 /* OBSOLETE SYMBOL_CHILL_DEMANGLED_NAME (symbol) = NULL; */ \
164 memset (&(symbol)->ginfo.language_specific, 0, \
165 sizeof ((symbol)->ginfo.language_specific)); \
169 #define SYMBOL_INIT_DEMANGLED_NAME(symbol,obstack) \
170 (symbol_init_demangled_name (&symbol->ginfo, (obstack)))
171 extern void symbol_init_demangled_name (struct general_symbol_info
*symbol
,
172 struct obstack
*obstack
);
175 /* Macro that returns the demangled name for a symbol based on the language
176 for that symbol. If no demangled name exists, returns NULL. */
178 #define SYMBOL_DEMANGLED_NAME(symbol) \
179 (SYMBOL_LANGUAGE (symbol) == language_cplus \
180 || SYMBOL_LANGUAGE (symbol) == language_java \
181 ? SYMBOL_CPLUS_DEMANGLED_NAME (symbol) \
182 : (SYMBOL_LANGUAGE (symbol) == language_objc \
183 ? SYMBOL_OBJC_DEMANGLED_NAME (symbol) \
184 : /* OBSOLETE (SYMBOL_LANGUAGE (symbol) == language_chill */ \
185 /* OBSOLETE ? SYMBOL_CHILL_DEMANGLED_NAME (symbol) */ \
188 /* OBSOLETE #define SYMBOL_CHILL_DEMANGLED_NAME(symbol) */
189 /* OBSOLETE (symbol)->ginfo.language_specific.chill_specific.demangled_name */
191 #define SYMBOL_OBJC_DEMANGLED_NAME(symbol) \
192 (symbol)->ginfo.language_specific.objc_specific.demangled_name
194 /* Macro that returns the "natural source name" of a symbol. In C++ this is
195 the "demangled" form of the name if demangle is on and the "mangled" form
196 of the name if demangle is off. In other languages this is just the
197 symbol name. The result should never be NULL. */
199 #define SYMBOL_SOURCE_NAME(symbol) \
200 (demangle && SYMBOL_DEMANGLED_NAME (symbol) != NULL \
201 ? SYMBOL_DEMANGLED_NAME (symbol) \
202 : SYMBOL_NAME (symbol))
204 /* Macro that returns the "natural assembly name" of a symbol. In C++ this is
205 the "mangled" form of the name if demangle is off, or if demangle is on and
206 asm_demangle is off. Otherwise if asm_demangle is on it is the "demangled"
207 form. In other languages this is just the symbol name. The result should
210 #define SYMBOL_LINKAGE_NAME(symbol) \
211 (demangle && asm_demangle && SYMBOL_DEMANGLED_NAME (symbol) != NULL \
212 ? SYMBOL_DEMANGLED_NAME (symbol) \
213 : SYMBOL_NAME (symbol))
215 /* Macro that tests a symbol for a match against a specified name string.
216 First test the unencoded name, then looks for and test a C++ encoded
217 name if it exists. Note that whitespace is ignored while attempting to
218 match a C++ encoded name, so that "foo::bar(int,long)" is the same as
219 "foo :: bar (int, long)".
220 Evaluates to zero if the match fails, or nonzero if it succeeds. */
222 #define SYMBOL_MATCHES_NAME(symbol, name) \
223 (STREQ (SYMBOL_NAME (symbol), (name)) \
224 || (SYMBOL_DEMANGLED_NAME (symbol) != NULL \
225 && strcmp_iw (SYMBOL_DEMANGLED_NAME (symbol), (name)) == 0))
227 /* Macro that tests a symbol for an re-match against the last compiled regular
228 expression. First test the unencoded name, then look for and test a C++
229 encoded name if it exists.
230 Evaluates to zero if the match fails, or nonzero if it succeeds. */
232 #define SYMBOL_MATCHES_REGEXP(symbol) \
233 (re_exec (SYMBOL_NAME (symbol)) != 0 \
234 || (SYMBOL_DEMANGLED_NAME (symbol) != NULL \
235 && re_exec (SYMBOL_DEMANGLED_NAME (symbol)) != 0))
237 /* Define a simple structure used to hold some very basic information about
238 all defined global symbols (text, data, bss, abs, etc). The only required
239 information is the general_symbol_info.
241 In many cases, even if a file was compiled with no special options for
242 debugging at all, as long as was not stripped it will contain sufficient
243 information to build a useful minimal symbol table using this structure.
244 Even when a file contains enough debugging information to build a full
245 symbol table, these minimal symbols are still useful for quickly mapping
246 between names and addresses, and vice versa. They are also sometimes
247 used to figure out what full symbol table entries need to be read in. */
249 struct minimal_symbol
252 /* The general symbol info required for all types of symbols.
254 The SYMBOL_VALUE_ADDRESS contains the address that this symbol
257 struct general_symbol_info ginfo
;
259 /* The info field is available for caching machine-specific information
260 so it doesn't have to rederive the info constantly (over a serial line).
261 It is initialized to zero and stays that way until target-dependent code
262 sets it. Storage for any data pointed to by this field should be allo-
263 cated on the symbol_obstack for the associated objfile.
264 The type would be "void *" except for reasons of compatibility with older
265 compilers. This field is optional.
267 Currently, the AMD 29000 tdep.c uses it to remember things it has decoded
268 from the instructions in the function header, and the MIPS-16 code uses
269 it to identify 16-bit procedures. */
273 #ifdef SOFUN_ADDRESS_MAYBE_MISSING
274 /* Which source file is this symbol in? Only relevant for mst_file_*. */
278 /* Classification types for this symbol. These should be taken as "advisory
279 only", since if gdb can't easily figure out a classification it simply
280 selects mst_unknown. It may also have to guess when it can't figure out
281 which is a better match between two types (mst_data versus mst_bss) for
282 example. Since the minimal symbol info is sometimes derived from the
283 BFD library's view of a file, we need to live with what information bfd
286 enum minimal_symbol_type
288 mst_unknown
= 0, /* Unknown type, the default */
289 mst_text
, /* Generally executable instructions */
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 */
310 /* Minimal symbols with the same hash key are kept on a linked
311 list. This is the link. */
313 struct minimal_symbol
*hash_next
;
315 /* Minimal symbols are stored in two different hash tables. This is
316 the `next' pointer for the demangled hash table. */
318 struct minimal_symbol
*demangled_hash_next
;
321 #define MSYMBOL_INFO(msymbol) (msymbol)->info
322 #define MSYMBOL_TYPE(msymbol) (msymbol)->type
326 /* All of the name-scope contours of the program
327 are represented by `struct block' objects.
328 All of these objects are pointed to by the blockvector.
330 Each block represents one name scope.
331 Each lexical context has its own block.
333 The blockvector begins with some special blocks.
334 The GLOBAL_BLOCK contains all the symbols defined in this compilation
335 whose scope is the entire program linked together.
336 The STATIC_BLOCK contains all the symbols whose scope is the
337 entire compilation excluding other separate compilations.
338 Blocks starting with the FIRST_LOCAL_BLOCK are not special.
340 Each block records a range of core addresses for the code that
341 is in the scope of the block. The STATIC_BLOCK and GLOBAL_BLOCK
342 give, for the range of code, the entire range of code produced
343 by the compilation that the symbol segment belongs to.
345 The blocks appear in the blockvector
346 in order of increasing starting-address,
347 and, within that, in order of decreasing ending-address.
349 This implies that within the body of one function
350 the blocks appear in the order of a depth-first tree walk. */
354 /* Number of blocks in the list. */
356 /* The blocks themselves. */
357 struct block
*block
[1];
360 #define BLOCKVECTOR_NBLOCKS(blocklist) (blocklist)->nblocks
361 #define BLOCKVECTOR_BLOCK(blocklist,n) (blocklist)->block[n]
363 /* Special block numbers */
365 #define GLOBAL_BLOCK 0
366 #define STATIC_BLOCK 1
367 #define FIRST_LOCAL_BLOCK 2
372 /* Addresses in the executable code that are in this block. */
377 /* The symbol that names this block, if the block is the body of a
378 function; otherwise, zero. */
380 struct symbol
*function
;
382 /* The `struct block' for the containing block, or 0 if none.
384 The superblock of a top-level local block (i.e. a function in the
385 case of C) is the STATIC_BLOCK. The superblock of the
386 STATIC_BLOCK is the GLOBAL_BLOCK. */
388 struct block
*superblock
;
390 /* Version of GCC used to compile the function corresponding
391 to this block, or 0 if not compiled with GCC. When possible,
392 GCC should be compatible with the native compiler, or if that
393 is not feasible, the differences should be fixed during symbol
394 reading. As of 16 Apr 93, this flag is never used to distinguish
395 between gcc2 and the native compiler.
397 If there is no function corresponding to this block, this meaning
398 of this flag is undefined. */
400 unsigned char gcc_compile_flag
;
402 /* The symbols for this block are either in a simple linear list or
403 in a simple hashtable. Blocks which correspond to a function
404 (which have a list of symbols corresponding to arguments) use
405 a linear list, as do some older symbol readers (currently only
406 mdebugread and dstread). Other blocks are hashed.
408 The hashtable uses the same hash function as the minsym hashtables,
409 found in minsyms.c:minsym_hash_iw. Symbols are hashed based on
410 their demangled name if appropriate, and on their name otherwise.
411 The hash function ignores space, and stops at the beginning of the
412 argument list if any.
414 The table is laid out in NSYMS/5 buckets and symbols are chained via
415 their hash_next field. */
417 /* If this is really a hashtable of the symbols, this flag is 1. */
419 unsigned char hashtable
;
421 /* Number of local symbols. */
425 /* The symbols. If some of them are arguments, then they must be
426 in the order in which we would like to print them. */
428 struct symbol
*sym
[1];
431 #define BLOCK_START(bl) (bl)->startaddr
432 #define BLOCK_END(bl) (bl)->endaddr
433 #define BLOCK_FUNCTION(bl) (bl)->function
434 #define BLOCK_SUPERBLOCK(bl) (bl)->superblock
435 #define BLOCK_GCC_COMPILED(bl) (bl)->gcc_compile_flag
436 #define BLOCK_HASHTABLE(bl) (bl)->hashtable
438 /* For blocks without a hashtable (BLOCK_HASHTABLE (bl) == 0) only. */
439 #define BLOCK_NSYMS(bl) (bl)->nsyms
440 #define BLOCK_SYM(bl, n) (bl)->sym[n]
442 /* For blocks with a hashtable, but these are valid for non-hashed blocks as
443 well - each symbol will appear to be one bucket by itself. */
444 #define BLOCK_BUCKETS(bl) (bl)->nsyms
445 #define BLOCK_BUCKET(bl, n) (bl)->sym[n]
447 /* Macro used to set the size of a hashtable for N symbols. */
448 #define BLOCK_HASHTABLE_SIZE(n) ((n)/5 + 1)
450 /* Macro to loop through all symbols in a block BL, in no particular order.
451 i counts which bucket we are in, and sym points to the current symbol. */
453 #define ALL_BLOCK_SYMBOLS(bl, i, sym) \
454 for ((i) = 0; (i) < BLOCK_BUCKETS ((bl)); (i)++) \
455 for ((sym) = BLOCK_BUCKET ((bl), (i)); (sym); \
456 (sym) = (sym)->hash_next)
458 /* Nonzero if symbols of block BL should be sorted alphabetically.
459 Don't sort a block which corresponds to a function. If we did the
460 sorting would have to preserve the order of the symbols for the
461 arguments. Also don't sort any block that we chose to hash. */
463 #define BLOCK_SHOULD_SORT(bl) (! BLOCK_HASHTABLE (bl) \
464 && BLOCK_FUNCTION (bl) == NULL)
467 /* Represent one symbol name; a variable, constant, function or typedef. */
469 /* Different name spaces for symbols. Looking up a symbol specifies a
470 namespace and ignores symbol definitions in other name spaces. */
474 /* UNDEF_NAMESPACE is used when a namespace has not been discovered or
475 none of the following apply. This usually indicates an error either
476 in the symbol information or in gdb's handling of symbols. */
480 /* VAR_NAMESPACE is the usual namespace. In C, this contains variables,
481 function names, typedef names and enum type values. */
485 /* STRUCT_NAMESPACE is used in C to hold struct, union and enum type names.
486 Thus, if `struct foo' is used in a C program, it produces a symbol named
487 `foo' in the STRUCT_NAMESPACE. */
491 /* LABEL_NAMESPACE may be used for names of labels (for gotos);
492 currently it is not used and labels are not recorded at all. */
496 /* Searching namespaces. These overlap with VAR_NAMESPACE, providing
497 some granularity with the search_symbols function. */
499 /* Everything in VAR_NAMESPACE minus FUNCTIONS_-, TYPES_-, and
503 /* All functions -- for some reason not methods, though. */
506 /* All defined types */
509 /* All class methods -- why is this separated out? */
514 /* An address-class says where to find the value of a symbol. */
518 /* Not used; catches errors */
522 /* Value is constant int SYMBOL_VALUE, host byteorder */
526 /* Value is at fixed address SYMBOL_VALUE_ADDRESS */
530 /* Value is in register. SYMBOL_VALUE is the register number. */
534 /* It's an argument; the value is at SYMBOL_VALUE offset in arglist. */
538 /* Value address is at SYMBOL_VALUE offset in arglist. */
542 /* Value is in register number SYMBOL_VALUE. Just like LOC_REGISTER
543 except this is an argument. Probably the cleaner way to handle
544 this would be to separate address_class (which would include
545 separate ARG and LOCAL to deal with FRAME_ARGS_ADDRESS versus
546 FRAME_LOCALS_ADDRESS), and an is_argument flag.
548 For some symbol formats (stabs, for some compilers at least),
549 the compiler generates two symbols, an argument and a register.
550 In some cases we combine them to a single LOC_REGPARM in symbol
551 reading, but currently not for all cases (e.g. it's passed on the
552 stack and then loaded into a register). */
556 /* Value is in specified register. Just like LOC_REGPARM except the
557 register holds the address of the argument instead of the argument
558 itself. This is currently used for the passing of structs and unions
559 on sparc and hppa. It is also used for call by reference where the
560 address is in a register, at least by mipsread.c. */
564 /* Value is a local variable at SYMBOL_VALUE offset in stack frame. */
568 /* Value not used; definition in SYMBOL_TYPE. Symbols in the namespace
569 STRUCT_NAMESPACE all have this class. */
573 /* Value is address SYMBOL_VALUE_ADDRESS in the code */
577 /* In a symbol table, value is SYMBOL_BLOCK_VALUE of a `struct block'.
578 In a partial symbol table, SYMBOL_VALUE_ADDRESS is the start address
579 of the block. Function names have this class. */
583 /* Value is a constant byte-sequence pointed to by SYMBOL_VALUE_BYTES, in
584 target byte order. */
588 /* Value is arg at SYMBOL_VALUE offset in stack frame. Differs from
589 LOC_LOCAL in that symbol is an argument; differs from LOC_ARG in
590 that we find it in the frame (FRAME_LOCALS_ADDRESS), not in the
591 arglist (FRAME_ARGS_ADDRESS). Added for i960, which passes args
592 in regs then copies to frame. */
596 /* Value is at SYMBOL_VALUE offset from the current value of
597 register number SYMBOL_BASEREG. This exists mainly for the same
598 things that LOC_LOCAL and LOC_ARG do; but we need to do this
599 instead because on 88k DWARF gives us the offset from the
600 frame/stack pointer, rather than the offset from the "canonical
601 frame address" used by COFF, stabs, etc., and we don't know how
602 to convert between these until we start examining prologues.
604 Note that LOC_BASEREG is much less general than a DWARF expression.
605 We don't need the generality (at least not yet), and storing a general
606 DWARF expression would presumably take up more space than the existing
611 /* Same as LOC_BASEREG but it is an argument. */
615 /* Value is at fixed address, but the address of the variable has
616 to be determined from the minimal symbol table whenever the
617 variable is referenced.
618 This happens if debugging information for a global symbol is
619 emitted and the corresponding minimal symbol is defined
620 in another object file or runtime common storage.
621 The linker might even remove the minimal symbol if the global
622 symbol is never referenced, in which case the symbol remains
627 /* Value is at a thread-specific location calculated by a
628 target-specific method. */
630 LOC_THREAD_LOCAL_STATIC
,
632 /* The variable does not actually exist in the program.
633 The value is ignored. */
637 /* The variable is static, but actually lives at * (address).
638 * I.e. do an extra indirection to get to it.
639 * This is used on HP-UX to get at globals that are allocated
640 * in shared libraries, where references from images other
641 * than the one where the global was allocated are done
642 * with a level of indirection.
648 /* Linked list of symbol's live ranges. */
654 struct range_list
*next
;
657 /* Linked list of aliases for a particular main/primary symbol. */
661 struct alias_list
*next
;
667 /* The general symbol info required for all types of symbols. */
669 struct general_symbol_info ginfo
;
671 /* Data type of value */
675 /* Name space code. */
678 /* FIXME: don't conflict with C++'s namespace */
679 /* would be safer to do a global change for all namespace identifiers. */
680 #define namespace _namespace
682 namespace_enum
namespace BYTE_BITFIELD
;
686 enum address_class aclass BYTE_BITFIELD
;
688 /* Line number of definition. FIXME: Should we really make the assumption
689 that nobody will try to debug files longer than 64K lines? What about
690 machine generated programs? */
694 /* Some symbols require an additional value to be recorded on a per-
695 symbol basis. Stash those values here. */
699 /* Used by LOC_BASEREG and LOC_BASEREG_ARG. */
705 /* Link to a list of aliases for this symbol.
706 Only a "primary/main symbol may have aliases. */
707 struct alias_list
*aliases
;
709 /* List of ranges where this symbol is active. This is only
710 used by alias symbols at the current time. */
711 struct range_list
*ranges
;
713 struct symbol
*hash_next
;
717 #define SYMBOL_NAMESPACE(symbol) (symbol)->namespace
718 #define SYMBOL_CLASS(symbol) (symbol)->aclass
719 #define SYMBOL_TYPE(symbol) (symbol)->type
720 #define SYMBOL_LINE(symbol) (symbol)->line
721 #define SYMBOL_BASEREG(symbol) (symbol)->aux_value.basereg
722 #define SYMBOL_ALIASES(symbol) (symbol)->aliases
723 #define SYMBOL_RANGES(symbol) (symbol)->ranges
725 /* A partial_symbol records the name, namespace, and address class of
726 symbols whose types we have not parsed yet. For functions, it also
727 contains their memory address, so we can find them from a PC value.
728 Each partial_symbol sits in a partial_symtab, all of which are chained
729 on a partial symtab list and which points to the corresponding
730 normal symtab once the partial_symtab has been referenced. */
732 struct partial_symbol
735 /* The general symbol info required for all types of symbols. */
737 struct general_symbol_info ginfo
;
739 /* Name space code. */
741 namespace_enum
namespace BYTE_BITFIELD
;
743 /* Address class (for info_symbols) */
745 enum address_class aclass BYTE_BITFIELD
;
749 #define PSYMBOL_NAMESPACE(psymbol) (psymbol)->namespace
750 #define PSYMBOL_CLASS(psymbol) (psymbol)->aclass
753 /* Source-file information. This describes the relation between source files,
754 line numbers and addresses in the program text. */
758 int length
; /* Number of source files described */
759 struct source
*source
[1]; /* Descriptions of the files */
762 /* Each item represents a line-->pc (or the reverse) mapping. This is
763 somewhat more wasteful of space than one might wish, but since only
764 the files which are actually debugged are read in to core, we don't
767 struct linetable_entry
773 /* The order of entries in the linetable is significant. They should
774 be sorted by increasing values of the pc field. If there is more than
775 one entry for a given pc, then I'm not sure what should happen (and
776 I not sure whether we currently handle it the best way).
778 Example: a C for statement generally looks like this
780 10 0x100 - for the init/test part of a for stmt.
783 10 0x400 - for the increment part of a for stmt.
785 If an entry has a line number of zero, it marks the start of a PC
786 range for which no line number information is available. It is
787 acceptable, though wasteful of table space, for such a range to be
794 /* Actually NITEMS elements. If you don't like this use of the
795 `struct hack', you can shove it up your ANSI (seriously, if the
796 committee tells us how to do it, we can probably go along). */
797 struct linetable_entry item
[1];
800 /* All the information on one source file. */
804 char *name
; /* Name of file */
805 struct linetable contents
;
808 /* How to relocate the symbols from each section in a symbol file.
809 Each struct contains an array of offsets.
810 The ordering and meaning of the offsets is file-type-dependent;
811 typically it is indexed by section numbers or symbol types or
814 To give us flexibility in changing the internal representation
815 of these offsets, the ANOFFSET macro must be used to insert and
816 extract offset values in the struct. */
818 struct section_offsets
820 CORE_ADDR offsets
[1]; /* As many as needed. */
823 #define ANOFFSET(secoff, whichone) \
825 ? (internal_error (__FILE__, __LINE__, "Section index is uninitialized"), -1) \
826 : secoff->offsets[whichone])
828 /* The maximum possible size of a section_offsets table. */
830 #define SIZEOF_SECTION_OFFSETS \
831 (sizeof (struct section_offsets) \
832 + sizeof (((struct section_offsets *) 0)->offsets) * (SECT_OFF_MAX-1))
834 /* Each source file or header is represented by a struct symtab.
835 These objects are chained through the `next' field. */
840 /* Chain of all existing symtabs. */
844 /* List of all symbol scope blocks for this symtab. May be shared
845 between different symtabs (and normally is for all the symtabs
846 in a given compilation unit). */
848 struct blockvector
*blockvector
;
850 /* Table mapping core addresses to line numbers for this file.
851 Can be NULL if none. Never shared between different symtabs. */
853 struct linetable
*linetable
;
855 /* Section in objfile->section_offsets for the blockvector and
856 the linetable. Probably always SECT_OFF_TEXT. */
858 int block_line_section
;
860 /* If several symtabs share a blockvector, exactly one of them
861 should be designated the primary, so that the blockvector
862 is relocated exactly once by objfile_relocate. */
866 /* The macro table for this symtab. Like the blockvector, this
867 may be shared between different symtabs --- and normally is for
868 all the symtabs in a given compilation unit. */
869 struct macro_table
*macro_table
;
871 /* Name of this source file. */
875 /* Directory in which it was compiled, or NULL if we don't know. */
879 /* This component says how to free the data we point to:
880 free_contents => do a tree walk and free each object.
881 free_nothing => do nothing; some other symtab will free
882 the data this one uses.
883 free_linetable => free just the linetable. FIXME: Is this redundant
884 with the primary field? */
888 free_nothing
, free_contents
, free_linetable
892 /* Pointer to one block of storage to be freed, if nonzero. */
893 /* This is IN ADDITION to the action indicated by free_code. */
897 /* Total number of lines found in source file. */
901 /* line_charpos[N] is the position of the (N-1)th line of the
902 source file. "position" means something we can lseek() to; it
903 is not guaranteed to be useful any other way. */
907 /* Language of this source file. */
909 enum language language
;
911 /* String that identifies the format of the debugging information, such
912 as "stabs", "dwarf 1", "dwarf 2", "coff", etc. This is mostly useful
913 for automated testing of gdb but may also be information that is
914 useful to the user. */
918 /* String of version information. May be zero. */
922 /* Full name of file as found by searching the source path.
923 NULL if not yet known. */
927 /* Object file from which this symbol information was read. */
929 struct objfile
*objfile
;
933 #define BLOCKVECTOR(symtab) (symtab)->blockvector
934 #define LINETABLE(symtab) (symtab)->linetable
937 /* Each source file that has not been fully read in is represented by
938 a partial_symtab. This contains the information on where in the
939 executable the debugging symbols for a specific file are, and a
940 list of names of global symbols which are located in this file.
941 They are all chained on partial symtab lists.
943 Even after the source file has been read into a symtab, the
944 partial_symtab remains around. They are allocated on an obstack,
945 psymbol_obstack. FIXME, this is bad for dynamic linking or VxWorks-
946 style execution of a bunch of .o's. */
948 struct partial_symtab
951 /* Chain of all existing partial symtabs. */
953 struct partial_symtab
*next
;
955 /* Name of the source file which this partial_symtab defines */
959 /* Full path of the source file. NULL if not known. */
963 /* Information about the object file from which symbols should be read. */
965 struct objfile
*objfile
;
967 /* Set of relocation offsets to apply to each section. */
969 struct section_offsets
*section_offsets
;
971 /* Range of text addresses covered by this file; texthigh is the
972 beginning of the next section. */
977 /* Array of pointers to all of the partial_symtab's which this one
978 depends on. Since this array can only be set to previous or
979 the current (?) psymtab, this dependency tree is guaranteed not
980 to have any loops. "depends on" means that symbols must be read
981 for the dependencies before being read for this psymtab; this is
982 for type references in stabs, where if foo.c includes foo.h, declarations
983 in foo.h may use type numbers defined in foo.c. For other debugging
984 formats there may be no need to use dependencies. */
986 struct partial_symtab
**dependencies
;
988 int number_of_dependencies
;
990 /* Global symbol list. This list will be sorted after readin to
991 improve access. Binary search will be the usual method of
992 finding a symbol within it. globals_offset is an integer offset
993 within global_psymbols[]. */
998 /* Static symbol list. This list will *not* be sorted after readin;
999 to find a symbol in it, exhaustive search must be used. This is
1000 reasonable because searches through this list will eventually
1001 lead to either the read in of a files symbols for real (assumed
1002 to take a *lot* of time; check) or an error (and we don't care
1003 how long errors take). This is an offset and size within
1004 static_psymbols[]. */
1009 /* Pointer to symtab eventually allocated for this source file, 0 if
1010 !readin or if we haven't looked for the symtab after it was readin. */
1012 struct symtab
*symtab
;
1014 /* Pointer to function which will read in the symtab corresponding to
1017 void (*read_symtab
) (struct partial_symtab
*);
1019 /* Information that lets read_symtab() locate the part of the symbol table
1020 that this psymtab corresponds to. This information is private to the
1021 format-dependent symbol reading routines. For further detail examine
1022 the various symbol reading modules. Should really be (void *) but is
1023 (char *) as with other such gdb variables. (FIXME) */
1025 char *read_symtab_private
;
1027 /* Non-zero if the symtab corresponding to this psymtab has been readin */
1029 unsigned char readin
;
1032 /* A fast way to get from a psymtab to its symtab (after the first time). */
1033 #define PSYMTAB_TO_SYMTAB(pst) \
1034 ((pst) -> symtab != NULL ? (pst) -> symtab : psymtab_to_symtab (pst))
1037 /* The virtual function table is now an array of structures which have the
1038 form { int16 offset, delta; void *pfn; }.
1040 In normal virtual function tables, OFFSET is unused.
1041 DELTA is the amount which is added to the apparent object's base
1042 address in order to point to the actual object to which the
1043 virtual function should be applied.
1044 PFN is a pointer to the virtual function.
1046 Note that this macro is g++ specific (FIXME). */
1048 #define VTBL_FNADDR_OFFSET 2
1050 /* External variables and functions for the objects described above. */
1052 /* See the comment in symfile.c about how current_objfile is used. */
1054 extern struct objfile
*current_objfile
;
1056 /* True if we are nested inside psymtab_to_symtab. */
1058 extern int currently_reading_symtab
;
1061 extern int demangle
;
1062 extern int asm_demangle
;
1064 /* symtab.c lookup functions */
1066 /* lookup a symbol table by source file name */
1068 extern struct symtab
*lookup_symtab (const char *);
1070 /* lookup a symbol by name (optional block, optional symtab) */
1072 extern struct symbol
*lookup_symbol (const char *, const struct block
*,
1073 const namespace_enum
, int *,
1076 /* lookup a symbol by name, within a specified block */
1078 extern struct symbol
*lookup_block_symbol (const struct block
*, const char *,
1080 const namespace_enum
);
1082 /* lookup a [struct, union, enum] by name, within a specified block */
1084 extern struct type
*lookup_struct (char *, struct block
*);
1086 extern struct type
*lookup_union (char *, struct block
*);
1088 extern struct type
*lookup_enum (char *, struct block
*);
1090 /* lookup the function corresponding to the block */
1092 extern struct symbol
*block_function (struct block
*);
1094 /* from blockframe.c: */
1096 /* lookup the function symbol corresponding to the address */
1098 extern struct symbol
*find_pc_function (CORE_ADDR
);
1100 /* lookup the function corresponding to the address and section */
1102 extern struct symbol
*find_pc_sect_function (CORE_ADDR
, asection
*);
1104 /* lookup function from address, return name, start addr and end addr */
1107 find_pc_partial_function (CORE_ADDR
, char **, CORE_ADDR
*, CORE_ADDR
*);
1109 extern void clear_pc_function_cache (void);
1111 extern int find_pc_sect_partial_function (CORE_ADDR
, asection
*,
1112 char **, CORE_ADDR
*, CORE_ADDR
*);
1114 /* from symtab.c: */
1116 /* lookup partial symbol table by filename */
1118 extern struct partial_symtab
*lookup_partial_symtab (const char *);
1120 /* lookup partial symbol table by address */
1122 extern struct partial_symtab
*find_pc_psymtab (CORE_ADDR
);
1124 /* lookup partial symbol table by address and section */
1126 extern struct partial_symtab
*find_pc_sect_psymtab (CORE_ADDR
, asection
*);
1128 /* lookup full symbol table by address */
1130 extern struct symtab
*find_pc_symtab (CORE_ADDR
);
1132 /* lookup full symbol table by address and section */
1134 extern struct symtab
*find_pc_sect_symtab (CORE_ADDR
, asection
*);
1136 /* lookup partial symbol by address */
1138 extern struct partial_symbol
*find_pc_psymbol (struct partial_symtab
*,
1141 /* lookup partial symbol by address and section */
1143 extern struct partial_symbol
*find_pc_sect_psymbol (struct partial_symtab
*,
1144 CORE_ADDR
, asection
*);
1146 extern int find_pc_line_pc_range (CORE_ADDR
, CORE_ADDR
*, CORE_ADDR
*);
1148 extern int contained_in (struct block
*, struct block
*);
1150 extern void reread_symbols (void);
1152 extern struct type
*lookup_transparent_type (const char *);
1155 /* Macro for name of symbol to indicate a file compiled with gcc. */
1156 #ifndef GCC_COMPILED_FLAG_SYMBOL
1157 #define GCC_COMPILED_FLAG_SYMBOL "gcc_compiled."
1160 /* Macro for name of symbol to indicate a file compiled with gcc2. */
1161 #ifndef GCC2_COMPILED_FLAG_SYMBOL
1162 #define GCC2_COMPILED_FLAG_SYMBOL "gcc2_compiled."
1165 /* Functions for dealing with the minimal symbol table, really a misc
1166 address<->symbol mapping for things we don't have debug symbols for. */
1168 extern void prim_record_minimal_symbol (const char *, CORE_ADDR
,
1169 enum minimal_symbol_type
,
1172 extern struct minimal_symbol
*prim_record_minimal_symbol_and_info
1173 (const char *, CORE_ADDR
,
1174 enum minimal_symbol_type
,
1175 char *info
, int section
, asection
* bfd_section
, struct objfile
*);
1177 extern unsigned int msymbol_hash_iw (const char *);
1179 extern unsigned int msymbol_hash (const char *);
1182 add_minsym_to_hash_table (struct minimal_symbol
*sym
,
1183 struct minimal_symbol
**table
);
1185 extern struct minimal_symbol
*lookup_minimal_symbol (const char *,
1189 extern struct minimal_symbol
*lookup_minimal_symbol_text (const char *,
1193 struct minimal_symbol
*lookup_minimal_symbol_solib_trampoline (const char *,
1198 extern struct minimal_symbol
*lookup_minimal_symbol_by_pc (CORE_ADDR
);
1200 extern struct minimal_symbol
*lookup_minimal_symbol_by_pc_section (CORE_ADDR
,
1204 extern struct minimal_symbol
1205 *lookup_solib_trampoline_symbol_by_pc (CORE_ADDR
);
1207 extern CORE_ADDR
find_solib_trampoline_target (CORE_ADDR
);
1209 extern void init_minimal_symbol_collection (void);
1211 extern struct cleanup
*make_cleanup_discard_minimal_symbols (void);
1213 extern void install_minimal_symbols (struct objfile
*);
1215 /* Sort all the minimal symbols in OBJFILE. */
1217 extern void msymbols_sort (struct objfile
*objfile
);
1219 struct symtab_and_line
1221 struct symtab
*symtab
;
1223 /* Line number. Line numbers start at 1 and proceed through symtab->nlines.
1224 0 is never a valid line number; it is used to indicate that line number
1225 information is not available. */
1232 #define INIT_SAL(sal) { \
1233 (sal)->symtab = 0; \
1234 (sal)->section = 0; \
1240 struct symtabs_and_lines
1242 struct symtab_and_line
*sals
;
1248 /* Some types and macros needed for exception catchpoints.
1249 Can't put these in target.h because symtab_and_line isn't
1250 known there. This file will be included by breakpoint.c,
1251 hppa-tdep.c, etc. */
1253 /* Enums for exception-handling support */
1254 enum exception_event_kind
1260 /* Type for returning info about an exception */
1261 struct exception_event_record
1263 enum exception_event_kind kind
;
1264 struct symtab_and_line throw_sal
;
1265 struct symtab_and_line catch_sal
;
1266 /* This may need to be extended in the future, if
1267 some platforms allow reporting more information,
1268 such as point of rethrow, type of exception object,
1269 type expected by catch clause, etc. */
1272 #define CURRENT_EXCEPTION_KIND (current_exception_event->kind)
1273 #define CURRENT_EXCEPTION_CATCH_SAL (current_exception_event->catch_sal)
1274 #define CURRENT_EXCEPTION_CATCH_LINE (current_exception_event->catch_sal.line)
1275 #define CURRENT_EXCEPTION_CATCH_FILE (current_exception_event->catch_sal.symtab->filename)
1276 #define CURRENT_EXCEPTION_CATCH_PC (current_exception_event->catch_sal.pc)
1277 #define CURRENT_EXCEPTION_THROW_SAL (current_exception_event->throw_sal)
1278 #define CURRENT_EXCEPTION_THROW_LINE (current_exception_event->throw_sal.line)
1279 #define CURRENT_EXCEPTION_THROW_FILE (current_exception_event->throw_sal.symtab->filename)
1280 #define CURRENT_EXCEPTION_THROW_PC (current_exception_event->throw_sal.pc)
1283 /* Given a pc value, return line number it is in. Second arg nonzero means
1284 if pc is on the boundary use the previous statement's line number. */
1286 extern struct symtab_and_line
find_pc_line (CORE_ADDR
, int);
1288 /* Same function, but specify a section as well as an address */
1290 extern struct symtab_and_line
find_pc_sect_line (CORE_ADDR
, asection
*, int);
1292 /* Given an address, return the nearest symbol at or below it in memory.
1293 Optionally return the symtab it's from through 2nd arg, and the
1294 address in inferior memory of the symbol through 3rd arg. */
1296 extern struct symbol
*find_addr_symbol (CORE_ADDR
, struct symtab
**,
1299 /* Given a symtab and line number, return the pc there. */
1301 extern int find_line_pc (struct symtab
*, int, CORE_ADDR
*);
1304 find_line_pc_range (struct symtab_and_line
, CORE_ADDR
*, CORE_ADDR
*);
1306 extern void resolve_sal_pc (struct symtab_and_line
*);
1308 /* Given a string, return the line specified by it. For commands like "list"
1309 and "breakpoint". */
1311 extern struct symtabs_and_lines
decode_line_spec (char *, int);
1313 extern struct symtabs_and_lines
decode_line_spec_1 (char *, int);
1317 void maintenance_print_symbols (char *, int);
1319 void maintenance_print_psymbols (char *, int);
1321 void maintenance_print_msymbols (char *, int);
1323 void maintenance_print_objfiles (char *, int);
1325 void maintenance_check_symtabs (char *, int);
1329 void maintenance_print_statistics (char *, int);
1331 extern void free_symtab (struct symtab
*);
1333 /* Symbol-reading stuff in symfile.c and solib.c. */
1335 extern struct symtab
*psymtab_to_symtab (struct partial_symtab
*);
1337 extern void clear_solib (void);
1341 extern int identify_source_line (struct symtab
*, int, int, CORE_ADDR
);
1343 extern void print_source_lines (struct symtab
*, int, int, int);
1345 extern void forget_cached_source_info (void);
1347 extern void select_source_symtab (struct symtab
*);
1349 extern char **make_symbol_completion_list (char *, char *);
1351 extern char **make_file_symbol_completion_list (char *, char *, char *);
1353 extern struct symbol
**make_symbol_overload_list (struct symbol
*);
1355 extern char **make_source_files_completion_list (char *, char *);
1359 extern struct partial_symtab
*find_main_psymtab (void);
1361 extern struct symtab
*find_line_symtab (struct symtab
*, int, int *, int *);
1363 extern struct symtab_and_line
find_function_start_sal (struct symbol
*sym
,
1368 extern struct blockvector
*blockvector_for_pc (CORE_ADDR
, int *);
1370 extern struct blockvector
*blockvector_for_pc_sect (CORE_ADDR
, asection
*,
1371 int *, struct symtab
*);
1375 extern void clear_symtab_users (void);
1377 extern enum language
deduce_language_from_filename (char *);
1381 extern int in_prologue (CORE_ADDR pc
, CORE_ADDR func_start
);
1383 extern struct symbol
*fixup_symbol_section (struct symbol
*,
1386 extern struct partial_symbol
*fixup_psymbol_section (struct partial_symbol
1388 struct objfile
*objfile
);
1390 /* Symbol searching */
1392 /* When using search_symbols, a list of the following structs is returned.
1393 Callers must free the search list using free_search_symbols! */
1394 struct symbol_search
1396 /* The block in which the match was found. Could be, for example,
1397 STATIC_BLOCK or GLOBAL_BLOCK. */
1400 /* Information describing what was found.
1402 If symtab abd symbol are NOT NULL, then information was found
1404 struct symtab
*symtab
;
1405 struct symbol
*symbol
;
1407 /* If msymbol is non-null, then a match was made on something for
1408 which only minimal_symbols exist. */
1409 struct minimal_symbol
*msymbol
;
1411 /* A link to the next match, or NULL for the end. */
1412 struct symbol_search
*next
;
1415 extern void search_symbols (char *, namespace_enum
, int, char **,
1416 struct symbol_search
**);
1417 extern void free_search_symbols (struct symbol_search
*);
1418 extern struct cleanup
*make_cleanup_free_search_symbols (struct symbol_search
1421 /* The name of the ``main'' function.
1422 FIXME: cagney/2001-03-20: Can't make main_name() const since some
1423 of the calling code currently assumes that the string isn't
1425 extern void set_main_name (const char *name
);
1426 extern /*const */ char *main_name (void);
1428 #endif /* !defined(SYMTAB_H) */