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, 2010
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. */
37 /* Some of the structures in this file are space critical.
38 The space-critical structures are:
40 struct general_symbol_info
44 These structures are laid out to encourage good packing.
45 They use ENUM_BITFIELD and short int fields, and they order the
46 structure members so that fields less than a word are next
47 to each other so they can be packed together. */
49 /* Rearranged: used ENUM_BITFIELD and rearranged field order in
50 all the space critical structures (plus struct minimal_symbol).
51 Memory usage dropped from 99360768 bytes to 90001408 bytes.
52 I measured this with before-and-after tests of
53 "HEAD-old-gdb -readnow HEAD-old-gdb" and
54 "HEAD-new-gdb -readnow HEAD-old-gdb" on native i686-pc-linux-gnu,
55 red hat linux 8, with LD_LIBRARY_PATH=/usr/lib/debug,
56 typing "maint space 1" at the first command prompt.
58 Here is another measurement (from andrew c):
59 # no /usr/lib/debug, just plain glibc, like a normal user
61 (gdb) break internal_error
63 (gdb) maint internal-error
67 gdb gdb_6_0_branch 2003-08-19 space used: 8896512
68 gdb HEAD 2003-08-19 space used: 8904704
69 gdb HEAD 2003-08-21 space used: 8396800 (+symtab.h)
70 gdb HEAD 2003-08-21 space used: 8265728 (+gdbtypes.h)
72 The third line shows the savings from the optimizations in symtab.h.
73 The fourth line shows the savings from the optimizations in
74 gdbtypes.h. Both optimizations are in gdb HEAD now.
76 --chastain 2003-08-21 */
80 /* Define a structure for the information that is common to all symbol types,
81 including minimal symbols, partial symbols, and full symbols. In a
82 multilanguage environment, some language specific information may need to
83 be recorded along with each symbol. */
85 /* This structure is space critical. See space comments at the top. */
87 struct general_symbol_info
89 /* Name of the symbol. This is a required field. Storage for the
90 name is allocated on the objfile_obstack for the associated
91 objfile. For languages like C++ that make a distinction between
92 the mangled name and demangled name, this is the mangled
97 /* Value of the symbol. Which member of this union to use, and what
98 it means, depends on what kind of symbol this is and its
99 SYMBOL_CLASS. See comments there for more details. All of these
100 are in host byte order (though what they point to might be in
101 target byte order, e.g. LOC_CONST_BYTES). */
105 /* The fact that this is a long not a LONGEST mainly limits the
106 range of a LOC_CONST. Since LOC_CONST_BYTES exists, I'm not
107 sure that is a big deal. */
116 /* for opaque typedef struct chain */
118 struct symbol
*chain
;
122 /* Since one and only one language can apply, wrap the language specific
123 information inside a union. */
127 /* This is used by languages which wish to store a demangled name.
128 currently used by Ada, 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 section associated with this symbol. It can be NULL. */
154 struct obj_section
*obj_section
;
157 extern void symbol_set_demangled_name (struct general_symbol_info
*, char *);
159 extern char *symbol_get_demangled_name (const struct general_symbol_info
*);
161 extern CORE_ADDR
symbol_overlayed_address (CORE_ADDR
, struct obj_section
*);
163 /* Note that all the following SYMBOL_* macros are used with the
164 SYMBOL argument being either a partial symbol, a minimal symbol or
165 a full symbol. All three types have a ginfo field. In particular
166 the SYMBOL_INIT_LANGUAGE_SPECIFIC, SYMBOL_DEMANGLED_NAME, etc.
167 macros cannot be entirely substituted by
168 functions, unless the callers are changed to pass in the ginfo
169 field only, instead of the SYMBOL parameter. */
171 #define SYMBOL_VALUE(symbol) (symbol)->ginfo.value.ivalue
172 #define SYMBOL_VALUE_ADDRESS(symbol) (symbol)->ginfo.value.address
173 #define SYMBOL_VALUE_BYTES(symbol) (symbol)->ginfo.value.bytes
174 #define SYMBOL_BLOCK_VALUE(symbol) (symbol)->ginfo.value.block
175 #define SYMBOL_VALUE_CHAIN(symbol) (symbol)->ginfo.value.chain
176 #define SYMBOL_LANGUAGE(symbol) (symbol)->ginfo.language
177 #define SYMBOL_SECTION(symbol) (symbol)->ginfo.section
178 #define SYMBOL_OBJ_SECTION(symbol) (symbol)->ginfo.obj_section
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 /* Set just the linkage name of a symbol; do not try to demangle
188 it. Used for constructs which do not have a mangled name,
189 e.g. struct tags. Unlike SYMBOL_SET_NAMES, linkage_name must
190 be terminated and either already on the objfile's obstack or
191 permanently allocated. */
192 #define SYMBOL_SET_LINKAGE_NAME(symbol,linkage_name) \
193 (symbol)->ginfo.name = (linkage_name)
195 /* Set the linkage and natural names of a symbol, by demangling
197 #define SYMBOL_SET_NAMES(symbol,linkage_name,len,copy_name,objfile) \
198 symbol_set_names (&(symbol)->ginfo, linkage_name, len, copy_name, objfile)
199 extern void symbol_set_names (struct general_symbol_info
*symbol
,
200 const char *linkage_name
, int len
, int copy_name
,
201 struct objfile
*objfile
);
203 /* Now come lots of name accessor macros. Short version as to when to
204 use which: Use SYMBOL_NATURAL_NAME to refer to the name of the
205 symbol in the original source code. Use SYMBOL_LINKAGE_NAME if you
206 want to know what the linker thinks the symbol's name is. Use
207 SYMBOL_PRINT_NAME for output. Use SYMBOL_DEMANGLED_NAME if you
208 specifically need to know whether SYMBOL_NATURAL_NAME and
209 SYMBOL_LINKAGE_NAME are different. */
211 /* Return SYMBOL's "natural" name, i.e. the name that it was called in
212 the original source code. In languages like C++ where symbols may
213 be mangled for ease of manipulation by the linker, this is the
216 #define SYMBOL_NATURAL_NAME(symbol) \
217 (symbol_natural_name (&(symbol)->ginfo))
218 extern char *symbol_natural_name (const struct general_symbol_info
*symbol
);
220 /* Return SYMBOL's name from the point of view of the linker. In
221 languages like C++ where symbols may be mangled for ease of
222 manipulation by the linker, this is the mangled name; otherwise,
223 it's the same as SYMBOL_NATURAL_NAME. */
225 #define SYMBOL_LINKAGE_NAME(symbol) (symbol)->ginfo.name
227 /* Return the demangled name for a symbol based on the language for
228 that symbol. If no demangled name exists, return NULL. */
229 #define SYMBOL_DEMANGLED_NAME(symbol) \
230 (symbol_demangled_name (&(symbol)->ginfo))
231 extern char *symbol_demangled_name (const struct general_symbol_info
*symbol
);
233 /* Macro that returns a version of the name of a symbol that is
234 suitable for output. In C++ this is the "demangled" form of the
235 name if demangle is on and the "mangled" form of the name if
236 demangle is off. In other languages this is just the symbol name.
237 The result should never be NULL. Don't use this for internal
238 purposes (e.g. storing in a hashtable): it's only suitable for
241 #define SYMBOL_PRINT_NAME(symbol) \
242 (demangle ? SYMBOL_NATURAL_NAME (symbol) : SYMBOL_LINKAGE_NAME (symbol))
244 /* Macro that tests a symbol for a match against a specified name string.
245 First test the unencoded name, then looks for and test a C++ encoded
246 name if it exists. Note that whitespace is ignored while attempting to
247 match a C++ encoded name, so that "foo::bar(int,long)" is the same as
248 "foo :: bar (int, long)".
249 Evaluates to zero if the match fails, or nonzero if it succeeds. */
251 /* Macro that tests a symbol for a match against a specified name
252 string. It tests against SYMBOL_NATURAL_NAME, and it ignores
253 whitespace and trailing parentheses. (See strcmp_iw for details
254 about its behavior.) */
256 #define SYMBOL_MATCHES_NATURAL_NAME(symbol, name) \
257 (strcmp_iw (SYMBOL_NATURAL_NAME (symbol), (name)) == 0)
259 /* Macro that returns the name to be used when sorting and searching symbols.
260 In C++, Chill, and Java, we search for the demangled form of a name,
261 and so sort symbols accordingly. In Ada, however, we search by mangled
262 name. If there is no distinct demangled name, then SYMBOL_SEARCH_NAME
263 returns the same value (same pointer) as SYMBOL_LINKAGE_NAME. */
264 #define SYMBOL_SEARCH_NAME(symbol) \
265 (symbol_search_name (&(symbol)->ginfo))
266 extern char *symbol_search_name (const struct general_symbol_info
*);
268 /* Analogous to SYMBOL_MATCHES_NATURAL_NAME, but uses the search
270 #define SYMBOL_MATCHES_SEARCH_NAME(symbol, name) \
271 (strcmp_iw (SYMBOL_SEARCH_NAME (symbol), (name)) == 0)
273 /* Classification types for a minimal symbol. These should be taken as
274 "advisory only", since if gdb can't easily figure out a
275 classification it simply selects mst_unknown. It may also have to
276 guess when it can't figure out which is a better match between two
277 types (mst_data versus mst_bss) for example. Since the minimal
278 symbol info is sometimes derived from the BFD library's view of a
279 file, we need to live with what information bfd supplies. */
281 enum minimal_symbol_type
283 mst_unknown
= 0, /* Unknown type, the default */
284 mst_text
, /* Generally executable instructions */
285 mst_data
, /* Generally initialized data */
286 mst_bss
, /* Generally uninitialized data */
287 mst_abs
, /* Generally absolute (nonrelocatable) */
288 /* GDB uses mst_solib_trampoline for the start address of a shared
289 library trampoline entry. Breakpoints for shared library functions
290 are put there if the shared library is not yet loaded.
291 After the shared library is loaded, lookup_minimal_symbol will
292 prefer the minimal symbol from the shared library (usually
293 a mst_text symbol) over the mst_solib_trampoline symbol, and the
294 breakpoints will be moved to their true address in the shared
295 library via breakpoint_re_set. */
296 mst_solib_trampoline
, /* Shared library trampoline code */
297 /* For the mst_file* types, the names are only guaranteed to be unique
298 within a given .o file. */
299 mst_file_text
, /* Static version of mst_text */
300 mst_file_data
, /* Static version of mst_data */
301 mst_file_bss
/* Static version of mst_bss */
304 /* Define a simple structure used to hold some very basic information about
305 all defined global symbols (text, data, bss, abs, etc). The only required
306 information is the general_symbol_info.
308 In many cases, even if a file was compiled with no special options for
309 debugging at all, as long as was not stripped it will contain sufficient
310 information to build a useful minimal symbol table using this structure.
311 Even when a file contains enough debugging information to build a full
312 symbol table, these minimal symbols are still useful for quickly mapping
313 between names and addresses, and vice versa. They are also sometimes
314 used to figure out what full symbol table entries need to be read in. */
316 struct minimal_symbol
319 /* The general symbol info required for all types of symbols.
321 The SYMBOL_VALUE_ADDRESS contains the address that this symbol
324 struct general_symbol_info ginfo
;
326 /* Size of this symbol. end_psymtab in dbxread.c uses this
327 information to calculate the end of the partial symtab based on the
328 address of the last symbol plus the size of the last symbol. */
332 /* Which source file is this symbol in? Only relevant for mst_file_*. */
335 /* Classification type for this minimal symbol. */
337 ENUM_BITFIELD(minimal_symbol_type
) type
: 8;
339 /* Two flag bits provided for the use of the target. */
340 unsigned int target_flag_1
: 1;
341 unsigned int target_flag_2
: 1;
343 /* Minimal symbols with the same hash key are kept on a linked
344 list. This is the link. */
346 struct minimal_symbol
*hash_next
;
348 /* Minimal symbols are stored in two different hash tables. This is
349 the `next' pointer for the demangled hash table. */
351 struct minimal_symbol
*demangled_hash_next
;
354 #define MSYMBOL_TARGET_FLAG_1(msymbol) (msymbol)->target_flag_1
355 #define MSYMBOL_TARGET_FLAG_2(msymbol) (msymbol)->target_flag_2
356 #define MSYMBOL_SIZE(msymbol) (msymbol)->size
357 #define MSYMBOL_TYPE(msymbol) (msymbol)->type
361 /* Represent one symbol name; a variable, constant, function or typedef. */
363 /* Different name domains for symbols. Looking up a symbol specifies a
364 domain and ignores symbol definitions in other name domains. */
366 typedef enum domain_enum_tag
368 /* UNDEF_DOMAIN is used when a domain has not been discovered or
369 none of the following apply. This usually indicates an error either
370 in the symbol information or in gdb's handling of symbols. */
374 /* VAR_DOMAIN is the usual domain. In C, this contains variables,
375 function names, typedef names and enum type values. */
379 /* STRUCT_DOMAIN is used in C to hold struct, union and enum type names.
380 Thus, if `struct foo' is used in a C program, it produces a symbol named
381 `foo' in the STRUCT_DOMAIN. */
385 /* LABEL_DOMAIN may be used for names of labels (for gotos). */
389 /* Searching domains. These overlap with VAR_DOMAIN, providing
390 some granularity with the search_symbols function. */
392 /* Everything in VAR_DOMAIN minus FUNCTIONS_DOMAIN and
396 /* All functions -- for some reason not methods, though. */
399 /* All defined types */
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
421 in the original debug format. SYMBOL_REGISTER_OPS holds a
422 function that can be called to transform this into the
423 actual register number this represents in a specific target
424 architecture (gdbarch).
426 For some symbol formats (stabs, for some compilers at least),
427 the compiler generates two symbols, an argument and a register.
428 In some cases we combine them to a single LOC_REGISTER in symbol
429 reading, but currently not for all cases (e.g. it's passed on the
430 stack and then loaded into a register). */
434 /* It's an argument; the value is at SYMBOL_VALUE offset in arglist. */
438 /* Value address is at SYMBOL_VALUE offset in arglist. */
442 /* Value is in specified register. Just like LOC_REGISTER except the
443 register holds the address of the argument instead of the argument
444 itself. This is currently used for the passing of structs and unions
445 on sparc and hppa. It is also used for call by reference where the
446 address is in a register, at least by mipsread.c. */
450 /* Value is a local variable at SYMBOL_VALUE offset in stack frame. */
454 /* Value not used; definition in SYMBOL_TYPE. Symbols in the domain
455 STRUCT_DOMAIN all have this class. */
459 /* Value is address SYMBOL_VALUE_ADDRESS in the code */
463 /* In a symbol table, value is SYMBOL_BLOCK_VALUE of a `struct block'.
464 In a partial symbol table, SYMBOL_VALUE_ADDRESS is the start address
465 of the block. Function names have this class. */
469 /* Value is a constant byte-sequence pointed to by SYMBOL_VALUE_BYTES, in
470 target byte order. */
474 /* Value is at fixed address, but the address of the variable has
475 to be determined from the minimal symbol table whenever the
476 variable is referenced.
477 This happens if debugging information for a global symbol is
478 emitted and the corresponding minimal symbol is defined
479 in another object file or runtime common storage.
480 The linker might even remove the minimal symbol if the global
481 symbol is never referenced, in which case the symbol remains
484 GDB would normally find the symbol in the minimal symbol table if it will
485 not find it in the full symbol table. But a reference to an external
486 symbol in a local block shadowing other definition requires full symbol
487 without possibly having its address available for LOC_STATIC. Testcase
488 is provided as `gdb.dwarf2/dw2-unresolved.exp'. */
492 /* The variable does not actually exist in the program.
493 The value is ignored. */
497 /* The variable's address is computed by a set of location
498 functions (see "struct symbol_computed_ops" below). */
502 /* The methods needed to implement LOC_COMPUTED. These methods can
503 use the symbol's .aux_value for additional per-symbol information.
505 At present this is only used to implement location expressions. */
507 struct symbol_computed_ops
510 /* Return the value of the variable SYMBOL, relative to the stack
511 frame FRAME. If the variable has been optimized out, return
514 Iff `read_needs_frame (SYMBOL)' is zero, then FRAME may be zero. */
516 struct value
*(*read_variable
) (struct symbol
* symbol
,
517 struct frame_info
* frame
);
519 /* Return non-zero if we need a frame to find the value of the SYMBOL. */
520 int (*read_needs_frame
) (struct symbol
* symbol
);
522 /* Write to STREAM a natural-language description of the location of
523 SYMBOL, in the context of ADDR. */
524 void (*describe_location
) (struct symbol
* symbol
, CORE_ADDR addr
,
525 struct ui_file
* stream
);
527 /* Tracepoint support. Append bytecodes to the tracepoint agent
528 expression AX that push the address of the object SYMBOL. Set
529 VALUE appropriately. Note --- for objects in registers, this
530 needn't emit any code; as long as it sets VALUE properly, then
531 the caller will generate the right code in the process of
532 treating this as an lvalue or rvalue. */
534 void (*tracepoint_var_ref
) (struct symbol
*symbol
, struct gdbarch
*gdbarch
,
535 struct agent_expr
*ax
, struct axs_value
*value
);
538 /* Functions used with LOC_REGISTER and LOC_REGPARM_ADDR. */
540 struct symbol_register_ops
542 int (*register_number
) (struct symbol
*symbol
, struct gdbarch
*gdbarch
);
545 /* This structure is space critical. See space comments at the top. */
550 /* The general symbol info required for all types of symbols. */
552 struct general_symbol_info ginfo
;
554 /* Data type of value */
558 /* The symbol table containing this symbol. This is the file
559 associated with LINE. It can be NULL during symbols read-in but it is
560 never NULL during normal operation. */
561 struct symtab
*symtab
;
565 ENUM_BITFIELD(domain_enum_tag
) domain
: 6;
568 /* NOTE: cagney/2003-11-02: The fields "aclass" and "ops" contain
569 overlapping information. By creating a per-aclass ops vector, or
570 using the aclass as an index into an ops table, the aclass and
571 ops fields can be merged. The latter, for instance, would shave
572 32-bits from each symbol (relative to a symbol lookup, any table
573 index overhead would be in the noise). */
575 ENUM_BITFIELD(address_class
) aclass
: 6;
577 /* Whether this is an argument. */
579 unsigned is_argument
: 1;
581 /* Whether this is an inlined function (class LOC_BLOCK only). */
582 unsigned is_inlined
: 1;
584 /* Line number of this symbol's definition, except for inlined
585 functions. For an inlined function (class LOC_BLOCK and
586 SYMBOL_INLINED set) this is the line number of the function's call
587 site. Inlined function symbols are not definitions, and they are
588 never found by symbol table lookup.
590 FIXME: Should we really make the assumption that nobody will try
591 to debug files longer than 64K lines? What about machine
592 generated programs? */
596 /* Method's for symbol's of this class. */
597 /* NOTE: cagney/2003-11-02: See comment above attached to "aclass". */
601 /* Used with LOC_COMPUTED. */
602 const struct symbol_computed_ops
*ops_computed
;
604 /* Used with LOC_REGISTER and LOC_REGPARM_ADDR. */
605 const struct symbol_register_ops
*ops_register
;
608 /* An arbitrary data pointer, allowing symbol readers to record
609 additional information on a per-symbol basis. Note that this data
610 must be allocated using the same obstack as the symbol itself. */
611 /* So far it is only used by LOC_COMPUTED to
612 find the location information. For a LOC_BLOCK symbol
613 for a function in a compilation unit compiled with DWARF 2
614 information, this is information used internally by the DWARF 2
615 code --- specifically, the location expression for the frame
616 base for this function. */
617 /* FIXME drow/2003-02-21: For the LOC_BLOCK case, it might be better
618 to add a magic symbol to the block containing this information,
619 or to have a generic debug info annotation slot for symbols. */
623 struct symbol
*hash_next
;
627 #define SYMBOL_DOMAIN(symbol) (symbol)->domain
628 #define SYMBOL_CLASS(symbol) (symbol)->aclass
629 #define SYMBOL_IS_ARGUMENT(symbol) (symbol)->is_argument
630 #define SYMBOL_INLINED(symbol) (symbol)->is_inlined
631 #define SYMBOL_TYPE(symbol) (symbol)->type
632 #define SYMBOL_LINE(symbol) (symbol)->line
633 #define SYMBOL_SYMTAB(symbol) (symbol)->symtab
634 #define SYMBOL_COMPUTED_OPS(symbol) (symbol)->ops.ops_computed
635 #define SYMBOL_REGISTER_OPS(symbol) (symbol)->ops.ops_register
636 #define SYMBOL_LOCATION_BATON(symbol) (symbol)->aux_value
638 /* Each item represents a line-->pc (or the reverse) mapping. This is
639 somewhat more wasteful of space than one might wish, but since only
640 the files which are actually debugged are read in to core, we don't
643 struct linetable_entry
649 /* The order of entries in the linetable is significant. They should
650 be sorted by increasing values of the pc field. If there is more than
651 one entry for a given pc, then I'm not sure what should happen (and
652 I not sure whether we currently handle it the best way).
654 Example: a C for statement generally looks like this
656 10 0x100 - for the init/test part of a for stmt.
659 10 0x400 - for the increment part of a for stmt.
661 If an entry has a line number of zero, it marks the start of a PC
662 range for which no line number information is available. It is
663 acceptable, though wasteful of table space, for such a range to be
670 /* Actually NITEMS elements. If you don't like this use of the
671 `struct hack', you can shove it up your ANSI (seriously, if the
672 committee tells us how to do it, we can probably go along). */
673 struct linetable_entry item
[1];
676 /* How to relocate the symbols from each section in a symbol file.
677 Each struct contains an array of offsets.
678 The ordering and meaning of the offsets is file-type-dependent;
679 typically it is indexed by section numbers or symbol types or
682 To give us flexibility in changing the internal representation
683 of these offsets, the ANOFFSET macro must be used to insert and
684 extract offset values in the struct. */
686 struct section_offsets
688 CORE_ADDR offsets
[1]; /* As many as needed. */
691 #define ANOFFSET(secoff, whichone) \
693 ? (internal_error (__FILE__, __LINE__, _("Section index is uninitialized")), -1) \
694 : secoff->offsets[whichone])
696 /* The size of a section_offsets table for N sections. */
697 #define SIZEOF_N_SECTION_OFFSETS(n) \
698 (sizeof (struct section_offsets) \
699 + sizeof (((struct section_offsets *) 0)->offsets) * ((n)-1))
701 /* Each source file or header is represented by a struct symtab.
702 These objects are chained through the `next' field. */
707 /* Chain of all existing symtabs. */
711 /* List of all symbol scope blocks for this symtab. May be shared
712 between different symtabs (and normally is for all the symtabs
713 in a given compilation unit). */
715 struct blockvector
*blockvector
;
717 /* Table mapping core addresses to line numbers for this file.
718 Can be NULL if none. Never shared between different symtabs. */
720 struct linetable
*linetable
;
722 /* Section in objfile->section_offsets for the blockvector and
723 the linetable. Probably always SECT_OFF_TEXT. */
725 int block_line_section
;
727 /* If several symtabs share a blockvector, exactly one of them
728 should be designated the primary, so that the blockvector
729 is relocated exactly once by objfile_relocate. */
733 /* The macro table for this symtab. Like the blockvector, this
734 may be shared between different symtabs --- and normally is for
735 all the symtabs in a given compilation unit. */
736 struct macro_table
*macro_table
;
738 /* Name of this source file. */
742 /* Directory in which it was compiled, or NULL if we don't know. */
746 /* This component says how to free the data we point to:
747 free_nothing => do nothing; some other symtab will free
748 the data this one uses.
749 free_linetable => free just the linetable. FIXME: Is this redundant
750 with the primary field? */
754 free_nothing
, free_linetable
758 /* A function to call to free space, if necessary. This is IN
759 ADDITION to the action indicated by free_code. */
761 void (*free_func
)(struct symtab
*symtab
);
763 /* Total number of lines found in source file. */
767 /* line_charpos[N] is the position of the (N-1)th line of the
768 source file. "position" means something we can lseek() to; it
769 is not guaranteed to be useful any other way. */
773 /* Language of this source file. */
775 enum language language
;
777 /* String that identifies the format of the debugging information, such
778 as "stabs", "dwarf 1", "dwarf 2", "coff", etc. This is mostly useful
779 for automated testing of gdb but may also be information that is
780 useful to the user. */
784 /* String of producer version information. May be zero. */
788 /* Full name of file as found by searching the source path.
789 NULL if not yet known. */
793 /* Object file from which this symbol information was read. */
795 struct objfile
*objfile
;
799 #define BLOCKVECTOR(symtab) (symtab)->blockvector
800 #define LINETABLE(symtab) (symtab)->linetable
801 #define SYMTAB_PSPACE(symtab) (symtab)->objfile->pspace
804 /* The virtual function table is now an array of structures which have the
805 form { int16 offset, delta; void *pfn; }.
807 In normal virtual function tables, OFFSET is unused.
808 DELTA is the amount which is added to the apparent object's base
809 address in order to point to the actual object to which the
810 virtual function should be applied.
811 PFN is a pointer to the virtual function.
813 Note that this macro is g++ specific (FIXME). */
815 #define VTBL_FNADDR_OFFSET 2
817 /* External variables and functions for the objects described above. */
819 /* See the comment in symfile.c about how current_objfile is used. */
821 extern struct objfile
*current_objfile
;
823 /* True if we are nested inside psymtab_to_symtab. */
825 extern int currently_reading_symtab
;
829 extern int asm_demangle
;
831 /* symtab.c lookup functions */
833 extern const char multiple_symbols_ask
[];
834 extern const char multiple_symbols_all
[];
835 extern const char multiple_symbols_cancel
[];
837 const char *multiple_symbols_select_mode (void);
839 int symbol_matches_domain (enum language symbol_language
,
840 domain_enum symbol_domain
,
843 /* lookup a symbol table by source file name */
845 extern struct symtab
*lookup_symtab (const char *);
847 /* lookup a symbol by name (optional block) in language. */
849 extern struct symbol
*lookup_symbol_in_language (const char *,
850 const struct block
*,
855 /* lookup a symbol by name (optional block, optional symtab)
856 in the current language */
858 extern struct symbol
*lookup_symbol (const char *, const struct block
*,
859 const domain_enum
, int *);
861 /* A default version of lookup_symbol_nonlocal for use by languages
862 that can't think of anything better to do. */
864 extern struct symbol
*basic_lookup_symbol_nonlocal (const char *,
865 const struct block
*,
868 /* Some helper functions for languages that need to write their own
869 lookup_symbol_nonlocal functions. */
871 /* Lookup a symbol in the static block associated to BLOCK, if there
872 is one; do nothing if BLOCK is NULL or a global block. */
874 extern struct symbol
*lookup_symbol_static (const char *name
,
875 const struct block
*block
,
876 const domain_enum domain
);
878 /* Lookup a symbol in all files' global blocks (searching psymtabs if
881 extern struct symbol
*lookup_symbol_global (const char *name
,
882 const struct block
*block
,
883 const domain_enum domain
);
885 /* Lookup a symbol within the block BLOCK. This, unlike
886 lookup_symbol_block, will set SYMTAB and BLOCK_FOUND correctly, and
887 will fix up the symbol if necessary. */
889 extern struct symbol
*lookup_symbol_aux_block (const char *name
,
890 const struct block
*block
,
891 const domain_enum domain
);
893 /* Lookup a symbol only in the file static scope of all the objfiles. */
895 struct symbol
*lookup_static_symbol_aux (const char *name
,
896 const domain_enum domain
);
899 /* lookup a symbol by name, within a specified block */
901 extern struct symbol
*lookup_block_symbol (const struct block
*, const char *,
904 /* lookup a [struct, union, enum] by name, within a specified block */
906 extern struct type
*lookup_struct (char *, struct block
*);
908 extern struct type
*lookup_union (char *, struct block
*);
910 extern struct type
*lookup_enum (char *, struct block
*);
912 /* from blockframe.c: */
914 /* lookup the function symbol corresponding to the address */
916 extern struct symbol
*find_pc_function (CORE_ADDR
);
918 /* lookup the function corresponding to the address and section */
920 extern struct symbol
*find_pc_sect_function (CORE_ADDR
, struct obj_section
*);
922 /* lookup function from address, return name, start addr and end addr */
924 extern int find_pc_partial_function (CORE_ADDR
, char **, CORE_ADDR
*,
927 extern void clear_pc_function_cache (void);
929 /* lookup partial symbol table by address and section */
931 extern struct symtab
*find_pc_sect_symtab_via_partial (CORE_ADDR
,
932 struct obj_section
*);
934 /* lookup full symbol table by address */
936 extern struct symtab
*find_pc_symtab (CORE_ADDR
);
938 /* lookup full symbol table by address and section */
940 extern struct symtab
*find_pc_sect_symtab (CORE_ADDR
, struct obj_section
*);
942 extern int find_pc_line_pc_range (CORE_ADDR
, CORE_ADDR
*, CORE_ADDR
*);
944 extern void reread_symbols (void);
946 extern struct type
*lookup_transparent_type (const char *);
947 extern struct type
*basic_lookup_transparent_type (const char *);
950 /* Macro for name of symbol to indicate a file compiled with gcc. */
951 #ifndef GCC_COMPILED_FLAG_SYMBOL
952 #define GCC_COMPILED_FLAG_SYMBOL "gcc_compiled."
955 /* Macro for name of symbol to indicate a file compiled with gcc2. */
956 #ifndef GCC2_COMPILED_FLAG_SYMBOL
957 #define GCC2_COMPILED_FLAG_SYMBOL "gcc2_compiled."
960 /* Functions for dealing with the minimal symbol table, really a misc
961 address<->symbol mapping for things we don't have debug symbols for. */
963 extern void prim_record_minimal_symbol (const char *, CORE_ADDR
,
964 enum minimal_symbol_type
,
967 extern struct minimal_symbol
*prim_record_minimal_symbol_full
968 (const char *, int, int, CORE_ADDR
,
969 enum minimal_symbol_type
,
970 int section
, asection
* bfd_section
, struct objfile
*);
972 extern struct minimal_symbol
*prim_record_minimal_symbol_and_info
973 (const char *, CORE_ADDR
,
974 enum minimal_symbol_type
,
975 int section
, asection
* bfd_section
, struct objfile
*);
977 extern unsigned int msymbol_hash_iw (const char *);
979 extern unsigned int msymbol_hash (const char *);
981 extern struct objfile
* msymbol_objfile (struct minimal_symbol
*sym
);
984 add_minsym_to_hash_table (struct minimal_symbol
*sym
,
985 struct minimal_symbol
**table
);
987 extern struct minimal_symbol
*lookup_minimal_symbol (const char *,
991 extern struct minimal_symbol
*lookup_minimal_symbol_text (const char *,
994 struct minimal_symbol
*lookup_minimal_symbol_solib_trampoline (const char *,
998 extern struct minimal_symbol
*lookup_minimal_symbol_by_pc_name
999 (CORE_ADDR
, const char *, struct objfile
*);
1001 extern struct minimal_symbol
*lookup_minimal_symbol_by_pc (CORE_ADDR
);
1003 extern struct minimal_symbol
*
1004 lookup_minimal_symbol_and_objfile (const char *,
1007 extern struct minimal_symbol
1008 *lookup_minimal_symbol_by_pc_section (CORE_ADDR
, struct obj_section
*);
1010 extern struct minimal_symbol
1011 *lookup_solib_trampoline_symbol_by_pc (CORE_ADDR
);
1013 extern CORE_ADDR
find_solib_trampoline_target (struct frame_info
*, CORE_ADDR
);
1015 extern void init_minimal_symbol_collection (void);
1017 extern struct cleanup
*make_cleanup_discard_minimal_symbols (void);
1019 extern void install_minimal_symbols (struct objfile
*);
1021 /* Sort all the minimal symbols in OBJFILE. */
1023 extern void msymbols_sort (struct objfile
*objfile
);
1025 struct symtab_and_line
1027 /* The program space of this sal. */
1028 struct program_space
*pspace
;
1030 struct symtab
*symtab
;
1031 struct obj_section
*section
;
1032 /* Line number. Line numbers start at 1 and proceed through symtab->nlines.
1033 0 is never a valid line number; it is used to indicate that line number
1034 information is not available. */
1043 extern void init_sal (struct symtab_and_line
*sal
);
1045 struct symtabs_and_lines
1047 struct symtab_and_line
*sals
;
1053 /* Some types and macros needed for exception catchpoints.
1054 Can't put these in target.h because symtab_and_line isn't
1055 known there. This file will be included by breakpoint.c,
1056 hppa-tdep.c, etc. */
1058 /* Enums for exception-handling support */
1059 enum exception_event_kind
1067 /* Given a pc value, return line number it is in. Second arg nonzero means
1068 if pc is on the boundary use the previous statement's line number. */
1070 extern struct symtab_and_line
find_pc_line (CORE_ADDR
, int);
1072 /* Same function, but specify a section as well as an address */
1074 extern struct symtab_and_line
find_pc_sect_line (CORE_ADDR
,
1075 struct obj_section
*, int);
1077 /* Given a symtab and line number, return the pc there. */
1079 extern int find_line_pc (struct symtab
*, int, CORE_ADDR
*);
1081 extern int find_line_pc_range (struct symtab_and_line
, CORE_ADDR
*,
1084 extern void resolve_sal_pc (struct symtab_and_line
*);
1086 /* Given a string, return the line specified by it. For commands like "list"
1087 and "breakpoint". */
1089 extern struct symtabs_and_lines
decode_line_spec (char *, int);
1091 extern struct symtabs_and_lines
decode_line_spec_1 (char *, int);
1095 void maintenance_print_symbols (char *, int);
1097 void maintenance_print_psymbols (char *, int);
1099 void maintenance_print_msymbols (char *, int);
1101 void maintenance_print_objfiles (char *, int);
1103 void maintenance_info_symtabs (char *, int);
1105 void maintenance_info_psymtabs (char *, int);
1107 void maintenance_check_symtabs (char *, int);
1111 void maintenance_print_statistics (char *, int);
1113 extern void free_symtab (struct symtab
*);
1115 /* Symbol-reading stuff in symfile.c and solib.c. */
1117 extern void clear_solib (void);
1121 extern int identify_source_line (struct symtab
*, int, int, CORE_ADDR
);
1123 extern void print_source_lines (struct symtab
*, int, int, int);
1125 extern void forget_cached_source_info (void);
1127 extern void select_source_symtab (struct symtab
*);
1129 extern char **default_make_symbol_completion_list_break_on
1130 (char *text
, char *word
, const char *break_on
);
1131 extern char **default_make_symbol_completion_list (char *, char *);
1132 extern char **make_symbol_completion_list (char *, char *);
1133 extern char **make_symbol_completion_list_fn (struct cmd_list_element
*,
1136 extern char **make_file_symbol_completion_list (char *, char *, char *);
1138 extern char **make_source_files_completion_list (char *, char *);
1142 int matching_obj_sections (struct obj_section
*, struct obj_section
*);
1144 extern const char *find_main_filename (void);
1146 extern struct symtab
*find_line_symtab (struct symtab
*, int, int *, int *);
1148 extern struct symtab_and_line
find_function_start_sal (struct symbol
*sym
,
1151 extern void skip_prologue_sal (struct symtab_and_line
*);
1155 extern void clear_symtab_users (void);
1157 extern enum language
deduce_language_from_filename (const char *);
1161 extern int in_prologue (struct gdbarch
*gdbarch
,
1162 CORE_ADDR pc
, CORE_ADDR func_start
);
1164 extern CORE_ADDR
skip_prologue_using_sal (struct gdbarch
*gdbarch
,
1165 CORE_ADDR func_addr
);
1167 extern struct symbol
*fixup_symbol_section (struct symbol
*,
1170 /* Symbol searching */
1172 /* When using search_symbols, a list of the following structs is returned.
1173 Callers must free the search list using free_search_symbols! */
1174 struct symbol_search
1176 /* The block in which the match was found. Could be, for example,
1177 STATIC_BLOCK or GLOBAL_BLOCK. */
1180 /* Information describing what was found.
1182 If symtab abd symbol are NOT NULL, then information was found
1184 struct symtab
*symtab
;
1185 struct symbol
*symbol
;
1187 /* If msymbol is non-null, then a match was made on something for
1188 which only minimal_symbols exist. */
1189 struct minimal_symbol
*msymbol
;
1191 /* A link to the next match, or NULL for the end. */
1192 struct symbol_search
*next
;
1195 extern void search_symbols (char *, domain_enum
, int, char **,
1196 struct symbol_search
**);
1197 extern void free_search_symbols (struct symbol_search
*);
1198 extern struct cleanup
*make_cleanup_free_search_symbols (struct symbol_search
1201 /* The name of the ``main'' function.
1202 FIXME: cagney/2001-03-20: Can't make main_name() const since some
1203 of the calling code currently assumes that the string isn't
1205 extern void set_main_name (const char *name
);
1206 extern /*const */ char *main_name (void);
1208 /* Check global symbols in objfile. */
1209 struct symbol
*lookup_global_symbol_from_objfile (const struct objfile
*objfile
,
1211 const domain_enum domain
);
1213 extern struct symtabs_and_lines
expand_line_sal (struct symtab_and_line sal
);
1215 /* Return 1 if the supplied producer string matches the ARM RealView
1216 compiler (armcc). */
1217 int producer_is_realview (const char *producer
);
1219 void fixup_section (struct general_symbol_info
*ginfo
,
1220 CORE_ADDR addr
, struct objfile
*objfile
);
1222 struct objfile
*lookup_objfile_from_block (const struct block
*block
);
1224 #endif /* !defined(SYMTAB_H) */