1 /* Symbol table definitions for GDB.
2 Copyright 1986, 1989, 1991, 1992, 1993, 1994, 1995, 1996 Free Software Foundation, Inc.
4 This file is part of GDB.
6 This program is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2 of the License, or
9 (at your option) any later version.
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with this program; if not, write to the Free Software
18 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */
20 #if !defined (SYMTAB_H)
23 /* Some definitions and declarations to go with use of obstacks. */
26 #define obstack_chunk_alloc xmalloc
27 #define obstack_chunk_free free
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++ and Java */
91 struct chill_specific /* For Chill */
97 /* Record the source code language that applies to this symbol.
98 This is used to select one of the fields from the language specific
101 enum language language BYTE_BITFIELD;
103 /* Which section is this symbol in? This is an index into
104 section_offsets for this objfile. Negative means that the symbol
105 does not get relocated relative to a section.
106 Disclaimer: currently this is just used for xcoff, so don't
107 expect all symbol-reading code to set it correctly (the ELF code
108 also tries to set it correctly). */
112 /* The bfd section associated with this symbol. */
114 asection *bfd_section;
117 extern CORE_ADDR symbol_overlayed_address PARAMS((CORE_ADDR, asection *));
119 #define SYMBOL_NAME(symbol) (symbol)->ginfo.name
120 #define SYMBOL_VALUE(symbol) (symbol)->ginfo.value.ivalue
121 #define SYMBOL_VALUE_ADDRESS(symbol) (symbol)->ginfo.value.address
122 #define SYMBOL_VALUE_BYTES(symbol) (symbol)->ginfo.value.bytes
123 #define SYMBOL_BLOCK_VALUE(symbol) (symbol)->ginfo.value.block
124 #define SYMBOL_VALUE_CHAIN(symbol) (symbol)->ginfo.value.chain
125 #define SYMBOL_LANGUAGE(symbol) (symbol)->ginfo.language
126 #define SYMBOL_SECTION(symbol) (symbol)->ginfo.section
127 #define SYMBOL_BFD_SECTION(symbol) (symbol)->ginfo.bfd_section
129 #define SYMBOL_CPLUS_DEMANGLED_NAME(symbol) \
130 (symbol)->ginfo.language_specific.cplus_specific.demangled_name
132 /* Macro that initializes the language dependent portion of a symbol
133 depending upon the language for the symbol. */
135 #define SYMBOL_INIT_LANGUAGE_SPECIFIC(symbol,language) \
137 SYMBOL_LANGUAGE (symbol) = language; \
138 if (SYMBOL_LANGUAGE (symbol) == language_cplus \
139 || SYMBOL_LANGUAGE (symbol) == language_java) \
141 SYMBOL_CPLUS_DEMANGLED_NAME (symbol) = NULL; \
143 else if (SYMBOL_LANGUAGE (symbol) == language_chill) \
145 SYMBOL_CHILL_DEMANGLED_NAME (symbol) = NULL; \
149 memset (&(symbol)->ginfo.language_specific, 0, \
150 sizeof ((symbol)->ginfo.language_specific)); \
154 /* Macro that attempts to initialize the demangled name for a symbol,
155 based on the language of that symbol. If the language is set to
156 language_auto, it will attempt to find any demangling algorithm
157 that works and then set the language appropriately. If no demangling
158 of any kind is found, the language is set back to language_unknown,
159 so we can avoid doing this work again the next time we encounter
160 the symbol. Any required space to store the name is obtained from the
161 specified obstack. */
163 #define SYMBOL_INIT_DEMANGLED_NAME(symbol,obstack) \
165 char *demangled = NULL; \
166 if (SYMBOL_LANGUAGE (symbol) == language_cplus \
167 || SYMBOL_LANGUAGE (symbol) == language_auto) \
170 cplus_demangle (SYMBOL_NAME (symbol), DMGL_PARAMS | DMGL_ANSI);\
171 if (demangled != NULL) \
173 SYMBOL_LANGUAGE (symbol) = language_cplus; \
174 SYMBOL_CPLUS_DEMANGLED_NAME (symbol) = \
175 obsavestring (demangled, strlen (demangled), (obstack)); \
180 SYMBOL_CPLUS_DEMANGLED_NAME (symbol) = NULL; \
183 if (SYMBOL_LANGUAGE (symbol) == language_java) \
186 cplus_demangle (SYMBOL_NAME (symbol), \
187 DMGL_PARAMS | DMGL_ANSI | DMGL_JAVA); \
188 if (demangled != NULL) \
190 SYMBOL_LANGUAGE (symbol) = language_java; \
191 SYMBOL_CPLUS_DEMANGLED_NAME (symbol) = \
192 obsavestring (demangled, strlen (demangled), (obstack)); \
197 SYMBOL_CPLUS_DEMANGLED_NAME (symbol) = NULL; \
200 if (demangled == NULL \
201 && (SYMBOL_LANGUAGE (symbol) == language_chill \
202 || SYMBOL_LANGUAGE (symbol) == language_auto)) \
205 chill_demangle (SYMBOL_NAME (symbol)); \
206 if (demangled != NULL) \
208 SYMBOL_LANGUAGE (symbol) = language_chill; \
209 SYMBOL_CHILL_DEMANGLED_NAME (symbol) = \
210 obsavestring (demangled, strlen (demangled), (obstack)); \
215 SYMBOL_CHILL_DEMANGLED_NAME (symbol) = NULL; \
218 if (SYMBOL_LANGUAGE (symbol) == language_auto) \
220 SYMBOL_LANGUAGE (symbol) = language_unknown; \
224 /* Macro that returns the demangled name for a symbol based on the language
225 for that symbol. If no demangled name exists, returns NULL. */
227 #define SYMBOL_DEMANGLED_NAME(symbol) \
228 (SYMBOL_LANGUAGE (symbol) == language_cplus \
229 || SYMBOL_LANGUAGE (symbol) == language_java \
230 ? SYMBOL_CPLUS_DEMANGLED_NAME (symbol) \
231 : (SYMBOL_LANGUAGE (symbol) == language_chill \
232 ? SYMBOL_CHILL_DEMANGLED_NAME (symbol) \
235 #define SYMBOL_CHILL_DEMANGLED_NAME(symbol) \
236 (symbol)->ginfo.language_specific.chill_specific.demangled_name
238 /* Macro that returns the "natural source name" of a symbol. In C++ this is
239 the "demangled" form of the name if demangle is on and the "mangled" form
240 of the name if demangle is off. In other languages this is just the
241 symbol name. The result should never be NULL. */
243 #define SYMBOL_SOURCE_NAME(symbol) \
244 (demangle && SYMBOL_DEMANGLED_NAME (symbol) != NULL \
245 ? SYMBOL_DEMANGLED_NAME (symbol) \
246 : SYMBOL_NAME (symbol))
248 /* Macro that returns the "natural assembly name" of a symbol. In C++ this is
249 the "mangled" form of the name if demangle is off, or if demangle is on and
250 asm_demangle is off. Otherwise if asm_demangle is on it is the "demangled"
251 form. In other languages this is just the symbol name. The result should
254 #define SYMBOL_LINKAGE_NAME(symbol) \
255 (demangle && asm_demangle && SYMBOL_DEMANGLED_NAME (symbol) != NULL \
256 ? SYMBOL_DEMANGLED_NAME (symbol) \
257 : SYMBOL_NAME (symbol))
259 /* Macro that tests a symbol for a match against a specified name string.
260 First test the unencoded name, then looks for and test a C++ encoded
261 name if it exists. Note that whitespace is ignored while attempting to
262 match a C++ encoded name, so that "foo::bar(int,long)" is the same as
263 "foo :: bar (int, long)".
264 Evaluates to zero if the match fails, or nonzero if it succeeds. */
266 #define SYMBOL_MATCHES_NAME(symbol, name) \
267 (STREQ (SYMBOL_NAME (symbol), (name)) \
268 || (SYMBOL_DEMANGLED_NAME (symbol) != NULL \
269 && strcmp_iw (SYMBOL_DEMANGLED_NAME (symbol), (name)) == 0))
271 /* Macro that tests a symbol for an re-match against the last compiled regular
272 expression. First test the unencoded name, then look for and test a C++
273 encoded name if it exists.
274 Evaluates to zero if the match fails, or nonzero if it succeeds. */
276 #define SYMBOL_MATCHES_REGEXP(symbol) \
277 (re_exec (SYMBOL_NAME (symbol)) != 0 \
278 || (SYMBOL_DEMANGLED_NAME (symbol) != NULL \
279 && re_exec (SYMBOL_DEMANGLED_NAME (symbol)) != 0))
281 /* Define a simple structure used to hold some very basic information about
282 all defined global symbols (text, data, bss, abs, etc). The only required
283 information is the general_symbol_info.
285 In many cases, even if a file was compiled with no special options for
286 debugging at all, as long as was not stripped it will contain sufficient
287 information to build a useful minimal symbol table using this structure.
288 Even when a file contains enough debugging information to build a full
289 symbol table, these minimal symbols are still useful for quickly mapping
290 between names and addresses, and vice versa. They are also sometimes
291 used to figure out what full symbol table entries need to be read in. */
293 struct minimal_symbol
296 /* The general symbol info required for all types of symbols.
298 The SYMBOL_VALUE_ADDRESS contains the address that this symbol
301 struct general_symbol_info ginfo;
303 /* The info field is available for caching machine-specific information that
304 The AMD 29000 tdep.c uses it to remember things it has decoded from the
305 instructions in the function header, so it doesn't have to rederive the
306 info constantly (over a serial line). It is initialized to zero and
307 stays that way until target-dependent code sets it. Storage for any data
308 pointed to by this field should be allocated on the symbol_obstack for
309 the associated objfile. The type would be "void *" except for reasons
310 of compatibility with older compilers. This field is optional. */
314 #ifdef SOFUN_ADDRESS_MAYBE_MISSING
315 /* Which source file is this symbol in? Only relevant for mst_file_*. */
319 /* Classification types for this symbol. These should be taken as "advisory
320 only", since if gdb can't easily figure out a classification it simply
321 selects mst_unknown. It may also have to guess when it can't figure out
322 which is a better match between two types (mst_data versus mst_bss) for
323 example. Since the minimal symbol info is sometimes derived from the
324 BFD library's view of a file, we need to live with what information bfd
327 enum minimal_symbol_type
329 mst_unknown = 0, /* Unknown type, the default */
330 mst_text, /* Generally executable instructions */
331 mst_data, /* Generally initialized data */
332 mst_bss, /* Generally uninitialized data */
333 mst_abs, /* Generally absolute (nonrelocatable) */
334 /* GDB uses mst_solib_trampoline for the start address of a shared
335 library trampoline entry. Breakpoints for shared library functions
336 are put there if the shared library is not yet loaded.
337 After the shared library is loaded, lookup_minimal_symbol will
338 prefer the minimal symbol from the shared library (usually
339 a mst_text symbol) over the mst_solib_trampoline symbol, and the
340 breakpoints will be moved to their true address in the shared
341 library via breakpoint_re_set. */
342 mst_solib_trampoline, /* Shared library trampoline code */
343 /* For the mst_file* types, the names are only guaranteed to be unique
344 within a given .o file. */
345 mst_file_text, /* Static version of mst_text */
346 mst_file_data, /* Static version of mst_data */
347 mst_file_bss /* Static version of mst_bss */
348 } type BYTE_BITFIELD;
351 #define MSYMBOL_INFO(msymbol) (msymbol)->info
352 #define MSYMBOL_TYPE(msymbol) (msymbol)->type
355 /* All of the name-scope contours of the program
356 are represented by `struct block' objects.
357 All of these objects are pointed to by the blockvector.
359 Each block represents one name scope.
360 Each lexical context has its own block.
362 The blockvector begins with some special blocks.
363 The GLOBAL_BLOCK contains all the symbols defined in this compilation
364 whose scope is the entire program linked together.
365 The STATIC_BLOCK contains all the symbols whose scope is the
366 entire compilation excluding other separate compilations.
367 Blocks starting with the FIRST_LOCAL_BLOCK are not special.
369 Each block records a range of core addresses for the code that
370 is in the scope of the block. The STATIC_BLOCK and GLOBAL_BLOCK
371 give, for the range of code, the entire range of code produced
372 by the compilation that the symbol segment belongs to.
374 The blocks appear in the blockvector
375 in order of increasing starting-address,
376 and, within that, in order of decreasing ending-address.
378 This implies that within the body of one function
379 the blocks appear in the order of a depth-first tree walk. */
383 /* Number of blocks in the list. */
385 /* The blocks themselves. */
386 struct block *block[1];
389 #define BLOCKVECTOR_NBLOCKS(blocklist) (blocklist)->nblocks
390 #define BLOCKVECTOR_BLOCK(blocklist,n) (blocklist)->block[n]
392 /* Special block numbers */
394 #define GLOBAL_BLOCK 0
395 #define STATIC_BLOCK 1
396 #define FIRST_LOCAL_BLOCK 2
401 /* Addresses in the executable code that are in this block. */
406 /* The symbol that names this block, if the block is the body of a
407 function; otherwise, zero. */
409 struct symbol *function;
411 /* The `struct block' for the containing block, or 0 if none.
413 The superblock of a top-level local block (i.e. a function in the
414 case of C) is the STATIC_BLOCK. The superblock of the
415 STATIC_BLOCK is the GLOBAL_BLOCK. */
417 struct block *superblock;
419 /* Version of GCC used to compile the function corresponding
420 to this block, or 0 if not compiled with GCC. When possible,
421 GCC should be compatible with the native compiler, or if that
422 is not feasible, the differences should be fixed during symbol
423 reading. As of 16 Apr 93, this flag is never used to distinguish
424 between gcc2 and the native compiler.
426 If there is no function corresponding to this block, this meaning
427 of this flag is undefined. */
429 unsigned char gcc_compile_flag;
431 /* Number of local symbols. */
435 /* The symbols. If some of them are arguments, then they must be
436 in the order in which we would like to print them. */
438 struct symbol *sym[1];
441 #define BLOCK_START(bl) (bl)->startaddr
442 #define BLOCK_END(bl) (bl)->endaddr
443 #define BLOCK_NSYMS(bl) (bl)->nsyms
444 #define BLOCK_SYM(bl, n) (bl)->sym[n]
445 #define BLOCK_FUNCTION(bl) (bl)->function
446 #define BLOCK_SUPERBLOCK(bl) (bl)->superblock
447 #define BLOCK_GCC_COMPILED(bl) (bl)->gcc_compile_flag
449 /* Nonzero if symbols of block BL should be sorted alphabetically.
450 Don't sort a block which corresponds to a function. If we did the
451 sorting would have to preserve the order of the symbols for the
454 #define BLOCK_SHOULD_SORT(bl) ((bl)->nsyms >= 40 && BLOCK_FUNCTION (bl) == NULL)
457 /* Represent one symbol name; a variable, constant, function or typedef. */
459 /* Different name spaces for symbols. Looking up a symbol specifies a
460 namespace and ignores symbol definitions in other name spaces. */
464 /* UNDEF_NAMESPACE is used when a namespace has not been discovered or
465 none of the following apply. This usually indicates an error either
466 in the symbol information or in gdb's handling of symbols. */
470 /* VAR_NAMESPACE is the usual namespace. In C, this contains variables,
471 function names, typedef names and enum type values. */
475 /* STRUCT_NAMESPACE is used in C to hold struct, union and enum type names.
476 Thus, if `struct foo' is used in a C program, it produces a symbol named
477 `foo' in the STRUCT_NAMESPACE. */
481 /* LABEL_NAMESPACE may be used for names of labels (for gotos);
482 currently it is not used and labels are not recorded at all. */
487 /* An address-class says where to find the value of a symbol. */
491 /* Not used; catches errors */
495 /* Value is constant int SYMBOL_VALUE, host byteorder */
499 /* Value is at fixed address SYMBOL_VALUE_ADDRESS */
503 /* Value is in register. SYMBOL_VALUE is the register number. */
507 /* It's an argument; the value is at SYMBOL_VALUE offset in arglist. */
511 /* Value address is at SYMBOL_VALUE offset in arglist. */
515 /* Value is in register number SYMBOL_VALUE. Just like LOC_REGISTER
516 except this is an argument. Probably the cleaner way to handle
517 this would be to separate address_class (which would include
518 separate ARG and LOCAL to deal with FRAME_ARGS_ADDRESS versus
519 FRAME_LOCALS_ADDRESS), and an is_argument flag.
521 For some symbol formats (stabs, for some compilers at least),
522 the compiler generates two symbols, an argument and a register.
523 In some cases we combine them to a single LOC_REGPARM in symbol
524 reading, but currently not for all cases (e.g. it's passed on the
525 stack and then loaded into a register). */
529 /* Value is in specified register. Just like LOC_REGPARM except the
530 register holds the address of the argument instead of the argument
531 itself. This is currently used for the passing of structs and unions
532 on sparc and hppa. It is also used for call by reference where the
533 address is in a register, at least by mipsread.c. */
537 /* Value is a local variable at SYMBOL_VALUE offset in stack frame. */
541 /* Value not used; definition in SYMBOL_TYPE. Symbols in the namespace
542 STRUCT_NAMESPACE all have this class. */
546 /* Value is address SYMBOL_VALUE_ADDRESS in the code */
550 /* In a symbol table, value is SYMBOL_BLOCK_VALUE of a `struct block'.
551 In a partial symbol table, SYMBOL_VALUE_ADDRESS is the start address
552 of the block. Function names have this class. */
556 /* Value is a constant byte-sequence pointed to by SYMBOL_VALUE_BYTES, in
557 target byte order. */
561 /* Value is arg at SYMBOL_VALUE offset in stack frame. Differs from
562 LOC_LOCAL in that symbol is an argument; differs from LOC_ARG in
563 that we find it in the frame (FRAME_LOCALS_ADDRESS), not in the
564 arglist (FRAME_ARGS_ADDRESS). Added for i960, which passes args
565 in regs then copies to frame. */
569 /* Value is at SYMBOL_VALUE offset from the current value of
570 register number SYMBOL_BASEREG. This exists mainly for the same
571 things that LOC_LOCAL and LOC_ARG do; but we need to do this
572 instead because on 88k DWARF gives us the offset from the
573 frame/stack pointer, rather than the offset from the "canonical
574 frame address" used by COFF, stabs, etc., and we don't know how
575 to convert between these until we start examining prologues.
577 Note that LOC_BASEREG is much less general than a DWARF expression.
578 We don't need the generality (at least not yet), and storing a general
579 DWARF expression would presumably take up more space than the existing
584 /* Same as LOC_BASEREG but it is an argument. */
588 /* Value is at fixed address, but the address of the variable has
589 to be determined from the minimal symbol table whenever the
590 variable is referenced.
591 This happens if debugging information for a global symbol is
592 emitted and the corresponding minimal symbol is defined
593 in another object file or runtime common storage.
594 The linker might even remove the minimal symbol if the global
595 symbol is never referenced, in which case the symbol remains
600 /* The variable does not actually exist in the program.
601 The value is ignored. */
606 /* Linked list of symbol's live ranges. */
612 struct live_range *next;
618 /* The general symbol info required for all types of symbols. */
620 struct general_symbol_info ginfo;
622 /* Data type of value */
626 /* Name space code. */
629 /* FIXME: don't conflict with C++'s namespace */
630 /* would be safer to do a global change for all namespace identifiers. */
631 #define namespace _namespace
633 namespace_enum namespace BYTE_BITFIELD;
637 enum address_class aclass BYTE_BITFIELD;
639 /* Line number of definition. FIXME: Should we really make the assumption
640 that nobody will try to debug files longer than 64K lines? What about
641 machine generated programs? */
645 /* Some symbols require an additional value to be recorded on a per-
646 symbol basis. Stash those values here. */
650 /* Used by LOC_BASEREG and LOC_BASEREG_ARG. */
655 /* Live range information (if present) for debugging of optimized code.
656 Gcc extensions were added to stabs to encode live range information.
657 The syntax for referencing (defining) symbol aliases is "#n" ("#n=")
658 where n is a number. The syntax for specifying a range is "l(#<m>,#<n>)",
659 where m and n are numbers.
660 aliases - list of other symbols which are lexically the same symbol,
661 but were optimized into different storage classes (eg. for the
662 local symbol "x", one symbol contains range information where x
663 is on the stack, while an alias contains the live ranges where x
665 range - list of instruction ranges where the symbol is live. */
666 struct live_range_info
668 struct symbol *aliases; /* Link to other aliases for this symbol. */
669 struct live_range *range; /* Linked list of live ranges. */
673 #define SYMBOL_NAMESPACE(symbol) (symbol)->namespace
674 #define SYMBOL_CLASS(symbol) (symbol)->aclass
675 #define SYMBOL_TYPE(symbol) (symbol)->type
676 #define SYMBOL_LINE(symbol) (symbol)->line
677 #define SYMBOL_BASEREG(symbol) (symbol)->aux_value.basereg
678 #define SYMBOL_ALIASES(symbol) (symbol)->live.aliases
679 #define SYMBOL_RANGE(symbol) (symbol)->live.range
680 #define SYMBOL_RANGE_START(symbol) (symbol)->live.range->start
681 #define SYMBOL_RANGE_END(symbol) (symbol)->live.range->end
682 #define SYMBOL_RANGE_NEXT(symbol) (symbol)->live.range->next
684 /* A partial_symbol records the name, namespace, and address class of
685 symbols whose types we have not parsed yet. For functions, it also
686 contains their memory address, so we can find them from a PC value.
687 Each partial_symbol sits in a partial_symtab, all of which are chained
688 on a partial symtab list and which points to the corresponding
689 normal symtab once the partial_symtab has been referenced. */
691 struct partial_symbol
694 /* The general symbol info required for all types of symbols. */
696 struct general_symbol_info ginfo;
698 /* Name space code. */
700 namespace_enum namespace BYTE_BITFIELD;
702 /* Address class (for info_symbols) */
704 enum address_class aclass BYTE_BITFIELD;
708 #define PSYMBOL_NAMESPACE(psymbol) (psymbol)->namespace
709 #define PSYMBOL_CLASS(psymbol) (psymbol)->aclass
712 /* Source-file information. This describes the relation between source files,
713 ine numbers and addresses in the program text. */
717 int length; /* Number of source files described */
718 struct source *source[1]; /* Descriptions of the files */
721 /* Each item represents a line-->pc (or the reverse) mapping. This is
722 somewhat more wasteful of space than one might wish, but since only
723 the files which are actually debugged are read in to core, we don't
726 struct linetable_entry
732 /* The order of entries in the linetable is significant. They should
733 be sorted by increasing values of the pc field. If there is more than
734 one entry for a given pc, then I'm not sure what should happen (and
735 I not sure whether we currently handle it the best way).
737 Example: a C for statement generally looks like this
739 10 0x100 - for the init/test part of a for stmt.
742 10 0x400 - for the increment part of a for stmt.
750 /* Actually NITEMS elements. If you don't like this use of the
751 `struct hack', you can shove it up your ANSI (seriously, if the
752 committee tells us how to do it, we can probably go along). */
753 struct linetable_entry item[1];
756 /* All the information on one source file. */
760 char *name; /* Name of file */
761 struct linetable contents;
764 /* How to relocate the symbols from each section in a symbol file.
765 Each struct contains an array of offsets.
766 The ordering and meaning of the offsets is file-type-dependent;
767 typically it is indexed by section numbers or symbol types or
770 To give us flexibility in changing the internal representation
771 of these offsets, the ANOFFSET macro must be used to insert and
772 extract offset values in the struct. */
774 struct section_offsets
776 CORE_ADDR offsets[1]; /* As many as needed. */
779 #define ANOFFSET(secoff, whichone) (secoff->offsets[whichone])
781 /* The maximum possible size of a section_offsets table. */
783 #define SIZEOF_SECTION_OFFSETS \
784 (sizeof (struct section_offsets) \
785 + sizeof (((struct section_offsets *) 0)->offsets) * (SECT_OFF_MAX-1))
788 /* Each source file or header is represented by a struct symtab.
789 These objects are chained through the `next' field. */
794 /* Chain of all existing symtabs. */
798 /* List of all symbol scope blocks for this symtab. May be shared
799 between different symtabs (and normally is for all the symtabs
800 in a given compilation unit). */
802 struct blockvector *blockvector;
804 /* Table mapping core addresses to line numbers for this file.
805 Can be NULL if none. Never shared between different symtabs. */
807 struct linetable *linetable;
809 /* Section in objfile->section_offsets for the blockvector and
810 the linetable. Probably always SECT_OFF_TEXT. */
812 int block_line_section;
814 /* If several symtabs share a blockvector, exactly one of them
815 should be designed the primary, so that the blockvector
816 is relocated exactly once by objfile_relocate. */
820 /* Name of this source file. */
824 /* Directory in which it was compiled, or NULL if we don't know. */
828 /* This component says how to free the data we point to:
829 free_contents => do a tree walk and free each object.
830 free_nothing => do nothing; some other symtab will free
831 the data this one uses.
832 free_linetable => free just the linetable. FIXME: Is this redundant
833 with the primary field? */
837 free_nothing, free_contents, free_linetable
841 /* Pointer to one block of storage to be freed, if nonzero. */
842 /* This is IN ADDITION to the action indicated by free_code. */
846 /* Total number of lines found in source file. */
850 /* line_charpos[N] is the position of the (N-1)th line of the
851 source file. "position" means something we can lseek() to; it
852 is not guaranteed to be useful any other way. */
856 /* Language of this source file. */
858 enum language language;
860 /* String that identifies the format of the debugging information, such
861 as "stabs", "dwarf 1", "dwarf 2", "coff", etc. This is mostly useful
862 for automated testing of gdb but may also be information that is
863 useful to the user. */
867 /* String of version information. May be zero. */
871 /* Full name of file as found by searching the source path.
872 NULL if not yet known. */
876 /* Object file from which this symbol information was read. */
878 struct objfile *objfile;
880 /* Anything extra for this symtab. This is for target machines
881 with special debugging info of some sort (which cannot just
882 be represented in a normal symtab). */
884 #if defined (EXTRA_SYMTAB_INFO)
890 #define BLOCKVECTOR(symtab) (symtab)->blockvector
891 #define LINETABLE(symtab) (symtab)->linetable
894 /* Each source file that has not been fully read in is represented by
895 a partial_symtab. This contains the information on where in the
896 executable the debugging symbols for a specific file are, and a
897 list of names of global symbols which are located in this file.
898 They are all chained on partial symtab lists.
900 Even after the source file has been read into a symtab, the
901 partial_symtab remains around. They are allocated on an obstack,
902 psymbol_obstack. FIXME, this is bad for dynamic linking or VxWorks-
903 style execution of a bunch of .o's. */
905 struct partial_symtab
908 /* Chain of all existing partial symtabs. */
910 struct partial_symtab *next;
912 /* Name of the source file which this partial_symtab defines */
916 /* Information about the object file from which symbols should be read. */
918 struct objfile *objfile;
920 /* Set of relocation offsets to apply to each section. */
922 struct section_offsets *section_offsets;
924 /* Range of text addresses covered by this file; texthigh is the
925 beginning of the next section. */
930 /* Array of pointers to all of the partial_symtab's which this one
931 depends on. Since this array can only be set to previous or
932 the current (?) psymtab, this dependency tree is guaranteed not
933 to have any loops. "depends on" means that symbols must be read
934 for the dependencies before being read for this psymtab; this is
935 for type references in stabs, where if foo.c includes foo.h, declarations
936 in foo.h may use type numbers defined in foo.c. For other debugging
937 formats there may be no need to use dependencies. */
939 struct partial_symtab **dependencies;
941 int number_of_dependencies;
943 /* Global symbol list. This list will be sorted after readin to
944 improve access. Binary search will be the usual method of
945 finding a symbol within it. globals_offset is an integer offset
946 within global_psymbols[]. */
951 /* Static symbol list. This list will *not* be sorted after readin;
952 to find a symbol in it, exhaustive search must be used. This is
953 reasonable because searches through this list will eventually
954 lead to either the read in of a files symbols for real (assumed
955 to take a *lot* of time; check) or an error (and we don't care
956 how long errors take). This is an offset and size within
957 static_psymbols[]. */
962 /* Pointer to symtab eventually allocated for this source file, 0 if
963 !readin or if we haven't looked for the symtab after it was readin. */
965 struct symtab *symtab;
967 /* Pointer to function which will read in the symtab corresponding to
970 void (*read_symtab) PARAMS ((struct partial_symtab *));
972 /* Information that lets read_symtab() locate the part of the symbol table
973 that this psymtab corresponds to. This information is private to the
974 format-dependent symbol reading routines. For further detail examine
975 the various symbol reading modules. Should really be (void *) but is
976 (char *) as with other such gdb variables. (FIXME) */
978 char *read_symtab_private;
980 /* Non-zero if the symtab corresponding to this psymtab has been readin */
982 unsigned char readin;
985 /* A fast way to get from a psymtab to its symtab (after the first time). */
986 #define PSYMTAB_TO_SYMTAB(pst) \
987 ((pst) -> symtab != NULL ? (pst) -> symtab : psymtab_to_symtab (pst))
990 /* The virtual function table is now an array of structures which have the
991 form { int16 offset, delta; void *pfn; }.
993 In normal virtual function tables, OFFSET is unused.
994 DELTA is the amount which is added to the apparent object's base
995 address in order to point to the actual object to which the
996 virtual function should be applied.
997 PFN is a pointer to the virtual function.
999 Note that this macro is g++ specific (FIXME). */
1001 #define VTBL_FNADDR_OFFSET 2
1003 /* Macro that yields non-zero value iff NAME is the prefix for C++ operator
1004 names. If you leave out the parenthesis here you will lose!
1005 Currently 'o' 'p' CPLUS_MARKER is used for both the symbol in the
1006 symbol-file and the names in gdb's symbol table.
1007 Note that this macro is g++ specific (FIXME). */
1009 #define OPNAME_PREFIX_P(NAME) \
1010 ((NAME)[0] == 'o' && (NAME)[1] == 'p' && is_cplus_marker ((NAME)[2]))
1012 /* Macro that yields non-zero value iff NAME is the prefix for C++ vtbl
1013 names. Note that this macro is g++ specific (FIXME).
1014 '_vt$' is the old cfront-style vtables; '_VT$' is the new
1015 style, using thunks (where '$' is really CPLUS_MARKER). */
1017 #define VTBL_PREFIX_P(NAME) \
1019 && (((NAME)[1] == 'V' && (NAME)[2] == 'T') \
1020 || ((NAME)[1] == 'v' && (NAME)[2] == 't')) \
1021 && is_cplus_marker ((NAME)[3]))
1023 /* Macro that yields non-zero value iff NAME is the prefix for C++ destructor
1024 names. Note that this macro is g++ specific (FIXME). */
1026 #define DESTRUCTOR_PREFIX_P(NAME) \
1027 ((NAME)[0] == '_' && is_cplus_marker ((NAME)[1]) && (NAME)[2] == '_')
1030 /* External variables and functions for the objects described above. */
1032 /* This symtab variable specifies the current file for printing source lines */
1034 extern struct symtab *current_source_symtab;
1036 /* This is the next line to print for listing source lines. */
1038 extern int current_source_line;
1040 /* See the comment in symfile.c about how current_objfile is used. */
1042 extern struct objfile *current_objfile;
1044 /* True if we are nested inside psymtab_to_symtab. */
1046 extern int currently_reading_symtab;
1049 extern int demangle;
1050 extern int asm_demangle;
1052 /* symtab.c lookup functions */
1054 /* lookup a symbol table by source file name */
1056 extern struct symtab *
1057 lookup_symtab PARAMS ((char *));
1059 /* lookup a symbol by name (optional block, optional symtab) */
1061 extern struct symbol *
1062 lookup_symbol PARAMS ((const char *, const struct block *,
1063 const namespace_enum, int *, struct symtab **));
1065 /* lookup a symbol by name, within a specified block */
1067 extern struct symbol *
1068 lookup_block_symbol PARAMS ((const struct block *, const char *,
1069 const namespace_enum));
1071 /* lookup a [struct, union, enum] by name, within a specified block */
1073 extern struct type *
1074 lookup_struct PARAMS ((char *, struct block *));
1076 extern struct type *
1077 lookup_union PARAMS ((char *, struct block *));
1079 extern struct type *
1080 lookup_enum PARAMS ((char *, struct block *));
1082 /* lookup the function corresponding to the block */
1084 extern struct symbol *
1085 block_function PARAMS ((struct block *));
1087 /* from blockframe.c: */
1089 /* lookup the function symbol corresponding to the address */
1091 extern struct symbol *
1092 find_pc_function PARAMS ((CORE_ADDR));
1094 /* lookup the function corresponding to the address and section */
1096 extern struct symbol *
1097 find_pc_sect_function PARAMS ((CORE_ADDR, asection *));
1099 /* lookup function from address, return name, start addr and end addr */
1101 extern int find_pc_partial_function PARAMS ((CORE_ADDR, char **,
1102 CORE_ADDR *, CORE_ADDR *));
1105 clear_pc_function_cache PARAMS ((void));
1107 /* from symtab.c: */
1109 /* lookup partial symbol table by filename */
1111 extern struct partial_symtab *
1112 lookup_partial_symtab PARAMS ((char *));
1114 /* lookup partial symbol table by address */
1116 extern struct partial_symtab *
1117 find_pc_psymtab PARAMS ((CORE_ADDR));
1119 /* lookup partial symbol table by address and section */
1121 extern struct partial_symtab *
1122 find_pc_sect_psymtab PARAMS ((CORE_ADDR, asection *));
1124 /* lookup full symbol table by address */
1126 extern struct symtab *
1127 find_pc_symtab PARAMS ((CORE_ADDR));
1129 /* lookup full symbol table by address and section */
1131 extern struct symtab *
1132 find_pc_sect_symtab PARAMS ((CORE_ADDR, asection *));
1134 /* lookup partial symbol by address */
1136 extern struct partial_symbol *
1137 find_pc_psymbol PARAMS ((struct partial_symtab *, CORE_ADDR));
1139 /* lookup partial symbol by address and section */
1141 extern struct partial_symbol *
1142 find_pc_sect_psymbol PARAMS ((struct partial_symtab *, CORE_ADDR, asection *));
1145 find_pc_line_pc_range PARAMS ((CORE_ADDR, CORE_ADDR *, CORE_ADDR *));
1148 contained_in PARAMS ((struct block *, struct block *));
1151 reread_symbols PARAMS ((void));
1153 /* Macro for name of symbol to indicate a file compiled with gcc. */
1154 #ifndef GCC_COMPILED_FLAG_SYMBOL
1155 #define GCC_COMPILED_FLAG_SYMBOL "gcc_compiled."
1158 /* Macro for name of symbol to indicate a file compiled with gcc2. */
1159 #ifndef GCC2_COMPILED_FLAG_SYMBOL
1160 #define GCC2_COMPILED_FLAG_SYMBOL "gcc2_compiled."
1163 /* Functions for dealing with the minimal symbol table, really a misc
1164 address<->symbol mapping for things we don't have debug symbols for. */
1166 extern void prim_record_minimal_symbol PARAMS ((const char *, CORE_ADDR,
1167 enum minimal_symbol_type,
1170 extern struct minimal_symbol *prim_record_minimal_symbol_and_info
1171 PARAMS ((const char *, CORE_ADDR,
1172 enum minimal_symbol_type,
1173 char *info, int section,
1174 asection *bfd_section,
1177 #ifdef SOFUN_ADDRESS_MAYBE_MISSING
1178 extern CORE_ADDR find_stab_function_addr PARAMS ((char *,
1179 struct partial_symtab *,
1183 extern struct minimal_symbol *
1184 lookup_minimal_symbol PARAMS ((const char *, const char *, struct objfile *));
1186 extern struct minimal_symbol *
1187 lookup_minimal_symbol_text PARAMS ((const char *, const char *, struct objfile *));
1189 struct minimal_symbol *
1190 lookup_minimal_symbol_solib_trampoline PARAMS ((const char *,
1194 extern struct minimal_symbol *
1195 lookup_minimal_symbol_by_pc PARAMS ((CORE_ADDR));
1197 extern struct minimal_symbol *
1198 lookup_minimal_symbol_by_pc_section PARAMS ((CORE_ADDR, asection *));
1200 extern struct minimal_symbol *
1201 lookup_solib_trampoline_symbol_by_pc PARAMS ((CORE_ADDR));
1204 find_solib_trampoline_target PARAMS ((CORE_ADDR));
1207 init_minimal_symbol_collection PARAMS ((void));
1210 discard_minimal_symbols PARAMS ((int));
1213 install_minimal_symbols PARAMS ((struct objfile *));
1215 /* Sort all the minimal symbols in OBJFILE. */
1217 extern void msymbols_sort PARAMS ((struct objfile *objfile));
1219 struct symtab_and_line
1221 struct symtab *symtab;
1223 /* Line number. Line numbers start at 1 and proceed through symtab->nlines.
1224 0 is never a valid line number; it is used to indicate that line number
1225 information is not available. */
1232 #define INIT_SAL(sal) { \
1233 (sal)->symtab = 0; \
1234 (sal)->section = 0; \
1240 struct symtabs_and_lines
1242 struct symtab_and_line *sals;
1246 /* Given a pc value, return line number it is in. Second arg nonzero means
1247 if pc is on the boundary use the previous statement's line number. */
1249 extern struct symtab_and_line
1250 find_pc_line PARAMS ((CORE_ADDR, int));
1252 /* Same function, but specify a section as well as an address */
1254 extern struct symtab_and_line
1255 find_pc_sect_line PARAMS ((CORE_ADDR, asection *, int));
1257 /* Given an address, return the nearest symbol at or below it in memory.
1258 Optionally return the symtab it's from through 2nd arg, and the
1259 address in inferior memory of the symbol through 3rd arg. */
1261 extern struct symbol *
1262 find_addr_symbol PARAMS ((CORE_ADDR, struct symtab **, CORE_ADDR *));
1264 /* Given a symtab and line number, return the pc there. */
1267 find_line_pc PARAMS ((struct symtab *, int));
1270 find_line_pc_range PARAMS ((struct symtab_and_line,
1271 CORE_ADDR *, CORE_ADDR *));
1274 resolve_sal_pc PARAMS ((struct symtab_and_line *));
1276 /* Given a string, return the line specified by it. For commands like "list"
1277 and "breakpoint". */
1279 extern struct symtabs_and_lines
1280 decode_line_spec PARAMS ((char *, int));
1282 extern struct symtabs_and_lines
1283 decode_line_spec_1 PARAMS ((char *, int));
1285 extern struct symtabs_and_lines
1286 decode_line_1 PARAMS ((char **, int, struct symtab *, int, char ***));
1288 #if MAINTENANCE_CMDS
1293 maintenance_print_symbols PARAMS ((char *, int));
1296 maintenance_print_psymbols PARAMS ((char *, int));
1299 maintenance_print_msymbols PARAMS ((char *, int));
1302 maintenance_print_objfiles PARAMS ((char *, int));
1305 maintenance_check_symtabs PARAMS ((char *, int));
1310 maintenance_print_statistics PARAMS ((char *, int));
1315 free_symtab PARAMS ((struct symtab *));
1317 /* Symbol-reading stuff in symfile.c and solib.c. */
1319 extern struct symtab *
1320 psymtab_to_symtab PARAMS ((struct partial_symtab *));
1323 clear_solib PARAMS ((void));
1325 extern struct objfile *
1326 symbol_file_add PARAMS ((char *, int, CORE_ADDR, int, int, int));
1331 identify_source_line PARAMS ((struct symtab *, int, int, CORE_ADDR));
1334 print_source_lines PARAMS ((struct symtab *, int, int, int));
1337 forget_cached_source_info PARAMS ((void));
1340 select_source_symtab PARAMS ((struct symtab *));
1342 extern char **make_symbol_completion_list PARAMS ((char *, char *));
1346 extern struct partial_symtab *
1347 find_main_psymtab PARAMS ((void));
1351 extern struct blockvector *
1352 blockvector_for_pc PARAMS ((CORE_ADDR, int *));
1355 extern struct blockvector *
1356 blockvector_for_pc_sect PARAMS ((CORE_ADDR, asection *, int *,
1361 clear_symtab_users PARAMS ((void));
1363 extern enum language
1364 deduce_language_from_filename PARAMS ((char *));
1369 in_prologue PARAMS ((CORE_ADDR pc, CORE_ADDR func_start));
1371 extern struct symbol *
1372 fixup_symbol_section PARAMS ((struct symbol *, struct objfile *));
1374 #endif /* !defined(SYMTAB_H) */