1 /* Symbol table definitions for GDB.
2 Copyright 1986, 1988, 1989, 1990, 1991, 1992, 1993, 1994, 1995, 1996,
3 1997, 1998, 1999, 2000, 2001
4 Free Software Foundation, Inc.
6 This file is part of GDB.
8 This program is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 2 of the License, or
11 (at your option) any later version.
13 This program is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with this program; if not, write to the Free Software
20 Foundation, Inc., 59 Temple Place - Suite 330,
21 Boston, MA 02111-1307, USA. */
23 #if !defined (SYMTAB_H)
26 /* Some definitions and declarations to go with use of obstacks. */
29 #define obstack_chunk_alloc xmalloc
30 #define obstack_chunk_free xfree
33 /* Don't do this; it means that if some .o's are compiled with GNU C
34 and some are not (easy to do accidentally the way we configure
35 things; also it is a pain to have to "make clean" every time you
36 want to switch compilers), then GDB dies a horrible death. */
37 /* GNU C supports enums that are bitfields. Some compilers don't. */
38 #if 0 && defined(__GNUC__) && !defined(BYTE_BITFIELD)
39 #define BYTE_BITFIELD :8;
41 #define BYTE_BITFIELD /*nothing */
44 /* Define a structure for the information that is common to all symbol types,
45 including minimal symbols, partial symbols, and full symbols. In a
46 multilanguage environment, some language specific information may need to
47 be recorded along with each symbol.
49 These fields are ordered to encourage good packing, since we frequently
50 have tens or hundreds of thousands of these. */
52 struct general_symbol_info
54 /* Name of the symbol. This is a required field. Storage for the name is
55 allocated on the psymbol_obstack or symbol_obstack for the associated
60 /* Value of the symbol. Which member of this union to use, and what
61 it means, depends on what kind of symbol this is and its
62 SYMBOL_CLASS. See comments there for more details. All of these
63 are in host byte order (though what they point to might be in
64 target byte order, e.g. LOC_CONST_BYTES). */
68 /* The fact that this is a long not a LONGEST mainly limits the
69 range of a LOC_CONST. Since LOC_CONST_BYTES exists, I'm not
70 sure that is a big deal. */
79 /* for opaque typedef struct chain */
85 /* Since one and only one language can apply, wrap the language specific
86 information inside a union. */
90 struct cplus_specific
/* For C++ */
96 struct chill_specific
/* For Chill */
104 /* Record the source code language that applies to this symbol.
105 This is used to select one of the fields from the language specific
108 enum language language BYTE_BITFIELD
;
110 /* Which section is this symbol in? This is an index into
111 section_offsets for this objfile. Negative means that the symbol
112 does not get relocated relative to a section.
113 Disclaimer: currently this is just used for xcoff, so don't
114 expect all symbol-reading code to set it correctly (the ELF code
115 also tries to set it correctly). */
119 /* The bfd section associated with this symbol. */
121 asection
*bfd_section
;
124 extern CORE_ADDR
symbol_overlayed_address (CORE_ADDR
, asection
*);
126 #define SYMBOL_NAME(symbol) (symbol)->ginfo.name
127 #define SYMBOL_VALUE(symbol) (symbol)->ginfo.value.ivalue
128 #define SYMBOL_VALUE_ADDRESS(symbol) (symbol)->ginfo.value.address
129 #define SYMBOL_VALUE_BYTES(symbol) (symbol)->ginfo.value.bytes
130 #define SYMBOL_BLOCK_VALUE(symbol) (symbol)->ginfo.value.block
131 #define SYMBOL_VALUE_CHAIN(symbol) (symbol)->ginfo.value.chain
132 #define SYMBOL_LANGUAGE(symbol) (symbol)->ginfo.language
133 #define SYMBOL_SECTION(symbol) (symbol)->ginfo.section
134 #define SYMBOL_BFD_SECTION(symbol) (symbol)->ginfo.bfd_section
136 #define SYMBOL_CPLUS_DEMANGLED_NAME(symbol) \
137 (symbol)->ginfo.language_specific.cplus_specific.demangled_name
139 /* Macro that initializes the language dependent portion of a symbol
140 depending upon the language for the symbol. */
142 #define SYMBOL_INIT_LANGUAGE_SPECIFIC(symbol,language) \
144 SYMBOL_LANGUAGE (symbol) = language; \
145 if (SYMBOL_LANGUAGE (symbol) == language_cplus \
146 || SYMBOL_LANGUAGE (symbol) == language_java \
149 SYMBOL_CPLUS_DEMANGLED_NAME (symbol) = NULL; \
151 else if (SYMBOL_LANGUAGE (symbol) == language_chill) \
153 SYMBOL_CHILL_DEMANGLED_NAME (symbol) = NULL; \
157 memset (&(symbol)->ginfo.language_specific, 0, \
158 sizeof ((symbol)->ginfo.language_specific)); \
162 #define SYMBOL_INIT_DEMANGLED_NAME(symbol,obstack) \
163 (symbol_init_demangled_name (&symbol->ginfo, (obstack)))
164 extern void symbol_init_demangled_name (struct general_symbol_info
*symbol
,
165 struct obstack
*obstack
);
168 /* Macro that returns the demangled name for a symbol based on the language
169 for that symbol. If no demangled name exists, returns NULL. */
171 #define SYMBOL_DEMANGLED_NAME(symbol) \
172 (SYMBOL_LANGUAGE (symbol) == language_cplus \
173 || SYMBOL_LANGUAGE (symbol) == language_java \
174 ? SYMBOL_CPLUS_DEMANGLED_NAME (symbol) \
175 : (SYMBOL_LANGUAGE (symbol) == language_chill \
176 ? SYMBOL_CHILL_DEMANGLED_NAME (symbol) \
179 #define SYMBOL_CHILL_DEMANGLED_NAME(symbol) \
180 (symbol)->ginfo.language_specific.chill_specific.demangled_name
182 /* Macro that returns the "natural source name" of a symbol. In C++ this is
183 the "demangled" form of the name if demangle is on and the "mangled" form
184 of the name if demangle is off. In other languages this is just the
185 symbol name. The result should never be NULL. */
187 #define SYMBOL_SOURCE_NAME(symbol) \
188 (demangle && SYMBOL_DEMANGLED_NAME (symbol) != NULL \
189 ? SYMBOL_DEMANGLED_NAME (symbol) \
190 : SYMBOL_NAME (symbol))
192 /* Macro that returns the "natural assembly name" of a symbol. In C++ this is
193 the "mangled" form of the name if demangle is off, or if demangle is on and
194 asm_demangle is off. Otherwise if asm_demangle is on it is the "demangled"
195 form. In other languages this is just the symbol name. The result should
198 #define SYMBOL_LINKAGE_NAME(symbol) \
199 (demangle && asm_demangle && SYMBOL_DEMANGLED_NAME (symbol) != NULL \
200 ? SYMBOL_DEMANGLED_NAME (symbol) \
201 : SYMBOL_NAME (symbol))
203 /* Macro that tests a symbol for a match against a specified name string.
204 First test the unencoded name, then looks for and test a C++ encoded
205 name if it exists. Note that whitespace is ignored while attempting to
206 match a C++ encoded name, so that "foo::bar(int,long)" is the same as
207 "foo :: bar (int, long)".
208 Evaluates to zero if the match fails, or nonzero if it succeeds. */
210 #define SYMBOL_MATCHES_NAME(symbol, name) \
211 (STREQ (SYMBOL_NAME (symbol), (name)) \
212 || (SYMBOL_DEMANGLED_NAME (symbol) != NULL \
213 && strcmp_iw (SYMBOL_DEMANGLED_NAME (symbol), (name)) == 0))
215 /* Macro that tests a symbol for an re-match against the last compiled regular
216 expression. First test the unencoded name, then look for and test a C++
217 encoded name if it exists.
218 Evaluates to zero if the match fails, or nonzero if it succeeds. */
220 #define SYMBOL_MATCHES_REGEXP(symbol) \
221 (re_exec (SYMBOL_NAME (symbol)) != 0 \
222 || (SYMBOL_DEMANGLED_NAME (symbol) != NULL \
223 && re_exec (SYMBOL_DEMANGLED_NAME (symbol)) != 0))
225 /* Define a simple structure used to hold some very basic information about
226 all defined global symbols (text, data, bss, abs, etc). The only required
227 information is the general_symbol_info.
229 In many cases, even if a file was compiled with no special options for
230 debugging at all, as long as was not stripped it will contain sufficient
231 information to build a useful minimal symbol table using this structure.
232 Even when a file contains enough debugging information to build a full
233 symbol table, these minimal symbols are still useful for quickly mapping
234 between names and addresses, and vice versa. They are also sometimes
235 used to figure out what full symbol table entries need to be read in. */
237 struct minimal_symbol
240 /* The general symbol info required for all types of symbols.
242 The SYMBOL_VALUE_ADDRESS contains the address that this symbol
245 struct general_symbol_info ginfo
;
247 /* The info field is available for caching machine-specific information
248 so it doesn't have to rederive the info constantly (over a serial line).
249 It is initialized to zero and stays that way until target-dependent code
250 sets it. Storage for any data pointed to by this field should be allo-
251 cated on the symbol_obstack for the associated objfile.
252 The type would be "void *" except for reasons of compatibility with older
253 compilers. This field is optional.
255 Currently, the AMD 29000 tdep.c uses it to remember things it has decoded
256 from the instructions in the function header, and the MIPS-16 code uses
257 it to identify 16-bit procedures. */
261 #ifdef SOFUN_ADDRESS_MAYBE_MISSING
262 /* Which source file is this symbol in? Only relevant for mst_file_*. */
266 /* Classification types for this symbol. These should be taken as "advisory
267 only", since if gdb can't easily figure out a classification it simply
268 selects mst_unknown. It may also have to guess when it can't figure out
269 which is a better match between two types (mst_data versus mst_bss) for
270 example. Since the minimal symbol info is sometimes derived from the
271 BFD library's view of a file, we need to live with what information bfd
274 enum minimal_symbol_type
276 mst_unknown
= 0, /* Unknown type, the default */
277 mst_text
, /* Generally executable instructions */
278 mst_data
, /* Generally initialized data */
279 mst_bss
, /* Generally uninitialized data */
280 mst_abs
, /* Generally absolute (nonrelocatable) */
281 /* GDB uses mst_solib_trampoline for the start address of a shared
282 library trampoline entry. Breakpoints for shared library functions
283 are put there if the shared library is not yet loaded.
284 After the shared library is loaded, lookup_minimal_symbol will
285 prefer the minimal symbol from the shared library (usually
286 a mst_text symbol) over the mst_solib_trampoline symbol, and the
287 breakpoints will be moved to their true address in the shared
288 library via breakpoint_re_set. */
289 mst_solib_trampoline
, /* Shared library trampoline code */
290 /* For the mst_file* types, the names are only guaranteed to be unique
291 within a given .o file. */
292 mst_file_text
, /* Static version of mst_text */
293 mst_file_data
, /* Static version of mst_data */
294 mst_file_bss
/* Static version of mst_bss */
298 /* Minimal symbols with the same hash key are kept on a linked
299 list. This is the link. */
301 struct minimal_symbol
*hash_next
;
303 /* Minimal symbols are stored in two different hash tables. This is
304 the `next' pointer for the demangled hash table. */
306 struct minimal_symbol
*demangled_hash_next
;
309 #define MSYMBOL_INFO(msymbol) (msymbol)->info
310 #define MSYMBOL_TYPE(msymbol) (msymbol)->type
314 /* All of the name-scope contours of the program
315 are represented by `struct block' objects.
316 All of these objects are pointed to by the blockvector.
318 Each block represents one name scope.
319 Each lexical context has its own block.
321 The blockvector begins with some special blocks.
322 The GLOBAL_BLOCK contains all the symbols defined in this compilation
323 whose scope is the entire program linked together.
324 The STATIC_BLOCK contains all the symbols whose scope is the
325 entire compilation excluding other separate compilations.
326 Blocks starting with the FIRST_LOCAL_BLOCK are not special.
328 Each block records a range of core addresses for the code that
329 is in the scope of the block. The STATIC_BLOCK and GLOBAL_BLOCK
330 give, for the range of code, the entire range of code produced
331 by the compilation that the symbol segment belongs to.
333 The blocks appear in the blockvector
334 in order of increasing starting-address,
335 and, within that, in order of decreasing ending-address.
337 This implies that within the body of one function
338 the blocks appear in the order of a depth-first tree walk. */
342 /* Number of blocks in the list. */
344 /* The blocks themselves. */
345 struct block
*block
[1];
348 #define BLOCKVECTOR_NBLOCKS(blocklist) (blocklist)->nblocks
349 #define BLOCKVECTOR_BLOCK(blocklist,n) (blocklist)->block[n]
351 /* Special block numbers */
353 #define GLOBAL_BLOCK 0
354 #define STATIC_BLOCK 1
355 #define FIRST_LOCAL_BLOCK 2
360 /* Addresses in the executable code that are in this block. */
365 /* The symbol that names this block, if the block is the body of a
366 function; otherwise, zero. */
368 struct symbol
*function
;
370 /* The `struct block' for the containing block, or 0 if none.
372 The superblock of a top-level local block (i.e. a function in the
373 case of C) is the STATIC_BLOCK. The superblock of the
374 STATIC_BLOCK is the GLOBAL_BLOCK. */
376 struct block
*superblock
;
378 /* Version of GCC used to compile the function corresponding
379 to this block, or 0 if not compiled with GCC. When possible,
380 GCC should be compatible with the native compiler, or if that
381 is not feasible, the differences should be fixed during symbol
382 reading. As of 16 Apr 93, this flag is never used to distinguish
383 between gcc2 and the native compiler.
385 If there is no function corresponding to this block, this meaning
386 of this flag is undefined. */
388 unsigned char gcc_compile_flag
;
390 /* Number of local symbols. */
394 /* The symbols. If some of them are arguments, then they must be
395 in the order in which we would like to print them. */
397 struct symbol
*sym
[1];
400 #define BLOCK_START(bl) (bl)->startaddr
401 #define BLOCK_END(bl) (bl)->endaddr
402 #define BLOCK_NSYMS(bl) (bl)->nsyms
403 #define BLOCK_SYM(bl, n) (bl)->sym[n]
404 #define BLOCK_FUNCTION(bl) (bl)->function
405 #define BLOCK_SUPERBLOCK(bl) (bl)->superblock
406 #define BLOCK_GCC_COMPILED(bl) (bl)->gcc_compile_flag
408 /* Macro to loop through all symbols in a block BL.
409 i counts which symbol we are looking at, and sym points to the current
411 #define ALL_BLOCK_SYMBOLS(bl, i, sym) \
412 for ((i) = 0, (sym) = BLOCK_SYM ((bl), (i)); \
413 (i) < BLOCK_NSYMS ((bl)); \
414 ++(i), (sym) = BLOCK_SYM ((bl), (i)))
416 /* Nonzero if symbols of block BL should be sorted alphabetically.
417 Don't sort a block which corresponds to a function. If we did the
418 sorting would have to preserve the order of the symbols for the
421 #define BLOCK_SHOULD_SORT(bl) ((bl)->nsyms >= 40 && BLOCK_FUNCTION (bl) == NULL)
424 /* Represent one symbol name; a variable, constant, function or typedef. */
426 /* Different name spaces for symbols. Looking up a symbol specifies a
427 namespace and ignores symbol definitions in other name spaces. */
431 /* UNDEF_NAMESPACE is used when a namespace has not been discovered or
432 none of the following apply. This usually indicates an error either
433 in the symbol information or in gdb's handling of symbols. */
437 /* VAR_NAMESPACE is the usual namespace. In C, this contains variables,
438 function names, typedef names and enum type values. */
442 /* STRUCT_NAMESPACE is used in C to hold struct, union and enum type names.
443 Thus, if `struct foo' is used in a C program, it produces a symbol named
444 `foo' in the STRUCT_NAMESPACE. */
448 /* LABEL_NAMESPACE may be used for names of labels (for gotos);
449 currently it is not used and labels are not recorded at all. */
453 /* Searching namespaces. These overlap with VAR_NAMESPACE, providing
454 some granularity with the search_symbols function. */
456 /* Everything in VAR_NAMESPACE minus FUNCTIONS_-, TYPES_-, and
460 /* All functions -- for some reason not methods, though. */
463 /* All defined types */
466 /* All class methods -- why is this separated out? */
472 /* An address-class says where to find the value of a symbol. */
476 /* Not used; catches errors */
480 /* Value is constant int SYMBOL_VALUE, host byteorder */
484 /* Value is at fixed address SYMBOL_VALUE_ADDRESS */
488 /* Value is in register. SYMBOL_VALUE is the register number. */
492 /* It's an argument; the value is at SYMBOL_VALUE offset in arglist. */
496 /* Value address is at SYMBOL_VALUE offset in arglist. */
500 /* Value is in register number SYMBOL_VALUE. Just like LOC_REGISTER
501 except this is an argument. Probably the cleaner way to handle
502 this would be to separate address_class (which would include
503 separate ARG and LOCAL to deal with FRAME_ARGS_ADDRESS versus
504 FRAME_LOCALS_ADDRESS), and an is_argument flag.
506 For some symbol formats (stabs, for some compilers at least),
507 the compiler generates two symbols, an argument and a register.
508 In some cases we combine them to a single LOC_REGPARM in symbol
509 reading, but currently not for all cases (e.g. it's passed on the
510 stack and then loaded into a register). */
514 /* Value is in specified register. Just like LOC_REGPARM except the
515 register holds the address of the argument instead of the argument
516 itself. This is currently used for the passing of structs and unions
517 on sparc and hppa. It is also used for call by reference where the
518 address is in a register, at least by mipsread.c. */
522 /* Value is a local variable at SYMBOL_VALUE offset in stack frame. */
526 /* Value not used; definition in SYMBOL_TYPE. Symbols in the namespace
527 STRUCT_NAMESPACE all have this class. */
531 /* Value is address SYMBOL_VALUE_ADDRESS in the code */
535 /* In a symbol table, value is SYMBOL_BLOCK_VALUE of a `struct block'.
536 In a partial symbol table, SYMBOL_VALUE_ADDRESS is the start address
537 of the block. Function names have this class. */
541 /* Value is a constant byte-sequence pointed to by SYMBOL_VALUE_BYTES, in
542 target byte order. */
546 /* Value is arg at SYMBOL_VALUE offset in stack frame. Differs from
547 LOC_LOCAL in that symbol is an argument; differs from LOC_ARG in
548 that we find it in the frame (FRAME_LOCALS_ADDRESS), not in the
549 arglist (FRAME_ARGS_ADDRESS). Added for i960, which passes args
550 in regs then copies to frame. */
554 /* Value is at SYMBOL_VALUE offset from the current value of
555 register number SYMBOL_BASEREG. This exists mainly for the same
556 things that LOC_LOCAL and LOC_ARG do; but we need to do this
557 instead because on 88k DWARF gives us the offset from the
558 frame/stack pointer, rather than the offset from the "canonical
559 frame address" used by COFF, stabs, etc., and we don't know how
560 to convert between these until we start examining prologues.
562 Note that LOC_BASEREG is much less general than a DWARF expression.
563 We don't need the generality (at least not yet), and storing a general
564 DWARF expression would presumably take up more space than the existing
569 /* Same as LOC_BASEREG but it is an argument. */
573 /* Value is at fixed address, but the address of the variable has
574 to be determined from the minimal symbol table whenever the
575 variable is referenced.
576 This happens if debugging information for a global symbol is
577 emitted and the corresponding minimal symbol is defined
578 in another object file or runtime common storage.
579 The linker might even remove the minimal symbol if the global
580 symbol is never referenced, in which case the symbol remains
585 /* Value is at a thread-specific location calculated by a
586 target-specific method. */
588 LOC_THREAD_LOCAL_STATIC
,
590 /* The variable does not actually exist in the program.
591 The value is ignored. */
595 /* The variable is static, but actually lives at * (address).
596 * I.e. do an extra indirection to get to it.
597 * This is used on HP-UX to get at globals that are allocated
598 * in shared libraries, where references from images other
599 * than the one where the global was allocated are done
600 * with a level of indirection.
607 /* Linked list of symbol's live ranges. */
613 struct range_list
*next
;
616 /* Linked list of aliases for a particular main/primary symbol. */
620 struct alias_list
*next
;
626 /* The general symbol info required for all types of symbols. */
628 struct general_symbol_info ginfo
;
630 /* Data type of value */
634 /* Name space code. */
637 /* FIXME: don't conflict with C++'s namespace */
638 /* would be safer to do a global change for all namespace identifiers. */
639 #define namespace _namespace
641 namespace_enum
namespace BYTE_BITFIELD
;
645 enum address_class aclass BYTE_BITFIELD
;
647 /* Line number of definition. FIXME: Should we really make the assumption
648 that nobody will try to debug files longer than 64K lines? What about
649 machine generated programs? */
653 /* Some symbols require an additional value to be recorded on a per-
654 symbol basis. Stash those values here. */
658 /* Used by LOC_BASEREG and LOC_BASEREG_ARG. */
664 /* Link to a list of aliases for this symbol.
665 Only a "primary/main symbol may have aliases. */
666 struct alias_list
*aliases
;
668 /* List of ranges where this symbol is active. This is only
669 used by alias symbols at the current time. */
670 struct range_list
*ranges
;
674 #define SYMBOL_NAMESPACE(symbol) (symbol)->namespace
675 #define SYMBOL_CLASS(symbol) (symbol)->aclass
676 #define SYMBOL_TYPE(symbol) (symbol)->type
677 #define SYMBOL_LINE(symbol) (symbol)->line
678 #define SYMBOL_BASEREG(symbol) (symbol)->aux_value.basereg
679 #define SYMBOL_ALIASES(symbol) (symbol)->aliases
680 #define SYMBOL_RANGES(symbol) (symbol)->ranges
682 /* A partial_symbol records the name, namespace, and address class of
683 symbols whose types we have not parsed yet. For functions, it also
684 contains their memory address, so we can find them from a PC value.
685 Each partial_symbol sits in a partial_symtab, all of which are chained
686 on a partial symtab list and which points to the corresponding
687 normal symtab once the partial_symtab has been referenced. */
689 struct partial_symbol
692 /* The general symbol info required for all types of symbols. */
694 struct general_symbol_info ginfo
;
696 /* Name space code. */
698 namespace_enum
namespace BYTE_BITFIELD
;
700 /* Address class (for info_symbols) */
702 enum address_class aclass BYTE_BITFIELD
;
706 #define PSYMBOL_NAMESPACE(psymbol) (psymbol)->namespace
707 #define PSYMBOL_CLASS(psymbol) (psymbol)->aclass
710 /* Source-file information. This describes the relation between source files,
711 line numbers and addresses in the program text. */
715 int length
; /* Number of source files described */
716 struct source
*source
[1]; /* Descriptions of the files */
719 /* Each item represents a line-->pc (or the reverse) mapping. This is
720 somewhat more wasteful of space than one might wish, but since only
721 the files which are actually debugged are read in to core, we don't
724 struct linetable_entry
730 /* The order of entries in the linetable is significant. They should
731 be sorted by increasing values of the pc field. If there is more than
732 one entry for a given pc, then I'm not sure what should happen (and
733 I not sure whether we currently handle it the best way).
735 Example: a C for statement generally looks like this
737 10 0x100 - for the init/test part of a for stmt.
740 10 0x400 - for the increment part of a for stmt.
742 If an entry has a line number of zero, it marks the start of a PC
743 range for which no line number information is available. It is
744 acceptable, though wasteful of table space, for such a range to be
751 /* Actually NITEMS elements. If you don't like this use of the
752 `struct hack', you can shove it up your ANSI (seriously, if the
753 committee tells us how to do it, we can probably go along). */
754 struct linetable_entry item
[1];
757 /* All the information on one source file. */
761 char *name
; /* Name of file */
762 struct linetable contents
;
765 /* How to relocate the symbols from each section in a symbol file.
766 Each struct contains an array of offsets.
767 The ordering and meaning of the offsets is file-type-dependent;
768 typically it is indexed by section numbers or symbol types or
771 To give us flexibility in changing the internal representation
772 of these offsets, the ANOFFSET macro must be used to insert and
773 extract offset values in the struct. */
775 struct section_offsets
777 CORE_ADDR offsets
[1]; /* As many as needed. */
780 #define ANOFFSET(secoff, whichone) \
782 ? (internal_error (__FILE__, __LINE__, "Section index is uninitialized"), -1) \
783 : secoff->offsets[whichone])
785 /* The maximum possible size of a section_offsets table. */
787 #define SIZEOF_SECTION_OFFSETS \
788 (sizeof (struct section_offsets) \
789 + sizeof (((struct section_offsets *) 0)->offsets) * (SECT_OFF_MAX-1))
791 /* Each source file or header is represented by a struct symtab.
792 These objects are chained through the `next' field. */
797 /* Chain of all existing symtabs. */
801 /* List of all symbol scope blocks for this symtab. May be shared
802 between different symtabs (and normally is for all the symtabs
803 in a given compilation unit). */
805 struct blockvector
*blockvector
;
807 /* Table mapping core addresses to line numbers for this file.
808 Can be NULL if none. Never shared between different symtabs. */
810 struct linetable
*linetable
;
812 /* Section in objfile->section_offsets for the blockvector and
813 the linetable. Probably always SECT_OFF_TEXT. */
815 int block_line_section
;
817 /* If several symtabs share a blockvector, exactly one of them
818 should be designated the primary, so that the blockvector
819 is relocated exactly once by objfile_relocate. */
823 /* Name of this source file. */
827 /* Directory in which it was compiled, or NULL if we don't know. */
831 /* This component says how to free the data we point to:
832 free_contents => do a tree walk and free each object.
833 free_nothing => do nothing; some other symtab will free
834 the data this one uses.
835 free_linetable => free just the linetable. FIXME: Is this redundant
836 with the primary field? */
840 free_nothing
, free_contents
, free_linetable
844 /* Pointer to one block of storage to be freed, if nonzero. */
845 /* This is IN ADDITION to the action indicated by free_code. */
849 /* Total number of lines found in source file. */
853 /* line_charpos[N] is the position of the (N-1)th line of the
854 source file. "position" means something we can lseek() to; it
855 is not guaranteed to be useful any other way. */
859 /* Language of this source file. */
861 enum language language
;
863 /* String that identifies the format of the debugging information, such
864 as "stabs", "dwarf 1", "dwarf 2", "coff", etc. This is mostly useful
865 for automated testing of gdb but may also be information that is
866 useful to the user. */
870 /* String of version information. May be zero. */
874 /* Full name of file as found by searching the source path.
875 NULL if not yet known. */
879 /* Object file from which this symbol information was read. */
881 struct objfile
*objfile
;
885 #define BLOCKVECTOR(symtab) (symtab)->blockvector
886 #define LINETABLE(symtab) (symtab)->linetable
889 /* Each source file that has not been fully read in is represented by
890 a partial_symtab. This contains the information on where in the
891 executable the debugging symbols for a specific file are, and a
892 list of names of global symbols which are located in this file.
893 They are all chained on partial symtab lists.
895 Even after the source file has been read into a symtab, the
896 partial_symtab remains around. They are allocated on an obstack,
897 psymbol_obstack. FIXME, this is bad for dynamic linking or VxWorks-
898 style execution of a bunch of .o's. */
900 struct partial_symtab
903 /* Chain of all existing partial symtabs. */
905 struct partial_symtab
*next
;
907 /* Name of the source file which this partial_symtab defines */
911 /* Full path of the source file. NULL if not known. */
915 /* Information about the object file from which symbols should be read. */
917 struct objfile
*objfile
;
919 /* Set of relocation offsets to apply to each section. */
921 struct section_offsets
*section_offsets
;
923 /* Range of text addresses covered by this file; texthigh is the
924 beginning of the next section. */
929 /* Array of pointers to all of the partial_symtab's which this one
930 depends on. Since this array can only be set to previous or
931 the current (?) psymtab, this dependency tree is guaranteed not
932 to have any loops. "depends on" means that symbols must be read
933 for the dependencies before being read for this psymtab; this is
934 for type references in stabs, where if foo.c includes foo.h, declarations
935 in foo.h may use type numbers defined in foo.c. For other debugging
936 formats there may be no need to use dependencies. */
938 struct partial_symtab
**dependencies
;
940 int number_of_dependencies
;
942 /* Global symbol list. This list will be sorted after readin to
943 improve access. Binary search will be the usual method of
944 finding a symbol within it. globals_offset is an integer offset
945 within global_psymbols[]. */
950 /* Static symbol list. This list will *not* be sorted after readin;
951 to find a symbol in it, exhaustive search must be used. This is
952 reasonable because searches through this list will eventually
953 lead to either the read in of a files symbols for real (assumed
954 to take a *lot* of time; check) or an error (and we don't care
955 how long errors take). This is an offset and size within
956 static_psymbols[]. */
961 /* Pointer to symtab eventually allocated for this source file, 0 if
962 !readin or if we haven't looked for the symtab after it was readin. */
964 struct symtab
*symtab
;
966 /* Pointer to function which will read in the symtab corresponding to
969 void (*read_symtab
) (struct partial_symtab
*);
971 /* Information that lets read_symtab() locate the part of the symbol table
972 that this psymtab corresponds to. This information is private to the
973 format-dependent symbol reading routines. For further detail examine
974 the various symbol reading modules. Should really be (void *) but is
975 (char *) as with other such gdb variables. (FIXME) */
977 char *read_symtab_private
;
979 /* Non-zero if the symtab corresponding to this psymtab has been readin */
981 unsigned char readin
;
984 /* A fast way to get from a psymtab to its symtab (after the first time). */
985 #define PSYMTAB_TO_SYMTAB(pst) \
986 ((pst) -> symtab != NULL ? (pst) -> symtab : psymtab_to_symtab (pst))
989 /* The virtual function table is now an array of structures which have the
990 form { int16 offset, delta; void *pfn; }.
992 In normal virtual function tables, OFFSET is unused.
993 DELTA is the amount which is added to the apparent object's base
994 address in order to point to the actual object to which the
995 virtual function should be applied.
996 PFN is a pointer to the virtual function.
998 Note that this macro is g++ specific (FIXME). */
1000 #define VTBL_FNADDR_OFFSET 2
1002 /* External variables and functions for the objects described above. */
1004 /* This symtab variable specifies the current file for printing source lines */
1006 extern struct symtab
*current_source_symtab
;
1008 /* This is the next line to print for listing source lines. */
1010 extern int current_source_line
;
1012 /* See the comment in symfile.c about how current_objfile is used. */
1014 extern struct objfile
*current_objfile
;
1016 /* True if we are nested inside psymtab_to_symtab. */
1018 extern int currently_reading_symtab
;
1021 extern int demangle
;
1022 extern int asm_demangle
;
1024 /* symtab.c lookup functions */
1026 /* lookup a symbol table by source file name */
1028 extern struct symtab
*lookup_symtab (const char *);
1030 /* lookup a symbol by name (optional block, optional symtab) */
1032 extern struct symbol
*lookup_symbol (const char *, const struct block
*,
1033 const namespace_enum
, int *,
1036 /* lookup a symbol by name, within a specified block */
1038 extern struct symbol
*lookup_block_symbol (const struct block
*, const char *,
1040 const namespace_enum
);
1042 /* lookup a [struct, union, enum] by name, within a specified block */
1044 extern struct type
*lookup_struct (char *, struct block
*);
1046 extern struct type
*lookup_union (char *, struct block
*);
1048 extern struct type
*lookup_enum (char *, struct block
*);
1050 /* lookup the function corresponding to the block */
1052 extern struct symbol
*block_function (struct block
*);
1054 /* from blockframe.c: */
1056 /* lookup the function symbol corresponding to the address */
1058 extern struct symbol
*find_pc_function (CORE_ADDR
);
1060 /* lookup the function corresponding to the address and section */
1062 extern struct symbol
*find_pc_sect_function (CORE_ADDR
, asection
*);
1064 /* lookup function from address, return name, start addr and end addr */
1067 find_pc_partial_function (CORE_ADDR
, char **, CORE_ADDR
*, CORE_ADDR
*);
1069 extern void clear_pc_function_cache (void);
1072 find_pc_sect_partial_function (CORE_ADDR
, asection
*,
1073 char **, CORE_ADDR
*, CORE_ADDR
*);
1075 /* from symtab.c: */
1077 /* lookup partial symbol table by filename */
1079 extern struct partial_symtab
*lookup_partial_symtab (const char *);
1081 /* lookup partial symbol table by address */
1083 extern struct partial_symtab
*find_pc_psymtab (CORE_ADDR
);
1085 /* lookup partial symbol table by address and section */
1087 extern struct partial_symtab
*find_pc_sect_psymtab (CORE_ADDR
, asection
*);
1089 /* lookup full symbol table by address */
1091 extern struct symtab
*find_pc_symtab (CORE_ADDR
);
1093 /* lookup full symbol table by address and section */
1095 extern struct symtab
*find_pc_sect_symtab (CORE_ADDR
, asection
*);
1097 /* lookup partial symbol by address */
1099 extern struct partial_symbol
*find_pc_psymbol (struct partial_symtab
*,
1102 /* lookup partial symbol by address and section */
1104 extern struct partial_symbol
*find_pc_sect_psymbol (struct partial_symtab
*,
1105 CORE_ADDR
, asection
*);
1107 extern int find_pc_line_pc_range (CORE_ADDR
, CORE_ADDR
*, CORE_ADDR
*);
1109 extern int contained_in (struct block
*, struct block
*);
1111 extern void reread_symbols (void);
1113 extern struct type
*lookup_transparent_type (const char *);
1116 /* Macro for name of symbol to indicate a file compiled with gcc. */
1117 #ifndef GCC_COMPILED_FLAG_SYMBOL
1118 #define GCC_COMPILED_FLAG_SYMBOL "gcc_compiled."
1121 /* Macro for name of symbol to indicate a file compiled with gcc2. */
1122 #ifndef GCC2_COMPILED_FLAG_SYMBOL
1123 #define GCC2_COMPILED_FLAG_SYMBOL "gcc2_compiled."
1126 /* Functions for dealing with the minimal symbol table, really a misc
1127 address<->symbol mapping for things we don't have debug symbols for. */
1129 extern void prim_record_minimal_symbol (const char *, CORE_ADDR
,
1130 enum minimal_symbol_type
,
1133 extern struct minimal_symbol
*prim_record_minimal_symbol_and_info
1134 (const char *, CORE_ADDR
,
1135 enum minimal_symbol_type
,
1136 char *info
, int section
, asection
* bfd_section
, struct objfile
*);
1138 #ifdef SOFUN_ADDRESS_MAYBE_MISSING
1139 extern CORE_ADDR
find_stab_function_addr (char *, char *, struct objfile
*);
1142 extern unsigned int msymbol_hash_iw (const char *);
1144 extern unsigned int msymbol_hash (const char *);
1147 add_minsym_to_hash_table (struct minimal_symbol
*sym
,
1148 struct minimal_symbol
**table
);
1150 extern struct minimal_symbol
*lookup_minimal_symbol (const char *,
1154 extern struct minimal_symbol
*lookup_minimal_symbol_text (const char *,
1158 struct minimal_symbol
*lookup_minimal_symbol_solib_trampoline (const char *,
1163 extern struct minimal_symbol
*lookup_minimal_symbol_by_pc (CORE_ADDR
);
1165 extern struct minimal_symbol
*lookup_minimal_symbol_by_pc_section (CORE_ADDR
,
1169 extern struct minimal_symbol
1170 *lookup_solib_trampoline_symbol_by_pc (CORE_ADDR
);
1172 extern CORE_ADDR
find_solib_trampoline_target (CORE_ADDR
);
1174 extern void init_minimal_symbol_collection (void);
1176 extern struct cleanup
*make_cleanup_discard_minimal_symbols (void);
1178 extern void install_minimal_symbols (struct objfile
*);
1180 /* Sort all the minimal symbols in OBJFILE. */
1182 extern void msymbols_sort (struct objfile
*objfile
);
1184 struct symtab_and_line
1186 struct symtab
*symtab
;
1188 /* Line number. Line numbers start at 1 and proceed through symtab->nlines.
1189 0 is never a valid line number; it is used to indicate that line number
1190 information is not available. */
1197 #define INIT_SAL(sal) { \
1198 (sal)->symtab = 0; \
1199 (sal)->section = 0; \
1205 struct symtabs_and_lines
1207 struct symtab_and_line
*sals
;
1213 /* Some types and macros needed for exception catchpoints.
1214 Can't put these in target.h because symtab_and_line isn't
1215 known there. This file will be included by breakpoint.c,
1216 hppa-tdep.c, etc. */
1218 /* Enums for exception-handling support */
1219 enum exception_event_kind
1225 /* Type for returning info about an exception */
1226 struct exception_event_record
1228 enum exception_event_kind kind
;
1229 struct symtab_and_line throw_sal
;
1230 struct symtab_and_line catch_sal
;
1231 /* This may need to be extended in the future, if
1232 some platforms allow reporting more information,
1233 such as point of rethrow, type of exception object,
1234 type expected by catch clause, etc. */
1237 #define CURRENT_EXCEPTION_KIND (current_exception_event->kind)
1238 #define CURRENT_EXCEPTION_CATCH_SAL (current_exception_event->catch_sal)
1239 #define CURRENT_EXCEPTION_CATCH_LINE (current_exception_event->catch_sal.line)
1240 #define CURRENT_EXCEPTION_CATCH_FILE (current_exception_event->catch_sal.symtab->filename)
1241 #define CURRENT_EXCEPTION_CATCH_PC (current_exception_event->catch_sal.pc)
1242 #define CURRENT_EXCEPTION_THROW_SAL (current_exception_event->throw_sal)
1243 #define CURRENT_EXCEPTION_THROW_LINE (current_exception_event->throw_sal.line)
1244 #define CURRENT_EXCEPTION_THROW_FILE (current_exception_event->throw_sal.symtab->filename)
1245 #define CURRENT_EXCEPTION_THROW_PC (current_exception_event->throw_sal.pc)
1248 /* Given a pc value, return line number it is in. Second arg nonzero means
1249 if pc is on the boundary use the previous statement's line number. */
1251 extern struct symtab_and_line
find_pc_line (CORE_ADDR
, int);
1253 /* Same function, but specify a section as well as an address */
1255 extern struct symtab_and_line
find_pc_sect_line (CORE_ADDR
, asection
*, int);
1257 /* Given an address, return the nearest symbol at or below it in memory.
1258 Optionally return the symtab it's from through 2nd arg, and the
1259 address in inferior memory of the symbol through 3rd arg. */
1261 extern struct symbol
*find_addr_symbol (CORE_ADDR
, struct symtab
**,
1264 /* Given a symtab and line number, return the pc there. */
1266 extern int find_line_pc (struct symtab
*, int, CORE_ADDR
*);
1269 find_line_pc_range (struct symtab_and_line
, CORE_ADDR
*, CORE_ADDR
*);
1271 extern void resolve_sal_pc (struct symtab_and_line
*);
1273 /* Given a string, return the line specified by it. For commands like "list"
1274 and "breakpoint". */
1276 extern struct symtabs_and_lines
decode_line_spec (char *, int);
1278 extern struct symtabs_and_lines
decode_line_spec_1 (char *, int);
1282 void maintenance_print_symbols (char *, int);
1284 void maintenance_print_psymbols (char *, int);
1286 void maintenance_print_msymbols (char *, int);
1288 void maintenance_print_objfiles (char *, int);
1290 void maintenance_check_symtabs (char *, int);
1294 void maintenance_print_statistics (char *, int);
1296 extern void free_symtab (struct symtab
*);
1298 /* Symbol-reading stuff in symfile.c and solib.c. */
1300 extern struct symtab
*psymtab_to_symtab (struct partial_symtab
*);
1302 extern void clear_solib (void);
1306 extern int identify_source_line (struct symtab
*, int, int, CORE_ADDR
);
1308 extern void print_source_lines (struct symtab
*, int, int, int);
1310 extern void forget_cached_source_info (void);
1312 extern void select_source_symtab (struct symtab
*);
1314 extern char **make_symbol_completion_list (char *, char *);
1316 extern char **make_file_symbol_completion_list (char *, char *, char *);
1318 extern struct symbol
**make_symbol_overload_list (struct symbol
*);
1320 extern char **make_source_files_completion_list (char *, char *);
1324 extern struct partial_symtab
*find_main_psymtab (void);
1326 extern struct symtab
*find_line_symtab (struct symtab
*, int, int *, int *);
1328 extern struct symtab_and_line
find_function_start_sal (struct symbol
*sym
, int);
1332 extern struct blockvector
*blockvector_for_pc (CORE_ADDR
, int *);
1334 extern struct blockvector
*blockvector_for_pc_sect (CORE_ADDR
, asection
*,
1335 int *, struct symtab
*);
1339 extern void clear_symtab_users (void);
1341 extern enum language
deduce_language_from_filename (char *);
1345 extern int in_prologue (CORE_ADDR pc
, CORE_ADDR func_start
);
1347 extern struct symbol
*fixup_symbol_section (struct symbol
*,
1350 extern struct partial_symbol
*fixup_psymbol_section (struct partial_symbol
1352 struct objfile
*objfile
);
1354 /* Symbol searching */
1356 /* When using search_symbols, a list of the following structs is returned.
1357 Callers must free the search list using free_search_symbols! */
1358 struct symbol_search
1360 /* The block in which the match was found. Could be, for example,
1361 STATIC_BLOCK or GLOBAL_BLOCK. */
1364 /* Information describing what was found.
1366 If symtab abd symbol are NOT NULL, then information was found
1368 struct symtab
*symtab
;
1369 struct symbol
*symbol
;
1371 /* If msymbol is non-null, then a match was made on something for
1372 which only minimal_symbols exist. */
1373 struct minimal_symbol
*msymbol
;
1375 /* A link to the next match, or NULL for the end. */
1376 struct symbol_search
*next
;
1379 extern void search_symbols (char *, namespace_enum
, int, char **,
1380 struct symbol_search
**);
1381 extern void free_search_symbols (struct symbol_search
*);
1382 extern struct cleanup
*make_cleanup_free_search_symbols (struct symbol_search
*);
1384 /* The name of the ``main'' function.
1385 FIXME: cagney/2001-03-20: Can't make main_name() const since some
1386 of the calling code currently assumes that the string isn't
1388 extern void set_main_name (const char *name
);
1389 extern /*const*/ char *main_name (void);
1391 #endif /* !defined(SYMTAB_H) */