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, 2009
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_DOMAIN and
393 /* All functions -- for some reason not methods, though. */
396 /* All defined types */
401 /* An address-class says where to find the value of a symbol. */
405 /* Not used; catches errors */
409 /* Value is constant int SYMBOL_VALUE, host byteorder */
413 /* Value is at fixed address SYMBOL_VALUE_ADDRESS */
417 /* Value is in register. SYMBOL_VALUE is the register number.
419 For some symbol formats (stabs, for some compilers at least),
420 the compiler generates two symbols, an argument and a register.
421 In some cases we combine them to a single LOC_REGISTER in symbol
422 reading, but currently not for all cases (e.g. it's passed on the
423 stack and then loaded into a register). */
427 /* It's an argument; the value is at SYMBOL_VALUE offset in arglist. */
431 /* Value address is at SYMBOL_VALUE offset in arglist. */
435 /* Value is in specified register. Just like LOC_REGISTER except the
436 register holds the address of the argument instead of the argument
437 itself. This is currently used for the passing of structs and unions
438 on sparc and hppa. It is also used for call by reference where the
439 address is in a register, at least by mipsread.c. */
443 /* Value is a local variable at SYMBOL_VALUE offset in stack frame. */
447 /* Value not used; definition in SYMBOL_TYPE. Symbols in the domain
448 STRUCT_DOMAIN all have this class. */
452 /* Value is address SYMBOL_VALUE_ADDRESS in the code */
456 /* In a symbol table, value is SYMBOL_BLOCK_VALUE of a `struct block'.
457 In a partial symbol table, SYMBOL_VALUE_ADDRESS is the start address
458 of the block. Function names have this class. */
462 /* Value is a constant byte-sequence pointed to by SYMBOL_VALUE_BYTES, in
463 target byte order. */
467 /* Value is at fixed address, but the address of the variable has
468 to be determined from the minimal symbol table whenever the
469 variable is referenced.
470 This happens if debugging information for a global symbol is
471 emitted and the corresponding minimal symbol is defined
472 in another object file or runtime common storage.
473 The linker might even remove the minimal symbol if the global
474 symbol is never referenced, in which case the symbol remains
477 GDB would normally find the symbol in the minimal symbol table if it will
478 not find it in the full symbol table. But a reference to an external
479 symbol in a local block shadowing other definition requires full symbol
480 without possibly having its address available for LOC_STATIC. Testcase
481 is provided as `gdb.dwarf2/dw2-unresolved.exp'. */
485 /* The variable does not actually exist in the program.
486 The value is ignored. */
490 /* The variable's address is computed by a set of location
491 functions (see "struct symbol_ops" below). */
495 /* The methods needed to implement a symbol class. These methods can
496 use the symbol's .aux_value for additional per-symbol information.
498 At present this is only used to implement location expressions. */
503 /* Return the value of the variable SYMBOL, relative to the stack
504 frame FRAME. If the variable has been optimized out, return
507 Iff `read_needs_frame (SYMBOL)' is zero, then FRAME may be zero. */
509 struct value *(*read_variable) (struct symbol * symbol,
510 struct frame_info * frame);
512 /* Return non-zero if we need a frame to find the value of the SYMBOL. */
513 int (*read_needs_frame) (struct symbol * symbol);
515 /* Write to STREAM a natural-language description of the location of
517 int (*describe_location) (struct symbol * symbol, struct ui_file * stream);
519 /* Tracepoint support. Append bytecodes to the tracepoint agent
520 expression AX that push the address of the object SYMBOL. Set
521 VALUE appropriately. Note --- for objects in registers, this
522 needn't emit any code; as long as it sets VALUE properly, then
523 the caller will generate the right code in the process of
524 treating this as an lvalue or rvalue. */
526 void (*tracepoint_var_ref) (struct symbol * symbol, struct agent_expr * ax,
527 struct axs_value * value);
530 /* This structure is space critical. See space comments at the top. */
535 /* The general symbol info required for all types of symbols. */
537 struct general_symbol_info ginfo;
539 /* Data type of value */
543 /* The symbol table containing this symbol. This is the file
544 associated with LINE. */
545 struct symtab *symtab;
549 ENUM_BITFIELD(domain_enum_tag) domain : 6;
552 /* NOTE: cagney/2003-11-02: The fields "aclass" and "ops" contain
553 overlapping information. By creating a per-aclass ops vector, or
554 using the aclass as an index into an ops table, the aclass and
555 ops fields can be merged. The latter, for instance, would shave
556 32-bits from each symbol (relative to a symbol lookup, any table
557 index overhead would be in the noise). */
559 ENUM_BITFIELD(address_class) aclass : 6;
561 /* Whether this is an argument. */
563 unsigned is_argument : 1;
565 /* Line number of definition. FIXME: Should we really make the assumption
566 that nobody will try to debug files longer than 64K lines? What about
567 machine generated programs? */
571 /* Method's for symbol's of this class. */
572 /* NOTE: cagney/2003-11-02: See comment above attached to "aclass". */
574 const struct symbol_ops *ops;
576 /* An arbitrary data pointer, allowing symbol readers to record
577 additional information on a per-symbol basis. Note that this data
578 must be allocated using the same obstack as the symbol itself. */
579 /* So far it is only used by LOC_COMPUTED to
580 find the location information. For a LOC_BLOCK symbol
581 for a function in a compilation unit compiled with DWARF 2
582 information, this is information used internally by the DWARF 2
583 code --- specifically, the location expression for the frame
584 base for this function. */
585 /* FIXME drow/2003-02-21: For the LOC_BLOCK case, it might be better
586 to add a magic symbol to the block containing this information,
587 or to have a generic debug info annotation slot for symbols. */
591 struct symbol *hash_next;
595 #define SYMBOL_DOMAIN(symbol) (symbol)->domain
596 #define SYMBOL_CLASS(symbol) (symbol)->aclass
597 #define SYMBOL_IS_ARGUMENT(symbol) (symbol)->is_argument
598 #define SYMBOL_TYPE(symbol) (symbol)->type
599 #define SYMBOL_LINE(symbol) (symbol)->line
600 #define SYMBOL_SYMTAB(symbol) (symbol)->symtab
601 #define SYMBOL_OPS(symbol) (symbol)->ops
602 #define SYMBOL_LOCATION_BATON(symbol) (symbol)->aux_value
604 /* A partial_symbol records the name, domain, and address class of
605 symbols whose types we have not parsed yet. For functions, it also
606 contains their memory address, so we can find them from a PC value.
607 Each partial_symbol sits in a partial_symtab, all of which are chained
608 on a partial symtab list and which points to the corresponding
609 normal symtab once the partial_symtab has been referenced. */
611 /* This structure is space critical. See space comments at the top. */
613 struct partial_symbol
616 /* The general symbol info required for all types of symbols. */
618 struct general_symbol_info ginfo;
620 /* Name space code. */
622 ENUM_BITFIELD(domain_enum_tag) domain : 6;
624 /* Address class (for info_symbols) */
626 ENUM_BITFIELD(address_class) aclass : 6;
630 #define PSYMBOL_DOMAIN(psymbol) (psymbol)->domain
631 #define PSYMBOL_CLASS(psymbol) (psymbol)->aclass
634 /* Each item represents a line-->pc (or the reverse) mapping. This is
635 somewhat more wasteful of space than one might wish, but since only
636 the files which are actually debugged are read in to core, we don't
639 struct linetable_entry
645 /* The order of entries in the linetable is significant. They should
646 be sorted by increasing values of the pc field. If there is more than
647 one entry for a given pc, then I'm not sure what should happen (and
648 I not sure whether we currently handle it the best way).
650 Example: a C for statement generally looks like this
652 10 0x100 - for the init/test part of a for stmt.
655 10 0x400 - for the increment part of a for stmt.
657 If an entry has a line number of zero, it marks the start of a PC
658 range for which no line number information is available. It is
659 acceptable, though wasteful of table space, for such a range to be
666 /* Actually NITEMS elements. If you don't like this use of the
667 `struct hack', you can shove it up your ANSI (seriously, if the
668 committee tells us how to do it, we can probably go along). */
669 struct linetable_entry item[1];
672 /* How to relocate the symbols from each section in a symbol file.
673 Each struct contains an array of offsets.
674 The ordering and meaning of the offsets is file-type-dependent;
675 typically it is indexed by section numbers or symbol types or
678 To give us flexibility in changing the internal representation
679 of these offsets, the ANOFFSET macro must be used to insert and
680 extract offset values in the struct. */
682 struct section_offsets
684 CORE_ADDR offsets[1]; /* As many as needed. */
687 #define ANOFFSET(secoff, whichone) \
689 ? (internal_error (__FILE__, __LINE__, _("Section index is uninitialized")), -1) \
690 : secoff->offsets[whichone])
692 /* The size of a section_offsets table for N sections. */
693 #define SIZEOF_N_SECTION_OFFSETS(n) \
694 (sizeof (struct section_offsets) \
695 + sizeof (((struct section_offsets *) 0)->offsets) * ((n)-1))
697 /* Each source file or header is represented by a struct symtab.
698 These objects are chained through the `next' field. */
703 /* Chain of all existing symtabs. */
707 /* List of all symbol scope blocks for this symtab. May be shared
708 between different symtabs (and normally is for all the symtabs
709 in a given compilation unit). */
711 struct blockvector *blockvector;
713 /* Table mapping core addresses to line numbers for this file.
714 Can be NULL if none. Never shared between different symtabs. */
716 struct linetable *linetable;
718 /* Section in objfile->section_offsets for the blockvector and
719 the linetable. Probably always SECT_OFF_TEXT. */
721 int block_line_section;
723 /* If several symtabs share a blockvector, exactly one of them
724 should be designated the primary, so that the blockvector
725 is relocated exactly once by objfile_relocate. */
729 /* The macro table for this symtab. Like the blockvector, this
730 may be shared between different symtabs --- and normally is for
731 all the symtabs in a given compilation unit. */
732 struct macro_table *macro_table;
734 /* Name of this source file. */
738 /* Directory in which it was compiled, or NULL if we don't know. */
742 /* This component says how to free the data we point to:
743 free_nothing => do nothing; some other symtab will free
744 the data this one uses.
745 free_linetable => free just the linetable. FIXME: Is this redundant
746 with the primary field? */
750 free_nothing, free_linetable
754 /* A function to call to free space, if necessary. This is IN
755 ADDITION to the action indicated by free_code. */
757 void (*free_func)(struct symtab *symtab);
759 /* Total number of lines found in source file. */
763 /* line_charpos[N] is the position of the (N-1)th line of the
764 source file. "position" means something we can lseek() to; it
765 is not guaranteed to be useful any other way. */
769 /* Language of this source file. */
771 enum language language;
773 /* String that identifies the format of the debugging information, such
774 as "stabs", "dwarf 1", "dwarf 2", "coff", etc. This is mostly useful
775 for automated testing of gdb but may also be information that is
776 useful to the user. */
780 /* String of producer version information. May be zero. */
784 /* Full name of file as found by searching the source path.
785 NULL if not yet known. */
789 /* Object file from which this symbol information was read. */
791 struct objfile *objfile;
795 #define BLOCKVECTOR(symtab) (symtab)->blockvector
796 #define LINETABLE(symtab) (symtab)->linetable
799 /* Each source file that has not been fully read in is represented by
800 a partial_symtab. This contains the information on where in the
801 executable the debugging symbols for a specific file are, and a
802 list of names of global symbols which are located in this file.
803 They are all chained on partial symtab lists.
805 Even after the source file has been read into a symtab, the
806 partial_symtab remains around. They are allocated on an obstack,
807 objfile_obstack. FIXME, this is bad for dynamic linking or VxWorks-
808 style execution of a bunch of .o's. */
810 struct partial_symtab
813 /* Chain of all existing partial symtabs. */
815 struct partial_symtab *next;
817 /* Name of the source file which this partial_symtab defines */
821 /* Full path of the source file. NULL if not known. */
825 /* Directory in which it was compiled, or NULL if we don't know. */
829 /* Information about the object file from which symbols should be read. */
831 struct objfile *objfile;
833 /* Set of relocation offsets to apply to each section. */
835 struct section_offsets *section_offsets;
837 /* Range of text addresses covered by this file; texthigh is the
838 beginning of the next section. */
843 /* Array of pointers to all of the partial_symtab's which this one
844 depends on. Since this array can only be set to previous or
845 the current (?) psymtab, this dependency tree is guaranteed not
846 to have any loops. "depends on" means that symbols must be read
847 for the dependencies before being read for this psymtab; this is
848 for type references in stabs, where if foo.c includes foo.h, declarations
849 in foo.h may use type numbers defined in foo.c. For other debugging
850 formats there may be no need to use dependencies. */
852 struct partial_symtab **dependencies;
854 int number_of_dependencies;
856 /* Global symbol list. This list will be sorted after readin to
857 improve access. Binary search will be the usual method of
858 finding a symbol within it. globals_offset is an integer offset
859 within global_psymbols[]. */
864 /* Static symbol list. This list will *not* be sorted after readin;
865 to find a symbol in it, exhaustive search must be used. This is
866 reasonable because searches through this list will eventually
867 lead to either the read in of a files symbols for real (assumed
868 to take a *lot* of time; check) or an error (and we don't care
869 how long errors take). This is an offset and size within
870 static_psymbols[]. */
875 /* Pointer to symtab eventually allocated for this source file, 0 if
876 !readin or if we haven't looked for the symtab after it was readin. */
878 struct symtab *symtab;
880 /* Pointer to function which will read in the symtab corresponding to
883 void (*read_symtab) (struct partial_symtab *);
885 /* Information that lets read_symtab() locate the part of the symbol table
886 that this psymtab corresponds to. This information is private to the
887 format-dependent symbol reading routines. For further detail examine
888 the various symbol reading modules. Should really be (void *) but is
889 (char *) as with other such gdb variables. (FIXME) */
891 char *read_symtab_private;
893 /* Non-zero if the symtab corresponding to this psymtab has been readin */
895 unsigned char readin;
898 /* A fast way to get from a psymtab to its symtab (after the first time). */
899 #define PSYMTAB_TO_SYMTAB(pst) \
900 ((pst) -> symtab != NULL ? (pst) -> symtab : psymtab_to_symtab (pst))
903 /* The virtual function table is now an array of structures which have the
904 form { int16 offset, delta; void *pfn; }.
906 In normal virtual function tables, OFFSET is unused.
907 DELTA is the amount which is added to the apparent object's base
908 address in order to point to the actual object to which the
909 virtual function should be applied.
910 PFN is a pointer to the virtual function.
912 Note that this macro is g++ specific (FIXME). */
914 #define VTBL_FNADDR_OFFSET 2
916 /* External variables and functions for the objects described above. */
918 /* See the comment in symfile.c about how current_objfile is used. */
920 extern struct objfile *current_objfile;
922 /* True if we are nested inside psymtab_to_symtab. */
924 extern int currently_reading_symtab;
928 extern int asm_demangle;
930 /* symtab.c lookup functions */
932 extern const char multiple_symbols_ask[];
933 extern const char multiple_symbols_all[];
934 extern const char multiple_symbols_cancel[];
936 const char *multiple_symbols_select_mode (void);
938 int symbol_matches_domain (enum language symbol_language,
939 domain_enum symbol_domain,
942 /* lookup a symbol table by source file name */
944 extern struct symtab *lookup_symtab (const char *);
946 /* lookup a symbol by name (optional block) in language. */
948 extern struct symbol *lookup_symbol_in_language (const char *,
949 const struct block *,
954 /* lookup a symbol by name (optional block, optional symtab)
955 in the current language */
957 extern struct symbol *lookup_symbol (const char *, const struct block *,
958 const domain_enum, int *);
960 /* A default version of lookup_symbol_nonlocal for use by languages
961 that can't think of anything better to do. */
963 extern struct symbol *basic_lookup_symbol_nonlocal (const char *,
965 const struct block *,
968 /* Some helper functions for languages that need to write their own
969 lookup_symbol_nonlocal functions. */
971 /* Lookup a symbol in the static block associated to BLOCK, if there
972 is one; do nothing if BLOCK is NULL or a global block. */
974 extern struct symbol *lookup_symbol_static (const char *name,
975 const char *linkage_name,
976 const struct block *block,
977 const domain_enum domain);
979 /* Lookup a symbol in all files' global blocks (searching psymtabs if
982 extern struct symbol *lookup_symbol_global (const char *name,
983 const char *linkage_name,
984 const struct block *block,
985 const domain_enum domain);
987 /* Lookup a symbol within the block BLOCK. This, unlike
988 lookup_symbol_block, will set SYMTAB and BLOCK_FOUND correctly, and
989 will fix up the symbol if necessary. */
991 extern struct symbol *lookup_symbol_aux_block (const char *name,
992 const char *linkage_name,
993 const struct block *block,
994 const domain_enum domain);
996 /* Lookup a partial symbol. */
998 extern struct partial_symbol *lookup_partial_symbol (struct partial_symtab *,
1003 /* lookup a symbol by name, within a specified block */
1005 extern struct symbol *lookup_block_symbol (const struct block *, const char *,
1009 /* lookup a [struct, union, enum] by name, within a specified block */
1011 extern struct type *lookup_struct (char *, struct block *);
1013 extern struct type *lookup_union (char *, struct block *);
1015 extern struct type *lookup_enum (char *, struct block *);
1017 /* from blockframe.c: */
1019 /* lookup the function symbol corresponding to the address */
1021 extern struct symbol *find_pc_function (CORE_ADDR);
1023 /* lookup the function corresponding to the address and section */
1025 extern struct symbol *find_pc_sect_function (CORE_ADDR, struct obj_section *);
1027 /* lookup function from address, return name, start addr and end addr */
1029 extern int find_pc_partial_function (CORE_ADDR, char **, CORE_ADDR *,
1032 extern void clear_pc_function_cache (void);
1034 /* from symtab.c: */
1036 /* lookup partial symbol table by filename */
1038 extern struct partial_symtab *lookup_partial_symtab (const char *);
1040 /* lookup partial symbol table by address */
1042 extern struct partial_symtab *find_pc_psymtab (CORE_ADDR);
1044 /* lookup partial symbol table by address and section */
1046 extern struct partial_symtab *find_pc_sect_psymtab (CORE_ADDR,
1047 struct obj_section *);
1049 /* lookup full symbol table by address */
1051 extern struct symtab *find_pc_symtab (CORE_ADDR);
1053 /* lookup full symbol table by address and section */
1055 extern struct symtab *find_pc_sect_symtab (CORE_ADDR, struct obj_section *);
1057 /* lookup partial symbol by address */
1059 extern struct partial_symbol *find_pc_psymbol (struct partial_symtab *,
1062 /* lookup partial symbol by address and section */
1064 extern struct partial_symbol *find_pc_sect_psymbol (struct partial_symtab *,
1066 struct obj_section *);
1068 extern int find_pc_line_pc_range (CORE_ADDR, CORE_ADDR *, CORE_ADDR *);
1070 extern void reread_symbols (void);
1072 extern struct type *lookup_transparent_type (const char *);
1073 extern struct type *basic_lookup_transparent_type (const char *);
1076 /* Macro for name of symbol to indicate a file compiled with gcc. */
1077 #ifndef GCC_COMPILED_FLAG_SYMBOL
1078 #define GCC_COMPILED_FLAG_SYMBOL "gcc_compiled."
1081 /* Macro for name of symbol to indicate a file compiled with gcc2. */
1082 #ifndef GCC2_COMPILED_FLAG_SYMBOL
1083 #define GCC2_COMPILED_FLAG_SYMBOL "gcc2_compiled."
1086 /* Functions for dealing with the minimal symbol table, really a misc
1087 address<->symbol mapping for things we don't have debug symbols for. */
1089 extern void prim_record_minimal_symbol (const char *, CORE_ADDR,
1090 enum minimal_symbol_type,
1093 extern struct minimal_symbol *prim_record_minimal_symbol_and_info
1094 (const char *, CORE_ADDR,
1095 enum minimal_symbol_type,
1096 int section, asection * bfd_section, struct objfile *);
1098 extern unsigned int msymbol_hash_iw (const char *);
1100 extern unsigned int msymbol_hash (const char *);
1102 extern struct objfile * msymbol_objfile (struct minimal_symbol *sym);
1105 add_minsym_to_hash_table (struct minimal_symbol *sym,
1106 struct minimal_symbol **table);
1108 extern struct minimal_symbol *lookup_minimal_symbol (const char *,
1112 extern struct minimal_symbol *lookup_minimal_symbol_text (const char *,
1115 struct minimal_symbol *lookup_minimal_symbol_solib_trampoline (const char *,
1119 extern struct minimal_symbol *lookup_minimal_symbol_by_pc_name
1120 (CORE_ADDR, const char *, struct objfile *);
1122 extern struct minimal_symbol *lookup_minimal_symbol_by_pc (CORE_ADDR);
1124 extern struct minimal_symbol
1125 *lookup_minimal_symbol_by_pc_section (CORE_ADDR, struct obj_section *);
1127 extern struct minimal_symbol
1128 *lookup_solib_trampoline_symbol_by_pc (CORE_ADDR);
1130 extern CORE_ADDR find_solib_trampoline_target (struct frame_info *, CORE_ADDR);
1132 extern void init_minimal_symbol_collection (void);
1134 extern struct cleanup *make_cleanup_discard_minimal_symbols (void);
1136 extern void install_minimal_symbols (struct objfile *);
1138 /* Sort all the minimal symbols in OBJFILE. */
1140 extern void msymbols_sort (struct objfile *objfile);
1142 struct symtab_and_line
1144 struct symtab *symtab;
1145 struct obj_section *section;
1146 /* Line number. Line numbers start at 1 and proceed through symtab->nlines.
1147 0 is never a valid line number; it is used to indicate that line number
1148 information is not available. */
1157 extern void init_sal (struct symtab_and_line *sal);
1159 struct symtabs_and_lines
1161 struct symtab_and_line *sals;
1167 /* Some types and macros needed for exception catchpoints.
1168 Can't put these in target.h because symtab_and_line isn't
1169 known there. This file will be included by breakpoint.c,
1170 hppa-tdep.c, etc. */
1172 /* Enums for exception-handling support */
1173 enum exception_event_kind
1181 /* Given a pc value, return line number it is in. Second arg nonzero means
1182 if pc is on the boundary use the previous statement's line number. */
1184 extern struct symtab_and_line find_pc_line (CORE_ADDR, int);
1186 /* Same function, but specify a section as well as an address */
1188 extern struct symtab_and_line find_pc_sect_line (CORE_ADDR,
1189 struct obj_section *, int);
1191 /* Given a symtab and line number, return the pc there. */
1193 extern int find_line_pc (struct symtab *, int, CORE_ADDR *);
1195 extern int find_line_pc_range (struct symtab_and_line, CORE_ADDR *,
1198 extern void resolve_sal_pc (struct symtab_and_line *);
1200 /* Given a string, return the line specified by it. For commands like "list"
1201 and "breakpoint". */
1203 extern struct symtabs_and_lines decode_line_spec (char *, int);
1205 extern struct symtabs_and_lines decode_line_spec_1 (char *, int);
1209 void maintenance_print_symbols (char *, int);
1211 void maintenance_print_psymbols (char *, int);
1213 void maintenance_print_msymbols (char *, int);
1215 void maintenance_print_objfiles (char *, int);
1217 void maintenance_info_symtabs (char *, int);
1219 void maintenance_info_psymtabs (char *, int);
1221 void maintenance_check_symtabs (char *, int);
1225 void maintenance_print_statistics (char *, int);
1227 extern void free_symtab (struct symtab *);
1229 /* Symbol-reading stuff in symfile.c and solib.c. */
1231 extern struct symtab *psymtab_to_symtab (struct partial_symtab *);
1233 extern void clear_solib (void);
1237 extern int identify_source_line (struct symtab *, int, int, CORE_ADDR);
1239 extern void print_source_lines (struct symtab *, int, int, int);
1241 extern void forget_cached_source_info (void);
1243 extern void select_source_symtab (struct symtab *);
1245 extern char **default_make_symbol_completion_list (char *, char *);
1246 extern char **make_symbol_completion_list (char *, char *);
1247 extern char **make_symbol_completion_list_fn (struct cmd_list_element *,
1250 extern char **make_file_symbol_completion_list (char *, char *, char *);
1252 extern char **make_source_files_completion_list (char *, char *);
1256 int matching_obj_sections (struct obj_section *, struct obj_section *);
1258 extern struct partial_symtab *find_main_psymtab (void);
1260 extern struct symtab *find_line_symtab (struct symtab *, int, int *, int *);
1262 extern CORE_ADDR find_function_start_pc (struct gdbarch *,
1263 CORE_ADDR, struct obj_section *);
1265 extern struct symtab_and_line find_function_start_sal (struct symbol *sym,
1270 extern void clear_symtab_users (void);
1272 extern enum language deduce_language_from_filename (char *);
1276 extern int in_prologue (CORE_ADDR pc, CORE_ADDR func_start);
1278 extern CORE_ADDR skip_prologue_using_sal (CORE_ADDR func_addr);
1280 extern struct symbol *fixup_symbol_section (struct symbol *,
1283 extern struct partial_symbol *fixup_psymbol_section (struct partial_symbol
1285 struct objfile *objfile);
1287 /* Symbol searching */
1289 /* When using search_symbols, a list of the following structs is returned.
1290 Callers must free the search list using free_search_symbols! */
1291 struct symbol_search
1293 /* The block in which the match was found. Could be, for example,
1294 STATIC_BLOCK or GLOBAL_BLOCK. */
1297 /* Information describing what was found.
1299 If symtab abd symbol are NOT NULL, then information was found
1301 struct symtab *symtab;
1302 struct symbol *symbol;
1304 /* If msymbol is non-null, then a match was made on something for
1305 which only minimal_symbols exist. */
1306 struct minimal_symbol *msymbol;
1308 /* A link to the next match, or NULL for the end. */
1309 struct symbol_search *next;
1312 extern void search_symbols (char *, domain_enum, int, char **,
1313 struct symbol_search **);
1314 extern void free_search_symbols (struct symbol_search *);
1315 extern struct cleanup *make_cleanup_free_search_symbols (struct symbol_search
1318 /* The name of the ``main'' function.
1319 FIXME: cagney/2001-03-20: Can't make main_name() const since some
1320 of the calling code currently assumes that the string isn't
1322 extern void set_main_name (const char *name);
1323 extern /*const */ char *main_name (void);
1325 /* Check global symbols in objfile. */
1326 struct symbol *lookup_global_symbol_from_objfile (const struct objfile *objfile,
1328 const char *linkage_name,
1329 const domain_enum domain);
1331 extern struct symtabs_and_lines
1332 expand_line_sal (struct symtab_and_line sal);
1334 #endif /* !defined(SYMTAB_H) */