1 /* Symbol table definitions for GDB.
2 Copyright (C) 1986, 1989, 1991, 1992 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., 675 Mass Ave, Cambridge, MA 02139, 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
29 /* Define a structure for the information that is common to all symbol types,
30 including minimal symbols, partial symbols, and full symbols. In a
31 multilanguage environment, some language specific information may need to
32 be recorded along with each symbol. */
34 struct general_symbol_info
36 /* Name of the symbol. This is a required field. Storage for the name is
37 allocated on the psymbol_obstack or symbol_obstack for the associated
42 /* Value of the symbol. Which member of this union to use, and what
43 it means, depends on what kind of symbol this is and its
44 SYMBOL_CLASS. See comments there for more details. All of these
45 are in host byte order (though what they point to might be in
46 target byte order, e.g. LOC_CONST_BYTES). */
58 /* for opaque typedef struct chain */
64 /* Record the source code language that applies to this symbol.
65 This is used to select one of the fields from the language specific
68 enum language language
;
70 /* Since one and only one language can apply, wrap the language specific
71 information inside a union. */
75 struct cplus_specific
/* For C++ */
79 struct chill_specific
/* For Chill */
85 /* Which section is this symbol in? This is an index into
86 section_offsets for this objfile. Negative means that the symbol
87 does not get relocated relative to a section.
88 Disclaimer: currently this is just used for xcoff, so don't expect
89 all symbol-reading code to set it correctly. */
94 #define SYMBOL_NAME(symbol) (symbol)->ginfo.name
95 #define SYMBOL_VALUE(symbol) (symbol)->ginfo.value.value
96 #define SYMBOL_VALUE_ADDRESS(symbol) (symbol)->ginfo.value.address
97 #define SYMBOL_VALUE_BYTES(symbol) (symbol)->ginfo.value.bytes
98 #define SYMBOL_BLOCK_VALUE(symbol) (symbol)->ginfo.value.block
99 #define SYMBOL_VALUE_CHAIN(symbol) (symbol)->ginfo.value.chain
100 #define SYMBOL_LANGUAGE(symbol) (symbol)->ginfo.language
101 #define SYMBOL_SECTION(symbol) (symbol)->ginfo.section
103 #define SYMBOL_CPLUS_DEMANGLED_NAME(symbol) \
104 (symbol)->ginfo.language_specific.cplus_specific.demangled_name
107 extern int demangle
; /* We reference it, so go ahead and declare it. */
109 /* Macro that initializes the language dependent portion of a symbol
110 depending upon the language for the symbol. */
112 #define SYMBOL_INIT_LANGUAGE_SPECIFIC(symbol,language) \
114 SYMBOL_LANGUAGE (symbol) = language; \
115 if (SYMBOL_LANGUAGE (symbol) == language_cplus) \
117 SYMBOL_CPLUS_DEMANGLED_NAME (symbol) = NULL; \
119 else if (SYMBOL_LANGUAGE (symbol) == language_chill) \
121 SYMBOL_CHILL_DEMANGLED_NAME (symbol) = NULL; \
125 memset (&(symbol)->ginfo.language_specific, 0, \
126 sizeof ((symbol)->ginfo.language_specific)); \
130 /* Macro that attempts to initialize the demangled name for a symbol,
131 based on the language of that symbol. If the language is set to
132 language_auto, it will attempt to find any demangling algorithm
133 that works and then set the language appropriately. If no demangling
134 of any kind is found, the language is set back to language_unknown,
135 so we can avoid doing this work again the next time we encounter
136 the symbol. Any required space to store the name is obtained from the
137 specified obstack. */
139 #define SYMBOL_INIT_DEMANGLED_NAME(symbol,obstack) \
141 char *demangled = NULL; \
142 if (SYMBOL_LANGUAGE (symbol) == language_cplus \
143 || SYMBOL_LANGUAGE (symbol) == language_auto) \
146 cplus_demangle (SYMBOL_NAME (symbol), DMGL_PARAMS | DMGL_ANSI);\
147 if (demangled != NULL) \
149 SYMBOL_LANGUAGE (symbol) = language_cplus; \
150 SYMBOL_CPLUS_DEMANGLED_NAME (symbol) = \
151 obsavestring (demangled, strlen (demangled), (obstack)); \
156 SYMBOL_CPLUS_DEMANGLED_NAME (symbol) = NULL; \
159 if (demangled == NULL \
160 && (SYMBOL_LANGUAGE (symbol) == language_chill \
161 || SYMBOL_LANGUAGE (symbol) == language_auto)) \
164 chill_demangle (SYMBOL_NAME (symbol)); \
165 if (demangled != NULL) \
167 SYMBOL_LANGUAGE (symbol) = language_chill; \
168 SYMBOL_CHILL_DEMANGLED_NAME (symbol) = \
169 obsavestring (demangled, strlen (demangled), (obstack)); \
174 SYMBOL_CHILL_DEMANGLED_NAME (symbol) = NULL; \
177 if (SYMBOL_LANGUAGE (symbol) == language_auto) \
179 SYMBOL_LANGUAGE (symbol) = language_unknown; \
183 /* Macro that returns the demangled name for a symbol based on the language
184 for that symbol. If no demangled name exists, returns NULL. */
186 #define SYMBOL_DEMANGLED_NAME(symbol) \
187 (SYMBOL_LANGUAGE (symbol) == language_cplus \
188 ? SYMBOL_CPLUS_DEMANGLED_NAME (symbol) \
189 : (SYMBOL_LANGUAGE (symbol) == language_chill \
190 ? SYMBOL_CHILL_DEMANGLED_NAME (symbol) \
193 #define SYMBOL_CHILL_DEMANGLED_NAME(symbol) \
194 (symbol)->ginfo.language_specific.chill_specific.demangled_name
196 /* Macro that returns the "natural source name" of a symbol. In C++ this is
197 the "demangled" form of the name if demangle is on and the "mangled" form
198 of the name if demangle is off. In other languages this is just the
199 symbol name. The result should never be NULL. */
201 #define SYMBOL_SOURCE_NAME(symbol) \
202 (demangle && SYMBOL_DEMANGLED_NAME (symbol) != NULL \
203 ? SYMBOL_DEMANGLED_NAME (symbol) \
204 : SYMBOL_NAME (symbol))
206 /* Macro that returns the "natural assembly name" of a symbol. In C++ this is
207 the "mangled" form of the name if demangle is off, or if demangle is on and
208 asm_demangle is off. Otherwise if asm_demangle is on it is the "demangled"
209 form. In other languages this is just the symbol name. The result should
212 #define SYMBOL_LINKAGE_NAME(symbol) \
213 (demangle && asm_demangle && SYMBOL_DEMANGLED_NAME (symbol) != NULL \
214 ? SYMBOL_DEMANGLED_NAME (symbol) \
215 : SYMBOL_NAME (symbol))
219 extern int asm_demangle
;
221 /* Macro that tests a symbol for a match against a specified name string.
222 First test the unencoded name, then looks for and test a C++ encoded
223 name if it exists. Note that whitespace is ignored while attempting to
224 match a C++ encoded name, so that "foo::bar(int,long)" is the same as
225 "foo :: bar (int, long)".
226 Evaluates to zero if the match fails, or nonzero if it succeeds. */
228 #define SYMBOL_MATCHES_NAME(symbol, name) \
229 (STREQ (SYMBOL_NAME (symbol), (name)) \
230 || (SYMBOL_DEMANGLED_NAME (symbol) != NULL \
231 && strcmp_iw (SYMBOL_DEMANGLED_NAME (symbol), (name)) == 0))
233 /* Macro that tests a symbol for an re-match against the last compiled regular
234 expression. First test the unencoded name, then look for and test a C++
235 encoded name if it exists.
236 Evaluates to zero if the match fails, or nonzero if it succeeds. */
238 #define SYMBOL_MATCHES_REGEXP(symbol) \
239 (re_exec (SYMBOL_NAME (symbol)) != 0 \
240 || (SYMBOL_DEMANGLED_NAME (symbol) != NULL \
241 && re_exec (SYMBOL_DEMANGLED_NAME (symbol)) != 0))
243 /* Define a simple structure used to hold some very basic information about
244 all defined global symbols (text, data, bss, abs, etc). The only required
245 information is the general_symbol_info.
247 In many cases, even if a file was compiled with no special options for
248 debugging at all, as long as was not stripped it will contain sufficient
249 information to build a useful minimal symbol table using this structure.
250 Even when a file contains enough debugging information to build a full
251 symbol table, these minimal symbols are still useful for quickly mapping
252 between names and addresses, and vice versa. They are also sometimes
253 used to figure out what full symbol table entries need to be read in. */
255 struct minimal_symbol
258 /* The general symbol info required for all types of symbols.
260 The SYMBOL_VALUE_ADDRESS contains the address that this symbol
263 struct general_symbol_info ginfo
;
265 /* The info field is available for caching machine-specific information that
266 The AMD 29000 tdep.c uses it to remember things it has decoded from the
267 instructions in the function header, so it doesn't have to rederive the
268 info constantly (over a serial line). It is initialized to zero and
269 stays that way until target-dependent code sets it. Storage for any data
270 pointed to by this field should be allocated on the symbol_obstack for
271 the associated objfile. The type would be "void *" except for reasons
272 of compatibility with older compilers. This field is optional. */
276 /* Classification types for this symbol. These should be taken as "advisory
277 only", since if gdb can't easily figure out a classification it simply
278 selects mst_unknown. It may also have to guess when it can't figure out
279 which is a better match between two types (mst_data versus mst_bss) for
280 example. Since the minimal symbol info is sometimes derived from the
281 BFD library's view of a file, we need to live with what information bfd
284 enum minimal_symbol_type
286 mst_unknown
= 0, /* Unknown type, the default */
287 mst_text
, /* Generally executable instructions */
288 mst_data
, /* Generally initialized data */
289 mst_bss
, /* Generally uninitialized data */
290 mst_abs
, /* Generally absolute (nonrelocatable) */
291 /* For the mst_file* types, the names are only guaranteed to be unique
292 within a given .o file. */
293 mst_file_text
, /* Static version of mst_text */
294 mst_file_data
, /* Static version of mst_data */
295 mst_file_bss
/* Static version of mst_bss */
300 #define MSYMBOL_INFO(msymbol) (msymbol)->info
301 #define MSYMBOL_TYPE(msymbol) (msymbol)->type
304 /* All of the name-scope contours of the program
305 are represented by `struct block' objects.
306 All of these objects are pointed to by the blockvector.
308 Each block represents one name scope.
309 Each lexical context has its own block.
311 The blockvector begins with some special blocks.
312 The GLOBAL_BLOCK contains all the symbols defined in this compilation
313 whose scope is the entire program linked together.
314 The STATIC_BLOCK contains all the symbols whose scope is the
315 entire compilation excluding other separate compilations.
316 Blocks starting with the FIRST_LOCAL_BLOCK are not special.
318 Each block records a range of core addresses for the code that
319 is in the scope of the block. The STATIC_BLOCK and GLOBAL_BLOCK
320 give, for the range of code, the entire range of code produced
321 by the compilation that the symbol segment belongs to.
323 The blocks appear in the blockvector
324 in order of increasing starting-address,
325 and, within that, in order of decreasing ending-address.
327 This implies that within the body of one function
328 the blocks appear in the order of a depth-first tree walk. */
332 /* Number of blocks in the list. */
334 /* The blocks themselves. */
335 struct block
*block
[1];
338 #define BLOCKVECTOR_NBLOCKS(blocklist) (blocklist)->nblocks
339 #define BLOCKVECTOR_BLOCK(blocklist,n) (blocklist)->block[n]
341 /* Special block numbers */
343 #define GLOBAL_BLOCK 0
344 #define STATIC_BLOCK 1
345 #define FIRST_LOCAL_BLOCK 2
350 /* Addresses in the executable code that are in this block. */
355 /* The symbol that names this block, if the block is the body of a
356 function; otherwise, zero. */
358 struct symbol
*function
;
360 /* The `struct block' for the containing block, or 0 if none.
362 The superblock of a top-level local block (i.e. a function in the
363 case of C) is the STATIC_BLOCK. The superblock of the
364 STATIC_BLOCK is the GLOBAL_BLOCK. */
366 struct block
*superblock
;
368 /* Version of GCC used to compile the function corresponding
369 to this block, or 0 if not compiled with GCC. When possible,
370 GCC should be compatible with the native compiler, or if that
371 is not feasible, the differences should be fixed during symbol
372 reading. As of 16 Apr 93, this flag is never used to distinguish
373 between gcc2 and the native compiler.
375 If there is no function corresponding to this block, this meaning
376 of this flag is undefined. */
378 unsigned char gcc_compile_flag
;
380 /* Number of local symbols. */
384 /* The symbols. If some of them are arguments, then they must be
385 in the order in which we would like to print them. */
387 struct symbol
*sym
[1];
390 #define BLOCK_START(bl) (bl)->startaddr
391 #define BLOCK_END(bl) (bl)->endaddr
392 #define BLOCK_NSYMS(bl) (bl)->nsyms
393 #define BLOCK_SYM(bl, n) (bl)->sym[n]
394 #define BLOCK_FUNCTION(bl) (bl)->function
395 #define BLOCK_SUPERBLOCK(bl) (bl)->superblock
396 #define BLOCK_GCC_COMPILED(bl) (bl)->gcc_compile_flag
398 /* Nonzero if symbols of block BL should be sorted alphabetically.
399 Don't sort a block which corresponds to a function. If we did the
400 sorting would have to preserve the order of the symbols for the
403 #define BLOCK_SHOULD_SORT(bl) ((bl)->nsyms >= 40 && BLOCK_FUNCTION (bl) == NULL)
406 /* Represent one symbol name; a variable, constant, function or typedef. */
408 /* Different name spaces for symbols. Looking up a symbol specifies a
409 namespace and ignores symbol definitions in other name spaces. */
413 /* UNDEF_NAMESPACE is used when a namespace has not been discovered or
414 none of the following apply. This usually indicates an error either
415 in the symbol information or in gdb's handling of symbols. */
419 /* VAR_NAMESPACE is the usual namespace. In C, this contains variables,
420 function names, typedef names and enum type values. */
424 /* STRUCT_NAMESPACE is used in C to hold struct, union and enum type names.
425 Thus, if `struct foo' is used in a C program, it produces a symbol named
426 `foo' in the STRUCT_NAMESPACE. */
430 /* LABEL_NAMESPACE may be used for names of labels (for gotos);
431 currently it is not used and labels are not recorded at all. */
436 /* An address-class says where to find the value of a symbol. */
440 /* Not used; catches errors */
444 /* Value is constant int SYMBOL_VALUE, host byteorder */
448 /* Value is at fixed address SYMBOL_VALUE_ADDRESS */
452 /* Value is in register. SYMBOL_VALUE is the register number. */
456 /* It's an argument; the value is at SYMBOL_VALUE offset in arglist. */
460 /* Value address is at SYMBOL_VALUE offset in arglist. */
464 /* Value is in register number SYMBOL_VALUE. Just like LOC_REGISTER
465 except this is an argument. Probably the cleaner way to handle
466 this would be to separate address_class (which would include
467 separate ARG and LOCAL to deal with FRAME_ARGS_ADDRESS versus
468 FRAME_LOCALS_ADDRESS), and an is_argument flag.
470 For some symbol formats (stabs, for some compilers at least),
471 the compiler generates two symbols, an argument and a register.
472 In some cases we combine them to a single LOC_REGPARM in symbol
473 reading, but currently not for all cases (e.g. it's passed on the
474 stack and then loaded into a register). */
478 /* Value is in specified register. Just like LOC_REGPARM except the
479 register holds the address of the argument instead of the argument
480 itself. This is currently used for the passing of structs and unions
481 on sparc and hppa. It is also used for call by reference where the
482 address is in a register, at least by mipsread.c. */
486 /* Value is a local variable at SYMBOL_VALUE offset in stack frame. */
490 /* Value not used; definition in SYMBOL_TYPE. Symbols in the namespace
491 STRUCT_NAMESPACE all have this class. */
495 /* Value is address SYMBOL_VALUE_ADDRESS in the code */
499 /* In a symbol table, value is SYMBOL_BLOCK_VALUE of a `struct block'.
500 In a partial symbol table, SYMBOL_VALUE_ADDRESS is the start address
501 of the block. Function names have this class. */
505 /* Value is a constant byte-sequence pointed to by SYMBOL_VALUE_BYTES, in
506 target byte order. */
510 /* Value is arg at SYMBOL_VALUE offset in stack frame. Differs from
511 LOC_LOCAL in that symbol is an argument; differs from LOC_ARG in
512 that we find it in the frame (FRAME_LOCALS_ADDRESS), not in the
513 arglist (FRAME_ARGS_ADDRESS). Added for i960, which passes args
514 in regs then copies to frame. */
518 /* Value is at SYMBOL_VALUE offset from the current value of
519 register number SYMBOL_BASEREG. This exists mainly for the same
520 things that LOC_LOCAL and LOC_ARG do; but we need to do this
521 instead because on 88k DWARF gives us the offset from the
522 frame/stack pointer, rather than the offset from the "canonical
523 frame address" used by COFF, stabs, etc., and we don't know how
524 to convert between these until we start examining prologues.
526 Note that LOC_BASEREG is much less general than a DWARF expression. */
530 /* Same as LOC_BASEREG but it is an argument. */
534 /* The variable does not actually exist in the program.
535 The value is ignored. */
543 /* The general symbol info required for all types of symbols. */
545 struct general_symbol_info ginfo
;
547 /* Name space code. */
549 enum namespace namespace;
553 enum address_class
class;
555 /* Data type of value */
559 /* Line number of definition. FIXME: Should we really make the assumption
560 that nobody will try to debug files longer than 64K lines? What about
561 machine generated programs? */
565 /* Some symbols require an additional value to be recorded on a per-
566 symbol basis. Stash those values here. */
570 /* Used by LOC_BASEREG and LOC_BASEREG_ARG. */
577 #define SYMBOL_NAMESPACE(symbol) (symbol)->namespace
578 #define SYMBOL_CLASS(symbol) (symbol)->class
579 #define SYMBOL_TYPE(symbol) (symbol)->type
580 #define SYMBOL_LINE(symbol) (symbol)->line
581 #define SYMBOL_BASEREG(symbol) (symbol)->aux_value.basereg
583 /* A partial_symbol records the name, namespace, and address class of
584 symbols whose types we have not parsed yet. For functions, it also
585 contains their memory address, so we can find them from a PC value.
586 Each partial_symbol sits in a partial_symtab, all of which are chained
587 on a partial symtab list and which points to the corresponding
588 normal symtab once the partial_symtab has been referenced. */
590 struct partial_symbol
593 /* The general symbol info required for all types of symbols. */
595 struct general_symbol_info ginfo
;
597 /* Name space code. */
599 enum namespace namespace;
601 /* Address class (for info_symbols) */
603 enum address_class
class;
607 #define PSYMBOL_NAMESPACE(psymbol) (psymbol)->namespace
608 #define PSYMBOL_CLASS(psymbol) (psymbol)->class
611 /* Source-file information. This describes the relation between source files,
612 ine numbers and addresses in the program text. */
616 int length
; /* Number of source files described */
617 struct source
*source
[1]; /* Descriptions of the files */
620 /* Each item represents a line-->pc (or the reverse) mapping. This is
621 somewhat more wasteful of space than one might wish, but since only
622 the files which are actually debugged are read in to core, we don't
625 struct linetable_entry
631 /* The order of entries in the linetable is significant.
633 It should generally be in ascending line number order. Line table
634 entries for a function at lines 10-40 should come before entries
635 for a function at lines 50-70.
637 A for statement looks like this
639 10 0x100 - for the init/test part of a for stmt.
642 10 0x400 - for the increment part of a for stmt.
644 FIXME: this description is incomplete. coffread.c is said to get
645 the linetable order wrong (would arrange_linenos from xcoffread.c
646 work for normal COFF too?). */
651 struct linetable_entry item
[1];
654 /* All the information on one source file. */
658 char *name
; /* Name of file */
659 struct linetable contents
;
662 /* How to relocate the symbols from each section in a symbol file.
663 Each struct contains an array of offsets.
664 The ordering and meaning of the offsets is file-type-dependent;
665 typically it is indexed by section numbers or symbol types or
668 To give us flexibility in changing the internal representation
669 of these offsets, the ANOFFSET macro must be used to insert and
670 extract offset values in the struct. */
672 struct section_offsets
674 CORE_ADDR offsets
[1]; /* As many as needed. */
677 #define ANOFFSET(secoff, whichone) (secoff->offsets[whichone])
679 /* Each source file is represented by a struct symtab.
680 These objects are chained through the `next' field. */
685 /* Chain of all existing symtabs. */
689 /* List of all symbol scope blocks for this symtab. */
691 struct blockvector
*blockvector
;
693 /* Table mapping core addresses to line numbers for this file.
694 Can be NULL if none. */
696 struct linetable
*linetable
;
698 /* Section in objfile->section_offsets for the blockvector and
701 int block_line_section
;
703 /* If several symtabs share a blockvector, exactly one of them
704 should be designed the primary, so that the blockvector
705 is relocated exactly once by objfile_relocate. */
709 /* Name of this source file. */
713 /* Directory in which it was compiled, or NULL if we don't know. */
717 /* This component says how to free the data we point to:
718 free_contents => do a tree walk and free each object.
719 free_nothing => do nothing; some other symtab will free
720 the data this one uses.
721 free_linetable => free just the linetable. */
725 free_nothing
, free_contents
, free_linetable
729 /* Pointer to one block of storage to be freed, if nonzero. */
730 /* This is IN ADDITION to the action indicated by free_code. */
734 /* Total number of lines found in source file. */
738 /* line_charpos[N] is the position of the (N-1)th line of the
739 source file. "position" means something we can lseek() to; it
740 is not guaranteed to be useful any other way. */
744 /* Language of this source file. */
746 enum language language
;
748 /* String of version information. May be zero. */
752 /* Full name of file as found by searching the source path.
753 NULL if not yet known. */
757 /* Object file from which this symbol information was read. */
759 struct objfile
*objfile
;
761 /* Anything extra for this symtab. This is for target machines
762 with special debugging info of some sort (which cannot just
763 be represented in a normal symtab). */
765 #if defined (EXTRA_SYMTAB_INFO)
771 #define BLOCKVECTOR(symtab) (symtab)->blockvector
772 #define LINETABLE(symtab) (symtab)->linetable
775 /* Each source file that has not been fully read in is represented by
776 a partial_symtab. This contains the information on where in the
777 executable the debugging symbols for a specific file are, and a
778 list of names of global symbols which are located in this file.
779 They are all chained on partial symtab lists.
781 Even after the source file has been read into a symtab, the
782 partial_symtab remains around. They are allocated on an obstack,
783 psymbol_obstack. FIXME, this is bad for dynamic linking or VxWorks-
784 style execution of a bunch of .o's. */
786 struct partial_symtab
789 /* Chain of all existing partial symtabs. */
791 struct partial_symtab
*next
;
793 /* Name of the source file which this partial_symtab defines */
797 /* Information about the object file from which symbols should be read. */
799 struct objfile
*objfile
;
801 /* Set of relocation offsets to apply to each section. */
803 struct section_offsets
*section_offsets
;
805 /* Range of text addresses covered by this file; texthigh is the
806 beginning of the next section. */
811 /* Array of pointers to all of the partial_symtab's which this one
812 depends on. Since this array can only be set to previous or
813 the current (?) psymtab, this dependency tree is guaranteed not
814 to have any loops. "depends on" means that symbols must be read
815 for the dependencies before being read for this psymtab; this is
816 for type references in stabs, where if foo.c includes foo.h, declarations
817 in foo.h may use type numbers defined in foo.c. For other debugging
818 formats there may be no need to use dependencies. */
820 struct partial_symtab
**dependencies
;
822 int number_of_dependencies
;
824 /* Global symbol list. This list will be sorted after readin to
825 improve access. Binary search will be the usual method of
826 finding a symbol within it. globals_offset is an integer offset
827 within global_psymbols[]. */
832 /* Static symbol list. This list will *not* be sorted after readin;
833 to find a symbol in it, exhaustive search must be used. This is
834 reasonable because searches through this list will eventually
835 lead to either the read in of a files symbols for real (assumed
836 to take a *lot* of time; check) or an error (and we don't care
837 how long errors take). This is an offset and size within
838 static_psymbols[]. */
843 /* Pointer to symtab eventually allocated for this source file, 0 if
844 !readin or if we haven't looked for the symtab after it was readin. */
846 struct symtab
*symtab
;
848 /* Pointer to function which will read in the symtab corresponding to
851 void (*read_symtab
) PARAMS ((struct partial_symtab
*));
853 /* Information that lets read_symtab() locate the part of the symbol table
854 that this psymtab corresponds to. This information is private to the
855 format-dependent symbol reading routines. For further detail examine
856 the various symbol reading modules. Should really be (void *) but is
857 (char *) as with other such gdb variables. (FIXME) */
859 char *read_symtab_private
;
861 /* Non-zero if the symtab corresponding to this psymtab has been readin */
863 unsigned char readin
;
866 /* A fast way to get from a psymtab to its symtab (after the first time). */
867 #define PSYMTAB_TO_SYMTAB(pst) \
868 ((pst) -> symtab != NULL ? (pst) -> symtab : psymtab_to_symtab (pst))
871 /* The virtual function table is now an array of structures which have the
872 form { int16 offset, delta; void *pfn; }.
874 In normal virtual function tables, OFFSET is unused.
875 DELTA is the amount which is added to the apparent object's base
876 address in order to point to the actual object to which the
877 virtual function should be applied.
878 PFN is a pointer to the virtual function.
880 Note that this macro is g++ specific (FIXME). */
882 #define VTBL_FNADDR_OFFSET 2
884 /* Macro that yields non-zero value iff NAME is the prefix for C++ operator
885 names. If you leave out the parenthesis here you will lose!
886 Currently 'o' 'p' CPLUS_MARKER is used for both the symbol in the
887 symbol-file and the names in gdb's symbol table.
888 Note that this macro is g++ specific (FIXME). */
890 #define OPNAME_PREFIX_P(NAME) \
891 ((NAME)[0] == 'o' && (NAME)[1] == 'p' && (NAME)[2] == CPLUS_MARKER)
893 /* Macro that yields non-zero value iff NAME is the prefix for C++ vtbl
894 names. Note that this macro is g++ specific (FIXME). */
896 #define VTBL_PREFIX_P(NAME) \
897 ((NAME)[3] == CPLUS_MARKER && !strncmp ((NAME), "_vt", 3))
899 /* Macro that yields non-zero value iff NAME is the prefix for C++ destructor
900 names. Note that this macro is g++ specific (FIXME). */
902 #define DESTRUCTOR_PREFIX_P(NAME) \
903 ((NAME)[0] == '_' && (NAME)[1] == CPLUS_MARKER && (NAME)[2] == '_')
906 /* External variables and functions for the objects described above. */
908 /* This symtab variable specifies the current file for printing source lines */
910 extern struct symtab
*current_source_symtab
;
912 /* This is the next line to print for listing source lines. */
914 extern int current_source_line
;
916 /* See the comment in symfile.c about how current_objfile is used. */
918 extern struct objfile
*current_objfile
;
920 extern struct symtab
*
921 lookup_symtab
PARAMS ((char *));
923 extern struct symbol
*
924 lookup_symbol
PARAMS ((const char *, const struct block
*,
925 const enum namespace, int *, struct symtab
**));
927 extern struct symbol
*
928 lookup_block_symbol
PARAMS ((const struct block
*, const char *,
929 const enum namespace));
932 lookup_struct
PARAMS ((char *, struct block
*));
935 lookup_union
PARAMS ((char *, struct block
*));
938 lookup_enum
PARAMS ((char *, struct block
*));
940 extern struct symbol
*
941 block_function
PARAMS ((struct block
*));
943 extern struct symbol
*
944 find_pc_function
PARAMS ((CORE_ADDR
));
946 extern int find_pc_partial_function
947 PARAMS ((CORE_ADDR
, char **, CORE_ADDR
*, CORE_ADDR
*));
950 clear_pc_function_cache
PARAMS ((void));
952 extern struct partial_symtab
*
953 lookup_partial_symtab
PARAMS ((char *));
955 extern struct partial_symtab
*
956 find_pc_psymtab
PARAMS ((CORE_ADDR
));
958 extern struct symtab
*
959 find_pc_symtab
PARAMS ((CORE_ADDR
));
961 extern struct partial_symbol
*
962 find_pc_psymbol
PARAMS ((struct partial_symtab
*, CORE_ADDR
));
965 find_pc_line_pc_range
PARAMS ((CORE_ADDR
, CORE_ADDR
*, CORE_ADDR
*));
968 contained_in
PARAMS ((struct block
*, struct block
*));
971 reread_symbols
PARAMS ((void));
973 /* Functions for dealing with the minimal symbol table, really a misc
974 address<->symbol mapping for things we don't have debug symbols for. */
977 prim_record_minimal_symbol
PARAMS ((const char *, CORE_ADDR
,
978 enum minimal_symbol_type
));
981 prim_record_minimal_symbol_and_info
PARAMS ((const char *, CORE_ADDR
,
982 enum minimal_symbol_type
,
983 char *info
, int section
));
985 extern struct minimal_symbol
*
986 lookup_minimal_symbol
PARAMS ((const char *, struct objfile
*));
988 extern struct minimal_symbol
*
989 lookup_minimal_symbol_by_pc
PARAMS ((CORE_ADDR
));
992 init_minimal_symbol_collection
PARAMS ((void));
995 discard_minimal_symbols
PARAMS ((int));
998 install_minimal_symbols
PARAMS ((struct objfile
*));
1000 struct symtab_and_line
1002 struct symtab
*symtab
;
1004 /* Line number. Line numbers start at 1 and proceed through symtab->nlines.
1005 0 is never a valid line number; it is used to indicate that line number
1006 information is not available. */
1013 struct symtabs_and_lines
1015 struct symtab_and_line
*sals
;
1019 /* Given a pc value, return line number it is in. Second arg nonzero means
1020 if pc is on the boundary use the previous statement's line number. */
1022 extern struct symtab_and_line
1023 find_pc_line
PARAMS ((CORE_ADDR
, int));
1025 /* Given a symtab and line number, return the pc there. */
1028 find_line_pc
PARAMS ((struct symtab
*, int));
1031 find_line_pc_range
PARAMS ((struct symtab
*, int, CORE_ADDR
*, CORE_ADDR
*));
1034 resolve_sal_pc
PARAMS ((struct symtab_and_line
*));
1036 /* Given a string, return the line specified by it. For commands like "list"
1037 and "breakpoint". */
1039 extern struct symtabs_and_lines
1040 decode_line_spec
PARAMS ((char *, int));
1042 extern struct symtabs_and_lines
1043 decode_line_spec_1
PARAMS ((char *, int));
1045 extern struct symtabs_and_lines
1046 decode_line_1
PARAMS ((char **, int, struct symtab
*, int, char ***));
1050 #if MAINTENANCE_CMDS
1053 maintenance_print_symbols
PARAMS ((char *, int));
1056 maintenance_print_psymbols
PARAMS ((char *, int));
1059 maintenance_print_msymbols
PARAMS ((char *, int));
1062 maintenance_print_objfiles
PARAMS ((char *, int));
1067 free_symtab
PARAMS ((struct symtab
*));
1069 /* Symbol-reading stuff in symfile.c and solib.c. */
1071 extern struct symtab
*
1072 psymtab_to_symtab
PARAMS ((struct partial_symtab
*));
1075 clear_solib
PARAMS ((void));
1077 extern struct objfile
*
1078 symbol_file_add
PARAMS ((char *, int, CORE_ADDR
, int, int, int));
1082 extern int frame_file_full_name
; /* in stack.c */
1085 identify_source_line
PARAMS ((struct symtab
*, int, int, CORE_ADDR
));
1088 print_source_lines
PARAMS ((struct symtab
*, int, int, int));
1091 forget_cached_source_info
PARAMS ((void));
1094 select_source_symtab
PARAMS ((struct symtab
*));
1096 extern char **make_symbol_completion_list
PARAMS ((char *, char *));
1100 extern struct partial_symtab
*
1101 find_main_psymtab
PARAMS ((void));
1105 extern struct blockvector
*
1106 blockvector_for_pc
PARAMS ((CORE_ADDR
, int *));
1111 clear_symtab_users
PARAMS ((void));
1113 extern enum language
1114 deduce_language_from_filename
PARAMS ((char *));
1116 #endif /* !defined(SYMTAB_H) */