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
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)
27 /* Opaque declarations. */
38 /* Some of the structures in this file are space critical.
39 The space-critical structures are:
41 struct general_symbol_info
45 These structures are laid out to encourage good packing.
46 They use ENUM_BITFIELD and short int fields, and they order the
47 structure members so that fields less than a word are next
48 to each other so they can be packed together. */
50 /* Rearranged: used ENUM_BITFIELD and rearranged field order in
51 all the space critical structures (plus struct minimal_symbol).
52 Memory usage dropped from 99360768 bytes to 90001408 bytes.
53 I measured this with before-and-after tests of
54 "HEAD-old-gdb -readnow HEAD-old-gdb" and
55 "HEAD-new-gdb -readnow HEAD-old-gdb" on native i686-pc-linux-gnu,
56 red hat linux 8, with LD_LIBRARY_PATH=/usr/lib/debug,
57 typing "maint space 1" at the first command prompt.
59 Here is another measurement (from andrew c):
60 # no /usr/lib/debug, just plain glibc, like a normal user
62 (gdb) break internal_error
64 (gdb) maint internal-error
68 gdb gdb_6_0_branch 2003-08-19 space used: 8896512
69 gdb HEAD 2003-08-19 space used: 8904704
70 gdb HEAD 2003-08-21 space used: 8396800 (+symtab.h)
71 gdb HEAD 2003-08-21 space used: 8265728 (+gdbtypes.h)
73 The third line shows the savings from the optimizations in symtab.h.
74 The fourth line shows the savings from the optimizations in
75 gdbtypes.h. Both optimizations are in gdb HEAD now.
77 --chastain 2003-08-21 */
81 /* Define a structure for the information that is common to all symbol types,
82 including minimal symbols, partial symbols, and full symbols. In a
83 multilanguage environment, some language specific information may need to
84 be recorded along with each symbol. */
86 /* This structure is space critical. See space comments at the top. */
88 struct general_symbol_info
90 /* Name of the symbol. This is a required field. Storage for the
91 name is allocated on the objfile_obstack for the associated
92 objfile. For languages like C++ that make a distinction between
93 the mangled name and demangled name, this is the mangled
98 /* Value of the symbol. Which member of this union to use, and what
99 it means, depends on what kind of symbol this is and its
100 SYMBOL_CLASS. See comments there for more details. All of these
101 are in host byte order (though what they point to might be in
102 target byte order, e.g. LOC_CONST_BYTES). */
106 /* The fact that this is a long not a LONGEST mainly limits the
107 range of a LOC_CONST. Since LOC_CONST_BYTES exists, I'm not
108 sure that is a big deal. */
117 /* for opaque typedef struct chain */
119 struct symbol
*chain
;
123 /* Since one and only one language can apply, wrap the language specific
124 information inside a union. */
128 struct cplus_specific
130 /* This is in fact used for C++, Java, and Objective C. */
131 char *demangled_name
;
137 /* Record the source code language that applies to this symbol.
138 This is used to select one of the fields from the language specific
141 ENUM_BITFIELD(language
) language
: 8;
143 /* Which section is this symbol in? This is an index into
144 section_offsets for this objfile. Negative means that the symbol
145 does not get relocated relative to a section.
146 Disclaimer: currently this is just used for xcoff, so don't
147 expect all symbol-reading code to set it correctly (the ELF code
148 also tries to set it correctly). */
152 /* The bfd section associated with this symbol. */
154 asection
*bfd_section
;
157 extern CORE_ADDR
symbol_overlayed_address (CORE_ADDR
, asection
*);
159 /* Note that all the following SYMBOL_* macros are used with the
160 SYMBOL argument being either a partial symbol, a minimal symbol or
161 a full symbol. All three types have a ginfo field. In particular
162 the SYMBOL_INIT_LANGUAGE_SPECIFIC, SYMBOL_INIT_DEMANGLED_NAME,
163 SYMBOL_DEMANGLED_NAME macros cannot be entirely substituted by
164 functions, unless the callers are changed to pass in the ginfo
165 field only, instead of the SYMBOL parameter. */
167 #define DEPRECATED_SYMBOL_NAME(symbol) (symbol)->ginfo.name
168 #define SYMBOL_VALUE(symbol) (symbol)->ginfo.value.ivalue
169 #define SYMBOL_VALUE_ADDRESS(symbol) (symbol)->ginfo.value.address
170 #define SYMBOL_VALUE_BYTES(symbol) (symbol)->ginfo.value.bytes
171 #define SYMBOL_BLOCK_VALUE(symbol) (symbol)->ginfo.value.block
172 #define SYMBOL_VALUE_CHAIN(symbol) (symbol)->ginfo.value.chain
173 #define SYMBOL_LANGUAGE(symbol) (symbol)->ginfo.language
174 #define SYMBOL_SECTION(symbol) (symbol)->ginfo.section
175 #define SYMBOL_BFD_SECTION(symbol) (symbol)->ginfo.bfd_section
177 #define SYMBOL_CPLUS_DEMANGLED_NAME(symbol) \
178 (symbol)->ginfo.language_specific.cplus_specific.demangled_name
180 /* Initializes the language dependent portion of a symbol
181 depending upon the language for the symbol. */
182 #define SYMBOL_INIT_LANGUAGE_SPECIFIC(symbol,language) \
183 (symbol_init_language_specific (&(symbol)->ginfo, (language)))
184 extern void symbol_init_language_specific (struct general_symbol_info
*symbol
,
185 enum language language
);
187 #define SYMBOL_INIT_DEMANGLED_NAME(symbol,obstack) \
188 (symbol_init_demangled_name (&(symbol)->ginfo, (obstack)))
189 extern void symbol_init_demangled_name (struct general_symbol_info
*symbol
,
190 struct obstack
*obstack
);
192 #define SYMBOL_SET_NAMES(symbol,linkage_name,len,objfile) \
193 symbol_set_names (&(symbol)->ginfo, linkage_name, len, objfile)
194 extern void symbol_set_names (struct general_symbol_info
*symbol
,
195 const char *linkage_name
, int len
,
196 struct objfile
*objfile
);
198 /* Now come lots of name accessor macros. Short version as to when to
199 use which: Use SYMBOL_NATURAL_NAME to refer to the name of the
200 symbol in the original source code. Use SYMBOL_LINKAGE_NAME if you
201 want to know what the linker thinks the symbol's name is. Use
202 SYMBOL_PRINT_NAME for output. Use SYMBOL_DEMANGLED_NAME if you
203 specifically need to know whether SYMBOL_NATURAL_NAME and
204 SYMBOL_LINKAGE_NAME are different. Don't use
205 DEPRECATED_SYMBOL_NAME at all: instances of that macro should be
206 replaced by SYMBOL_NATURAL_NAME, SYMBOL_LINKAGE_NAME, or perhaps
207 SYMBOL_PRINT_NAME. */
209 /* Return SYMBOL's "natural" name, i.e. the name that it was called in
210 the original source code. In languages like C++ where symbols may
211 be mangled for ease of manipulation by the linker, this is the
214 #define SYMBOL_NATURAL_NAME(symbol) \
215 (symbol_natural_name (&(symbol)->ginfo))
216 extern char *symbol_natural_name (const struct general_symbol_info
*symbol
);
218 /* Return SYMBOL's name from the point of view of the linker. In
219 languages like C++ where symbols may be mangled for ease of
220 manipulation by the linker, this is the mangled name; otherwise,
221 it's the same as SYMBOL_NATURAL_NAME. This is currently identical
222 to DEPRECATED_SYMBOL_NAME, but please use SYMBOL_LINKAGE_NAME when
223 appropriate: it conveys the additional semantic information that
224 you really have thought about the issue and decided that you mean
225 SYMBOL_LINKAGE_NAME instead of SYMBOL_NATURAL_NAME. */
227 #define SYMBOL_LINKAGE_NAME(symbol) (symbol)->ginfo.name
229 /* Return the demangled name for a symbol based on the language for
230 that symbol. If no demangled name exists, return NULL. */
231 #define SYMBOL_DEMANGLED_NAME(symbol) \
232 (symbol_demangled_name (&(symbol)->ginfo))
233 extern char *symbol_demangled_name (struct general_symbol_info
*symbol
);
235 /* Macro that returns a version of the name of a symbol that is
236 suitable for output. In C++ this is the "demangled" form of the
237 name if demangle is on and the "mangled" form of the name if
238 demangle is off. In other languages this is just the symbol name.
239 The result should never be NULL. Don't use this for internal
240 purposes (e.g. storing in a hashtable): it's only suitable for
243 #define SYMBOL_PRINT_NAME(symbol) \
244 (demangle ? SYMBOL_NATURAL_NAME (symbol) : SYMBOL_LINKAGE_NAME (symbol))
246 /* Macro that tests a symbol for a match against a specified name string.
247 First test the unencoded name, then looks for and test a C++ encoded
248 name if it exists. Note that whitespace is ignored while attempting to
249 match a C++ encoded name, so that "foo::bar(int,long)" is the same as
250 "foo :: bar (int, long)".
251 Evaluates to zero if the match fails, or nonzero if it succeeds. */
253 /* Macro that tests a symbol for a match against a specified name
254 string. It tests against SYMBOL_NATURAL_NAME, and it ignores
255 whitespace and trailing parentheses. (See strcmp_iw for details
256 about its behavior.) */
258 #define SYMBOL_MATCHES_NATURAL_NAME(symbol, name) \
259 (strcmp_iw (SYMBOL_NATURAL_NAME (symbol), (name)) == 0)
261 /* Macro that returns the name to be used when sorting and searching symbols.
262 In C++, Chill, and Java, we search for the demangled form of a name,
263 and so sort symbols accordingly. In Ada, however, we search by mangled
264 name. If there is no distinct demangled name, then SYMBOL_SEARCH_NAME
265 returns the same value (same pointer) as SYMBOL_LINKAGE_NAME. */
266 #define SYMBOL_SEARCH_NAME(symbol) \
267 (symbol_search_name (&(symbol)->ginfo))
268 extern char *symbol_search_name (const struct general_symbol_info
*);
270 /* Analogous to SYMBOL_MATCHES_NATURAL_NAME, but uses the search
272 #define SYMBOL_MATCHES_SEARCH_NAME(symbol, name) \
273 (strcmp_iw (SYMBOL_SEARCH_NAME (symbol), (name)) == 0)
275 /* Classification types for a minimal symbol. These should be taken as
276 "advisory only", since if gdb can't easily figure out a
277 classification it simply selects mst_unknown. It may also have to
278 guess when it can't figure out which is a better match between two
279 types (mst_data versus mst_bss) for example. Since the minimal
280 symbol info is sometimes derived from the BFD library's view of a
281 file, we need to live with what information bfd supplies. */
283 enum minimal_symbol_type
285 mst_unknown
= 0, /* Unknown type, the default */
286 mst_text
, /* Generally executable instructions */
287 mst_data
, /* Generally initialized data */
288 mst_bss
, /* Generally uninitialized data */
289 mst_abs
, /* Generally absolute (nonrelocatable) */
290 /* GDB uses mst_solib_trampoline for the start address of a shared
291 library trampoline entry. Breakpoints for shared library functions
292 are put there if the shared library is not yet loaded.
293 After the shared library is loaded, lookup_minimal_symbol will
294 prefer the minimal symbol from the shared library (usually
295 a mst_text symbol) over the mst_solib_trampoline symbol, and the
296 breakpoints will be moved to their true address in the shared
297 library via breakpoint_re_set. */
298 mst_solib_trampoline
, /* Shared library trampoline code */
299 /* For the mst_file* types, the names are only guaranteed to be unique
300 within a given .o file. */
301 mst_file_text
, /* Static version of mst_text */
302 mst_file_data
, /* Static version of mst_data */
303 mst_file_bss
/* Static version of mst_bss */
306 /* Define a simple structure used to hold some very basic information about
307 all defined global symbols (text, data, bss, abs, etc). The only required
308 information is the general_symbol_info.
310 In many cases, even if a file was compiled with no special options for
311 debugging at all, as long as was not stripped it will contain sufficient
312 information to build a useful minimal symbol table using this structure.
313 Even when a file contains enough debugging information to build a full
314 symbol table, these minimal symbols are still useful for quickly mapping
315 between names and addresses, and vice versa. They are also sometimes
316 used to figure out what full symbol table entries need to be read in. */
318 struct minimal_symbol
321 /* The general symbol info required for all types of symbols.
323 The SYMBOL_VALUE_ADDRESS contains the address that this symbol
326 struct general_symbol_info ginfo
;
328 /* The info field is available for caching machine-specific
329 information so it doesn't have to rederive the info constantly
330 (over a serial line). It is initialized to zero and stays that
331 way until target-dependent code sets it. Storage for any data
332 pointed to by this field should be allocated on the
333 objfile_obstack for the associated objfile. The type would be
334 "void *" except for reasons of compatibility with older
335 compilers. This field is optional.
337 Currently, the AMD 29000 tdep.c uses it to remember things it has decoded
338 from the instructions in the function header, and the MIPS-16 code uses
339 it to identify 16-bit procedures. */
343 /* Size of this symbol. end_psymtab in dbxread.c uses this
344 information to calculate the end of the partial symtab based on the
345 address of the last symbol plus the size of the last symbol. */
349 /* Which source file is this symbol in? Only relevant for mst_file_*. */
352 /* Classification type for this minimal symbol. */
354 ENUM_BITFIELD(minimal_symbol_type
) type
: 8;
356 /* Minimal symbols with the same hash key are kept on a linked
357 list. This is the link. */
359 struct minimal_symbol
*hash_next
;
361 /* Minimal symbols are stored in two different hash tables. This is
362 the `next' pointer for the demangled hash table. */
364 struct minimal_symbol
*demangled_hash_next
;
367 #define MSYMBOL_INFO(msymbol) (msymbol)->info
368 #define MSYMBOL_SIZE(msymbol) (msymbol)->size
369 #define MSYMBOL_TYPE(msymbol) (msymbol)->type
373 /* Represent one symbol name; a variable, constant, function or typedef. */
375 /* Different name domains for symbols. Looking up a symbol specifies a
376 domain and ignores symbol definitions in other name domains. */
378 typedef enum domain_enum_tag
380 /* UNDEF_DOMAIN is used when a domain has not been discovered or
381 none of the following apply. This usually indicates an error either
382 in the symbol information or in gdb's handling of symbols. */
386 /* VAR_DOMAIN is the usual domain. In C, this contains variables,
387 function names, typedef names and enum type values. */
391 /* STRUCT_DOMAIN is used in C to hold struct, union and enum type names.
392 Thus, if `struct foo' is used in a C program, it produces a symbol named
393 `foo' in the STRUCT_DOMAIN. */
397 /* LABEL_DOMAIN may be used for names of labels (for gotos);
398 currently it is not used and labels are not recorded at all. */
402 /* Searching domains. These overlap with VAR_DOMAIN, providing
403 some granularity with the search_symbols function. */
405 /* Everything in VAR_DOMAIN minus FUNCTIONS_-, TYPES_-, and
409 /* All functions -- for some reason not methods, though. */
412 /* All defined types */
415 /* All class methods -- why is this separated out? */
420 /* An address-class says where to find the value of a symbol. */
424 /* Not used; catches errors */
428 /* Value is constant int SYMBOL_VALUE, host byteorder */
432 /* Value is at fixed address SYMBOL_VALUE_ADDRESS */
436 /* Value is in register. SYMBOL_VALUE is the register number. */
440 /* It's an argument; the value is at SYMBOL_VALUE offset in arglist. */
444 /* Value address is at SYMBOL_VALUE offset in arglist. */
448 /* Value is in register number SYMBOL_VALUE. Just like LOC_REGISTER
449 except this is an argument. Probably the cleaner way to handle
450 this would be to separate address_class (which would include
451 separate ARG and LOCAL to deal with the frame's arguments
452 (get_frame_args_address) versus the frame's locals
453 (get_frame_locals_address), and an is_argument flag.
455 For some symbol formats (stabs, for some compilers at least),
456 the compiler generates two symbols, an argument and a register.
457 In some cases we combine them to a single LOC_REGPARM in symbol
458 reading, but currently not for all cases (e.g. it's passed on the
459 stack and then loaded into a register). */
463 /* Value is in specified register. Just like LOC_REGPARM except the
464 register holds the address of the argument instead of the argument
465 itself. This is currently used for the passing of structs and unions
466 on sparc and hppa. It is also used for call by reference where the
467 address is in a register, at least by mipsread.c. */
471 /* Value is a local variable at SYMBOL_VALUE offset in stack frame. */
475 /* Value not used; definition in SYMBOL_TYPE. Symbols in the domain
476 STRUCT_DOMAIN all have this class. */
480 /* Value is address SYMBOL_VALUE_ADDRESS in the code */
484 /* In a symbol table, value is SYMBOL_BLOCK_VALUE of a `struct block'.
485 In a partial symbol table, SYMBOL_VALUE_ADDRESS is the start address
486 of the block. Function names have this class. */
490 /* Value is a constant byte-sequence pointed to by SYMBOL_VALUE_BYTES, in
491 target byte order. */
495 /* Value is arg at SYMBOL_VALUE offset in stack frame. Differs from
496 LOC_LOCAL in that symbol is an argument; differs from LOC_ARG in
497 that we find it in the frame (get_frame_locals_address), not in
498 the arglist (get_frame_args_address). Added for i960, which
499 passes args in regs then copies to frame. */
503 /* Value is at SYMBOL_VALUE offset from the current value of
504 register number SYMBOL_BASEREG. This exists mainly for the same
505 things that LOC_LOCAL and LOC_ARG do; but we need to do this
506 instead because on 88k DWARF gives us the offset from the
507 frame/stack pointer, rather than the offset from the "canonical
508 frame address" used by COFF, stabs, etc., and we don't know how
509 to convert between these until we start examining prologues.
511 Note that LOC_BASEREG is much less general than a DWARF expression.
512 We don't need the generality (at least not yet), and storing a general
513 DWARF expression would presumably take up more space than the existing
518 /* Same as LOC_BASEREG but it is an argument. */
522 /* Value is at fixed address, but the address of the variable has
523 to be determined from the minimal symbol table whenever the
524 variable is referenced.
525 This happens if debugging information for a global symbol is
526 emitted and the corresponding minimal symbol is defined
527 in another object file or runtime common storage.
528 The linker might even remove the minimal symbol if the global
529 symbol is never referenced, in which case the symbol remains
534 /* Value is at a thread-specific location calculated by a
535 target-specific method. This is used only by hppa. */
537 LOC_HP_THREAD_LOCAL_STATIC
,
539 /* The variable does not actually exist in the program.
540 The value is ignored. */
544 /* The variable is static, but actually lives at * (address).
545 * I.e. do an extra indirection to get to it.
546 * This is used on HP-UX to get at globals that are allocated
547 * in shared libraries, where references from images other
548 * than the one where the global was allocated are done
549 * with a level of indirection.
554 /* The variable's address is computed by a set of location
555 functions (see "struct symbol_ops" below). */
558 /* Same as LOC_COMPUTED, but for function arguments. */
562 /* The methods needed to implement a symbol class. These methods can
563 use the symbol's .aux_value for additional per-symbol information.
565 At present this is only used to implement location expressions. */
570 /* Return the value of the variable SYMBOL, relative to the stack
571 frame FRAME. If the variable has been optimized out, return
574 Iff `read_needs_frame (SYMBOL)' is zero, then FRAME may be zero. */
576 struct value
*(*read_variable
) (struct symbol
* symbol
,
577 struct frame_info
* frame
);
579 /* Return non-zero if we need a frame to find the value of the SYMBOL. */
580 int (*read_needs_frame
) (struct symbol
* symbol
);
582 /* Write to STREAM a natural-language description of the location of
584 int (*describe_location
) (struct symbol
* symbol
, struct ui_file
* stream
);
586 /* Tracepoint support. Append bytecodes to the tracepoint agent
587 expression AX that push the address of the object SYMBOL. Set
588 VALUE appropriately. Note --- for objects in registers, this
589 needn't emit any code; as long as it sets VALUE properly, then
590 the caller will generate the right code in the process of
591 treating this as an lvalue or rvalue. */
593 void (*tracepoint_var_ref
) (struct symbol
* symbol
, struct agent_expr
* ax
,
594 struct axs_value
* value
);
597 /* This structure is space critical. See space comments at the top. */
602 /* The general symbol info required for all types of symbols. */
604 struct general_symbol_info ginfo
;
606 /* Data type of value */
610 /* The symbol table containing this symbol. This is the file
611 associated with LINE. */
612 struct symtab
*symtab
;
616 ENUM_BITFIELD(domain_enum_tag
) domain
: 6;
619 /* NOTE: cagney/2003-11-02: The fields "aclass" and "ops" contain
620 overlapping information. By creating a per-aclass ops vector, or
621 using the aclass as an index into an ops table, the aclass and
622 ops fields can be merged. The latter, for instance, would shave
623 32-bits from each symbol (relative to a symbol lookup, any table
624 index overhead would be in the noise). */
626 ENUM_BITFIELD(address_class
) aclass
: 6;
628 /* Line number of definition. FIXME: Should we really make the assumption
629 that nobody will try to debug files longer than 64K lines? What about
630 machine generated programs? */
634 /* Method's for symbol's of this class. */
635 /* NOTE: cagney/2003-11-02: See comment above attached to "aclass". */
637 const struct symbol_ops
*ops
;
639 /* Some symbols require additional information to be recorded on a
640 per- symbol basis. Stash those values here. */
644 /* Used by LOC_BASEREG and LOC_BASEREG_ARG. */
646 /* An arbitrary data pointer. Note that this data must be
647 allocated using the same obstack as the symbol itself. */
648 /* So far it is only used by LOC_COMPUTED and LOC_COMPUTED_ARG to
649 find the location location information. For a LOC_BLOCK symbol
650 for a function in a compilation unit compiled with DWARF 2
651 information, this is information used internally by the DWARF 2
652 code --- specifically, the location expression for the frame
653 base for this function. */
654 /* FIXME drow/2003-02-21: For the LOC_BLOCK case, it might be better
655 to add a magic symbol to the block containing this information,
656 or to have a generic debug info annotation slot for symbols. */
661 struct symbol
*hash_next
;
665 #define SYMBOL_DOMAIN(symbol) (symbol)->domain
666 #define SYMBOL_CLASS(symbol) (symbol)->aclass
667 #define SYMBOL_TYPE(symbol) (symbol)->type
668 #define SYMBOL_LINE(symbol) (symbol)->line
669 #define SYMBOL_SYMTAB(symbol) (symbol)->symtab
670 #define SYMBOL_BASEREG(symbol) (symbol)->aux_value.basereg
671 #define SYMBOL_OBJFILE(symbol) (symbol)->aux_value.objfile
672 #define SYMBOL_OPS(symbol) (symbol)->ops
673 #define SYMBOL_LOCATION_BATON(symbol) (symbol)->aux_value.ptr
675 /* A partial_symbol records the name, domain, and address class of
676 symbols whose types we have not parsed yet. For functions, it also
677 contains their memory address, so we can find them from a PC value.
678 Each partial_symbol sits in a partial_symtab, all of which are chained
679 on a partial symtab list and which points to the corresponding
680 normal symtab once the partial_symtab has been referenced. */
682 /* This structure is space critical. See space comments at the top. */
684 struct partial_symbol
687 /* The general symbol info required for all types of symbols. */
689 struct general_symbol_info ginfo
;
691 /* Name space code. */
693 ENUM_BITFIELD(domain_enum_tag
) domain
: 6;
695 /* Address class (for info_symbols) */
697 ENUM_BITFIELD(address_class
) aclass
: 6;
701 #define PSYMBOL_DOMAIN(psymbol) (psymbol)->domain
702 #define PSYMBOL_CLASS(psymbol) (psymbol)->aclass
705 /* Each item represents a line-->pc (or the reverse) mapping. This is
706 somewhat more wasteful of space than one might wish, but since only
707 the files which are actually debugged are read in to core, we don't
710 struct linetable_entry
716 /* The order of entries in the linetable is significant. They should
717 be sorted by increasing values of the pc field. If there is more than
718 one entry for a given pc, then I'm not sure what should happen (and
719 I not sure whether we currently handle it the best way).
721 Example: a C for statement generally looks like this
723 10 0x100 - for the init/test part of a for stmt.
726 10 0x400 - for the increment part of a for stmt.
728 If an entry has a line number of zero, it marks the start of a PC
729 range for which no line number information is available. It is
730 acceptable, though wasteful of table space, for such a range to be
737 /* Actually NITEMS elements. If you don't like this use of the
738 `struct hack', you can shove it up your ANSI (seriously, if the
739 committee tells us how to do it, we can probably go along). */
740 struct linetable_entry item
[1];
743 /* How to relocate the symbols from each section in a symbol file.
744 Each struct contains an array of offsets.
745 The ordering and meaning of the offsets is file-type-dependent;
746 typically it is indexed by section numbers or symbol types or
749 To give us flexibility in changing the internal representation
750 of these offsets, the ANOFFSET macro must be used to insert and
751 extract offset values in the struct. */
753 struct section_offsets
755 CORE_ADDR offsets
[1]; /* As many as needed. */
758 #define ANOFFSET(secoff, whichone) \
760 ? (internal_error (__FILE__, __LINE__, _("Section index is uninitialized")), -1) \
761 : secoff->offsets[whichone])
763 /* The size of a section_offsets table for N sections. */
764 #define SIZEOF_N_SECTION_OFFSETS(n) \
765 (sizeof (struct section_offsets) \
766 + sizeof (((struct section_offsets *) 0)->offsets) * ((n)-1))
768 /* Each source file or header is represented by a struct symtab.
769 These objects are chained through the `next' field. */
774 /* Chain of all existing symtabs. */
778 /* List of all symbol scope blocks for this symtab. May be shared
779 between different symtabs (and normally is for all the symtabs
780 in a given compilation unit). */
782 struct blockvector
*blockvector
;
784 /* Table mapping core addresses to line numbers for this file.
785 Can be NULL if none. Never shared between different symtabs. */
787 struct linetable
*linetable
;
789 /* Section in objfile->section_offsets for the blockvector and
790 the linetable. Probably always SECT_OFF_TEXT. */
792 int block_line_section
;
794 /* If several symtabs share a blockvector, exactly one of them
795 should be designated the primary, so that the blockvector
796 is relocated exactly once by objfile_relocate. */
800 /* The macro table for this symtab. Like the blockvector, this
801 may be shared between different symtabs --- and normally is for
802 all the symtabs in a given compilation unit. */
803 struct macro_table
*macro_table
;
805 /* Name of this source file. */
809 /* Directory in which it was compiled, or NULL if we don't know. */
813 /* This component says how to free the data we point to:
814 free_contents => do a tree walk and free each object.
815 free_nothing => do nothing; some other symtab will free
816 the data this one uses.
817 free_linetable => free just the linetable. FIXME: Is this redundant
818 with the primary field? */
822 free_nothing
, free_contents
, free_linetable
826 /* A function to call to free space, if necessary. This is IN
827 ADDITION to the action indicated by free_code. */
829 void (*free_func
)(struct symtab
*symtab
);
831 /* Total number of lines found in source file. */
835 /* line_charpos[N] is the position of the (N-1)th line of the
836 source file. "position" means something we can lseek() to; it
837 is not guaranteed to be useful any other way. */
841 /* Language of this source file. */
843 enum language language
;
845 /* String that identifies the format of the debugging information, such
846 as "stabs", "dwarf 1", "dwarf 2", "coff", etc. This is mostly useful
847 for automated testing of gdb but may also be information that is
848 useful to the user. */
852 /* String of producer version information. May be zero. */
856 /* Full name of file as found by searching the source path.
857 NULL if not yet known. */
861 /* Object file from which this symbol information was read. */
863 struct objfile
*objfile
;
867 #define BLOCKVECTOR(symtab) (symtab)->blockvector
868 #define LINETABLE(symtab) (symtab)->linetable
871 /* Each source file that has not been fully read in is represented by
872 a partial_symtab. This contains the information on where in the
873 executable the debugging symbols for a specific file are, and a
874 list of names of global symbols which are located in this file.
875 They are all chained on partial symtab lists.
877 Even after the source file has been read into a symtab, the
878 partial_symtab remains around. They are allocated on an obstack,
879 objfile_obstack. FIXME, this is bad for dynamic linking or VxWorks-
880 style execution of a bunch of .o's. */
882 struct partial_symtab
885 /* Chain of all existing partial symtabs. */
887 struct partial_symtab
*next
;
889 /* Name of the source file which this partial_symtab defines */
893 /* Full path of the source file. NULL if not known. */
897 /* Directory in which it was compiled, or NULL if we don't know. */
901 /* Information about the object file from which symbols should be read. */
903 struct objfile
*objfile
;
905 /* Set of relocation offsets to apply to each section. */
907 struct section_offsets
*section_offsets
;
909 /* Range of text addresses covered by this file; texthigh is the
910 beginning of the next section. */
915 /* Array of pointers to all of the partial_symtab's which this one
916 depends on. Since this array can only be set to previous or
917 the current (?) psymtab, this dependency tree is guaranteed not
918 to have any loops. "depends on" means that symbols must be read
919 for the dependencies before being read for this psymtab; this is
920 for type references in stabs, where if foo.c includes foo.h, declarations
921 in foo.h may use type numbers defined in foo.c. For other debugging
922 formats there may be no need to use dependencies. */
924 struct partial_symtab
**dependencies
;
926 int number_of_dependencies
;
928 /* Global symbol list. This list will be sorted after readin to
929 improve access. Binary search will be the usual method of
930 finding a symbol within it. globals_offset is an integer offset
931 within global_psymbols[]. */
936 /* Static symbol list. This list will *not* be sorted after readin;
937 to find a symbol in it, exhaustive search must be used. This is
938 reasonable because searches through this list will eventually
939 lead to either the read in of a files symbols for real (assumed
940 to take a *lot* of time; check) or an error (and we don't care
941 how long errors take). This is an offset and size within
942 static_psymbols[]. */
947 /* Pointer to symtab eventually allocated for this source file, 0 if
948 !readin or if we haven't looked for the symtab after it was readin. */
950 struct symtab
*symtab
;
952 /* Pointer to function which will read in the symtab corresponding to
955 void (*read_symtab
) (struct partial_symtab
*);
957 /* Information that lets read_symtab() locate the part of the symbol table
958 that this psymtab corresponds to. This information is private to the
959 format-dependent symbol reading routines. For further detail examine
960 the various symbol reading modules. Should really be (void *) but is
961 (char *) as with other such gdb variables. (FIXME) */
963 char *read_symtab_private
;
965 /* Non-zero if the symtab corresponding to this psymtab has been readin */
967 unsigned char readin
;
970 /* A fast way to get from a psymtab to its symtab (after the first time). */
971 #define PSYMTAB_TO_SYMTAB(pst) \
972 ((pst) -> symtab != NULL ? (pst) -> symtab : psymtab_to_symtab (pst))
975 /* The virtual function table is now an array of structures which have the
976 form { int16 offset, delta; void *pfn; }.
978 In normal virtual function tables, OFFSET is unused.
979 DELTA is the amount which is added to the apparent object's base
980 address in order to point to the actual object to which the
981 virtual function should be applied.
982 PFN is a pointer to the virtual function.
984 Note that this macro is g++ specific (FIXME). */
986 #define VTBL_FNADDR_OFFSET 2
988 /* External variables and functions for the objects described above. */
990 /* See the comment in symfile.c about how current_objfile is used. */
992 extern struct objfile
*current_objfile
;
994 /* True if we are nested inside psymtab_to_symtab. */
996 extern int currently_reading_symtab
;
1000 extern int asm_demangle
;
1002 /* symtab.c lookup functions */
1004 /* lookup a symbol table by source file name */
1006 extern struct symtab
*lookup_symtab (const char *);
1008 /* lookup a symbol by name (optional block, optional symtab) in language */
1010 extern struct symbol
*lookup_symbol_in_language (const char *,
1011 const struct block
*,
1017 /* lookup a symbol by name (optional block, optional symtab)
1018 in the current language */
1020 extern struct symbol
*lookup_symbol (const char *, const struct block
*,
1021 const domain_enum
, int *,
1024 /* A default version of lookup_symbol_nonlocal for use by languages
1025 that can't think of anything better to do. */
1027 extern struct symbol
*basic_lookup_symbol_nonlocal (const char *,
1029 const struct block
*,
1033 /* Some helper functions for languages that need to write their own
1034 lookup_symbol_nonlocal functions. */
1036 /* Lookup a symbol in the static block associated to BLOCK, if there
1037 is one; do nothing if BLOCK is NULL or a global block. */
1039 extern struct symbol
*lookup_symbol_static (const char *name
,
1040 const char *linkage_name
,
1041 const struct block
*block
,
1042 const domain_enum domain
,
1043 struct symtab
**symtab
);
1045 /* Lookup a symbol in all files' global blocks (searching psymtabs if
1048 extern struct symbol
*lookup_symbol_global (const char *name
,
1049 const char *linkage_name
,
1050 const struct block
*block
,
1051 const domain_enum domain
,
1052 struct symtab
**symtab
);
1054 /* Lookup a symbol within the block BLOCK. This, unlike
1055 lookup_symbol_block, will set SYMTAB and BLOCK_FOUND correctly, and
1056 will fix up the symbol if necessary. */
1058 extern struct symbol
*lookup_symbol_aux_block (const char *name
,
1059 const char *linkage_name
,
1060 const struct block
*block
,
1061 const domain_enum domain
,
1062 struct symtab
**symtab
);
1064 /* Lookup a partial symbol. */
1066 extern struct partial_symbol
*lookup_partial_symbol (struct partial_symtab
*,
1071 /* lookup a symbol by name, within a specified block */
1073 extern struct symbol
*lookup_block_symbol (const struct block
*, const char *,
1077 /* lookup a [struct, union, enum] by name, within a specified block */
1079 extern struct type
*lookup_struct (char *, struct block
*);
1081 extern struct type
*lookup_union (char *, struct block
*);
1083 extern struct type
*lookup_enum (char *, struct block
*);
1085 /* from blockframe.c: */
1087 /* lookup the function symbol corresponding to the address */
1089 extern struct symbol
*find_pc_function (CORE_ADDR
);
1091 /* lookup the function corresponding to the address and section */
1093 extern struct symbol
*find_pc_sect_function (CORE_ADDR
, asection
*);
1095 /* lookup function from address, return name, start addr and end addr */
1097 extern int find_pc_partial_function (CORE_ADDR
, char **, CORE_ADDR
*,
1100 extern void clear_pc_function_cache (void);
1102 /* from symtab.c: */
1104 /* lookup partial symbol table by filename */
1106 extern struct partial_symtab
*lookup_partial_symtab (const char *);
1108 /* lookup partial symbol table by address */
1110 extern struct partial_symtab
*find_pc_psymtab (CORE_ADDR
);
1112 /* lookup partial symbol table by address and section */
1114 extern struct partial_symtab
*find_pc_sect_psymtab (CORE_ADDR
, asection
*);
1116 /* lookup full symbol table by address */
1118 extern struct symtab
*find_pc_symtab (CORE_ADDR
);
1120 /* lookup full symbol table by address and section */
1122 extern struct symtab
*find_pc_sect_symtab (CORE_ADDR
, asection
*);
1124 /* lookup partial symbol by address */
1126 extern struct partial_symbol
*find_pc_psymbol (struct partial_symtab
*,
1129 /* lookup partial symbol by address and section */
1131 extern struct partial_symbol
*find_pc_sect_psymbol (struct partial_symtab
*,
1132 CORE_ADDR
, asection
*);
1134 extern int find_pc_line_pc_range (CORE_ADDR
, CORE_ADDR
*, CORE_ADDR
*);
1136 extern void reread_symbols (void);
1138 extern struct type
*lookup_transparent_type (const char *);
1139 extern struct type
*basic_lookup_transparent_type (const char *);
1142 /* Macro for name of symbol to indicate a file compiled with gcc. */
1143 #ifndef GCC_COMPILED_FLAG_SYMBOL
1144 #define GCC_COMPILED_FLAG_SYMBOL "gcc_compiled."
1147 /* Macro for name of symbol to indicate a file compiled with gcc2. */
1148 #ifndef GCC2_COMPILED_FLAG_SYMBOL
1149 #define GCC2_COMPILED_FLAG_SYMBOL "gcc2_compiled."
1152 /* Functions for dealing with the minimal symbol table, really a misc
1153 address<->symbol mapping for things we don't have debug symbols for. */
1155 extern void prim_record_minimal_symbol (const char *, CORE_ADDR
,
1156 enum minimal_symbol_type
,
1159 extern struct minimal_symbol
*prim_record_minimal_symbol_and_info
1160 (const char *, CORE_ADDR
,
1161 enum minimal_symbol_type
,
1162 char *info
, int section
, asection
* bfd_section
, struct objfile
*);
1164 extern unsigned int msymbol_hash_iw (const char *);
1166 extern unsigned int msymbol_hash (const char *);
1169 add_minsym_to_hash_table (struct minimal_symbol
*sym
,
1170 struct minimal_symbol
**table
);
1172 extern struct minimal_symbol
*lookup_minimal_symbol (const char *,
1176 extern struct minimal_symbol
*lookup_minimal_symbol_text (const char *,
1179 struct minimal_symbol
*lookup_minimal_symbol_solib_trampoline (const char *,
1183 extern struct minimal_symbol
*lookup_minimal_symbol_by_pc (CORE_ADDR
);
1185 extern struct minimal_symbol
*lookup_minimal_symbol_by_pc_section (CORE_ADDR
,
1189 extern struct minimal_symbol
1190 *lookup_solib_trampoline_symbol_by_pc (CORE_ADDR
);
1192 extern CORE_ADDR
find_solib_trampoline_target (struct frame_info
*, CORE_ADDR
);
1194 extern void init_minimal_symbol_collection (void);
1196 extern struct cleanup
*make_cleanup_discard_minimal_symbols (void);
1198 extern void install_minimal_symbols (struct objfile
*);
1200 /* Sort all the minimal symbols in OBJFILE. */
1202 extern void msymbols_sort (struct objfile
*objfile
);
1204 struct symtab_and_line
1206 struct symtab
*symtab
;
1208 /* Line number. Line numbers start at 1 and proceed through symtab->nlines.
1209 0 is never a valid line number; it is used to indicate that line number
1210 information is not available. */
1219 extern void init_sal (struct symtab_and_line
*sal
);
1221 struct symtabs_and_lines
1223 struct symtab_and_line
*sals
;
1229 /* Some types and macros needed for exception catchpoints.
1230 Can't put these in target.h because symtab_and_line isn't
1231 known there. This file will be included by breakpoint.c,
1232 hppa-tdep.c, etc. */
1234 /* Enums for exception-handling support */
1235 enum exception_event_kind
1241 /* Type for returning info about an exception */
1242 struct exception_event_record
1244 enum exception_event_kind kind
;
1245 struct symtab_and_line throw_sal
;
1246 struct symtab_and_line catch_sal
;
1247 /* This may need to be extended in the future, if
1248 some platforms allow reporting more information,
1249 such as point of rethrow, type of exception object,
1250 type expected by catch clause, etc. */
1253 #define CURRENT_EXCEPTION_KIND (current_exception_event->kind)
1254 #define CURRENT_EXCEPTION_CATCH_SAL (current_exception_event->catch_sal)
1255 #define CURRENT_EXCEPTION_CATCH_LINE (current_exception_event->catch_sal.line)
1256 #define CURRENT_EXCEPTION_CATCH_FILE (current_exception_event->catch_sal.symtab->filename)
1257 #define CURRENT_EXCEPTION_CATCH_PC (current_exception_event->catch_sal.pc)
1258 #define CURRENT_EXCEPTION_THROW_SAL (current_exception_event->throw_sal)
1259 #define CURRENT_EXCEPTION_THROW_LINE (current_exception_event->throw_sal.line)
1260 #define CURRENT_EXCEPTION_THROW_FILE (current_exception_event->throw_sal.symtab->filename)
1261 #define CURRENT_EXCEPTION_THROW_PC (current_exception_event->throw_sal.pc)
1264 /* Given a pc value, return line number it is in. Second arg nonzero means
1265 if pc is on the boundary use the previous statement's line number. */
1267 extern struct symtab_and_line
find_pc_line (CORE_ADDR
, int);
1269 /* Same function, but specify a section as well as an address */
1271 extern struct symtab_and_line
find_pc_sect_line (CORE_ADDR
, asection
*, int);
1273 /* Given a symtab and line number, return the pc there. */
1275 extern int find_line_pc (struct symtab
*, int, CORE_ADDR
*);
1277 extern int find_line_pc_range (struct symtab_and_line
, CORE_ADDR
*,
1280 extern void resolve_sal_pc (struct symtab_and_line
*);
1282 /* Given a string, return the line specified by it. For commands like "list"
1283 and "breakpoint". */
1285 extern struct symtabs_and_lines
decode_line_spec (char *, int);
1287 extern struct symtabs_and_lines
decode_line_spec_1 (char *, int);
1291 void maintenance_print_symbols (char *, int);
1293 void maintenance_print_psymbols (char *, int);
1295 void maintenance_print_msymbols (char *, int);
1297 void maintenance_print_objfiles (char *, int);
1299 void maintenance_info_symtabs (char *, int);
1301 void maintenance_info_psymtabs (char *, int);
1303 void maintenance_check_symtabs (char *, int);
1307 void maintenance_print_statistics (char *, int);
1309 extern void free_symtab (struct symtab
*);
1311 /* Symbol-reading stuff in symfile.c and solib.c. */
1313 extern struct symtab
*psymtab_to_symtab (struct partial_symtab
*);
1315 extern void clear_solib (void);
1319 extern int identify_source_line (struct symtab
*, int, int, CORE_ADDR
);
1321 extern void print_source_lines (struct symtab
*, int, int, int);
1323 extern void forget_cached_source_info (void);
1325 extern void select_source_symtab (struct symtab
*);
1327 extern char **make_symbol_completion_list (char *, char *);
1329 extern char **make_file_symbol_completion_list (char *, char *, char *);
1331 extern char **make_source_files_completion_list (char *, char *);
1335 int matching_bfd_sections (asection
*, asection
*);
1337 extern struct partial_symtab
*find_main_psymtab (void);
1339 extern struct symtab
*find_line_symtab (struct symtab
*, int, int *, int *);
1341 extern struct symtab_and_line
find_function_start_sal (struct symbol
*sym
,
1346 extern void clear_symtab_users (void);
1348 extern enum language
deduce_language_from_filename (char *);
1352 extern int in_prologue (CORE_ADDR pc
, CORE_ADDR func_start
);
1354 extern CORE_ADDR
skip_prologue_using_sal (CORE_ADDR func_addr
);
1356 extern struct symbol
*fixup_symbol_section (struct symbol
*,
1359 extern struct partial_symbol
*fixup_psymbol_section (struct partial_symbol
1361 struct objfile
*objfile
);
1363 /* Symbol searching */
1365 /* When using search_symbols, a list of the following structs is returned.
1366 Callers must free the search list using free_search_symbols! */
1367 struct symbol_search
1369 /* The block in which the match was found. Could be, for example,
1370 STATIC_BLOCK or GLOBAL_BLOCK. */
1373 /* Information describing what was found.
1375 If symtab abd symbol are NOT NULL, then information was found
1377 struct symtab
*symtab
;
1378 struct symbol
*symbol
;
1380 /* If msymbol is non-null, then a match was made on something for
1381 which only minimal_symbols exist. */
1382 struct minimal_symbol
*msymbol
;
1384 /* A link to the next match, or NULL for the end. */
1385 struct symbol_search
*next
;
1388 extern void search_symbols (char *, domain_enum
, int, char **,
1389 struct symbol_search
**);
1390 extern void free_search_symbols (struct symbol_search
*);
1391 extern struct cleanup
*make_cleanup_free_search_symbols (struct symbol_search
1394 /* The name of the ``main'' function.
1395 FIXME: cagney/2001-03-20: Can't make main_name() const since some
1396 of the calling code currently assumes that the string isn't
1398 extern void set_main_name (const char *name
);
1399 extern /*const */ char *main_name (void);
1401 /* Check global symbols in objfile. */
1402 struct symbol
*lookup_global_symbol_from_objfile (const struct objfile
*objfile
,
1404 const char *linkage_name
,
1405 const domain_enum domain
,
1406 struct symtab
**symtab
);
1408 extern struct symtabs_and_lines
1409 expand_line_sal (struct symtab_and_line sal
);
1411 #endif /* !defined(SYMTAB_H) */