1 /* Symbol table definitions for GDB.
3 Copyright (C) 1986, 1988-2004, 2007-2012 Free Software Foundation,
6 This file is part of GDB.
8 This program is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 3 of the License, or
11 (at your option) any later version.
13 This program is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with this program. If not, see <http://www.gnu.org/licenses/>. */
21 #if !defined (SYMTAB_H)
26 /* Opaque declarations. */
39 /* Some of the structures in this file are space critical.
40 The space-critical structures are:
42 struct general_symbol_info
46 These structures are laid out to encourage good packing.
47 They use ENUM_BITFIELD and short int fields, and they order the
48 structure members so that fields less than a word are next
49 to each other so they can be packed together. */
51 /* Rearranged: used ENUM_BITFIELD and rearranged field order in
52 all the space critical structures (plus struct minimal_symbol).
53 Memory usage dropped from 99360768 bytes to 90001408 bytes.
54 I measured this with before-and-after tests of
55 "HEAD-old-gdb -readnow HEAD-old-gdb" and
56 "HEAD-new-gdb -readnow HEAD-old-gdb" on native i686-pc-linux-gnu,
57 red hat linux 8, with LD_LIBRARY_PATH=/usr/lib/debug,
58 typing "maint space 1" at the first command prompt.
60 Here is another measurement (from andrew c):
61 # no /usr/lib/debug, just plain glibc, like a normal user
63 (gdb) break internal_error
65 (gdb) maint internal-error
69 gdb gdb_6_0_branch 2003-08-19 space used: 8896512
70 gdb HEAD 2003-08-19 space used: 8904704
71 gdb HEAD 2003-08-21 space used: 8396800 (+symtab.h)
72 gdb HEAD 2003-08-21 space used: 8265728 (+gdbtypes.h)
74 The third line shows the savings from the optimizations in symtab.h.
75 The fourth line shows the savings from the optimizations in
76 gdbtypes.h. Both optimizations are in gdb HEAD now.
78 --chastain 2003-08-21 */
80 /* Struct for storing C++ specific information. Allocated when needed. */
87 /* Define a structure for the information that is common to all symbol types,
88 including minimal symbols, partial symbols, and full symbols. In a
89 multilanguage environment, some language specific information may need to
90 be recorded along with each symbol. */
92 /* This structure is space critical. See space comments at the top. */
94 struct general_symbol_info
96 /* Name of the symbol. This is a required field. Storage for the
97 name is allocated on the objfile_obstack for the associated
98 objfile. For languages like C++ that make a distinction between
99 the mangled name and demangled name, this is the mangled
104 /* Value of the symbol. Which member of this union to use, and what
105 it means, depends on what kind of symbol this is and its
106 SYMBOL_CLASS. See comments there for more details. All of these
107 are in host byte order (though what they point to might be in
108 target byte order, e.g. LOC_CONST_BYTES). */
112 /* The fact that this is a long not a LONGEST mainly limits the
113 range of a LOC_CONST. Since LOC_CONST_BYTES exists, I'm not
114 sure that is a big deal. */
123 /* For opaque typedef struct chain. */
125 struct symbol
*chain
;
129 /* Since one and only one language can apply, wrap the language specific
130 information inside a union. */
134 /* This is used by languages which wish to store a demangled name.
135 currently used by Ada, Java, and Objective C. */
138 char *demangled_name
;
142 struct cplus_specific
*cplus_specific
;
146 /* Record the source code language that applies to this symbol.
147 This is used to select one of the fields from the language specific
150 ENUM_BITFIELD(language
) language
: 8;
152 /* Which section is this symbol in? This is an index into
153 section_offsets for this objfile. Negative means that the symbol
154 does not get relocated relative to a section.
155 Disclaimer: currently this is just used for xcoff, so don't
156 expect all symbol-reading code to set it correctly (the ELF code
157 also tries to set it correctly). */
161 /* The section associated with this symbol. It can be NULL. */
163 struct obj_section
*obj_section
;
166 extern void symbol_set_demangled_name (struct general_symbol_info
*, char *,
169 extern char *symbol_get_demangled_name (const struct general_symbol_info
*);
171 extern CORE_ADDR
symbol_overlayed_address (CORE_ADDR
, struct obj_section
*);
173 /* Note that all the following SYMBOL_* macros are used with the
174 SYMBOL argument being either a partial symbol, a minimal symbol or
175 a full symbol. All three types have a ginfo field. In particular
176 the SYMBOL_SET_LANGUAGE, SYMBOL_DEMANGLED_NAME, etc.
177 macros cannot be entirely substituted by
178 functions, unless the callers are changed to pass in the ginfo
179 field only, instead of the SYMBOL parameter. */
181 #define SYMBOL_VALUE(symbol) (symbol)->ginfo.value.ivalue
182 #define SYMBOL_VALUE_ADDRESS(symbol) (symbol)->ginfo.value.address
183 #define SYMBOL_VALUE_BYTES(symbol) (symbol)->ginfo.value.bytes
184 #define SYMBOL_BLOCK_VALUE(symbol) (symbol)->ginfo.value.block
185 #define SYMBOL_VALUE_CHAIN(symbol) (symbol)->ginfo.value.chain
186 #define SYMBOL_LANGUAGE(symbol) (symbol)->ginfo.language
187 #define SYMBOL_SECTION(symbol) (symbol)->ginfo.section
188 #define SYMBOL_OBJ_SECTION(symbol) (symbol)->ginfo.obj_section
190 /* Initializes the language dependent portion of a symbol
191 depending upon the language for the symbol. */
192 #define SYMBOL_SET_LANGUAGE(symbol,language) \
193 (symbol_set_language (&(symbol)->ginfo, (language)))
194 extern void symbol_set_language (struct general_symbol_info
*symbol
,
195 enum language language
);
197 /* Set just the linkage name of a symbol; do not try to demangle
198 it. Used for constructs which do not have a mangled name,
199 e.g. struct tags. Unlike SYMBOL_SET_NAMES, linkage_name must
200 be terminated and either already on the objfile's obstack or
201 permanently allocated. */
202 #define SYMBOL_SET_LINKAGE_NAME(symbol,linkage_name) \
203 (symbol)->ginfo.name = (linkage_name)
205 /* Set the linkage and natural names of a symbol, by demangling
207 #define SYMBOL_SET_NAMES(symbol,linkage_name,len,copy_name,objfile) \
208 symbol_set_names (&(symbol)->ginfo, linkage_name, len, copy_name, objfile)
209 extern void symbol_set_names (struct general_symbol_info
*symbol
,
210 const char *linkage_name
, int len
, int copy_name
,
211 struct objfile
*objfile
);
213 /* Now come lots of name accessor macros. Short version as to when to
214 use which: Use SYMBOL_NATURAL_NAME to refer to the name of the
215 symbol in the original source code. Use SYMBOL_LINKAGE_NAME if you
216 want to know what the linker thinks the symbol's name is. Use
217 SYMBOL_PRINT_NAME for output. Use SYMBOL_DEMANGLED_NAME if you
218 specifically need to know whether SYMBOL_NATURAL_NAME and
219 SYMBOL_LINKAGE_NAME are different. */
221 /* Return SYMBOL's "natural" name, i.e. the name that it was called in
222 the original source code. In languages like C++ where symbols may
223 be mangled for ease of manipulation by the linker, this is the
226 #define SYMBOL_NATURAL_NAME(symbol) \
227 (symbol_natural_name (&(symbol)->ginfo))
228 extern char *symbol_natural_name (const struct general_symbol_info
*symbol
);
230 /* Return SYMBOL's name from the point of view of the linker. In
231 languages like C++ where symbols may be mangled for ease of
232 manipulation by the linker, this is the mangled name; otherwise,
233 it's the same as SYMBOL_NATURAL_NAME. */
235 #define SYMBOL_LINKAGE_NAME(symbol) (symbol)->ginfo.name
237 /* Return the demangled name for a symbol based on the language for
238 that symbol. If no demangled name exists, return NULL. */
239 #define SYMBOL_DEMANGLED_NAME(symbol) \
240 (symbol_demangled_name (&(symbol)->ginfo))
241 extern char *symbol_demangled_name (const struct general_symbol_info
*symbol
);
243 /* Macro that returns a version of the name of a symbol that is
244 suitable for output. In C++ this is the "demangled" form of the
245 name if demangle is on and the "mangled" form of the name if
246 demangle is off. In other languages this is just the symbol name.
247 The result should never be NULL. Don't use this for internal
248 purposes (e.g. storing in a hashtable): it's only suitable for output.
250 N.B. symbol may be anything with a ginfo member,
251 e.g., struct symbol or struct minimal_symbol. */
253 #define SYMBOL_PRINT_NAME(symbol) \
254 (demangle ? SYMBOL_NATURAL_NAME (symbol) : SYMBOL_LINKAGE_NAME (symbol))
257 /* Macro that tests a symbol for a match against a specified name string.
258 First test the unencoded name, then looks for and test a C++ encoded
259 name if it exists. Note that whitespace is ignored while attempting to
260 match a C++ encoded name, so that "foo::bar(int,long)" is the same as
261 "foo :: bar (int, long)".
262 Evaluates to zero if the match fails, or nonzero if it succeeds. */
264 /* Macro that tests a symbol for a match against a specified name
265 string. It tests against SYMBOL_NATURAL_NAME, and it ignores
266 whitespace and trailing parentheses. (See strcmp_iw for details
267 about its behavior.) */
269 #define SYMBOL_MATCHES_NATURAL_NAME(symbol, name) \
270 (strcmp_iw (SYMBOL_NATURAL_NAME (symbol), (name)) == 0)
272 /* Macro that returns the name to be used when sorting and searching symbols.
273 In C++, Chill, and Java, we search for the demangled form of a name,
274 and so sort symbols accordingly. In Ada, however, we search by mangled
275 name. If there is no distinct demangled name, then SYMBOL_SEARCH_NAME
276 returns the same value (same pointer) as SYMBOL_LINKAGE_NAME. */
277 #define SYMBOL_SEARCH_NAME(symbol) \
278 (symbol_search_name (&(symbol)->ginfo))
279 extern char *symbol_search_name (const struct general_symbol_info
*);
281 /* Analogous to SYMBOL_MATCHES_NATURAL_NAME, but uses the search
283 #define SYMBOL_MATCHES_SEARCH_NAME(symbol, name) \
284 (strcmp_iw (SYMBOL_SEARCH_NAME (symbol), (name)) == 0)
286 /* Classification types for a minimal symbol. These should be taken as
287 "advisory only", since if gdb can't easily figure out a
288 classification it simply selects mst_unknown. It may also have to
289 guess when it can't figure out which is a better match between two
290 types (mst_data versus mst_bss) for example. Since the minimal
291 symbol info is sometimes derived from the BFD library's view of a
292 file, we need to live with what information bfd supplies. */
294 enum minimal_symbol_type
296 mst_unknown
= 0, /* Unknown type, the default */
297 mst_text
, /* Generally executable instructions */
298 mst_text_gnu_ifunc
, /* Executable code returning address
299 of executable code */
300 mst_slot_got_plt
, /* GOT entries for .plt sections */
301 mst_data
, /* Generally initialized data */
302 mst_bss
, /* Generally uninitialized data */
303 mst_abs
, /* Generally absolute (nonrelocatable) */
304 /* GDB uses mst_solib_trampoline for the start address of a shared
305 library trampoline entry. Breakpoints for shared library functions
306 are put there if the shared library is not yet loaded.
307 After the shared library is loaded, lookup_minimal_symbol will
308 prefer the minimal symbol from the shared library (usually
309 a mst_text symbol) over the mst_solib_trampoline symbol, and the
310 breakpoints will be moved to their true address in the shared
311 library via breakpoint_re_set. */
312 mst_solib_trampoline
, /* Shared library trampoline code */
313 /* For the mst_file* types, the names are only guaranteed to be unique
314 within a given .o file. */
315 mst_file_text
, /* Static version of mst_text */
316 mst_file_data
, /* Static version of mst_data */
317 mst_file_bss
/* Static version of mst_bss */
320 /* Define a simple structure used to hold some very basic information about
321 all defined global symbols (text, data, bss, abs, etc). The only required
322 information is the general_symbol_info.
324 In many cases, even if a file was compiled with no special options for
325 debugging at all, as long as was not stripped it will contain sufficient
326 information to build a useful minimal symbol table using this structure.
327 Even when a file contains enough debugging information to build a full
328 symbol table, these minimal symbols are still useful for quickly mapping
329 between names and addresses, and vice versa. They are also sometimes
330 used to figure out what full symbol table entries need to be read in. */
332 struct minimal_symbol
335 /* The general symbol info required for all types of symbols.
337 The SYMBOL_VALUE_ADDRESS contains the address that this symbol
340 struct general_symbol_info ginfo
;
342 /* Size of this symbol. end_psymtab in dbxread.c uses this
343 information to calculate the end of the partial symtab based on the
344 address of the last symbol plus the size of the last symbol. */
348 /* Which source file is this symbol in? Only relevant for mst_file_*. */
349 const char *filename
;
351 /* Classification type for this minimal symbol. */
353 ENUM_BITFIELD(minimal_symbol_type
) type
: 8;
355 /* Two flag bits provided for the use of the target. */
356 unsigned int target_flag_1
: 1;
357 unsigned int target_flag_2
: 1;
359 /* Minimal symbols with the same hash key are kept on a linked
360 list. This is the link. */
362 struct minimal_symbol
*hash_next
;
364 /* Minimal symbols are stored in two different hash tables. This is
365 the `next' pointer for the demangled hash table. */
367 struct minimal_symbol
*demangled_hash_next
;
370 #define MSYMBOL_TARGET_FLAG_1(msymbol) (msymbol)->target_flag_1
371 #define MSYMBOL_TARGET_FLAG_2(msymbol) (msymbol)->target_flag_2
372 #define MSYMBOL_SIZE(msymbol) (msymbol)->size
373 #define MSYMBOL_TYPE(msymbol) (msymbol)->type
379 /* Represent one symbol name; a variable, constant, function or typedef. */
381 /* Different name domains for symbols. Looking up a symbol specifies a
382 domain and ignores symbol definitions in other name domains. */
384 typedef enum domain_enum_tag
386 /* UNDEF_DOMAIN is used when a domain has not been discovered or
387 none of the following apply. This usually indicates an error either
388 in the symbol information or in gdb's handling of symbols. */
392 /* VAR_DOMAIN is the usual domain. In C, this contains variables,
393 function names, typedef names and enum type values. */
397 /* STRUCT_DOMAIN is used in C to hold struct, union and enum type names.
398 Thus, if `struct foo' is used in a C program, it produces a symbol named
399 `foo' in the STRUCT_DOMAIN. */
403 /* LABEL_DOMAIN may be used for names of labels (for gotos). */
408 /* Searching domains, used for `search_symbols'. Element numbers are
409 hardcoded in GDB, check all enum uses before changing it. */
413 /* Everything in VAR_DOMAIN minus FUNCTIONS_DOMAIN and
415 VARIABLES_DOMAIN
= 0,
417 /* All functions -- for some reason not methods, though. */
418 FUNCTIONS_DOMAIN
= 1,
420 /* All defined types */
427 /* An address-class says where to find the value of a symbol. */
431 /* Not used; catches errors. */
435 /* Value is constant int SYMBOL_VALUE, host byteorder. */
439 /* Value is at fixed address SYMBOL_VALUE_ADDRESS. */
443 /* Value is in register. SYMBOL_VALUE is the register number
444 in the original debug format. SYMBOL_REGISTER_OPS holds a
445 function that can be called to transform this into the
446 actual register number this represents in a specific target
447 architecture (gdbarch).
449 For some symbol formats (stabs, for some compilers at least),
450 the compiler generates two symbols, an argument and a register.
451 In some cases we combine them to a single LOC_REGISTER in symbol
452 reading, but currently not for all cases (e.g. it's passed on the
453 stack and then loaded into a register). */
457 /* It's an argument; the value is at SYMBOL_VALUE offset in arglist. */
461 /* Value address is at SYMBOL_VALUE offset in arglist. */
465 /* Value is in specified register. Just like LOC_REGISTER except the
466 register holds the address of the argument instead of the argument
467 itself. This is currently used for the passing of structs and unions
468 on sparc and hppa. It is also used for call by reference where the
469 address is in a register, at least by mipsread.c. */
473 /* Value is a local variable at SYMBOL_VALUE offset in stack frame. */
477 /* Value not used; definition in SYMBOL_TYPE. Symbols in the domain
478 STRUCT_DOMAIN all have this class. */
482 /* Value is address SYMBOL_VALUE_ADDRESS in the code. */
486 /* In a symbol table, value is SYMBOL_BLOCK_VALUE of a `struct block'.
487 In a partial symbol table, SYMBOL_VALUE_ADDRESS is the start address
488 of the block. Function names have this class. */
492 /* Value is a constant byte-sequence pointed to by SYMBOL_VALUE_BYTES, in
493 target byte order. */
497 /* Value is at fixed address, but the address of the variable has
498 to be determined from the minimal symbol table whenever the
499 variable is referenced.
500 This happens if debugging information for a global symbol is
501 emitted and the corresponding minimal symbol is defined
502 in another object file or runtime common storage.
503 The linker might even remove the minimal symbol if the global
504 symbol is never referenced, in which case the symbol remains
507 GDB would normally find the symbol in the minimal symbol table if it will
508 not find it in the full symbol table. But a reference to an external
509 symbol in a local block shadowing other definition requires full symbol
510 without possibly having its address available for LOC_STATIC. Testcase
511 is provided as `gdb.dwarf2/dw2-unresolved.exp'. */
515 /* The variable does not actually exist in the program.
516 The value is ignored. */
520 /* The variable's address is computed by a set of location
521 functions (see "struct symbol_computed_ops" below). */
525 /* The methods needed to implement LOC_COMPUTED. These methods can
526 use the symbol's .aux_value for additional per-symbol information.
528 At present this is only used to implement location expressions. */
530 struct symbol_computed_ops
533 /* Return the value of the variable SYMBOL, relative to the stack
534 frame FRAME. If the variable has been optimized out, return
537 Iff `read_needs_frame (SYMBOL)' is zero, then FRAME may be zero. */
539 struct value
*(*read_variable
) (struct symbol
* symbol
,
540 struct frame_info
* frame
);
542 /* Read variable SYMBOL like read_variable at (callee) FRAME's function
543 entry. SYMBOL should be a function parameter, otherwise
544 NO_ENTRY_VALUE_ERROR will be thrown. */
545 struct value
*(*read_variable_at_entry
) (struct symbol
*symbol
,
546 struct frame_info
*frame
);
548 /* Return non-zero if we need a frame to find the value of the SYMBOL. */
549 int (*read_needs_frame
) (struct symbol
* symbol
);
551 /* Write to STREAM a natural-language description of the location of
552 SYMBOL, in the context of ADDR. */
553 void (*describe_location
) (struct symbol
* symbol
, CORE_ADDR addr
,
554 struct ui_file
* stream
);
556 /* Tracepoint support. Append bytecodes to the tracepoint agent
557 expression AX that push the address of the object SYMBOL. Set
558 VALUE appropriately. Note --- for objects in registers, this
559 needn't emit any code; as long as it sets VALUE properly, then
560 the caller will generate the right code in the process of
561 treating this as an lvalue or rvalue. */
563 void (*tracepoint_var_ref
) (struct symbol
*symbol
, struct gdbarch
*gdbarch
,
564 struct agent_expr
*ax
, struct axs_value
*value
);
567 /* Functions used with LOC_REGISTER and LOC_REGPARM_ADDR. */
569 struct symbol_register_ops
571 int (*register_number
) (struct symbol
*symbol
, struct gdbarch
*gdbarch
);
574 /* This structure is space critical. See space comments at the top. */
579 /* The general symbol info required for all types of symbols. */
581 struct general_symbol_info ginfo
;
583 /* Data type of value */
587 /* The symbol table containing this symbol. This is the file
588 associated with LINE. It can be NULL during symbols read-in but it is
589 never NULL during normal operation. */
590 struct symtab
*symtab
;
594 ENUM_BITFIELD(domain_enum_tag
) domain
: 6;
597 /* NOTE: cagney/2003-11-02: The fields "aclass" and "ops" contain
598 overlapping information. By creating a per-aclass ops vector, or
599 using the aclass as an index into an ops table, the aclass and
600 ops fields can be merged. The latter, for instance, would shave
601 32-bits from each symbol (relative to a symbol lookup, any table
602 index overhead would be in the noise). */
604 ENUM_BITFIELD(address_class
) aclass
: 6;
606 /* Whether this is an argument. */
608 unsigned is_argument
: 1;
610 /* Whether this is an inlined function (class LOC_BLOCK only). */
611 unsigned is_inlined
: 1;
613 /* True if this is a C++ function symbol with template arguments.
614 In this case the symbol is really a "struct template_symbol". */
615 unsigned is_cplus_template_function
: 1;
617 /* Line number of this symbol's definition, except for inlined
618 functions. For an inlined function (class LOC_BLOCK and
619 SYMBOL_INLINED set) this is the line number of the function's call
620 site. Inlined function symbols are not definitions, and they are
621 never found by symbol table lookup.
623 FIXME: Should we really make the assumption that nobody will try
624 to debug files longer than 64K lines? What about machine
625 generated programs? */
629 /* Method's for symbol's of this class. */
630 /* NOTE: cagney/2003-11-02: See comment above attached to "aclass". */
634 /* Used with LOC_COMPUTED. */
635 const struct symbol_computed_ops
*ops_computed
;
637 /* Used with LOC_REGISTER and LOC_REGPARM_ADDR. */
638 const struct symbol_register_ops
*ops_register
;
641 /* An arbitrary data pointer, allowing symbol readers to record
642 additional information on a per-symbol basis. Note that this data
643 must be allocated using the same obstack as the symbol itself. */
644 /* So far it is only used by LOC_COMPUTED to
645 find the location information. For a LOC_BLOCK symbol
646 for a function in a compilation unit compiled with DWARF 2
647 information, this is information used internally by the DWARF 2
648 code --- specifically, the location expression for the frame
649 base for this function. */
650 /* FIXME drow/2003-02-21: For the LOC_BLOCK case, it might be better
651 to add a magic symbol to the block containing this information,
652 or to have a generic debug info annotation slot for symbols. */
656 struct symbol
*hash_next
;
660 #define SYMBOL_DOMAIN(symbol) (symbol)->domain
661 #define SYMBOL_CLASS(symbol) (symbol)->aclass
662 #define SYMBOL_IS_ARGUMENT(symbol) (symbol)->is_argument
663 #define SYMBOL_INLINED(symbol) (symbol)->is_inlined
664 #define SYMBOL_IS_CPLUS_TEMPLATE_FUNCTION(symbol) \
665 (symbol)->is_cplus_template_function
666 #define SYMBOL_TYPE(symbol) (symbol)->type
667 #define SYMBOL_LINE(symbol) (symbol)->line
668 #define SYMBOL_SYMTAB(symbol) (symbol)->symtab
669 #define SYMBOL_COMPUTED_OPS(symbol) (symbol)->ops.ops_computed
670 #define SYMBOL_REGISTER_OPS(symbol) (symbol)->ops.ops_register
671 #define SYMBOL_LOCATION_BATON(symbol) (symbol)->aux_value
673 /* An instance of this type is used to represent a C++ template
674 function. It includes a "struct symbol" as a kind of base class;
675 users downcast to "struct template_symbol *" when needed. A symbol
676 is really of this type iff SYMBOL_IS_CPLUS_TEMPLATE_FUNCTION is
679 struct template_symbol
681 /* The base class. */
684 /* The number of template arguments. */
685 int n_template_arguments
;
687 /* The template arguments. This is an array with
688 N_TEMPLATE_ARGUMENTS elements. */
689 struct symbol
**template_arguments
;
693 /* Each item represents a line-->pc (or the reverse) mapping. This is
694 somewhat more wasteful of space than one might wish, but since only
695 the files which are actually debugged are read in to core, we don't
698 struct linetable_entry
704 /* The order of entries in the linetable is significant. They should
705 be sorted by increasing values of the pc field. If there is more than
706 one entry for a given pc, then I'm not sure what should happen (and
707 I not sure whether we currently handle it the best way).
709 Example: a C for statement generally looks like this
711 10 0x100 - for the init/test part of a for stmt.
714 10 0x400 - for the increment part of a for stmt.
716 If an entry has a line number of zero, it marks the start of a PC
717 range for which no line number information is available. It is
718 acceptable, though wasteful of table space, for such a range to be
725 /* Actually NITEMS elements. If you don't like this use of the
726 `struct hack', you can shove it up your ANSI (seriously, if the
727 committee tells us how to do it, we can probably go along). */
728 struct linetable_entry item
[1];
731 /* How to relocate the symbols from each section in a symbol file.
732 Each struct contains an array of offsets.
733 The ordering and meaning of the offsets is file-type-dependent;
734 typically it is indexed by section numbers or symbol types or
737 To give us flexibility in changing the internal representation
738 of these offsets, the ANOFFSET macro must be used to insert and
739 extract offset values in the struct. */
741 struct section_offsets
743 CORE_ADDR offsets
[1]; /* As many as needed. */
746 #define ANOFFSET(secoff, whichone) \
748 ? (internal_error (__FILE__, __LINE__, \
749 _("Section index is uninitialized")), -1) \
750 : secoff->offsets[whichone])
752 /* The size of a section_offsets table for N sections. */
753 #define SIZEOF_N_SECTION_OFFSETS(n) \
754 (sizeof (struct section_offsets) \
755 + sizeof (((struct section_offsets *) 0)->offsets) * ((n)-1))
757 /* Each source file or header is represented by a struct symtab.
758 These objects are chained through the `next' field. */
762 /* Unordered chain of all existing symtabs of this objfile. */
766 /* List of all symbol scope blocks for this symtab. May be shared
767 between different symtabs (and normally is for all the symtabs
768 in a given compilation unit). */
770 struct blockvector
*blockvector
;
772 /* Table mapping core addresses to line numbers for this file.
773 Can be NULL if none. Never shared between different symtabs. */
775 struct linetable
*linetable
;
777 /* Section in objfile->section_offsets for the blockvector and
778 the linetable. Probably always SECT_OFF_TEXT. */
780 int block_line_section
;
782 /* If several symtabs share a blockvector, exactly one of them
783 should be designated the primary, so that the blockvector
784 is relocated exactly once by objfile_relocate. */
786 unsigned int primary
: 1;
788 /* Symtab has been compiled with both optimizations and debug info so that
789 GDB may stop skipping prologues as variables locations are valid already
790 at function entry points. */
792 unsigned int locations_valid
: 1;
794 /* DWARF unwinder for this CU is valid even for epilogues (PC at the return
795 instruction). This is supported by GCC since 4.5.0. */
797 unsigned int epilogue_unwind_valid
: 1;
799 /* The macro table for this symtab. Like the blockvector, this
800 may be shared between different symtabs --- and normally is for
801 all the symtabs in a given compilation unit. */
802 struct macro_table
*macro_table
;
804 /* Name of this source file. */
808 /* Directory in which it was compiled, or NULL if we don't know. */
812 /* Total number of lines found in source file. */
816 /* line_charpos[N] is the position of the (N-1)th line of the
817 source file. "position" means something we can lseek() to; it
818 is not guaranteed to be useful any other way. */
822 /* Language of this source file. */
824 enum language language
;
826 /* String that identifies the format of the debugging information, such
827 as "stabs", "dwarf 1", "dwarf 2", "coff", etc. This is mostly useful
828 for automated testing of gdb but may also be information that is
829 useful to the user. */
831 const char *debugformat
;
833 /* String of producer version information. May be zero. */
835 const char *producer
;
837 /* Full name of file as found by searching the source path.
838 NULL if not yet known. */
842 /* Object file from which this symbol information was read. */
844 struct objfile
*objfile
;
846 /* struct call_site entries for this compilation unit or NULL. */
848 htab_t call_site_htab
;
851 #define BLOCKVECTOR(symtab) (symtab)->blockvector
852 #define LINETABLE(symtab) (symtab)->linetable
853 #define SYMTAB_PSPACE(symtab) (symtab)->objfile->pspace
856 /* The virtual function table is now an array of structures which have the
857 form { int16 offset, delta; void *pfn; }.
859 In normal virtual function tables, OFFSET is unused.
860 DELTA is the amount which is added to the apparent object's base
861 address in order to point to the actual object to which the
862 virtual function should be applied.
863 PFN is a pointer to the virtual function.
865 Note that this macro is g++ specific (FIXME). */
867 #define VTBL_FNADDR_OFFSET 2
869 /* External variables and functions for the objects described above. */
871 /* True if we are nested inside psymtab_to_symtab. */
873 extern int currently_reading_symtab
;
875 /* symtab.c lookup functions */
877 extern const char multiple_symbols_ask
[];
878 extern const char multiple_symbols_all
[];
879 extern const char multiple_symbols_cancel
[];
881 const char *multiple_symbols_select_mode (void);
883 int symbol_matches_domain (enum language symbol_language
,
884 domain_enum symbol_domain
,
887 /* lookup a symbol table by source file name. */
889 extern struct symtab
*lookup_symtab (const char *);
891 /* lookup a symbol by name (optional block) in language. */
893 extern struct symbol
*lookup_symbol_in_language (const char *,
894 const struct block
*,
899 /* lookup a symbol by name (optional block, optional symtab)
900 in the current language. */
902 extern struct symbol
*lookup_symbol (const char *, const struct block
*,
903 const domain_enum
, int *);
905 /* A default version of lookup_symbol_nonlocal for use by languages
906 that can't think of anything better to do. */
908 extern struct symbol
*basic_lookup_symbol_nonlocal (const char *,
909 const struct block
*,
912 /* Some helper functions for languages that need to write their own
913 lookup_symbol_nonlocal functions. */
915 /* Lookup a symbol in the static block associated to BLOCK, if there
916 is one; do nothing if BLOCK is NULL or a global block. */
918 extern struct symbol
*lookup_symbol_static (const char *name
,
919 const struct block
*block
,
920 const domain_enum domain
);
922 /* Lookup a symbol in all files' global blocks (searching psymtabs if
925 extern struct symbol
*lookup_symbol_global (const char *name
,
926 const struct block
*block
,
927 const domain_enum domain
);
929 /* Lookup a symbol within the block BLOCK. This, unlike
930 lookup_symbol_block, will set SYMTAB and BLOCK_FOUND correctly, and
931 will fix up the symbol if necessary. */
933 extern struct symbol
*lookup_symbol_aux_block (const char *name
,
934 const struct block
*block
,
935 const domain_enum domain
);
937 extern struct symbol
*lookup_language_this (const struct language_defn
*lang
,
938 const struct block
*block
);
940 /* Lookup a symbol only in the file static scope of all the objfiles. */
942 struct symbol
*lookup_static_symbol_aux (const char *name
,
943 const domain_enum domain
);
946 /* lookup a symbol by name, within a specified block. */
948 extern struct symbol
*lookup_block_symbol (const struct block
*, const char *,
951 /* lookup a [struct, union, enum] by name, within a specified block. */
953 extern struct type
*lookup_struct (const char *, struct block
*);
955 extern struct type
*lookup_union (const char *, struct block
*);
957 extern struct type
*lookup_enum (const char *, struct block
*);
959 /* from blockframe.c: */
961 /* lookup the function symbol corresponding to the address. */
963 extern struct symbol
*find_pc_function (CORE_ADDR
);
965 /* lookup the function corresponding to the address and section. */
967 extern struct symbol
*find_pc_sect_function (CORE_ADDR
, struct obj_section
*);
969 extern int find_pc_partial_function_gnu_ifunc (CORE_ADDR pc
, char **name
,
972 int *is_gnu_ifunc_p
);
974 /* lookup function from address, return name, start addr and end addr. */
976 extern int find_pc_partial_function (CORE_ADDR
, char **, CORE_ADDR
*,
979 extern void clear_pc_function_cache (void);
981 /* lookup partial symbol table by address and section. */
983 extern struct symtab
*find_pc_sect_symtab_via_partial (CORE_ADDR
,
984 struct obj_section
*);
986 /* lookup full symbol table by address. */
988 extern struct symtab
*find_pc_symtab (CORE_ADDR
);
990 /* lookup full symbol table by address and section. */
992 extern struct symtab
*find_pc_sect_symtab (CORE_ADDR
, struct obj_section
*);
994 extern int find_pc_line_pc_range (CORE_ADDR
, CORE_ADDR
*, CORE_ADDR
*);
996 extern void reread_symbols (void);
998 extern struct type
*lookup_transparent_type (const char *);
999 extern struct type
*basic_lookup_transparent_type (const char *);
1002 /* Macro for name of symbol to indicate a file compiled with gcc. */
1003 #ifndef GCC_COMPILED_FLAG_SYMBOL
1004 #define GCC_COMPILED_FLAG_SYMBOL "gcc_compiled."
1007 /* Macro for name of symbol to indicate a file compiled with gcc2. */
1008 #ifndef GCC2_COMPILED_FLAG_SYMBOL
1009 #define GCC2_COMPILED_FLAG_SYMBOL "gcc2_compiled."
1012 extern int in_gnu_ifunc_stub (CORE_ADDR pc
);
1014 /* Functions for resolving STT_GNU_IFUNC symbols which are implemented only
1015 for ELF symbol files. */
1017 struct gnu_ifunc_fns
1019 /* See elf_gnu_ifunc_resolve_addr for its real implementation. */
1020 CORE_ADDR (*gnu_ifunc_resolve_addr
) (struct gdbarch
*gdbarch
, CORE_ADDR pc
);
1022 /* See elf_gnu_ifunc_resolve_name for its real implementation. */
1023 int (*gnu_ifunc_resolve_name
) (const char *function_name
,
1024 CORE_ADDR
*function_address_p
);
1026 /* See elf_gnu_ifunc_resolver_stop for its real implementation. */
1027 void (*gnu_ifunc_resolver_stop
) (struct breakpoint
*b
);
1029 /* See elf_gnu_ifunc_resolver_return_stop for its real implementation. */
1030 void (*gnu_ifunc_resolver_return_stop
) (struct breakpoint
*b
);
1033 #define gnu_ifunc_resolve_addr gnu_ifunc_fns_p->gnu_ifunc_resolve_addr
1034 #define gnu_ifunc_resolve_name gnu_ifunc_fns_p->gnu_ifunc_resolve_name
1035 #define gnu_ifunc_resolver_stop gnu_ifunc_fns_p->gnu_ifunc_resolver_stop
1036 #define gnu_ifunc_resolver_return_stop \
1037 gnu_ifunc_fns_p->gnu_ifunc_resolver_return_stop
1039 extern const struct gnu_ifunc_fns
*gnu_ifunc_fns_p
;
1041 extern CORE_ADDR
find_solib_trampoline_target (struct frame_info
*, CORE_ADDR
);
1043 struct symtab_and_line
1045 /* The program space of this sal. */
1046 struct program_space
*pspace
;
1048 struct symtab
*symtab
;
1049 struct obj_section
*section
;
1050 /* Line number. Line numbers start at 1 and proceed through symtab->nlines.
1051 0 is never a valid line number; it is used to indicate that line number
1052 information is not available. */
1061 extern void init_sal (struct symtab_and_line
*sal
);
1063 struct symtabs_and_lines
1065 struct symtab_and_line
*sals
;
1071 /* Some types and macros needed for exception catchpoints.
1072 Can't put these in target.h because symtab_and_line isn't
1073 known there. This file will be included by breakpoint.c,
1074 hppa-tdep.c, etc. */
1076 /* Enums for exception-handling support. */
1077 enum exception_event_kind
1085 /* Given a pc value, return line number it is in. Second arg nonzero means
1086 if pc is on the boundary use the previous statement's line number. */
1088 extern struct symtab_and_line
find_pc_line (CORE_ADDR
, int);
1090 /* Same function, but specify a section as well as an address. */
1092 extern struct symtab_and_line
find_pc_sect_line (CORE_ADDR
,
1093 struct obj_section
*, int);
1095 /* Given a symtab and line number, return the pc there. */
1097 extern int find_line_pc (struct symtab
*, int, CORE_ADDR
*);
1099 extern int find_line_pc_range (struct symtab_and_line
, CORE_ADDR
*,
1102 extern void resolve_sal_pc (struct symtab_and_line
*);
1104 /* Given a string, return the line specified by it. For commands like "list"
1105 and "breakpoint". */
1107 extern struct symtabs_and_lines
decode_line_spec (char *, int);
1109 extern struct symtabs_and_lines
decode_line_spec_1 (char *, int);
1113 void maintenance_print_symbols (char *, int);
1115 void maintenance_print_psymbols (char *, int);
1117 void maintenance_print_msymbols (char *, int);
1119 void maintenance_print_objfiles (char *, int);
1121 void maintenance_info_symtabs (char *, int);
1123 void maintenance_info_psymtabs (char *, int);
1125 void maintenance_check_symtabs (char *, int);
1129 void maintenance_print_statistics (char *, int);
1131 /* Symbol-reading stuff in symfile.c and solib.c. */
1133 extern void clear_solib (void);
1137 extern int identify_source_line (struct symtab
*, int, int, CORE_ADDR
);
1139 extern void print_source_lines (struct symtab
*, int, int, int);
1141 extern void forget_cached_source_info_for_objfile (struct objfile
*);
1142 extern void forget_cached_source_info (void);
1144 extern void select_source_symtab (struct symtab
*);
1146 extern char **default_make_symbol_completion_list_break_on
1147 (char *text
, char *word
, const char *break_on
);
1148 extern char **default_make_symbol_completion_list (char *, char *);
1149 extern char **make_symbol_completion_list (char *, char *);
1150 extern char **make_symbol_completion_list_fn (struct cmd_list_element
*,
1153 extern char **make_file_symbol_completion_list (char *, char *, char *);
1155 extern char **make_source_files_completion_list (char *, char *);
1159 int matching_obj_sections (struct obj_section
*, struct obj_section
*);
1161 extern const char *find_main_filename (void);
1163 extern struct symtab
*find_line_symtab (struct symtab
*, int, int *, int *);
1165 extern struct symtab_and_line
find_function_start_sal (struct symbol
*sym
,
1168 extern void skip_prologue_sal (struct symtab_and_line
*);
1172 extern void clear_symtab_users (int add_flags
);
1174 extern enum language
deduce_language_from_filename (const char *);
1178 extern int in_prologue (struct gdbarch
*gdbarch
,
1179 CORE_ADDR pc
, CORE_ADDR func_start
);
1181 extern CORE_ADDR
skip_prologue_using_sal (struct gdbarch
*gdbarch
,
1182 CORE_ADDR func_addr
);
1184 extern struct symbol
*fixup_symbol_section (struct symbol
*,
1187 /* Symbol searching */
1189 /* When using search_symbols, a list of the following structs is returned.
1190 Callers must free the search list using free_search_symbols! */
1191 struct symbol_search
1193 /* The block in which the match was found. Could be, for example,
1194 STATIC_BLOCK or GLOBAL_BLOCK. */
1197 /* Information describing what was found.
1199 If symtab abd symbol are NOT NULL, then information was found
1201 struct symtab
*symtab
;
1202 struct symbol
*symbol
;
1204 /* If msymbol is non-null, then a match was made on something for
1205 which only minimal_symbols exist. */
1206 struct minimal_symbol
*msymbol
;
1208 /* A link to the next match, or NULL for the end. */
1209 struct symbol_search
*next
;
1212 extern void search_symbols (char *, enum search_domain
, int, char **,
1213 struct symbol_search
**);
1214 extern void free_search_symbols (struct symbol_search
*);
1215 extern struct cleanup
*make_cleanup_free_search_symbols (struct symbol_search
1218 /* The name of the ``main'' function.
1219 FIXME: cagney/2001-03-20: Can't make main_name() const since some
1220 of the calling code currently assumes that the string isn't
1222 extern void set_main_name (const char *name
);
1223 extern /*const */ char *main_name (void);
1224 extern enum language language_of_main
;
1226 /* Check global symbols in objfile. */
1227 struct symbol
*lookup_global_symbol_from_objfile (const struct objfile
*,
1229 const domain_enum domain
);
1231 /* Return 1 if the supplied producer string matches the ARM RealView
1232 compiler (armcc). */
1233 int producer_is_realview (const char *producer
);
1235 void fixup_section (struct general_symbol_info
*ginfo
,
1236 CORE_ADDR addr
, struct objfile
*objfile
);
1238 struct objfile
*lookup_objfile_from_block (const struct block
*block
);
1240 extern int basenames_may_differ
;
1242 int iterate_over_some_symtabs (const char *name
,
1243 const char *full_path
,
1244 const char *real_path
,
1245 int (*callback
) (struct symtab
*symtab
,
1248 struct symtab
*first
,
1249 struct symtab
*after_last
);
1251 void iterate_over_symtabs (const char *name
,
1252 int (*callback
) (struct symtab
*symtab
,
1256 DEF_VEC_I (CORE_ADDR
);
1258 VEC (CORE_ADDR
) *find_pcs_for_symtab_line (struct symtab
*symtab
, int line
,
1259 struct linetable_entry
**best_entry
);
1261 void iterate_over_symbols (const struct block
*block
, const char *name
,
1262 const domain_enum domain
,
1263 int (*callback
) (struct symbol
*, void *),
1266 struct cleanup
*demangle_for_lookup (const char *name
, enum language lang
,
1267 const char **result_name
);
1269 #endif /* !defined(SYMTAB_H) */