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 a version of the name of a symbol that is
176 suitable for output. In C++ this is the "demangled" form of the
177 name if demangle is on and the "mangled" form of the name if
178 demangle is off. In other languages this is just the symbol name.
179 The result should never be NULL. Don't use this for internal
180 purposes (e.g. storing in a hashtable): it's only suitable for
183 #define SYMBOL_PRINT_NAME(symbol) \
184 (demangle && SYMBOL_DEMANGLED_NAME (symbol) != NULL \
185 ? SYMBOL_DEMANGLED_NAME (symbol) \
186 : SYMBOL_NAME (symbol))
188 /* Macro that tests a symbol for a match against a specified name string.
189 First test the unencoded name, then looks for and test a C++ encoded
190 name if it exists. Note that whitespace is ignored while attempting to
191 match a C++ encoded name, so that "foo::bar(int,long)" is the same as
192 "foo :: bar (int, long)".
193 Evaluates to zero if the match fails, or nonzero if it succeeds. */
195 #define SYMBOL_MATCHES_NAME(symbol, name) \
196 (STREQ (SYMBOL_NAME (symbol), (name)) \
197 || (SYMBOL_DEMANGLED_NAME (symbol) != NULL \
198 && strcmp_iw (SYMBOL_DEMANGLED_NAME (symbol), (name)) == 0))
200 /* Macro that tests a symbol for an re-match against the last compiled regular
201 expression. First test the unencoded name, then look for and test a C++
202 encoded name if it exists.
203 Evaluates to zero if the match fails, or nonzero if it succeeds. */
205 #define SYMBOL_MATCHES_REGEXP(symbol) \
206 (re_exec (SYMBOL_NAME (symbol)) != 0 \
207 || (SYMBOL_DEMANGLED_NAME (symbol) != NULL \
208 && re_exec (SYMBOL_DEMANGLED_NAME (symbol)) != 0))
210 /* Define a simple structure used to hold some very basic information about
211 all defined global symbols (text, data, bss, abs, etc). The only required
212 information is the general_symbol_info.
214 In many cases, even if a file was compiled with no special options for
215 debugging at all, as long as was not stripped it will contain sufficient
216 information to build a useful minimal symbol table using this structure.
217 Even when a file contains enough debugging information to build a full
218 symbol table, these minimal symbols are still useful for quickly mapping
219 between names and addresses, and vice versa. They are also sometimes
220 used to figure out what full symbol table entries need to be read in. */
222 struct minimal_symbol
225 /* The general symbol info required for all types of symbols.
227 The SYMBOL_VALUE_ADDRESS contains the address that this symbol
230 struct general_symbol_info ginfo
;
232 /* The info field is available for caching machine-specific information
233 so it doesn't have to rederive the info constantly (over a serial line).
234 It is initialized to zero and stays that way until target-dependent code
235 sets it. Storage for any data pointed to by this field should be allo-
236 cated on the symbol_obstack for the associated objfile.
237 The type would be "void *" except for reasons of compatibility with older
238 compilers. This field is optional.
240 Currently, the AMD 29000 tdep.c uses it to remember things it has decoded
241 from the instructions in the function header, and the MIPS-16 code uses
242 it to identify 16-bit procedures. */
246 #ifdef SOFUN_ADDRESS_MAYBE_MISSING
247 /* Which source file is this symbol in? Only relevant for mst_file_*. */
251 /* Classification types for this symbol. These should be taken as "advisory
252 only", since if gdb can't easily figure out a classification it simply
253 selects mst_unknown. It may also have to guess when it can't figure out
254 which is a better match between two types (mst_data versus mst_bss) for
255 example. Since the minimal symbol info is sometimes derived from the
256 BFD library's view of a file, we need to live with what information bfd
259 enum minimal_symbol_type
261 mst_unknown
= 0, /* Unknown type, the default */
262 mst_text
, /* Generally executable instructions */
263 mst_data
, /* Generally initialized data */
264 mst_bss
, /* Generally uninitialized data */
265 mst_abs
, /* Generally absolute (nonrelocatable) */
266 /* GDB uses mst_solib_trampoline for the start address of a shared
267 library trampoline entry. Breakpoints for shared library functions
268 are put there if the shared library is not yet loaded.
269 After the shared library is loaded, lookup_minimal_symbol will
270 prefer the minimal symbol from the shared library (usually
271 a mst_text symbol) over the mst_solib_trampoline symbol, and the
272 breakpoints will be moved to their true address in the shared
273 library via breakpoint_re_set. */
274 mst_solib_trampoline
, /* Shared library trampoline code */
275 /* For the mst_file* types, the names are only guaranteed to be unique
276 within a given .o file. */
277 mst_file_text
, /* Static version of mst_text */
278 mst_file_data
, /* Static version of mst_data */
279 mst_file_bss
/* Static version of mst_bss */
283 /* Minimal symbols with the same hash key are kept on a linked
284 list. This is the link. */
286 struct minimal_symbol
*hash_next
;
288 /* Minimal symbols are stored in two different hash tables. This is
289 the `next' pointer for the demangled hash table. */
291 struct minimal_symbol
*demangled_hash_next
;
294 #define MSYMBOL_INFO(msymbol) (msymbol)->info
295 #define MSYMBOL_TYPE(msymbol) (msymbol)->type
299 /* Represent one symbol name; a variable, constant, function or typedef. */
301 /* Different name spaces for symbols. Looking up a symbol specifies a
302 namespace and ignores symbol definitions in other name spaces. */
306 /* UNDEF_NAMESPACE is used when a namespace has not been discovered or
307 none of the following apply. This usually indicates an error either
308 in the symbol information or in gdb's handling of symbols. */
312 /* VAR_NAMESPACE is the usual namespace. In C, this contains variables,
313 function names, typedef names and enum type values. */
317 /* STRUCT_NAMESPACE is used in C to hold struct, union and enum type names.
318 Thus, if `struct foo' is used in a C program, it produces a symbol named
319 `foo' in the STRUCT_NAMESPACE. */
323 /* LABEL_NAMESPACE may be used for names of labels (for gotos);
324 currently it is not used and labels are not recorded at all. */
328 /* Searching namespaces. These overlap with VAR_NAMESPACE, providing
329 some granularity with the search_symbols function. */
331 /* Everything in VAR_NAMESPACE minus FUNCTIONS_-, TYPES_-, and
335 /* All functions -- for some reason not methods, though. */
338 /* All defined types */
341 /* All class methods -- why is this separated out? */
346 /* An address-class says where to find the value of a symbol. */
350 /* Not used; catches errors */
354 /* Value is constant int SYMBOL_VALUE, host byteorder */
358 /* Value is at fixed address SYMBOL_VALUE_ADDRESS */
362 /* Value is in register. SYMBOL_VALUE is the register number. */
366 /* It's an argument; the value is at SYMBOL_VALUE offset in arglist. */
370 /* Value address is at SYMBOL_VALUE offset in arglist. */
374 /* Value is in register number SYMBOL_VALUE. Just like LOC_REGISTER
375 except this is an argument. Probably the cleaner way to handle
376 this would be to separate address_class (which would include
377 separate ARG and LOCAL to deal with FRAME_ARGS_ADDRESS versus
378 FRAME_LOCALS_ADDRESS), and an is_argument flag.
380 For some symbol formats (stabs, for some compilers at least),
381 the compiler generates two symbols, an argument and a register.
382 In some cases we combine them to a single LOC_REGPARM in symbol
383 reading, but currently not for all cases (e.g. it's passed on the
384 stack and then loaded into a register). */
388 /* Value is in specified register. Just like LOC_REGPARM except the
389 register holds the address of the argument instead of the argument
390 itself. This is currently used for the passing of structs and unions
391 on sparc and hppa. It is also used for call by reference where the
392 address is in a register, at least by mipsread.c. */
396 /* Value is a local variable at SYMBOL_VALUE offset in stack frame. */
400 /* Value not used; definition in SYMBOL_TYPE. Symbols in the namespace
401 STRUCT_NAMESPACE all have this class. */
405 /* Value is address SYMBOL_VALUE_ADDRESS in the code */
409 /* In a symbol table, value is SYMBOL_BLOCK_VALUE of a `struct block'.
410 In a partial symbol table, SYMBOL_VALUE_ADDRESS is the start address
411 of the block. Function names have this class. */
415 /* Value is a constant byte-sequence pointed to by SYMBOL_VALUE_BYTES, in
416 target byte order. */
420 /* Value is arg at SYMBOL_VALUE offset in stack frame. Differs from
421 LOC_LOCAL in that symbol is an argument; differs from LOC_ARG in
422 that we find it in the frame (FRAME_LOCALS_ADDRESS), not in the
423 arglist (FRAME_ARGS_ADDRESS). Added for i960, which passes args
424 in regs then copies to frame. */
428 /* Value is at SYMBOL_VALUE offset from the current value of
429 register number SYMBOL_BASEREG. This exists mainly for the same
430 things that LOC_LOCAL and LOC_ARG do; but we need to do this
431 instead because on 88k DWARF gives us the offset from the
432 frame/stack pointer, rather than the offset from the "canonical
433 frame address" used by COFF, stabs, etc., and we don't know how
434 to convert between these until we start examining prologues.
436 Note that LOC_BASEREG is much less general than a DWARF expression.
437 We don't need the generality (at least not yet), and storing a general
438 DWARF expression would presumably take up more space than the existing
443 /* Same as LOC_BASEREG but it is an argument. */
447 /* Value is at fixed address, but the address of the variable has
448 to be determined from the minimal symbol table whenever the
449 variable is referenced.
450 This happens if debugging information for a global symbol is
451 emitted and the corresponding minimal symbol is defined
452 in another object file or runtime common storage.
453 The linker might even remove the minimal symbol if the global
454 symbol is never referenced, in which case the symbol remains
459 /* Value is at a thread-specific location calculated by a
460 target-specific method. This is used only by hppa. */
462 LOC_HP_THREAD_LOCAL_STATIC
,
464 /* Value is at a thread-specific location calculated by a
465 target-specific method. SYMBOL_OBJFILE gives the object file
466 in which the symbol is defined; the symbol's value is the
467 offset into that objfile's thread-local storage for the current
470 LOC_THREAD_LOCAL_STATIC
,
472 /* The variable does not actually exist in the program.
473 The value is ignored. */
477 /* The variable is static, but actually lives at * (address).
478 * I.e. do an extra indirection to get to it.
479 * This is used on HP-UX to get at globals that are allocated
480 * in shared libraries, where references from images other
481 * than the one where the global was allocated are done
482 * with a level of indirection.
488 /* Linked list of symbol's live ranges. */
494 struct range_list
*next
;
497 /* Linked list of aliases for a particular main/primary symbol. */
501 struct alias_list
*next
;
507 /* The general symbol info required for all types of symbols. */
509 struct general_symbol_info ginfo
;
511 /* Data type of value */
515 /* Name space code. */
518 /* FIXME: don't conflict with C++'s namespace */
519 /* would be safer to do a global change for all namespace identifiers. */
520 #define namespace _namespace
522 namespace_enum
namespace BYTE_BITFIELD
;
526 enum address_class aclass BYTE_BITFIELD
;
528 /* Line number of definition. FIXME: Should we really make the assumption
529 that nobody will try to debug files longer than 64K lines? What about
530 machine generated programs? */
534 /* Some symbols require an additional value to be recorded on a per-
535 symbol basis. Stash those values here. */
539 /* Used by LOC_BASEREG and LOC_BASEREG_ARG. */
542 /* Used by LOC_THREAD_LOCAL_STATIC. The objfile in which this
543 symbol is defined. To find a thread-local variable (e.g., a
544 variable declared with the `__thread' storage class), we may
545 need to know which object file it's in. */
546 struct objfile
*objfile
;
551 /* Link to a list of aliases for this symbol.
552 Only a "primary/main symbol may have aliases. */
553 struct alias_list
*aliases
;
555 /* List of ranges where this symbol is active. This is only
556 used by alias symbols at the current time. */
557 struct range_list
*ranges
;
559 struct symbol
*hash_next
;
563 #define SYMBOL_NAMESPACE(symbol) (symbol)->namespace
564 #define SYMBOL_CLASS(symbol) (symbol)->aclass
565 #define SYMBOL_TYPE(symbol) (symbol)->type
566 #define SYMBOL_LINE(symbol) (symbol)->line
567 #define SYMBOL_BASEREG(symbol) (symbol)->aux_value.basereg
568 #define SYMBOL_OBJFILE(symbol) (symbol)->aux_value.objfile
569 #define SYMBOL_ALIASES(symbol) (symbol)->aliases
570 #define SYMBOL_RANGES(symbol) (symbol)->ranges
572 /* A partial_symbol records the name, namespace, and address class of
573 symbols whose types we have not parsed yet. For functions, it also
574 contains their memory address, so we can find them from a PC value.
575 Each partial_symbol sits in a partial_symtab, all of which are chained
576 on a partial symtab list and which points to the corresponding
577 normal symtab once the partial_symtab has been referenced. */
579 struct partial_symbol
582 /* The general symbol info required for all types of symbols. */
584 struct general_symbol_info ginfo
;
586 /* Name space code. */
588 namespace_enum
namespace BYTE_BITFIELD
;
590 /* Address class (for info_symbols) */
592 enum address_class aclass BYTE_BITFIELD
;
596 #define PSYMBOL_NAMESPACE(psymbol) (psymbol)->namespace
597 #define PSYMBOL_CLASS(psymbol) (psymbol)->aclass
600 /* Each item represents a line-->pc (or the reverse) mapping. This is
601 somewhat more wasteful of space than one might wish, but since only
602 the files which are actually debugged are read in to core, we don't
605 struct linetable_entry
611 /* The order of entries in the linetable is significant. They should
612 be sorted by increasing values of the pc field. If there is more than
613 one entry for a given pc, then I'm not sure what should happen (and
614 I not sure whether we currently handle it the best way).
616 Example: a C for statement generally looks like this
618 10 0x100 - for the init/test part of a for stmt.
621 10 0x400 - for the increment part of a for stmt.
623 If an entry has a line number of zero, it marks the start of a PC
624 range for which no line number information is available. It is
625 acceptable, though wasteful of table space, for such a range to be
632 /* Actually NITEMS elements. If you don't like this use of the
633 `struct hack', you can shove it up your ANSI (seriously, if the
634 committee tells us how to do it, we can probably go along). */
635 struct linetable_entry item
[1];
638 /* How to relocate the symbols from each section in a symbol file.
639 Each struct contains an array of offsets.
640 The ordering and meaning of the offsets is file-type-dependent;
641 typically it is indexed by section numbers or symbol types or
644 To give us flexibility in changing the internal representation
645 of these offsets, the ANOFFSET macro must be used to insert and
646 extract offset values in the struct. */
648 struct section_offsets
650 CORE_ADDR offsets
[1]; /* As many as needed. */
653 #define ANOFFSET(secoff, whichone) \
655 ? (internal_error (__FILE__, __LINE__, "Section index is uninitialized"), -1) \
656 : secoff->offsets[whichone])
658 /* The size of a section_offsets table for N sections. */
659 #define SIZEOF_N_SECTION_OFFSETS(n) \
660 (sizeof (struct section_offsets) \
661 + sizeof (((struct section_offsets *) 0)->offsets) * ((n)-1))
663 /* The maximum possible size of a section_offsets table. */
664 #define SIZEOF_SECTION_OFFSETS (SIZEOF_N_SECTION_OFFSETS (SECT_OFF_MAX))
666 /* Each source file or header is represented by a struct symtab.
667 These objects are chained through the `next' field. */
672 /* Chain of all existing symtabs. */
676 /* List of all symbol scope blocks for this symtab. May be shared
677 between different symtabs (and normally is for all the symtabs
678 in a given compilation unit). */
680 struct blockvector
*blockvector
;
682 /* Table mapping core addresses to line numbers for this file.
683 Can be NULL if none. Never shared between different symtabs. */
685 struct linetable
*linetable
;
687 /* Section in objfile->section_offsets for the blockvector and
688 the linetable. Probably always SECT_OFF_TEXT. */
690 int block_line_section
;
692 /* If several symtabs share a blockvector, exactly one of them
693 should be designated the primary, so that the blockvector
694 is relocated exactly once by objfile_relocate. */
698 /* The macro table for this symtab. Like the blockvector, this
699 may be shared between different symtabs --- and normally is for
700 all the symtabs in a given compilation unit. */
701 struct macro_table
*macro_table
;
703 /* Name of this source file. */
707 /* Directory in which it was compiled, or NULL if we don't know. */
711 /* This component says how to free the data we point to:
712 free_contents => do a tree walk and free each object.
713 free_nothing => do nothing; some other symtab will free
714 the data this one uses.
715 free_linetable => free just the linetable. FIXME: Is this redundant
716 with the primary field? */
720 free_nothing
, free_contents
, free_linetable
724 /* Pointer to one block of storage to be freed, if nonzero. */
725 /* This is IN ADDITION to the action indicated by free_code. */
729 /* Total number of lines found in source file. */
733 /* line_charpos[N] is the position of the (N-1)th line of the
734 source file. "position" means something we can lseek() to; it
735 is not guaranteed to be useful any other way. */
739 /* Language of this source file. */
741 enum language language
;
743 /* String that identifies the format of the debugging information, such
744 as "stabs", "dwarf 1", "dwarf 2", "coff", etc. This is mostly useful
745 for automated testing of gdb but may also be information that is
746 useful to the user. */
750 /* String of version information. May be zero. */
754 /* Full name of file as found by searching the source path.
755 NULL if not yet known. */
759 /* Object file from which this symbol information was read. */
761 struct objfile
*objfile
;
765 #define BLOCKVECTOR(symtab) (symtab)->blockvector
766 #define LINETABLE(symtab) (symtab)->linetable
769 /* Each source file that has not been fully read in is represented by
770 a partial_symtab. This contains the information on where in the
771 executable the debugging symbols for a specific file are, and a
772 list of names of global symbols which are located in this file.
773 They are all chained on partial symtab lists.
775 Even after the source file has been read into a symtab, the
776 partial_symtab remains around. They are allocated on an obstack,
777 psymbol_obstack. FIXME, this is bad for dynamic linking or VxWorks-
778 style execution of a bunch of .o's. */
780 struct partial_symtab
783 /* Chain of all existing partial symtabs. */
785 struct partial_symtab
*next
;
787 /* Name of the source file which this partial_symtab defines */
791 /* Full path of the source file. NULL if not known. */
795 /* Information about the object file from which symbols should be read. */
797 struct objfile
*objfile
;
799 /* Set of relocation offsets to apply to each section. */
801 struct section_offsets
*section_offsets
;
803 /* Range of text addresses covered by this file; texthigh is the
804 beginning of the next section. */
809 /* Array of pointers to all of the partial_symtab's which this one
810 depends on. Since this array can only be set to previous or
811 the current (?) psymtab, this dependency tree is guaranteed not
812 to have any loops. "depends on" means that symbols must be read
813 for the dependencies before being read for this psymtab; this is
814 for type references in stabs, where if foo.c includes foo.h, declarations
815 in foo.h may use type numbers defined in foo.c. For other debugging
816 formats there may be no need to use dependencies. */
818 struct partial_symtab
**dependencies
;
820 int number_of_dependencies
;
822 /* Global symbol list. This list will be sorted after readin to
823 improve access. Binary search will be the usual method of
824 finding a symbol within it. globals_offset is an integer offset
825 within global_psymbols[]. */
830 /* Static symbol list. This list will *not* be sorted after readin;
831 to find a symbol in it, exhaustive search must be used. This is
832 reasonable because searches through this list will eventually
833 lead to either the read in of a files symbols for real (assumed
834 to take a *lot* of time; check) or an error (and we don't care
835 how long errors take). This is an offset and size within
836 static_psymbols[]. */
841 /* Pointer to symtab eventually allocated for this source file, 0 if
842 !readin or if we haven't looked for the symtab after it was readin. */
844 struct symtab
*symtab
;
846 /* Pointer to function which will read in the symtab corresponding to
849 void (*read_symtab
) (struct partial_symtab
*);
851 /* Information that lets read_symtab() locate the part of the symbol table
852 that this psymtab corresponds to. This information is private to the
853 format-dependent symbol reading routines. For further detail examine
854 the various symbol reading modules. Should really be (void *) but is
855 (char *) as with other such gdb variables. (FIXME) */
857 char *read_symtab_private
;
859 /* Non-zero if the symtab corresponding to this psymtab has been readin */
861 unsigned char readin
;
864 /* A fast way to get from a psymtab to its symtab (after the first time). */
865 #define PSYMTAB_TO_SYMTAB(pst) \
866 ((pst) -> symtab != NULL ? (pst) -> symtab : psymtab_to_symtab (pst))
869 /* The virtual function table is now an array of structures which have the
870 form { int16 offset, delta; void *pfn; }.
872 In normal virtual function tables, OFFSET is unused.
873 DELTA is the amount which is added to the apparent object's base
874 address in order to point to the actual object to which the
875 virtual function should be applied.
876 PFN is a pointer to the virtual function.
878 Note that this macro is g++ specific (FIXME). */
880 #define VTBL_FNADDR_OFFSET 2
882 /* External variables and functions for the objects described above. */
884 /* See the comment in symfile.c about how current_objfile is used. */
886 extern struct objfile
*current_objfile
;
888 /* True if we are nested inside psymtab_to_symtab. */
890 extern int currently_reading_symtab
;
894 extern int asm_demangle
;
896 /* symtab.c lookup functions */
898 /* lookup a symbol table by source file name */
900 extern struct symtab
*lookup_symtab (const char *);
902 /* lookup a symbol by name (optional block, optional symtab) */
904 extern struct symbol
*lookup_symbol (const char *, const struct block
*,
905 const namespace_enum
, int *,
908 /* lookup a symbol by name, within a specified block */
910 extern struct symbol
*lookup_block_symbol (const struct block
*, const char *,
912 const namespace_enum
);
914 /* lookup a [struct, union, enum] by name, within a specified block */
916 extern struct type
*lookup_struct (char *, struct block
*);
918 extern struct type
*lookup_union (char *, struct block
*);
920 extern struct type
*lookup_enum (char *, struct block
*);
922 /* from blockframe.c: */
924 /* lookup the function symbol corresponding to the address */
926 extern struct symbol
*find_pc_function (CORE_ADDR
);
928 /* lookup the function corresponding to the address and section */
930 extern struct symbol
*find_pc_sect_function (CORE_ADDR
, asection
*);
932 /* lookup function from address, return name, start addr and end addr */
934 extern int find_pc_partial_function (CORE_ADDR
, char **, CORE_ADDR
*,
937 extern void clear_pc_function_cache (void);
939 extern int find_pc_sect_partial_function (CORE_ADDR
, asection
*,
940 char **, CORE_ADDR
*, CORE_ADDR
*);
944 /* lookup partial symbol table by filename */
946 extern struct partial_symtab
*lookup_partial_symtab (const char *);
948 /* lookup partial symbol table by address */
950 extern struct partial_symtab
*find_pc_psymtab (CORE_ADDR
);
952 /* lookup partial symbol table by address and section */
954 extern struct partial_symtab
*find_pc_sect_psymtab (CORE_ADDR
, asection
*);
956 /* lookup full symbol table by address */
958 extern struct symtab
*find_pc_symtab (CORE_ADDR
);
960 /* lookup full symbol table by address and section */
962 extern struct symtab
*find_pc_sect_symtab (CORE_ADDR
, asection
*);
964 /* lookup partial symbol by address */
966 extern struct partial_symbol
*find_pc_psymbol (struct partial_symtab
*,
969 /* lookup partial symbol by address and section */
971 extern struct partial_symbol
*find_pc_sect_psymbol (struct partial_symtab
*,
972 CORE_ADDR
, asection
*);
974 extern int find_pc_line_pc_range (CORE_ADDR
, CORE_ADDR
*, CORE_ADDR
*);
976 extern void reread_symbols (void);
978 extern struct type
*lookup_transparent_type (const char *);
981 /* Macro for name of symbol to indicate a file compiled with gcc. */
982 #ifndef GCC_COMPILED_FLAG_SYMBOL
983 #define GCC_COMPILED_FLAG_SYMBOL "gcc_compiled."
986 /* Macro for name of symbol to indicate a file compiled with gcc2. */
987 #ifndef GCC2_COMPILED_FLAG_SYMBOL
988 #define GCC2_COMPILED_FLAG_SYMBOL "gcc2_compiled."
991 /* Functions for dealing with the minimal symbol table, really a misc
992 address<->symbol mapping for things we don't have debug symbols for. */
994 extern void prim_record_minimal_symbol (const char *, CORE_ADDR
,
995 enum minimal_symbol_type
,
998 extern struct minimal_symbol
*prim_record_minimal_symbol_and_info
999 (const char *, CORE_ADDR
,
1000 enum minimal_symbol_type
,
1001 char *info
, int section
, asection
* bfd_section
, struct objfile
*);
1003 extern unsigned int msymbol_hash_iw (const char *);
1005 extern unsigned int msymbol_hash (const char *);
1008 add_minsym_to_hash_table (struct minimal_symbol
*sym
,
1009 struct minimal_symbol
**table
);
1011 extern struct minimal_symbol
*lookup_minimal_symbol (const char *,
1015 extern struct minimal_symbol
*lookup_minimal_symbol_text (const char *,
1019 struct minimal_symbol
*lookup_minimal_symbol_solib_trampoline (const char *,
1024 extern struct minimal_symbol
*lookup_minimal_symbol_by_pc (CORE_ADDR
);
1026 extern struct minimal_symbol
*lookup_minimal_symbol_by_pc_section (CORE_ADDR
,
1030 extern struct minimal_symbol
1031 *lookup_solib_trampoline_symbol_by_pc (CORE_ADDR
);
1033 extern CORE_ADDR
find_solib_trampoline_target (CORE_ADDR
);
1035 extern void init_minimal_symbol_collection (void);
1037 extern struct cleanup
*make_cleanup_discard_minimal_symbols (void);
1039 extern void install_minimal_symbols (struct objfile
*);
1041 /* Sort all the minimal symbols in OBJFILE. */
1043 extern void msymbols_sort (struct objfile
*objfile
);
1045 struct symtab_and_line
1047 struct symtab
*symtab
;
1049 /* Line number. Line numbers start at 1 and proceed through symtab->nlines.
1050 0 is never a valid line number; it is used to indicate that line number
1051 information is not available. */
1058 extern void init_sal (struct symtab_and_line
*sal
);
1060 struct symtabs_and_lines
1062 struct symtab_and_line
*sals
;
1068 /* Some types and macros needed for exception catchpoints.
1069 Can't put these in target.h because symtab_and_line isn't
1070 known there. This file will be included by breakpoint.c,
1071 hppa-tdep.c, etc. */
1073 /* Enums for exception-handling support */
1074 enum exception_event_kind
1080 /* Type for returning info about an exception */
1081 struct exception_event_record
1083 enum exception_event_kind kind
;
1084 struct symtab_and_line throw_sal
;
1085 struct symtab_and_line catch_sal
;
1086 /* This may need to be extended in the future, if
1087 some platforms allow reporting more information,
1088 such as point of rethrow, type of exception object,
1089 type expected by catch clause, etc. */
1092 #define CURRENT_EXCEPTION_KIND (current_exception_event->kind)
1093 #define CURRENT_EXCEPTION_CATCH_SAL (current_exception_event->catch_sal)
1094 #define CURRENT_EXCEPTION_CATCH_LINE (current_exception_event->catch_sal.line)
1095 #define CURRENT_EXCEPTION_CATCH_FILE (current_exception_event->catch_sal.symtab->filename)
1096 #define CURRENT_EXCEPTION_CATCH_PC (current_exception_event->catch_sal.pc)
1097 #define CURRENT_EXCEPTION_THROW_SAL (current_exception_event->throw_sal)
1098 #define CURRENT_EXCEPTION_THROW_LINE (current_exception_event->throw_sal.line)
1099 #define CURRENT_EXCEPTION_THROW_FILE (current_exception_event->throw_sal.symtab->filename)
1100 #define CURRENT_EXCEPTION_THROW_PC (current_exception_event->throw_sal.pc)
1103 /* Given a pc value, return line number it is in. Second arg nonzero means
1104 if pc is on the boundary use the previous statement's line number. */
1106 extern struct symtab_and_line
find_pc_line (CORE_ADDR
, int);
1108 /* Same function, but specify a section as well as an address */
1110 extern struct symtab_and_line
find_pc_sect_line (CORE_ADDR
, asection
*, int);
1112 /* Given a symtab and line number, return the pc there. */
1114 extern int find_line_pc (struct symtab
*, int, CORE_ADDR
*);
1116 extern int find_line_pc_range (struct symtab_and_line
, CORE_ADDR
*,
1119 extern void resolve_sal_pc (struct symtab_and_line
*);
1121 /* Given a string, return the line specified by it. For commands like "list"
1122 and "breakpoint". */
1124 extern struct symtabs_and_lines
decode_line_spec (char *, int);
1126 extern struct symtabs_and_lines
decode_line_spec_1 (char *, int);
1130 void maintenance_print_symbols (char *, int);
1132 void maintenance_print_psymbols (char *, int);
1134 void maintenance_print_msymbols (char *, int);
1136 void maintenance_print_objfiles (char *, int);
1138 void maintenance_check_symtabs (char *, int);
1142 void maintenance_print_statistics (char *, int);
1144 extern void free_symtab (struct symtab
*);
1146 /* Symbol-reading stuff in symfile.c and solib.c. */
1148 extern struct symtab
*psymtab_to_symtab (struct partial_symtab
*);
1150 extern void clear_solib (void);
1154 extern int identify_source_line (struct symtab
*, int, int, CORE_ADDR
);
1156 extern void print_source_lines (struct symtab
*, int, int, int);
1158 extern void forget_cached_source_info (void);
1160 extern void select_source_symtab (struct symtab
*);
1162 extern char **make_symbol_completion_list (char *, char *);
1164 extern char **make_file_symbol_completion_list (char *, char *, char *);
1166 extern struct symbol
**make_symbol_overload_list (struct symbol
*);
1168 extern char **make_source_files_completion_list (char *, char *);
1172 extern struct partial_symtab
*find_main_psymtab (void);
1174 extern struct symtab
*find_line_symtab (struct symtab
*, int, int *, int *);
1176 extern struct symtab_and_line
find_function_start_sal (struct symbol
*sym
,
1181 extern void clear_symtab_users (void);
1183 extern enum language
deduce_language_from_filename (char *);
1187 extern int in_prologue (CORE_ADDR pc
, CORE_ADDR func_start
);
1189 extern struct symbol
*fixup_symbol_section (struct symbol
*,
1192 extern struct partial_symbol
*fixup_psymbol_section (struct partial_symbol
1194 struct objfile
*objfile
);
1196 /* Symbol searching */
1198 /* When using search_symbols, a list of the following structs is returned.
1199 Callers must free the search list using free_search_symbols! */
1200 struct symbol_search
1202 /* The block in which the match was found. Could be, for example,
1203 STATIC_BLOCK or GLOBAL_BLOCK. */
1206 /* Information describing what was found.
1208 If symtab abd symbol are NOT NULL, then information was found
1210 struct symtab
*symtab
;
1211 struct symbol
*symbol
;
1213 /* If msymbol is non-null, then a match was made on something for
1214 which only minimal_symbols exist. */
1215 struct minimal_symbol
*msymbol
;
1217 /* A link to the next match, or NULL for the end. */
1218 struct symbol_search
*next
;
1221 extern void search_symbols (char *, namespace_enum
, int, char **,
1222 struct symbol_search
**);
1223 extern void free_search_symbols (struct symbol_search
*);
1224 extern struct cleanup
*make_cleanup_free_search_symbols (struct symbol_search
1227 /* The name of the ``main'' function.
1228 FIXME: cagney/2001-03-20: Can't make main_name() const since some
1229 of the calling code currently assumes that the string isn't
1231 extern void set_main_name (const char *name
);
1232 extern /*const */ char *main_name (void);
1234 #endif /* !defined(SYMTAB_H) */