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 returns the "natural assembly name" of a symbol. In C++ this is
182 the "mangled" form of the name if demangle is off, or if demangle is on and
183 asm_demangle is off. Otherwise if asm_demangle is on it is the "demangled"
184 form. In other languages this is just the symbol name. The result should
187 #define SYMBOL_LINKAGE_NAME(symbol) \
188 (demangle && asm_demangle && SYMBOL_DEMANGLED_NAME (symbol) != NULL \
189 ? SYMBOL_DEMANGLED_NAME (symbol) \
190 : SYMBOL_NAME (symbol))
192 /* Macro that tests a symbol for a match against a specified name string.
193 First test the unencoded name, then looks for and test a C++ encoded
194 name if it exists. Note that whitespace is ignored while attempting to
195 match a C++ encoded name, so that "foo::bar(int,long)" is the same as
196 "foo :: bar (int, long)".
197 Evaluates to zero if the match fails, or nonzero if it succeeds. */
199 #define SYMBOL_MATCHES_NAME(symbol, name) \
200 (STREQ (SYMBOL_NAME (symbol), (name)) \
201 || (SYMBOL_DEMANGLED_NAME (symbol) != NULL \
202 && strcmp_iw (SYMBOL_DEMANGLED_NAME (symbol), (name)) == 0))
204 /* Macro that tests a symbol for an re-match against the last compiled regular
205 expression. First test the unencoded name, then look for and test a C++
206 encoded name if it exists.
207 Evaluates to zero if the match fails, or nonzero if it succeeds. */
209 #define SYMBOL_MATCHES_REGEXP(symbol) \
210 (re_exec (SYMBOL_NAME (symbol)) != 0 \
211 || (SYMBOL_DEMANGLED_NAME (symbol) != NULL \
212 && re_exec (SYMBOL_DEMANGLED_NAME (symbol)) != 0))
214 /* Define a simple structure used to hold some very basic information about
215 all defined global symbols (text, data, bss, abs, etc). The only required
216 information is the general_symbol_info.
218 In many cases, even if a file was compiled with no special options for
219 debugging at all, as long as was not stripped it will contain sufficient
220 information to build a useful minimal symbol table using this structure.
221 Even when a file contains enough debugging information to build a full
222 symbol table, these minimal symbols are still useful for quickly mapping
223 between names and addresses, and vice versa. They are also sometimes
224 used to figure out what full symbol table entries need to be read in. */
226 struct minimal_symbol
229 /* The general symbol info required for all types of symbols.
231 The SYMBOL_VALUE_ADDRESS contains the address that this symbol
234 struct general_symbol_info ginfo
;
236 /* The info field is available for caching machine-specific information
237 so it doesn't have to rederive the info constantly (over a serial line).
238 It is initialized to zero and stays that way until target-dependent code
239 sets it. Storage for any data pointed to by this field should be allo-
240 cated on the symbol_obstack for the associated objfile.
241 The type would be "void *" except for reasons of compatibility with older
242 compilers. This field is optional.
244 Currently, the AMD 29000 tdep.c uses it to remember things it has decoded
245 from the instructions in the function header, and the MIPS-16 code uses
246 it to identify 16-bit procedures. */
250 #ifdef SOFUN_ADDRESS_MAYBE_MISSING
251 /* Which source file is this symbol in? Only relevant for mst_file_*. */
255 /* Classification types for this symbol. These should be taken as "advisory
256 only", since if gdb can't easily figure out a classification it simply
257 selects mst_unknown. It may also have to guess when it can't figure out
258 which is a better match between two types (mst_data versus mst_bss) for
259 example. Since the minimal symbol info is sometimes derived from the
260 BFD library's view of a file, we need to live with what information bfd
263 enum minimal_symbol_type
265 mst_unknown
= 0, /* Unknown type, the default */
266 mst_text
, /* Generally executable instructions */
267 mst_data
, /* Generally initialized data */
268 mst_bss
, /* Generally uninitialized data */
269 mst_abs
, /* Generally absolute (nonrelocatable) */
270 /* GDB uses mst_solib_trampoline for the start address of a shared
271 library trampoline entry. Breakpoints for shared library functions
272 are put there if the shared library is not yet loaded.
273 After the shared library is loaded, lookup_minimal_symbol will
274 prefer the minimal symbol from the shared library (usually
275 a mst_text symbol) over the mst_solib_trampoline symbol, and the
276 breakpoints will be moved to their true address in the shared
277 library via breakpoint_re_set. */
278 mst_solib_trampoline
, /* Shared library trampoline code */
279 /* For the mst_file* types, the names are only guaranteed to be unique
280 within a given .o file. */
281 mst_file_text
, /* Static version of mst_text */
282 mst_file_data
, /* Static version of mst_data */
283 mst_file_bss
/* Static version of mst_bss */
287 /* Minimal symbols with the same hash key are kept on a linked
288 list. This is the link. */
290 struct minimal_symbol
*hash_next
;
292 /* Minimal symbols are stored in two different hash tables. This is
293 the `next' pointer for the demangled hash table. */
295 struct minimal_symbol
*demangled_hash_next
;
298 #define MSYMBOL_INFO(msymbol) (msymbol)->info
299 #define MSYMBOL_TYPE(msymbol) (msymbol)->type
303 /* All of the name-scope contours of the program
304 are represented by `struct block' objects.
305 All of these objects are pointed to by the blockvector.
307 Each block represents one name scope.
308 Each lexical context has its own block.
310 The blockvector begins with some special blocks.
311 The GLOBAL_BLOCK contains all the symbols defined in this compilation
312 whose scope is the entire program linked together.
313 The STATIC_BLOCK contains all the symbols whose scope is the
314 entire compilation excluding other separate compilations.
315 Blocks starting with the FIRST_LOCAL_BLOCK are not special.
317 Each block records a range of core addresses for the code that
318 is in the scope of the block. The STATIC_BLOCK and GLOBAL_BLOCK
319 give, for the range of code, the entire range of code produced
320 by the compilation that the symbol segment belongs to.
322 The blocks appear in the blockvector
323 in order of increasing starting-address,
324 and, within that, in order of decreasing ending-address.
326 This implies that within the body of one function
327 the blocks appear in the order of a depth-first tree walk. */
331 /* Number of blocks in the list. */
333 /* The blocks themselves. */
334 struct block
*block
[1];
337 #define BLOCKVECTOR_NBLOCKS(blocklist) (blocklist)->nblocks
338 #define BLOCKVECTOR_BLOCK(blocklist,n) (blocklist)->block[n]
340 /* Special block numbers */
342 #define GLOBAL_BLOCK 0
343 #define STATIC_BLOCK 1
344 #define FIRST_LOCAL_BLOCK 2
349 /* Addresses in the executable code that are in this block. */
354 /* The symbol that names this block, if the block is the body of a
355 function; otherwise, zero. */
357 struct symbol
*function
;
359 /* The `struct block' for the containing block, or 0 if none.
361 The superblock of a top-level local block (i.e. a function in the
362 case of C) is the STATIC_BLOCK. The superblock of the
363 STATIC_BLOCK is the GLOBAL_BLOCK. */
365 struct block
*superblock
;
367 /* Version of GCC used to compile the function corresponding
368 to this block, or 0 if not compiled with GCC. When possible,
369 GCC should be compatible with the native compiler, or if that
370 is not feasible, the differences should be fixed during symbol
371 reading. As of 16 Apr 93, this flag is never used to distinguish
372 between gcc2 and the native compiler.
374 If there is no function corresponding to this block, this meaning
375 of this flag is undefined. */
377 unsigned char gcc_compile_flag
;
379 /* The symbols for this block are either in a simple linear list or
380 in a simple hashtable. Blocks which correspond to a function
381 (which have a list of symbols corresponding to arguments) use
382 a linear list, as do some older symbol readers (currently only
383 mdebugread and dstread). Other blocks are hashed.
385 The hashtable uses the same hash function as the minsym hashtables,
386 found in minsyms.c:minsym_hash_iw. Symbols are hashed based on
387 their demangled name if appropriate, and on their name otherwise.
388 The hash function ignores space, and stops at the beginning of the
389 argument list if any.
391 The table is laid out in NSYMS/5 buckets and symbols are chained via
392 their hash_next field. */
394 /* If this is really a hashtable of the symbols, this flag is 1. */
396 unsigned char hashtable
;
398 /* Number of local symbols. */
402 /* The symbols. If some of them are arguments, then they must be
403 in the order in which we would like to print them. */
405 struct symbol
*sym
[1];
408 #define BLOCK_START(bl) (bl)->startaddr
409 #define BLOCK_END(bl) (bl)->endaddr
410 #define BLOCK_FUNCTION(bl) (bl)->function
411 #define BLOCK_SUPERBLOCK(bl) (bl)->superblock
412 #define BLOCK_GCC_COMPILED(bl) (bl)->gcc_compile_flag
413 #define BLOCK_HASHTABLE(bl) (bl)->hashtable
415 /* For blocks without a hashtable (BLOCK_HASHTABLE (bl) == 0) only. */
416 #define BLOCK_NSYMS(bl) (bl)->nsyms
417 #define BLOCK_SYM(bl, n) (bl)->sym[n]
419 /* For blocks with a hashtable, but these are valid for non-hashed blocks as
420 well - each symbol will appear to be one bucket by itself. */
421 #define BLOCK_BUCKETS(bl) (bl)->nsyms
422 #define BLOCK_BUCKET(bl, n) (bl)->sym[n]
424 /* Macro used to set the size of a hashtable for N symbols. */
425 #define BLOCK_HASHTABLE_SIZE(n) ((n)/5 + 1)
427 /* Macro to loop through all symbols in a block BL, in no particular order.
428 i counts which bucket we are in, and sym points to the current symbol. */
430 #define ALL_BLOCK_SYMBOLS(bl, i, sym) \
431 for ((i) = 0; (i) < BLOCK_BUCKETS ((bl)); (i)++) \
432 for ((sym) = BLOCK_BUCKET ((bl), (i)); (sym); \
433 (sym) = (sym)->hash_next)
435 /* Nonzero if symbols of block BL should be sorted alphabetically.
436 Don't sort a block which corresponds to a function. If we did the
437 sorting would have to preserve the order of the symbols for the
438 arguments. Also don't sort any block that we chose to hash. */
440 #define BLOCK_SHOULD_SORT(bl) (! BLOCK_HASHTABLE (bl) \
441 && BLOCK_FUNCTION (bl) == NULL)
444 /* Represent one symbol name; a variable, constant, function or typedef. */
446 /* Different name spaces for symbols. Looking up a symbol specifies a
447 namespace and ignores symbol definitions in other name spaces. */
451 /* UNDEF_NAMESPACE is used when a namespace has not been discovered or
452 none of the following apply. This usually indicates an error either
453 in the symbol information or in gdb's handling of symbols. */
457 /* VAR_NAMESPACE is the usual namespace. In C, this contains variables,
458 function names, typedef names and enum type values. */
462 /* STRUCT_NAMESPACE is used in C to hold struct, union and enum type names.
463 Thus, if `struct foo' is used in a C program, it produces a symbol named
464 `foo' in the STRUCT_NAMESPACE. */
468 /* LABEL_NAMESPACE may be used for names of labels (for gotos);
469 currently it is not used and labels are not recorded at all. */
473 /* Searching namespaces. These overlap with VAR_NAMESPACE, providing
474 some granularity with the search_symbols function. */
476 /* Everything in VAR_NAMESPACE minus FUNCTIONS_-, TYPES_-, and
480 /* All functions -- for some reason not methods, though. */
483 /* All defined types */
486 /* All class methods -- why is this separated out? */
491 /* An address-class says where to find the value of a symbol. */
495 /* Not used; catches errors */
499 /* Value is constant int SYMBOL_VALUE, host byteorder */
503 /* Value is at fixed address SYMBOL_VALUE_ADDRESS */
507 /* Value is in register. SYMBOL_VALUE is the register number. */
511 /* It's an argument; the value is at SYMBOL_VALUE offset in arglist. */
515 /* Value address is at SYMBOL_VALUE offset in arglist. */
519 /* Value is in register number SYMBOL_VALUE. Just like LOC_REGISTER
520 except this is an argument. Probably the cleaner way to handle
521 this would be to separate address_class (which would include
522 separate ARG and LOCAL to deal with FRAME_ARGS_ADDRESS versus
523 FRAME_LOCALS_ADDRESS), and an is_argument flag.
525 For some symbol formats (stabs, for some compilers at least),
526 the compiler generates two symbols, an argument and a register.
527 In some cases we combine them to a single LOC_REGPARM in symbol
528 reading, but currently not for all cases (e.g. it's passed on the
529 stack and then loaded into a register). */
533 /* Value is in specified register. Just like LOC_REGPARM except the
534 register holds the address of the argument instead of the argument
535 itself. This is currently used for the passing of structs and unions
536 on sparc and hppa. It is also used for call by reference where the
537 address is in a register, at least by mipsread.c. */
541 /* Value is a local variable at SYMBOL_VALUE offset in stack frame. */
545 /* Value not used; definition in SYMBOL_TYPE. Symbols in the namespace
546 STRUCT_NAMESPACE all have this class. */
550 /* Value is address SYMBOL_VALUE_ADDRESS in the code */
554 /* In a symbol table, value is SYMBOL_BLOCK_VALUE of a `struct block'.
555 In a partial symbol table, SYMBOL_VALUE_ADDRESS is the start address
556 of the block. Function names have this class. */
560 /* Value is a constant byte-sequence pointed to by SYMBOL_VALUE_BYTES, in
561 target byte order. */
565 /* Value is arg at SYMBOL_VALUE offset in stack frame. Differs from
566 LOC_LOCAL in that symbol is an argument; differs from LOC_ARG in
567 that we find it in the frame (FRAME_LOCALS_ADDRESS), not in the
568 arglist (FRAME_ARGS_ADDRESS). Added for i960, which passes args
569 in regs then copies to frame. */
573 /* Value is at SYMBOL_VALUE offset from the current value of
574 register number SYMBOL_BASEREG. This exists mainly for the same
575 things that LOC_LOCAL and LOC_ARG do; but we need to do this
576 instead because on 88k DWARF gives us the offset from the
577 frame/stack pointer, rather than the offset from the "canonical
578 frame address" used by COFF, stabs, etc., and we don't know how
579 to convert between these until we start examining prologues.
581 Note that LOC_BASEREG is much less general than a DWARF expression.
582 We don't need the generality (at least not yet), and storing a general
583 DWARF expression would presumably take up more space than the existing
588 /* Same as LOC_BASEREG but it is an argument. */
592 /* Value is at fixed address, but the address of the variable has
593 to be determined from the minimal symbol table whenever the
594 variable is referenced.
595 This happens if debugging information for a global symbol is
596 emitted and the corresponding minimal symbol is defined
597 in another object file or runtime common storage.
598 The linker might even remove the minimal symbol if the global
599 symbol is never referenced, in which case the symbol remains
604 /* Value is at a thread-specific location calculated by a
605 target-specific method. This is used only by hppa. */
607 LOC_HP_THREAD_LOCAL_STATIC
,
609 /* Value is at a thread-specific location calculated by a
610 target-specific method. SYMBOL_OBJFILE gives the object file
611 in which the symbol is defined; the symbol's value is the
612 offset into that objfile's thread-local storage for the current
615 LOC_THREAD_LOCAL_STATIC
,
617 /* The variable does not actually exist in the program.
618 The value is ignored. */
622 /* The variable is static, but actually lives at * (address).
623 * I.e. do an extra indirection to get to it.
624 * This is used on HP-UX to get at globals that are allocated
625 * in shared libraries, where references from images other
626 * than the one where the global was allocated are done
627 * with a level of indirection.
633 /* Linked list of symbol's live ranges. */
639 struct range_list
*next
;
642 /* Linked list of aliases for a particular main/primary symbol. */
646 struct alias_list
*next
;
652 /* The general symbol info required for all types of symbols. */
654 struct general_symbol_info ginfo
;
656 /* Data type of value */
660 /* Name space code. */
663 /* FIXME: don't conflict with C++'s namespace */
664 /* would be safer to do a global change for all namespace identifiers. */
665 #define namespace _namespace
667 namespace_enum
namespace BYTE_BITFIELD
;
671 enum address_class aclass BYTE_BITFIELD
;
673 /* Line number of definition. FIXME: Should we really make the assumption
674 that nobody will try to debug files longer than 64K lines? What about
675 machine generated programs? */
679 /* Some symbols require an additional value to be recorded on a per-
680 symbol basis. Stash those values here. */
684 /* Used by LOC_BASEREG and LOC_BASEREG_ARG. */
687 /* Used by LOC_THREAD_LOCAL_STATIC. The objfile in which this
688 symbol is defined. To find a thread-local variable (e.g., a
689 variable declared with the `__thread' storage class), we may
690 need to know which object file it's in. */
691 struct objfile
*objfile
;
696 /* Link to a list of aliases for this symbol.
697 Only a "primary/main symbol may have aliases. */
698 struct alias_list
*aliases
;
700 /* List of ranges where this symbol is active. This is only
701 used by alias symbols at the current time. */
702 struct range_list
*ranges
;
704 struct symbol
*hash_next
;
708 #define SYMBOL_NAMESPACE(symbol) (symbol)->namespace
709 #define SYMBOL_CLASS(symbol) (symbol)->aclass
710 #define SYMBOL_TYPE(symbol) (symbol)->type
711 #define SYMBOL_LINE(symbol) (symbol)->line
712 #define SYMBOL_BASEREG(symbol) (symbol)->aux_value.basereg
713 #define SYMBOL_OBJFILE(symbol) (symbol)->aux_value.objfile
714 #define SYMBOL_ALIASES(symbol) (symbol)->aliases
715 #define SYMBOL_RANGES(symbol) (symbol)->ranges
717 /* A partial_symbol records the name, namespace, and address class of
718 symbols whose types we have not parsed yet. For functions, it also
719 contains their memory address, so we can find them from a PC value.
720 Each partial_symbol sits in a partial_symtab, all of which are chained
721 on a partial symtab list and which points to the corresponding
722 normal symtab once the partial_symtab has been referenced. */
724 struct partial_symbol
727 /* The general symbol info required for all types of symbols. */
729 struct general_symbol_info ginfo
;
731 /* Name space code. */
733 namespace_enum
namespace BYTE_BITFIELD
;
735 /* Address class (for info_symbols) */
737 enum address_class aclass BYTE_BITFIELD
;
741 #define PSYMBOL_NAMESPACE(psymbol) (psymbol)->namespace
742 #define PSYMBOL_CLASS(psymbol) (psymbol)->aclass
745 /* Each item represents a line-->pc (or the reverse) mapping. This is
746 somewhat more wasteful of space than one might wish, but since only
747 the files which are actually debugged are read in to core, we don't
750 struct linetable_entry
756 /* The order of entries in the linetable is significant. They should
757 be sorted by increasing values of the pc field. If there is more than
758 one entry for a given pc, then I'm not sure what should happen (and
759 I not sure whether we currently handle it the best way).
761 Example: a C for statement generally looks like this
763 10 0x100 - for the init/test part of a for stmt.
766 10 0x400 - for the increment part of a for stmt.
768 If an entry has a line number of zero, it marks the start of a PC
769 range for which no line number information is available. It is
770 acceptable, though wasteful of table space, for such a range to be
777 /* Actually NITEMS elements. If you don't like this use of the
778 `struct hack', you can shove it up your ANSI (seriously, if the
779 committee tells us how to do it, we can probably go along). */
780 struct linetable_entry item
[1];
783 /* How to relocate the symbols from each section in a symbol file.
784 Each struct contains an array of offsets.
785 The ordering and meaning of the offsets is file-type-dependent;
786 typically it is indexed by section numbers or symbol types or
789 To give us flexibility in changing the internal representation
790 of these offsets, the ANOFFSET macro must be used to insert and
791 extract offset values in the struct. */
793 struct section_offsets
795 CORE_ADDR offsets
[1]; /* As many as needed. */
798 #define ANOFFSET(secoff, whichone) \
800 ? (internal_error (__FILE__, __LINE__, "Section index is uninitialized"), -1) \
801 : secoff->offsets[whichone])
803 /* The size of a section_offsets table for N sections. */
804 #define SIZEOF_N_SECTION_OFFSETS(n) \
805 (sizeof (struct section_offsets) \
806 + sizeof (((struct section_offsets *) 0)->offsets) * ((n)-1))
808 /* The maximum possible size of a section_offsets table. */
809 #define SIZEOF_SECTION_OFFSETS (SIZEOF_N_SECTION_OFFSETS (SECT_OFF_MAX))
811 /* Each source file or header is represented by a struct symtab.
812 These objects are chained through the `next' field. */
817 /* Chain of all existing symtabs. */
821 /* List of all symbol scope blocks for this symtab. May be shared
822 between different symtabs (and normally is for all the symtabs
823 in a given compilation unit). */
825 struct blockvector
*blockvector
;
827 /* Table mapping core addresses to line numbers for this file.
828 Can be NULL if none. Never shared between different symtabs. */
830 struct linetable
*linetable
;
832 /* Section in objfile->section_offsets for the blockvector and
833 the linetable. Probably always SECT_OFF_TEXT. */
835 int block_line_section
;
837 /* If several symtabs share a blockvector, exactly one of them
838 should be designated the primary, so that the blockvector
839 is relocated exactly once by objfile_relocate. */
843 /* The macro table for this symtab. Like the blockvector, this
844 may be shared between different symtabs --- and normally is for
845 all the symtabs in a given compilation unit. */
846 struct macro_table
*macro_table
;
848 /* Name of this source file. */
852 /* Directory in which it was compiled, or NULL if we don't know. */
856 /* This component says how to free the data we point to:
857 free_contents => do a tree walk and free each object.
858 free_nothing => do nothing; some other symtab will free
859 the data this one uses.
860 free_linetable => free just the linetable. FIXME: Is this redundant
861 with the primary field? */
865 free_nothing
, free_contents
, free_linetable
869 /* Pointer to one block of storage to be freed, if nonzero. */
870 /* This is IN ADDITION to the action indicated by free_code. */
874 /* Total number of lines found in source file. */
878 /* line_charpos[N] is the position of the (N-1)th line of the
879 source file. "position" means something we can lseek() to; it
880 is not guaranteed to be useful any other way. */
884 /* Language of this source file. */
886 enum language language
;
888 /* String that identifies the format of the debugging information, such
889 as "stabs", "dwarf 1", "dwarf 2", "coff", etc. This is mostly useful
890 for automated testing of gdb but may also be information that is
891 useful to the user. */
895 /* String of version information. May be zero. */
899 /* Full name of file as found by searching the source path.
900 NULL if not yet known. */
904 /* Object file from which this symbol information was read. */
906 struct objfile
*objfile
;
910 #define BLOCKVECTOR(symtab) (symtab)->blockvector
911 #define LINETABLE(symtab) (symtab)->linetable
914 /* Each source file that has not been fully read in is represented by
915 a partial_symtab. This contains the information on where in the
916 executable the debugging symbols for a specific file are, and a
917 list of names of global symbols which are located in this file.
918 They are all chained on partial symtab lists.
920 Even after the source file has been read into a symtab, the
921 partial_symtab remains around. They are allocated on an obstack,
922 psymbol_obstack. FIXME, this is bad for dynamic linking or VxWorks-
923 style execution of a bunch of .o's. */
925 struct partial_symtab
928 /* Chain of all existing partial symtabs. */
930 struct partial_symtab
*next
;
932 /* Name of the source file which this partial_symtab defines */
936 /* Full path of the source file. NULL if not known. */
940 /* Information about the object file from which symbols should be read. */
942 struct objfile
*objfile
;
944 /* Set of relocation offsets to apply to each section. */
946 struct section_offsets
*section_offsets
;
948 /* Range of text addresses covered by this file; texthigh is the
949 beginning of the next section. */
954 /* Array of pointers to all of the partial_symtab's which this one
955 depends on. Since this array can only be set to previous or
956 the current (?) psymtab, this dependency tree is guaranteed not
957 to have any loops. "depends on" means that symbols must be read
958 for the dependencies before being read for this psymtab; this is
959 for type references in stabs, where if foo.c includes foo.h, declarations
960 in foo.h may use type numbers defined in foo.c. For other debugging
961 formats there may be no need to use dependencies. */
963 struct partial_symtab
**dependencies
;
965 int number_of_dependencies
;
967 /* Global symbol list. This list will be sorted after readin to
968 improve access. Binary search will be the usual method of
969 finding a symbol within it. globals_offset is an integer offset
970 within global_psymbols[]. */
975 /* Static symbol list. This list will *not* be sorted after readin;
976 to find a symbol in it, exhaustive search must be used. This is
977 reasonable because searches through this list will eventually
978 lead to either the read in of a files symbols for real (assumed
979 to take a *lot* of time; check) or an error (and we don't care
980 how long errors take). This is an offset and size within
981 static_psymbols[]. */
986 /* Pointer to symtab eventually allocated for this source file, 0 if
987 !readin or if we haven't looked for the symtab after it was readin. */
989 struct symtab
*symtab
;
991 /* Pointer to function which will read in the symtab corresponding to
994 void (*read_symtab
) (struct partial_symtab
*);
996 /* Information that lets read_symtab() locate the part of the symbol table
997 that this psymtab corresponds to. This information is private to the
998 format-dependent symbol reading routines. For further detail examine
999 the various symbol reading modules. Should really be (void *) but is
1000 (char *) as with other such gdb variables. (FIXME) */
1002 char *read_symtab_private
;
1004 /* Non-zero if the symtab corresponding to this psymtab has been readin */
1006 unsigned char readin
;
1009 /* A fast way to get from a psymtab to its symtab (after the first time). */
1010 #define PSYMTAB_TO_SYMTAB(pst) \
1011 ((pst) -> symtab != NULL ? (pst) -> symtab : psymtab_to_symtab (pst))
1014 /* The virtual function table is now an array of structures which have the
1015 form { int16 offset, delta; void *pfn; }.
1017 In normal virtual function tables, OFFSET is unused.
1018 DELTA is the amount which is added to the apparent object's base
1019 address in order to point to the actual object to which the
1020 virtual function should be applied.
1021 PFN is a pointer to the virtual function.
1023 Note that this macro is g++ specific (FIXME). */
1025 #define VTBL_FNADDR_OFFSET 2
1027 /* External variables and functions for the objects described above. */
1029 /* See the comment in symfile.c about how current_objfile is used. */
1031 extern struct objfile
*current_objfile
;
1033 /* True if we are nested inside psymtab_to_symtab. */
1035 extern int currently_reading_symtab
;
1038 extern int demangle
;
1039 extern int asm_demangle
;
1041 /* symtab.c lookup functions */
1043 /* lookup a symbol table by source file name */
1045 extern struct symtab
*lookup_symtab (const char *);
1047 /* lookup a symbol by name (optional block, optional symtab) */
1049 extern struct symbol
*lookup_symbol (const char *, const struct block
*,
1050 const namespace_enum
, int *,
1053 /* lookup a symbol by name, within a specified block */
1055 extern struct symbol
*lookup_block_symbol (const struct block
*, const char *,
1057 const namespace_enum
);
1059 /* lookup a [struct, union, enum] by name, within a specified block */
1061 extern struct type
*lookup_struct (char *, struct block
*);
1063 extern struct type
*lookup_union (char *, struct block
*);
1065 extern struct type
*lookup_enum (char *, struct block
*);
1067 /* lookup the function corresponding to the block */
1069 extern struct symbol
*block_function (struct block
*);
1071 /* from blockframe.c: */
1073 /* lookup the function symbol corresponding to the address */
1075 extern struct symbol
*find_pc_function (CORE_ADDR
);
1077 /* lookup the function corresponding to the address and section */
1079 extern struct symbol
*find_pc_sect_function (CORE_ADDR
, asection
*);
1081 /* lookup function from address, return name, start addr and end addr */
1083 extern int find_pc_partial_function (CORE_ADDR
, char **, CORE_ADDR
*,
1086 extern void clear_pc_function_cache (void);
1088 extern int find_pc_sect_partial_function (CORE_ADDR
, asection
*,
1089 char **, CORE_ADDR
*, CORE_ADDR
*);
1091 /* from symtab.c: */
1093 /* lookup partial symbol table by filename */
1095 extern struct partial_symtab
*lookup_partial_symtab (const char *);
1097 /* lookup partial symbol table by address */
1099 extern struct partial_symtab
*find_pc_psymtab (CORE_ADDR
);
1101 /* lookup partial symbol table by address and section */
1103 extern struct partial_symtab
*find_pc_sect_psymtab (CORE_ADDR
, asection
*);
1105 /* lookup full symbol table by address */
1107 extern struct symtab
*find_pc_symtab (CORE_ADDR
);
1109 /* lookup full symbol table by address and section */
1111 extern struct symtab
*find_pc_sect_symtab (CORE_ADDR
, asection
*);
1113 /* lookup partial symbol by address */
1115 extern struct partial_symbol
*find_pc_psymbol (struct partial_symtab
*,
1118 /* lookup partial symbol by address and section */
1120 extern struct partial_symbol
*find_pc_sect_psymbol (struct partial_symtab
*,
1121 CORE_ADDR
, asection
*);
1123 extern int find_pc_line_pc_range (CORE_ADDR
, CORE_ADDR
*, CORE_ADDR
*);
1125 extern int contained_in (struct block
*, struct block
*);
1127 extern void reread_symbols (void);
1129 extern struct type
*lookup_transparent_type (const char *);
1132 /* Macro for name of symbol to indicate a file compiled with gcc. */
1133 #ifndef GCC_COMPILED_FLAG_SYMBOL
1134 #define GCC_COMPILED_FLAG_SYMBOL "gcc_compiled."
1137 /* Macro for name of symbol to indicate a file compiled with gcc2. */
1138 #ifndef GCC2_COMPILED_FLAG_SYMBOL
1139 #define GCC2_COMPILED_FLAG_SYMBOL "gcc2_compiled."
1142 /* Functions for dealing with the minimal symbol table, really a misc
1143 address<->symbol mapping for things we don't have debug symbols for. */
1145 extern void prim_record_minimal_symbol (const char *, CORE_ADDR
,
1146 enum minimal_symbol_type
,
1149 extern struct minimal_symbol
*prim_record_minimal_symbol_and_info
1150 (const char *, CORE_ADDR
,
1151 enum minimal_symbol_type
,
1152 char *info
, int section
, asection
* bfd_section
, struct objfile
*);
1154 extern unsigned int msymbol_hash_iw (const char *);
1156 extern unsigned int msymbol_hash (const char *);
1159 add_minsym_to_hash_table (struct minimal_symbol
*sym
,
1160 struct minimal_symbol
**table
);
1162 extern struct minimal_symbol
*lookup_minimal_symbol (const char *,
1166 extern struct minimal_symbol
*lookup_minimal_symbol_text (const char *,
1170 struct minimal_symbol
*lookup_minimal_symbol_solib_trampoline (const char *,
1175 extern struct minimal_symbol
*lookup_minimal_symbol_by_pc (CORE_ADDR
);
1177 extern struct minimal_symbol
*lookup_minimal_symbol_by_pc_section (CORE_ADDR
,
1181 extern struct minimal_symbol
1182 *lookup_solib_trampoline_symbol_by_pc (CORE_ADDR
);
1184 extern CORE_ADDR
find_solib_trampoline_target (CORE_ADDR
);
1186 extern void init_minimal_symbol_collection (void);
1188 extern struct cleanup
*make_cleanup_discard_minimal_symbols (void);
1190 extern void install_minimal_symbols (struct objfile
*);
1192 /* Sort all the minimal symbols in OBJFILE. */
1194 extern void msymbols_sort (struct objfile
*objfile
);
1196 struct symtab_and_line
1198 struct symtab
*symtab
;
1200 /* Line number. Line numbers start at 1 and proceed through symtab->nlines.
1201 0 is never a valid line number; it is used to indicate that line number
1202 information is not available. */
1209 extern void init_sal (struct symtab_and_line
*sal
);
1211 struct symtabs_and_lines
1213 struct symtab_and_line
*sals
;
1219 /* Some types and macros needed for exception catchpoints.
1220 Can't put these in target.h because symtab_and_line isn't
1221 known there. This file will be included by breakpoint.c,
1222 hppa-tdep.c, etc. */
1224 /* Enums for exception-handling support */
1225 enum exception_event_kind
1231 /* Type for returning info about an exception */
1232 struct exception_event_record
1234 enum exception_event_kind kind
;
1235 struct symtab_and_line throw_sal
;
1236 struct symtab_and_line catch_sal
;
1237 /* This may need to be extended in the future, if
1238 some platforms allow reporting more information,
1239 such as point of rethrow, type of exception object,
1240 type expected by catch clause, etc. */
1243 #define CURRENT_EXCEPTION_KIND (current_exception_event->kind)
1244 #define CURRENT_EXCEPTION_CATCH_SAL (current_exception_event->catch_sal)
1245 #define CURRENT_EXCEPTION_CATCH_LINE (current_exception_event->catch_sal.line)
1246 #define CURRENT_EXCEPTION_CATCH_FILE (current_exception_event->catch_sal.symtab->filename)
1247 #define CURRENT_EXCEPTION_CATCH_PC (current_exception_event->catch_sal.pc)
1248 #define CURRENT_EXCEPTION_THROW_SAL (current_exception_event->throw_sal)
1249 #define CURRENT_EXCEPTION_THROW_LINE (current_exception_event->throw_sal.line)
1250 #define CURRENT_EXCEPTION_THROW_FILE (current_exception_event->throw_sal.symtab->filename)
1251 #define CURRENT_EXCEPTION_THROW_PC (current_exception_event->throw_sal.pc)
1254 /* Given a pc value, return line number it is in. Second arg nonzero means
1255 if pc is on the boundary use the previous statement's line number. */
1257 extern struct symtab_and_line
find_pc_line (CORE_ADDR
, int);
1259 /* Same function, but specify a section as well as an address */
1261 extern struct symtab_and_line
find_pc_sect_line (CORE_ADDR
, asection
*, int);
1263 /* Given a symtab and line number, return the pc there. */
1265 extern int find_line_pc (struct symtab
*, int, CORE_ADDR
*);
1267 extern int find_line_pc_range (struct symtab_and_line
, CORE_ADDR
*,
1270 extern void resolve_sal_pc (struct symtab_and_line
*);
1272 /* Given a string, return the line specified by it. For commands like "list"
1273 and "breakpoint". */
1275 extern struct symtabs_and_lines
decode_line_spec (char *, int);
1277 extern struct symtabs_and_lines
decode_line_spec_1 (char *, int);
1281 void maintenance_print_symbols (char *, int);
1283 void maintenance_print_psymbols (char *, int);
1285 void maintenance_print_msymbols (char *, int);
1287 void maintenance_print_objfiles (char *, int);
1289 void maintenance_check_symtabs (char *, int);
1293 void maintenance_print_statistics (char *, int);
1295 extern void free_symtab (struct symtab
*);
1297 /* Symbol-reading stuff in symfile.c and solib.c. */
1299 extern struct symtab
*psymtab_to_symtab (struct partial_symtab
*);
1301 extern void clear_solib (void);
1305 extern int identify_source_line (struct symtab
*, int, int, CORE_ADDR
);
1307 extern void print_source_lines (struct symtab
*, int, int, int);
1309 extern void forget_cached_source_info (void);
1311 extern void select_source_symtab (struct symtab
*);
1313 extern char **make_symbol_completion_list (char *, char *);
1315 extern char **make_file_symbol_completion_list (char *, char *, char *);
1317 extern struct symbol
**make_symbol_overload_list (struct symbol
*);
1319 extern char **make_source_files_completion_list (char *, char *);
1323 extern struct partial_symtab
*find_main_psymtab (void);
1325 extern struct symtab
*find_line_symtab (struct symtab
*, int, int *, int *);
1327 extern struct symtab_and_line
find_function_start_sal (struct symbol
*sym
,
1332 extern struct blockvector
*blockvector_for_pc (CORE_ADDR
, int *);
1334 extern struct blockvector
*blockvector_for_pc_sect (CORE_ADDR
, asection
*,
1335 int *, struct symtab
*);
1339 extern void clear_symtab_users (void);
1341 extern enum language
deduce_language_from_filename (char *);
1345 extern int in_prologue (CORE_ADDR pc
, CORE_ADDR func_start
);
1347 extern struct symbol
*fixup_symbol_section (struct symbol
*,
1350 extern struct partial_symbol
*fixup_psymbol_section (struct partial_symbol
1352 struct objfile
*objfile
);
1354 /* Symbol searching */
1356 /* When using search_symbols, a list of the following structs is returned.
1357 Callers must free the search list using free_search_symbols! */
1358 struct symbol_search
1360 /* The block in which the match was found. Could be, for example,
1361 STATIC_BLOCK or GLOBAL_BLOCK. */
1364 /* Information describing what was found.
1366 If symtab abd symbol are NOT NULL, then information was found
1368 struct symtab
*symtab
;
1369 struct symbol
*symbol
;
1371 /* If msymbol is non-null, then a match was made on something for
1372 which only minimal_symbols exist. */
1373 struct minimal_symbol
*msymbol
;
1375 /* A link to the next match, or NULL for the end. */
1376 struct symbol_search
*next
;
1379 extern void search_symbols (char *, namespace_enum
, int, char **,
1380 struct symbol_search
**);
1381 extern void free_search_symbols (struct symbol_search
*);
1382 extern struct cleanup
*make_cleanup_free_search_symbols (struct symbol_search
1385 /* The name of the ``main'' function.
1386 FIXME: cagney/2001-03-20: Can't make main_name() const since some
1387 of the calling code currently assumes that the string isn't
1389 extern void set_main_name (const char *name
);
1390 extern /*const */ char *main_name (void);
1392 #endif /* !defined(SYMTAB_H) */