1 /* Symbol table definitions for GDB.
2 Copyright 1986, 1988, 1989, 1990, 1991, 1992, 1993, 1994, 1995, 1996,
3 1997, 1998, 1999, 2000, 2001
4 Free Software Foundation, Inc.
6 This file is part of GDB.
8 This program is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 2 of the License, or
11 (at your option) any later version.
13 This program is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with this program; if not, write to the Free Software
20 Foundation, Inc., 59 Temple Place - Suite 330,
21 Boston, MA 02111-1307, USA. */
23 #if !defined (SYMTAB_H)
26 /* Some definitions and declarations to go with use of obstacks. */
28 #include "gdb_obstack.h"
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++ */
93 struct chill_specific /* For Chill */
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 #define SYMBOL_NAME(symbol) (symbol)->ginfo.name
124 #define SYMBOL_VALUE(symbol) (symbol)->ginfo.value.ivalue
125 #define SYMBOL_VALUE_ADDRESS(symbol) (symbol)->ginfo.value.address
126 #define SYMBOL_VALUE_BYTES(symbol) (symbol)->ginfo.value.bytes
127 #define SYMBOL_BLOCK_VALUE(symbol) (symbol)->ginfo.value.block
128 #define SYMBOL_VALUE_CHAIN(symbol) (symbol)->ginfo.value.chain
129 #define SYMBOL_LANGUAGE(symbol) (symbol)->ginfo.language
130 #define SYMBOL_SECTION(symbol) (symbol)->ginfo.section
131 #define SYMBOL_BFD_SECTION(symbol) (symbol)->ginfo.bfd_section
133 #define SYMBOL_CPLUS_DEMANGLED_NAME(symbol) \
134 (symbol)->ginfo.language_specific.cplus_specific.demangled_name
136 /* Macro that initializes the language dependent portion of a symbol
137 depending upon the language for the symbol. */
139 #define SYMBOL_INIT_LANGUAGE_SPECIFIC(symbol,language) \
141 SYMBOL_LANGUAGE (symbol) = language; \
142 if (SYMBOL_LANGUAGE (symbol) == language_cplus \
143 || SYMBOL_LANGUAGE (symbol) == language_java \
146 SYMBOL_CPLUS_DEMANGLED_NAME (symbol) = NULL; \
148 else if (SYMBOL_LANGUAGE (symbol) == language_chill) \
150 SYMBOL_CHILL_DEMANGLED_NAME (symbol) = NULL; \
154 memset (&(symbol)->ginfo.language_specific, 0, \
155 sizeof ((symbol)->ginfo.language_specific)); \
159 #define SYMBOL_INIT_DEMANGLED_NAME(symbol,obstack) \
160 (symbol_init_demangled_name (&symbol->ginfo, (obstack)))
161 extern void symbol_init_demangled_name (struct general_symbol_info *symbol,
162 struct obstack *obstack);
165 /* Macro that returns the demangled name for a symbol based on the language
166 for that symbol. If no demangled name exists, returns NULL. */
168 #define SYMBOL_DEMANGLED_NAME(symbol) \
169 (SYMBOL_LANGUAGE (symbol) == language_cplus \
170 || SYMBOL_LANGUAGE (symbol) == language_java \
171 ? SYMBOL_CPLUS_DEMANGLED_NAME (symbol) \
172 : (SYMBOL_LANGUAGE (symbol) == language_chill \
173 ? SYMBOL_CHILL_DEMANGLED_NAME (symbol) \
176 #define SYMBOL_CHILL_DEMANGLED_NAME(symbol) \
177 (symbol)->ginfo.language_specific.chill_specific.demangled_name
179 /* Macro that returns the "natural source name" of a symbol. In C++ this is
180 the "demangled" form of the name if demangle is on and the "mangled" form
181 of the name if demangle is off. In other languages this is just the
182 symbol name. The result should never be NULL. */
184 #define SYMBOL_SOURCE_NAME(symbol) \
185 (demangle && SYMBOL_DEMANGLED_NAME (symbol) != NULL \
186 ? SYMBOL_DEMANGLED_NAME (symbol) \
187 : SYMBOL_NAME (symbol))
189 /* Macro that returns the "natural assembly name" of a symbol. In C++ this is
190 the "mangled" form of the name if demangle is off, or if demangle is on and
191 asm_demangle is off. Otherwise if asm_demangle is on it is the "demangled"
192 form. In other languages this is just the symbol name. The result should
195 #define SYMBOL_LINKAGE_NAME(symbol) \
196 (demangle && asm_demangle && SYMBOL_DEMANGLED_NAME (symbol) != NULL \
197 ? SYMBOL_DEMANGLED_NAME (symbol) \
198 : SYMBOL_NAME (symbol))
200 /* Macro that tests a symbol for a match against a specified name string.
201 First test the unencoded name, then looks for and test a C++ encoded
202 name if it exists. Note that whitespace is ignored while attempting to
203 match a C++ encoded name, so that "foo::bar(int,long)" is the same as
204 "foo :: bar (int, long)".
205 Evaluates to zero if the match fails, or nonzero if it succeeds. */
207 #define SYMBOL_MATCHES_NAME(symbol, name) \
208 (STREQ (SYMBOL_NAME (symbol), (name)) \
209 || (SYMBOL_DEMANGLED_NAME (symbol) != NULL \
210 && strcmp_iw (SYMBOL_DEMANGLED_NAME (symbol), (name)) == 0))
212 /* Macro that tests a symbol for an re-match against the last compiled regular
213 expression. First test the unencoded name, then look for and test a C++
214 encoded name if it exists.
215 Evaluates to zero if the match fails, or nonzero if it succeeds. */
217 #define SYMBOL_MATCHES_REGEXP(symbol) \
218 (re_exec (SYMBOL_NAME (symbol)) != 0 \
219 || (SYMBOL_DEMANGLED_NAME (symbol) != NULL \
220 && re_exec (SYMBOL_DEMANGLED_NAME (symbol)) != 0))
222 /* Define a simple structure used to hold some very basic information about
223 all defined global symbols (text, data, bss, abs, etc). The only required
224 information is the general_symbol_info.
226 In many cases, even if a file was compiled with no special options for
227 debugging at all, as long as was not stripped it will contain sufficient
228 information to build a useful minimal symbol table using this structure.
229 Even when a file contains enough debugging information to build a full
230 symbol table, these minimal symbols are still useful for quickly mapping
231 between names and addresses, and vice versa. They are also sometimes
232 used to figure out what full symbol table entries need to be read in. */
234 struct minimal_symbol
237 /* The general symbol info required for all types of symbols.
239 The SYMBOL_VALUE_ADDRESS contains the address that this symbol
242 struct general_symbol_info ginfo;
244 /* The info field is available for caching machine-specific information
245 so it doesn't have to rederive the info constantly (over a serial line).
246 It is initialized to zero and stays that way until target-dependent code
247 sets it. Storage for any data pointed to by this field should be allo-
248 cated on the symbol_obstack for the associated objfile.
249 The type would be "void *" except for reasons of compatibility with older
250 compilers. This field is optional.
252 Currently, the AMD 29000 tdep.c uses it to remember things it has decoded
253 from the instructions in the function header, and the MIPS-16 code uses
254 it to identify 16-bit procedures. */
258 #ifdef SOFUN_ADDRESS_MAYBE_MISSING
259 /* Which source file is this symbol in? Only relevant for mst_file_*. */
263 /* Classification types for this symbol. These should be taken as "advisory
264 only", since if gdb can't easily figure out a classification it simply
265 selects mst_unknown. It may also have to guess when it can't figure out
266 which is a better match between two types (mst_data versus mst_bss) for
267 example. Since the minimal symbol info is sometimes derived from the
268 BFD library's view of a file, we need to live with what information bfd
271 enum minimal_symbol_type
273 mst_unknown = 0, /* Unknown type, the default */
274 mst_text, /* Generally executable instructions */
275 mst_data, /* Generally initialized data */
276 mst_bss, /* Generally uninitialized data */
277 mst_abs, /* Generally absolute (nonrelocatable) */
278 /* GDB uses mst_solib_trampoline for the start address of a shared
279 library trampoline entry. Breakpoints for shared library functions
280 are put there if the shared library is not yet loaded.
281 After the shared library is loaded, lookup_minimal_symbol will
282 prefer the minimal symbol from the shared library (usually
283 a mst_text symbol) over the mst_solib_trampoline symbol, and the
284 breakpoints will be moved to their true address in the shared
285 library via breakpoint_re_set. */
286 mst_solib_trampoline, /* Shared library trampoline code */
287 /* For the mst_file* types, the names are only guaranteed to be unique
288 within a given .o file. */
289 mst_file_text, /* Static version of mst_text */
290 mst_file_data, /* Static version of mst_data */
291 mst_file_bss /* Static version of mst_bss */
295 /* Minimal symbols with the same hash key are kept on a linked
296 list. This is the link. */
298 struct minimal_symbol *hash_next;
300 /* Minimal symbols are stored in two different hash tables. This is
301 the `next' pointer for the demangled hash table. */
303 struct minimal_symbol *demangled_hash_next;
306 #define MSYMBOL_INFO(msymbol) (msymbol)->info
307 #define MSYMBOL_TYPE(msymbol) (msymbol)->type
311 /* All of the name-scope contours of the program
312 are represented by `struct block' objects.
313 All of these objects are pointed to by the blockvector.
315 Each block represents one name scope.
316 Each lexical context has its own block.
318 The blockvector begins with some special blocks.
319 The GLOBAL_BLOCK contains all the symbols defined in this compilation
320 whose scope is the entire program linked together.
321 The STATIC_BLOCK contains all the symbols whose scope is the
322 entire compilation excluding other separate compilations.
323 Blocks starting with the FIRST_LOCAL_BLOCK are not special.
325 Each block records a range of core addresses for the code that
326 is in the scope of the block. The STATIC_BLOCK and GLOBAL_BLOCK
327 give, for the range of code, the entire range of code produced
328 by the compilation that the symbol segment belongs to.
330 The blocks appear in the blockvector
331 in order of increasing starting-address,
332 and, within that, in order of decreasing ending-address.
334 This implies that within the body of one function
335 the blocks appear in the order of a depth-first tree walk. */
339 /* Number of blocks in the list. */
341 /* The blocks themselves. */
342 struct block *block[1];
345 #define BLOCKVECTOR_NBLOCKS(blocklist) (blocklist)->nblocks
346 #define BLOCKVECTOR_BLOCK(blocklist,n) (blocklist)->block[n]
348 /* Special block numbers */
350 #define GLOBAL_BLOCK 0
351 #define STATIC_BLOCK 1
352 #define FIRST_LOCAL_BLOCK 2
357 /* Addresses in the executable code that are in this block. */
362 /* The symbol that names this block, if the block is the body of a
363 function; otherwise, zero. */
365 struct symbol *function;
367 /* The `struct block' for the containing block, or 0 if none.
369 The superblock of a top-level local block (i.e. a function in the
370 case of C) is the STATIC_BLOCK. The superblock of the
371 STATIC_BLOCK is the GLOBAL_BLOCK. */
373 struct block *superblock;
375 /* Version of GCC used to compile the function corresponding
376 to this block, or 0 if not compiled with GCC. When possible,
377 GCC should be compatible with the native compiler, or if that
378 is not feasible, the differences should be fixed during symbol
379 reading. As of 16 Apr 93, this flag is never used to distinguish
380 between gcc2 and the native compiler.
382 If there is no function corresponding to this block, this meaning
383 of this flag is undefined. */
385 unsigned char gcc_compile_flag;
387 /* The symbols for this block are either in a simple linear list or
388 in a simple hashtable. Blocks which correspond to a function
389 (which have a list of symbols corresponding to arguments) use
390 a linear list, as do some older symbol readers (currently only
391 mdebugread and dstread). Other blocks are hashed.
393 The hashtable uses the same hash function as the minsym hashtables,
394 found in minsyms.c:minsym_hash_iw. Symbols are hashed based on
395 their demangled name if appropriate, and on their name otherwise.
396 The hash function ignores space, and stops at the beginning of the
397 argument list if any.
399 The table is laid out in NSYMS/5 buckets and symbols are chained via
400 their hash_next field. */
402 /* If this is really a hashtable of the symbols, this flag is 1. */
404 unsigned char hashtable;
406 /* Number of local symbols. */
410 /* The symbols. If some of them are arguments, then they must be
411 in the order in which we would like to print them. */
413 struct symbol *sym[1];
416 #define BLOCK_START(bl) (bl)->startaddr
417 #define BLOCK_END(bl) (bl)->endaddr
418 #define BLOCK_FUNCTION(bl) (bl)->function
419 #define BLOCK_SUPERBLOCK(bl) (bl)->superblock
420 #define BLOCK_GCC_COMPILED(bl) (bl)->gcc_compile_flag
421 #define BLOCK_HASHTABLE(bl) (bl)->hashtable
423 /* For blocks without a hashtable (BLOCK_HASHTABLE (bl) == 0) only. */
424 #define BLOCK_NSYMS(bl) (bl)->nsyms
425 #define BLOCK_SYM(bl, n) (bl)->sym[n]
427 /* For blocks with a hashtable, but these are valid for non-hashed blocks as
428 well - each symbol will appear to be one bucket by itself. */
429 #define BLOCK_BUCKETS(bl) (bl)->nsyms
430 #define BLOCK_BUCKET(bl, n) (bl)->sym[n]
432 /* Macro used to set the size of a hashtable for N symbols. */
433 #define BLOCK_HASHTABLE_SIZE(n) ((n)/5 + 1)
435 /* Macro to loop through all symbols in a block BL, in no particular order.
436 i counts which bucket we are in, and sym points to the current symbol. */
438 #define ALL_BLOCK_SYMBOLS(bl, i, sym) \
439 for ((i) = 0; (i) < BLOCK_BUCKETS ((bl)); (i)++) \
440 for ((sym) = BLOCK_BUCKET ((bl), (i)); (sym); \
441 (sym) = (sym)->hash_next)
443 /* Nonzero if symbols of block BL should be sorted alphabetically.
444 Don't sort a block which corresponds to a function. If we did the
445 sorting would have to preserve the order of the symbols for the
446 arguments. Also don't sort any block that we chose to hash. */
448 #define BLOCK_SHOULD_SORT(bl) (! BLOCK_HASHTABLE (bl) \
449 && BLOCK_FUNCTION (bl) == NULL)
452 /* Represent one symbol name; a variable, constant, function or typedef. */
454 /* Different name spaces for symbols. Looking up a symbol specifies a
455 namespace and ignores symbol definitions in other name spaces. */
459 /* UNDEF_NAMESPACE is used when a namespace has not been discovered or
460 none of the following apply. This usually indicates an error either
461 in the symbol information or in gdb's handling of symbols. */
465 /* VAR_NAMESPACE is the usual namespace. In C, this contains variables,
466 function names, typedef names and enum type values. */
470 /* STRUCT_NAMESPACE is used in C to hold struct, union and enum type names.
471 Thus, if `struct foo' is used in a C program, it produces a symbol named
472 `foo' in the STRUCT_NAMESPACE. */
476 /* LABEL_NAMESPACE may be used for names of labels (for gotos);
477 currently it is not used and labels are not recorded at all. */
481 /* Searching namespaces. These overlap with VAR_NAMESPACE, providing
482 some granularity with the search_symbols function. */
484 /* Everything in VAR_NAMESPACE minus FUNCTIONS_-, TYPES_-, and
488 /* All functions -- for some reason not methods, though. */
491 /* All defined types */
494 /* All class methods -- why is this separated out? */
500 /* An address-class says where to find the value of a symbol. */
504 /* Not used; catches errors */
508 /* Value is constant int SYMBOL_VALUE, host byteorder */
512 /* Value is at fixed address SYMBOL_VALUE_ADDRESS */
516 /* Value is in register. SYMBOL_VALUE is the register number. */
520 /* It's an argument; the value is at SYMBOL_VALUE offset in arglist. */
524 /* Value address is at SYMBOL_VALUE offset in arglist. */
528 /* Value is in register number SYMBOL_VALUE. Just like LOC_REGISTER
529 except this is an argument. Probably the cleaner way to handle
530 this would be to separate address_class (which would include
531 separate ARG and LOCAL to deal with FRAME_ARGS_ADDRESS versus
532 FRAME_LOCALS_ADDRESS), and an is_argument flag.
534 For some symbol formats (stabs, for some compilers at least),
535 the compiler generates two symbols, an argument and a register.
536 In some cases we combine them to a single LOC_REGPARM in symbol
537 reading, but currently not for all cases (e.g. it's passed on the
538 stack and then loaded into a register). */
542 /* Value is in specified register. Just like LOC_REGPARM except the
543 register holds the address of the argument instead of the argument
544 itself. This is currently used for the passing of structs and unions
545 on sparc and hppa. It is also used for call by reference where the
546 address is in a register, at least by mipsread.c. */
550 /* Value is a local variable at SYMBOL_VALUE offset in stack frame. */
554 /* Value not used; definition in SYMBOL_TYPE. Symbols in the namespace
555 STRUCT_NAMESPACE all have this class. */
559 /* Value is address SYMBOL_VALUE_ADDRESS in the code */
563 /* In a symbol table, value is SYMBOL_BLOCK_VALUE of a `struct block'.
564 In a partial symbol table, SYMBOL_VALUE_ADDRESS is the start address
565 of the block. Function names have this class. */
569 /* Value is a constant byte-sequence pointed to by SYMBOL_VALUE_BYTES, in
570 target byte order. */
574 /* Value is arg at SYMBOL_VALUE offset in stack frame. Differs from
575 LOC_LOCAL in that symbol is an argument; differs from LOC_ARG in
576 that we find it in the frame (FRAME_LOCALS_ADDRESS), not in the
577 arglist (FRAME_ARGS_ADDRESS). Added for i960, which passes args
578 in regs then copies to frame. */
582 /* Value is at SYMBOL_VALUE offset from the current value of
583 register number SYMBOL_BASEREG. This exists mainly for the same
584 things that LOC_LOCAL and LOC_ARG do; but we need to do this
585 instead because on 88k DWARF gives us the offset from the
586 frame/stack pointer, rather than the offset from the "canonical
587 frame address" used by COFF, stabs, etc., and we don't know how
588 to convert between these until we start examining prologues.
590 Note that LOC_BASEREG is much less general than a DWARF expression.
591 We don't need the generality (at least not yet), and storing a general
592 DWARF expression would presumably take up more space than the existing
597 /* Same as LOC_BASEREG but it is an argument. */
601 /* Value is at fixed address, but the address of the variable has
602 to be determined from the minimal symbol table whenever the
603 variable is referenced.
604 This happens if debugging information for a global symbol is
605 emitted and the corresponding minimal symbol is defined
606 in another object file or runtime common storage.
607 The linker might even remove the minimal symbol if the global
608 symbol is never referenced, in which case the symbol remains
613 /* Value is at a thread-specific location calculated by a
614 target-specific method. */
616 LOC_THREAD_LOCAL_STATIC,
618 /* The variable does not actually exist in the program.
619 The value is ignored. */
623 /* The variable is static, but actually lives at * (address).
624 * I.e. do an extra indirection to get to it.
625 * This is used on HP-UX to get at globals that are allocated
626 * in shared libraries, where references from images other
627 * than the one where the global was allocated are done
628 * with a level of indirection.
635 /* Linked list of symbol's live ranges. */
641 struct range_list *next;
644 /* Linked list of aliases for a particular main/primary symbol. */
648 struct alias_list *next;
654 /* The general symbol info required for all types of symbols. */
656 struct general_symbol_info ginfo;
658 /* Data type of value */
662 /* Name space code. */
665 /* FIXME: don't conflict with C++'s namespace */
666 /* would be safer to do a global change for all namespace identifiers. */
667 #define namespace _namespace
669 namespace_enum namespace BYTE_BITFIELD;
673 enum address_class aclass BYTE_BITFIELD;
675 /* Line number of definition. FIXME: Should we really make the assumption
676 that nobody will try to debug files longer than 64K lines? What about
677 machine generated programs? */
681 /* Some symbols require an additional value to be recorded on a per-
682 symbol basis. Stash those values here. */
686 /* Used by LOC_BASEREG and LOC_BASEREG_ARG. */
692 /* Link to a list of aliases for this symbol.
693 Only a "primary/main symbol may have aliases. */
694 struct alias_list *aliases;
696 /* List of ranges where this symbol is active. This is only
697 used by alias symbols at the current time. */
698 struct range_list *ranges;
700 struct symbol *hash_next;
704 #define SYMBOL_NAMESPACE(symbol) (symbol)->namespace
705 #define SYMBOL_CLASS(symbol) (symbol)->aclass
706 #define SYMBOL_TYPE(symbol) (symbol)->type
707 #define SYMBOL_LINE(symbol) (symbol)->line
708 #define SYMBOL_BASEREG(symbol) (symbol)->aux_value.basereg
709 #define SYMBOL_ALIASES(symbol) (symbol)->aliases
710 #define SYMBOL_RANGES(symbol) (symbol)->ranges
712 /* A partial_symbol records the name, namespace, and address class of
713 symbols whose types we have not parsed yet. For functions, it also
714 contains their memory address, so we can find them from a PC value.
715 Each partial_symbol sits in a partial_symtab, all of which are chained
716 on a partial symtab list and which points to the corresponding
717 normal symtab once the partial_symtab has been referenced. */
719 struct partial_symbol
722 /* The general symbol info required for all types of symbols. */
724 struct general_symbol_info ginfo;
726 /* Name space code. */
728 namespace_enum namespace BYTE_BITFIELD;
730 /* Address class (for info_symbols) */
732 enum address_class aclass BYTE_BITFIELD;
736 #define PSYMBOL_NAMESPACE(psymbol) (psymbol)->namespace
737 #define PSYMBOL_CLASS(psymbol) (psymbol)->aclass
740 /* Source-file information. This describes the relation between source files,
741 line numbers and addresses in the program text. */
745 int length; /* Number of source files described */
746 struct source *source[1]; /* Descriptions of the files */
749 /* Each item represents a line-->pc (or the reverse) mapping. This is
750 somewhat more wasteful of space than one might wish, but since only
751 the files which are actually debugged are read in to core, we don't
754 struct linetable_entry
760 /* The order of entries in the linetable is significant. They should
761 be sorted by increasing values of the pc field. If there is more than
762 one entry for a given pc, then I'm not sure what should happen (and
763 I not sure whether we currently handle it the best way).
765 Example: a C for statement generally looks like this
767 10 0x100 - for the init/test part of a for stmt.
770 10 0x400 - for the increment part of a for stmt.
772 If an entry has a line number of zero, it marks the start of a PC
773 range for which no line number information is available. It is
774 acceptable, though wasteful of table space, for such a range to be
781 /* Actually NITEMS elements. If you don't like this use of the
782 `struct hack', you can shove it up your ANSI (seriously, if the
783 committee tells us how to do it, we can probably go along). */
784 struct linetable_entry item[1];
787 /* All the information on one source file. */
791 char *name; /* Name of file */
792 struct linetable contents;
795 /* How to relocate the symbols from each section in a symbol file.
796 Each struct contains an array of offsets.
797 The ordering and meaning of the offsets is file-type-dependent;
798 typically it is indexed by section numbers or symbol types or
801 To give us flexibility in changing the internal representation
802 of these offsets, the ANOFFSET macro must be used to insert and
803 extract offset values in the struct. */
805 struct section_offsets
807 CORE_ADDR offsets[1]; /* As many as needed. */
810 #define ANOFFSET(secoff, whichone) \
812 ? (internal_error (__FILE__, __LINE__, "Section index is uninitialized"), -1) \
813 : secoff->offsets[whichone])
815 /* The maximum possible size of a section_offsets table. */
817 #define SIZEOF_SECTION_OFFSETS \
818 (sizeof (struct section_offsets) \
819 + sizeof (((struct section_offsets *) 0)->offsets) * (SECT_OFF_MAX-1))
821 /* Each source file or header is represented by a struct symtab.
822 These objects are chained through the `next' field. */
827 /* Chain of all existing symtabs. */
831 /* List of all symbol scope blocks for this symtab. May be shared
832 between different symtabs (and normally is for all the symtabs
833 in a given compilation unit). */
835 struct blockvector *blockvector;
837 /* Table mapping core addresses to line numbers for this file.
838 Can be NULL if none. Never shared between different symtabs. */
840 struct linetable *linetable;
842 /* Section in objfile->section_offsets for the blockvector and
843 the linetable. Probably always SECT_OFF_TEXT. */
845 int block_line_section;
847 /* If several symtabs share a blockvector, exactly one of them
848 should be designated the primary, so that the blockvector
849 is relocated exactly once by objfile_relocate. */
853 /* The macro table for this symtab. Like the blockvector, this
854 may be shared between different symtabs --- and normally is for
855 all the symtabs in a given compilation unit. */
856 struct macro_table *macro_table;
858 /* Name of this source file. */
862 /* Directory in which it was compiled, or NULL if we don't know. */
866 /* This component says how to free the data we point to:
867 free_contents => do a tree walk and free each object.
868 free_nothing => do nothing; some other symtab will free
869 the data this one uses.
870 free_linetable => free just the linetable. FIXME: Is this redundant
871 with the primary field? */
875 free_nothing, free_contents, free_linetable
879 /* Pointer to one block of storage to be freed, if nonzero. */
880 /* This is IN ADDITION to the action indicated by free_code. */
884 /* Total number of lines found in source file. */
888 /* line_charpos[N] is the position of the (N-1)th line of the
889 source file. "position" means something we can lseek() to; it
890 is not guaranteed to be useful any other way. */
894 /* Language of this source file. */
896 enum language language;
898 /* String that identifies the format of the debugging information, such
899 as "stabs", "dwarf 1", "dwarf 2", "coff", etc. This is mostly useful
900 for automated testing of gdb but may also be information that is
901 useful to the user. */
905 /* String of version information. May be zero. */
909 /* Full name of file as found by searching the source path.
910 NULL if not yet known. */
914 /* Object file from which this symbol information was read. */
916 struct objfile *objfile;
920 #define BLOCKVECTOR(symtab) (symtab)->blockvector
921 #define LINETABLE(symtab) (symtab)->linetable
924 /* Each source file that has not been fully read in is represented by
925 a partial_symtab. This contains the information on where in the
926 executable the debugging symbols for a specific file are, and a
927 list of names of global symbols which are located in this file.
928 They are all chained on partial symtab lists.
930 Even after the source file has been read into a symtab, the
931 partial_symtab remains around. They are allocated on an obstack,
932 psymbol_obstack. FIXME, this is bad for dynamic linking or VxWorks-
933 style execution of a bunch of .o's. */
935 struct partial_symtab
938 /* Chain of all existing partial symtabs. */
940 struct partial_symtab *next;
942 /* Name of the source file which this partial_symtab defines */
946 /* Full path of the source file. NULL if not known. */
950 /* Information about the object file from which symbols should be read. */
952 struct objfile *objfile;
954 /* Set of relocation offsets to apply to each section. */
956 struct section_offsets *section_offsets;
958 /* Range of text addresses covered by this file; texthigh is the
959 beginning of the next section. */
964 /* Array of pointers to all of the partial_symtab's which this one
965 depends on. Since this array can only be set to previous or
966 the current (?) psymtab, this dependency tree is guaranteed not
967 to have any loops. "depends on" means that symbols must be read
968 for the dependencies before being read for this psymtab; this is
969 for type references in stabs, where if foo.c includes foo.h, declarations
970 in foo.h may use type numbers defined in foo.c. For other debugging
971 formats there may be no need to use dependencies. */
973 struct partial_symtab **dependencies;
975 int number_of_dependencies;
977 /* Global symbol list. This list will be sorted after readin to
978 improve access. Binary search will be the usual method of
979 finding a symbol within it. globals_offset is an integer offset
980 within global_psymbols[]. */
985 /* Static symbol list. This list will *not* be sorted after readin;
986 to find a symbol in it, exhaustive search must be used. This is
987 reasonable because searches through this list will eventually
988 lead to either the read in of a files symbols for real (assumed
989 to take a *lot* of time; check) or an error (and we don't care
990 how long errors take). This is an offset and size within
991 static_psymbols[]. */
996 /* Pointer to symtab eventually allocated for this source file, 0 if
997 !readin or if we haven't looked for the symtab after it was readin. */
999 struct symtab *symtab;
1001 /* Pointer to function which will read in the symtab corresponding to
1004 void (*read_symtab) (struct partial_symtab *);
1006 /* Information that lets read_symtab() locate the part of the symbol table
1007 that this psymtab corresponds to. This information is private to the
1008 format-dependent symbol reading routines. For further detail examine
1009 the various symbol reading modules. Should really be (void *) but is
1010 (char *) as with other such gdb variables. (FIXME) */
1012 char *read_symtab_private;
1014 /* Non-zero if the symtab corresponding to this psymtab has been readin */
1016 unsigned char readin;
1019 /* A fast way to get from a psymtab to its symtab (after the first time). */
1020 #define PSYMTAB_TO_SYMTAB(pst) \
1021 ((pst) -> symtab != NULL ? (pst) -> symtab : psymtab_to_symtab (pst))
1024 /* The virtual function table is now an array of structures which have the
1025 form { int16 offset, delta; void *pfn; }.
1027 In normal virtual function tables, OFFSET is unused.
1028 DELTA is the amount which is added to the apparent object's base
1029 address in order to point to the actual object to which the
1030 virtual function should be applied.
1031 PFN is a pointer to the virtual function.
1033 Note that this macro is g++ specific (FIXME). */
1035 #define VTBL_FNADDR_OFFSET 2
1037 /* External variables and functions for the objects described above. */
1039 /* This symtab variable specifies the current file for printing source lines */
1041 extern struct symtab *current_source_symtab;
1043 /* This is the next line to print for listing source lines. */
1045 extern int current_source_line;
1047 /* See the comment in symfile.c about how current_objfile is used. */
1049 extern struct objfile *current_objfile;
1051 /* True if we are nested inside psymtab_to_symtab. */
1053 extern int currently_reading_symtab;
1056 extern int demangle;
1057 extern int asm_demangle;
1059 /* symtab.c lookup functions */
1061 /* lookup a symbol table by source file name */
1063 extern struct symtab *lookup_symtab (const char *);
1065 /* lookup a symbol by name (optional block, optional symtab) */
1067 extern struct symbol *lookup_symbol (const char *, const struct block *,
1068 const namespace_enum, int *,
1071 /* lookup a symbol by name, within a specified block */
1073 extern struct symbol *lookup_block_symbol (const struct block *, const char *,
1075 const namespace_enum);
1077 /* lookup a [struct, union, enum] by name, within a specified block */
1079 extern struct type *lookup_struct (char *, struct block *);
1081 extern struct type *lookup_union (char *, struct block *);
1083 extern struct type *lookup_enum (char *, struct block *);
1085 /* lookup the function corresponding to the block */
1087 extern struct symbol *block_function (struct block *);
1089 /* from blockframe.c: */
1091 /* lookup the function symbol corresponding to the address */
1093 extern struct symbol *find_pc_function (CORE_ADDR);
1095 /* lookup the function corresponding to the address and section */
1097 extern struct symbol *find_pc_sect_function (CORE_ADDR, asection *);
1099 /* lookup function from address, return name, start addr and end addr */
1102 find_pc_partial_function (CORE_ADDR, char **, CORE_ADDR *, CORE_ADDR *);
1104 extern void clear_pc_function_cache (void);
1106 extern int find_pc_sect_partial_function (CORE_ADDR, asection *,
1107 char **, CORE_ADDR *, CORE_ADDR *);
1109 /* from symtab.c: */
1111 /* lookup partial symbol table by filename */
1113 extern struct partial_symtab *lookup_partial_symtab (const char *);
1115 /* lookup partial symbol table by address */
1117 extern struct partial_symtab *find_pc_psymtab (CORE_ADDR);
1119 /* lookup partial symbol table by address and section */
1121 extern struct partial_symtab *find_pc_sect_psymtab (CORE_ADDR, asection *);
1123 /* lookup full symbol table by address */
1125 extern struct symtab *find_pc_symtab (CORE_ADDR);
1127 /* lookup full symbol table by address and section */
1129 extern struct symtab *find_pc_sect_symtab (CORE_ADDR, asection *);
1131 /* lookup partial symbol by address */
1133 extern struct partial_symbol *find_pc_psymbol (struct partial_symtab *,
1136 /* lookup partial symbol by address and section */
1138 extern struct partial_symbol *find_pc_sect_psymbol (struct partial_symtab *,
1139 CORE_ADDR, asection *);
1141 extern int find_pc_line_pc_range (CORE_ADDR, CORE_ADDR *, CORE_ADDR *);
1143 extern int contained_in (struct block *, struct block *);
1145 extern void reread_symbols (void);
1147 extern struct type *lookup_transparent_type (const char *);
1150 /* Macro for name of symbol to indicate a file compiled with gcc. */
1151 #ifndef GCC_COMPILED_FLAG_SYMBOL
1152 #define GCC_COMPILED_FLAG_SYMBOL "gcc_compiled."
1155 /* Macro for name of symbol to indicate a file compiled with gcc2. */
1156 #ifndef GCC2_COMPILED_FLAG_SYMBOL
1157 #define GCC2_COMPILED_FLAG_SYMBOL "gcc2_compiled."
1160 /* Functions for dealing with the minimal symbol table, really a misc
1161 address<->symbol mapping for things we don't have debug symbols for. */
1163 extern void prim_record_minimal_symbol (const char *, CORE_ADDR,
1164 enum minimal_symbol_type,
1167 extern struct minimal_symbol *prim_record_minimal_symbol_and_info
1168 (const char *, CORE_ADDR,
1169 enum minimal_symbol_type,
1170 char *info, int section, asection * bfd_section, struct objfile *);
1172 extern unsigned int msymbol_hash_iw (const char *);
1174 extern unsigned int msymbol_hash (const char *);
1177 add_minsym_to_hash_table (struct minimal_symbol *sym,
1178 struct minimal_symbol **table);
1180 extern struct minimal_symbol *lookup_minimal_symbol (const char *,
1184 extern struct minimal_symbol *lookup_minimal_symbol_text (const char *,
1188 struct minimal_symbol *lookup_minimal_symbol_solib_trampoline (const char *,
1193 extern struct minimal_symbol *lookup_minimal_symbol_by_pc (CORE_ADDR);
1195 extern struct minimal_symbol *lookup_minimal_symbol_by_pc_section (CORE_ADDR,
1199 extern struct minimal_symbol
1200 *lookup_solib_trampoline_symbol_by_pc (CORE_ADDR);
1202 extern CORE_ADDR find_solib_trampoline_target (CORE_ADDR);
1204 extern void init_minimal_symbol_collection (void);
1206 extern struct cleanup *make_cleanup_discard_minimal_symbols (void);
1208 extern void install_minimal_symbols (struct objfile *);
1210 /* Sort all the minimal symbols in OBJFILE. */
1212 extern void msymbols_sort (struct objfile *objfile);
1214 struct symtab_and_line
1216 struct symtab *symtab;
1218 /* Line number. Line numbers start at 1 and proceed through symtab->nlines.
1219 0 is never a valid line number; it is used to indicate that line number
1220 information is not available. */
1227 #define INIT_SAL(sal) { \
1228 (sal)->symtab = 0; \
1229 (sal)->section = 0; \
1235 struct symtabs_and_lines
1237 struct symtab_and_line *sals;
1243 /* Some types and macros needed for exception catchpoints.
1244 Can't put these in target.h because symtab_and_line isn't
1245 known there. This file will be included by breakpoint.c,
1246 hppa-tdep.c, etc. */
1248 /* Enums for exception-handling support */
1249 enum exception_event_kind
1255 /* Type for returning info about an exception */
1256 struct exception_event_record
1258 enum exception_event_kind kind;
1259 struct symtab_and_line throw_sal;
1260 struct symtab_and_line catch_sal;
1261 /* This may need to be extended in the future, if
1262 some platforms allow reporting more information,
1263 such as point of rethrow, type of exception object,
1264 type expected by catch clause, etc. */
1267 #define CURRENT_EXCEPTION_KIND (current_exception_event->kind)
1268 #define CURRENT_EXCEPTION_CATCH_SAL (current_exception_event->catch_sal)
1269 #define CURRENT_EXCEPTION_CATCH_LINE (current_exception_event->catch_sal.line)
1270 #define CURRENT_EXCEPTION_CATCH_FILE (current_exception_event->catch_sal.symtab->filename)
1271 #define CURRENT_EXCEPTION_CATCH_PC (current_exception_event->catch_sal.pc)
1272 #define CURRENT_EXCEPTION_THROW_SAL (current_exception_event->throw_sal)
1273 #define CURRENT_EXCEPTION_THROW_LINE (current_exception_event->throw_sal.line)
1274 #define CURRENT_EXCEPTION_THROW_FILE (current_exception_event->throw_sal.symtab->filename)
1275 #define CURRENT_EXCEPTION_THROW_PC (current_exception_event->throw_sal.pc)
1278 /* Given a pc value, return line number it is in. Second arg nonzero means
1279 if pc is on the boundary use the previous statement's line number. */
1281 extern struct symtab_and_line find_pc_line (CORE_ADDR, int);
1283 /* Same function, but specify a section as well as an address */
1285 extern struct symtab_and_line find_pc_sect_line (CORE_ADDR, asection *, int);
1287 /* Given an address, return the nearest symbol at or below it in memory.
1288 Optionally return the symtab it's from through 2nd arg, and the
1289 address in inferior memory of the symbol through 3rd arg. */
1291 extern struct symbol *find_addr_symbol (CORE_ADDR, struct symtab **,
1294 /* Given a symtab and line number, return the pc there. */
1296 extern int find_line_pc (struct symtab *, int, CORE_ADDR *);
1299 find_line_pc_range (struct symtab_and_line, CORE_ADDR *, CORE_ADDR *);
1301 extern void resolve_sal_pc (struct symtab_and_line *);
1303 /* Given a string, return the line specified by it. For commands like "list"
1304 and "breakpoint". */
1306 extern struct symtabs_and_lines decode_line_spec (char *, int);
1308 extern struct symtabs_and_lines decode_line_spec_1 (char *, int);
1312 void maintenance_print_symbols (char *, int);
1314 void maintenance_print_psymbols (char *, int);
1316 void maintenance_print_msymbols (char *, int);
1318 void maintenance_print_objfiles (char *, int);
1320 void maintenance_check_symtabs (char *, int);
1324 void maintenance_print_statistics (char *, int);
1326 extern void free_symtab (struct symtab *);
1328 /* Symbol-reading stuff in symfile.c and solib.c. */
1330 extern struct symtab *psymtab_to_symtab (struct partial_symtab *);
1332 extern void clear_solib (void);
1336 extern int identify_source_line (struct symtab *, int, int, CORE_ADDR);
1338 extern void print_source_lines (struct symtab *, int, int, int);
1340 extern void forget_cached_source_info (void);
1342 extern void select_source_symtab (struct symtab *);
1344 extern char **make_symbol_completion_list (char *, char *);
1346 extern char **make_file_symbol_completion_list (char *, char *, char *);
1348 extern struct symbol **make_symbol_overload_list (struct symbol *);
1350 extern char **make_source_files_completion_list (char *, char *);
1354 extern struct partial_symtab *find_main_psymtab (void);
1356 extern struct symtab *find_line_symtab (struct symtab *, int, int *, int *);
1358 extern struct symtab_and_line find_function_start_sal (struct symbol *sym, int);
1362 extern struct blockvector *blockvector_for_pc (CORE_ADDR, int *);
1364 extern struct blockvector *blockvector_for_pc_sect (CORE_ADDR, asection *,
1365 int *, struct symtab *);
1369 extern void clear_symtab_users (void);
1371 extern enum language deduce_language_from_filename (char *);
1375 extern int in_prologue (CORE_ADDR pc, CORE_ADDR func_start);
1377 extern struct symbol *fixup_symbol_section (struct symbol *,
1380 extern struct partial_symbol *fixup_psymbol_section (struct partial_symbol
1382 struct objfile *objfile);
1384 /* Symbol searching */
1386 /* When using search_symbols, a list of the following structs is returned.
1387 Callers must free the search list using free_search_symbols! */
1388 struct symbol_search
1390 /* The block in which the match was found. Could be, for example,
1391 STATIC_BLOCK or GLOBAL_BLOCK. */
1394 /* Information describing what was found.
1396 If symtab abd symbol are NOT NULL, then information was found
1398 struct symtab *symtab;
1399 struct symbol *symbol;
1401 /* If msymbol is non-null, then a match was made on something for
1402 which only minimal_symbols exist. */
1403 struct minimal_symbol *msymbol;
1405 /* A link to the next match, or NULL for the end. */
1406 struct symbol_search *next;
1409 extern void search_symbols (char *, namespace_enum, int, char **,
1410 struct symbol_search **);
1411 extern void free_search_symbols (struct symbol_search *);
1412 extern struct cleanup *make_cleanup_free_search_symbols (struct symbol_search *);
1414 /* The name of the ``main'' function.
1415 FIXME: cagney/2001-03-20: Can't make main_name() const since some
1416 of the calling code currently assumes that the string isn't
1418 extern void set_main_name (const char *name);
1419 extern /*const*/ char *main_name (void);
1421 #endif /* !defined(SYMTAB_H) */