1 /* Symbol table definitions for GDB.
3 Copyright 1986, 1988, 1989, 1990, 1991, 1992, 1993, 1994, 1995,
4 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003 Free Software
7 This file is part of GDB.
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 2 of the License, or
12 (at your option) any later version.
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
19 You should have received a copy of the GNU General Public License
20 along with this program; if not, write to the Free Software
21 Foundation, Inc., 59 Temple Place - Suite 330,
22 Boston, MA 02111-1307, USA. */
24 #if !defined (SYMTAB_H)
27 /* Opaque declarations. */
34 /* Don't do this; it means that if some .o's are compiled with GNU C
35 and some are not (easy to do accidentally the way we configure
36 things; also it is a pain to have to "make clean" every time you
37 want to switch compilers), then GDB dies a horrible death. */
38 /* GNU C supports enums that are bitfields. Some compilers don't. */
39 #if 0 && defined(__GNUC__) && !defined(BYTE_BITFIELD)
40 #define BYTE_BITFIELD :8;
42 #define BYTE_BITFIELD /*nothing */
45 /* Define a structure for the information that is common to all symbol types,
46 including minimal symbols, partial symbols, and full symbols. In a
47 multilanguage environment, some language specific information may need to
48 be recorded along with each symbol.
50 These fields are ordered to encourage good packing, since we frequently
51 have tens or hundreds of thousands of these. */
53 struct general_symbol_info
55 /* Name of the symbol. This is a required field. Storage for the name is
56 allocated on the psymbol_obstack or symbol_obstack for the associated
61 /* Value of the symbol. Which member of this union to use, and what
62 it means, depends on what kind of symbol this is and its
63 SYMBOL_CLASS. See comments there for more details. All of these
64 are in host byte order (though what they point to might be in
65 target byte order, e.g. LOC_CONST_BYTES). */
69 /* The fact that this is a long not a LONGEST mainly limits the
70 range of a LOC_CONST. Since LOC_CONST_BYTES exists, I'm not
71 sure that is a big deal. */
80 /* for opaque typedef struct chain */
86 /* Since one and only one language can apply, wrap the language specific
87 information inside a union. */
91 struct cplus_specific
/* For C++ */
105 /* Record the source code language that applies to this symbol.
106 This is used to select one of the fields from the language specific
109 enum language language BYTE_BITFIELD
;
111 /* Which section is this symbol in? This is an index into
112 section_offsets for this objfile. Negative means that the symbol
113 does not get relocated relative to a section.
114 Disclaimer: currently this is just used for xcoff, so don't
115 expect all symbol-reading code to set it correctly (the ELF code
116 also tries to set it correctly). */
120 /* The bfd section associated with this symbol. */
122 asection
*bfd_section
;
125 extern CORE_ADDR
symbol_overlayed_address (CORE_ADDR
, asection
*);
127 /* Note that all the following SYMBOL_* macros are used with the
128 SYMBOL argument being either a partial symbol, a minimal symbol or
129 a full symbol. All three types have a ginfo field. In particular
130 the SYMBOL_INIT_LANGUAGE_SPECIFIC, SYMBOL_INIT_DEMANGLED_NAME,
131 SYMBOL_DEMANGLED_NAME macros cannot be entirely substituted by
132 functions, unless the callers are changed to pass in the ginfo
133 field only, instead of the SYMBOL parameter. */
135 #define SYMBOL_NAME(symbol) (symbol)->ginfo.name
136 #define SYMBOL_VALUE(symbol) (symbol)->ginfo.value.ivalue
137 #define SYMBOL_VALUE_ADDRESS(symbol) (symbol)->ginfo.value.address
138 #define SYMBOL_VALUE_BYTES(symbol) (symbol)->ginfo.value.bytes
139 #define SYMBOL_BLOCK_VALUE(symbol) (symbol)->ginfo.value.block
140 #define SYMBOL_VALUE_CHAIN(symbol) (symbol)->ginfo.value.chain
141 #define SYMBOL_LANGUAGE(symbol) (symbol)->ginfo.language
142 #define SYMBOL_SECTION(symbol) (symbol)->ginfo.section
143 #define SYMBOL_BFD_SECTION(symbol) (symbol)->ginfo.bfd_section
145 #define SYMBOL_CPLUS_DEMANGLED_NAME(symbol) \
146 (symbol)->ginfo.language_specific.cplus_specific.demangled_name
148 /* Initializes the language dependent portion of a symbol
149 depending upon the language for the symbol. */
150 #define SYMBOL_INIT_LANGUAGE_SPECIFIC(symbol,language) \
151 (symbol_init_language_specific (&(symbol)->ginfo, (language)))
152 extern void symbol_init_language_specific (struct general_symbol_info
*symbol
,
153 enum language language
);
155 #define SYMBOL_INIT_DEMANGLED_NAME(symbol,obstack) \
156 (symbol_init_demangled_name (&(symbol)->ginfo, (obstack)))
157 extern void symbol_init_demangled_name (struct general_symbol_info
*symbol
,
158 struct obstack
*obstack
);
160 #define SYMBOL_SET_NAMES(symbol,name,len,objfile) \
161 symbol_set_names (&(symbol)->ginfo, name, len, objfile)
162 extern void symbol_set_names (struct general_symbol_info
*symbol
,
163 const char *name
, int len
,
164 struct objfile
*objfile
);
166 /* Return the demangled name for a symbol based on the language for
167 that symbol. If no demangled name exists, return NULL. */
168 #define SYMBOL_DEMANGLED_NAME(symbol) \
169 (symbol_demangled_name (&(symbol)->ginfo))
170 extern char *symbol_demangled_name (struct general_symbol_info
*symbol
);
172 #define SYMBOL_OBJC_DEMANGLED_NAME(symbol) \
173 (symbol)->ginfo.language_specific.objc_specific.demangled_name
175 /* Macro that returns the "natural source name" of a symbol. In C++ this is
176 the "demangled" form of the name if demangle is on and the "mangled" form
177 of the name if demangle is off. In other languages this is just the
178 symbol name. The result should never be NULL. */
180 #define SYMBOL_SOURCE_NAME(symbol) \
181 (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 /* Represent one symbol name; a variable, constant, function or typedef. */
298 /* Different name spaces for symbols. Looking up a symbol specifies a
299 namespace and ignores symbol definitions in other name spaces. */
303 /* UNDEF_NAMESPACE is used when a namespace has not been discovered or
304 none of the following apply. This usually indicates an error either
305 in the symbol information or in gdb's handling of symbols. */
309 /* VAR_NAMESPACE is the usual namespace. In C, this contains variables,
310 function names, typedef names and enum type values. */
314 /* STRUCT_NAMESPACE is used in C to hold struct, union and enum type names.
315 Thus, if `struct foo' is used in a C program, it produces a symbol named
316 `foo' in the STRUCT_NAMESPACE. */
320 /* LABEL_NAMESPACE may be used for names of labels (for gotos);
321 currently it is not used and labels are not recorded at all. */
325 /* Searching namespaces. These overlap with VAR_NAMESPACE, providing
326 some granularity with the search_symbols function. */
328 /* Everything in VAR_NAMESPACE minus FUNCTIONS_-, TYPES_-, and
332 /* All functions -- for some reason not methods, though. */
335 /* All defined types */
338 /* All class methods -- why is this separated out? */
343 /* An address-class says where to find the value of a symbol. */
347 /* Not used; catches errors */
351 /* Value is constant int SYMBOL_VALUE, host byteorder */
355 /* Value is at fixed address SYMBOL_VALUE_ADDRESS */
359 /* Value is in register. SYMBOL_VALUE is the register number. */
363 /* It's an argument; the value is at SYMBOL_VALUE offset in arglist. */
367 /* Value address is at SYMBOL_VALUE offset in arglist. */
371 /* Value is in register number SYMBOL_VALUE. Just like LOC_REGISTER
372 except this is an argument. Probably the cleaner way to handle
373 this would be to separate address_class (which would include
374 separate ARG and LOCAL to deal with FRAME_ARGS_ADDRESS versus
375 FRAME_LOCALS_ADDRESS), and an is_argument flag.
377 For some symbol formats (stabs, for some compilers at least),
378 the compiler generates two symbols, an argument and a register.
379 In some cases we combine them to a single LOC_REGPARM in symbol
380 reading, but currently not for all cases (e.g. it's passed on the
381 stack and then loaded into a register). */
385 /* Value is in specified register. Just like LOC_REGPARM except the
386 register holds the address of the argument instead of the argument
387 itself. This is currently used for the passing of structs and unions
388 on sparc and hppa. It is also used for call by reference where the
389 address is in a register, at least by mipsread.c. */
393 /* Value is a local variable at SYMBOL_VALUE offset in stack frame. */
397 /* Value not used; definition in SYMBOL_TYPE. Symbols in the namespace
398 STRUCT_NAMESPACE all have this class. */
402 /* Value is address SYMBOL_VALUE_ADDRESS in the code */
406 /* In a symbol table, value is SYMBOL_BLOCK_VALUE of a `struct block'.
407 In a partial symbol table, SYMBOL_VALUE_ADDRESS is the start address
408 of the block. Function names have this class. */
412 /* Value is a constant byte-sequence pointed to by SYMBOL_VALUE_BYTES, in
413 target byte order. */
417 /* Value is arg at SYMBOL_VALUE offset in stack frame. Differs from
418 LOC_LOCAL in that symbol is an argument; differs from LOC_ARG in
419 that we find it in the frame (FRAME_LOCALS_ADDRESS), not in the
420 arglist (FRAME_ARGS_ADDRESS). Added for i960, which passes args
421 in regs then copies to frame. */
425 /* Value is at SYMBOL_VALUE offset from the current value of
426 register number SYMBOL_BASEREG. This exists mainly for the same
427 things that LOC_LOCAL and LOC_ARG do; but we need to do this
428 instead because on 88k DWARF gives us the offset from the
429 frame/stack pointer, rather than the offset from the "canonical
430 frame address" used by COFF, stabs, etc., and we don't know how
431 to convert between these until we start examining prologues.
433 Note that LOC_BASEREG is much less general than a DWARF expression.
434 We don't need the generality (at least not yet), and storing a general
435 DWARF expression would presumably take up more space than the existing
440 /* Same as LOC_BASEREG but it is an argument. */
444 /* Value is at fixed address, but the address of the variable has
445 to be determined from the minimal symbol table whenever the
446 variable is referenced.
447 This happens if debugging information for a global symbol is
448 emitted and the corresponding minimal symbol is defined
449 in another object file or runtime common storage.
450 The linker might even remove the minimal symbol if the global
451 symbol is never referenced, in which case the symbol remains
456 /* Value is at a thread-specific location calculated by a
457 target-specific method. This is used only by hppa. */
459 LOC_HP_THREAD_LOCAL_STATIC
,
461 /* Value is at a thread-specific location calculated by a
462 target-specific method. SYMBOL_OBJFILE gives the object file
463 in which the symbol is defined; the symbol's value is the
464 offset into that objfile's thread-local storage for the current
467 LOC_THREAD_LOCAL_STATIC
,
469 /* The variable does not actually exist in the program.
470 The value is ignored. */
474 /* The variable is static, but actually lives at * (address).
475 * I.e. do an extra indirection to get to it.
476 * This is used on HP-UX to get at globals that are allocated
477 * in shared libraries, where references from images other
478 * than the one where the global was allocated are done
479 * with a level of indirection.
485 /* Linked list of symbol's live ranges. */
491 struct range_list
*next
;
494 /* Linked list of aliases for a particular main/primary symbol. */
498 struct alias_list
*next
;
504 /* The general symbol info required for all types of symbols. */
506 struct general_symbol_info ginfo
;
508 /* Data type of value */
512 /* Name space code. */
515 /* FIXME: don't conflict with C++'s namespace */
516 /* would be safer to do a global change for all namespace identifiers. */
517 #define namespace _namespace
519 namespace_enum
namespace BYTE_BITFIELD
;
523 enum address_class aclass BYTE_BITFIELD
;
525 /* Line number of definition. FIXME: Should we really make the assumption
526 that nobody will try to debug files longer than 64K lines? What about
527 machine generated programs? */
531 /* Some symbols require an additional value to be recorded on a per-
532 symbol basis. Stash those values here. */
536 /* Used by LOC_BASEREG and LOC_BASEREG_ARG. */
539 /* Used by LOC_THREAD_LOCAL_STATIC. The objfile in which this
540 symbol is defined. To find a thread-local variable (e.g., a
541 variable declared with the `__thread' storage class), we may
542 need to know which object file it's in. */
543 struct objfile
*objfile
;
548 /* Link to a list of aliases for this symbol.
549 Only a "primary/main symbol may have aliases. */
550 struct alias_list
*aliases
;
552 /* List of ranges where this symbol is active. This is only
553 used by alias symbols at the current time. */
554 struct range_list
*ranges
;
556 struct symbol
*hash_next
;
560 #define SYMBOL_NAMESPACE(symbol) (symbol)->namespace
561 #define SYMBOL_CLASS(symbol) (symbol)->aclass
562 #define SYMBOL_TYPE(symbol) (symbol)->type
563 #define SYMBOL_LINE(symbol) (symbol)->line
564 #define SYMBOL_BASEREG(symbol) (symbol)->aux_value.basereg
565 #define SYMBOL_OBJFILE(symbol) (symbol)->aux_value.objfile
566 #define SYMBOL_ALIASES(symbol) (symbol)->aliases
567 #define SYMBOL_RANGES(symbol) (symbol)->ranges
569 /* A partial_symbol records the name, namespace, and address class of
570 symbols whose types we have not parsed yet. For functions, it also
571 contains their memory address, so we can find them from a PC value.
572 Each partial_symbol sits in a partial_symtab, all of which are chained
573 on a partial symtab list and which points to the corresponding
574 normal symtab once the partial_symtab has been referenced. */
576 struct partial_symbol
579 /* The general symbol info required for all types of symbols. */
581 struct general_symbol_info ginfo
;
583 /* Name space code. */
585 namespace_enum
namespace BYTE_BITFIELD
;
587 /* Address class (for info_symbols) */
589 enum address_class aclass BYTE_BITFIELD
;
593 #define PSYMBOL_NAMESPACE(psymbol) (psymbol)->namespace
594 #define PSYMBOL_CLASS(psymbol) (psymbol)->aclass
597 /* Each item represents a line-->pc (or the reverse) mapping. This is
598 somewhat more wasteful of space than one might wish, but since only
599 the files which are actually debugged are read in to core, we don't
602 struct linetable_entry
608 /* The order of entries in the linetable is significant. They should
609 be sorted by increasing values of the pc field. If there is more than
610 one entry for a given pc, then I'm not sure what should happen (and
611 I not sure whether we currently handle it the best way).
613 Example: a C for statement generally looks like this
615 10 0x100 - for the init/test part of a for stmt.
618 10 0x400 - for the increment part of a for stmt.
620 If an entry has a line number of zero, it marks the start of a PC
621 range for which no line number information is available. It is
622 acceptable, though wasteful of table space, for such a range to be
629 /* Actually NITEMS elements. If you don't like this use of the
630 `struct hack', you can shove it up your ANSI (seriously, if the
631 committee tells us how to do it, we can probably go along). */
632 struct linetable_entry item
[1];
635 /* How to relocate the symbols from each section in a symbol file.
636 Each struct contains an array of offsets.
637 The ordering and meaning of the offsets is file-type-dependent;
638 typically it is indexed by section numbers or symbol types or
641 To give us flexibility in changing the internal representation
642 of these offsets, the ANOFFSET macro must be used to insert and
643 extract offset values in the struct. */
645 struct section_offsets
647 CORE_ADDR offsets
[1]; /* As many as needed. */
650 #define ANOFFSET(secoff, whichone) \
652 ? (internal_error (__FILE__, __LINE__, "Section index is uninitialized"), -1) \
653 : secoff->offsets[whichone])
655 /* The size of a section_offsets table for N sections. */
656 #define SIZEOF_N_SECTION_OFFSETS(n) \
657 (sizeof (struct section_offsets) \
658 + sizeof (((struct section_offsets *) 0)->offsets) * ((n)-1))
660 /* The maximum possible size of a section_offsets table. */
661 #define SIZEOF_SECTION_OFFSETS (SIZEOF_N_SECTION_OFFSETS (SECT_OFF_MAX))
663 /* Each source file or header is represented by a struct symtab.
664 These objects are chained through the `next' field. */
669 /* Chain of all existing symtabs. */
673 /* List of all symbol scope blocks for this symtab. May be shared
674 between different symtabs (and normally is for all the symtabs
675 in a given compilation unit). */
677 struct blockvector
*blockvector
;
679 /* Table mapping core addresses to line numbers for this file.
680 Can be NULL if none. Never shared between different symtabs. */
682 struct linetable
*linetable
;
684 /* Section in objfile->section_offsets for the blockvector and
685 the linetable. Probably always SECT_OFF_TEXT. */
687 int block_line_section
;
689 /* If several symtabs share a blockvector, exactly one of them
690 should be designated the primary, so that the blockvector
691 is relocated exactly once by objfile_relocate. */
695 /* The macro table for this symtab. Like the blockvector, this
696 may be shared between different symtabs --- and normally is for
697 all the symtabs in a given compilation unit. */
698 struct macro_table
*macro_table
;
700 /* Name of this source file. */
704 /* Directory in which it was compiled, or NULL if we don't know. */
708 /* This component says how to free the data we point to:
709 free_contents => do a tree walk and free each object.
710 free_nothing => do nothing; some other symtab will free
711 the data this one uses.
712 free_linetable => free just the linetable. FIXME: Is this redundant
713 with the primary field? */
717 free_nothing
, free_contents
, free_linetable
721 /* Pointer to one block of storage to be freed, if nonzero. */
722 /* This is IN ADDITION to the action indicated by free_code. */
726 /* Total number of lines found in source file. */
730 /* line_charpos[N] is the position of the (N-1)th line of the
731 source file. "position" means something we can lseek() to; it
732 is not guaranteed to be useful any other way. */
736 /* Language of this source file. */
738 enum language language
;
740 /* String that identifies the format of the debugging information, such
741 as "stabs", "dwarf 1", "dwarf 2", "coff", etc. This is mostly useful
742 for automated testing of gdb but may also be information that is
743 useful to the user. */
747 /* String of version information. May be zero. */
751 /* Full name of file as found by searching the source path.
752 NULL if not yet known. */
756 /* Object file from which this symbol information was read. */
758 struct objfile
*objfile
;
762 #define BLOCKVECTOR(symtab) (symtab)->blockvector
763 #define LINETABLE(symtab) (symtab)->linetable
766 /* Each source file that has not been fully read in is represented by
767 a partial_symtab. This contains the information on where in the
768 executable the debugging symbols for a specific file are, and a
769 list of names of global symbols which are located in this file.
770 They are all chained on partial symtab lists.
772 Even after the source file has been read into a symtab, the
773 partial_symtab remains around. They are allocated on an obstack,
774 psymbol_obstack. FIXME, this is bad for dynamic linking or VxWorks-
775 style execution of a bunch of .o's. */
777 struct partial_symtab
780 /* Chain of all existing partial symtabs. */
782 struct partial_symtab
*next
;
784 /* Name of the source file which this partial_symtab defines */
788 /* Full path of the source file. NULL if not known. */
792 /* Information about the object file from which symbols should be read. */
794 struct objfile
*objfile
;
796 /* Set of relocation offsets to apply to each section. */
798 struct section_offsets
*section_offsets
;
800 /* Range of text addresses covered by this file; texthigh is the
801 beginning of the next section. */
806 /* Array of pointers to all of the partial_symtab's which this one
807 depends on. Since this array can only be set to previous or
808 the current (?) psymtab, this dependency tree is guaranteed not
809 to have any loops. "depends on" means that symbols must be read
810 for the dependencies before being read for this psymtab; this is
811 for type references in stabs, where if foo.c includes foo.h, declarations
812 in foo.h may use type numbers defined in foo.c. For other debugging
813 formats there may be no need to use dependencies. */
815 struct partial_symtab
**dependencies
;
817 int number_of_dependencies
;
819 /* Global symbol list. This list will be sorted after readin to
820 improve access. Binary search will be the usual method of
821 finding a symbol within it. globals_offset is an integer offset
822 within global_psymbols[]. */
827 /* Static symbol list. This list will *not* be sorted after readin;
828 to find a symbol in it, exhaustive search must be used. This is
829 reasonable because searches through this list will eventually
830 lead to either the read in of a files symbols for real (assumed
831 to take a *lot* of time; check) or an error (and we don't care
832 how long errors take). This is an offset and size within
833 static_psymbols[]. */
838 /* Pointer to symtab eventually allocated for this source file, 0 if
839 !readin or if we haven't looked for the symtab after it was readin. */
841 struct symtab
*symtab
;
843 /* Pointer to function which will read in the symtab corresponding to
846 void (*read_symtab
) (struct partial_symtab
*);
848 /* Information that lets read_symtab() locate the part of the symbol table
849 that this psymtab corresponds to. This information is private to the
850 format-dependent symbol reading routines. For further detail examine
851 the various symbol reading modules. Should really be (void *) but is
852 (char *) as with other such gdb variables. (FIXME) */
854 char *read_symtab_private
;
856 /* Non-zero if the symtab corresponding to this psymtab has been readin */
858 unsigned char readin
;
861 /* A fast way to get from a psymtab to its symtab (after the first time). */
862 #define PSYMTAB_TO_SYMTAB(pst) \
863 ((pst) -> symtab != NULL ? (pst) -> symtab : psymtab_to_symtab (pst))
866 /* The virtual function table is now an array of structures which have the
867 form { int16 offset, delta; void *pfn; }.
869 In normal virtual function tables, OFFSET is unused.
870 DELTA is the amount which is added to the apparent object's base
871 address in order to point to the actual object to which the
872 virtual function should be applied.
873 PFN is a pointer to the virtual function.
875 Note that this macro is g++ specific (FIXME). */
877 #define VTBL_FNADDR_OFFSET 2
879 /* External variables and functions for the objects described above. */
881 /* See the comment in symfile.c about how current_objfile is used. */
883 extern struct objfile
*current_objfile
;
885 /* True if we are nested inside psymtab_to_symtab. */
887 extern int currently_reading_symtab
;
891 extern int asm_demangle
;
893 /* symtab.c lookup functions */
895 /* lookup a symbol table by source file name */
897 extern struct symtab
*lookup_symtab (const char *);
899 /* lookup a symbol by name (optional block, optional symtab) */
901 extern struct symbol
*lookup_symbol (const char *, const struct block
*,
902 const namespace_enum
, int *,
905 /* lookup a symbol by name, within a specified block */
907 extern struct symbol
*lookup_block_symbol (const struct block
*, const char *,
909 const namespace_enum
);
911 /* lookup a [struct, union, enum] by name, within a specified block */
913 extern struct type
*lookup_struct (char *, struct block
*);
915 extern struct type
*lookup_union (char *, struct block
*);
917 extern struct type
*lookup_enum (char *, struct block
*);
919 /* from blockframe.c: */
921 /* lookup the function symbol corresponding to the address */
923 extern struct symbol
*find_pc_function (CORE_ADDR
);
925 /* lookup the function corresponding to the address and section */
927 extern struct symbol
*find_pc_sect_function (CORE_ADDR
, asection
*);
929 /* lookup function from address, return name, start addr and end addr */
931 extern int find_pc_partial_function (CORE_ADDR
, char **, CORE_ADDR
*,
934 extern void clear_pc_function_cache (void);
936 extern int find_pc_sect_partial_function (CORE_ADDR
, asection
*,
937 char **, CORE_ADDR
*, CORE_ADDR
*);
941 /* lookup partial symbol table by filename */
943 extern struct partial_symtab
*lookup_partial_symtab (const char *);
945 /* lookup partial symbol table by address */
947 extern struct partial_symtab
*find_pc_psymtab (CORE_ADDR
);
949 /* lookup partial symbol table by address and section */
951 extern struct partial_symtab
*find_pc_sect_psymtab (CORE_ADDR
, asection
*);
953 /* lookup full symbol table by address */
955 extern struct symtab
*find_pc_symtab (CORE_ADDR
);
957 /* lookup full symbol table by address and section */
959 extern struct symtab
*find_pc_sect_symtab (CORE_ADDR
, asection
*);
961 /* lookup partial symbol by address */
963 extern struct partial_symbol
*find_pc_psymbol (struct partial_symtab
*,
966 /* lookup partial symbol by address and section */
968 extern struct partial_symbol
*find_pc_sect_psymbol (struct partial_symtab
*,
969 CORE_ADDR
, asection
*);
971 extern int find_pc_line_pc_range (CORE_ADDR
, CORE_ADDR
*, CORE_ADDR
*);
973 extern void reread_symbols (void);
975 extern struct type
*lookup_transparent_type (const char *);
978 /* Macro for name of symbol to indicate a file compiled with gcc. */
979 #ifndef GCC_COMPILED_FLAG_SYMBOL
980 #define GCC_COMPILED_FLAG_SYMBOL "gcc_compiled."
983 /* Macro for name of symbol to indicate a file compiled with gcc2. */
984 #ifndef GCC2_COMPILED_FLAG_SYMBOL
985 #define GCC2_COMPILED_FLAG_SYMBOL "gcc2_compiled."
988 /* Functions for dealing with the minimal symbol table, really a misc
989 address<->symbol mapping for things we don't have debug symbols for. */
991 extern void prim_record_minimal_symbol (const char *, CORE_ADDR
,
992 enum minimal_symbol_type
,
995 extern struct minimal_symbol
*prim_record_minimal_symbol_and_info
996 (const char *, CORE_ADDR
,
997 enum minimal_symbol_type
,
998 char *info
, int section
, asection
* bfd_section
, struct objfile
*);
1000 extern unsigned int msymbol_hash_iw (const char *);
1002 extern unsigned int msymbol_hash (const char *);
1005 add_minsym_to_hash_table (struct minimal_symbol
*sym
,
1006 struct minimal_symbol
**table
);
1008 extern struct minimal_symbol
*lookup_minimal_symbol (const char *,
1012 extern struct minimal_symbol
*lookup_minimal_symbol_text (const char *,
1016 struct minimal_symbol
*lookup_minimal_symbol_solib_trampoline (const char *,
1021 extern struct minimal_symbol
*lookup_minimal_symbol_by_pc (CORE_ADDR
);
1023 extern struct minimal_symbol
*lookup_minimal_symbol_by_pc_section (CORE_ADDR
,
1027 extern struct minimal_symbol
1028 *lookup_solib_trampoline_symbol_by_pc (CORE_ADDR
);
1030 extern CORE_ADDR
find_solib_trampoline_target (CORE_ADDR
);
1032 extern void init_minimal_symbol_collection (void);
1034 extern struct cleanup
*make_cleanup_discard_minimal_symbols (void);
1036 extern void install_minimal_symbols (struct objfile
*);
1038 /* Sort all the minimal symbols in OBJFILE. */
1040 extern void msymbols_sort (struct objfile
*objfile
);
1042 struct symtab_and_line
1044 struct symtab
*symtab
;
1046 /* Line number. Line numbers start at 1 and proceed through symtab->nlines.
1047 0 is never a valid line number; it is used to indicate that line number
1048 information is not available. */
1055 extern void init_sal (struct symtab_and_line
*sal
);
1057 struct symtabs_and_lines
1059 struct symtab_and_line
*sals
;
1065 /* Some types and macros needed for exception catchpoints.
1066 Can't put these in target.h because symtab_and_line isn't
1067 known there. This file will be included by breakpoint.c,
1068 hppa-tdep.c, etc. */
1070 /* Enums for exception-handling support */
1071 enum exception_event_kind
1077 /* Type for returning info about an exception */
1078 struct exception_event_record
1080 enum exception_event_kind kind
;
1081 struct symtab_and_line throw_sal
;
1082 struct symtab_and_line catch_sal
;
1083 /* This may need to be extended in the future, if
1084 some platforms allow reporting more information,
1085 such as point of rethrow, type of exception object,
1086 type expected by catch clause, etc. */
1089 #define CURRENT_EXCEPTION_KIND (current_exception_event->kind)
1090 #define CURRENT_EXCEPTION_CATCH_SAL (current_exception_event->catch_sal)
1091 #define CURRENT_EXCEPTION_CATCH_LINE (current_exception_event->catch_sal.line)
1092 #define CURRENT_EXCEPTION_CATCH_FILE (current_exception_event->catch_sal.symtab->filename)
1093 #define CURRENT_EXCEPTION_CATCH_PC (current_exception_event->catch_sal.pc)
1094 #define CURRENT_EXCEPTION_THROW_SAL (current_exception_event->throw_sal)
1095 #define CURRENT_EXCEPTION_THROW_LINE (current_exception_event->throw_sal.line)
1096 #define CURRENT_EXCEPTION_THROW_FILE (current_exception_event->throw_sal.symtab->filename)
1097 #define CURRENT_EXCEPTION_THROW_PC (current_exception_event->throw_sal.pc)
1100 /* Given a pc value, return line number it is in. Second arg nonzero means
1101 if pc is on the boundary use the previous statement's line number. */
1103 extern struct symtab_and_line
find_pc_line (CORE_ADDR
, int);
1105 /* Same function, but specify a section as well as an address */
1107 extern struct symtab_and_line
find_pc_sect_line (CORE_ADDR
, asection
*, int);
1109 /* Given a symtab and line number, return the pc there. */
1111 extern int find_line_pc (struct symtab
*, int, CORE_ADDR
*);
1113 extern int find_line_pc_range (struct symtab_and_line
, CORE_ADDR
*,
1116 extern void resolve_sal_pc (struct symtab_and_line
*);
1118 /* Given a string, return the line specified by it. For commands like "list"
1119 and "breakpoint". */
1121 extern struct symtabs_and_lines
decode_line_spec (char *, int);
1123 extern struct symtabs_and_lines
decode_line_spec_1 (char *, int);
1127 void maintenance_print_symbols (char *, int);
1129 void maintenance_print_psymbols (char *, int);
1131 void maintenance_print_msymbols (char *, int);
1133 void maintenance_print_objfiles (char *, int);
1135 void maintenance_check_symtabs (char *, int);
1139 void maintenance_print_statistics (char *, int);
1141 extern void free_symtab (struct symtab
*);
1143 /* Symbol-reading stuff in symfile.c and solib.c. */
1145 extern struct symtab
*psymtab_to_symtab (struct partial_symtab
*);
1147 extern void clear_solib (void);
1151 extern int identify_source_line (struct symtab
*, int, int, CORE_ADDR
);
1153 extern void print_source_lines (struct symtab
*, int, int, int);
1155 extern void forget_cached_source_info (void);
1157 extern void select_source_symtab (struct symtab
*);
1159 extern char **make_symbol_completion_list (char *, char *);
1161 extern char **make_file_symbol_completion_list (char *, char *, char *);
1163 extern struct symbol
**make_symbol_overload_list (struct symbol
*);
1165 extern char **make_source_files_completion_list (char *, char *);
1169 extern struct partial_symtab
*find_main_psymtab (void);
1171 extern struct symtab
*find_line_symtab (struct symtab
*, int, int *, int *);
1173 extern struct symtab_and_line
find_function_start_sal (struct symbol
*sym
,
1178 extern void clear_symtab_users (void);
1180 extern enum language
deduce_language_from_filename (char *);
1184 extern int in_prologue (CORE_ADDR pc
, CORE_ADDR func_start
);
1186 extern struct symbol
*fixup_symbol_section (struct symbol
*,
1189 extern struct partial_symbol
*fixup_psymbol_section (struct partial_symbol
1191 struct objfile
*objfile
);
1193 /* Symbol searching */
1195 /* When using search_symbols, a list of the following structs is returned.
1196 Callers must free the search list using free_search_symbols! */
1197 struct symbol_search
1199 /* The block in which the match was found. Could be, for example,
1200 STATIC_BLOCK or GLOBAL_BLOCK. */
1203 /* Information describing what was found.
1205 If symtab abd symbol are NOT NULL, then information was found
1207 struct symtab
*symtab
;
1208 struct symbol
*symbol
;
1210 /* If msymbol is non-null, then a match was made on something for
1211 which only minimal_symbols exist. */
1212 struct minimal_symbol
*msymbol
;
1214 /* A link to the next match, or NULL for the end. */
1215 struct symbol_search
*next
;
1218 extern void search_symbols (char *, namespace_enum
, int, char **,
1219 struct symbol_search
**);
1220 extern void free_search_symbols (struct symbol_search
*);
1221 extern struct cleanup
*make_cleanup_free_search_symbols (struct symbol_search
1224 /* The name of the ``main'' function.
1225 FIXME: cagney/2001-03-20: Can't make main_name() const since some
1226 of the calling code currently assumes that the string isn't
1228 extern void set_main_name (const char *name
);
1229 extern /*const */ char *main_name (void);
1231 #endif /* !defined(SYMTAB_H) */