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++ */
100 /* Record the source code language that applies to this symbol.
101 This is used to select one of the fields from the language specific
104 enum language language BYTE_BITFIELD
;
106 /* Which section is this symbol in? This is an index into
107 section_offsets for this objfile. Negative means that the symbol
108 does not get relocated relative to a section.
109 Disclaimer: currently this is just used for xcoff, so don't
110 expect all symbol-reading code to set it correctly (the ELF code
111 also tries to set it correctly). */
115 /* The bfd section associated with this symbol. */
117 asection
*bfd_section
;
120 extern CORE_ADDR
symbol_overlayed_address (CORE_ADDR
, asection
*);
122 /* Note that all the following SYMBOL_* macros are used with the
123 SYMBOL argument being either a partial symbol, a minimal symbol or
124 a full symbol. All three types have a ginfo field. In particular
125 the SYMBOL_INIT_LANGUAGE_SPECIFIC, SYMBOL_INIT_DEMANGLED_NAME,
126 SYMBOL_DEMANGLED_NAME macros cannot be entirely substituted by
127 functions, unless the callers are changed to pass in the ginfo
128 field only, instead of the SYMBOL parameter. */
130 #define SYMBOL_NAME(symbol) (symbol)->ginfo.name
131 #define SYMBOL_VALUE(symbol) (symbol)->ginfo.value.ivalue
132 #define SYMBOL_VALUE_ADDRESS(symbol) (symbol)->ginfo.value.address
133 #define SYMBOL_VALUE_BYTES(symbol) (symbol)->ginfo.value.bytes
134 #define SYMBOL_BLOCK_VALUE(symbol) (symbol)->ginfo.value.block
135 #define SYMBOL_VALUE_CHAIN(symbol) (symbol)->ginfo.value.chain
136 #define SYMBOL_LANGUAGE(symbol) (symbol)->ginfo.language
137 #define SYMBOL_SECTION(symbol) (symbol)->ginfo.section
138 #define SYMBOL_BFD_SECTION(symbol) (symbol)->ginfo.bfd_section
140 #define SYMBOL_CPLUS_DEMANGLED_NAME(symbol) \
141 (symbol)->ginfo.language_specific.cplus_specific.demangled_name
143 /* Initializes the language dependent portion of a symbol
144 depending upon the language for the symbol. */
145 #define SYMBOL_INIT_LANGUAGE_SPECIFIC(symbol,language) \
146 (symbol_init_language_specific (&(symbol)->ginfo, (language)))
147 extern void symbol_init_language_specific (struct general_symbol_info
*symbol
,
148 enum language language
);
150 #define SYMBOL_INIT_DEMANGLED_NAME(symbol,obstack) \
151 (symbol_init_demangled_name (&symbol->ginfo, (obstack)))
152 extern void symbol_init_demangled_name (struct general_symbol_info
*symbol
,
153 struct obstack
*obstack
);
155 /* Return the demangled name for a symbol based on the language for
156 that symbol. If no demangled name exists, return NULL. */
157 #define SYMBOL_DEMANGLED_NAME(symbol) \
158 (symbol_demangled_name (&(symbol)->ginfo))
159 extern char *symbol_demangled_name (struct general_symbol_info
*symbol
);
161 #define SYMBOL_OBJC_DEMANGLED_NAME(symbol) \
162 (symbol)->ginfo.language_specific.objc_specific.demangled_name
164 /* Macro that returns the "natural source name" of a symbol. In C++ this is
165 the "demangled" form of the name if demangle is on and the "mangled" form
166 of the name if demangle is off. In other languages this is just the
167 symbol name. The result should never be NULL. */
169 #define SYMBOL_SOURCE_NAME(symbol) \
170 (demangle && SYMBOL_DEMANGLED_NAME (symbol) != NULL \
171 ? SYMBOL_DEMANGLED_NAME (symbol) \
172 : SYMBOL_NAME (symbol))
174 /* Macro that returns the "natural assembly name" of a symbol. In C++ this is
175 the "mangled" form of the name if demangle is off, or if demangle is on and
176 asm_demangle is off. Otherwise if asm_demangle is on it is the "demangled"
177 form. In other languages this is just the symbol name. The result should
180 #define SYMBOL_LINKAGE_NAME(symbol) \
181 (demangle && asm_demangle && SYMBOL_DEMANGLED_NAME (symbol) != NULL \
182 ? SYMBOL_DEMANGLED_NAME (symbol) \
183 : SYMBOL_NAME (symbol))
185 /* Macro that tests a symbol for a match against a specified name string.
186 First test the unencoded name, then looks for and test a C++ encoded
187 name if it exists. Note that whitespace is ignored while attempting to
188 match a C++ encoded name, so that "foo::bar(int,long)" is the same as
189 "foo :: bar (int, long)".
190 Evaluates to zero if the match fails, or nonzero if it succeeds. */
192 #define SYMBOL_MATCHES_NAME(symbol, name) \
193 (STREQ (SYMBOL_NAME (symbol), (name)) \
194 || (SYMBOL_DEMANGLED_NAME (symbol) != NULL \
195 && strcmp_iw (SYMBOL_DEMANGLED_NAME (symbol), (name)) == 0))
197 /* Macro that tests a symbol for an re-match against the last compiled regular
198 expression. First test the unencoded name, then look for and test a C++
199 encoded name if it exists.
200 Evaluates to zero if the match fails, or nonzero if it succeeds. */
202 #define SYMBOL_MATCHES_REGEXP(symbol) \
203 (re_exec (SYMBOL_NAME (symbol)) != 0 \
204 || (SYMBOL_DEMANGLED_NAME (symbol) != NULL \
205 && re_exec (SYMBOL_DEMANGLED_NAME (symbol)) != 0))
207 /* Define a simple structure used to hold some very basic information about
208 all defined global symbols (text, data, bss, abs, etc). The only required
209 information is the general_symbol_info.
211 In many cases, even if a file was compiled with no special options for
212 debugging at all, as long as was not stripped it will contain sufficient
213 information to build a useful minimal symbol table using this structure.
214 Even when a file contains enough debugging information to build a full
215 symbol table, these minimal symbols are still useful for quickly mapping
216 between names and addresses, and vice versa. They are also sometimes
217 used to figure out what full symbol table entries need to be read in. */
219 struct minimal_symbol
222 /* The general symbol info required for all types of symbols.
224 The SYMBOL_VALUE_ADDRESS contains the address that this symbol
227 struct general_symbol_info ginfo
;
229 /* The info field is available for caching machine-specific information
230 so it doesn't have to rederive the info constantly (over a serial line).
231 It is initialized to zero and stays that way until target-dependent code
232 sets it. Storage for any data pointed to by this field should be allo-
233 cated on the symbol_obstack for the associated objfile.
234 The type would be "void *" except for reasons of compatibility with older
235 compilers. This field is optional.
237 Currently, the AMD 29000 tdep.c uses it to remember things it has decoded
238 from the instructions in the function header, and the MIPS-16 code uses
239 it to identify 16-bit procedures. */
243 #ifdef SOFUN_ADDRESS_MAYBE_MISSING
244 /* Which source file is this symbol in? Only relevant for mst_file_*. */
248 /* Classification types for this symbol. These should be taken as "advisory
249 only", since if gdb can't easily figure out a classification it simply
250 selects mst_unknown. It may also have to guess when it can't figure out
251 which is a better match between two types (mst_data versus mst_bss) for
252 example. Since the minimal symbol info is sometimes derived from the
253 BFD library's view of a file, we need to live with what information bfd
256 enum minimal_symbol_type
258 mst_unknown
= 0, /* Unknown type, the default */
259 mst_text
, /* Generally executable instructions */
260 mst_data
, /* Generally initialized data */
261 mst_bss
, /* Generally uninitialized data */
262 mst_abs
, /* Generally absolute (nonrelocatable) */
263 /* GDB uses mst_solib_trampoline for the start address of a shared
264 library trampoline entry. Breakpoints for shared library functions
265 are put there if the shared library is not yet loaded.
266 After the shared library is loaded, lookup_minimal_symbol will
267 prefer the minimal symbol from the shared library (usually
268 a mst_text symbol) over the mst_solib_trampoline symbol, and the
269 breakpoints will be moved to their true address in the shared
270 library via breakpoint_re_set. */
271 mst_solib_trampoline
, /* Shared library trampoline code */
272 /* For the mst_file* types, the names are only guaranteed to be unique
273 within a given .o file. */
274 mst_file_text
, /* Static version of mst_text */
275 mst_file_data
, /* Static version of mst_data */
276 mst_file_bss
/* Static version of mst_bss */
280 /* Minimal symbols with the same hash key are kept on a linked
281 list. This is the link. */
283 struct minimal_symbol
*hash_next
;
285 /* Minimal symbols are stored in two different hash tables. This is
286 the `next' pointer for the demangled hash table. */
288 struct minimal_symbol
*demangled_hash_next
;
291 #define MSYMBOL_INFO(msymbol) (msymbol)->info
292 #define MSYMBOL_TYPE(msymbol) (msymbol)->type
296 /* All of the name-scope contours of the program
297 are represented by `struct block' objects.
298 All of these objects are pointed to by the blockvector.
300 Each block represents one name scope.
301 Each lexical context has its own block.
303 The blockvector begins with some special blocks.
304 The GLOBAL_BLOCK contains all the symbols defined in this compilation
305 whose scope is the entire program linked together.
306 The STATIC_BLOCK contains all the symbols whose scope is the
307 entire compilation excluding other separate compilations.
308 Blocks starting with the FIRST_LOCAL_BLOCK are not special.
310 Each block records a range of core addresses for the code that
311 is in the scope of the block. The STATIC_BLOCK and GLOBAL_BLOCK
312 give, for the range of code, the entire range of code produced
313 by the compilation that the symbol segment belongs to.
315 The blocks appear in the blockvector
316 in order of increasing starting-address,
317 and, within that, in order of decreasing ending-address.
319 This implies that within the body of one function
320 the blocks appear in the order of a depth-first tree walk. */
324 /* Number of blocks in the list. */
326 /* The blocks themselves. */
327 struct block
*block
[1];
330 #define BLOCKVECTOR_NBLOCKS(blocklist) (blocklist)->nblocks
331 #define BLOCKVECTOR_BLOCK(blocklist,n) (blocklist)->block[n]
333 /* Special block numbers */
335 #define GLOBAL_BLOCK 0
336 #define STATIC_BLOCK 1
337 #define FIRST_LOCAL_BLOCK 2
342 /* Addresses in the executable code that are in this block. */
347 /* The symbol that names this block, if the block is the body of a
348 function; otherwise, zero. */
350 struct symbol
*function
;
352 /* The `struct block' for the containing block, or 0 if none.
354 The superblock of a top-level local block (i.e. a function in the
355 case of C) is the STATIC_BLOCK. The superblock of the
356 STATIC_BLOCK is the GLOBAL_BLOCK. */
358 struct block
*superblock
;
360 /* Version of GCC used to compile the function corresponding
361 to this block, or 0 if not compiled with GCC. When possible,
362 GCC should be compatible with the native compiler, or if that
363 is not feasible, the differences should be fixed during symbol
364 reading. As of 16 Apr 93, this flag is never used to distinguish
365 between gcc2 and the native compiler.
367 If there is no function corresponding to this block, this meaning
368 of this flag is undefined. */
370 unsigned char gcc_compile_flag
;
372 /* The symbols for this block are either in a simple linear list or
373 in a simple hashtable. Blocks which correspond to a function
374 (which have a list of symbols corresponding to arguments) use
375 a linear list, as do some older symbol readers (currently only
376 mdebugread and dstread). Other blocks are hashed.
378 The hashtable uses the same hash function as the minsym hashtables,
379 found in minsyms.c:minsym_hash_iw. Symbols are hashed based on
380 their demangled name if appropriate, and on their name otherwise.
381 The hash function ignores space, and stops at the beginning of the
382 argument list if any.
384 The table is laid out in NSYMS/5 buckets and symbols are chained via
385 their hash_next field. */
387 /* If this is really a hashtable of the symbols, this flag is 1. */
389 unsigned char hashtable
;
391 /* Number of local symbols. */
395 /* The symbols. If some of them are arguments, then they must be
396 in the order in which we would like to print them. */
398 struct symbol
*sym
[1];
401 #define BLOCK_START(bl) (bl)->startaddr
402 #define BLOCK_END(bl) (bl)->endaddr
403 #define BLOCK_FUNCTION(bl) (bl)->function
404 #define BLOCK_SUPERBLOCK(bl) (bl)->superblock
405 #define BLOCK_GCC_COMPILED(bl) (bl)->gcc_compile_flag
406 #define BLOCK_HASHTABLE(bl) (bl)->hashtable
408 /* For blocks without a hashtable (BLOCK_HASHTABLE (bl) == 0) only. */
409 #define BLOCK_NSYMS(bl) (bl)->nsyms
410 #define BLOCK_SYM(bl, n) (bl)->sym[n]
412 /* For blocks with a hashtable, but these are valid for non-hashed blocks as
413 well - each symbol will appear to be one bucket by itself. */
414 #define BLOCK_BUCKETS(bl) (bl)->nsyms
415 #define BLOCK_BUCKET(bl, n) (bl)->sym[n]
417 /* Macro used to set the size of a hashtable for N symbols. */
418 #define BLOCK_HASHTABLE_SIZE(n) ((n)/5 + 1)
420 /* Macro to loop through all symbols in a block BL, in no particular order.
421 i counts which bucket we are in, and sym points to the current symbol. */
423 #define ALL_BLOCK_SYMBOLS(bl, i, sym) \
424 for ((i) = 0; (i) < BLOCK_BUCKETS ((bl)); (i)++) \
425 for ((sym) = BLOCK_BUCKET ((bl), (i)); (sym); \
426 (sym) = (sym)->hash_next)
428 /* Nonzero if symbols of block BL should be sorted alphabetically.
429 Don't sort a block which corresponds to a function. If we did the
430 sorting would have to preserve the order of the symbols for the
431 arguments. Also don't sort any block that we chose to hash. */
433 #define BLOCK_SHOULD_SORT(bl) (! BLOCK_HASHTABLE (bl) \
434 && BLOCK_FUNCTION (bl) == NULL)
437 /* Represent one symbol name; a variable, constant, function or typedef. */
439 /* Different name spaces for symbols. Looking up a symbol specifies a
440 namespace and ignores symbol definitions in other name spaces. */
444 /* UNDEF_NAMESPACE is used when a namespace has not been discovered or
445 none of the following apply. This usually indicates an error either
446 in the symbol information or in gdb's handling of symbols. */
450 /* VAR_NAMESPACE is the usual namespace. In C, this contains variables,
451 function names, typedef names and enum type values. */
455 /* STRUCT_NAMESPACE is used in C to hold struct, union and enum type names.
456 Thus, if `struct foo' is used in a C program, it produces a symbol named
457 `foo' in the STRUCT_NAMESPACE. */
461 /* LABEL_NAMESPACE may be used for names of labels (for gotos);
462 currently it is not used and labels are not recorded at all. */
466 /* Searching namespaces. These overlap with VAR_NAMESPACE, providing
467 some granularity with the search_symbols function. */
469 /* Everything in VAR_NAMESPACE minus FUNCTIONS_-, TYPES_-, and
473 /* All functions -- for some reason not methods, though. */
476 /* All defined types */
479 /* All class methods -- why is this separated out? */
484 /* An address-class says where to find the value of a symbol. */
488 /* Not used; catches errors */
492 /* Value is constant int SYMBOL_VALUE, host byteorder */
496 /* Value is at fixed address SYMBOL_VALUE_ADDRESS */
500 /* Value is in register. SYMBOL_VALUE is the register number. */
504 /* It's an argument; the value is at SYMBOL_VALUE offset in arglist. */
508 /* Value address is at SYMBOL_VALUE offset in arglist. */
512 /* Value is in register number SYMBOL_VALUE. Just like LOC_REGISTER
513 except this is an argument. Probably the cleaner way to handle
514 this would be to separate address_class (which would include
515 separate ARG and LOCAL to deal with FRAME_ARGS_ADDRESS versus
516 FRAME_LOCALS_ADDRESS), and an is_argument flag.
518 For some symbol formats (stabs, for some compilers at least),
519 the compiler generates two symbols, an argument and a register.
520 In some cases we combine them to a single LOC_REGPARM in symbol
521 reading, but currently not for all cases (e.g. it's passed on the
522 stack and then loaded into a register). */
526 /* Value is in specified register. Just like LOC_REGPARM except the
527 register holds the address of the argument instead of the argument
528 itself. This is currently used for the passing of structs and unions
529 on sparc and hppa. It is also used for call by reference where the
530 address is in a register, at least by mipsread.c. */
534 /* Value is a local variable at SYMBOL_VALUE offset in stack frame. */
538 /* Value not used; definition in SYMBOL_TYPE. Symbols in the namespace
539 STRUCT_NAMESPACE all have this class. */
543 /* Value is address SYMBOL_VALUE_ADDRESS in the code */
547 /* In a symbol table, value is SYMBOL_BLOCK_VALUE of a `struct block'.
548 In a partial symbol table, SYMBOL_VALUE_ADDRESS is the start address
549 of the block. Function names have this class. */
553 /* Value is a constant byte-sequence pointed to by SYMBOL_VALUE_BYTES, in
554 target byte order. */
558 /* Value is arg at SYMBOL_VALUE offset in stack frame. Differs from
559 LOC_LOCAL in that symbol is an argument; differs from LOC_ARG in
560 that we find it in the frame (FRAME_LOCALS_ADDRESS), not in the
561 arglist (FRAME_ARGS_ADDRESS). Added for i960, which passes args
562 in regs then copies to frame. */
566 /* Value is at SYMBOL_VALUE offset from the current value of
567 register number SYMBOL_BASEREG. This exists mainly for the same
568 things that LOC_LOCAL and LOC_ARG do; but we need to do this
569 instead because on 88k DWARF gives us the offset from the
570 frame/stack pointer, rather than the offset from the "canonical
571 frame address" used by COFF, stabs, etc., and we don't know how
572 to convert between these until we start examining prologues.
574 Note that LOC_BASEREG is much less general than a DWARF expression.
575 We don't need the generality (at least not yet), and storing a general
576 DWARF expression would presumably take up more space than the existing
581 /* Same as LOC_BASEREG but it is an argument. */
585 /* Value is at fixed address, but the address of the variable has
586 to be determined from the minimal symbol table whenever the
587 variable is referenced.
588 This happens if debugging information for a global symbol is
589 emitted and the corresponding minimal symbol is defined
590 in another object file or runtime common storage.
591 The linker might even remove the minimal symbol if the global
592 symbol is never referenced, in which case the symbol remains
597 /* Value is at a thread-specific location calculated by a
598 target-specific method. This is used only by hppa. */
600 LOC_HP_THREAD_LOCAL_STATIC
,
602 /* Value is at a thread-specific location calculated by a
603 target-specific method. SYMBOL_OBJFILE gives the object file
604 in which the symbol is defined; the symbol's value is the
605 offset into that objfile's thread-local storage for the current
608 LOC_THREAD_LOCAL_STATIC
,
610 /* The variable does not actually exist in the program.
611 The value is ignored. */
615 /* The variable is static, but actually lives at * (address).
616 * I.e. do an extra indirection to get to it.
617 * This is used on HP-UX to get at globals that are allocated
618 * in shared libraries, where references from images other
619 * than the one where the global was allocated are done
620 * with a level of indirection.
626 /* Linked list of symbol's live ranges. */
632 struct range_list
*next
;
635 /* Linked list of aliases for a particular main/primary symbol. */
639 struct alias_list
*next
;
645 /* The general symbol info required for all types of symbols. */
647 struct general_symbol_info ginfo
;
649 /* Data type of value */
653 /* Name space code. */
656 /* FIXME: don't conflict with C++'s namespace */
657 /* would be safer to do a global change for all namespace identifiers. */
658 #define namespace _namespace
660 namespace_enum
namespace BYTE_BITFIELD
;
664 enum address_class aclass BYTE_BITFIELD
;
666 /* Line number of definition. FIXME: Should we really make the assumption
667 that nobody will try to debug files longer than 64K lines? What about
668 machine generated programs? */
672 /* Some symbols require an additional value to be recorded on a per-
673 symbol basis. Stash those values here. */
677 /* Used by LOC_BASEREG and LOC_BASEREG_ARG. */
680 /* Used by LOC_THREAD_LOCAL_STATIC. The objfile in which this
681 symbol is defined. To find a thread-local variable (e.g., a
682 variable declared with the `__thread' storage class), we may
683 need to know which object file it's in. */
684 struct objfile
*objfile
;
689 /* Link to a list of aliases for this symbol.
690 Only a "primary/main symbol may have aliases. */
691 struct alias_list
*aliases
;
693 /* List of ranges where this symbol is active. This is only
694 used by alias symbols at the current time. */
695 struct range_list
*ranges
;
697 struct symbol
*hash_next
;
701 #define SYMBOL_NAMESPACE(symbol) (symbol)->namespace
702 #define SYMBOL_CLASS(symbol) (symbol)->aclass
703 #define SYMBOL_TYPE(symbol) (symbol)->type
704 #define SYMBOL_LINE(symbol) (symbol)->line
705 #define SYMBOL_BASEREG(symbol) (symbol)->aux_value.basereg
706 #define SYMBOL_OBJFILE(symbol) (symbol)->aux_value.objfile
707 #define SYMBOL_ALIASES(symbol) (symbol)->aliases
708 #define SYMBOL_RANGES(symbol) (symbol)->ranges
710 /* A partial_symbol records the name, namespace, and address class of
711 symbols whose types we have not parsed yet. For functions, it also
712 contains their memory address, so we can find them from a PC value.
713 Each partial_symbol sits in a partial_symtab, all of which are chained
714 on a partial symtab list and which points to the corresponding
715 normal symtab once the partial_symtab has been referenced. */
717 struct partial_symbol
720 /* The general symbol info required for all types of symbols. */
722 struct general_symbol_info ginfo
;
724 /* Name space code. */
726 namespace_enum
namespace BYTE_BITFIELD
;
728 /* Address class (for info_symbols) */
730 enum address_class aclass BYTE_BITFIELD
;
734 #define PSYMBOL_NAMESPACE(psymbol) (psymbol)->namespace
735 #define PSYMBOL_CLASS(psymbol) (psymbol)->aclass
738 /* Each item represents a line-->pc (or the reverse) mapping. This is
739 somewhat more wasteful of space than one might wish, but since only
740 the files which are actually debugged are read in to core, we don't
743 struct linetable_entry
749 /* The order of entries in the linetable is significant. They should
750 be sorted by increasing values of the pc field. If there is more than
751 one entry for a given pc, then I'm not sure what should happen (and
752 I not sure whether we currently handle it the best way).
754 Example: a C for statement generally looks like this
756 10 0x100 - for the init/test part of a for stmt.
759 10 0x400 - for the increment part of a for stmt.
761 If an entry has a line number of zero, it marks the start of a PC
762 range for which no line number information is available. It is
763 acceptable, though wasteful of table space, for such a range to be
770 /* Actually NITEMS elements. If you don't like this use of the
771 `struct hack', you can shove it up your ANSI (seriously, if the
772 committee tells us how to do it, we can probably go along). */
773 struct linetable_entry item
[1];
776 /* How to relocate the symbols from each section in a symbol file.
777 Each struct contains an array of offsets.
778 The ordering and meaning of the offsets is file-type-dependent;
779 typically it is indexed by section numbers or symbol types or
782 To give us flexibility in changing the internal representation
783 of these offsets, the ANOFFSET macro must be used to insert and
784 extract offset values in the struct. */
786 struct section_offsets
788 CORE_ADDR offsets
[1]; /* As many as needed. */
791 #define ANOFFSET(secoff, whichone) \
793 ? (internal_error (__FILE__, __LINE__, "Section index is uninitialized"), -1) \
794 : secoff->offsets[whichone])
796 /* The size of a section_offsets table for N sections. */
797 #define SIZEOF_N_SECTION_OFFSETS(n) \
798 (sizeof (struct section_offsets) \
799 + sizeof (((struct section_offsets *) 0)->offsets) * ((n)-1))
801 /* The maximum possible size of a section_offsets table. */
802 #define SIZEOF_SECTION_OFFSETS (SIZEOF_N_SECTION_OFFSETS (SECT_OFF_MAX))
804 /* Each source file or header is represented by a struct symtab.
805 These objects are chained through the `next' field. */
810 /* Chain of all existing symtabs. */
814 /* List of all symbol scope blocks for this symtab. May be shared
815 between different symtabs (and normally is for all the symtabs
816 in a given compilation unit). */
818 struct blockvector
*blockvector
;
820 /* Table mapping core addresses to line numbers for this file.
821 Can be NULL if none. Never shared between different symtabs. */
823 struct linetable
*linetable
;
825 /* Section in objfile->section_offsets for the blockvector and
826 the linetable. Probably always SECT_OFF_TEXT. */
828 int block_line_section
;
830 /* If several symtabs share a blockvector, exactly one of them
831 should be designated the primary, so that the blockvector
832 is relocated exactly once by objfile_relocate. */
836 /* The macro table for this symtab. Like the blockvector, this
837 may be shared between different symtabs --- and normally is for
838 all the symtabs in a given compilation unit. */
839 struct macro_table
*macro_table
;
841 /* Name of this source file. */
845 /* Directory in which it was compiled, or NULL if we don't know. */
849 /* This component says how to free the data we point to:
850 free_contents => do a tree walk and free each object.
851 free_nothing => do nothing; some other symtab will free
852 the data this one uses.
853 free_linetable => free just the linetable. FIXME: Is this redundant
854 with the primary field? */
858 free_nothing
, free_contents
, free_linetable
862 /* Pointer to one block of storage to be freed, if nonzero. */
863 /* This is IN ADDITION to the action indicated by free_code. */
867 /* Total number of lines found in source file. */
871 /* line_charpos[N] is the position of the (N-1)th line of the
872 source file. "position" means something we can lseek() to; it
873 is not guaranteed to be useful any other way. */
877 /* Language of this source file. */
879 enum language language
;
881 /* String that identifies the format of the debugging information, such
882 as "stabs", "dwarf 1", "dwarf 2", "coff", etc. This is mostly useful
883 for automated testing of gdb but may also be information that is
884 useful to the user. */
888 /* String of version information. May be zero. */
892 /* Full name of file as found by searching the source path.
893 NULL if not yet known. */
897 /* Object file from which this symbol information was read. */
899 struct objfile
*objfile
;
903 #define BLOCKVECTOR(symtab) (symtab)->blockvector
904 #define LINETABLE(symtab) (symtab)->linetable
907 /* Each source file that has not been fully read in is represented by
908 a partial_symtab. This contains the information on where in the
909 executable the debugging symbols for a specific file are, and a
910 list of names of global symbols which are located in this file.
911 They are all chained on partial symtab lists.
913 Even after the source file has been read into a symtab, the
914 partial_symtab remains around. They are allocated on an obstack,
915 psymbol_obstack. FIXME, this is bad for dynamic linking or VxWorks-
916 style execution of a bunch of .o's. */
918 struct partial_symtab
921 /* Chain of all existing partial symtabs. */
923 struct partial_symtab
*next
;
925 /* Name of the source file which this partial_symtab defines */
929 /* Full path of the source file. NULL if not known. */
933 /* Information about the object file from which symbols should be read. */
935 struct objfile
*objfile
;
937 /* Set of relocation offsets to apply to each section. */
939 struct section_offsets
*section_offsets
;
941 /* Range of text addresses covered by this file; texthigh is the
942 beginning of the next section. */
947 /* Array of pointers to all of the partial_symtab's which this one
948 depends on. Since this array can only be set to previous or
949 the current (?) psymtab, this dependency tree is guaranteed not
950 to have any loops. "depends on" means that symbols must be read
951 for the dependencies before being read for this psymtab; this is
952 for type references in stabs, where if foo.c includes foo.h, declarations
953 in foo.h may use type numbers defined in foo.c. For other debugging
954 formats there may be no need to use dependencies. */
956 struct partial_symtab
**dependencies
;
958 int number_of_dependencies
;
960 /* Global symbol list. This list will be sorted after readin to
961 improve access. Binary search will be the usual method of
962 finding a symbol within it. globals_offset is an integer offset
963 within global_psymbols[]. */
968 /* Static symbol list. This list will *not* be sorted after readin;
969 to find a symbol in it, exhaustive search must be used. This is
970 reasonable because searches through this list will eventually
971 lead to either the read in of a files symbols for real (assumed
972 to take a *lot* of time; check) or an error (and we don't care
973 how long errors take). This is an offset and size within
974 static_psymbols[]. */
979 /* Pointer to symtab eventually allocated for this source file, 0 if
980 !readin or if we haven't looked for the symtab after it was readin. */
982 struct symtab
*symtab
;
984 /* Pointer to function which will read in the symtab corresponding to
987 void (*read_symtab
) (struct partial_symtab
*);
989 /* Information that lets read_symtab() locate the part of the symbol table
990 that this psymtab corresponds to. This information is private to the
991 format-dependent symbol reading routines. For further detail examine
992 the various symbol reading modules. Should really be (void *) but is
993 (char *) as with other such gdb variables. (FIXME) */
995 char *read_symtab_private
;
997 /* Non-zero if the symtab corresponding to this psymtab has been readin */
999 unsigned char readin
;
1002 /* A fast way to get from a psymtab to its symtab (after the first time). */
1003 #define PSYMTAB_TO_SYMTAB(pst) \
1004 ((pst) -> symtab != NULL ? (pst) -> symtab : psymtab_to_symtab (pst))
1007 /* The virtual function table is now an array of structures which have the
1008 form { int16 offset, delta; void *pfn; }.
1010 In normal virtual function tables, OFFSET is unused.
1011 DELTA is the amount which is added to the apparent object's base
1012 address in order to point to the actual object to which the
1013 virtual function should be applied.
1014 PFN is a pointer to the virtual function.
1016 Note that this macro is g++ specific (FIXME). */
1018 #define VTBL_FNADDR_OFFSET 2
1020 /* External variables and functions for the objects described above. */
1022 /* See the comment in symfile.c about how current_objfile is used. */
1024 extern struct objfile
*current_objfile
;
1026 /* True if we are nested inside psymtab_to_symtab. */
1028 extern int currently_reading_symtab
;
1031 extern int demangle
;
1032 extern int asm_demangle
;
1034 /* symtab.c lookup functions */
1036 /* lookup a symbol table by source file name */
1038 extern struct symtab
*lookup_symtab (const char *);
1040 /* lookup a symbol by name (optional block, optional symtab) */
1042 extern struct symbol
*lookup_symbol (const char *, const struct block
*,
1043 const namespace_enum
, int *,
1046 /* lookup a symbol by name, within a specified block */
1048 extern struct symbol
*lookup_block_symbol (const struct block
*, const char *,
1050 const namespace_enum
);
1052 /* lookup a [struct, union, enum] by name, within a specified block */
1054 extern struct type
*lookup_struct (char *, struct block
*);
1056 extern struct type
*lookup_union (char *, struct block
*);
1058 extern struct type
*lookup_enum (char *, struct block
*);
1060 /* lookup the function corresponding to the block */
1062 extern struct symbol
*block_function (struct block
*);
1064 /* from blockframe.c: */
1066 /* lookup the function symbol corresponding to the address */
1068 extern struct symbol
*find_pc_function (CORE_ADDR
);
1070 /* lookup the function corresponding to the address and section */
1072 extern struct symbol
*find_pc_sect_function (CORE_ADDR
, asection
*);
1074 /* lookup function from address, return name, start addr and end addr */
1077 find_pc_partial_function (CORE_ADDR
, char **, CORE_ADDR
*, CORE_ADDR
*);
1079 extern void clear_pc_function_cache (void);
1081 extern int find_pc_sect_partial_function (CORE_ADDR
, asection
*,
1082 char **, CORE_ADDR
*, CORE_ADDR
*);
1084 /* from symtab.c: */
1086 /* lookup partial symbol table by filename */
1088 extern struct partial_symtab
*lookup_partial_symtab (const char *);
1090 /* lookup partial symbol table by address */
1092 extern struct partial_symtab
*find_pc_psymtab (CORE_ADDR
);
1094 /* lookup partial symbol table by address and section */
1096 extern struct partial_symtab
*find_pc_sect_psymtab (CORE_ADDR
, asection
*);
1098 /* lookup full symbol table by address */
1100 extern struct symtab
*find_pc_symtab (CORE_ADDR
);
1102 /* lookup full symbol table by address and section */
1104 extern struct symtab
*find_pc_sect_symtab (CORE_ADDR
, asection
*);
1106 /* lookup partial symbol by address */
1108 extern struct partial_symbol
*find_pc_psymbol (struct partial_symtab
*,
1111 /* lookup partial symbol by address and section */
1113 extern struct partial_symbol
*find_pc_sect_psymbol (struct partial_symtab
*,
1114 CORE_ADDR
, asection
*);
1116 extern int find_pc_line_pc_range (CORE_ADDR
, CORE_ADDR
*, CORE_ADDR
*);
1118 extern int contained_in (struct block
*, struct block
*);
1120 extern void reread_symbols (void);
1122 extern struct type
*lookup_transparent_type (const char *);
1125 /* Macro for name of symbol to indicate a file compiled with gcc. */
1126 #ifndef GCC_COMPILED_FLAG_SYMBOL
1127 #define GCC_COMPILED_FLAG_SYMBOL "gcc_compiled."
1130 /* Macro for name of symbol to indicate a file compiled with gcc2. */
1131 #ifndef GCC2_COMPILED_FLAG_SYMBOL
1132 #define GCC2_COMPILED_FLAG_SYMBOL "gcc2_compiled."
1135 /* Functions for dealing with the minimal symbol table, really a misc
1136 address<->symbol mapping for things we don't have debug symbols for. */
1138 extern void prim_record_minimal_symbol (const char *, CORE_ADDR
,
1139 enum minimal_symbol_type
,
1142 extern struct minimal_symbol
*prim_record_minimal_symbol_and_info
1143 (const char *, CORE_ADDR
,
1144 enum minimal_symbol_type
,
1145 char *info
, int section
, asection
* bfd_section
, struct objfile
*);
1147 extern unsigned int msymbol_hash_iw (const char *);
1149 extern unsigned int msymbol_hash (const char *);
1152 add_minsym_to_hash_table (struct minimal_symbol
*sym
,
1153 struct minimal_symbol
**table
);
1155 extern struct minimal_symbol
*lookup_minimal_symbol (const char *,
1159 extern struct minimal_symbol
*lookup_minimal_symbol_text (const char *,
1163 struct minimal_symbol
*lookup_minimal_symbol_solib_trampoline (const char *,
1168 extern struct minimal_symbol
*lookup_minimal_symbol_by_pc (CORE_ADDR
);
1170 extern struct minimal_symbol
*lookup_minimal_symbol_by_pc_section (CORE_ADDR
,
1174 extern struct minimal_symbol
1175 *lookup_solib_trampoline_symbol_by_pc (CORE_ADDR
);
1177 extern CORE_ADDR
find_solib_trampoline_target (CORE_ADDR
);
1179 extern void init_minimal_symbol_collection (void);
1181 extern struct cleanup
*make_cleanup_discard_minimal_symbols (void);
1183 extern void install_minimal_symbols (struct objfile
*);
1185 /* Sort all the minimal symbols in OBJFILE. */
1187 extern void msymbols_sort (struct objfile
*objfile
);
1189 struct symtab_and_line
1191 struct symtab
*symtab
;
1193 /* Line number. Line numbers start at 1 and proceed through symtab->nlines.
1194 0 is never a valid line number; it is used to indicate that line number
1195 information is not available. */
1202 extern void init_sal (struct symtab_and_line
*sal
);
1204 struct symtabs_and_lines
1206 struct symtab_and_line
*sals
;
1212 /* Some types and macros needed for exception catchpoints.
1213 Can't put these in target.h because symtab_and_line isn't
1214 known there. This file will be included by breakpoint.c,
1215 hppa-tdep.c, etc. */
1217 /* Enums for exception-handling support */
1218 enum exception_event_kind
1224 /* Type for returning info about an exception */
1225 struct exception_event_record
1227 enum exception_event_kind kind
;
1228 struct symtab_and_line throw_sal
;
1229 struct symtab_and_line catch_sal
;
1230 /* This may need to be extended in the future, if
1231 some platforms allow reporting more information,
1232 such as point of rethrow, type of exception object,
1233 type expected by catch clause, etc. */
1236 #define CURRENT_EXCEPTION_KIND (current_exception_event->kind)
1237 #define CURRENT_EXCEPTION_CATCH_SAL (current_exception_event->catch_sal)
1238 #define CURRENT_EXCEPTION_CATCH_LINE (current_exception_event->catch_sal.line)
1239 #define CURRENT_EXCEPTION_CATCH_FILE (current_exception_event->catch_sal.symtab->filename)
1240 #define CURRENT_EXCEPTION_CATCH_PC (current_exception_event->catch_sal.pc)
1241 #define CURRENT_EXCEPTION_THROW_SAL (current_exception_event->throw_sal)
1242 #define CURRENT_EXCEPTION_THROW_LINE (current_exception_event->throw_sal.line)
1243 #define CURRENT_EXCEPTION_THROW_FILE (current_exception_event->throw_sal.symtab->filename)
1244 #define CURRENT_EXCEPTION_THROW_PC (current_exception_event->throw_sal.pc)
1247 /* Given a pc value, return line number it is in. Second arg nonzero means
1248 if pc is on the boundary use the previous statement's line number. */
1250 extern struct symtab_and_line
find_pc_line (CORE_ADDR
, int);
1252 /* Same function, but specify a section as well as an address */
1254 extern struct symtab_and_line
find_pc_sect_line (CORE_ADDR
, asection
*, int);
1256 /* Given a symtab and line number, return the pc there. */
1258 extern int find_line_pc (struct symtab
*, int, CORE_ADDR
*);
1261 find_line_pc_range (struct symtab_and_line
, CORE_ADDR
*, CORE_ADDR
*);
1263 extern void resolve_sal_pc (struct symtab_and_line
*);
1265 /* Given a string, return the line specified by it. For commands like "list"
1266 and "breakpoint". */
1268 extern struct symtabs_and_lines
decode_line_spec (char *, int);
1270 extern struct symtabs_and_lines
decode_line_spec_1 (char *, int);
1274 void maintenance_print_symbols (char *, int);
1276 void maintenance_print_psymbols (char *, int);
1278 void maintenance_print_msymbols (char *, int);
1280 void maintenance_print_objfiles (char *, int);
1282 void maintenance_check_symtabs (char *, int);
1286 void maintenance_print_statistics (char *, int);
1288 extern void free_symtab (struct symtab
*);
1290 /* Symbol-reading stuff in symfile.c and solib.c. */
1292 extern struct symtab
*psymtab_to_symtab (struct partial_symtab
*);
1294 extern void clear_solib (void);
1298 extern int identify_source_line (struct symtab
*, int, int, CORE_ADDR
);
1300 extern void print_source_lines (struct symtab
*, int, int, int);
1302 extern void forget_cached_source_info (void);
1304 extern void select_source_symtab (struct symtab
*);
1306 extern char **make_symbol_completion_list (char *, char *);
1308 extern char **make_file_symbol_completion_list (char *, char *, char *);
1310 extern struct symbol
**make_symbol_overload_list (struct symbol
*);
1312 extern char **make_source_files_completion_list (char *, char *);
1316 extern struct partial_symtab
*find_main_psymtab (void);
1318 extern struct symtab
*find_line_symtab (struct symtab
*, int, int *, int *);
1320 extern struct symtab_and_line
find_function_start_sal (struct symbol
*sym
,
1325 extern struct blockvector
*blockvector_for_pc (CORE_ADDR
, int *);
1327 extern struct blockvector
*blockvector_for_pc_sect (CORE_ADDR
, asection
*,
1328 int *, struct symtab
*);
1332 extern void clear_symtab_users (void);
1334 extern enum language
deduce_language_from_filename (char *);
1338 extern int in_prologue (CORE_ADDR pc
, CORE_ADDR func_start
);
1340 extern struct symbol
*fixup_symbol_section (struct symbol
*,
1343 extern struct partial_symbol
*fixup_psymbol_section (struct partial_symbol
1345 struct objfile
*objfile
);
1347 /* Symbol searching */
1349 /* When using search_symbols, a list of the following structs is returned.
1350 Callers must free the search list using free_search_symbols! */
1351 struct symbol_search
1353 /* The block in which the match was found. Could be, for example,
1354 STATIC_BLOCK or GLOBAL_BLOCK. */
1357 /* Information describing what was found.
1359 If symtab abd symbol are NOT NULL, then information was found
1361 struct symtab
*symtab
;
1362 struct symbol
*symbol
;
1364 /* If msymbol is non-null, then a match was made on something for
1365 which only minimal_symbols exist. */
1366 struct minimal_symbol
*msymbol
;
1368 /* A link to the next match, or NULL for the end. */
1369 struct symbol_search
*next
;
1372 extern void search_symbols (char *, namespace_enum
, int, char **,
1373 struct symbol_search
**);
1374 extern void free_search_symbols (struct symbol_search
*);
1375 extern struct cleanup
*make_cleanup_free_search_symbols (struct symbol_search
1378 /* The name of the ``main'' function.
1379 FIXME: cagney/2001-03-20: Can't make main_name() const since some
1380 of the calling code currently assumes that the string isn't
1382 extern void set_main_name (const char *name
);
1383 extern /*const */ char *main_name (void);
1385 #endif /* !defined(SYMTAB_H) */