1 /* Symbol table definitions for GDB.
3 Copyright (C) 1986, 1988, 1989, 1990, 1991, 1992, 1993, 1994, 1995, 1996,
4 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2007, 2008
5 Free Software Foundation, Inc.
7 This file is part of GDB.
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 3 of the License, or
12 (at your option) any later version.
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
19 You should have received a copy of the GNU General Public License
20 along with this program. If not, see <http://www.gnu.org/licenses/>. */
22 #if !defined (SYMTAB_H)
25 /* Opaque declarations. */
36 /* Some of the structures in this file are space critical.
37 The space-critical structures are:
39 struct general_symbol_info
43 These structures are laid out to encourage good packing.
44 They use ENUM_BITFIELD and short int fields, and they order the
45 structure members so that fields less than a word are next
46 to each other so they can be packed together. */
48 /* Rearranged: used ENUM_BITFIELD and rearranged field order in
49 all the space critical structures (plus struct minimal_symbol).
50 Memory usage dropped from 99360768 bytes to 90001408 bytes.
51 I measured this with before-and-after tests of
52 "HEAD-old-gdb -readnow HEAD-old-gdb" and
53 "HEAD-new-gdb -readnow HEAD-old-gdb" on native i686-pc-linux-gnu,
54 red hat linux 8, with LD_LIBRARY_PATH=/usr/lib/debug,
55 typing "maint space 1" at the first command prompt.
57 Here is another measurement (from andrew c):
58 # no /usr/lib/debug, just plain glibc, like a normal user
60 (gdb) break internal_error
62 (gdb) maint internal-error
66 gdb gdb_6_0_branch 2003-08-19 space used: 8896512
67 gdb HEAD 2003-08-19 space used: 8904704
68 gdb HEAD 2003-08-21 space used: 8396800 (+symtab.h)
69 gdb HEAD 2003-08-21 space used: 8265728 (+gdbtypes.h)
71 The third line shows the savings from the optimizations in symtab.h.
72 The fourth line shows the savings from the optimizations in
73 gdbtypes.h. Both optimizations are in gdb HEAD now.
75 --chastain 2003-08-21 */
79 /* Define a structure for the information that is common to all symbol types,
80 including minimal symbols, partial symbols, and full symbols. In a
81 multilanguage environment, some language specific information may need to
82 be recorded along with each symbol. */
84 /* This structure is space critical. See space comments at the top. */
86 struct general_symbol_info
88 /* Name of the symbol. This is a required field. Storage for the
89 name is allocated on the objfile_obstack for the associated
90 objfile. For languages like C++ that make a distinction between
91 the mangled name and demangled name, this is the mangled
96 /* Value of the symbol. Which member of this union to use, and what
97 it means, depends on what kind of symbol this is and its
98 SYMBOL_CLASS. See comments there for more details. All of these
99 are in host byte order (though what they point to might be in
100 target byte order, e.g. LOC_CONST_BYTES). */
104 /* The fact that this is a long not a LONGEST mainly limits the
105 range of a LOC_CONST. Since LOC_CONST_BYTES exists, I'm not
106 sure that is a big deal. */
115 /* for opaque typedef struct chain */
117 struct symbol
*chain
;
121 /* Since one and only one language can apply, wrap the language specific
122 information inside a union. */
126 struct cplus_specific
128 /* This is in fact used for C++, Java, and Objective C. */
129 char *demangled_name
;
135 /* Record the source code language that applies to this symbol.
136 This is used to select one of the fields from the language specific
139 ENUM_BITFIELD(language
) language
: 8;
141 /* Which section is this symbol in? This is an index into
142 section_offsets for this objfile. Negative means that the symbol
143 does not get relocated relative to a section.
144 Disclaimer: currently this is just used for xcoff, so don't
145 expect all symbol-reading code to set it correctly (the ELF code
146 also tries to set it correctly). */
150 /* The bfd section associated with this symbol. */
152 asection
*bfd_section
;
155 extern CORE_ADDR
symbol_overlayed_address (CORE_ADDR
, asection
*);
157 /* Note that all the following SYMBOL_* macros are used with the
158 SYMBOL argument being either a partial symbol, a minimal symbol or
159 a full symbol. All three types have a ginfo field. In particular
160 the SYMBOL_INIT_LANGUAGE_SPECIFIC, SYMBOL_DEMANGLED_NAME, etc.
161 macros cannot be entirely substituted by
162 functions, unless the callers are changed to pass in the ginfo
163 field only, instead of the SYMBOL parameter. */
165 #define DEPRECATED_SYMBOL_NAME(symbol) (symbol)->ginfo.name
166 #define SYMBOL_VALUE(symbol) (symbol)->ginfo.value.ivalue
167 #define SYMBOL_VALUE_ADDRESS(symbol) (symbol)->ginfo.value.address
168 #define SYMBOL_VALUE_BYTES(symbol) (symbol)->ginfo.value.bytes
169 #define SYMBOL_BLOCK_VALUE(symbol) (symbol)->ginfo.value.block
170 #define SYMBOL_VALUE_CHAIN(symbol) (symbol)->ginfo.value.chain
171 #define SYMBOL_LANGUAGE(symbol) (symbol)->ginfo.language
172 #define SYMBOL_SECTION(symbol) (symbol)->ginfo.section
173 #define SYMBOL_BFD_SECTION(symbol) (symbol)->ginfo.bfd_section
175 #define SYMBOL_CPLUS_DEMANGLED_NAME(symbol) \
176 (symbol)->ginfo.language_specific.cplus_specific.demangled_name
178 /* Initializes the language dependent portion of a symbol
179 depending upon the language for the symbol. */
180 #define SYMBOL_INIT_LANGUAGE_SPECIFIC(symbol,language) \
181 (symbol_init_language_specific (&(symbol)->ginfo, (language)))
182 extern void symbol_init_language_specific (struct general_symbol_info
*symbol
,
183 enum language language
);
185 #define SYMBOL_SET_NAMES(symbol,linkage_name,len,objfile) \
186 symbol_set_names (&(symbol)->ginfo, linkage_name, len, objfile)
187 extern void symbol_set_names (struct general_symbol_info
*symbol
,
188 const char *linkage_name
, int len
,
189 struct objfile
*objfile
);
191 /* Now come lots of name accessor macros. Short version as to when to
192 use which: Use SYMBOL_NATURAL_NAME to refer to the name of the
193 symbol in the original source code. Use SYMBOL_LINKAGE_NAME if you
194 want to know what the linker thinks the symbol's name is. Use
195 SYMBOL_PRINT_NAME for output. Use SYMBOL_DEMANGLED_NAME if you
196 specifically need to know whether SYMBOL_NATURAL_NAME and
197 SYMBOL_LINKAGE_NAME are different. Don't use
198 DEPRECATED_SYMBOL_NAME at all: instances of that macro should be
199 replaced by SYMBOL_NATURAL_NAME, SYMBOL_LINKAGE_NAME, or perhaps
200 SYMBOL_PRINT_NAME. */
202 /* Return SYMBOL's "natural" name, i.e. the name that it was called in
203 the original source code. In languages like C++ where symbols may
204 be mangled for ease of manipulation by the linker, this is the
207 #define SYMBOL_NATURAL_NAME(symbol) \
208 (symbol_natural_name (&(symbol)->ginfo))
209 extern char *symbol_natural_name (const struct general_symbol_info
*symbol
);
211 /* Return SYMBOL's name from the point of view of the linker. In
212 languages like C++ where symbols may be mangled for ease of
213 manipulation by the linker, this is the mangled name; otherwise,
214 it's the same as SYMBOL_NATURAL_NAME. This is currently identical
215 to DEPRECATED_SYMBOL_NAME, but please use SYMBOL_LINKAGE_NAME when
216 appropriate: it conveys the additional semantic information that
217 you really have thought about the issue and decided that you mean
218 SYMBOL_LINKAGE_NAME instead of SYMBOL_NATURAL_NAME. */
220 #define SYMBOL_LINKAGE_NAME(symbol) (symbol)->ginfo.name
222 /* Return the demangled name for a symbol based on the language for
223 that symbol. If no demangled name exists, return NULL. */
224 #define SYMBOL_DEMANGLED_NAME(symbol) \
225 (symbol_demangled_name (&(symbol)->ginfo))
226 extern char *symbol_demangled_name (struct general_symbol_info
*symbol
);
228 /* Macro that returns a version of the name of a symbol that is
229 suitable for output. In C++ this is the "demangled" form of the
230 name if demangle is on and the "mangled" form of the name if
231 demangle is off. In other languages this is just the symbol name.
232 The result should never be NULL. Don't use this for internal
233 purposes (e.g. storing in a hashtable): it's only suitable for
236 #define SYMBOL_PRINT_NAME(symbol) \
237 (demangle ? SYMBOL_NATURAL_NAME (symbol) : SYMBOL_LINKAGE_NAME (symbol))
239 /* Macro that tests a symbol for a match against a specified name string.
240 First test the unencoded name, then looks for and test a C++ encoded
241 name if it exists. Note that whitespace is ignored while attempting to
242 match a C++ encoded name, so that "foo::bar(int,long)" is the same as
243 "foo :: bar (int, long)".
244 Evaluates to zero if the match fails, or nonzero if it succeeds. */
246 /* Macro that tests a symbol for a match against a specified name
247 string. It tests against SYMBOL_NATURAL_NAME, and it ignores
248 whitespace and trailing parentheses. (See strcmp_iw for details
249 about its behavior.) */
251 #define SYMBOL_MATCHES_NATURAL_NAME(symbol, name) \
252 (strcmp_iw (SYMBOL_NATURAL_NAME (symbol), (name)) == 0)
254 /* Macro that returns the name to be used when sorting and searching symbols.
255 In C++, Chill, and Java, we search for the demangled form of a name,
256 and so sort symbols accordingly. In Ada, however, we search by mangled
257 name. If there is no distinct demangled name, then SYMBOL_SEARCH_NAME
258 returns the same value (same pointer) as SYMBOL_LINKAGE_NAME. */
259 #define SYMBOL_SEARCH_NAME(symbol) \
260 (symbol_search_name (&(symbol)->ginfo))
261 extern char *symbol_search_name (const struct general_symbol_info
*);
263 /* Analogous to SYMBOL_MATCHES_NATURAL_NAME, but uses the search
265 #define SYMBOL_MATCHES_SEARCH_NAME(symbol, name) \
266 (strcmp_iw (SYMBOL_SEARCH_NAME (symbol), (name)) == 0)
268 /* Classification types for a minimal symbol. These should be taken as
269 "advisory only", since if gdb can't easily figure out a
270 classification it simply selects mst_unknown. It may also have to
271 guess when it can't figure out which is a better match between two
272 types (mst_data versus mst_bss) for example. Since the minimal
273 symbol info is sometimes derived from the BFD library's view of a
274 file, we need to live with what information bfd supplies. */
276 enum minimal_symbol_type
278 mst_unknown
= 0, /* Unknown type, the default */
279 mst_text
, /* Generally executable instructions */
280 mst_data
, /* Generally initialized data */
281 mst_bss
, /* Generally uninitialized data */
282 mst_abs
, /* Generally absolute (nonrelocatable) */
283 /* GDB uses mst_solib_trampoline for the start address of a shared
284 library trampoline entry. Breakpoints for shared library functions
285 are put there if the shared library is not yet loaded.
286 After the shared library is loaded, lookup_minimal_symbol will
287 prefer the minimal symbol from the shared library (usually
288 a mst_text symbol) over the mst_solib_trampoline symbol, and the
289 breakpoints will be moved to their true address in the shared
290 library via breakpoint_re_set. */
291 mst_solib_trampoline
, /* Shared library trampoline code */
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 */
299 /* Define a simple structure used to hold some very basic information about
300 all defined global symbols (text, data, bss, abs, etc). The only required
301 information is the general_symbol_info.
303 In many cases, even if a file was compiled with no special options for
304 debugging at all, as long as was not stripped it will contain sufficient
305 information to build a useful minimal symbol table using this structure.
306 Even when a file contains enough debugging information to build a full
307 symbol table, these minimal symbols are still useful for quickly mapping
308 between names and addresses, and vice versa. They are also sometimes
309 used to figure out what full symbol table entries need to be read in. */
311 struct minimal_symbol
314 /* The general symbol info required for all types of symbols.
316 The SYMBOL_VALUE_ADDRESS contains the address that this symbol
319 struct general_symbol_info ginfo
;
321 /* The info field is available for caching machine-specific
322 information so it doesn't have to rederive the info constantly
323 (over a serial line). It is initialized to zero and stays that
324 way until target-dependent code sets it. Storage for any data
325 pointed to by this field should be allocated on the
326 objfile_obstack for the associated objfile. The type would be
327 "void *" except for reasons of compatibility with older
328 compilers. This field is optional.
330 Currently, the AMD 29000 tdep.c uses it to remember things it has decoded
331 from the instructions in the function header, and the MIPS-16 code uses
332 it to identify 16-bit procedures. */
336 /* Size of this symbol. end_psymtab in dbxread.c uses this
337 information to calculate the end of the partial symtab based on the
338 address of the last symbol plus the size of the last symbol. */
342 /* Which source file is this symbol in? Only relevant for mst_file_*. */
345 /* Classification type for this minimal symbol. */
347 ENUM_BITFIELD(minimal_symbol_type
) type
: 8;
349 /* Minimal symbols with the same hash key are kept on a linked
350 list. This is the link. */
352 struct minimal_symbol
*hash_next
;
354 /* Minimal symbols are stored in two different hash tables. This is
355 the `next' pointer for the demangled hash table. */
357 struct minimal_symbol
*demangled_hash_next
;
360 #define MSYMBOL_INFO(msymbol) (msymbol)->info
361 #define MSYMBOL_SIZE(msymbol) (msymbol)->size
362 #define MSYMBOL_TYPE(msymbol) (msymbol)->type
366 /* Represent one symbol name; a variable, constant, function or typedef. */
368 /* Different name domains for symbols. Looking up a symbol specifies a
369 domain and ignores symbol definitions in other name domains. */
371 typedef enum domain_enum_tag
373 /* UNDEF_DOMAIN is used when a domain has not been discovered or
374 none of the following apply. This usually indicates an error either
375 in the symbol information or in gdb's handling of symbols. */
379 /* VAR_DOMAIN is the usual domain. In C, this contains variables,
380 function names, typedef names and enum type values. */
384 /* STRUCT_DOMAIN is used in C to hold struct, union and enum type names.
385 Thus, if `struct foo' is used in a C program, it produces a symbol named
386 `foo' in the STRUCT_DOMAIN. */
390 /* LABEL_DOMAIN may be used for names of labels (for gotos);
391 currently it is not used and labels are not recorded at all. */
395 /* Searching domains. These overlap with VAR_DOMAIN, providing
396 some granularity with the search_symbols function. */
398 /* Everything in VAR_DOMAIN minus FUNCTIONS_-, TYPES_-, and
402 /* All functions -- for some reason not methods, though. */
405 /* All defined types */
408 /* All class methods -- why is this separated out? */
413 /* An address-class says where to find the value of a symbol. */
417 /* Not used; catches errors */
421 /* Value is constant int SYMBOL_VALUE, host byteorder */
425 /* Value is at fixed address SYMBOL_VALUE_ADDRESS */
429 /* Value is in register. SYMBOL_VALUE is the register number. */
433 /* It's an argument; the value is at SYMBOL_VALUE offset in arglist. */
437 /* Value address is at SYMBOL_VALUE offset in arglist. */
441 /* Value is in register number SYMBOL_VALUE. Just like LOC_REGISTER
442 except this is an argument. Probably the cleaner way to handle
443 this would be to separate address_class (which would include
444 separate ARG and LOCAL to deal with the frame's arguments
445 (get_frame_args_address) versus the frame's locals
446 (get_frame_locals_address), and an is_argument flag.
448 For some symbol formats (stabs, for some compilers at least),
449 the compiler generates two symbols, an argument and a register.
450 In some cases we combine them to a single LOC_REGPARM in symbol
451 reading, but currently not for all cases (e.g. it's passed on the
452 stack and then loaded into a register). */
456 /* Value is in specified register. Just like LOC_REGPARM except the
457 register holds the address of the argument instead of the argument
458 itself. This is currently used for the passing of structs and unions
459 on sparc and hppa. It is also used for call by reference where the
460 address is in a register, at least by mipsread.c. */
464 /* Value is a local variable at SYMBOL_VALUE offset in stack frame. */
468 /* Value not used; definition in SYMBOL_TYPE. Symbols in the domain
469 STRUCT_DOMAIN all have this class. */
473 /* Value is address SYMBOL_VALUE_ADDRESS in the code */
477 /* In a symbol table, value is SYMBOL_BLOCK_VALUE of a `struct block'.
478 In a partial symbol table, SYMBOL_VALUE_ADDRESS is the start address
479 of the block. Function names have this class. */
483 /* Value is a constant byte-sequence pointed to by SYMBOL_VALUE_BYTES, in
484 target byte order. */
488 /* Value is arg at SYMBOL_VALUE offset in stack frame. Differs from
489 LOC_LOCAL in that symbol is an argument; differs from LOC_ARG in
490 that we find it in the frame (get_frame_locals_address), not in
491 the arglist (get_frame_args_address). Added for i960, which
492 passes args in regs then copies to frame. */
496 /* Value is at SYMBOL_VALUE offset from the current value of
497 register number SYMBOL_BASEREG. This exists mainly for the same
498 things that LOC_LOCAL and LOC_ARG do; but we need to do this
499 instead because on 88k DWARF gives us the offset from the
500 frame/stack pointer, rather than the offset from the "canonical
501 frame address" used by COFF, stabs, etc., and we don't know how
502 to convert between these until we start examining prologues.
504 Note that LOC_BASEREG is much less general than a DWARF expression.
505 We don't need the generality (at least not yet), and storing a general
506 DWARF expression would presumably take up more space than the existing
511 /* Same as LOC_BASEREG but it is an argument. */
515 /* Value is at fixed address, but the address of the variable has
516 to be determined from the minimal symbol table whenever the
517 variable is referenced.
518 This happens if debugging information for a global symbol is
519 emitted and the corresponding minimal symbol is defined
520 in another object file or runtime common storage.
521 The linker might even remove the minimal symbol if the global
522 symbol is never referenced, in which case the symbol remains
527 /* Value is at a thread-specific location calculated by a
528 target-specific method. This is used only by hppa. */
530 LOC_HP_THREAD_LOCAL_STATIC
,
532 /* The variable does not actually exist in the program.
533 The value is ignored. */
537 /* The variable is static, but actually lives at * (address).
538 * I.e. do an extra indirection to get to it.
539 * This is used on HP-UX to get at globals that are allocated
540 * in shared libraries, where references from images other
541 * than the one where the global was allocated are done
542 * with a level of indirection.
547 /* The variable's address is computed by a set of location
548 functions (see "struct symbol_ops" below). */
551 /* Same as LOC_COMPUTED, but for function arguments. */
555 /* The methods needed to implement a symbol class. These methods can
556 use the symbol's .aux_value for additional per-symbol information.
558 At present this is only used to implement location expressions. */
563 /* Return the value of the variable SYMBOL, relative to the stack
564 frame FRAME. If the variable has been optimized out, return
567 Iff `read_needs_frame (SYMBOL)' is zero, then FRAME may be zero. */
569 struct value
*(*read_variable
) (struct symbol
* symbol
,
570 struct frame_info
* frame
);
572 /* Return non-zero if we need a frame to find the value of the SYMBOL. */
573 int (*read_needs_frame
) (struct symbol
* symbol
);
575 /* Write to STREAM a natural-language description of the location of
577 int (*describe_location
) (struct symbol
* symbol
, struct ui_file
* stream
);
579 /* Tracepoint support. Append bytecodes to the tracepoint agent
580 expression AX that push the address of the object SYMBOL. Set
581 VALUE appropriately. Note --- for objects in registers, this
582 needn't emit any code; as long as it sets VALUE properly, then
583 the caller will generate the right code in the process of
584 treating this as an lvalue or rvalue. */
586 void (*tracepoint_var_ref
) (struct symbol
* symbol
, struct agent_expr
* ax
,
587 struct axs_value
* value
);
590 /* This structure is space critical. See space comments at the top. */
595 /* The general symbol info required for all types of symbols. */
597 struct general_symbol_info ginfo
;
599 /* Data type of value */
603 /* The symbol table containing this symbol. This is the file
604 associated with LINE. */
605 struct symtab
*symtab
;
609 ENUM_BITFIELD(domain_enum_tag
) domain
: 6;
612 /* NOTE: cagney/2003-11-02: The fields "aclass" and "ops" contain
613 overlapping information. By creating a per-aclass ops vector, or
614 using the aclass as an index into an ops table, the aclass and
615 ops fields can be merged. The latter, for instance, would shave
616 32-bits from each symbol (relative to a symbol lookup, any table
617 index overhead would be in the noise). */
619 ENUM_BITFIELD(address_class
) aclass
: 6;
621 /* Line number of definition. FIXME: Should we really make the assumption
622 that nobody will try to debug files longer than 64K lines? What about
623 machine generated programs? */
627 /* Method's for symbol's of this class. */
628 /* NOTE: cagney/2003-11-02: See comment above attached to "aclass". */
630 const struct symbol_ops
*ops
;
632 /* Some symbols require additional information to be recorded on a
633 per-symbol basis. Stash those values here. */
637 /* Used by LOC_BASEREG and LOC_BASEREG_ARG. */
639 /* An arbitrary data pointer. Note that this data must be
640 allocated using the same obstack as the symbol itself. */
641 /* So far it is only used by LOC_COMPUTED and LOC_COMPUTED_ARG to
642 find the location information. For a LOC_BLOCK symbol
643 for a function in a compilation unit compiled with DWARF 2
644 information, this is information used internally by the DWARF 2
645 code --- specifically, the location expression for the frame
646 base for this function. */
647 /* FIXME drow/2003-02-21: For the LOC_BLOCK case, it might be better
648 to add a magic symbol to the block containing this information,
649 or to have a generic debug info annotation slot for symbols. */
654 struct symbol
*hash_next
;
658 #define SYMBOL_DOMAIN(symbol) (symbol)->domain
659 #define SYMBOL_CLASS(symbol) (symbol)->aclass
660 #define SYMBOL_TYPE(symbol) (symbol)->type
661 #define SYMBOL_LINE(symbol) (symbol)->line
662 #define SYMBOL_SYMTAB(symbol) (symbol)->symtab
663 #define SYMBOL_BASEREG(symbol) (symbol)->aux_value.basereg
664 #define SYMBOL_OPS(symbol) (symbol)->ops
665 #define SYMBOL_LOCATION_BATON(symbol) (symbol)->aux_value.ptr
667 /* A partial_symbol records the name, domain, and address class of
668 symbols whose types we have not parsed yet. For functions, it also
669 contains their memory address, so we can find them from a PC value.
670 Each partial_symbol sits in a partial_symtab, all of which are chained
671 on a partial symtab list and which points to the corresponding
672 normal symtab once the partial_symtab has been referenced. */
674 /* This structure is space critical. See space comments at the top. */
676 struct partial_symbol
679 /* The general symbol info required for all types of symbols. */
681 struct general_symbol_info ginfo
;
683 /* Name space code. */
685 ENUM_BITFIELD(domain_enum_tag
) domain
: 6;
687 /* Address class (for info_symbols) */
689 ENUM_BITFIELD(address_class
) aclass
: 6;
693 #define PSYMBOL_DOMAIN(psymbol) (psymbol)->domain
694 #define PSYMBOL_CLASS(psymbol) (psymbol)->aclass
697 /* Each item represents a line-->pc (or the reverse) mapping. This is
698 somewhat more wasteful of space than one might wish, but since only
699 the files which are actually debugged are read in to core, we don't
702 struct linetable_entry
708 /* The order of entries in the linetable is significant. They should
709 be sorted by increasing values of the pc field. If there is more than
710 one entry for a given pc, then I'm not sure what should happen (and
711 I not sure whether we currently handle it the best way).
713 Example: a C for statement generally looks like this
715 10 0x100 - for the init/test part of a for stmt.
718 10 0x400 - for the increment part of a for stmt.
720 If an entry has a line number of zero, it marks the start of a PC
721 range for which no line number information is available. It is
722 acceptable, though wasteful of table space, for such a range to be
729 /* Actually NITEMS elements. If you don't like this use of the
730 `struct hack', you can shove it up your ANSI (seriously, if the
731 committee tells us how to do it, we can probably go along). */
732 struct linetable_entry item
[1];
735 /* How to relocate the symbols from each section in a symbol file.
736 Each struct contains an array of offsets.
737 The ordering and meaning of the offsets is file-type-dependent;
738 typically it is indexed by section numbers or symbol types or
741 To give us flexibility in changing the internal representation
742 of these offsets, the ANOFFSET macro must be used to insert and
743 extract offset values in the struct. */
745 struct section_offsets
747 CORE_ADDR offsets
[1]; /* As many as needed. */
750 #define ANOFFSET(secoff, whichone) \
752 ? (internal_error (__FILE__, __LINE__, _("Section index is uninitialized")), -1) \
753 : secoff->offsets[whichone])
755 /* The size of a section_offsets table for N sections. */
756 #define SIZEOF_N_SECTION_OFFSETS(n) \
757 (sizeof (struct section_offsets) \
758 + sizeof (((struct section_offsets *) 0)->offsets) * ((n)-1))
760 /* Each source file or header is represented by a struct symtab.
761 These objects are chained through the `next' field. */
766 /* Chain of all existing symtabs. */
770 /* List of all symbol scope blocks for this symtab. May be shared
771 between different symtabs (and normally is for all the symtabs
772 in a given compilation unit). */
774 struct blockvector
*blockvector
;
776 /* Table mapping core addresses to line numbers for this file.
777 Can be NULL if none. Never shared between different symtabs. */
779 struct linetable
*linetable
;
781 /* Section in objfile->section_offsets for the blockvector and
782 the linetable. Probably always SECT_OFF_TEXT. */
784 int block_line_section
;
786 /* If several symtabs share a blockvector, exactly one of them
787 should be designated the primary, so that the blockvector
788 is relocated exactly once by objfile_relocate. */
792 /* The macro table for this symtab. Like the blockvector, this
793 may be shared between different symtabs --- and normally is for
794 all the symtabs in a given compilation unit. */
795 struct macro_table
*macro_table
;
797 /* Name of this source file. */
801 /* Directory in which it was compiled, or NULL if we don't know. */
805 /* This component says how to free the data we point to:
806 free_nothing => do nothing; some other symtab will free
807 the data this one uses.
808 free_linetable => free just the linetable. FIXME: Is this redundant
809 with the primary field? */
813 free_nothing
, free_linetable
817 /* A function to call to free space, if necessary. This is IN
818 ADDITION to the action indicated by free_code. */
820 void (*free_func
)(struct symtab
*symtab
);
822 /* Total number of lines found in source file. */
826 /* line_charpos[N] is the position of the (N-1)th line of the
827 source file. "position" means something we can lseek() to; it
828 is not guaranteed to be useful any other way. */
832 /* Language of this source file. */
834 enum language language
;
836 /* String that identifies the format of the debugging information, such
837 as "stabs", "dwarf 1", "dwarf 2", "coff", etc. This is mostly useful
838 for automated testing of gdb but may also be information that is
839 useful to the user. */
843 /* String of producer version information. May be zero. */
847 /* Full name of file as found by searching the source path.
848 NULL if not yet known. */
852 /* Object file from which this symbol information was read. */
854 struct objfile
*objfile
;
858 #define BLOCKVECTOR(symtab) (symtab)->blockvector
859 #define LINETABLE(symtab) (symtab)->linetable
862 /* Each source file that has not been fully read in is represented by
863 a partial_symtab. This contains the information on where in the
864 executable the debugging symbols for a specific file are, and a
865 list of names of global symbols which are located in this file.
866 They are all chained on partial symtab lists.
868 Even after the source file has been read into a symtab, the
869 partial_symtab remains around. They are allocated on an obstack,
870 objfile_obstack. FIXME, this is bad for dynamic linking or VxWorks-
871 style execution of a bunch of .o's. */
873 struct partial_symtab
876 /* Chain of all existing partial symtabs. */
878 struct partial_symtab
*next
;
880 /* Name of the source file which this partial_symtab defines */
884 /* Full path of the source file. NULL if not known. */
888 /* Directory in which it was compiled, or NULL if we don't know. */
892 /* Information about the object file from which symbols should be read. */
894 struct objfile
*objfile
;
896 /* Set of relocation offsets to apply to each section. */
898 struct section_offsets
*section_offsets
;
900 /* Range of text addresses covered by this file; texthigh is the
901 beginning of the next section. */
906 /* Array of pointers to all of the partial_symtab's which this one
907 depends on. Since this array can only be set to previous or
908 the current (?) psymtab, this dependency tree is guaranteed not
909 to have any loops. "depends on" means that symbols must be read
910 for the dependencies before being read for this psymtab; this is
911 for type references in stabs, where if foo.c includes foo.h, declarations
912 in foo.h may use type numbers defined in foo.c. For other debugging
913 formats there may be no need to use dependencies. */
915 struct partial_symtab
**dependencies
;
917 int number_of_dependencies
;
919 /* Global symbol list. This list will be sorted after readin to
920 improve access. Binary search will be the usual method of
921 finding a symbol within it. globals_offset is an integer offset
922 within global_psymbols[]. */
927 /* Static symbol list. This list will *not* be sorted after readin;
928 to find a symbol in it, exhaustive search must be used. This is
929 reasonable because searches through this list will eventually
930 lead to either the read in of a files symbols for real (assumed
931 to take a *lot* of time; check) or an error (and we don't care
932 how long errors take). This is an offset and size within
933 static_psymbols[]. */
938 /* Pointer to symtab eventually allocated for this source file, 0 if
939 !readin or if we haven't looked for the symtab after it was readin. */
941 struct symtab
*symtab
;
943 /* Pointer to function which will read in the symtab corresponding to
946 void (*read_symtab
) (struct partial_symtab
*);
948 /* Information that lets read_symtab() locate the part of the symbol table
949 that this psymtab corresponds to. This information is private to the
950 format-dependent symbol reading routines. For further detail examine
951 the various symbol reading modules. Should really be (void *) but is
952 (char *) as with other such gdb variables. (FIXME) */
954 char *read_symtab_private
;
956 /* Non-zero if the symtab corresponding to this psymtab has been readin */
958 unsigned char readin
;
961 /* A fast way to get from a psymtab to its symtab (after the first time). */
962 #define PSYMTAB_TO_SYMTAB(pst) \
963 ((pst) -> symtab != NULL ? (pst) -> symtab : psymtab_to_symtab (pst))
966 /* The virtual function table is now an array of structures which have the
967 form { int16 offset, delta; void *pfn; }.
969 In normal virtual function tables, OFFSET is unused.
970 DELTA is the amount which is added to the apparent object's base
971 address in order to point to the actual object to which the
972 virtual function should be applied.
973 PFN is a pointer to the virtual function.
975 Note that this macro is g++ specific (FIXME). */
977 #define VTBL_FNADDR_OFFSET 2
979 /* External variables and functions for the objects described above. */
981 /* See the comment in symfile.c about how current_objfile is used. */
983 extern struct objfile
*current_objfile
;
985 /* True if we are nested inside psymtab_to_symtab. */
987 extern int currently_reading_symtab
;
991 extern int asm_demangle
;
993 /* symtab.c lookup functions */
995 extern const char multiple_symbols_ask
[];
996 extern const char multiple_symbols_all
[];
997 extern const char multiple_symbols_cancel
[];
999 const char *multiple_symbols_select_mode (void);
1001 int symbol_matches_domain (enum language symbol_language
,
1002 domain_enum symbol_domain
,
1003 domain_enum domain
);
1005 /* lookup a symbol table by source file name */
1007 extern struct symtab
*lookup_symtab (const char *);
1009 /* lookup a symbol by name (optional block, optional symtab) in language */
1011 extern struct symbol
*lookup_symbol_in_language (const char *,
1012 const struct block
*,
1018 /* lookup a symbol by name (optional block, optional symtab)
1019 in the current language */
1021 extern struct symbol
*lookup_symbol (const char *, const struct block
*,
1022 const domain_enum
, int *,
1025 /* A default version of lookup_symbol_nonlocal for use by languages
1026 that can't think of anything better to do. */
1028 extern struct symbol
*basic_lookup_symbol_nonlocal (const char *,
1030 const struct block
*,
1034 /* Some helper functions for languages that need to write their own
1035 lookup_symbol_nonlocal functions. */
1037 /* Lookup a symbol in the static block associated to BLOCK, if there
1038 is one; do nothing if BLOCK is NULL or a global block. */
1040 extern struct symbol
*lookup_symbol_static (const char *name
,
1041 const char *linkage_name
,
1042 const struct block
*block
,
1043 const domain_enum domain
,
1044 struct symtab
**symtab
);
1046 /* Lookup a symbol in all files' global blocks (searching psymtabs if
1049 extern struct symbol
*lookup_symbol_global (const char *name
,
1050 const char *linkage_name
,
1051 const struct block
*block
,
1052 const domain_enum domain
,
1053 struct symtab
**symtab
);
1055 /* Lookup a symbol within the block BLOCK. This, unlike
1056 lookup_symbol_block, will set SYMTAB and BLOCK_FOUND correctly, and
1057 will fix up the symbol if necessary. */
1059 extern struct symbol
*lookup_symbol_aux_block (const char *name
,
1060 const char *linkage_name
,
1061 const struct block
*block
,
1062 const domain_enum domain
,
1063 struct symtab
**symtab
);
1065 /* Lookup a partial symbol. */
1067 extern struct partial_symbol
*lookup_partial_symbol (struct partial_symtab
*,
1072 /* lookup a symbol by name, within a specified block */
1074 extern struct symbol
*lookup_block_symbol (const struct block
*, const char *,
1078 /* lookup a [struct, union, enum] by name, within a specified block */
1080 extern struct type
*lookup_struct (char *, struct block
*);
1082 extern struct type
*lookup_union (char *, struct block
*);
1084 extern struct type
*lookup_enum (char *, struct block
*);
1086 /* from blockframe.c: */
1088 /* lookup the function symbol corresponding to the address */
1090 extern struct symbol
*find_pc_function (CORE_ADDR
);
1092 /* lookup the function corresponding to the address and section */
1094 extern struct symbol
*find_pc_sect_function (CORE_ADDR
, asection
*);
1096 /* lookup function from address, return name, start addr and end addr */
1098 extern int find_pc_partial_function (CORE_ADDR
, char **, CORE_ADDR
*,
1101 extern void clear_pc_function_cache (void);
1103 /* from symtab.c: */
1105 /* lookup partial symbol table by filename */
1107 extern struct partial_symtab
*lookup_partial_symtab (const char *);
1109 /* lookup partial symbol table by address */
1111 extern struct partial_symtab
*find_pc_psymtab (CORE_ADDR
);
1113 /* lookup partial symbol table by address and section */
1115 extern struct partial_symtab
*find_pc_sect_psymtab (CORE_ADDR
, asection
*);
1117 /* lookup full symbol table by address */
1119 extern struct symtab
*find_pc_symtab (CORE_ADDR
);
1121 /* lookup full symbol table by address and section */
1123 extern struct symtab
*find_pc_sect_symtab (CORE_ADDR
, asection
*);
1125 /* lookup partial symbol by address */
1127 extern struct partial_symbol
*find_pc_psymbol (struct partial_symtab
*,
1130 /* lookup partial symbol by address and section */
1132 extern struct partial_symbol
*find_pc_sect_psymbol (struct partial_symtab
*,
1133 CORE_ADDR
, asection
*);
1135 extern int find_pc_line_pc_range (CORE_ADDR
, CORE_ADDR
*, CORE_ADDR
*);
1137 extern void reread_symbols (void);
1139 extern struct type
*lookup_transparent_type (const char *);
1140 extern struct type
*basic_lookup_transparent_type (const char *);
1143 /* Macro for name of symbol to indicate a file compiled with gcc. */
1144 #ifndef GCC_COMPILED_FLAG_SYMBOL
1145 #define GCC_COMPILED_FLAG_SYMBOL "gcc_compiled."
1148 /* Macro for name of symbol to indicate a file compiled with gcc2. */
1149 #ifndef GCC2_COMPILED_FLAG_SYMBOL
1150 #define GCC2_COMPILED_FLAG_SYMBOL "gcc2_compiled."
1153 /* Functions for dealing with the minimal symbol table, really a misc
1154 address<->symbol mapping for things we don't have debug symbols for. */
1156 extern void prim_record_minimal_symbol (const char *, CORE_ADDR
,
1157 enum minimal_symbol_type
,
1160 extern struct minimal_symbol
*prim_record_minimal_symbol_and_info
1161 (const char *, CORE_ADDR
,
1162 enum minimal_symbol_type
,
1163 char *info
, int section
, asection
* bfd_section
, struct objfile
*);
1165 extern unsigned int msymbol_hash_iw (const char *);
1167 extern unsigned int msymbol_hash (const char *);
1169 extern struct objfile
* msymbol_objfile (struct minimal_symbol
*sym
);
1172 add_minsym_to_hash_table (struct minimal_symbol
*sym
,
1173 struct minimal_symbol
**table
);
1175 extern struct minimal_symbol
*lookup_minimal_symbol (const char *,
1179 extern struct minimal_symbol
*lookup_minimal_symbol_text (const char *,
1182 struct minimal_symbol
*lookup_minimal_symbol_solib_trampoline (const char *,
1186 extern struct minimal_symbol
*lookup_minimal_symbol_by_pc (CORE_ADDR
);
1188 extern struct minimal_symbol
*lookup_minimal_symbol_by_pc_section (CORE_ADDR
,
1192 extern struct minimal_symbol
1193 *lookup_solib_trampoline_symbol_by_pc (CORE_ADDR
);
1195 extern CORE_ADDR
find_solib_trampoline_target (struct frame_info
*, CORE_ADDR
);
1197 extern void init_minimal_symbol_collection (void);
1199 extern struct cleanup
*make_cleanup_discard_minimal_symbols (void);
1201 extern void install_minimal_symbols (struct objfile
*);
1203 /* Sort all the minimal symbols in OBJFILE. */
1205 extern void msymbols_sort (struct objfile
*objfile
);
1207 struct symtab_and_line
1209 struct symtab
*symtab
;
1211 /* Line number. Line numbers start at 1 and proceed through symtab->nlines.
1212 0 is never a valid line number; it is used to indicate that line number
1213 information is not available. */
1222 extern void init_sal (struct symtab_and_line
*sal
);
1224 struct symtabs_and_lines
1226 struct symtab_and_line
*sals
;
1232 /* Some types and macros needed for exception catchpoints.
1233 Can't put these in target.h because symtab_and_line isn't
1234 known there. This file will be included by breakpoint.c,
1235 hppa-tdep.c, etc. */
1237 /* Enums for exception-handling support */
1238 enum exception_event_kind
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
find_pc_line (CORE_ADDR
, int);
1251 /* Same function, but specify a section as well as an address */
1253 extern struct symtab_and_line
find_pc_sect_line (CORE_ADDR
, asection
*, int);
1255 /* Given a symtab and line number, return the pc there. */
1257 extern int find_line_pc (struct symtab
*, int, CORE_ADDR
*);
1259 extern int find_line_pc_range (struct symtab_and_line
, CORE_ADDR
*,
1262 extern void resolve_sal_pc (struct symtab_and_line
*);
1264 /* Given a string, return the line specified by it. For commands like "list"
1265 and "breakpoint". */
1267 extern struct symtabs_and_lines
decode_line_spec (char *, int);
1269 extern struct symtabs_and_lines
decode_line_spec_1 (char *, int);
1273 void maintenance_print_symbols (char *, int);
1275 void maintenance_print_psymbols (char *, int);
1277 void maintenance_print_msymbols (char *, int);
1279 void maintenance_print_objfiles (char *, int);
1281 void maintenance_info_symtabs (char *, int);
1283 void maintenance_info_psymtabs (char *, int);
1285 void maintenance_check_symtabs (char *, int);
1289 void maintenance_print_statistics (char *, int);
1291 extern void free_symtab (struct symtab
*);
1293 /* Symbol-reading stuff in symfile.c and solib.c. */
1295 extern struct symtab
*psymtab_to_symtab (struct partial_symtab
*);
1297 extern void clear_solib (void);
1301 extern int identify_source_line (struct symtab
*, int, int, CORE_ADDR
);
1303 extern void print_source_lines (struct symtab
*, int, int, int);
1305 extern void forget_cached_source_info (void);
1307 extern void select_source_symtab (struct symtab
*);
1309 extern char **default_make_symbol_completion_list (char *, char *);
1310 extern char **make_symbol_completion_list (char *, char *);
1312 extern char **make_file_symbol_completion_list (char *, char *, char *);
1314 extern char **make_source_files_completion_list (char *, char *);
1318 int matching_bfd_sections (asection
*, asection
*);
1320 extern struct partial_symtab
*find_main_psymtab (void);
1322 extern struct symtab
*find_line_symtab (struct symtab
*, int, int *, int *);
1324 extern CORE_ADDR
find_function_start_pc (struct gdbarch
*,
1325 CORE_ADDR
, asection
*);
1327 extern struct symtab_and_line
find_function_start_sal (struct symbol
*sym
,
1332 extern void clear_symtab_users (void);
1334 extern enum language
deduce_language_from_filename (char *);
1338 extern int in_prologue (CORE_ADDR pc
, CORE_ADDR func_start
);
1340 extern CORE_ADDR
skip_prologue_using_sal (CORE_ADDR func_addr
);
1342 extern struct symbol
*fixup_symbol_section (struct symbol
*,
1345 extern struct partial_symbol
*fixup_psymbol_section (struct partial_symbol
1347 struct objfile
*objfile
);
1349 /* Symbol searching */
1351 /* When using search_symbols, a list of the following structs is returned.
1352 Callers must free the search list using free_search_symbols! */
1353 struct symbol_search
1355 /* The block in which the match was found. Could be, for example,
1356 STATIC_BLOCK or GLOBAL_BLOCK. */
1359 /* Information describing what was found.
1361 If symtab abd symbol are NOT NULL, then information was found
1363 struct symtab
*symtab
;
1364 struct symbol
*symbol
;
1366 /* If msymbol is non-null, then a match was made on something for
1367 which only minimal_symbols exist. */
1368 struct minimal_symbol
*msymbol
;
1370 /* A link to the next match, or NULL for the end. */
1371 struct symbol_search
*next
;
1374 extern void search_symbols (char *, domain_enum
, int, char **,
1375 struct symbol_search
**);
1376 extern void free_search_symbols (struct symbol_search
*);
1377 extern struct cleanup
*make_cleanup_free_search_symbols (struct symbol_search
1380 /* The name of the ``main'' function.
1381 FIXME: cagney/2001-03-20: Can't make main_name() const since some
1382 of the calling code currently assumes that the string isn't
1384 extern void set_main_name (const char *name
);
1385 extern /*const */ char *main_name (void);
1387 /* Check global symbols in objfile. */
1388 struct symbol
*lookup_global_symbol_from_objfile (const struct objfile
*objfile
,
1390 const char *linkage_name
,
1391 const domain_enum domain
,
1392 struct symtab
**symtab
);
1394 extern struct symtabs_and_lines
1395 expand_line_sal (struct symtab_and_line sal
);
1397 #endif /* !defined(SYMTAB_H) */