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++ */
93 /* OBSOLETE struct chill_specific *//* For Chill */
95 /* OBSOLETE char *demangled_name; */
97 /* OBSOLETE chill_specific; */
102 /* Record the source code language that applies to this symbol.
103 This is used to select one of the fields from the language specific
106 enum language language BYTE_BITFIELD
;
108 /* Which section is this symbol in? This is an index into
109 section_offsets for this objfile. Negative means that the symbol
110 does not get relocated relative to a section.
111 Disclaimer: currently this is just used for xcoff, so don't
112 expect all symbol-reading code to set it correctly (the ELF code
113 also tries to set it correctly). */
117 /* The bfd section associated with this symbol. */
119 asection
*bfd_section
;
122 extern CORE_ADDR
symbol_overlayed_address (CORE_ADDR
, asection
*);
124 #define SYMBOL_NAME(symbol) (symbol)->ginfo.name
125 #define SYMBOL_VALUE(symbol) (symbol)->ginfo.value.ivalue
126 #define SYMBOL_VALUE_ADDRESS(symbol) (symbol)->ginfo.value.address
127 #define SYMBOL_VALUE_BYTES(symbol) (symbol)->ginfo.value.bytes
128 #define SYMBOL_BLOCK_VALUE(symbol) (symbol)->ginfo.value.block
129 #define SYMBOL_VALUE_CHAIN(symbol) (symbol)->ginfo.value.chain
130 #define SYMBOL_LANGUAGE(symbol) (symbol)->ginfo.language
131 #define SYMBOL_SECTION(symbol) (symbol)->ginfo.section
132 #define SYMBOL_BFD_SECTION(symbol) (symbol)->ginfo.bfd_section
134 #define SYMBOL_CPLUS_DEMANGLED_NAME(symbol) \
135 (symbol)->ginfo.language_specific.cplus_specific.demangled_name
137 /* Macro that initializes the language dependent portion of a symbol
138 depending upon the language for the symbol. */
140 #define SYMBOL_INIT_LANGUAGE_SPECIFIC(symbol,language) \
142 SYMBOL_LANGUAGE (symbol) = language; \
143 if (SYMBOL_LANGUAGE (symbol) == language_cplus \
144 || SYMBOL_LANGUAGE (symbol) == language_java \
147 SYMBOL_CPLUS_DEMANGLED_NAME (symbol) = NULL; \
149 /* OBSOLETE else if (SYMBOL_LANGUAGE (symbol) == language_chill) */ \
151 /* OBSOLETE SYMBOL_CHILL_DEMANGLED_NAME (symbol) = NULL; */ \
155 memset (&(symbol)->ginfo.language_specific, 0, \
156 sizeof ((symbol)->ginfo.language_specific)); \
160 #define SYMBOL_INIT_DEMANGLED_NAME(symbol,obstack) \
161 (symbol_init_demangled_name (&symbol->ginfo, (obstack)))
162 extern void symbol_init_demangled_name (struct general_symbol_info
*symbol
,
163 struct obstack
*obstack
);
166 /* Macro that returns the demangled name for a symbol based on the language
167 for that symbol. If no demangled name exists, returns NULL. */
169 #define SYMBOL_DEMANGLED_NAME(symbol) \
170 (SYMBOL_LANGUAGE (symbol) == language_cplus \
171 || SYMBOL_LANGUAGE (symbol) == language_java \
172 ? SYMBOL_CPLUS_DEMANGLED_NAME (symbol) \
173 : /* OBSOLETE (SYMBOL_LANGUAGE (symbol) == language_chill */ \
174 /* OBSOLETE ? SYMBOL_CHILL_DEMANGLED_NAME (symbol) */ \
177 /* OBSOLETE #define SYMBOL_CHILL_DEMANGLED_NAME(symbol) */
178 /* OBSOLETE (symbol)->ginfo.language_specific.chill_specific.demangled_name */
180 /* Macro that returns the "natural source name" of a symbol. In C++ this is
181 the "demangled" form of the name if demangle is on and the "mangled" form
182 of the name if demangle is off. In other languages this is just the
183 symbol name. The result should never be NULL. */
185 #define SYMBOL_SOURCE_NAME(symbol) \
186 (demangle && SYMBOL_DEMANGLED_NAME (symbol) != NULL \
187 ? SYMBOL_DEMANGLED_NAME (symbol) \
188 : SYMBOL_NAME (symbol))
190 /* Macro that returns the "natural assembly name" of a symbol. In C++ this is
191 the "mangled" form of the name if demangle is off, or if demangle is on and
192 asm_demangle is off. Otherwise if asm_demangle is on it is the "demangled"
193 form. In other languages this is just the symbol name. The result should
196 #define SYMBOL_LINKAGE_NAME(symbol) \
197 (demangle && asm_demangle && SYMBOL_DEMANGLED_NAME (symbol) != NULL \
198 ? SYMBOL_DEMANGLED_NAME (symbol) \
199 : SYMBOL_NAME (symbol))
201 /* Macro that tests a symbol for a match against a specified name string.
202 First test the unencoded name, then looks for and test a C++ encoded
203 name if it exists. Note that whitespace is ignored while attempting to
204 match a C++ encoded name, so that "foo::bar(int,long)" is the same as
205 "foo :: bar (int, long)".
206 Evaluates to zero if the match fails, or nonzero if it succeeds. */
208 #define SYMBOL_MATCHES_NAME(symbol, name) \
209 (STREQ (SYMBOL_NAME (symbol), (name)) \
210 || (SYMBOL_DEMANGLED_NAME (symbol) != NULL \
211 && strcmp_iw (SYMBOL_DEMANGLED_NAME (symbol), (name)) == 0))
213 /* Macro that tests a symbol for an re-match against the last compiled regular
214 expression. First test the unencoded name, then look for and test a C++
215 encoded name if it exists.
216 Evaluates to zero if the match fails, or nonzero if it succeeds. */
218 #define SYMBOL_MATCHES_REGEXP(symbol) \
219 (re_exec (SYMBOL_NAME (symbol)) != 0 \
220 || (SYMBOL_DEMANGLED_NAME (symbol) != NULL \
221 && re_exec (SYMBOL_DEMANGLED_NAME (symbol)) != 0))
223 /* Define a simple structure used to hold some very basic information about
224 all defined global symbols (text, data, bss, abs, etc). The only required
225 information is the general_symbol_info.
227 In many cases, even if a file was compiled with no special options for
228 debugging at all, as long as was not stripped it will contain sufficient
229 information to build a useful minimal symbol table using this structure.
230 Even when a file contains enough debugging information to build a full
231 symbol table, these minimal symbols are still useful for quickly mapping
232 between names and addresses, and vice versa. They are also sometimes
233 used to figure out what full symbol table entries need to be read in. */
235 struct minimal_symbol
238 /* The general symbol info required for all types of symbols.
240 The SYMBOL_VALUE_ADDRESS contains the address that this symbol
243 struct general_symbol_info ginfo
;
245 /* The info field is available for caching machine-specific information
246 so it doesn't have to rederive the info constantly (over a serial line).
247 It is initialized to zero and stays that way until target-dependent code
248 sets it. Storage for any data pointed to by this field should be allo-
249 cated on the symbol_obstack for the associated objfile.
250 The type would be "void *" except for reasons of compatibility with older
251 compilers. This field is optional.
253 Currently, the AMD 29000 tdep.c uses it to remember things it has decoded
254 from the instructions in the function header, and the MIPS-16 code uses
255 it to identify 16-bit procedures. */
259 #ifdef SOFUN_ADDRESS_MAYBE_MISSING
260 /* Which source file is this symbol in? Only relevant for mst_file_*. */
264 /* Classification types for this symbol. These should be taken as "advisory
265 only", since if gdb can't easily figure out a classification it simply
266 selects mst_unknown. It may also have to guess when it can't figure out
267 which is a better match between two types (mst_data versus mst_bss) for
268 example. Since the minimal symbol info is sometimes derived from the
269 BFD library's view of a file, we need to live with what information bfd
272 enum minimal_symbol_type
274 mst_unknown
= 0, /* Unknown type, the default */
275 mst_text
, /* Generally executable instructions */
276 mst_data
, /* Generally initialized data */
277 mst_bss
, /* Generally uninitialized data */
278 mst_abs
, /* Generally absolute (nonrelocatable) */
279 /* GDB uses mst_solib_trampoline for the start address of a shared
280 library trampoline entry. Breakpoints for shared library functions
281 are put there if the shared library is not yet loaded.
282 After the shared library is loaded, lookup_minimal_symbol will
283 prefer the minimal symbol from the shared library (usually
284 a mst_text symbol) over the mst_solib_trampoline symbol, and the
285 breakpoints will be moved to their true address in the shared
286 library via breakpoint_re_set. */
287 mst_solib_trampoline
, /* Shared library trampoline code */
288 /* For the mst_file* types, the names are only guaranteed to be unique
289 within a given .o file. */
290 mst_file_text
, /* Static version of mst_text */
291 mst_file_data
, /* Static version of mst_data */
292 mst_file_bss
/* Static version of mst_bss */
296 /* Minimal symbols with the same hash key are kept on a linked
297 list. This is the link. */
299 struct minimal_symbol
*hash_next
;
301 /* Minimal symbols are stored in two different hash tables. This is
302 the `next' pointer for the demangled hash table. */
304 struct minimal_symbol
*demangled_hash_next
;
307 #define MSYMBOL_INFO(msymbol) (msymbol)->info
308 #define MSYMBOL_TYPE(msymbol) (msymbol)->type
312 /* All of the name-scope contours of the program
313 are represented by `struct block' objects.
314 All of these objects are pointed to by the blockvector.
316 Each block represents one name scope.
317 Each lexical context has its own block.
319 The blockvector begins with some special blocks.
320 The GLOBAL_BLOCK contains all the symbols defined in this compilation
321 whose scope is the entire program linked together.
322 The STATIC_BLOCK contains all the symbols whose scope is the
323 entire compilation excluding other separate compilations.
324 Blocks starting with the FIRST_LOCAL_BLOCK are not special.
326 Each block records a range of core addresses for the code that
327 is in the scope of the block. The STATIC_BLOCK and GLOBAL_BLOCK
328 give, for the range of code, the entire range of code produced
329 by the compilation that the symbol segment belongs to.
331 The blocks appear in the blockvector
332 in order of increasing starting-address,
333 and, within that, in order of decreasing ending-address.
335 This implies that within the body of one function
336 the blocks appear in the order of a depth-first tree walk. */
340 /* Number of blocks in the list. */
342 /* The blocks themselves. */
343 struct block
*block
[1];
346 #define BLOCKVECTOR_NBLOCKS(blocklist) (blocklist)->nblocks
347 #define BLOCKVECTOR_BLOCK(blocklist,n) (blocklist)->block[n]
349 /* Special block numbers */
351 #define GLOBAL_BLOCK 0
352 #define STATIC_BLOCK 1
353 #define FIRST_LOCAL_BLOCK 2
358 /* Addresses in the executable code that are in this block. */
363 /* The symbol that names this block, if the block is the body of a
364 function; otherwise, zero. */
366 struct symbol
*function
;
368 /* The `struct block' for the containing block, or 0 if none.
370 The superblock of a top-level local block (i.e. a function in the
371 case of C) is the STATIC_BLOCK. The superblock of the
372 STATIC_BLOCK is the GLOBAL_BLOCK. */
374 struct block
*superblock
;
376 /* Version of GCC used to compile the function corresponding
377 to this block, or 0 if not compiled with GCC. When possible,
378 GCC should be compatible with the native compiler, or if that
379 is not feasible, the differences should be fixed during symbol
380 reading. As of 16 Apr 93, this flag is never used to distinguish
381 between gcc2 and the native compiler.
383 If there is no function corresponding to this block, this meaning
384 of this flag is undefined. */
386 unsigned char gcc_compile_flag
;
388 /* The symbols for this block are either in a simple linear list or
389 in a simple hashtable. Blocks which correspond to a function
390 (which have a list of symbols corresponding to arguments) use
391 a linear list, as do some older symbol readers (currently only
392 mdebugread and dstread). Other blocks are hashed.
394 The hashtable uses the same hash function as the minsym hashtables,
395 found in minsyms.c:minsym_hash_iw. Symbols are hashed based on
396 their demangled name if appropriate, and on their name otherwise.
397 The hash function ignores space, and stops at the beginning of the
398 argument list if any.
400 The table is laid out in NSYMS/5 buckets and symbols are chained via
401 their hash_next field. */
403 /* If this is really a hashtable of the symbols, this flag is 1. */
405 unsigned char hashtable
;
407 /* Number of local symbols. */
411 /* The symbols. If some of them are arguments, then they must be
412 in the order in which we would like to print them. */
414 struct symbol
*sym
[1];
417 #define BLOCK_START(bl) (bl)->startaddr
418 #define BLOCK_END(bl) (bl)->endaddr
419 #define BLOCK_FUNCTION(bl) (bl)->function
420 #define BLOCK_SUPERBLOCK(bl) (bl)->superblock
421 #define BLOCK_GCC_COMPILED(bl) (bl)->gcc_compile_flag
422 #define BLOCK_HASHTABLE(bl) (bl)->hashtable
424 /* For blocks without a hashtable (BLOCK_HASHTABLE (bl) == 0) only. */
425 #define BLOCK_NSYMS(bl) (bl)->nsyms
426 #define BLOCK_SYM(bl, n) (bl)->sym[n]
428 /* For blocks with a hashtable, but these are valid for non-hashed blocks as
429 well - each symbol will appear to be one bucket by itself. */
430 #define BLOCK_BUCKETS(bl) (bl)->nsyms
431 #define BLOCK_BUCKET(bl, n) (bl)->sym[n]
433 /* Macro used to set the size of a hashtable for N symbols. */
434 #define BLOCK_HASHTABLE_SIZE(n) ((n)/5 + 1)
436 /* Macro to loop through all symbols in a block BL, in no particular order.
437 i counts which bucket we are in, and sym points to the current symbol. */
439 #define ALL_BLOCK_SYMBOLS(bl, i, sym) \
440 for ((i) = 0; (i) < BLOCK_BUCKETS ((bl)); (i)++) \
441 for ((sym) = BLOCK_BUCKET ((bl), (i)); (sym); \
442 (sym) = (sym)->hash_next)
444 /* Nonzero if symbols of block BL should be sorted alphabetically.
445 Don't sort a block which corresponds to a function. If we did the
446 sorting would have to preserve the order of the symbols for the
447 arguments. Also don't sort any block that we chose to hash. */
449 #define BLOCK_SHOULD_SORT(bl) (! BLOCK_HASHTABLE (bl) \
450 && BLOCK_FUNCTION (bl) == NULL)
453 /* Represent one symbol name; a variable, constant, function or typedef. */
455 /* Different name spaces for symbols. Looking up a symbol specifies a
456 namespace and ignores symbol definitions in other name spaces. */
460 /* UNDEF_NAMESPACE is used when a namespace has not been discovered or
461 none of the following apply. This usually indicates an error either
462 in the symbol information or in gdb's handling of symbols. */
466 /* VAR_NAMESPACE is the usual namespace. In C, this contains variables,
467 function names, typedef names and enum type values. */
471 /* STRUCT_NAMESPACE is used in C to hold struct, union and enum type names.
472 Thus, if `struct foo' is used in a C program, it produces a symbol named
473 `foo' in the STRUCT_NAMESPACE. */
477 /* LABEL_NAMESPACE may be used for names of labels (for gotos);
478 currently it is not used and labels are not recorded at all. */
482 /* Searching namespaces. These overlap with VAR_NAMESPACE, providing
483 some granularity with the search_symbols function. */
485 /* Everything in VAR_NAMESPACE minus FUNCTIONS_-, TYPES_-, and
489 /* All functions -- for some reason not methods, though. */
492 /* All defined types */
495 /* All class methods -- why is this separated out? */
500 /* An address-class says where to find the value of a symbol. */
504 /* Not used; catches errors */
508 /* Value is constant int SYMBOL_VALUE, host byteorder */
512 /* Value is at fixed address SYMBOL_VALUE_ADDRESS */
516 /* Value is in register. SYMBOL_VALUE is the register number. */
520 /* It's an argument; the value is at SYMBOL_VALUE offset in arglist. */
524 /* Value address is at SYMBOL_VALUE offset in arglist. */
528 /* Value is in register number SYMBOL_VALUE. Just like LOC_REGISTER
529 except this is an argument. Probably the cleaner way to handle
530 this would be to separate address_class (which would include
531 separate ARG and LOCAL to deal with FRAME_ARGS_ADDRESS versus
532 FRAME_LOCALS_ADDRESS), and an is_argument flag.
534 For some symbol formats (stabs, for some compilers at least),
535 the compiler generates two symbols, an argument and a register.
536 In some cases we combine them to a single LOC_REGPARM in symbol
537 reading, but currently not for all cases (e.g. it's passed on the
538 stack and then loaded into a register). */
542 /* Value is in specified register. Just like LOC_REGPARM except the
543 register holds the address of the argument instead of the argument
544 itself. This is currently used for the passing of structs and unions
545 on sparc and hppa. It is also used for call by reference where the
546 address is in a register, at least by mipsread.c. */
550 /* Value is a local variable at SYMBOL_VALUE offset in stack frame. */
554 /* Value not used; definition in SYMBOL_TYPE. Symbols in the namespace
555 STRUCT_NAMESPACE all have this class. */
559 /* Value is address SYMBOL_VALUE_ADDRESS in the code */
563 /* In a symbol table, value is SYMBOL_BLOCK_VALUE of a `struct block'.
564 In a partial symbol table, SYMBOL_VALUE_ADDRESS is the start address
565 of the block. Function names have this class. */
569 /* Value is a constant byte-sequence pointed to by SYMBOL_VALUE_BYTES, in
570 target byte order. */
574 /* Value is arg at SYMBOL_VALUE offset in stack frame. Differs from
575 LOC_LOCAL in that symbol is an argument; differs from LOC_ARG in
576 that we find it in the frame (FRAME_LOCALS_ADDRESS), not in the
577 arglist (FRAME_ARGS_ADDRESS). Added for i960, which passes args
578 in regs then copies to frame. */
582 /* Value is at SYMBOL_VALUE offset from the current value of
583 register number SYMBOL_BASEREG. This exists mainly for the same
584 things that LOC_LOCAL and LOC_ARG do; but we need to do this
585 instead because on 88k DWARF gives us the offset from the
586 frame/stack pointer, rather than the offset from the "canonical
587 frame address" used by COFF, stabs, etc., and we don't know how
588 to convert between these until we start examining prologues.
590 Note that LOC_BASEREG is much less general than a DWARF expression.
591 We don't need the generality (at least not yet), and storing a general
592 DWARF expression would presumably take up more space than the existing
597 /* Same as LOC_BASEREG but it is an argument. */
601 /* Value is at fixed address, but the address of the variable has
602 to be determined from the minimal symbol table whenever the
603 variable is referenced.
604 This happens if debugging information for a global symbol is
605 emitted and the corresponding minimal symbol is defined
606 in another object file or runtime common storage.
607 The linker might even remove the minimal symbol if the global
608 symbol is never referenced, in which case the symbol remains
613 /* Value is at a thread-specific location calculated by a
614 target-specific method. */
616 LOC_THREAD_LOCAL_STATIC
,
618 /* The variable does not actually exist in the program.
619 The value is ignored. */
623 /* The variable is static, but actually lives at * (address).
624 * I.e. do an extra indirection to get to it.
625 * This is used on HP-UX to get at globals that are allocated
626 * in shared libraries, where references from images other
627 * than the one where the global was allocated are done
628 * with a level of indirection.
634 /* Linked list of symbol's live ranges. */
640 struct range_list
*next
;
643 /* Linked list of aliases for a particular main/primary symbol. */
647 struct alias_list
*next
;
653 /* The general symbol info required for all types of symbols. */
655 struct general_symbol_info ginfo
;
657 /* Data type of value */
661 /* Name space code. */
664 /* FIXME: don't conflict with C++'s namespace */
665 /* would be safer to do a global change for all namespace identifiers. */
666 #define namespace _namespace
668 namespace_enum
namespace BYTE_BITFIELD
;
672 enum address_class aclass BYTE_BITFIELD
;
674 /* Line number of definition. FIXME: Should we really make the assumption
675 that nobody will try to debug files longer than 64K lines? What about
676 machine generated programs? */
680 /* Some symbols require an additional value to be recorded on a per-
681 symbol basis. Stash those values here. */
685 /* Used by LOC_BASEREG and LOC_BASEREG_ARG. */
691 /* Link to a list of aliases for this symbol.
692 Only a "primary/main symbol may have aliases. */
693 struct alias_list
*aliases
;
695 /* List of ranges where this symbol is active. This is only
696 used by alias symbols at the current time. */
697 struct range_list
*ranges
;
699 struct symbol
*hash_next
;
703 #define SYMBOL_NAMESPACE(symbol) (symbol)->namespace
704 #define SYMBOL_CLASS(symbol) (symbol)->aclass
705 #define SYMBOL_TYPE(symbol) (symbol)->type
706 #define SYMBOL_LINE(symbol) (symbol)->line
707 #define SYMBOL_BASEREG(symbol) (symbol)->aux_value.basereg
708 #define SYMBOL_ALIASES(symbol) (symbol)->aliases
709 #define SYMBOL_RANGES(symbol) (symbol)->ranges
711 /* A partial_symbol records the name, namespace, and address class of
712 symbols whose types we have not parsed yet. For functions, it also
713 contains their memory address, so we can find them from a PC value.
714 Each partial_symbol sits in a partial_symtab, all of which are chained
715 on a partial symtab list and which points to the corresponding
716 normal symtab once the partial_symtab has been referenced. */
718 struct partial_symbol
721 /* The general symbol info required for all types of symbols. */
723 struct general_symbol_info ginfo
;
725 /* Name space code. */
727 namespace_enum
namespace BYTE_BITFIELD
;
729 /* Address class (for info_symbols) */
731 enum address_class aclass BYTE_BITFIELD
;
735 #define PSYMBOL_NAMESPACE(psymbol) (psymbol)->namespace
736 #define PSYMBOL_CLASS(psymbol) (psymbol)->aclass
739 /* Source-file information. This describes the relation between source files,
740 line numbers and addresses in the program text. */
744 int length
; /* Number of source files described */
745 struct source
*source
[1]; /* Descriptions of the files */
748 /* Each item represents a line-->pc (or the reverse) mapping. This is
749 somewhat more wasteful of space than one might wish, but since only
750 the files which are actually debugged are read in to core, we don't
753 struct linetable_entry
759 /* The order of entries in the linetable is significant. They should
760 be sorted by increasing values of the pc field. If there is more than
761 one entry for a given pc, then I'm not sure what should happen (and
762 I not sure whether we currently handle it the best way).
764 Example: a C for statement generally looks like this
766 10 0x100 - for the init/test part of a for stmt.
769 10 0x400 - for the increment part of a for stmt.
771 If an entry has a line number of zero, it marks the start of a PC
772 range for which no line number information is available. It is
773 acceptable, though wasteful of table space, for such a range to be
780 /* Actually NITEMS elements. If you don't like this use of the
781 `struct hack', you can shove it up your ANSI (seriously, if the
782 committee tells us how to do it, we can probably go along). */
783 struct linetable_entry item
[1];
786 /* All the information on one source file. */
790 char *name
; /* Name of file */
791 struct linetable contents
;
794 /* How to relocate the symbols from each section in a symbol file.
795 Each struct contains an array of offsets.
796 The ordering and meaning of the offsets is file-type-dependent;
797 typically it is indexed by section numbers or symbol types or
800 To give us flexibility in changing the internal representation
801 of these offsets, the ANOFFSET macro must be used to insert and
802 extract offset values in the struct. */
804 struct section_offsets
806 CORE_ADDR offsets
[1]; /* As many as needed. */
809 #define ANOFFSET(secoff, whichone) \
811 ? (internal_error (__FILE__, __LINE__, "Section index is uninitialized"), -1) \
812 : secoff->offsets[whichone])
814 /* The maximum possible size of a section_offsets table. */
816 #define SIZEOF_SECTION_OFFSETS \
817 (sizeof (struct section_offsets) \
818 + sizeof (((struct section_offsets *) 0)->offsets) * (SECT_OFF_MAX-1))
820 /* Each source file or header is represented by a struct symtab.
821 These objects are chained through the `next' field. */
826 /* Chain of all existing symtabs. */
830 /* List of all symbol scope blocks for this symtab. May be shared
831 between different symtabs (and normally is for all the symtabs
832 in a given compilation unit). */
834 struct blockvector
*blockvector
;
836 /* Table mapping core addresses to line numbers for this file.
837 Can be NULL if none. Never shared between different symtabs. */
839 struct linetable
*linetable
;
841 /* Section in objfile->section_offsets for the blockvector and
842 the linetable. Probably always SECT_OFF_TEXT. */
844 int block_line_section
;
846 /* If several symtabs share a blockvector, exactly one of them
847 should be designated the primary, so that the blockvector
848 is relocated exactly once by objfile_relocate. */
852 /* The macro table for this symtab. Like the blockvector, this
853 may be shared between different symtabs --- and normally is for
854 all the symtabs in a given compilation unit. */
855 struct macro_table
*macro_table
;
857 /* Name of this source file. */
861 /* Directory in which it was compiled, or NULL if we don't know. */
865 /* This component says how to free the data we point to:
866 free_contents => do a tree walk and free each object.
867 free_nothing => do nothing; some other symtab will free
868 the data this one uses.
869 free_linetable => free just the linetable. FIXME: Is this redundant
870 with the primary field? */
874 free_nothing
, free_contents
, free_linetable
878 /* Pointer to one block of storage to be freed, if nonzero. */
879 /* This is IN ADDITION to the action indicated by free_code. */
883 /* Total number of lines found in source file. */
887 /* line_charpos[N] is the position of the (N-1)th line of the
888 source file. "position" means something we can lseek() to; it
889 is not guaranteed to be useful any other way. */
893 /* Language of this source file. */
895 enum language language
;
897 /* String that identifies the format of the debugging information, such
898 as "stabs", "dwarf 1", "dwarf 2", "coff", etc. This is mostly useful
899 for automated testing of gdb but may also be information that is
900 useful to the user. */
904 /* String of version information. May be zero. */
908 /* Full name of file as found by searching the source path.
909 NULL if not yet known. */
913 /* Object file from which this symbol information was read. */
915 struct objfile
*objfile
;
919 #define BLOCKVECTOR(symtab) (symtab)->blockvector
920 #define LINETABLE(symtab) (symtab)->linetable
923 /* Each source file that has not been fully read in is represented by
924 a partial_symtab. This contains the information on where in the
925 executable the debugging symbols for a specific file are, and a
926 list of names of global symbols which are located in this file.
927 They are all chained on partial symtab lists.
929 Even after the source file has been read into a symtab, the
930 partial_symtab remains around. They are allocated on an obstack,
931 psymbol_obstack. FIXME, this is bad for dynamic linking or VxWorks-
932 style execution of a bunch of .o's. */
934 struct partial_symtab
937 /* Chain of all existing partial symtabs. */
939 struct partial_symtab
*next
;
941 /* Name of the source file which this partial_symtab defines */
945 /* Full path of the source file. NULL if not known. */
949 /* Information about the object file from which symbols should be read. */
951 struct objfile
*objfile
;
953 /* Set of relocation offsets to apply to each section. */
955 struct section_offsets
*section_offsets
;
957 /* Range of text addresses covered by this file; texthigh is the
958 beginning of the next section. */
963 /* Array of pointers to all of the partial_symtab's which this one
964 depends on. Since this array can only be set to previous or
965 the current (?) psymtab, this dependency tree is guaranteed not
966 to have any loops. "depends on" means that symbols must be read
967 for the dependencies before being read for this psymtab; this is
968 for type references in stabs, where if foo.c includes foo.h, declarations
969 in foo.h may use type numbers defined in foo.c. For other debugging
970 formats there may be no need to use dependencies. */
972 struct partial_symtab
**dependencies
;
974 int number_of_dependencies
;
976 /* Global symbol list. This list will be sorted after readin to
977 improve access. Binary search will be the usual method of
978 finding a symbol within it. globals_offset is an integer offset
979 within global_psymbols[]. */
984 /* Static symbol list. This list will *not* be sorted after readin;
985 to find a symbol in it, exhaustive search must be used. This is
986 reasonable because searches through this list will eventually
987 lead to either the read in of a files symbols for real (assumed
988 to take a *lot* of time; check) or an error (and we don't care
989 how long errors take). This is an offset and size within
990 static_psymbols[]. */
995 /* Pointer to symtab eventually allocated for this source file, 0 if
996 !readin or if we haven't looked for the symtab after it was readin. */
998 struct symtab
*symtab
;
1000 /* Pointer to function which will read in the symtab corresponding to
1003 void (*read_symtab
) (struct partial_symtab
*);
1005 /* Information that lets read_symtab() locate the part of the symbol table
1006 that this psymtab corresponds to. This information is private to the
1007 format-dependent symbol reading routines. For further detail examine
1008 the various symbol reading modules. Should really be (void *) but is
1009 (char *) as with other such gdb variables. (FIXME) */
1011 char *read_symtab_private
;
1013 /* Non-zero if the symtab corresponding to this psymtab has been readin */
1015 unsigned char readin
;
1018 /* A fast way to get from a psymtab to its symtab (after the first time). */
1019 #define PSYMTAB_TO_SYMTAB(pst) \
1020 ((pst) -> symtab != NULL ? (pst) -> symtab : psymtab_to_symtab (pst))
1023 /* The virtual function table is now an array of structures which have the
1024 form { int16 offset, delta; void *pfn; }.
1026 In normal virtual function tables, OFFSET is unused.
1027 DELTA is the amount which is added to the apparent object's base
1028 address in order to point to the actual object to which the
1029 virtual function should be applied.
1030 PFN is a pointer to the virtual function.
1032 Note that this macro is g++ specific (FIXME). */
1034 #define VTBL_FNADDR_OFFSET 2
1036 /* External variables and functions for the objects described above. */
1038 /* See the comment in symfile.c about how current_objfile is used. */
1040 extern struct objfile
*current_objfile
;
1042 /* True if we are nested inside psymtab_to_symtab. */
1044 extern int currently_reading_symtab
;
1047 extern int demangle
;
1048 extern int asm_demangle
;
1050 /* symtab.c lookup functions */
1052 /* lookup a symbol table by source file name */
1054 extern struct symtab
*lookup_symtab (const char *);
1056 /* lookup a symbol by name (optional block, optional symtab) */
1058 extern struct symbol
*lookup_symbol (const char *, const struct block
*,
1059 const namespace_enum
, int *,
1062 /* lookup a symbol by name, within a specified block */
1064 extern struct symbol
*lookup_block_symbol (const struct block
*, const char *,
1066 const namespace_enum
);
1068 /* lookup a [struct, union, enum] by name, within a specified block */
1070 extern struct type
*lookup_struct (char *, struct block
*);
1072 extern struct type
*lookup_union (char *, struct block
*);
1074 extern struct type
*lookup_enum (char *, struct block
*);
1076 /* lookup the function corresponding to the block */
1078 extern struct symbol
*block_function (struct block
*);
1080 /* from blockframe.c: */
1082 /* lookup the function symbol corresponding to the address */
1084 extern struct symbol
*find_pc_function (CORE_ADDR
);
1086 /* lookup the function corresponding to the address and section */
1088 extern struct symbol
*find_pc_sect_function (CORE_ADDR
, asection
*);
1090 /* lookup function from address, return name, start addr and end addr */
1093 find_pc_partial_function (CORE_ADDR
, char **, CORE_ADDR
*, CORE_ADDR
*);
1095 extern void clear_pc_function_cache (void);
1097 extern int find_pc_sect_partial_function (CORE_ADDR
, asection
*,
1098 char **, CORE_ADDR
*, CORE_ADDR
*);
1100 /* from symtab.c: */
1102 /* lookup partial symbol table by filename */
1104 extern struct partial_symtab
*lookup_partial_symtab (const char *);
1106 /* lookup partial symbol table by address */
1108 extern struct partial_symtab
*find_pc_psymtab (CORE_ADDR
);
1110 /* lookup partial symbol table by address and section */
1112 extern struct partial_symtab
*find_pc_sect_psymtab (CORE_ADDR
, asection
*);
1114 /* lookup full symbol table by address */
1116 extern struct symtab
*find_pc_symtab (CORE_ADDR
);
1118 /* lookup full symbol table by address and section */
1120 extern struct symtab
*find_pc_sect_symtab (CORE_ADDR
, asection
*);
1122 /* lookup partial symbol by address */
1124 extern struct partial_symbol
*find_pc_psymbol (struct partial_symtab
*,
1127 /* lookup partial symbol by address and section */
1129 extern struct partial_symbol
*find_pc_sect_psymbol (struct partial_symtab
*,
1130 CORE_ADDR
, asection
*);
1132 extern int find_pc_line_pc_range (CORE_ADDR
, CORE_ADDR
*, CORE_ADDR
*);
1134 extern int contained_in (struct block
*, struct block
*);
1136 extern void reread_symbols (void);
1138 extern struct type
*lookup_transparent_type (const char *);
1141 /* Macro for name of symbol to indicate a file compiled with gcc. */
1142 #ifndef GCC_COMPILED_FLAG_SYMBOL
1143 #define GCC_COMPILED_FLAG_SYMBOL "gcc_compiled."
1146 /* Macro for name of symbol to indicate a file compiled with gcc2. */
1147 #ifndef GCC2_COMPILED_FLAG_SYMBOL
1148 #define GCC2_COMPILED_FLAG_SYMBOL "gcc2_compiled."
1151 /* Functions for dealing with the minimal symbol table, really a misc
1152 address<->symbol mapping for things we don't have debug symbols for. */
1154 extern void prim_record_minimal_symbol (const char *, CORE_ADDR
,
1155 enum minimal_symbol_type
,
1158 extern struct minimal_symbol
*prim_record_minimal_symbol_and_info
1159 (const char *, CORE_ADDR
,
1160 enum minimal_symbol_type
,
1161 char *info
, int section
, asection
* bfd_section
, struct objfile
*);
1163 extern unsigned int msymbol_hash_iw (const char *);
1165 extern unsigned int msymbol_hash (const char *);
1168 add_minsym_to_hash_table (struct minimal_symbol
*sym
,
1169 struct minimal_symbol
**table
);
1171 extern struct minimal_symbol
*lookup_minimal_symbol (const char *,
1175 extern struct minimal_symbol
*lookup_minimal_symbol_text (const char *,
1179 struct minimal_symbol
*lookup_minimal_symbol_solib_trampoline (const char *,
1184 extern struct minimal_symbol
*lookup_minimal_symbol_by_pc (CORE_ADDR
);
1186 extern struct minimal_symbol
*lookup_minimal_symbol_by_pc_section (CORE_ADDR
,
1190 extern struct minimal_symbol
1191 *lookup_solib_trampoline_symbol_by_pc (CORE_ADDR
);
1193 extern CORE_ADDR
find_solib_trampoline_target (CORE_ADDR
);
1195 extern void init_minimal_symbol_collection (void);
1197 extern struct cleanup
*make_cleanup_discard_minimal_symbols (void);
1199 extern void install_minimal_symbols (struct objfile
*);
1201 /* Sort all the minimal symbols in OBJFILE. */
1203 extern void msymbols_sort (struct objfile
*objfile
);
1205 struct symtab_and_line
1207 struct symtab
*symtab
;
1209 /* Line number. Line numbers start at 1 and proceed through symtab->nlines.
1210 0 is never a valid line number; it is used to indicate that line number
1211 information is not available. */
1218 #define INIT_SAL(sal) { \
1219 (sal)->symtab = 0; \
1220 (sal)->section = 0; \
1226 struct symtabs_and_lines
1228 struct symtab_and_line
*sals
;
1234 /* Some types and macros needed for exception catchpoints.
1235 Can't put these in target.h because symtab_and_line isn't
1236 known there. This file will be included by breakpoint.c,
1237 hppa-tdep.c, etc. */
1239 /* Enums for exception-handling support */
1240 enum exception_event_kind
1246 /* Type for returning info about an exception */
1247 struct exception_event_record
1249 enum exception_event_kind kind
;
1250 struct symtab_and_line throw_sal
;
1251 struct symtab_and_line catch_sal
;
1252 /* This may need to be extended in the future, if
1253 some platforms allow reporting more information,
1254 such as point of rethrow, type of exception object,
1255 type expected by catch clause, etc. */
1258 #define CURRENT_EXCEPTION_KIND (current_exception_event->kind)
1259 #define CURRENT_EXCEPTION_CATCH_SAL (current_exception_event->catch_sal)
1260 #define CURRENT_EXCEPTION_CATCH_LINE (current_exception_event->catch_sal.line)
1261 #define CURRENT_EXCEPTION_CATCH_FILE (current_exception_event->catch_sal.symtab->filename)
1262 #define CURRENT_EXCEPTION_CATCH_PC (current_exception_event->catch_sal.pc)
1263 #define CURRENT_EXCEPTION_THROW_SAL (current_exception_event->throw_sal)
1264 #define CURRENT_EXCEPTION_THROW_LINE (current_exception_event->throw_sal.line)
1265 #define CURRENT_EXCEPTION_THROW_FILE (current_exception_event->throw_sal.symtab->filename)
1266 #define CURRENT_EXCEPTION_THROW_PC (current_exception_event->throw_sal.pc)
1269 /* Given a pc value, return line number it is in. Second arg nonzero means
1270 if pc is on the boundary use the previous statement's line number. */
1272 extern struct symtab_and_line
find_pc_line (CORE_ADDR
, int);
1274 /* Same function, but specify a section as well as an address */
1276 extern struct symtab_and_line
find_pc_sect_line (CORE_ADDR
, asection
*, int);
1278 /* Given an address, return the nearest symbol at or below it in memory.
1279 Optionally return the symtab it's from through 2nd arg, and the
1280 address in inferior memory of the symbol through 3rd arg. */
1282 extern struct symbol
*find_addr_symbol (CORE_ADDR
, struct symtab
**,
1285 /* Given a symtab and line number, return the pc there. */
1287 extern int find_line_pc (struct symtab
*, int, CORE_ADDR
*);
1290 find_line_pc_range (struct symtab_and_line
, CORE_ADDR
*, CORE_ADDR
*);
1292 extern void resolve_sal_pc (struct symtab_and_line
*);
1294 /* Given a string, return the line specified by it. For commands like "list"
1295 and "breakpoint". */
1297 extern struct symtabs_and_lines
decode_line_spec (char *, int);
1299 extern struct symtabs_and_lines
decode_line_spec_1 (char *, int);
1303 void maintenance_print_symbols (char *, int);
1305 void maintenance_print_psymbols (char *, int);
1307 void maintenance_print_msymbols (char *, int);
1309 void maintenance_print_objfiles (char *, int);
1311 void maintenance_check_symtabs (char *, int);
1315 void maintenance_print_statistics (char *, int);
1317 extern void free_symtab (struct symtab
*);
1319 /* Symbol-reading stuff in symfile.c and solib.c. */
1321 extern struct symtab
*psymtab_to_symtab (struct partial_symtab
*);
1323 extern void clear_solib (void);
1327 extern int identify_source_line (struct symtab
*, int, int, CORE_ADDR
);
1329 extern void print_source_lines (struct symtab
*, int, int, int);
1331 extern void forget_cached_source_info (void);
1333 extern void select_source_symtab (struct symtab
*);
1335 extern char **make_symbol_completion_list (char *, char *);
1337 extern char **make_file_symbol_completion_list (char *, char *, char *);
1339 extern struct symbol
**make_symbol_overload_list (struct symbol
*);
1341 extern char **make_source_files_completion_list (char *, char *);
1345 extern struct partial_symtab
*find_main_psymtab (void);
1347 extern struct symtab
*find_line_symtab (struct symtab
*, int, int *, int *);
1349 extern struct symtab_and_line
find_function_start_sal (struct symbol
*sym
,
1354 extern struct blockvector
*blockvector_for_pc (CORE_ADDR
, int *);
1356 extern struct blockvector
*blockvector_for_pc_sect (CORE_ADDR
, asection
*,
1357 int *, struct symtab
*);
1361 extern void clear_symtab_users (void);
1363 extern enum language
deduce_language_from_filename (char *);
1367 extern int in_prologue (CORE_ADDR pc
, CORE_ADDR func_start
);
1369 extern struct symbol
*fixup_symbol_section (struct symbol
*,
1372 extern struct partial_symbol
*fixup_psymbol_section (struct partial_symbol
1374 struct objfile
*objfile
);
1376 /* Symbol searching */
1378 /* When using search_symbols, a list of the following structs is returned.
1379 Callers must free the search list using free_search_symbols! */
1380 struct symbol_search
1382 /* The block in which the match was found. Could be, for example,
1383 STATIC_BLOCK or GLOBAL_BLOCK. */
1386 /* Information describing what was found.
1388 If symtab abd symbol are NOT NULL, then information was found
1390 struct symtab
*symtab
;
1391 struct symbol
*symbol
;
1393 /* If msymbol is non-null, then a match was made on something for
1394 which only minimal_symbols exist. */
1395 struct minimal_symbol
*msymbol
;
1397 /* A link to the next match, or NULL for the end. */
1398 struct symbol_search
*next
;
1401 extern void search_symbols (char *, namespace_enum
, int, char **,
1402 struct symbol_search
**);
1403 extern void free_search_symbols (struct symbol_search
*);
1404 extern struct cleanup
*make_cleanup_free_search_symbols (struct symbol_search
1407 /* The name of the ``main'' function.
1408 FIXME: cagney/2001-03-20: Can't make main_name() const since some
1409 of the calling code currently assumes that the string isn't
1411 extern void set_main_name (const char *name
);
1412 extern /*const */ char *main_name (void);
1414 #endif /* !defined(SYMTAB_H) */