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. */
30 /* Don't do this; it means that if some .o's are compiled with GNU C
31 and some are not (easy to do accidentally the way we configure
32 things; also it is a pain to have to "make clean" every time you
33 want to switch compilers), then GDB dies a horrible death. */
34 /* GNU C supports enums that are bitfields. Some compilers don't. */
35 #if 0 && defined(__GNUC__) && !defined(BYTE_BITFIELD)
36 #define BYTE_BITFIELD :8;
38 #define BYTE_BITFIELD /*nothing */
41 /* Define a structure for the information that is common to all symbol types,
42 including minimal symbols, partial symbols, and full symbols. In a
43 multilanguage environment, some language specific information may need to
44 be recorded along with each symbol.
46 These fields are ordered to encourage good packing, since we frequently
47 have tens or hundreds of thousands of these. */
49 struct general_symbol_info
51 /* Name of the symbol. This is a required field. Storage for the name is
52 allocated on the psymbol_obstack or symbol_obstack for the associated
57 /* Value of the symbol. Which member of this union to use, and what
58 it means, depends on what kind of symbol this is and its
59 SYMBOL_CLASS. See comments there for more details. All of these
60 are in host byte order (though what they point to might be in
61 target byte order, e.g. LOC_CONST_BYTES). */
65 /* The fact that this is a long not a LONGEST mainly limits the
66 range of a LOC_CONST. Since LOC_CONST_BYTES exists, I'm not
67 sure that is a big deal. */
76 /* for opaque typedef struct chain */
82 /* Since one and only one language can apply, wrap the language specific
83 information inside a union. */
87 struct cplus_specific
/* For C++ */
101 /* Record the source code language that applies to this symbol.
102 This is used to select one of the fields from the language specific
105 enum language language BYTE_BITFIELD
;
107 /* Which section is this symbol in? This is an index into
108 section_offsets for this objfile. Negative means that the symbol
109 does not get relocated relative to a section.
110 Disclaimer: currently this is just used for xcoff, so don't
111 expect all symbol-reading code to set it correctly (the ELF code
112 also tries to set it correctly). */
116 /* The bfd section associated with this symbol. */
118 asection
*bfd_section
;
121 extern CORE_ADDR
symbol_overlayed_address (CORE_ADDR
, asection
*);
123 /* Note that all the following SYMBOL_* macros are used with the
124 SYMBOL argument being either a partial symbol, a minimal symbol or
125 a full symbol. All three types have a ginfo field. In particular
126 the SYMBOL_INIT_LANGUAGE_SPECIFIC, SYMBOL_INIT_DEMANGLED_NAME,
127 SYMBOL_DEMANGLED_NAME macros cannot be entirely substituted by
128 functions, unless the callers are changed to pass in the ginfo
129 field only, instead of the SYMBOL parameter. */
131 #define SYMBOL_NAME(symbol) (symbol)->ginfo.name
132 #define SYMBOL_VALUE(symbol) (symbol)->ginfo.value.ivalue
133 #define SYMBOL_VALUE_ADDRESS(symbol) (symbol)->ginfo.value.address
134 #define SYMBOL_VALUE_BYTES(symbol) (symbol)->ginfo.value.bytes
135 #define SYMBOL_BLOCK_VALUE(symbol) (symbol)->ginfo.value.block
136 #define SYMBOL_VALUE_CHAIN(symbol) (symbol)->ginfo.value.chain
137 #define SYMBOL_LANGUAGE(symbol) (symbol)->ginfo.language
138 #define SYMBOL_SECTION(symbol) (symbol)->ginfo.section
139 #define SYMBOL_BFD_SECTION(symbol) (symbol)->ginfo.bfd_section
141 #define SYMBOL_CPLUS_DEMANGLED_NAME(symbol) \
142 (symbol)->ginfo.language_specific.cplus_specific.demangled_name
144 /* Initializes the language dependent portion of a symbol
145 depending upon the language for the symbol. */
146 #define SYMBOL_INIT_LANGUAGE_SPECIFIC(symbol,language) \
147 (symbol_init_language_specific (&(symbol)->ginfo, (language)))
148 extern void symbol_init_language_specific (struct general_symbol_info
*symbol
,
149 enum language language
);
151 #define SYMBOL_INIT_DEMANGLED_NAME(symbol,obstack) \
152 (symbol_init_demangled_name (&(symbol)->ginfo, (obstack)))
153 extern void symbol_init_demangled_name (struct general_symbol_info
*symbol
,
154 struct obstack
*obstack
);
156 #define SYMBOL_SET_NAMES(symbol,name,len,objfile) \
157 symbol_set_names (&(symbol)->ginfo, name, len, objfile)
158 extern void symbol_set_names (struct general_symbol_info
*symbol
,
159 const char *name
, int len
,
160 struct objfile
*objfile
);
162 /* Return the demangled name for a symbol based on the language for
163 that symbol. If no demangled name exists, return NULL. */
164 #define SYMBOL_DEMANGLED_NAME(symbol) \
165 (symbol_demangled_name (&(symbol)->ginfo))
166 extern char *symbol_demangled_name (struct general_symbol_info
*symbol
);
168 #define SYMBOL_OBJC_DEMANGLED_NAME(symbol) \
169 (symbol)->ginfo.language_specific.objc_specific.demangled_name
171 /* Macro that returns the "natural source name" of a symbol. In C++ this is
172 the "demangled" form of the name if demangle is on and the "mangled" form
173 of the name if demangle is off. In other languages this is just the
174 symbol name. The result should never be NULL. */
176 #define SYMBOL_SOURCE_NAME(symbol) \
177 (demangle && SYMBOL_DEMANGLED_NAME (symbol) != NULL \
178 ? SYMBOL_DEMANGLED_NAME (symbol) \
179 : SYMBOL_NAME (symbol))
181 /* Macro that tests a symbol for a match against a specified name string.
182 First test the unencoded name, then looks for and test a C++ encoded
183 name if it exists. Note that whitespace is ignored while attempting to
184 match a C++ encoded name, so that "foo::bar(int,long)" is the same as
185 "foo :: bar (int, long)".
186 Evaluates to zero if the match fails, or nonzero if it succeeds. */
188 #define SYMBOL_MATCHES_NAME(symbol, name) \
189 (STREQ (SYMBOL_NAME (symbol), (name)) \
190 || (SYMBOL_DEMANGLED_NAME (symbol) != NULL \
191 && strcmp_iw (SYMBOL_DEMANGLED_NAME (symbol), (name)) == 0))
193 /* Macro that tests a symbol for an re-match against the last compiled regular
194 expression. First test the unencoded name, then look for and test a C++
195 encoded name if it exists.
196 Evaluates to zero if the match fails, or nonzero if it succeeds. */
198 #define SYMBOL_MATCHES_REGEXP(symbol) \
199 (re_exec (SYMBOL_NAME (symbol)) != 0 \
200 || (SYMBOL_DEMANGLED_NAME (symbol) != NULL \
201 && re_exec (SYMBOL_DEMANGLED_NAME (symbol)) != 0))
203 /* Define a simple structure used to hold some very basic information about
204 all defined global symbols (text, data, bss, abs, etc). The only required
205 information is the general_symbol_info.
207 In many cases, even if a file was compiled with no special options for
208 debugging at all, as long as was not stripped it will contain sufficient
209 information to build a useful minimal symbol table using this structure.
210 Even when a file contains enough debugging information to build a full
211 symbol table, these minimal symbols are still useful for quickly mapping
212 between names and addresses, and vice versa. They are also sometimes
213 used to figure out what full symbol table entries need to be read in. */
215 struct minimal_symbol
218 /* The general symbol info required for all types of symbols.
220 The SYMBOL_VALUE_ADDRESS contains the address that this symbol
223 struct general_symbol_info ginfo
;
225 /* The info field is available for caching machine-specific information
226 so it doesn't have to rederive the info constantly (over a serial line).
227 It is initialized to zero and stays that way until target-dependent code
228 sets it. Storage for any data pointed to by this field should be allo-
229 cated on the symbol_obstack for the associated objfile.
230 The type would be "void *" except for reasons of compatibility with older
231 compilers. This field is optional.
233 Currently, the AMD 29000 tdep.c uses it to remember things it has decoded
234 from the instructions in the function header, and the MIPS-16 code uses
235 it to identify 16-bit procedures. */
239 #ifdef SOFUN_ADDRESS_MAYBE_MISSING
240 /* Which source file is this symbol in? Only relevant for mst_file_*. */
244 /* Classification types for this symbol. These should be taken as "advisory
245 only", since if gdb can't easily figure out a classification it simply
246 selects mst_unknown. It may also have to guess when it can't figure out
247 which is a better match between two types (mst_data versus mst_bss) for
248 example. Since the minimal symbol info is sometimes derived from the
249 BFD library's view of a file, we need to live with what information bfd
252 enum minimal_symbol_type
254 mst_unknown
= 0, /* Unknown type, the default */
255 mst_text
, /* Generally executable instructions */
256 mst_data
, /* Generally initialized data */
257 mst_bss
, /* Generally uninitialized data */
258 mst_abs
, /* Generally absolute (nonrelocatable) */
259 /* GDB uses mst_solib_trampoline for the start address of a shared
260 library trampoline entry. Breakpoints for shared library functions
261 are put there if the shared library is not yet loaded.
262 After the shared library is loaded, lookup_minimal_symbol will
263 prefer the minimal symbol from the shared library (usually
264 a mst_text symbol) over the mst_solib_trampoline symbol, and the
265 breakpoints will be moved to their true address in the shared
266 library via breakpoint_re_set. */
267 mst_solib_trampoline
, /* Shared library trampoline code */
268 /* For the mst_file* types, the names are only guaranteed to be unique
269 within a given .o file. */
270 mst_file_text
, /* Static version of mst_text */
271 mst_file_data
, /* Static version of mst_data */
272 mst_file_bss
/* Static version of mst_bss */
276 /* Minimal symbols with the same hash key are kept on a linked
277 list. This is the link. */
279 struct minimal_symbol
*hash_next
;
281 /* Minimal symbols are stored in two different hash tables. This is
282 the `next' pointer for the demangled hash table. */
284 struct minimal_symbol
*demangled_hash_next
;
287 #define MSYMBOL_INFO(msymbol) (msymbol)->info
288 #define MSYMBOL_TYPE(msymbol) (msymbol)->type
292 /* All of the name-scope contours of the program
293 are represented by `struct block' objects.
294 All of these objects are pointed to by the blockvector.
296 Each block represents one name scope.
297 Each lexical context has its own block.
299 The blockvector begins with some special blocks.
300 The GLOBAL_BLOCK contains all the symbols defined in this compilation
301 whose scope is the entire program linked together.
302 The STATIC_BLOCK contains all the symbols whose scope is the
303 entire compilation excluding other separate compilations.
304 Blocks starting with the FIRST_LOCAL_BLOCK are not special.
306 Each block records a range of core addresses for the code that
307 is in the scope of the block. The STATIC_BLOCK and GLOBAL_BLOCK
308 give, for the range of code, the entire range of code produced
309 by the compilation that the symbol segment belongs to.
311 The blocks appear in the blockvector
312 in order of increasing starting-address,
313 and, within that, in order of decreasing ending-address.
315 This implies that within the body of one function
316 the blocks appear in the order of a depth-first tree walk. */
320 /* Number of blocks in the list. */
322 /* The blocks themselves. */
323 struct block
*block
[1];
326 #define BLOCKVECTOR_NBLOCKS(blocklist) (blocklist)->nblocks
327 #define BLOCKVECTOR_BLOCK(blocklist,n) (blocklist)->block[n]
329 /* Special block numbers */
331 #define GLOBAL_BLOCK 0
332 #define STATIC_BLOCK 1
333 #define FIRST_LOCAL_BLOCK 2
338 /* Addresses in the executable code that are in this block. */
343 /* The symbol that names this block, if the block is the body of a
344 function; otherwise, zero. */
346 struct symbol
*function
;
348 /* The `struct block' for the containing block, or 0 if none.
350 The superblock of a top-level local block (i.e. a function in the
351 case of C) is the STATIC_BLOCK. The superblock of the
352 STATIC_BLOCK is the GLOBAL_BLOCK. */
354 struct block
*superblock
;
356 /* Version of GCC used to compile the function corresponding
357 to this block, or 0 if not compiled with GCC. When possible,
358 GCC should be compatible with the native compiler, or if that
359 is not feasible, the differences should be fixed during symbol
360 reading. As of 16 Apr 93, this flag is never used to distinguish
361 between gcc2 and the native compiler.
363 If there is no function corresponding to this block, this meaning
364 of this flag is undefined. */
366 unsigned char gcc_compile_flag
;
368 /* The symbols for this block are either in a simple linear list or
369 in a simple hashtable. Blocks which correspond to a function
370 (which have a list of symbols corresponding to arguments) use
371 a linear list, as do some older symbol readers (currently only
372 mdebugread and dstread). Other blocks are hashed.
374 The hashtable uses the same hash function as the minsym hashtables,
375 found in minsyms.c:minsym_hash_iw. Symbols are hashed based on
376 their demangled name if appropriate, and on their name otherwise.
377 The hash function ignores space, and stops at the beginning of the
378 argument list if any.
380 The table is laid out in NSYMS/5 buckets and symbols are chained via
381 their hash_next field. */
383 /* If this is really a hashtable of the symbols, this flag is 1. */
385 unsigned char hashtable
;
387 /* Number of local symbols. */
391 /* The symbols. If some of them are arguments, then they must be
392 in the order in which we would like to print them. */
394 struct symbol
*sym
[1];
397 #define BLOCK_START(bl) (bl)->startaddr
398 #define BLOCK_END(bl) (bl)->endaddr
399 #define BLOCK_FUNCTION(bl) (bl)->function
400 #define BLOCK_SUPERBLOCK(bl) (bl)->superblock
401 #define BLOCK_GCC_COMPILED(bl) (bl)->gcc_compile_flag
402 #define BLOCK_HASHTABLE(bl) (bl)->hashtable
404 /* For blocks without a hashtable (BLOCK_HASHTABLE (bl) == 0) only. */
405 #define BLOCK_NSYMS(bl) (bl)->nsyms
406 #define BLOCK_SYM(bl, n) (bl)->sym[n]
408 /* For blocks with a hashtable, but these are valid for non-hashed blocks as
409 well - each symbol will appear to be one bucket by itself. */
410 #define BLOCK_BUCKETS(bl) (bl)->nsyms
411 #define BLOCK_BUCKET(bl, n) (bl)->sym[n]
413 /* Macro used to set the size of a hashtable for N symbols. */
414 #define BLOCK_HASHTABLE_SIZE(n) ((n)/5 + 1)
416 /* Macro to loop through all symbols in a block BL, in no particular order.
417 i counts which bucket we are in, and sym points to the current symbol. */
419 #define ALL_BLOCK_SYMBOLS(bl, i, sym) \
420 for ((i) = 0; (i) < BLOCK_BUCKETS ((bl)); (i)++) \
421 for ((sym) = BLOCK_BUCKET ((bl), (i)); (sym); \
422 (sym) = (sym)->hash_next)
424 /* Nonzero if symbols of block BL should be sorted alphabetically.
425 Don't sort a block which corresponds to a function. If we did the
426 sorting would have to preserve the order of the symbols for the
427 arguments. Also don't sort any block that we chose to hash. */
429 #define BLOCK_SHOULD_SORT(bl) (! BLOCK_HASHTABLE (bl) \
430 && BLOCK_FUNCTION (bl) == NULL)
433 /* Represent one symbol name; a variable, constant, function or typedef. */
435 /* Different name spaces for symbols. Looking up a symbol specifies a
436 namespace and ignores symbol definitions in other name spaces. */
440 /* UNDEF_NAMESPACE is used when a namespace has not been discovered or
441 none of the following apply. This usually indicates an error either
442 in the symbol information or in gdb's handling of symbols. */
446 /* VAR_NAMESPACE is the usual namespace. In C, this contains variables,
447 function names, typedef names and enum type values. */
451 /* STRUCT_NAMESPACE is used in C to hold struct, union and enum type names.
452 Thus, if `struct foo' is used in a C program, it produces a symbol named
453 `foo' in the STRUCT_NAMESPACE. */
457 /* LABEL_NAMESPACE may be used for names of labels (for gotos);
458 currently it is not used and labels are not recorded at all. */
462 /* Searching namespaces. These overlap with VAR_NAMESPACE, providing
463 some granularity with the search_symbols function. */
465 /* Everything in VAR_NAMESPACE minus FUNCTIONS_-, TYPES_-, and
469 /* All functions -- for some reason not methods, though. */
472 /* All defined types */
475 /* All class methods -- why is this separated out? */
480 /* An address-class says where to find the value of a symbol. */
484 /* Not used; catches errors */
488 /* Value is constant int SYMBOL_VALUE, host byteorder */
492 /* Value is at fixed address SYMBOL_VALUE_ADDRESS */
496 /* Value is in register. SYMBOL_VALUE is the register number. */
500 /* It's an argument; the value is at SYMBOL_VALUE offset in arglist. */
504 /* Value address is at SYMBOL_VALUE offset in arglist. */
508 /* Value is in register number SYMBOL_VALUE. Just like LOC_REGISTER
509 except this is an argument. Probably the cleaner way to handle
510 this would be to separate address_class (which would include
511 separate ARG and LOCAL to deal with FRAME_ARGS_ADDRESS versus
512 FRAME_LOCALS_ADDRESS), and an is_argument flag.
514 For some symbol formats (stabs, for some compilers at least),
515 the compiler generates two symbols, an argument and a register.
516 In some cases we combine them to a single LOC_REGPARM in symbol
517 reading, but currently not for all cases (e.g. it's passed on the
518 stack and then loaded into a register). */
522 /* Value is in specified register. Just like LOC_REGPARM except the
523 register holds the address of the argument instead of the argument
524 itself. This is currently used for the passing of structs and unions
525 on sparc and hppa. It is also used for call by reference where the
526 address is in a register, at least by mipsread.c. */
530 /* Value is a local variable at SYMBOL_VALUE offset in stack frame. */
534 /* Value not used; definition in SYMBOL_TYPE. Symbols in the namespace
535 STRUCT_NAMESPACE all have this class. */
539 /* Value is address SYMBOL_VALUE_ADDRESS in the code */
543 /* In a symbol table, value is SYMBOL_BLOCK_VALUE of a `struct block'.
544 In a partial symbol table, SYMBOL_VALUE_ADDRESS is the start address
545 of the block. Function names have this class. */
549 /* Value is a constant byte-sequence pointed to by SYMBOL_VALUE_BYTES, in
550 target byte order. */
554 /* Value is arg at SYMBOL_VALUE offset in stack frame. Differs from
555 LOC_LOCAL in that symbol is an argument; differs from LOC_ARG in
556 that we find it in the frame (FRAME_LOCALS_ADDRESS), not in the
557 arglist (FRAME_ARGS_ADDRESS). Added for i960, which passes args
558 in regs then copies to frame. */
562 /* Value is at SYMBOL_VALUE offset from the current value of
563 register number SYMBOL_BASEREG. This exists mainly for the same
564 things that LOC_LOCAL and LOC_ARG do; but we need to do this
565 instead because on 88k DWARF gives us the offset from the
566 frame/stack pointer, rather than the offset from the "canonical
567 frame address" used by COFF, stabs, etc., and we don't know how
568 to convert between these until we start examining prologues.
570 Note that LOC_BASEREG is much less general than a DWARF expression.
571 We don't need the generality (at least not yet), and storing a general
572 DWARF expression would presumably take up more space than the existing
577 /* Same as LOC_BASEREG but it is an argument. */
581 /* Value is at fixed address, but the address of the variable has
582 to be determined from the minimal symbol table whenever the
583 variable is referenced.
584 This happens if debugging information for a global symbol is
585 emitted and the corresponding minimal symbol is defined
586 in another object file or runtime common storage.
587 The linker might even remove the minimal symbol if the global
588 symbol is never referenced, in which case the symbol remains
593 /* Value is at a thread-specific location calculated by a
594 target-specific method. This is used only by hppa. */
596 LOC_HP_THREAD_LOCAL_STATIC
,
598 /* Value is at a thread-specific location calculated by a
599 target-specific method. SYMBOL_OBJFILE gives the object file
600 in which the symbol is defined; the symbol's value is the
601 offset into that objfile's thread-local storage for the current
604 LOC_THREAD_LOCAL_STATIC
,
606 /* The variable does not actually exist in the program.
607 The value is ignored. */
611 /* The variable is static, but actually lives at * (address).
612 * I.e. do an extra indirection to get to it.
613 * This is used on HP-UX to get at globals that are allocated
614 * in shared libraries, where references from images other
615 * than the one where the global was allocated are done
616 * with a level of indirection.
622 /* Linked list of symbol's live ranges. */
628 struct range_list
*next
;
631 /* Linked list of aliases for a particular main/primary symbol. */
635 struct alias_list
*next
;
641 /* The general symbol info required for all types of symbols. */
643 struct general_symbol_info ginfo
;
645 /* Data type of value */
649 /* Name space code. */
652 /* FIXME: don't conflict with C++'s namespace */
653 /* would be safer to do a global change for all namespace identifiers. */
654 #define namespace _namespace
656 namespace_enum
namespace BYTE_BITFIELD
;
660 enum address_class aclass BYTE_BITFIELD
;
662 /* Line number of definition. FIXME: Should we really make the assumption
663 that nobody will try to debug files longer than 64K lines? What about
664 machine generated programs? */
668 /* Some symbols require an additional value to be recorded on a per-
669 symbol basis. Stash those values here. */
673 /* Used by LOC_BASEREG and LOC_BASEREG_ARG. */
676 /* Used by LOC_THREAD_LOCAL_STATIC. The objfile in which this
677 symbol is defined. To find a thread-local variable (e.g., a
678 variable declared with the `__thread' storage class), we may
679 need to know which object file it's in. */
680 struct objfile
*objfile
;
685 /* Link to a list of aliases for this symbol.
686 Only a "primary/main symbol may have aliases. */
687 struct alias_list
*aliases
;
689 /* List of ranges where this symbol is active. This is only
690 used by alias symbols at the current time. */
691 struct range_list
*ranges
;
693 struct symbol
*hash_next
;
697 #define SYMBOL_NAMESPACE(symbol) (symbol)->namespace
698 #define SYMBOL_CLASS(symbol) (symbol)->aclass
699 #define SYMBOL_TYPE(symbol) (symbol)->type
700 #define SYMBOL_LINE(symbol) (symbol)->line
701 #define SYMBOL_BASEREG(symbol) (symbol)->aux_value.basereg
702 #define SYMBOL_OBJFILE(symbol) (symbol)->aux_value.objfile
703 #define SYMBOL_ALIASES(symbol) (symbol)->aliases
704 #define SYMBOL_RANGES(symbol) (symbol)->ranges
706 /* A partial_symbol records the name, namespace, and address class of
707 symbols whose types we have not parsed yet. For functions, it also
708 contains their memory address, so we can find them from a PC value.
709 Each partial_symbol sits in a partial_symtab, all of which are chained
710 on a partial symtab list and which points to the corresponding
711 normal symtab once the partial_symtab has been referenced. */
713 struct partial_symbol
716 /* The general symbol info required for all types of symbols. */
718 struct general_symbol_info ginfo
;
720 /* Name space code. */
722 namespace_enum
namespace BYTE_BITFIELD
;
724 /* Address class (for info_symbols) */
726 enum address_class aclass BYTE_BITFIELD
;
730 #define PSYMBOL_NAMESPACE(psymbol) (psymbol)->namespace
731 #define PSYMBOL_CLASS(psymbol) (psymbol)->aclass
734 /* Each item represents a line-->pc (or the reverse) mapping. This is
735 somewhat more wasteful of space than one might wish, but since only
736 the files which are actually debugged are read in to core, we don't
739 struct linetable_entry
745 /* The order of entries in the linetable is significant. They should
746 be sorted by increasing values of the pc field. If there is more than
747 one entry for a given pc, then I'm not sure what should happen (and
748 I not sure whether we currently handle it the best way).
750 Example: a C for statement generally looks like this
752 10 0x100 - for the init/test part of a for stmt.
755 10 0x400 - for the increment part of a for stmt.
757 If an entry has a line number of zero, it marks the start of a PC
758 range for which no line number information is available. It is
759 acceptable, though wasteful of table space, for such a range to be
766 /* Actually NITEMS elements. If you don't like this use of the
767 `struct hack', you can shove it up your ANSI (seriously, if the
768 committee tells us how to do it, we can probably go along). */
769 struct linetable_entry item
[1];
772 /* How to relocate the symbols from each section in a symbol file.
773 Each struct contains an array of offsets.
774 The ordering and meaning of the offsets is file-type-dependent;
775 typically it is indexed by section numbers or symbol types or
778 To give us flexibility in changing the internal representation
779 of these offsets, the ANOFFSET macro must be used to insert and
780 extract offset values in the struct. */
782 struct section_offsets
784 CORE_ADDR offsets
[1]; /* As many as needed. */
787 #define ANOFFSET(secoff, whichone) \
789 ? (internal_error (__FILE__, __LINE__, "Section index is uninitialized"), -1) \
790 : secoff->offsets[whichone])
792 /* The size of a section_offsets table for N sections. */
793 #define SIZEOF_N_SECTION_OFFSETS(n) \
794 (sizeof (struct section_offsets) \
795 + sizeof (((struct section_offsets *) 0)->offsets) * ((n)-1))
797 /* The maximum possible size of a section_offsets table. */
798 #define SIZEOF_SECTION_OFFSETS (SIZEOF_N_SECTION_OFFSETS (SECT_OFF_MAX))
800 /* Each source file or header is represented by a struct symtab.
801 These objects are chained through the `next' field. */
806 /* Chain of all existing symtabs. */
810 /* List of all symbol scope blocks for this symtab. May be shared
811 between different symtabs (and normally is for all the symtabs
812 in a given compilation unit). */
814 struct blockvector
*blockvector
;
816 /* Table mapping core addresses to line numbers for this file.
817 Can be NULL if none. Never shared between different symtabs. */
819 struct linetable
*linetable
;
821 /* Section in objfile->section_offsets for the blockvector and
822 the linetable. Probably always SECT_OFF_TEXT. */
824 int block_line_section
;
826 /* If several symtabs share a blockvector, exactly one of them
827 should be designated the primary, so that the blockvector
828 is relocated exactly once by objfile_relocate. */
832 /* The macro table for this symtab. Like the blockvector, this
833 may be shared between different symtabs --- and normally is for
834 all the symtabs in a given compilation unit. */
835 struct macro_table
*macro_table
;
837 /* Name of this source file. */
841 /* Directory in which it was compiled, or NULL if we don't know. */
845 /* This component says how to free the data we point to:
846 free_contents => do a tree walk and free each object.
847 free_nothing => do nothing; some other symtab will free
848 the data this one uses.
849 free_linetable => free just the linetable. FIXME: Is this redundant
850 with the primary field? */
854 free_nothing
, free_contents
, free_linetable
858 /* Pointer to one block of storage to be freed, if nonzero. */
859 /* This is IN ADDITION to the action indicated by free_code. */
863 /* Total number of lines found in source file. */
867 /* line_charpos[N] is the position of the (N-1)th line of the
868 source file. "position" means something we can lseek() to; it
869 is not guaranteed to be useful any other way. */
873 /* Language of this source file. */
875 enum language language
;
877 /* String that identifies the format of the debugging information, such
878 as "stabs", "dwarf 1", "dwarf 2", "coff", etc. This is mostly useful
879 for automated testing of gdb but may also be information that is
880 useful to the user. */
884 /* String of version information. May be zero. */
888 /* Full name of file as found by searching the source path.
889 NULL if not yet known. */
893 /* Object file from which this symbol information was read. */
895 struct objfile
*objfile
;
899 #define BLOCKVECTOR(symtab) (symtab)->blockvector
900 #define LINETABLE(symtab) (symtab)->linetable
903 /* Each source file that has not been fully read in is represented by
904 a partial_symtab. This contains the information on where in the
905 executable the debugging symbols for a specific file are, and a
906 list of names of global symbols which are located in this file.
907 They are all chained on partial symtab lists.
909 Even after the source file has been read into a symtab, the
910 partial_symtab remains around. They are allocated on an obstack,
911 psymbol_obstack. FIXME, this is bad for dynamic linking or VxWorks-
912 style execution of a bunch of .o's. */
914 struct partial_symtab
917 /* Chain of all existing partial symtabs. */
919 struct partial_symtab
*next
;
921 /* Name of the source file which this partial_symtab defines */
925 /* Full path of the source file. NULL if not known. */
929 /* Information about the object file from which symbols should be read. */
931 struct objfile
*objfile
;
933 /* Set of relocation offsets to apply to each section. */
935 struct section_offsets
*section_offsets
;
937 /* Range of text addresses covered by this file; texthigh is the
938 beginning of the next section. */
943 /* Array of pointers to all of the partial_symtab's which this one
944 depends on. Since this array can only be set to previous or
945 the current (?) psymtab, this dependency tree is guaranteed not
946 to have any loops. "depends on" means that symbols must be read
947 for the dependencies before being read for this psymtab; this is
948 for type references in stabs, where if foo.c includes foo.h, declarations
949 in foo.h may use type numbers defined in foo.c. For other debugging
950 formats there may be no need to use dependencies. */
952 struct partial_symtab
**dependencies
;
954 int number_of_dependencies
;
956 /* Global symbol list. This list will be sorted after readin to
957 improve access. Binary search will be the usual method of
958 finding a symbol within it. globals_offset is an integer offset
959 within global_psymbols[]. */
964 /* Static symbol list. This list will *not* be sorted after readin;
965 to find a symbol in it, exhaustive search must be used. This is
966 reasonable because searches through this list will eventually
967 lead to either the read in of a files symbols for real (assumed
968 to take a *lot* of time; check) or an error (and we don't care
969 how long errors take). This is an offset and size within
970 static_psymbols[]. */
975 /* Pointer to symtab eventually allocated for this source file, 0 if
976 !readin or if we haven't looked for the symtab after it was readin. */
978 struct symtab
*symtab
;
980 /* Pointer to function which will read in the symtab corresponding to
983 void (*read_symtab
) (struct partial_symtab
*);
985 /* Information that lets read_symtab() locate the part of the symbol table
986 that this psymtab corresponds to. This information is private to the
987 format-dependent symbol reading routines. For further detail examine
988 the various symbol reading modules. Should really be (void *) but is
989 (char *) as with other such gdb variables. (FIXME) */
991 char *read_symtab_private
;
993 /* Non-zero if the symtab corresponding to this psymtab has been readin */
995 unsigned char readin
;
998 /* A fast way to get from a psymtab to its symtab (after the first time). */
999 #define PSYMTAB_TO_SYMTAB(pst) \
1000 ((pst) -> symtab != NULL ? (pst) -> symtab : psymtab_to_symtab (pst))
1003 /* The virtual function table is now an array of structures which have the
1004 form { int16 offset, delta; void *pfn; }.
1006 In normal virtual function tables, OFFSET is unused.
1007 DELTA is the amount which is added to the apparent object's base
1008 address in order to point to the actual object to which the
1009 virtual function should be applied.
1010 PFN is a pointer to the virtual function.
1012 Note that this macro is g++ specific (FIXME). */
1014 #define VTBL_FNADDR_OFFSET 2
1016 /* External variables and functions for the objects described above. */
1018 /* See the comment in symfile.c about how current_objfile is used. */
1020 extern struct objfile
*current_objfile
;
1022 /* True if we are nested inside psymtab_to_symtab. */
1024 extern int currently_reading_symtab
;
1027 extern int demangle
;
1028 extern int asm_demangle
;
1030 /* symtab.c lookup functions */
1032 /* lookup a symbol table by source file name */
1034 extern struct symtab
*lookup_symtab (const char *);
1036 /* lookup a symbol by name (optional block, optional symtab) */
1038 extern struct symbol
*lookup_symbol (const char *, const struct block
*,
1039 const namespace_enum
, int *,
1042 /* lookup a symbol by name, within a specified block */
1044 extern struct symbol
*lookup_block_symbol (const struct block
*, const char *,
1046 const namespace_enum
);
1048 /* lookup a [struct, union, enum] by name, within a specified block */
1050 extern struct type
*lookup_struct (char *, struct block
*);
1052 extern struct type
*lookup_union (char *, struct block
*);
1054 extern struct type
*lookup_enum (char *, struct block
*);
1056 /* lookup the function corresponding to the block */
1058 extern struct symbol
*block_function (struct block
*);
1060 /* from blockframe.c: */
1062 /* lookup the function symbol corresponding to the address */
1064 extern struct symbol
*find_pc_function (CORE_ADDR
);
1066 /* lookup the function corresponding to the address and section */
1068 extern struct symbol
*find_pc_sect_function (CORE_ADDR
, asection
*);
1070 /* lookup function from address, return name, start addr and end addr */
1072 extern int find_pc_partial_function (CORE_ADDR
, char **, CORE_ADDR
*,
1075 extern void clear_pc_function_cache (void);
1077 extern int find_pc_sect_partial_function (CORE_ADDR
, asection
*,
1078 char **, CORE_ADDR
*, CORE_ADDR
*);
1080 /* from symtab.c: */
1082 /* lookup partial symbol table by filename */
1084 extern struct partial_symtab
*lookup_partial_symtab (const char *);
1086 /* lookup partial symbol table by address */
1088 extern struct partial_symtab
*find_pc_psymtab (CORE_ADDR
);
1090 /* lookup partial symbol table by address and section */
1092 extern struct partial_symtab
*find_pc_sect_psymtab (CORE_ADDR
, asection
*);
1094 /* lookup full symbol table by address */
1096 extern struct symtab
*find_pc_symtab (CORE_ADDR
);
1098 /* lookup full symbol table by address and section */
1100 extern struct symtab
*find_pc_sect_symtab (CORE_ADDR
, asection
*);
1102 /* lookup partial symbol by address */
1104 extern struct partial_symbol
*find_pc_psymbol (struct partial_symtab
*,
1107 /* lookup partial symbol by address and section */
1109 extern struct partial_symbol
*find_pc_sect_psymbol (struct partial_symtab
*,
1110 CORE_ADDR
, asection
*);
1112 extern int find_pc_line_pc_range (CORE_ADDR
, CORE_ADDR
*, CORE_ADDR
*);
1114 extern int contained_in (struct block
*, struct block
*);
1116 extern void reread_symbols (void);
1118 extern struct type
*lookup_transparent_type (const char *);
1121 /* Macro for name of symbol to indicate a file compiled with gcc. */
1122 #ifndef GCC_COMPILED_FLAG_SYMBOL
1123 #define GCC_COMPILED_FLAG_SYMBOL "gcc_compiled."
1126 /* Macro for name of symbol to indicate a file compiled with gcc2. */
1127 #ifndef GCC2_COMPILED_FLAG_SYMBOL
1128 #define GCC2_COMPILED_FLAG_SYMBOL "gcc2_compiled."
1131 /* Functions for dealing with the minimal symbol table, really a misc
1132 address<->symbol mapping for things we don't have debug symbols for. */
1134 extern void prim_record_minimal_symbol (const char *, CORE_ADDR
,
1135 enum minimal_symbol_type
,
1138 extern struct minimal_symbol
*prim_record_minimal_symbol_and_info
1139 (const char *, CORE_ADDR
,
1140 enum minimal_symbol_type
,
1141 char *info
, int section
, asection
* bfd_section
, struct objfile
*);
1143 extern unsigned int msymbol_hash_iw (const char *);
1145 extern unsigned int msymbol_hash (const char *);
1148 add_minsym_to_hash_table (struct minimal_symbol
*sym
,
1149 struct minimal_symbol
**table
);
1151 extern struct minimal_symbol
*lookup_minimal_symbol (const char *,
1155 extern struct minimal_symbol
*lookup_minimal_symbol_text (const char *,
1159 struct minimal_symbol
*lookup_minimal_symbol_solib_trampoline (const char *,
1164 extern struct minimal_symbol
*lookup_minimal_symbol_by_pc (CORE_ADDR
);
1166 extern struct minimal_symbol
*lookup_minimal_symbol_by_pc_section (CORE_ADDR
,
1170 extern struct minimal_symbol
1171 *lookup_solib_trampoline_symbol_by_pc (CORE_ADDR
);
1173 extern CORE_ADDR
find_solib_trampoline_target (CORE_ADDR
);
1175 extern void init_minimal_symbol_collection (void);
1177 extern struct cleanup
*make_cleanup_discard_minimal_symbols (void);
1179 extern void install_minimal_symbols (struct objfile
*);
1181 /* Sort all the minimal symbols in OBJFILE. */
1183 extern void msymbols_sort (struct objfile
*objfile
);
1185 struct symtab_and_line
1187 struct symtab
*symtab
;
1189 /* Line number. Line numbers start at 1 and proceed through symtab->nlines.
1190 0 is never a valid line number; it is used to indicate that line number
1191 information is not available. */
1198 extern void init_sal (struct symtab_and_line
*sal
);
1200 struct symtabs_and_lines
1202 struct symtab_and_line
*sals
;
1208 /* Some types and macros needed for exception catchpoints.
1209 Can't put these in target.h because symtab_and_line isn't
1210 known there. This file will be included by breakpoint.c,
1211 hppa-tdep.c, etc. */
1213 /* Enums for exception-handling support */
1214 enum exception_event_kind
1220 /* Type for returning info about an exception */
1221 struct exception_event_record
1223 enum exception_event_kind kind
;
1224 struct symtab_and_line throw_sal
;
1225 struct symtab_and_line catch_sal
;
1226 /* This may need to be extended in the future, if
1227 some platforms allow reporting more information,
1228 such as point of rethrow, type of exception object,
1229 type expected by catch clause, etc. */
1232 #define CURRENT_EXCEPTION_KIND (current_exception_event->kind)
1233 #define CURRENT_EXCEPTION_CATCH_SAL (current_exception_event->catch_sal)
1234 #define CURRENT_EXCEPTION_CATCH_LINE (current_exception_event->catch_sal.line)
1235 #define CURRENT_EXCEPTION_CATCH_FILE (current_exception_event->catch_sal.symtab->filename)
1236 #define CURRENT_EXCEPTION_CATCH_PC (current_exception_event->catch_sal.pc)
1237 #define CURRENT_EXCEPTION_THROW_SAL (current_exception_event->throw_sal)
1238 #define CURRENT_EXCEPTION_THROW_LINE (current_exception_event->throw_sal.line)
1239 #define CURRENT_EXCEPTION_THROW_FILE (current_exception_event->throw_sal.symtab->filename)
1240 #define CURRENT_EXCEPTION_THROW_PC (current_exception_event->throw_sal.pc)
1243 /* Given a pc value, return line number it is in. Second arg nonzero means
1244 if pc is on the boundary use the previous statement's line number. */
1246 extern struct symtab_and_line
find_pc_line (CORE_ADDR
, int);
1248 /* Same function, but specify a section as well as an address */
1250 extern struct symtab_and_line
find_pc_sect_line (CORE_ADDR
, asection
*, int);
1252 /* Given a symtab and line number, return the pc there. */
1254 extern int find_line_pc (struct symtab
*, int, CORE_ADDR
*);
1256 extern int find_line_pc_range (struct symtab_and_line
, CORE_ADDR
*,
1259 extern void resolve_sal_pc (struct symtab_and_line
*);
1261 /* Given a string, return the line specified by it. For commands like "list"
1262 and "breakpoint". */
1264 extern struct symtabs_and_lines
decode_line_spec (char *, int);
1266 extern struct symtabs_and_lines
decode_line_spec_1 (char *, int);
1270 void maintenance_print_symbols (char *, int);
1272 void maintenance_print_psymbols (char *, int);
1274 void maintenance_print_msymbols (char *, int);
1276 void maintenance_print_objfiles (char *, int);
1278 void maintenance_check_symtabs (char *, int);
1282 void maintenance_print_statistics (char *, int);
1284 extern void free_symtab (struct symtab
*);
1286 /* Symbol-reading stuff in symfile.c and solib.c. */
1288 extern struct symtab
*psymtab_to_symtab (struct partial_symtab
*);
1290 extern void clear_solib (void);
1294 extern int identify_source_line (struct symtab
*, int, int, CORE_ADDR
);
1296 extern void print_source_lines (struct symtab
*, int, int, int);
1298 extern void forget_cached_source_info (void);
1300 extern void select_source_symtab (struct symtab
*);
1302 extern char **make_symbol_completion_list (char *, char *);
1304 extern char **make_file_symbol_completion_list (char *, char *, char *);
1306 extern struct symbol
**make_symbol_overload_list (struct symbol
*);
1308 extern char **make_source_files_completion_list (char *, char *);
1312 extern struct partial_symtab
*find_main_psymtab (void);
1314 extern struct symtab
*find_line_symtab (struct symtab
*, int, int *, int *);
1316 extern struct symtab_and_line
find_function_start_sal (struct symbol
*sym
,
1321 extern struct blockvector
*blockvector_for_pc (CORE_ADDR
, int *);
1323 extern struct blockvector
*blockvector_for_pc_sect (CORE_ADDR
, asection
*,
1324 int *, struct symtab
*);
1328 extern void clear_symtab_users (void);
1330 extern enum language
deduce_language_from_filename (char *);
1334 extern int in_prologue (CORE_ADDR pc
, CORE_ADDR func_start
);
1336 extern struct symbol
*fixup_symbol_section (struct symbol
*,
1339 extern struct partial_symbol
*fixup_psymbol_section (struct partial_symbol
1341 struct objfile
*objfile
);
1343 /* Symbol searching */
1345 /* When using search_symbols, a list of the following structs is returned.
1346 Callers must free the search list using free_search_symbols! */
1347 struct symbol_search
1349 /* The block in which the match was found. Could be, for example,
1350 STATIC_BLOCK or GLOBAL_BLOCK. */
1353 /* Information describing what was found.
1355 If symtab abd symbol are NOT NULL, then information was found
1357 struct symtab
*symtab
;
1358 struct symbol
*symbol
;
1360 /* If msymbol is non-null, then a match was made on something for
1361 which only minimal_symbols exist. */
1362 struct minimal_symbol
*msymbol
;
1364 /* A link to the next match, or NULL for the end. */
1365 struct symbol_search
*next
;
1368 extern void search_symbols (char *, namespace_enum
, int, char **,
1369 struct symbol_search
**);
1370 extern void free_search_symbols (struct symbol_search
*);
1371 extern struct cleanup
*make_cleanup_free_search_symbols (struct symbol_search
1374 /* The name of the ``main'' function.
1375 FIXME: cagney/2001-03-20: Can't make main_name() const since some
1376 of the calling code currently assumes that the string isn't
1378 extern void set_main_name (const char *name
);
1379 extern /*const */ char *main_name (void);
1381 #endif /* !defined(SYMTAB_H) */