1 /* Symbol table definitions for GDB.
2 Copyright 1986, 1989, 1991, 1992, 1993, 1994, 1995 Free Software Foundation, Inc.
4 This file is part of GDB.
6 This program is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2 of the License, or
9 (at your option) any later version.
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with this program; if not, write to the Free Software
18 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */
20 #if !defined (SYMTAB_H)
23 /* Some definitions and declarations to go with use of obstacks. */
26 #define obstack_chunk_alloc xmalloc
27 #define obstack_chunk_free free
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++ */
90 struct chill_specific
/* For Chill */
96 /* Record the source code language that applies to this symbol.
97 This is used to select one of the fields from the language specific
100 enum language language BYTE_BITFIELD
;
102 /* Which section is this symbol in? This is an index into
103 section_offsets for this objfile. Negative means that the symbol
104 does not get relocated relative to a section.
105 Disclaimer: currently this is just used for xcoff, so don't
106 expect all symbol-reading code to set it correctly (the ELF code
107 also tries to set it correctly). */
112 #define SYMBOL_NAME(symbol) (symbol)->ginfo.name
113 #define SYMBOL_VALUE(symbol) (symbol)->ginfo.value.ivalue
114 #define SYMBOL_VALUE_ADDRESS(symbol) (symbol)->ginfo.value.address
115 #define SYMBOL_VALUE_BYTES(symbol) (symbol)->ginfo.value.bytes
116 #define SYMBOL_BLOCK_VALUE(symbol) (symbol)->ginfo.value.block
117 #define SYMBOL_VALUE_CHAIN(symbol) (symbol)->ginfo.value.chain
118 #define SYMBOL_LANGUAGE(symbol) (symbol)->ginfo.language
119 #define SYMBOL_SECTION(symbol) (symbol)->ginfo.section
121 #define SYMBOL_CPLUS_DEMANGLED_NAME(symbol) \
122 (symbol)->ginfo.language_specific.cplus_specific.demangled_name
124 /* Macro that initializes the language dependent portion of a symbol
125 depending upon the language for the symbol. */
127 #define SYMBOL_INIT_LANGUAGE_SPECIFIC(symbol,language) \
129 SYMBOL_LANGUAGE (symbol) = language; \
130 if (SYMBOL_LANGUAGE (symbol) == language_cplus) \
132 SYMBOL_CPLUS_DEMANGLED_NAME (symbol) = NULL; \
134 else if (SYMBOL_LANGUAGE (symbol) == language_chill) \
136 SYMBOL_CHILL_DEMANGLED_NAME (symbol) = NULL; \
140 memset (&(symbol)->ginfo.language_specific, 0, \
141 sizeof ((symbol)->ginfo.language_specific)); \
145 /* Macro that attempts to initialize the demangled name for a symbol,
146 based on the language of that symbol. If the language is set to
147 language_auto, it will attempt to find any demangling algorithm
148 that works and then set the language appropriately. If no demangling
149 of any kind is found, the language is set back to language_unknown,
150 so we can avoid doing this work again the next time we encounter
151 the symbol. Any required space to store the name is obtained from the
152 specified obstack. */
154 #define SYMBOL_INIT_DEMANGLED_NAME(symbol,obstack) \
156 char *demangled = NULL; \
157 if (SYMBOL_LANGUAGE (symbol) == language_cplus \
158 || SYMBOL_LANGUAGE (symbol) == language_auto) \
161 cplus_demangle (SYMBOL_NAME (symbol), DMGL_PARAMS | DMGL_ANSI);\
162 if (demangled != NULL) \
164 SYMBOL_LANGUAGE (symbol) = language_cplus; \
165 SYMBOL_CPLUS_DEMANGLED_NAME (symbol) = \
166 obsavestring (demangled, strlen (demangled), (obstack)); \
171 SYMBOL_CPLUS_DEMANGLED_NAME (symbol) = NULL; \
174 if (demangled == NULL \
175 && (SYMBOL_LANGUAGE (symbol) == language_chill \
176 || SYMBOL_LANGUAGE (symbol) == language_auto)) \
179 chill_demangle (SYMBOL_NAME (symbol)); \
180 if (demangled != NULL) \
182 SYMBOL_LANGUAGE (symbol) = language_chill; \
183 SYMBOL_CHILL_DEMANGLED_NAME (symbol) = \
184 obsavestring (demangled, strlen (demangled), (obstack)); \
189 SYMBOL_CHILL_DEMANGLED_NAME (symbol) = NULL; \
192 if (SYMBOL_LANGUAGE (symbol) == language_auto) \
194 SYMBOL_LANGUAGE (symbol) = language_unknown; \
198 /* Macro that returns the demangled name for a symbol based on the language
199 for that symbol. If no demangled name exists, returns NULL. */
201 #define SYMBOL_DEMANGLED_NAME(symbol) \
202 (SYMBOL_LANGUAGE (symbol) == language_cplus \
203 ? SYMBOL_CPLUS_DEMANGLED_NAME (symbol) \
204 : (SYMBOL_LANGUAGE (symbol) == language_chill \
205 ? SYMBOL_CHILL_DEMANGLED_NAME (symbol) \
208 #define SYMBOL_CHILL_DEMANGLED_NAME(symbol) \
209 (symbol)->ginfo.language_specific.chill_specific.demangled_name
211 /* Macro that returns the "natural source name" of a symbol. In C++ this is
212 the "demangled" form of the name if demangle is on and the "mangled" form
213 of the name if demangle is off. In other languages this is just the
214 symbol name. The result should never be NULL. */
216 #define SYMBOL_SOURCE_NAME(symbol) \
217 (demangle && SYMBOL_DEMANGLED_NAME (symbol) != NULL \
218 ? SYMBOL_DEMANGLED_NAME (symbol) \
219 : SYMBOL_NAME (symbol))
221 /* Macro that returns the "natural assembly name" of a symbol. In C++ this is
222 the "mangled" form of the name if demangle is off, or if demangle is on and
223 asm_demangle is off. Otherwise if asm_demangle is on it is the "demangled"
224 form. In other languages this is just the symbol name. The result should
227 #define SYMBOL_LINKAGE_NAME(symbol) \
228 (demangle && asm_demangle && SYMBOL_DEMANGLED_NAME (symbol) != NULL \
229 ? SYMBOL_DEMANGLED_NAME (symbol) \
230 : SYMBOL_NAME (symbol))
232 /* Macro that tests a symbol for a match against a specified name string.
233 First test the unencoded name, then looks for and test a C++ encoded
234 name if it exists. Note that whitespace is ignored while attempting to
235 match a C++ encoded name, so that "foo::bar(int,long)" is the same as
236 "foo :: bar (int, long)".
237 Evaluates to zero if the match fails, or nonzero if it succeeds. */
239 #define SYMBOL_MATCHES_NAME(symbol, name) \
240 (STREQ (SYMBOL_NAME (symbol), (name)) \
241 || (SYMBOL_DEMANGLED_NAME (symbol) != NULL \
242 && strcmp_iw (SYMBOL_DEMANGLED_NAME (symbol), (name)) == 0))
244 /* Macro that tests a symbol for an re-match against the last compiled regular
245 expression. First test the unencoded name, then look for and test a C++
246 encoded name if it exists.
247 Evaluates to zero if the match fails, or nonzero if it succeeds. */
249 #define SYMBOL_MATCHES_REGEXP(symbol) \
250 (re_exec (SYMBOL_NAME (symbol)) != 0 \
251 || (SYMBOL_DEMANGLED_NAME (symbol) != NULL \
252 && re_exec (SYMBOL_DEMANGLED_NAME (symbol)) != 0))
254 /* Define a simple structure used to hold some very basic information about
255 all defined global symbols (text, data, bss, abs, etc). The only required
256 information is the general_symbol_info.
258 In many cases, even if a file was compiled with no special options for
259 debugging at all, as long as was not stripped it will contain sufficient
260 information to build a useful minimal symbol table using this structure.
261 Even when a file contains enough debugging information to build a full
262 symbol table, these minimal symbols are still useful for quickly mapping
263 between names and addresses, and vice versa. They are also sometimes
264 used to figure out what full symbol table entries need to be read in. */
266 struct minimal_symbol
269 /* The general symbol info required for all types of symbols.
271 The SYMBOL_VALUE_ADDRESS contains the address that this symbol
274 struct general_symbol_info ginfo
;
276 /* The info field is available for caching machine-specific information that
277 The AMD 29000 tdep.c uses it to remember things it has decoded from the
278 instructions in the function header, so it doesn't have to rederive the
279 info constantly (over a serial line). It is initialized to zero and
280 stays that way until target-dependent code sets it. Storage for any data
281 pointed to by this field should be allocated on the symbol_obstack for
282 the associated objfile. The type would be "void *" except for reasons
283 of compatibility with older compilers. This field is optional. */
287 #ifdef SOFUN_ADDRESS_MAYBE_MISSING
288 /* Which source file is this symbol in? Only relevant for mst_file_*. */
292 /* Classification types for this symbol. These should be taken as "advisory
293 only", since if gdb can't easily figure out a classification it simply
294 selects mst_unknown. It may also have to guess when it can't figure out
295 which is a better match between two types (mst_data versus mst_bss) for
296 example. Since the minimal symbol info is sometimes derived from the
297 BFD library's view of a file, we need to live with what information bfd
300 enum minimal_symbol_type
302 mst_unknown
= 0, /* Unknown type, the default */
303 mst_text
, /* Generally executable instructions */
304 mst_data
, /* Generally initialized data */
305 mst_bss
, /* Generally uninitialized data */
306 mst_abs
, /* Generally absolute (nonrelocatable) */
307 /* GDB uses mst_solib_trampoline for the start address of a shared
308 library trampoline entry. Breakpoints for shared library functions
309 are put there if the shared library is not yet loaded.
310 After the shared library is loaded, lookup_minimal_symbol will
311 prefer the minimal symbol from the shared library (usually
312 a mst_text symbol) over the mst_solib_trampoline symbol, and the
313 breakpoints will be moved to their true address in the shared
314 library via breakpoint_re_set. */
315 mst_solib_trampoline
, /* Shared library trampoline code */
316 /* For the mst_file* types, the names are only guaranteed to be unique
317 within a given .o file. */
318 mst_file_text
, /* Static version of mst_text */
319 mst_file_data
, /* Static version of mst_data */
320 mst_file_bss
/* Static version of mst_bss */
321 } type BYTE_BITFIELD
;
325 #define MSYMBOL_INFO(msymbol) (msymbol)->info
326 #define MSYMBOL_TYPE(msymbol) (msymbol)->type
329 /* All of the name-scope contours of the program
330 are represented by `struct block' objects.
331 All of these objects are pointed to by the blockvector.
333 Each block represents one name scope.
334 Each lexical context has its own block.
336 The blockvector begins with some special blocks.
337 The GLOBAL_BLOCK contains all the symbols defined in this compilation
338 whose scope is the entire program linked together.
339 The STATIC_BLOCK contains all the symbols whose scope is the
340 entire compilation excluding other separate compilations.
341 Blocks starting with the FIRST_LOCAL_BLOCK are not special.
343 Each block records a range of core addresses for the code that
344 is in the scope of the block. The STATIC_BLOCK and GLOBAL_BLOCK
345 give, for the range of code, the entire range of code produced
346 by the compilation that the symbol segment belongs to.
348 The blocks appear in the blockvector
349 in order of increasing starting-address,
350 and, within that, in order of decreasing ending-address.
352 This implies that within the body of one function
353 the blocks appear in the order of a depth-first tree walk. */
357 /* Number of blocks in the list. */
359 /* The blocks themselves. */
360 struct block
*block
[1];
363 #define BLOCKVECTOR_NBLOCKS(blocklist) (blocklist)->nblocks
364 #define BLOCKVECTOR_BLOCK(blocklist,n) (blocklist)->block[n]
366 /* Special block numbers */
368 #define GLOBAL_BLOCK 0
369 #define STATIC_BLOCK 1
370 #define FIRST_LOCAL_BLOCK 2
375 /* Addresses in the executable code that are in this block. */
380 /* The symbol that names this block, if the block is the body of a
381 function; otherwise, zero. */
383 struct symbol
*function
;
385 /* The `struct block' for the containing block, or 0 if none.
387 The superblock of a top-level local block (i.e. a function in the
388 case of C) is the STATIC_BLOCK. The superblock of the
389 STATIC_BLOCK is the GLOBAL_BLOCK. */
391 struct block
*superblock
;
393 /* Version of GCC used to compile the function corresponding
394 to this block, or 0 if not compiled with GCC. When possible,
395 GCC should be compatible with the native compiler, or if that
396 is not feasible, the differences should be fixed during symbol
397 reading. As of 16 Apr 93, this flag is never used to distinguish
398 between gcc2 and the native compiler.
400 If there is no function corresponding to this block, this meaning
401 of this flag is undefined. */
403 unsigned char gcc_compile_flag
;
405 /* Number of local symbols. */
409 /* The symbols. If some of them are arguments, then they must be
410 in the order in which we would like to print them. */
412 struct symbol
*sym
[1];
415 #define BLOCK_START(bl) (bl)->startaddr
416 #define BLOCK_END(bl) (bl)->endaddr
417 #define BLOCK_NSYMS(bl) (bl)->nsyms
418 #define BLOCK_SYM(bl, n) (bl)->sym[n]
419 #define BLOCK_FUNCTION(bl) (bl)->function
420 #define BLOCK_SUPERBLOCK(bl) (bl)->superblock
421 #define BLOCK_GCC_COMPILED(bl) (bl)->gcc_compile_flag
423 /* Nonzero if symbols of block BL should be sorted alphabetically.
424 Don't sort a block which corresponds to a function. If we did the
425 sorting would have to preserve the order of the symbols for the
428 #define BLOCK_SHOULD_SORT(bl) ((bl)->nsyms >= 40 && BLOCK_FUNCTION (bl) == NULL)
431 /* Represent one symbol name; a variable, constant, function or typedef. */
433 /* Different name spaces for symbols. Looking up a symbol specifies a
434 namespace and ignores symbol definitions in other name spaces. */
438 /* UNDEF_NAMESPACE is used when a namespace has not been discovered or
439 none of the following apply. This usually indicates an error either
440 in the symbol information or in gdb's handling of symbols. */
444 /* VAR_NAMESPACE is the usual namespace. In C, this contains variables,
445 function names, typedef names and enum type values. */
449 /* STRUCT_NAMESPACE is used in C to hold struct, union and enum type names.
450 Thus, if `struct foo' is used in a C program, it produces a symbol named
451 `foo' in the STRUCT_NAMESPACE. */
455 /* LABEL_NAMESPACE may be used for names of labels (for gotos);
456 currently it is not used and labels are not recorded at all. */
461 /* An address-class says where to find the value of a symbol. */
465 /* Not used; catches errors */
469 /* Value is constant int SYMBOL_VALUE, host byteorder */
473 /* Value is at fixed address SYMBOL_VALUE_ADDRESS */
477 /* Value is in register. SYMBOL_VALUE is the register number. */
481 /* It's an argument; the value is at SYMBOL_VALUE offset in arglist. */
485 /* Value address is at SYMBOL_VALUE offset in arglist. */
489 /* Value is in register number SYMBOL_VALUE. Just like LOC_REGISTER
490 except this is an argument. Probably the cleaner way to handle
491 this would be to separate address_class (which would include
492 separate ARG and LOCAL to deal with FRAME_ARGS_ADDRESS versus
493 FRAME_LOCALS_ADDRESS), and an is_argument flag.
495 For some symbol formats (stabs, for some compilers at least),
496 the compiler generates two symbols, an argument and a register.
497 In some cases we combine them to a single LOC_REGPARM in symbol
498 reading, but currently not for all cases (e.g. it's passed on the
499 stack and then loaded into a register). */
503 /* Value is in specified register. Just like LOC_REGPARM except the
504 register holds the address of the argument instead of the argument
505 itself. This is currently used for the passing of structs and unions
506 on sparc and hppa. It is also used for call by reference where the
507 address is in a register, at least by mipsread.c. */
511 /* Value is a local variable at SYMBOL_VALUE offset in stack frame. */
515 /* Value not used; definition in SYMBOL_TYPE. Symbols in the namespace
516 STRUCT_NAMESPACE all have this class. */
520 /* Value is address SYMBOL_VALUE_ADDRESS in the code */
524 /* In a symbol table, value is SYMBOL_BLOCK_VALUE of a `struct block'.
525 In a partial symbol table, SYMBOL_VALUE_ADDRESS is the start address
526 of the block. Function names have this class. */
530 /* Value is a constant byte-sequence pointed to by SYMBOL_VALUE_BYTES, in
531 target byte order. */
535 /* Value is arg at SYMBOL_VALUE offset in stack frame. Differs from
536 LOC_LOCAL in that symbol is an argument; differs from LOC_ARG in
537 that we find it in the frame (FRAME_LOCALS_ADDRESS), not in the
538 arglist (FRAME_ARGS_ADDRESS). Added for i960, which passes args
539 in regs then copies to frame. */
543 /* Value is at SYMBOL_VALUE offset from the current value of
544 register number SYMBOL_BASEREG. This exists mainly for the same
545 things that LOC_LOCAL and LOC_ARG do; but we need to do this
546 instead because on 88k DWARF gives us the offset from the
547 frame/stack pointer, rather than the offset from the "canonical
548 frame address" used by COFF, stabs, etc., and we don't know how
549 to convert between these until we start examining prologues.
551 Note that LOC_BASEREG is much less general than a DWARF expression.
552 We don't need the generality (at least not yet), and storing a general
553 DWARF expression would presumably take up more space than the existing
558 /* Same as LOC_BASEREG but it is an argument. */
562 /* The variable does not actually exist in the program.
563 The value is ignored. */
571 /* The general symbol info required for all types of symbols. */
573 struct general_symbol_info ginfo
;
575 /* Data type of value */
579 /* Name space code. */
581 enum namespace namespace BYTE_BITFIELD
;
585 enum address_class aclass BYTE_BITFIELD
;
587 /* Line number of definition. FIXME: Should we really make the assumption
588 that nobody will try to debug files longer than 64K lines? What about
589 machine generated programs? */
593 /* Some symbols require an additional value to be recorded on a per-
594 symbol basis. Stash those values here. */
598 /* Used by LOC_BASEREG and LOC_BASEREG_ARG. */
604 #define SYMBOL_NAMESPACE(symbol) (symbol)->namespace
605 #define SYMBOL_CLASS(symbol) (symbol)->aclass
606 #define SYMBOL_TYPE(symbol) (symbol)->type
607 #define SYMBOL_LINE(symbol) (symbol)->line
608 #define SYMBOL_BASEREG(symbol) (symbol)->aux_value.basereg
610 /* A partial_symbol records the name, namespace, and address class of
611 symbols whose types we have not parsed yet. For functions, it also
612 contains their memory address, so we can find them from a PC value.
613 Each partial_symbol sits in a partial_symtab, all of which are chained
614 on a partial symtab list and which points to the corresponding
615 normal symtab once the partial_symtab has been referenced. */
617 struct partial_symbol
620 /* The general symbol info required for all types of symbols. */
622 struct general_symbol_info ginfo
;
624 /* Name space code. */
626 enum namespace namespace BYTE_BITFIELD
;
628 /* Address class (for info_symbols) */
630 enum address_class aclass BYTE_BITFIELD
;
634 #define PSYMBOL_NAMESPACE(psymbol) (psymbol)->namespace
635 #define PSYMBOL_CLASS(psymbol) (psymbol)->aclass
638 /* Source-file information. This describes the relation between source files,
639 ine numbers and addresses in the program text. */
643 int length
; /* Number of source files described */
644 struct source
*source
[1]; /* Descriptions of the files */
647 /* Each item represents a line-->pc (or the reverse) mapping. This is
648 somewhat more wasteful of space than one might wish, but since only
649 the files which are actually debugged are read in to core, we don't
652 struct linetable_entry
658 /* The order of entries in the linetable is significant. They should
659 be sorted by increasing values of the pc field. If there is more than
660 one entry for a given pc, then I'm not sure what should happen (and
661 I not sure whether we currently handle it the best way).
663 Example: a C for statement generally looks like this
665 10 0x100 - for the init/test part of a for stmt.
668 10 0x400 - for the increment part of a for stmt.
676 /* Actually NITEMS elements. If you don't like this use of the
677 `struct hack', you can shove it up your ANSI (seriously, if the
678 committee tells us how to do it, we can probably go along). */
679 struct linetable_entry item
[1];
682 /* All the information on one source file. */
686 char *name
; /* Name of file */
687 struct linetable contents
;
690 /* How to relocate the symbols from each section in a symbol file.
691 Each struct contains an array of offsets.
692 The ordering and meaning of the offsets is file-type-dependent;
693 typically it is indexed by section numbers or symbol types or
696 To give us flexibility in changing the internal representation
697 of these offsets, the ANOFFSET macro must be used to insert and
698 extract offset values in the struct. */
700 struct section_offsets
702 CORE_ADDR offsets
[1]; /* As many as needed. */
705 #define ANOFFSET(secoff, whichone) (secoff->offsets[whichone])
707 /* Each source file or header is represented by a struct symtab.
708 These objects are chained through the `next' field. */
713 /* Chain of all existing symtabs. */
717 /* List of all symbol scope blocks for this symtab. May be shared
718 between different symtabs (and normally is for all the symtabs
719 in a given compilation unit). */
721 struct blockvector
*blockvector
;
723 /* Table mapping core addresses to line numbers for this file.
724 Can be NULL if none. Never shared between different symtabs. */
726 struct linetable
*linetable
;
728 /* Section in objfile->section_offsets for the blockvector and
729 the linetable. Probably always SECT_OFF_TEXT. */
731 int block_line_section
;
733 /* If several symtabs share a blockvector, exactly one of them
734 should be designed the primary, so that the blockvector
735 is relocated exactly once by objfile_relocate. */
739 /* Name of this source file. */
743 /* Directory in which it was compiled, or NULL if we don't know. */
747 /* This component says how to free the data we point to:
748 free_contents => do a tree walk and free each object.
749 free_nothing => do nothing; some other symtab will free
750 the data this one uses.
751 free_linetable => free just the linetable. FIXME: Is this redundant
752 with the primary field? */
756 free_nothing
, free_contents
, free_linetable
760 /* Pointer to one block of storage to be freed, if nonzero. */
761 /* This is IN ADDITION to the action indicated by free_code. */
765 /* Total number of lines found in source file. */
769 /* line_charpos[N] is the position of the (N-1)th line of the
770 source file. "position" means something we can lseek() to; it
771 is not guaranteed to be useful any other way. */
775 /* Language of this source file. */
777 enum language language
;
779 /* String of version information. May be zero. */
783 /* Full name of file as found by searching the source path.
784 NULL if not yet known. */
788 /* Object file from which this symbol information was read. */
790 struct objfile
*objfile
;
792 /* Anything extra for this symtab. This is for target machines
793 with special debugging info of some sort (which cannot just
794 be represented in a normal symtab). */
796 #if defined (EXTRA_SYMTAB_INFO)
802 #define BLOCKVECTOR(symtab) (symtab)->blockvector
803 #define LINETABLE(symtab) (symtab)->linetable
806 /* Each source file that has not been fully read in is represented by
807 a partial_symtab. This contains the information on where in the
808 executable the debugging symbols for a specific file are, and a
809 list of names of global symbols which are located in this file.
810 They are all chained on partial symtab lists.
812 Even after the source file has been read into a symtab, the
813 partial_symtab remains around. They are allocated on an obstack,
814 psymbol_obstack. FIXME, this is bad for dynamic linking or VxWorks-
815 style execution of a bunch of .o's. */
817 struct partial_symtab
820 /* Chain of all existing partial symtabs. */
822 struct partial_symtab
*next
;
824 /* Name of the source file which this partial_symtab defines */
828 /* Information about the object file from which symbols should be read. */
830 struct objfile
*objfile
;
832 /* Set of relocation offsets to apply to each section. */
834 struct section_offsets
*section_offsets
;
836 /* Range of text addresses covered by this file; texthigh is the
837 beginning of the next section. */
842 /* Array of pointers to all of the partial_symtab's which this one
843 depends on. Since this array can only be set to previous or
844 the current (?) psymtab, this dependency tree is guaranteed not
845 to have any loops. "depends on" means that symbols must be read
846 for the dependencies before being read for this psymtab; this is
847 for type references in stabs, where if foo.c includes foo.h, declarations
848 in foo.h may use type numbers defined in foo.c. For other debugging
849 formats there may be no need to use dependencies. */
851 struct partial_symtab
**dependencies
;
853 int number_of_dependencies
;
855 /* Global symbol list. This list will be sorted after readin to
856 improve access. Binary search will be the usual method of
857 finding a symbol within it. globals_offset is an integer offset
858 within global_psymbols[]. */
863 /* Static symbol list. This list will *not* be sorted after readin;
864 to find a symbol in it, exhaustive search must be used. This is
865 reasonable because searches through this list will eventually
866 lead to either the read in of a files symbols for real (assumed
867 to take a *lot* of time; check) or an error (and we don't care
868 how long errors take). This is an offset and size within
869 static_psymbols[]. */
874 /* Pointer to symtab eventually allocated for this source file, 0 if
875 !readin or if we haven't looked for the symtab after it was readin. */
877 struct symtab
*symtab
;
879 /* Pointer to function which will read in the symtab corresponding to
882 void (*read_symtab
) PARAMS ((struct partial_symtab
*));
884 /* Information that lets read_symtab() locate the part of the symbol table
885 that this psymtab corresponds to. This information is private to the
886 format-dependent symbol reading routines. For further detail examine
887 the various symbol reading modules. Should really be (void *) but is
888 (char *) as with other such gdb variables. (FIXME) */
890 char *read_symtab_private
;
892 /* Non-zero if the symtab corresponding to this psymtab has been readin */
894 unsigned char readin
;
897 /* A fast way to get from a psymtab to its symtab (after the first time). */
898 #define PSYMTAB_TO_SYMTAB(pst) \
899 ((pst) -> symtab != NULL ? (pst) -> symtab : psymtab_to_symtab (pst))
902 /* The virtual function table is now an array of structures which have the
903 form { int16 offset, delta; void *pfn; }.
905 In normal virtual function tables, OFFSET is unused.
906 DELTA is the amount which is added to the apparent object's base
907 address in order to point to the actual object to which the
908 virtual function should be applied.
909 PFN is a pointer to the virtual function.
911 Note that this macro is g++ specific (FIXME). */
913 #define VTBL_FNADDR_OFFSET 2
915 /* Macro that yields non-zero value iff NAME is the prefix for C++ operator
916 names. If you leave out the parenthesis here you will lose!
917 Currently 'o' 'p' CPLUS_MARKER is used for both the symbol in the
918 symbol-file and the names in gdb's symbol table.
919 Note that this macro is g++ specific (FIXME). */
921 #define OPNAME_PREFIX_P(NAME) \
922 ((NAME)[0] == 'o' && (NAME)[1] == 'p' && (NAME)[2] == CPLUS_MARKER)
924 /* Macro that yields non-zero value iff NAME is the prefix for C++ vtbl
925 names. Note that this macro is g++ specific (FIXME).
926 '_vt$' is the old cfront-style vtables; '_VT$' is the new
927 style, using thunks (where '$' is really CPLUS_MARKER). */
929 #define VTBL_PREFIX_P(NAME) \
930 ((NAME)[3] == CPLUS_MARKER && (NAME)[0] == '_' \
931 && (((NAME)[1] == 'V' && (NAME)[2] == 'T') \
932 || ((NAME)[1] == 'v' && (NAME)[2] == 't')))
934 /* Macro that yields non-zero value iff NAME is the prefix for C++ destructor
935 names. Note that this macro is g++ specific (FIXME). */
937 #define DESTRUCTOR_PREFIX_P(NAME) \
938 ((NAME)[0] == '_' && (NAME)[1] == CPLUS_MARKER && (NAME)[2] == '_')
941 /* External variables and functions for the objects described above. */
943 /* This symtab variable specifies the current file for printing source lines */
945 extern struct symtab
*current_source_symtab
;
947 /* This is the next line to print for listing source lines. */
949 extern int current_source_line
;
951 /* See the comment in symfile.c about how current_objfile is used. */
953 extern struct objfile
*current_objfile
;
957 extern int asm_demangle
;
959 extern struct symtab
*
960 lookup_symtab
PARAMS ((char *));
962 extern struct symbol
*
963 lookup_symbol
PARAMS ((const char *, const struct block
*,
964 const enum namespace, int *, struct symtab
**));
966 extern struct symbol
*
967 lookup_block_symbol
PARAMS ((const struct block
*, const char *,
968 const enum namespace));
971 lookup_struct
PARAMS ((char *, struct block
*));
974 lookup_union
PARAMS ((char *, struct block
*));
977 lookup_enum
PARAMS ((char *, struct block
*));
979 extern struct symbol
*
980 block_function
PARAMS ((struct block
*));
982 extern struct symbol
*
983 find_pc_function
PARAMS ((CORE_ADDR
));
985 extern int find_pc_partial_function
986 PARAMS ((CORE_ADDR
, char **, CORE_ADDR
*, CORE_ADDR
*));
989 clear_pc_function_cache
PARAMS ((void));
991 extern struct partial_symtab
*
992 lookup_partial_symtab
PARAMS ((char *));
994 extern struct partial_symtab
*
995 find_pc_psymtab
PARAMS ((CORE_ADDR
));
997 extern struct symtab
*
998 find_pc_symtab
PARAMS ((CORE_ADDR
));
1000 extern struct partial_symbol
*
1001 find_pc_psymbol
PARAMS ((struct partial_symtab
*, CORE_ADDR
));
1004 find_pc_line_pc_range
PARAMS ((CORE_ADDR
, CORE_ADDR
*, CORE_ADDR
*));
1007 contained_in
PARAMS ((struct block
*, struct block
*));
1010 reread_symbols
PARAMS ((void));
1012 /* Macro for name of symbol to indicate a file compiled with gcc. */
1013 #ifndef GCC_COMPILED_FLAG_SYMBOL
1014 #define GCC_COMPILED_FLAG_SYMBOL "gcc_compiled."
1017 /* Macro for name of symbol to indicate a file compiled with gcc2. */
1018 #ifndef GCC2_COMPILED_FLAG_SYMBOL
1019 #define GCC2_COMPILED_FLAG_SYMBOL "gcc2_compiled."
1022 /* Functions for dealing with the minimal symbol table, really a misc
1023 address<->symbol mapping for things we don't have debug symbols for. */
1025 extern void prim_record_minimal_symbol
PARAMS ((const char *, CORE_ADDR
,
1026 enum minimal_symbol_type
,
1029 extern struct minimal_symbol
*prim_record_minimal_symbol_and_info
1030 PARAMS ((const char *, CORE_ADDR
,
1031 enum minimal_symbol_type
,
1032 char *info
, int section
,
1035 #ifdef SOFUN_ADDRESS_MAYBE_MISSING
1036 extern CORE_ADDR find_stab_function_addr
PARAMS ((char *,
1037 struct partial_symtab
*,
1041 extern struct minimal_symbol
*
1042 lookup_minimal_symbol
PARAMS ((const char *, const char *, struct objfile
*));
1044 extern struct minimal_symbol
*
1045 lookup_minimal_symbol_text
PARAMS ((const char *, const char *, struct objfile
*));
1047 extern struct minimal_symbol
*
1048 lookup_minimal_symbol_by_pc
PARAMS ((CORE_ADDR
));
1050 extern struct minimal_symbol
*
1051 lookup_solib_trampoline_symbol_by_pc
PARAMS ((CORE_ADDR
));
1054 find_solib_trampoline_target
PARAMS ((CORE_ADDR
));
1057 init_minimal_symbol_collection
PARAMS ((void));
1060 discard_minimal_symbols
PARAMS ((int));
1063 install_minimal_symbols
PARAMS ((struct objfile
*));
1065 /* Sort all the minimal symbols in OBJFILE. */
1067 extern void msymbols_sort
PARAMS ((struct objfile
*objfile
));
1069 struct symtab_and_line
1071 struct symtab
*symtab
;
1073 /* Line number. Line numbers start at 1 and proceed through symtab->nlines.
1074 0 is never a valid line number; it is used to indicate that line number
1075 information is not available. */
1082 struct symtabs_and_lines
1084 struct symtab_and_line
*sals
;
1088 /* Given a pc value, return line number it is in. Second arg nonzero means
1089 if pc is on the boundary use the previous statement's line number. */
1091 extern struct symtab_and_line
1092 find_pc_line
PARAMS ((CORE_ADDR
, int));
1094 /* Given an address, return the nearest symbol at or below it in memory.
1095 Optionally return the symtab it's from through 2nd arg, and the
1096 address in inferior memory of the symbol through 3rd arg. */
1098 extern struct symbol
*
1099 find_addr_symbol
PARAMS ((CORE_ADDR
, struct symtab
**, CORE_ADDR
*));
1101 /* Given a symtab and line number, return the pc there. */
1104 find_line_pc
PARAMS ((struct symtab
*, int));
1107 find_line_pc_range
PARAMS ((struct symtab_and_line
,
1108 CORE_ADDR
*, CORE_ADDR
*));
1111 resolve_sal_pc
PARAMS ((struct symtab_and_line
*));
1113 /* Given a string, return the line specified by it. For commands like "list"
1114 and "breakpoint". */
1116 extern struct symtabs_and_lines
1117 decode_line_spec
PARAMS ((char *, int));
1119 extern struct symtabs_and_lines
1120 decode_line_spec_1
PARAMS ((char *, int));
1122 extern struct symtabs_and_lines
1123 decode_line_1
PARAMS ((char **, int, struct symtab
*, int, char ***));
1127 #if MAINTENANCE_CMDS
1130 maintenance_print_symbols
PARAMS ((char *, int));
1133 maintenance_print_psymbols
PARAMS ((char *, int));
1136 maintenance_print_msymbols
PARAMS ((char *, int));
1139 maintenance_print_objfiles
PARAMS ((char *, int));
1142 maintenance_check_symtabs
PARAMS ((char *, int));
1147 free_symtab
PARAMS ((struct symtab
*));
1149 /* Symbol-reading stuff in symfile.c and solib.c. */
1151 extern struct symtab
*
1152 psymtab_to_symtab
PARAMS ((struct partial_symtab
*));
1155 clear_solib
PARAMS ((void));
1157 extern struct objfile
*
1158 symbol_file_add
PARAMS ((char *, int, CORE_ADDR
, int, int, int));
1163 identify_source_line
PARAMS ((struct symtab
*, int, int, CORE_ADDR
));
1166 print_source_lines
PARAMS ((struct symtab
*, int, int, int));
1169 forget_cached_source_info
PARAMS ((void));
1172 select_source_symtab
PARAMS ((struct symtab
*));
1174 extern char **make_symbol_completion_list
PARAMS ((char *, char *));
1178 extern struct partial_symtab
*
1179 find_main_psymtab
PARAMS ((void));
1183 extern struct blockvector
*
1184 blockvector_for_pc
PARAMS ((CORE_ADDR
, int *));
1189 clear_symtab_users
PARAMS ((void));
1191 extern enum language
1192 deduce_language_from_filename
PARAMS ((char *));
1197 in_prologue
PARAMS ((CORE_ADDR pc
, CORE_ADDR func_start
));
1199 #endif /* !defined(SYMTAB_H) */