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
89 expect all symbol-reading code to set it correctly (the ELF code
90 also tries to set it correctly). */
95 #define SYMBOL_NAME(symbol) (symbol)->ginfo.name
96 #define SYMBOL_VALUE(symbol) (symbol)->ginfo.value.value
97 #define SYMBOL_VALUE_ADDRESS(symbol) (symbol)->ginfo.value.address
98 #define SYMBOL_VALUE_BYTES(symbol) (symbol)->ginfo.value.bytes
99 #define SYMBOL_BLOCK_VALUE(symbol) (symbol)->ginfo.value.block
100 #define SYMBOL_VALUE_CHAIN(symbol) (symbol)->ginfo.value.chain
101 #define SYMBOL_LANGUAGE(symbol) (symbol)->ginfo.language
102 #define SYMBOL_SECTION(symbol) (symbol)->ginfo.section
104 #define SYMBOL_CPLUS_DEMANGLED_NAME(symbol) \
105 (symbol)->ginfo.language_specific.cplus_specific.demangled_name
108 extern int demangle
; /* We reference it, so go ahead and declare it. */
110 /* Macro that initializes the language dependent portion of a symbol
111 depending upon the language for the symbol. */
113 #define SYMBOL_INIT_LANGUAGE_SPECIFIC(symbol,language) \
115 SYMBOL_LANGUAGE (symbol) = language; \
116 if (SYMBOL_LANGUAGE (symbol) == language_cplus) \
118 SYMBOL_CPLUS_DEMANGLED_NAME (symbol) = NULL; \
120 else if (SYMBOL_LANGUAGE (symbol) == language_chill) \
122 SYMBOL_CHILL_DEMANGLED_NAME (symbol) = NULL; \
126 memset (&(symbol)->ginfo.language_specific, 0, \
127 sizeof ((symbol)->ginfo.language_specific)); \
131 /* Macro that attempts to initialize the demangled name for a symbol,
132 based on the language of that symbol. If the language is set to
133 language_auto, it will attempt to find any demangling algorithm
134 that works and then set the language appropriately. If no demangling
135 of any kind is found, the language is set back to language_unknown,
136 so we can avoid doing this work again the next time we encounter
137 the symbol. Any required space to store the name is obtained from the
138 specified obstack. */
140 #define SYMBOL_INIT_DEMANGLED_NAME(symbol,obstack) \
142 char *demangled = NULL; \
143 if (SYMBOL_LANGUAGE (symbol) == language_cplus \
144 || SYMBOL_LANGUAGE (symbol) == language_auto) \
147 cplus_demangle (SYMBOL_NAME (symbol), DMGL_PARAMS | DMGL_ANSI);\
148 if (demangled != NULL) \
150 SYMBOL_LANGUAGE (symbol) = language_cplus; \
151 SYMBOL_CPLUS_DEMANGLED_NAME (symbol) = \
152 obsavestring (demangled, strlen (demangled), (obstack)); \
157 SYMBOL_CPLUS_DEMANGLED_NAME (symbol) = NULL; \
160 if (demangled == NULL \
161 && (SYMBOL_LANGUAGE (symbol) == language_chill \
162 || SYMBOL_LANGUAGE (symbol) == language_auto)) \
165 chill_demangle (SYMBOL_NAME (symbol)); \
166 if (demangled != NULL) \
168 SYMBOL_LANGUAGE (symbol) = language_chill; \
169 SYMBOL_CHILL_DEMANGLED_NAME (symbol) = \
170 obsavestring (demangled, strlen (demangled), (obstack)); \
175 SYMBOL_CHILL_DEMANGLED_NAME (symbol) = NULL; \
178 if (SYMBOL_LANGUAGE (symbol) == language_auto) \
180 SYMBOL_LANGUAGE (symbol) = language_unknown; \
184 /* Macro that returns the demangled name for a symbol based on the language
185 for that symbol. If no demangled name exists, returns NULL. */
187 #define SYMBOL_DEMANGLED_NAME(symbol) \
188 (SYMBOL_LANGUAGE (symbol) == language_cplus \
189 ? SYMBOL_CPLUS_DEMANGLED_NAME (symbol) \
190 : (SYMBOL_LANGUAGE (symbol) == language_chill \
191 ? SYMBOL_CHILL_DEMANGLED_NAME (symbol) \
194 #define SYMBOL_CHILL_DEMANGLED_NAME(symbol) \
195 (symbol)->ginfo.language_specific.chill_specific.demangled_name
197 /* Macro that returns the "natural source name" of a symbol. In C++ this is
198 the "demangled" form of the name if demangle is on and the "mangled" form
199 of the name if demangle is off. In other languages this is just the
200 symbol name. The result should never be NULL. */
202 #define SYMBOL_SOURCE_NAME(symbol) \
203 (demangle && SYMBOL_DEMANGLED_NAME (symbol) != NULL \
204 ? SYMBOL_DEMANGLED_NAME (symbol) \
205 : SYMBOL_NAME (symbol))
207 /* Macro that returns the "natural assembly name" of a symbol. In C++ this is
208 the "mangled" form of the name if demangle is off, or if demangle is on and
209 asm_demangle is off. Otherwise if asm_demangle is on it is the "demangled"
210 form. In other languages this is just the symbol name. The result should
213 #define SYMBOL_LINKAGE_NAME(symbol) \
214 (demangle && asm_demangle && SYMBOL_DEMANGLED_NAME (symbol) != NULL \
215 ? SYMBOL_DEMANGLED_NAME (symbol) \
216 : SYMBOL_NAME (symbol))
220 extern int asm_demangle
;
222 /* Macro that tests a symbol for a match against a specified name string.
223 First test the unencoded name, then looks for and test a C++ encoded
224 name if it exists. Note that whitespace is ignored while attempting to
225 match a C++ encoded name, so that "foo::bar(int,long)" is the same as
226 "foo :: bar (int, long)".
227 Evaluates to zero if the match fails, or nonzero if it succeeds. */
229 #define SYMBOL_MATCHES_NAME(symbol, name) \
230 (STREQ (SYMBOL_NAME (symbol), (name)) \
231 || (SYMBOL_DEMANGLED_NAME (symbol) != NULL \
232 && strcmp_iw (SYMBOL_DEMANGLED_NAME (symbol), (name)) == 0))
234 /* Macro that tests a symbol for an re-match against the last compiled regular
235 expression. First test the unencoded name, then look for and test a C++
236 encoded name if it exists.
237 Evaluates to zero if the match fails, or nonzero if it succeeds. */
239 #define SYMBOL_MATCHES_REGEXP(symbol) \
240 (re_exec (SYMBOL_NAME (symbol)) != 0 \
241 || (SYMBOL_DEMANGLED_NAME (symbol) != NULL \
242 && re_exec (SYMBOL_DEMANGLED_NAME (symbol)) != 0))
244 /* Define a simple structure used to hold some very basic information about
245 all defined global symbols (text, data, bss, abs, etc). The only required
246 information is the general_symbol_info.
248 In many cases, even if a file was compiled with no special options for
249 debugging at all, as long as was not stripped it will contain sufficient
250 information to build a useful minimal symbol table using this structure.
251 Even when a file contains enough debugging information to build a full
252 symbol table, these minimal symbols are still useful for quickly mapping
253 between names and addresses, and vice versa. They are also sometimes
254 used to figure out what full symbol table entries need to be read in. */
256 struct minimal_symbol
259 /* The general symbol info required for all types of symbols.
261 The SYMBOL_VALUE_ADDRESS contains the address that this symbol
264 struct general_symbol_info ginfo
;
266 /* The info field is available for caching machine-specific information that
267 The AMD 29000 tdep.c uses it to remember things it has decoded from the
268 instructions in the function header, so it doesn't have to rederive the
269 info constantly (over a serial line). It is initialized to zero and
270 stays that way until target-dependent code sets it. Storage for any data
271 pointed to by this field should be allocated on the symbol_obstack for
272 the associated objfile. The type would be "void *" except for reasons
273 of compatibility with older compilers. This field is optional. */
277 /* Classification types for this symbol. These should be taken as "advisory
278 only", since if gdb can't easily figure out a classification it simply
279 selects mst_unknown. It may also have to guess when it can't figure out
280 which is a better match between two types (mst_data versus mst_bss) for
281 example. Since the minimal symbol info is sometimes derived from the
282 BFD library's view of a file, we need to live with what information bfd
285 enum minimal_symbol_type
287 mst_unknown
= 0, /* Unknown type, the default */
288 mst_text
, /* Generally executable instructions */
289 mst_data
, /* Generally initialized data */
290 mst_bss
, /* Generally uninitialized data */
291 mst_abs
, /* Generally absolute (nonrelocatable) */
292 /* For the mst_file* types, the names are only guaranteed to be unique
293 within a given .o file. */
294 mst_file_text
, /* Static version of mst_text */
295 mst_file_data
, /* Static version of mst_data */
296 mst_file_bss
/* Static version of mst_bss */
301 #define MSYMBOL_INFO(msymbol) (msymbol)->info
302 #define MSYMBOL_TYPE(msymbol) (msymbol)->type
305 /* All of the name-scope contours of the program
306 are represented by `struct block' objects.
307 All of these objects are pointed to by the blockvector.
309 Each block represents one name scope.
310 Each lexical context has its own block.
312 The blockvector begins with some special blocks.
313 The GLOBAL_BLOCK contains all the symbols defined in this compilation
314 whose scope is the entire program linked together.
315 The STATIC_BLOCK contains all the symbols whose scope is the
316 entire compilation excluding other separate compilations.
317 Blocks starting with the FIRST_LOCAL_BLOCK are not special.
319 Each block records a range of core addresses for the code that
320 is in the scope of the block. The STATIC_BLOCK and GLOBAL_BLOCK
321 give, for the range of code, the entire range of code produced
322 by the compilation that the symbol segment belongs to.
324 The blocks appear in the blockvector
325 in order of increasing starting-address,
326 and, within that, in order of decreasing ending-address.
328 This implies that within the body of one function
329 the blocks appear in the order of a depth-first tree walk. */
333 /* Number of blocks in the list. */
335 /* The blocks themselves. */
336 struct block
*block
[1];
339 #define BLOCKVECTOR_NBLOCKS(blocklist) (blocklist)->nblocks
340 #define BLOCKVECTOR_BLOCK(blocklist,n) (blocklist)->block[n]
342 /* Special block numbers */
344 #define GLOBAL_BLOCK 0
345 #define STATIC_BLOCK 1
346 #define FIRST_LOCAL_BLOCK 2
351 /* Addresses in the executable code that are in this block. */
356 /* The symbol that names this block, if the block is the body of a
357 function; otherwise, zero. */
359 struct symbol
*function
;
361 /* The `struct block' for the containing block, or 0 if none.
363 The superblock of a top-level local block (i.e. a function in the
364 case of C) is the STATIC_BLOCK. The superblock of the
365 STATIC_BLOCK is the GLOBAL_BLOCK. */
367 struct block
*superblock
;
369 /* Version of GCC used to compile the function corresponding
370 to this block, or 0 if not compiled with GCC. When possible,
371 GCC should be compatible with the native compiler, or if that
372 is not feasible, the differences should be fixed during symbol
373 reading. As of 16 Apr 93, this flag is never used to distinguish
374 between gcc2 and the native compiler.
376 If there is no function corresponding to this block, this meaning
377 of this flag is undefined. */
379 unsigned char gcc_compile_flag
;
381 /* Number of local symbols. */
385 /* The symbols. If some of them are arguments, then they must be
386 in the order in which we would like to print them. */
388 struct symbol
*sym
[1];
391 #define BLOCK_START(bl) (bl)->startaddr
392 #define BLOCK_END(bl) (bl)->endaddr
393 #define BLOCK_NSYMS(bl) (bl)->nsyms
394 #define BLOCK_SYM(bl, n) (bl)->sym[n]
395 #define BLOCK_FUNCTION(bl) (bl)->function
396 #define BLOCK_SUPERBLOCK(bl) (bl)->superblock
397 #define BLOCK_GCC_COMPILED(bl) (bl)->gcc_compile_flag
399 /* Nonzero if symbols of block BL should be sorted alphabetically.
400 Don't sort a block which corresponds to a function. If we did the
401 sorting would have to preserve the order of the symbols for the
404 #define BLOCK_SHOULD_SORT(bl) ((bl)->nsyms >= 40 && BLOCK_FUNCTION (bl) == NULL)
407 /* Represent one symbol name; a variable, constant, function or typedef. */
409 /* Different name spaces for symbols. Looking up a symbol specifies a
410 namespace and ignores symbol definitions in other name spaces. */
414 /* UNDEF_NAMESPACE is used when a namespace has not been discovered or
415 none of the following apply. This usually indicates an error either
416 in the symbol information or in gdb's handling of symbols. */
420 /* VAR_NAMESPACE is the usual namespace. In C, this contains variables,
421 function names, typedef names and enum type values. */
425 /* STRUCT_NAMESPACE is used in C to hold struct, union and enum type names.
426 Thus, if `struct foo' is used in a C program, it produces a symbol named
427 `foo' in the STRUCT_NAMESPACE. */
431 /* LABEL_NAMESPACE may be used for names of labels (for gotos);
432 currently it is not used and labels are not recorded at all. */
437 /* An address-class says where to find the value of a symbol. */
441 /* Not used; catches errors */
445 /* Value is constant int SYMBOL_VALUE, host byteorder */
449 /* Value is at fixed address SYMBOL_VALUE_ADDRESS */
453 /* Value is in register. SYMBOL_VALUE is the register number. */
457 /* It's an argument; the value is at SYMBOL_VALUE offset in arglist. */
461 /* Value address is at SYMBOL_VALUE offset in arglist. */
465 /* Value is in register number SYMBOL_VALUE. Just like LOC_REGISTER
466 except this is an argument. Probably the cleaner way to handle
467 this would be to separate address_class (which would include
468 separate ARG and LOCAL to deal with FRAME_ARGS_ADDRESS versus
469 FRAME_LOCALS_ADDRESS), and an is_argument flag.
471 For some symbol formats (stabs, for some compilers at least),
472 the compiler generates two symbols, an argument and a register.
473 In some cases we combine them to a single LOC_REGPARM in symbol
474 reading, but currently not for all cases (e.g. it's passed on the
475 stack and then loaded into a register). */
479 /* Value is in specified register. Just like LOC_REGPARM except the
480 register holds the address of the argument instead of the argument
481 itself. This is currently used for the passing of structs and unions
482 on sparc and hppa. It is also used for call by reference where the
483 address is in a register, at least by mipsread.c. */
487 /* Value is a local variable at SYMBOL_VALUE offset in stack frame. */
491 /* Value not used; definition in SYMBOL_TYPE. Symbols in the namespace
492 STRUCT_NAMESPACE all have this class. */
496 /* Value is address SYMBOL_VALUE_ADDRESS in the code */
500 /* In a symbol table, value is SYMBOL_BLOCK_VALUE of a `struct block'.
501 In a partial symbol table, SYMBOL_VALUE_ADDRESS is the start address
502 of the block. Function names have this class. */
506 /* Value is a constant byte-sequence pointed to by SYMBOL_VALUE_BYTES, in
507 target byte order. */
511 /* Value is arg at SYMBOL_VALUE offset in stack frame. Differs from
512 LOC_LOCAL in that symbol is an argument; differs from LOC_ARG in
513 that we find it in the frame (FRAME_LOCALS_ADDRESS), not in the
514 arglist (FRAME_ARGS_ADDRESS). Added for i960, which passes args
515 in regs then copies to frame. */
519 /* Value is at SYMBOL_VALUE offset from the current value of
520 register number SYMBOL_BASEREG. This exists mainly for the same
521 things that LOC_LOCAL and LOC_ARG do; but we need to do this
522 instead because on 88k DWARF gives us the offset from the
523 frame/stack pointer, rather than the offset from the "canonical
524 frame address" used by COFF, stabs, etc., and we don't know how
525 to convert between these until we start examining prologues.
527 Note that LOC_BASEREG is much less general than a DWARF expression.
528 We don't need the generality (at least not yet), and storing a general
529 DWARF expression would presumably take up more space than the existing
534 /* Same as LOC_BASEREG but it is an argument. */
538 /* The variable does not actually exist in the program.
539 The value is ignored. */
547 /* The general symbol info required for all types of symbols. */
549 struct general_symbol_info ginfo
;
551 /* Name space code. */
553 enum namespace namespace;
557 enum address_class
class;
559 /* Data type of value */
563 /* Line number of definition. FIXME: Should we really make the assumption
564 that nobody will try to debug files longer than 64K lines? What about
565 machine generated programs? */
569 /* Some symbols require an additional value to be recorded on a per-
570 symbol basis. Stash those values here. */
574 /* Used by LOC_BASEREG and LOC_BASEREG_ARG. */
581 #define SYMBOL_NAMESPACE(symbol) (symbol)->namespace
582 #define SYMBOL_CLASS(symbol) (symbol)->class
583 #define SYMBOL_TYPE(symbol) (symbol)->type
584 #define SYMBOL_LINE(symbol) (symbol)->line
585 #define SYMBOL_BASEREG(symbol) (symbol)->aux_value.basereg
587 /* A partial_symbol records the name, namespace, and address class of
588 symbols whose types we have not parsed yet. For functions, it also
589 contains their memory address, so we can find them from a PC value.
590 Each partial_symbol sits in a partial_symtab, all of which are chained
591 on a partial symtab list and which points to the corresponding
592 normal symtab once the partial_symtab has been referenced. */
594 struct partial_symbol
597 /* The general symbol info required for all types of symbols. */
599 struct general_symbol_info ginfo
;
601 /* Name space code. */
603 enum namespace namespace;
605 /* Address class (for info_symbols) */
607 enum address_class
class;
611 #define PSYMBOL_NAMESPACE(psymbol) (psymbol)->namespace
612 #define PSYMBOL_CLASS(psymbol) (psymbol)->class
615 /* Source-file information. This describes the relation between source files,
616 ine numbers and addresses in the program text. */
620 int length
; /* Number of source files described */
621 struct source
*source
[1]; /* Descriptions of the files */
624 /* Each item represents a line-->pc (or the reverse) mapping. This is
625 somewhat more wasteful of space than one might wish, but since only
626 the files which are actually debugged are read in to core, we don't
629 struct linetable_entry
635 /* The order of entries in the linetable is significant. They should
636 be sorted by increasing values of the pc field. If there is more than
637 one entry for a given pc, then I'm not sure what should happen (and
638 I not sure whether we currently handle it the best way).
640 Example: a C for statement generally looks like this
642 10 0x100 - for the init/test part of a for stmt.
645 10 0x400 - for the increment part of a for stmt.
653 /* Actually NITEMS elements. If you don't like this use of the
654 `struct hack', you can shove it up your ANSI (seriously, if the
655 committee tells us how to do it, we can probably go along). */
656 struct linetable_entry item
[1];
659 /* All the information on one source file. */
663 char *name
; /* Name of file */
664 struct linetable contents
;
667 /* How to relocate the symbols from each section in a symbol file.
668 Each struct contains an array of offsets.
669 The ordering and meaning of the offsets is file-type-dependent;
670 typically it is indexed by section numbers or symbol types or
673 To give us flexibility in changing the internal representation
674 of these offsets, the ANOFFSET macro must be used to insert and
675 extract offset values in the struct. */
677 struct section_offsets
679 CORE_ADDR offsets
[1]; /* As many as needed. */
682 #define ANOFFSET(secoff, whichone) (secoff->offsets[whichone])
684 /* Each source file or header is represented by a struct symtab.
685 These objects are chained through the `next' field. */
690 /* Chain of all existing symtabs. */
694 /* List of all symbol scope blocks for this symtab. May be shared
695 between different symtabs (and normally is for all the symtabs
696 in a given compilation unit). */
698 struct blockvector
*blockvector
;
700 /* Table mapping core addresses to line numbers for this file.
701 Can be NULL if none. Never shared between different symtabs. */
703 struct linetable
*linetable
;
705 /* Section in objfile->section_offsets for the blockvector and
708 int block_line_section
;
710 /* If several symtabs share a blockvector, exactly one of them
711 should be designed the primary, so that the blockvector
712 is relocated exactly once by objfile_relocate. */
716 /* Name of this source file. */
720 /* Directory in which it was compiled, or NULL if we don't know. */
724 /* This component says how to free the data we point to:
725 free_contents => do a tree walk and free each object.
726 free_nothing => do nothing; some other symtab will free
727 the data this one uses.
728 free_linetable => free just the linetable. FIXME: Is this redundant
729 with the primary field? */
733 free_nothing
, free_contents
, free_linetable
737 /* Pointer to one block of storage to be freed, if nonzero. */
738 /* This is IN ADDITION to the action indicated by free_code. */
742 /* Total number of lines found in source file. */
746 /* line_charpos[N] is the position of the (N-1)th line of the
747 source file. "position" means something we can lseek() to; it
748 is not guaranteed to be useful any other way. */
752 /* Language of this source file. */
754 enum language language
;
756 /* String of version information. May be zero. */
760 /* Full name of file as found by searching the source path.
761 NULL if not yet known. */
765 /* Object file from which this symbol information was read. */
767 struct objfile
*objfile
;
769 /* Anything extra for this symtab. This is for target machines
770 with special debugging info of some sort (which cannot just
771 be represented in a normal symtab). */
773 #if defined (EXTRA_SYMTAB_INFO)
779 #define BLOCKVECTOR(symtab) (symtab)->blockvector
780 #define LINETABLE(symtab) (symtab)->linetable
783 /* Each source file that has not been fully read in is represented by
784 a partial_symtab. This contains the information on where in the
785 executable the debugging symbols for a specific file are, and a
786 list of names of global symbols which are located in this file.
787 They are all chained on partial symtab lists.
789 Even after the source file has been read into a symtab, the
790 partial_symtab remains around. They are allocated on an obstack,
791 psymbol_obstack. FIXME, this is bad for dynamic linking or VxWorks-
792 style execution of a bunch of .o's. */
794 struct partial_symtab
797 /* Chain of all existing partial symtabs. */
799 struct partial_symtab
*next
;
801 /* Name of the source file which this partial_symtab defines */
805 /* Information about the object file from which symbols should be read. */
807 struct objfile
*objfile
;
809 /* Set of relocation offsets to apply to each section. */
811 struct section_offsets
*section_offsets
;
813 /* Range of text addresses covered by this file; texthigh is the
814 beginning of the next section. */
819 /* Array of pointers to all of the partial_symtab's which this one
820 depends on. Since this array can only be set to previous or
821 the current (?) psymtab, this dependency tree is guaranteed not
822 to have any loops. "depends on" means that symbols must be read
823 for the dependencies before being read for this psymtab; this is
824 for type references in stabs, where if foo.c includes foo.h, declarations
825 in foo.h may use type numbers defined in foo.c. For other debugging
826 formats there may be no need to use dependencies. */
828 struct partial_symtab
**dependencies
;
830 int number_of_dependencies
;
832 /* Global symbol list. This list will be sorted after readin to
833 improve access. Binary search will be the usual method of
834 finding a symbol within it. globals_offset is an integer offset
835 within global_psymbols[]. */
840 /* Static symbol list. This list will *not* be sorted after readin;
841 to find a symbol in it, exhaustive search must be used. This is
842 reasonable because searches through this list will eventually
843 lead to either the read in of a files symbols for real (assumed
844 to take a *lot* of time; check) or an error (and we don't care
845 how long errors take). This is an offset and size within
846 static_psymbols[]. */
851 /* Pointer to symtab eventually allocated for this source file, 0 if
852 !readin or if we haven't looked for the symtab after it was readin. */
854 struct symtab
*symtab
;
856 /* Pointer to function which will read in the symtab corresponding to
859 void (*read_symtab
) PARAMS ((struct partial_symtab
*));
861 /* Information that lets read_symtab() locate the part of the symbol table
862 that this psymtab corresponds to. This information is private to the
863 format-dependent symbol reading routines. For further detail examine
864 the various symbol reading modules. Should really be (void *) but is
865 (char *) as with other such gdb variables. (FIXME) */
867 char *read_symtab_private
;
869 /* Non-zero if the symtab corresponding to this psymtab has been readin */
871 unsigned char readin
;
874 /* A fast way to get from a psymtab to its symtab (after the first time). */
875 #define PSYMTAB_TO_SYMTAB(pst) \
876 ((pst) -> symtab != NULL ? (pst) -> symtab : psymtab_to_symtab (pst))
879 /* The virtual function table is now an array of structures which have the
880 form { int16 offset, delta; void *pfn; }.
882 In normal virtual function tables, OFFSET is unused.
883 DELTA is the amount which is added to the apparent object's base
884 address in order to point to the actual object to which the
885 virtual function should be applied.
886 PFN is a pointer to the virtual function.
888 Note that this macro is g++ specific (FIXME). */
890 #define VTBL_FNADDR_OFFSET 2
892 /* Macro that yields non-zero value iff NAME is the prefix for C++ operator
893 names. If you leave out the parenthesis here you will lose!
894 Currently 'o' 'p' CPLUS_MARKER is used for both the symbol in the
895 symbol-file and the names in gdb's symbol table.
896 Note that this macro is g++ specific (FIXME). */
898 #define OPNAME_PREFIX_P(NAME) \
899 ((NAME)[0] == 'o' && (NAME)[1] == 'p' && (NAME)[2] == CPLUS_MARKER)
901 /* Macro that yields non-zero value iff NAME is the prefix for C++ vtbl
902 names. Note that this macro is g++ specific (FIXME). */
904 #define VTBL_PREFIX_P(NAME) \
905 ((NAME)[3] == CPLUS_MARKER && !strncmp ((NAME), "_vt", 3))
907 /* Macro that yields non-zero value iff NAME is the prefix for C++ destructor
908 names. Note that this macro is g++ specific (FIXME). */
910 #define DESTRUCTOR_PREFIX_P(NAME) \
911 ((NAME)[0] == '_' && (NAME)[1] == CPLUS_MARKER && (NAME)[2] == '_')
914 /* External variables and functions for the objects described above. */
916 /* This symtab variable specifies the current file for printing source lines */
918 extern struct symtab
*current_source_symtab
;
920 /* This is the next line to print for listing source lines. */
922 extern int current_source_line
;
924 /* See the comment in symfile.c about how current_objfile is used. */
926 extern struct objfile
*current_objfile
;
928 extern struct symtab
*
929 lookup_symtab
PARAMS ((char *));
931 extern struct symbol
*
932 lookup_symbol
PARAMS ((const char *, const struct block
*,
933 const enum namespace, int *, struct symtab
**));
935 extern struct symbol
*
936 lookup_block_symbol
PARAMS ((const struct block
*, const char *,
937 const enum namespace));
940 lookup_struct
PARAMS ((char *, struct block
*));
943 lookup_union
PARAMS ((char *, struct block
*));
946 lookup_enum
PARAMS ((char *, struct block
*));
948 extern struct symbol
*
949 block_function
PARAMS ((struct block
*));
951 extern struct symbol
*
952 find_pc_function
PARAMS ((CORE_ADDR
));
954 extern int find_pc_partial_function
955 PARAMS ((CORE_ADDR
, char **, CORE_ADDR
*, CORE_ADDR
*));
958 clear_pc_function_cache
PARAMS ((void));
960 extern struct partial_symtab
*
961 lookup_partial_symtab
PARAMS ((char *));
963 extern struct partial_symtab
*
964 find_pc_psymtab
PARAMS ((CORE_ADDR
));
966 extern struct symtab
*
967 find_pc_symtab
PARAMS ((CORE_ADDR
));
969 extern struct partial_symbol
*
970 find_pc_psymbol
PARAMS ((struct partial_symtab
*, CORE_ADDR
));
973 find_pc_line_pc_range
PARAMS ((CORE_ADDR
, CORE_ADDR
*, CORE_ADDR
*));
976 contained_in
PARAMS ((struct block
*, struct block
*));
979 reread_symbols
PARAMS ((void));
981 /* Macro for name of symbol to indicate a file compiled with gcc. */
982 #ifndef GCC_COMPILED_FLAG_SYMBOL
983 #define GCC_COMPILED_FLAG_SYMBOL "gcc_compiled."
986 /* Macro for name of symbol to indicate a file compiled with gcc2. */
987 #ifndef GCC2_COMPILED_FLAG_SYMBOL
988 #define GCC2_COMPILED_FLAG_SYMBOL "gcc2_compiled."
991 /* Functions for dealing with the minimal symbol table, really a misc
992 address<->symbol mapping for things we don't have debug symbols for. */
995 prim_record_minimal_symbol
PARAMS ((const char *, CORE_ADDR
,
996 enum minimal_symbol_type
));
999 prim_record_minimal_symbol_and_info
PARAMS ((const char *, CORE_ADDR
,
1000 enum minimal_symbol_type
,
1001 char *info
, int section
));
1003 extern struct minimal_symbol
*
1004 lookup_minimal_symbol
PARAMS ((const char *, struct objfile
*));
1006 extern struct minimal_symbol
*
1007 lookup_minimal_symbol_by_pc
PARAMS ((CORE_ADDR
));
1010 init_minimal_symbol_collection
PARAMS ((void));
1013 discard_minimal_symbols
PARAMS ((int));
1016 install_minimal_symbols
PARAMS ((struct objfile
*));
1018 struct symtab_and_line
1020 struct symtab
*symtab
;
1022 /* Line number. Line numbers start at 1 and proceed through symtab->nlines.
1023 0 is never a valid line number; it is used to indicate that line number
1024 information is not available. */
1031 struct symtabs_and_lines
1033 struct symtab_and_line
*sals
;
1037 /* Given a pc value, return line number it is in. Second arg nonzero means
1038 if pc is on the boundary use the previous statement's line number. */
1040 extern struct symtab_and_line
1041 find_pc_line
PARAMS ((CORE_ADDR
, int));
1043 /* Given a symtab and line number, return the pc there. */
1046 find_line_pc
PARAMS ((struct symtab
*, int));
1049 find_line_pc_range
PARAMS ((struct symtab_and_line
,
1050 CORE_ADDR
*, CORE_ADDR
*));
1053 resolve_sal_pc
PARAMS ((struct symtab_and_line
*));
1055 /* Given a string, return the line specified by it. For commands like "list"
1056 and "breakpoint". */
1058 extern struct symtabs_and_lines
1059 decode_line_spec
PARAMS ((char *, int));
1061 extern struct symtabs_and_lines
1062 decode_line_spec_1
PARAMS ((char *, int));
1064 extern struct symtabs_and_lines
1065 decode_line_1
PARAMS ((char **, int, struct symtab
*, int, char ***));
1069 #if MAINTENANCE_CMDS
1072 maintenance_print_symbols
PARAMS ((char *, int));
1075 maintenance_print_psymbols
PARAMS ((char *, int));
1078 maintenance_print_msymbols
PARAMS ((char *, int));
1081 maintenance_print_objfiles
PARAMS ((char *, int));
1086 free_symtab
PARAMS ((struct symtab
*));
1088 /* Symbol-reading stuff in symfile.c and solib.c. */
1090 extern struct symtab
*
1091 psymtab_to_symtab
PARAMS ((struct partial_symtab
*));
1094 clear_solib
PARAMS ((void));
1096 extern struct objfile
*
1097 symbol_file_add
PARAMS ((char *, int, CORE_ADDR
, int, int, int));
1101 extern int frame_file_full_name
; /* in stack.c */
1104 identify_source_line
PARAMS ((struct symtab
*, int, int, CORE_ADDR
));
1107 print_source_lines
PARAMS ((struct symtab
*, int, int, int));
1110 forget_cached_source_info
PARAMS ((void));
1113 select_source_symtab
PARAMS ((struct symtab
*));
1115 extern char **make_symbol_completion_list
PARAMS ((char *, char *));
1119 extern struct partial_symtab
*
1120 find_main_psymtab
PARAMS ((void));
1124 extern struct blockvector
*
1125 blockvector_for_pc
PARAMS ((CORE_ADDR
, int *));
1130 clear_symtab_users
PARAMS ((void));
1132 extern enum language
1133 deduce_language_from_filename
PARAMS ((char *));
1135 #endif /* !defined(SYMTAB_H) */