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 section associated with this symbol. */
152 struct obj_section
*obj_section
;
155 extern CORE_ADDR
symbol_overlayed_address (CORE_ADDR
, struct obj_section
*);
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 SYMBOL_VALUE(symbol) (symbol)->ginfo.value.ivalue
166 #define SYMBOL_VALUE_ADDRESS(symbol) (symbol)->ginfo.value.address
167 #define SYMBOL_VALUE_BYTES(symbol) (symbol)->ginfo.value.bytes
168 #define SYMBOL_BLOCK_VALUE(symbol) (symbol)->ginfo.value.block
169 #define SYMBOL_VALUE_CHAIN(symbol) (symbol)->ginfo.value.chain
170 #define SYMBOL_LANGUAGE(symbol) (symbol)->ginfo.language
171 #define SYMBOL_SECTION(symbol) (symbol)->ginfo.section
172 #define SYMBOL_OBJ_SECTION(symbol) (symbol)->ginfo.obj_section
174 #define SYMBOL_CPLUS_DEMANGLED_NAME(symbol) \
175 (symbol)->ginfo.language_specific.cplus_specific.demangled_name
177 /* Initializes the language dependent portion of a symbol
178 depending upon the language for the symbol. */
179 #define SYMBOL_INIT_LANGUAGE_SPECIFIC(symbol,language) \
180 (symbol_init_language_specific (&(symbol)->ginfo, (language)))
181 extern void symbol_init_language_specific (struct general_symbol_info
*symbol
,
182 enum language language
);
184 /* Set just the linkage name of a symbol; do not try to demangle
185 it. Used for constructs which do not have a mangled name,
186 e.g. struct tags. Unlike SYMBOL_SET_NAMES, linkage_name must
187 be terminated and already on the objfile's obstack. */
188 #define SYMBOL_SET_LINKAGE_NAME(symbol,linkage_name) \
189 (symbol)->ginfo.name = (linkage_name)
191 /* Set the linkage and natural names of a symbol, by demangling
193 #define SYMBOL_SET_NAMES(symbol,linkage_name,len,objfile) \
194 symbol_set_names (&(symbol)->ginfo, linkage_name, len, objfile)
195 extern void symbol_set_names (struct general_symbol_info
*symbol
,
196 const char *linkage_name
, int len
,
197 struct objfile
*objfile
);
199 /* Now come lots of name accessor macros. Short version as to when to
200 use which: Use SYMBOL_NATURAL_NAME to refer to the name of the
201 symbol in the original source code. Use SYMBOL_LINKAGE_NAME if you
202 want to know what the linker thinks the symbol's name is. Use
203 SYMBOL_PRINT_NAME for output. Use SYMBOL_DEMANGLED_NAME if you
204 specifically need to know whether SYMBOL_NATURAL_NAME and
205 SYMBOL_LINKAGE_NAME are different. */
207 /* Return SYMBOL's "natural" name, i.e. the name that it was called in
208 the original source code. In languages like C++ where symbols may
209 be mangled for ease of manipulation by the linker, this is the
212 #define SYMBOL_NATURAL_NAME(symbol) \
213 (symbol_natural_name (&(symbol)->ginfo))
214 extern char *symbol_natural_name (const struct general_symbol_info
*symbol
);
216 /* Return SYMBOL's name from the point of view of the linker. In
217 languages like C++ where symbols may be mangled for ease of
218 manipulation by the linker, this is the mangled name; otherwise,
219 it's the same as SYMBOL_NATURAL_NAME. */
221 #define SYMBOL_LINKAGE_NAME(symbol) (symbol)->ginfo.name
223 /* Return the demangled name for a symbol based on the language for
224 that symbol. If no demangled name exists, return NULL. */
225 #define SYMBOL_DEMANGLED_NAME(symbol) \
226 (symbol_demangled_name (&(symbol)->ginfo))
227 extern char *symbol_demangled_name (const struct general_symbol_info
*symbol
);
229 /* Macro that returns a version of the name of a symbol that is
230 suitable for output. In C++ this is the "demangled" form of the
231 name if demangle is on and the "mangled" form of the name if
232 demangle is off. In other languages this is just the symbol name.
233 The result should never be NULL. Don't use this for internal
234 purposes (e.g. storing in a hashtable): it's only suitable for
237 #define SYMBOL_PRINT_NAME(symbol) \
238 (demangle ? SYMBOL_NATURAL_NAME (symbol) : SYMBOL_LINKAGE_NAME (symbol))
240 /* Macro that tests a symbol for a match against a specified name string.
241 First test the unencoded name, then looks for and test a C++ encoded
242 name if it exists. Note that whitespace is ignored while attempting to
243 match a C++ encoded name, so that "foo::bar(int,long)" is the same as
244 "foo :: bar (int, long)".
245 Evaluates to zero if the match fails, or nonzero if it succeeds. */
247 /* Macro that tests a symbol for a match against a specified name
248 string. It tests against SYMBOL_NATURAL_NAME, and it ignores
249 whitespace and trailing parentheses. (See strcmp_iw for details
250 about its behavior.) */
252 #define SYMBOL_MATCHES_NATURAL_NAME(symbol, name) \
253 (strcmp_iw (SYMBOL_NATURAL_NAME (symbol), (name)) == 0)
255 /* Macro that returns the name to be used when sorting and searching symbols.
256 In C++, Chill, and Java, we search for the demangled form of a name,
257 and so sort symbols accordingly. In Ada, however, we search by mangled
258 name. If there is no distinct demangled name, then SYMBOL_SEARCH_NAME
259 returns the same value (same pointer) as SYMBOL_LINKAGE_NAME. */
260 #define SYMBOL_SEARCH_NAME(symbol) \
261 (symbol_search_name (&(symbol)->ginfo))
262 extern char *symbol_search_name (const struct general_symbol_info
*);
264 /* Analogous to SYMBOL_MATCHES_NATURAL_NAME, but uses the search
266 #define SYMBOL_MATCHES_SEARCH_NAME(symbol, name) \
267 (strcmp_iw (SYMBOL_SEARCH_NAME (symbol), (name)) == 0)
269 /* Classification types for a minimal symbol. These should be taken as
270 "advisory only", since if gdb can't easily figure out a
271 classification it simply selects mst_unknown. It may also have to
272 guess when it can't figure out which is a better match between two
273 types (mst_data versus mst_bss) for example. Since the minimal
274 symbol info is sometimes derived from the BFD library's view of a
275 file, we need to live with what information bfd supplies. */
277 enum minimal_symbol_type
279 mst_unknown
= 0, /* Unknown type, the default */
280 mst_text
, /* Generally executable instructions */
281 mst_data
, /* Generally initialized data */
282 mst_bss
, /* Generally uninitialized data */
283 mst_abs
, /* Generally absolute (nonrelocatable) */
284 /* GDB uses mst_solib_trampoline for the start address of a shared
285 library trampoline entry. Breakpoints for shared library functions
286 are put there if the shared library is not yet loaded.
287 After the shared library is loaded, lookup_minimal_symbol will
288 prefer the minimal symbol from the shared library (usually
289 a mst_text symbol) over the mst_solib_trampoline symbol, and the
290 breakpoints will be moved to their true address in the shared
291 library via breakpoint_re_set. */
292 mst_solib_trampoline
, /* Shared library trampoline code */
293 /* For the mst_file* types, the names are only guaranteed to be unique
294 within a given .o file. */
295 mst_file_text
, /* Static version of mst_text */
296 mst_file_data
, /* Static version of mst_data */
297 mst_file_bss
/* Static version of mst_bss */
300 /* Define a simple structure used to hold some very basic information about
301 all defined global symbols (text, data, bss, abs, etc). The only required
302 information is the general_symbol_info.
304 In many cases, even if a file was compiled with no special options for
305 debugging at all, as long as was not stripped it will contain sufficient
306 information to build a useful minimal symbol table using this structure.
307 Even when a file contains enough debugging information to build a full
308 symbol table, these minimal symbols are still useful for quickly mapping
309 between names and addresses, and vice versa. They are also sometimes
310 used to figure out what full symbol table entries need to be read in. */
312 struct minimal_symbol
315 /* The general symbol info required for all types of symbols.
317 The SYMBOL_VALUE_ADDRESS contains the address that this symbol
320 struct general_symbol_info ginfo
;
322 /* Size of this symbol. end_psymtab in dbxread.c uses this
323 information to calculate the end of the partial symtab based on the
324 address of the last symbol plus the size of the last symbol. */
328 /* Which source file is this symbol in? Only relevant for mst_file_*. */
331 /* Classification type for this minimal symbol. */
333 ENUM_BITFIELD(minimal_symbol_type
) type
: 8;
335 /* Two flag bits provided for the use of the target. */
336 unsigned int target_flag_1
: 1;
337 unsigned int target_flag_2
: 1;
339 /* Minimal symbols with the same hash key are kept on a linked
340 list. This is the link. */
342 struct minimal_symbol
*hash_next
;
344 /* Minimal symbols are stored in two different hash tables. This is
345 the `next' pointer for the demangled hash table. */
347 struct minimal_symbol
*demangled_hash_next
;
350 #define MSYMBOL_TARGET_FLAG_1(msymbol) (msymbol)->target_flag_1
351 #define MSYMBOL_TARGET_FLAG_2(msymbol) (msymbol)->target_flag_2
352 #define MSYMBOL_SIZE(msymbol) (msymbol)->size
353 #define MSYMBOL_TYPE(msymbol) (msymbol)->type
357 /* Represent one symbol name; a variable, constant, function or typedef. */
359 /* Different name domains for symbols. Looking up a symbol specifies a
360 domain and ignores symbol definitions in other name domains. */
362 typedef enum domain_enum_tag
364 /* UNDEF_DOMAIN is used when a domain has not been discovered or
365 none of the following apply. This usually indicates an error either
366 in the symbol information or in gdb's handling of symbols. */
370 /* VAR_DOMAIN is the usual domain. In C, this contains variables,
371 function names, typedef names and enum type values. */
375 /* STRUCT_DOMAIN is used in C to hold struct, union and enum type names.
376 Thus, if `struct foo' is used in a C program, it produces a symbol named
377 `foo' in the STRUCT_DOMAIN. */
381 /* LABEL_DOMAIN may be used for names of labels (for gotos);
382 currently it is not used and labels are not recorded at all. */
386 /* Searching domains. These overlap with VAR_DOMAIN, providing
387 some granularity with the search_symbols function. */
389 /* Everything in VAR_DOMAIN minus FUNCTIONS_-, TYPES_-, and
393 /* All functions -- for some reason not methods, though. */
396 /* All defined types */
399 /* All class methods -- why is this separated out? */
404 /* An address-class says where to find the value of a symbol. */
408 /* Not used; catches errors */
412 /* Value is constant int SYMBOL_VALUE, host byteorder */
416 /* Value is at fixed address SYMBOL_VALUE_ADDRESS */
420 /* Value is in register. SYMBOL_VALUE is the register number.
422 For some symbol formats (stabs, for some compilers at least),
423 the compiler generates two symbols, an argument and a register.
424 In some cases we combine them to a single LOC_REGISTER in symbol
425 reading, but currently not for all cases (e.g. it's passed on the
426 stack and then loaded into a register). */
430 /* It's an argument; the value is at SYMBOL_VALUE offset in arglist. */
434 /* Value address is at SYMBOL_VALUE offset in arglist. */
438 /* Value is in specified register. Just like LOC_REGISTER except the
439 register holds the address of the argument instead of the argument
440 itself. This is currently used for the passing of structs and unions
441 on sparc and hppa. It is also used for call by reference where the
442 address is in a register, at least by mipsread.c. */
446 /* Value is a local variable at SYMBOL_VALUE offset in stack frame. */
450 /* Value not used; definition in SYMBOL_TYPE. Symbols in the domain
451 STRUCT_DOMAIN all have this class. */
455 /* Value is address SYMBOL_VALUE_ADDRESS in the code */
459 /* In a symbol table, value is SYMBOL_BLOCK_VALUE of a `struct block'.
460 In a partial symbol table, SYMBOL_VALUE_ADDRESS is the start address
461 of the block. Function names have this class. */
465 /* Value is a constant byte-sequence pointed to by SYMBOL_VALUE_BYTES, in
466 target byte order. */
470 /* Value is at fixed address, but the address of the variable has
471 to be determined from the minimal symbol table whenever the
472 variable is referenced.
473 This happens if debugging information for a global symbol is
474 emitted and the corresponding minimal symbol is defined
475 in another object file or runtime common storage.
476 The linker might even remove the minimal symbol if the global
477 symbol is never referenced, in which case the symbol remains
482 /* The variable does not actually exist in the program.
483 The value is ignored. */
487 /* The variable's address is computed by a set of location
488 functions (see "struct symbol_ops" below). */
492 /* The methods needed to implement a symbol class. These methods can
493 use the symbol's .aux_value for additional per-symbol information.
495 At present this is only used to implement location expressions. */
500 /* Return the value of the variable SYMBOL, relative to the stack
501 frame FRAME. If the variable has been optimized out, return
504 Iff `read_needs_frame (SYMBOL)' is zero, then FRAME may be zero. */
506 struct value
*(*read_variable
) (struct symbol
* symbol
,
507 struct frame_info
* frame
);
509 /* Return non-zero if we need a frame to find the value of the SYMBOL. */
510 int (*read_needs_frame
) (struct symbol
* symbol
);
512 /* Write to STREAM a natural-language description of the location of
514 int (*describe_location
) (struct symbol
* symbol
, struct ui_file
* stream
);
516 /* Tracepoint support. Append bytecodes to the tracepoint agent
517 expression AX that push the address of the object SYMBOL. Set
518 VALUE appropriately. Note --- for objects in registers, this
519 needn't emit any code; as long as it sets VALUE properly, then
520 the caller will generate the right code in the process of
521 treating this as an lvalue or rvalue. */
523 void (*tracepoint_var_ref
) (struct symbol
* symbol
, struct agent_expr
* ax
,
524 struct axs_value
* value
);
527 /* This structure is space critical. See space comments at the top. */
532 /* The general symbol info required for all types of symbols. */
534 struct general_symbol_info ginfo
;
536 /* Data type of value */
540 /* The symbol table containing this symbol. This is the file
541 associated with LINE. */
542 struct symtab
*symtab
;
546 ENUM_BITFIELD(domain_enum_tag
) domain
: 6;
549 /* NOTE: cagney/2003-11-02: The fields "aclass" and "ops" contain
550 overlapping information. By creating a per-aclass ops vector, or
551 using the aclass as an index into an ops table, the aclass and
552 ops fields can be merged. The latter, for instance, would shave
553 32-bits from each symbol (relative to a symbol lookup, any table
554 index overhead would be in the noise). */
556 ENUM_BITFIELD(address_class
) aclass
: 6;
558 /* Whether this is an argument. */
560 unsigned is_argument
: 1;
562 /* Line number of definition. FIXME: Should we really make the assumption
563 that nobody will try to debug files longer than 64K lines? What about
564 machine generated programs? */
568 /* Method's for symbol's of this class. */
569 /* NOTE: cagney/2003-11-02: See comment above attached to "aclass". */
571 const struct symbol_ops
*ops
;
573 /* An arbitrary data pointer, allowing symbol readers to record
574 additional information on a per-symbol basis. Note that this data
575 must be allocated using the same obstack as the symbol itself. */
576 /* So far it is only used by LOC_COMPUTED to
577 find the location information. For a LOC_BLOCK symbol
578 for a function in a compilation unit compiled with DWARF 2
579 information, this is information used internally by the DWARF 2
580 code --- specifically, the location expression for the frame
581 base for this function. */
582 /* FIXME drow/2003-02-21: For the LOC_BLOCK case, it might be better
583 to add a magic symbol to the block containing this information,
584 or to have a generic debug info annotation slot for symbols. */
588 struct symbol
*hash_next
;
592 #define SYMBOL_DOMAIN(symbol) (symbol)->domain
593 #define SYMBOL_CLASS(symbol) (symbol)->aclass
594 #define SYMBOL_IS_ARGUMENT(symbol) (symbol)->is_argument
595 #define SYMBOL_TYPE(symbol) (symbol)->type
596 #define SYMBOL_LINE(symbol) (symbol)->line
597 #define SYMBOL_SYMTAB(symbol) (symbol)->symtab
598 #define SYMBOL_OPS(symbol) (symbol)->ops
599 #define SYMBOL_LOCATION_BATON(symbol) (symbol)->aux_value
601 /* A partial_symbol records the name, domain, and address class of
602 symbols whose types we have not parsed yet. For functions, it also
603 contains their memory address, so we can find them from a PC value.
604 Each partial_symbol sits in a partial_symtab, all of which are chained
605 on a partial symtab list and which points to the corresponding
606 normal symtab once the partial_symtab has been referenced. */
608 /* This structure is space critical. See space comments at the top. */
610 struct partial_symbol
613 /* The general symbol info required for all types of symbols. */
615 struct general_symbol_info ginfo
;
617 /* Name space code. */
619 ENUM_BITFIELD(domain_enum_tag
) domain
: 6;
621 /* Address class (for info_symbols) */
623 ENUM_BITFIELD(address_class
) aclass
: 6;
627 #define PSYMBOL_DOMAIN(psymbol) (psymbol)->domain
628 #define PSYMBOL_CLASS(psymbol) (psymbol)->aclass
631 /* Each item represents a line-->pc (or the reverse) mapping. This is
632 somewhat more wasteful of space than one might wish, but since only
633 the files which are actually debugged are read in to core, we don't
636 struct linetable_entry
642 /* The order of entries in the linetable is significant. They should
643 be sorted by increasing values of the pc field. If there is more than
644 one entry for a given pc, then I'm not sure what should happen (and
645 I not sure whether we currently handle it the best way).
647 Example: a C for statement generally looks like this
649 10 0x100 - for the init/test part of a for stmt.
652 10 0x400 - for the increment part of a for stmt.
654 If an entry has a line number of zero, it marks the start of a PC
655 range for which no line number information is available. It is
656 acceptable, though wasteful of table space, for such a range to be
663 /* Actually NITEMS elements. If you don't like this use of the
664 `struct hack', you can shove it up your ANSI (seriously, if the
665 committee tells us how to do it, we can probably go along). */
666 struct linetable_entry item
[1];
669 /* How to relocate the symbols from each section in a symbol file.
670 Each struct contains an array of offsets.
671 The ordering and meaning of the offsets is file-type-dependent;
672 typically it is indexed by section numbers or symbol types or
675 To give us flexibility in changing the internal representation
676 of these offsets, the ANOFFSET macro must be used to insert and
677 extract offset values in the struct. */
679 struct section_offsets
681 CORE_ADDR offsets
[1]; /* As many as needed. */
684 #define ANOFFSET(secoff, whichone) \
686 ? (internal_error (__FILE__, __LINE__, _("Section index is uninitialized")), -1) \
687 : secoff->offsets[whichone])
689 /* The size of a section_offsets table for N sections. */
690 #define SIZEOF_N_SECTION_OFFSETS(n) \
691 (sizeof (struct section_offsets) \
692 + sizeof (((struct section_offsets *) 0)->offsets) * ((n)-1))
694 /* Each source file or header is represented by a struct symtab.
695 These objects are chained through the `next' field. */
700 /* Chain of all existing symtabs. */
704 /* List of all symbol scope blocks for this symtab. May be shared
705 between different symtabs (and normally is for all the symtabs
706 in a given compilation unit). */
708 struct blockvector
*blockvector
;
710 /* Table mapping core addresses to line numbers for this file.
711 Can be NULL if none. Never shared between different symtabs. */
713 struct linetable
*linetable
;
715 /* Section in objfile->section_offsets for the blockvector and
716 the linetable. Probably always SECT_OFF_TEXT. */
718 int block_line_section
;
720 /* If several symtabs share a blockvector, exactly one of them
721 should be designated the primary, so that the blockvector
722 is relocated exactly once by objfile_relocate. */
726 /* The macro table for this symtab. Like the blockvector, this
727 may be shared between different symtabs --- and normally is for
728 all the symtabs in a given compilation unit. */
729 struct macro_table
*macro_table
;
731 /* Name of this source file. */
735 /* Directory in which it was compiled, or NULL if we don't know. */
739 /* This component says how to free the data we point to:
740 free_nothing => do nothing; some other symtab will free
741 the data this one uses.
742 free_linetable => free just the linetable. FIXME: Is this redundant
743 with the primary field? */
747 free_nothing
, free_linetable
751 /* A function to call to free space, if necessary. This is IN
752 ADDITION to the action indicated by free_code. */
754 void (*free_func
)(struct symtab
*symtab
);
756 /* Total number of lines found in source file. */
760 /* line_charpos[N] is the position of the (N-1)th line of the
761 source file. "position" means something we can lseek() to; it
762 is not guaranteed to be useful any other way. */
766 /* Language of this source file. */
768 enum language language
;
770 /* String that identifies the format of the debugging information, such
771 as "stabs", "dwarf 1", "dwarf 2", "coff", etc. This is mostly useful
772 for automated testing of gdb but may also be information that is
773 useful to the user. */
777 /* String of producer version information. May be zero. */
781 /* Full name of file as found by searching the source path.
782 NULL if not yet known. */
786 /* Object file from which this symbol information was read. */
788 struct objfile
*objfile
;
792 #define BLOCKVECTOR(symtab) (symtab)->blockvector
793 #define LINETABLE(symtab) (symtab)->linetable
796 /* Each source file that has not been fully read in is represented by
797 a partial_symtab. This contains the information on where in the
798 executable the debugging symbols for a specific file are, and a
799 list of names of global symbols which are located in this file.
800 They are all chained on partial symtab lists.
802 Even after the source file has been read into a symtab, the
803 partial_symtab remains around. They are allocated on an obstack,
804 objfile_obstack. FIXME, this is bad for dynamic linking or VxWorks-
805 style execution of a bunch of .o's. */
807 struct partial_symtab
810 /* Chain of all existing partial symtabs. */
812 struct partial_symtab
*next
;
814 /* Name of the source file which this partial_symtab defines */
818 /* Full path of the source file. NULL if not known. */
822 /* Directory in which it was compiled, or NULL if we don't know. */
826 /* Information about the object file from which symbols should be read. */
828 struct objfile
*objfile
;
830 /* Set of relocation offsets to apply to each section. */
832 struct section_offsets
*section_offsets
;
834 /* Range of text addresses covered by this file; texthigh is the
835 beginning of the next section. */
840 /* Array of pointers to all of the partial_symtab's which this one
841 depends on. Since this array can only be set to previous or
842 the current (?) psymtab, this dependency tree is guaranteed not
843 to have any loops. "depends on" means that symbols must be read
844 for the dependencies before being read for this psymtab; this is
845 for type references in stabs, where if foo.c includes foo.h, declarations
846 in foo.h may use type numbers defined in foo.c. For other debugging
847 formats there may be no need to use dependencies. */
849 struct partial_symtab
**dependencies
;
851 int number_of_dependencies
;
853 /* Global symbol list. This list will be sorted after readin to
854 improve access. Binary search will be the usual method of
855 finding a symbol within it. globals_offset is an integer offset
856 within global_psymbols[]. */
861 /* Static symbol list. This list will *not* be sorted after readin;
862 to find a symbol in it, exhaustive search must be used. This is
863 reasonable because searches through this list will eventually
864 lead to either the read in of a files symbols for real (assumed
865 to take a *lot* of time; check) or an error (and we don't care
866 how long errors take). This is an offset and size within
867 static_psymbols[]. */
872 /* Pointer to symtab eventually allocated for this source file, 0 if
873 !readin or if we haven't looked for the symtab after it was readin. */
875 struct symtab
*symtab
;
877 /* Pointer to function which will read in the symtab corresponding to
880 void (*read_symtab
) (struct partial_symtab
*);
882 /* Information that lets read_symtab() locate the part of the symbol table
883 that this psymtab corresponds to. This information is private to the
884 format-dependent symbol reading routines. For further detail examine
885 the various symbol reading modules. Should really be (void *) but is
886 (char *) as with other such gdb variables. (FIXME) */
888 char *read_symtab_private
;
890 /* Non-zero if the symtab corresponding to this psymtab has been readin */
892 unsigned char readin
;
895 /* A fast way to get from a psymtab to its symtab (after the first time). */
896 #define PSYMTAB_TO_SYMTAB(pst) \
897 ((pst) -> symtab != NULL ? (pst) -> symtab : psymtab_to_symtab (pst))
900 /* The virtual function table is now an array of structures which have the
901 form { int16 offset, delta; void *pfn; }.
903 In normal virtual function tables, OFFSET is unused.
904 DELTA is the amount which is added to the apparent object's base
905 address in order to point to the actual object to which the
906 virtual function should be applied.
907 PFN is a pointer to the virtual function.
909 Note that this macro is g++ specific (FIXME). */
911 #define VTBL_FNADDR_OFFSET 2
913 /* External variables and functions for the objects described above. */
915 /* See the comment in symfile.c about how current_objfile is used. */
917 extern struct objfile
*current_objfile
;
919 /* True if we are nested inside psymtab_to_symtab. */
921 extern int currently_reading_symtab
;
925 extern int asm_demangle
;
927 /* symtab.c lookup functions */
929 extern const char multiple_symbols_ask
[];
930 extern const char multiple_symbols_all
[];
931 extern const char multiple_symbols_cancel
[];
933 const char *multiple_symbols_select_mode (void);
935 int symbol_matches_domain (enum language symbol_language
,
936 domain_enum symbol_domain
,
939 /* lookup a symbol table by source file name */
941 extern struct symtab
*lookup_symtab (const char *);
943 /* lookup a symbol by name (optional block) in language. */
945 extern struct symbol
*lookup_symbol_in_language (const char *,
946 const struct block
*,
951 /* lookup a symbol by name (optional block, optional symtab)
952 in the current language */
954 extern struct symbol
*lookup_symbol (const char *, const struct block
*,
955 const domain_enum
, int *);
957 /* A default version of lookup_symbol_nonlocal for use by languages
958 that can't think of anything better to do. */
960 extern struct symbol
*basic_lookup_symbol_nonlocal (const char *,
962 const struct block
*,
965 /* Some helper functions for languages that need to write their own
966 lookup_symbol_nonlocal functions. */
968 /* Lookup a symbol in the static block associated to BLOCK, if there
969 is one; do nothing if BLOCK is NULL or a global block. */
971 extern struct symbol
*lookup_symbol_static (const char *name
,
972 const char *linkage_name
,
973 const struct block
*block
,
974 const domain_enum domain
);
976 /* Lookup a symbol in all files' global blocks (searching psymtabs if
979 extern struct symbol
*lookup_symbol_global (const char *name
,
980 const char *linkage_name
,
981 const struct block
*block
,
982 const domain_enum domain
);
984 /* Lookup a symbol within the block BLOCK. This, unlike
985 lookup_symbol_block, will set SYMTAB and BLOCK_FOUND correctly, and
986 will fix up the symbol if necessary. */
988 extern struct symbol
*lookup_symbol_aux_block (const char *name
,
989 const char *linkage_name
,
990 const struct block
*block
,
991 const domain_enum domain
);
993 /* Lookup a partial symbol. */
995 extern struct partial_symbol
*lookup_partial_symbol (struct partial_symtab
*,
1000 /* lookup a symbol by name, within a specified block */
1002 extern struct symbol
*lookup_block_symbol (const struct block
*, const char *,
1006 /* lookup a [struct, union, enum] by name, within a specified block */
1008 extern struct type
*lookup_struct (char *, struct block
*);
1010 extern struct type
*lookup_union (char *, struct block
*);
1012 extern struct type
*lookup_enum (char *, struct block
*);
1014 /* from blockframe.c: */
1016 /* lookup the function symbol corresponding to the address */
1018 extern struct symbol
*find_pc_function (CORE_ADDR
);
1020 /* lookup the function corresponding to the address and section */
1022 extern struct symbol
*find_pc_sect_function (CORE_ADDR
, struct obj_section
*);
1024 /* lookup function from address, return name, start addr and end addr */
1026 extern int find_pc_partial_function (CORE_ADDR
, char **, CORE_ADDR
*,
1029 extern void clear_pc_function_cache (void);
1031 /* from symtab.c: */
1033 /* lookup partial symbol table by filename */
1035 extern struct partial_symtab
*lookup_partial_symtab (const char *);
1037 /* lookup partial symbol table by address */
1039 extern struct partial_symtab
*find_pc_psymtab (CORE_ADDR
);
1041 /* lookup partial symbol table by address and section */
1043 extern struct partial_symtab
*find_pc_sect_psymtab (CORE_ADDR
,
1044 struct obj_section
*);
1046 /* lookup full symbol table by address */
1048 extern struct symtab
*find_pc_symtab (CORE_ADDR
);
1050 /* lookup full symbol table by address and section */
1052 extern struct symtab
*find_pc_sect_symtab (CORE_ADDR
, struct obj_section
*);
1054 /* lookup partial symbol by address */
1056 extern struct partial_symbol
*find_pc_psymbol (struct partial_symtab
*,
1059 /* lookup partial symbol by address and section */
1061 extern struct partial_symbol
*find_pc_sect_psymbol (struct partial_symtab
*,
1063 struct obj_section
*);
1065 extern int find_pc_line_pc_range (CORE_ADDR
, CORE_ADDR
*, CORE_ADDR
*);
1067 extern void reread_symbols (void);
1069 extern struct type
*lookup_transparent_type (const char *);
1070 extern struct type
*basic_lookup_transparent_type (const char *);
1073 /* Macro for name of symbol to indicate a file compiled with gcc. */
1074 #ifndef GCC_COMPILED_FLAG_SYMBOL
1075 #define GCC_COMPILED_FLAG_SYMBOL "gcc_compiled."
1078 /* Macro for name of symbol to indicate a file compiled with gcc2. */
1079 #ifndef GCC2_COMPILED_FLAG_SYMBOL
1080 #define GCC2_COMPILED_FLAG_SYMBOL "gcc2_compiled."
1083 /* Functions for dealing with the minimal symbol table, really a misc
1084 address<->symbol mapping for things we don't have debug symbols for. */
1086 extern void prim_record_minimal_symbol (const char *, CORE_ADDR
,
1087 enum minimal_symbol_type
,
1090 extern struct minimal_symbol
*prim_record_minimal_symbol_and_info
1091 (const char *, CORE_ADDR
,
1092 enum minimal_symbol_type
,
1093 int section
, asection
* bfd_section
, struct objfile
*);
1095 extern unsigned int msymbol_hash_iw (const char *);
1097 extern unsigned int msymbol_hash (const char *);
1099 extern struct objfile
* msymbol_objfile (struct minimal_symbol
*sym
);
1102 add_minsym_to_hash_table (struct minimal_symbol
*sym
,
1103 struct minimal_symbol
**table
);
1105 extern struct minimal_symbol
*lookup_minimal_symbol (const char *,
1109 extern struct minimal_symbol
*lookup_minimal_symbol_text (const char *,
1112 struct minimal_symbol
*lookup_minimal_symbol_solib_trampoline (const char *,
1116 extern struct minimal_symbol
*lookup_minimal_symbol_by_pc_name
1117 (CORE_ADDR
, const char *, struct objfile
*);
1119 extern struct minimal_symbol
*lookup_minimal_symbol_by_pc (CORE_ADDR
);
1121 extern struct minimal_symbol
1122 *lookup_minimal_symbol_by_pc_section (CORE_ADDR
, struct obj_section
*);
1124 extern struct minimal_symbol
1125 *lookup_solib_trampoline_symbol_by_pc (CORE_ADDR
);
1127 extern CORE_ADDR
find_solib_trampoline_target (struct frame_info
*, CORE_ADDR
);
1129 extern void init_minimal_symbol_collection (void);
1131 extern struct cleanup
*make_cleanup_discard_minimal_symbols (void);
1133 extern void install_minimal_symbols (struct objfile
*);
1135 /* Sort all the minimal symbols in OBJFILE. */
1137 extern void msymbols_sort (struct objfile
*objfile
);
1139 struct symtab_and_line
1141 struct symtab
*symtab
;
1142 struct obj_section
*section
;
1143 /* Line number. Line numbers start at 1 and proceed through symtab->nlines.
1144 0 is never a valid line number; it is used to indicate that line number
1145 information is not available. */
1154 extern void init_sal (struct symtab_and_line
*sal
);
1156 struct symtabs_and_lines
1158 struct symtab_and_line
*sals
;
1164 /* Some types and macros needed for exception catchpoints.
1165 Can't put these in target.h because symtab_and_line isn't
1166 known there. This file will be included by breakpoint.c,
1167 hppa-tdep.c, etc. */
1169 /* Enums for exception-handling support */
1170 enum exception_event_kind
1178 /* Given a pc value, return line number it is in. Second arg nonzero means
1179 if pc is on the boundary use the previous statement's line number. */
1181 extern struct symtab_and_line
find_pc_line (CORE_ADDR
, int);
1183 /* Same function, but specify a section as well as an address */
1185 extern struct symtab_and_line
find_pc_sect_line (CORE_ADDR
,
1186 struct obj_section
*, int);
1188 /* Given a symtab and line number, return the pc there. */
1190 extern int find_line_pc (struct symtab
*, int, CORE_ADDR
*);
1192 extern int find_line_pc_range (struct symtab_and_line
, CORE_ADDR
*,
1195 extern void resolve_sal_pc (struct symtab_and_line
*);
1197 /* Given a string, return the line specified by it. For commands like "list"
1198 and "breakpoint". */
1200 extern struct symtabs_and_lines
decode_line_spec (char *, int);
1202 extern struct symtabs_and_lines
decode_line_spec_1 (char *, int);
1206 void maintenance_print_symbols (char *, int);
1208 void maintenance_print_psymbols (char *, int);
1210 void maintenance_print_msymbols (char *, int);
1212 void maintenance_print_objfiles (char *, int);
1214 void maintenance_info_symtabs (char *, int);
1216 void maintenance_info_psymtabs (char *, int);
1218 void maintenance_check_symtabs (char *, int);
1222 void maintenance_print_statistics (char *, int);
1224 extern void free_symtab (struct symtab
*);
1226 /* Symbol-reading stuff in symfile.c and solib.c. */
1228 extern struct symtab
*psymtab_to_symtab (struct partial_symtab
*);
1230 extern void clear_solib (void);
1234 extern int identify_source_line (struct symtab
*, int, int, CORE_ADDR
);
1236 extern void print_source_lines (struct symtab
*, int, int, int);
1238 extern void forget_cached_source_info (void);
1240 extern void select_source_symtab (struct symtab
*);
1242 extern char **default_make_symbol_completion_list (char *, char *);
1243 extern char **make_symbol_completion_list (char *, char *);
1245 extern char **make_file_symbol_completion_list (char *, char *, char *);
1247 extern char **make_source_files_completion_list (char *, char *);
1251 int matching_obj_sections (struct obj_section
*, struct obj_section
*);
1253 extern struct partial_symtab
*find_main_psymtab (void);
1255 extern struct symtab
*find_line_symtab (struct symtab
*, int, int *, int *);
1257 extern CORE_ADDR
find_function_start_pc (struct gdbarch
*,
1258 CORE_ADDR
, struct obj_section
*);
1260 extern struct symtab_and_line
find_function_start_sal (struct symbol
*sym
,
1265 extern void clear_symtab_users (void);
1267 extern enum language
deduce_language_from_filename (char *);
1271 extern int in_prologue (CORE_ADDR pc
, CORE_ADDR func_start
);
1273 extern CORE_ADDR
skip_prologue_using_sal (CORE_ADDR func_addr
);
1275 extern struct symbol
*fixup_symbol_section (struct symbol
*,
1278 extern struct partial_symbol
*fixup_psymbol_section (struct partial_symbol
1280 struct objfile
*objfile
);
1282 /* Symbol searching */
1284 /* When using search_symbols, a list of the following structs is returned.
1285 Callers must free the search list using free_search_symbols! */
1286 struct symbol_search
1288 /* The block in which the match was found. Could be, for example,
1289 STATIC_BLOCK or GLOBAL_BLOCK. */
1292 /* Information describing what was found.
1294 If symtab abd symbol are NOT NULL, then information was found
1296 struct symtab
*symtab
;
1297 struct symbol
*symbol
;
1299 /* If msymbol is non-null, then a match was made on something for
1300 which only minimal_symbols exist. */
1301 struct minimal_symbol
*msymbol
;
1303 /* A link to the next match, or NULL for the end. */
1304 struct symbol_search
*next
;
1307 extern void search_symbols (char *, domain_enum
, int, char **,
1308 struct symbol_search
**);
1309 extern void free_search_symbols (struct symbol_search
*);
1310 extern struct cleanup
*make_cleanup_free_search_symbols (struct symbol_search
1313 /* The name of the ``main'' function.
1314 FIXME: cagney/2001-03-20: Can't make main_name() const since some
1315 of the calling code currently assumes that the string isn't
1317 extern void set_main_name (const char *name
);
1318 extern /*const */ char *main_name (void);
1320 /* Check global symbols in objfile. */
1321 struct symbol
*lookup_global_symbol_from_objfile (const struct objfile
*objfile
,
1323 const char *linkage_name
,
1324 const domain_enum domain
);
1326 extern struct symtabs_and_lines
1327 expand_line_sal (struct symtab_and_line sal
);
1329 #endif /* !defined(SYMTAB_H) */