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. */
40 /* Some of the structures in this file are space critical.
41 The space-critical structures are:
43 struct general_symbol_info
47 These structures are laid out to encourage good packing.
48 They use ENUM_BITFIELD and short int fields, and they order the
49 structure members so that fields less than a word are next
50 to each other so they can be packed together. */
52 /* Rearranged: used ENUM_BITFIELD and rearranged field order in
53 all the space critical structures (plus struct minimal_symbol).
54 Memory usage dropped from 99360768 bytes to 90001408 bytes.
55 I measured this with before-and-after tests of
56 "HEAD-old-gdb -readnow HEAD-old-gdb" and
57 "HEAD-new-gdb -readnow HEAD-old-gdb" on native i686-pc-linux-gnu,
58 red hat linux 8, with LD_LIBRARY_PATH=/usr/lib/debug,
59 typing "maint space 1" at the first command prompt.
61 Here is another measurement (from andrew c):
62 # no /usr/lib/debug, just plain glibc, like a normal user
64 (gdb) break internal_error
66 (gdb) maint internal-error
70 gdb gdb_6_0_branch 2003-08-19 space used: 8896512
71 gdb HEAD 2003-08-19 space used: 8904704
72 gdb HEAD 2003-08-21 space used: 8396800 (+symtab.h)
73 gdb HEAD 2003-08-21 space used: 8265728 (+gdbtypes.h)
75 The third line shows the savings from the optimizations in symtab.h.
76 The fourth line shows the savings from the optimizations in
77 gdbtypes.h. Both optimizations are in gdb HEAD now.
79 --chastain 2003-08-21 */
81 /* Struct for storing C++ specific information. Allocated when needed. */
85 const char *demangled_name
;
88 /* Define a structure for the information that is common to all symbol types,
89 including minimal symbols, partial symbols, and full symbols. In a
90 multilanguage environment, some language specific information may need to
91 be recorded along with each symbol. */
93 /* This structure is space critical. See space comments at the top. */
95 struct general_symbol_info
97 /* Name of the symbol. This is a required field. Storage for the
98 name is allocated on the objfile_obstack for the associated
99 objfile. For languages like C++ that make a distinction between
100 the mangled name and demangled name, this is the mangled
105 /* Value of the symbol. Which member of this union to use, and what
106 it means, depends on what kind of symbol this is and its
107 SYMBOL_CLASS. See comments there for more details. All of these
108 are in host byte order (though what they point to might be in
109 target byte order, e.g. LOC_CONST_BYTES). */
121 /* For opaque typedef struct chain. */
123 struct symbol
*chain
;
127 /* Since one and only one language can apply, wrap the language specific
128 information inside a union. */
132 /* This is used by languages which wish to store a demangled name.
133 currently used by Ada, Java, and Objective C. */
136 const char *demangled_name
;
140 struct cplus_specific
*cplus_specific
;
144 /* Record the source code language that applies to this symbol.
145 This is used to select one of the fields from the language specific
148 ENUM_BITFIELD(language
) language
: 8;
150 /* Which section is this symbol in? This is an index into
151 section_offsets for this objfile. Negative means that the symbol
152 does not get relocated relative to a section.
153 Disclaimer: currently this is just used for xcoff, so don't
154 expect all symbol-reading code to set it correctly (the ELF code
155 also tries to set it correctly). */
159 /* The section associated with this symbol. It can be NULL. */
161 struct obj_section
*obj_section
;
164 extern void symbol_set_demangled_name (struct general_symbol_info
*, char *,
167 extern const char *symbol_get_demangled_name
168 (const struct general_symbol_info
*);
170 extern CORE_ADDR
symbol_overlayed_address (CORE_ADDR
, struct obj_section
*);
172 /* Note that all the following SYMBOL_* macros are used with the
173 SYMBOL argument being either a partial symbol, a minimal symbol or
174 a full symbol. All three types have a ginfo field. In particular
175 the SYMBOL_SET_LANGUAGE, SYMBOL_DEMANGLED_NAME, etc.
176 macros cannot be entirely substituted by
177 functions, unless the callers are changed to pass in the ginfo
178 field only, instead of the SYMBOL parameter. */
180 #define SYMBOL_VALUE(symbol) (symbol)->ginfo.value.ivalue
181 #define SYMBOL_VALUE_ADDRESS(symbol) (symbol)->ginfo.value.address
182 #define SYMBOL_VALUE_BYTES(symbol) (symbol)->ginfo.value.bytes
183 #define SYMBOL_BLOCK_VALUE(symbol) (symbol)->ginfo.value.block
184 #define SYMBOL_VALUE_CHAIN(symbol) (symbol)->ginfo.value.chain
185 #define SYMBOL_LANGUAGE(symbol) (symbol)->ginfo.language
186 #define SYMBOL_SECTION(symbol) (symbol)->ginfo.section
187 #define SYMBOL_OBJ_SECTION(symbol) (symbol)->ginfo.obj_section
189 /* Initializes the language dependent portion of a symbol
190 depending upon the language for the symbol. */
191 #define SYMBOL_SET_LANGUAGE(symbol,language) \
192 (symbol_set_language (&(symbol)->ginfo, (language)))
193 extern void symbol_set_language (struct general_symbol_info
*symbol
,
194 enum language language
);
196 /* Set just the linkage name of a symbol; do not try to demangle
197 it. Used for constructs which do not have a mangled name,
198 e.g. struct tags. Unlike SYMBOL_SET_NAMES, linkage_name must
199 be terminated and either already on the objfile's obstack or
200 permanently allocated. */
201 #define SYMBOL_SET_LINKAGE_NAME(symbol,linkage_name) \
202 (symbol)->ginfo.name = (linkage_name)
204 /* Set the linkage and natural names of a symbol, by demangling
206 #define SYMBOL_SET_NAMES(symbol,linkage_name,len,copy_name,objfile) \
207 symbol_set_names (&(symbol)->ginfo, linkage_name, len, copy_name, objfile)
208 extern void symbol_set_names (struct general_symbol_info
*symbol
,
209 const char *linkage_name
, int len
, int copy_name
,
210 struct objfile
*objfile
);
212 /* Now come lots of name accessor macros. Short version as to when to
213 use which: Use SYMBOL_NATURAL_NAME to refer to the name of the
214 symbol in the original source code. Use SYMBOL_LINKAGE_NAME if you
215 want to know what the linker thinks the symbol's name is. Use
216 SYMBOL_PRINT_NAME for output. Use SYMBOL_DEMANGLED_NAME if you
217 specifically need to know whether SYMBOL_NATURAL_NAME and
218 SYMBOL_LINKAGE_NAME are different. */
220 /* Return SYMBOL's "natural" name, i.e. the name that it was called in
221 the original source code. In languages like C++ where symbols may
222 be mangled for ease of manipulation by the linker, this is the
225 #define SYMBOL_NATURAL_NAME(symbol) \
226 (symbol_natural_name (&(symbol)->ginfo))
227 extern const char *symbol_natural_name
228 (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 const char *symbol_demangled_name
242 (const struct general_symbol_info
*symbol
);
244 /* Macro that returns a version of the name of a symbol that is
245 suitable for output. In C++ this is the "demangled" form of the
246 name if demangle is on and the "mangled" form of the name if
247 demangle is off. In other languages this is just the symbol name.
248 The result should never be NULL. Don't use this for internal
249 purposes (e.g. storing in a hashtable): it's only suitable for output.
251 N.B. symbol may be anything with a ginfo member,
252 e.g., struct symbol or struct minimal_symbol. */
254 #define SYMBOL_PRINT_NAME(symbol) \
255 (demangle ? SYMBOL_NATURAL_NAME (symbol) : SYMBOL_LINKAGE_NAME (symbol))
258 /* Macro that returns the name to be used when sorting and searching symbols.
259 In C++, Chill, and Java, we search for the demangled form of a name,
260 and so sort symbols accordingly. In Ada, however, we search by mangled
261 name. If there is no distinct demangled name, then SYMBOL_SEARCH_NAME
262 returns the same value (same pointer) as SYMBOL_LINKAGE_NAME. */
263 #define SYMBOL_SEARCH_NAME(symbol) \
264 (symbol_search_name (&(symbol)->ginfo))
265 extern const char *symbol_search_name (const struct general_symbol_info
*);
267 /* Return non-zero if NAME matches the "search" name of SYMBOL.
268 Whitespace and trailing parentheses are ignored.
269 See strcmp_iw for details about its behavior. */
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_text_gnu_ifunc
, /* Executable code returning address
286 of executable code */
287 mst_slot_got_plt
, /* GOT entries for .plt sections */
288 mst_data
, /* Generally initialized data */
289 mst_bss
, /* Generally uninitialized data */
290 mst_abs
, /* Generally absolute (nonrelocatable) */
291 /* GDB uses mst_solib_trampoline for the start address of a shared
292 library trampoline entry. Breakpoints for shared library functions
293 are put there if the shared library is not yet loaded.
294 After the shared library is loaded, lookup_minimal_symbol will
295 prefer the minimal symbol from the shared library (usually
296 a mst_text symbol) over the mst_solib_trampoline symbol, and the
297 breakpoints will be moved to their true address in the shared
298 library via breakpoint_re_set. */
299 mst_solib_trampoline
, /* Shared library trampoline code */
300 /* For the mst_file* types, the names are only guaranteed to be unique
301 within a given .o file. */
302 mst_file_text
, /* Static version of mst_text */
303 mst_file_data
, /* Static version of mst_data */
304 mst_file_bss
/* Static version of mst_bss */
307 /* Define a simple structure used to hold some very basic information about
308 all defined global symbols (text, data, bss, abs, etc). The only required
309 information is the general_symbol_info.
311 In many cases, even if a file was compiled with no special options for
312 debugging at all, as long as was not stripped it will contain sufficient
313 information to build a useful minimal symbol table using this structure.
314 Even when a file contains enough debugging information to build a full
315 symbol table, these minimal symbols are still useful for quickly mapping
316 between names and addresses, and vice versa. They are also sometimes
317 used to figure out what full symbol table entries need to be read in. */
319 struct minimal_symbol
322 /* The general symbol info required for all types of symbols.
324 The SYMBOL_VALUE_ADDRESS contains the address that this symbol
327 struct general_symbol_info ginfo
;
329 /* Size of this symbol. end_psymtab in dbxread.c uses this
330 information to calculate the end of the partial symtab based on the
331 address of the last symbol plus the size of the last symbol. */
335 /* Which source file is this symbol in? Only relevant for mst_file_*. */
336 const char *filename
;
338 /* Classification type for this minimal symbol. */
340 ENUM_BITFIELD(minimal_symbol_type
) type
: 8;
342 /* Two flag bits provided for the use of the target. */
343 unsigned int target_flag_1
: 1;
344 unsigned int target_flag_2
: 1;
346 /* Minimal symbols with the same hash key are kept on a linked
347 list. This is the link. */
349 struct minimal_symbol
*hash_next
;
351 /* Minimal symbols are stored in two different hash tables. This is
352 the `next' pointer for the demangled hash table. */
354 struct minimal_symbol
*demangled_hash_next
;
357 #define MSYMBOL_TARGET_FLAG_1(msymbol) (msymbol)->target_flag_1
358 #define MSYMBOL_TARGET_FLAG_2(msymbol) (msymbol)->target_flag_2
359 #define MSYMBOL_SIZE(msymbol) (msymbol)->size
360 #define MSYMBOL_TYPE(msymbol) (msymbol)->type
366 /* Represent one symbol name; a variable, constant, function or typedef. */
368 /* Different name domains for symbols. Looking up a symbol specifies a
369 domain and ignores symbol definitions in other name domains. */
371 typedef enum domain_enum_tag
373 /* UNDEF_DOMAIN is used when a domain has not been discovered or
374 none of the following apply. This usually indicates an error either
375 in the symbol information or in gdb's handling of symbols. */
379 /* VAR_DOMAIN is the usual domain. In C, this contains variables,
380 function names, typedef names and enum type values. */
384 /* STRUCT_DOMAIN is used in C to hold struct, union and enum type names.
385 Thus, if `struct foo' is used in a C program, it produces a symbol named
386 `foo' in the STRUCT_DOMAIN. */
390 /* LABEL_DOMAIN may be used for names of labels (for gotos). */
395 /* Searching domains, used for `search_symbols'. Element numbers are
396 hardcoded in GDB, check all enum uses before changing it. */
400 /* Everything in VAR_DOMAIN minus FUNCTIONS_DOMAIN and
402 VARIABLES_DOMAIN
= 0,
404 /* All functions -- for some reason not methods, though. */
405 FUNCTIONS_DOMAIN
= 1,
407 /* All defined types */
414 /* An address-class says where to find the value of a symbol. */
418 /* Not used; catches errors. */
422 /* Value is constant int SYMBOL_VALUE, host byteorder. */
426 /* Value is at fixed address SYMBOL_VALUE_ADDRESS. */
430 /* Value is in register. SYMBOL_VALUE is the register number
431 in the original debug format. SYMBOL_REGISTER_OPS holds a
432 function that can be called to transform this into the
433 actual register number this represents in a specific target
434 architecture (gdbarch).
436 For some symbol formats (stabs, for some compilers at least),
437 the compiler generates two symbols, an argument and a register.
438 In some cases we combine them to a single LOC_REGISTER in symbol
439 reading, but currently not for all cases (e.g. it's passed on the
440 stack and then loaded into a register). */
444 /* It's an argument; the value is at SYMBOL_VALUE offset in arglist. */
448 /* Value address is at SYMBOL_VALUE offset in arglist. */
452 /* Value is in specified register. Just like LOC_REGISTER except the
453 register holds the address of the argument instead of the argument
454 itself. This is currently used for the passing of structs and unions
455 on sparc and hppa. It is also used for call by reference where the
456 address is in a register, at least by mipsread.c. */
460 /* Value is a local variable at SYMBOL_VALUE offset in stack frame. */
464 /* Value not used; definition in SYMBOL_TYPE. Symbols in the domain
465 STRUCT_DOMAIN all have this class. */
469 /* Value is address SYMBOL_VALUE_ADDRESS in the code. */
473 /* In a symbol table, value is SYMBOL_BLOCK_VALUE of a `struct block'.
474 In a partial symbol table, SYMBOL_VALUE_ADDRESS is the start address
475 of the block. Function names have this class. */
479 /* Value is a constant byte-sequence pointed to by SYMBOL_VALUE_BYTES, in
480 target byte order. */
484 /* Value is at fixed address, but the address of the variable has
485 to be determined from the minimal symbol table whenever the
486 variable is referenced.
487 This happens if debugging information for a global symbol is
488 emitted and the corresponding minimal symbol is defined
489 in another object file or runtime common storage.
490 The linker might even remove the minimal symbol if the global
491 symbol is never referenced, in which case the symbol remains
494 GDB would normally find the symbol in the minimal symbol table if it will
495 not find it in the full symbol table. But a reference to an external
496 symbol in a local block shadowing other definition requires full symbol
497 without possibly having its address available for LOC_STATIC. Testcase
498 is provided as `gdb.dwarf2/dw2-unresolved.exp'. */
502 /* The variable does not actually exist in the program.
503 The value is ignored. */
507 /* The variable's address is computed by a set of location
508 functions (see "struct symbol_computed_ops" below). */
512 /* The methods needed to implement LOC_COMPUTED. These methods can
513 use the symbol's .aux_value for additional per-symbol information.
515 At present this is only used to implement location expressions. */
517 struct symbol_computed_ops
520 /* Return the value of the variable SYMBOL, relative to the stack
521 frame FRAME. If the variable has been optimized out, return
524 Iff `read_needs_frame (SYMBOL)' is zero, then FRAME may be zero. */
526 struct value
*(*read_variable
) (struct symbol
* symbol
,
527 struct frame_info
* frame
);
529 /* Read variable SYMBOL like read_variable at (callee) FRAME's function
530 entry. SYMBOL should be a function parameter, otherwise
531 NO_ENTRY_VALUE_ERROR will be thrown. */
532 struct value
*(*read_variable_at_entry
) (struct symbol
*symbol
,
533 struct frame_info
*frame
);
535 /* Return non-zero if we need a frame to find the value of the SYMBOL. */
536 int (*read_needs_frame
) (struct symbol
* symbol
);
538 /* Write to STREAM a natural-language description of the location of
539 SYMBOL, in the context of ADDR. */
540 void (*describe_location
) (struct symbol
* symbol
, CORE_ADDR addr
,
541 struct ui_file
* stream
);
543 /* Tracepoint support. Append bytecodes to the tracepoint agent
544 expression AX that push the address of the object SYMBOL. Set
545 VALUE appropriately. Note --- for objects in registers, this
546 needn't emit any code; as long as it sets VALUE properly, then
547 the caller will generate the right code in the process of
548 treating this as an lvalue or rvalue. */
550 void (*tracepoint_var_ref
) (struct symbol
*symbol
, struct gdbarch
*gdbarch
,
551 struct agent_expr
*ax
, struct axs_value
*value
);
554 /* Functions used with LOC_REGISTER and LOC_REGPARM_ADDR. */
556 struct symbol_register_ops
558 int (*register_number
) (struct symbol
*symbol
, struct gdbarch
*gdbarch
);
561 /* This structure is space critical. See space comments at the top. */
566 /* The general symbol info required for all types of symbols. */
568 struct general_symbol_info ginfo
;
570 /* Data type of value */
574 /* The symbol table containing this symbol. This is the file
575 associated with LINE. It can be NULL during symbols read-in but it is
576 never NULL during normal operation. */
577 struct symtab
*symtab
;
581 ENUM_BITFIELD(domain_enum_tag
) domain
: 6;
584 /* NOTE: cagney/2003-11-02: The fields "aclass" and "ops" contain
585 overlapping information. By creating a per-aclass ops vector, or
586 using the aclass as an index into an ops table, the aclass and
587 ops fields can be merged. The latter, for instance, would shave
588 32-bits from each symbol (relative to a symbol lookup, any table
589 index overhead would be in the noise). */
591 ENUM_BITFIELD(address_class
) aclass
: 6;
593 /* Whether this is an argument. */
595 unsigned is_argument
: 1;
597 /* Whether this is an inlined function (class LOC_BLOCK only). */
598 unsigned is_inlined
: 1;
600 /* True if this is a C++ function symbol with template arguments.
601 In this case the symbol is really a "struct template_symbol". */
602 unsigned is_cplus_template_function
: 1;
604 /* Line number of this symbol's definition, except for inlined
605 functions. For an inlined function (class LOC_BLOCK and
606 SYMBOL_INLINED set) this is the line number of the function's call
607 site. Inlined function symbols are not definitions, and they are
608 never found by symbol table lookup.
610 FIXME: Should we really make the assumption that nobody will try
611 to debug files longer than 64K lines? What about machine
612 generated programs? */
616 /* Method's for symbol's of this class. */
617 /* NOTE: cagney/2003-11-02: See comment above attached to "aclass". */
621 /* Used with LOC_COMPUTED. */
622 const struct symbol_computed_ops
*ops_computed
;
624 /* Used with LOC_REGISTER and LOC_REGPARM_ADDR. */
625 const struct symbol_register_ops
*ops_register
;
628 /* An arbitrary data pointer, allowing symbol readers to record
629 additional information on a per-symbol basis. Note that this data
630 must be allocated using the same obstack as the symbol itself. */
631 /* So far it is only used by LOC_COMPUTED to
632 find the location information. For a LOC_BLOCK symbol
633 for a function in a compilation unit compiled with DWARF 2
634 information, this is information used internally by the DWARF 2
635 code --- specifically, the location expression for the frame
636 base for this function. */
637 /* FIXME drow/2003-02-21: For the LOC_BLOCK case, it might be better
638 to add a magic symbol to the block containing this information,
639 or to have a generic debug info annotation slot for symbols. */
643 struct symbol
*hash_next
;
647 #define SYMBOL_DOMAIN(symbol) (symbol)->domain
648 #define SYMBOL_CLASS(symbol) (symbol)->aclass
649 #define SYMBOL_IS_ARGUMENT(symbol) (symbol)->is_argument
650 #define SYMBOL_INLINED(symbol) (symbol)->is_inlined
651 #define SYMBOL_IS_CPLUS_TEMPLATE_FUNCTION(symbol) \
652 (symbol)->is_cplus_template_function
653 #define SYMBOL_TYPE(symbol) (symbol)->type
654 #define SYMBOL_LINE(symbol) (symbol)->line
655 #define SYMBOL_SYMTAB(symbol) (symbol)->symtab
656 #define SYMBOL_COMPUTED_OPS(symbol) (symbol)->ops.ops_computed
657 #define SYMBOL_REGISTER_OPS(symbol) (symbol)->ops.ops_register
658 #define SYMBOL_LOCATION_BATON(symbol) (symbol)->aux_value
660 /* An instance of this type is used to represent a C++ template
661 function. It includes a "struct symbol" as a kind of base class;
662 users downcast to "struct template_symbol *" when needed. A symbol
663 is really of this type iff SYMBOL_IS_CPLUS_TEMPLATE_FUNCTION is
666 struct template_symbol
668 /* The base class. */
671 /* The number of template arguments. */
672 int n_template_arguments
;
674 /* The template arguments. This is an array with
675 N_TEMPLATE_ARGUMENTS elements. */
676 struct symbol
**template_arguments
;
680 /* Each item represents a line-->pc (or the reverse) mapping. This is
681 somewhat more wasteful of space than one might wish, but since only
682 the files which are actually debugged are read in to core, we don't
685 struct linetable_entry
691 /* The order of entries in the linetable is significant. They should
692 be sorted by increasing values of the pc field. If there is more than
693 one entry for a given pc, then I'm not sure what should happen (and
694 I not sure whether we currently handle it the best way).
696 Example: a C for statement generally looks like this
698 10 0x100 - for the init/test part of a for stmt.
701 10 0x400 - for the increment part of a for stmt.
703 If an entry has a line number of zero, it marks the start of a PC
704 range for which no line number information is available. It is
705 acceptable, though wasteful of table space, for such a range to be
712 /* Actually NITEMS elements. If you don't like this use of the
713 `struct hack', you can shove it up your ANSI (seriously, if the
714 committee tells us how to do it, we can probably go along). */
715 struct linetable_entry item
[1];
718 /* How to relocate the symbols from each section in a symbol file.
719 Each struct contains an array of offsets.
720 The ordering and meaning of the offsets is file-type-dependent;
721 typically it is indexed by section numbers or symbol types or
724 To give us flexibility in changing the internal representation
725 of these offsets, the ANOFFSET macro must be used to insert and
726 extract offset values in the struct. */
728 struct section_offsets
730 CORE_ADDR offsets
[1]; /* As many as needed. */
733 #define ANOFFSET(secoff, whichone) \
735 ? (internal_error (__FILE__, __LINE__, \
736 _("Section index is uninitialized")), -1) \
737 : secoff->offsets[whichone])
739 /* The size of a section_offsets table for N sections. */
740 #define SIZEOF_N_SECTION_OFFSETS(n) \
741 (sizeof (struct section_offsets) \
742 + sizeof (((struct section_offsets *) 0)->offsets) * ((n)-1))
744 /* Each source file or header is represented by a struct symtab.
745 These objects are chained through the `next' field. */
749 /* Unordered chain of all existing symtabs of this objfile. */
753 /* List of all symbol scope blocks for this symtab. May be shared
754 between different symtabs (and normally is for all the symtabs
755 in a given compilation unit). */
757 struct blockvector
*blockvector
;
759 /* Table mapping core addresses to line numbers for this file.
760 Can be NULL if none. Never shared between different symtabs. */
762 struct linetable
*linetable
;
764 /* Section in objfile->section_offsets for the blockvector and
765 the linetable. Probably always SECT_OFF_TEXT. */
767 int block_line_section
;
769 /* If several symtabs share a blockvector, exactly one of them
770 should be designated the primary, so that the blockvector
771 is relocated exactly once by objfile_relocate. */
773 unsigned int primary
: 1;
775 /* Symtab has been compiled with both optimizations and debug info so that
776 GDB may stop skipping prologues as variables locations are valid already
777 at function entry points. */
779 unsigned int locations_valid
: 1;
781 /* DWARF unwinder for this CU is valid even for epilogues (PC at the return
782 instruction). This is supported by GCC since 4.5.0. */
784 unsigned int epilogue_unwind_valid
: 1;
786 /* The macro table for this symtab. Like the blockvector, this
787 may be shared between different symtabs --- and normally is for
788 all the symtabs in a given compilation unit. */
789 struct macro_table
*macro_table
;
791 /* Name of this source file. */
795 /* Directory in which it was compiled, or NULL if we don't know. */
799 /* Total number of lines found in source file. */
803 /* line_charpos[N] is the position of the (N-1)th line of the
804 source file. "position" means something we can lseek() to; it
805 is not guaranteed to be useful any other way. */
809 /* Language of this source file. */
811 enum language language
;
813 /* String that identifies the format of the debugging information, such
814 as "stabs", "dwarf 1", "dwarf 2", "coff", etc. This is mostly useful
815 for automated testing of gdb but may also be information that is
816 useful to the user. */
818 const char *debugformat
;
820 /* String of producer version information. May be zero. */
822 const char *producer
;
824 /* Full name of file as found by searching the source path.
825 NULL if not yet known. */
829 /* Object file from which this symbol information was read. */
831 struct objfile
*objfile
;
833 /* struct call_site entries for this compilation unit or NULL. */
835 htab_t call_site_htab
;
837 /* If non-NULL, then this points to a NULL-terminated vector of
838 included symbol tables. When searching the static or global
839 block of this symbol table, the corresponding block of all
840 included symbol tables will also be searched. Note that this
841 list must be flattened -- the symbol reader is responsible for
842 ensuring that this vector contains the transitive closure of all
843 included symbol tables. */
845 struct symtab
**includes
;
847 /* If this is an included symbol table, this points to one includer
848 of the table. This user is considered the canonical symbol table
849 containing this one. An included symbol table may itself be
850 included by another. */
855 #define BLOCKVECTOR(symtab) (symtab)->blockvector
856 #define LINETABLE(symtab) (symtab)->linetable
857 #define SYMTAB_PSPACE(symtab) (symtab)->objfile->pspace
860 /* The virtual function table is now an array of structures which have the
861 form { int16 offset, delta; void *pfn; }.
863 In normal virtual function tables, OFFSET is unused.
864 DELTA is the amount which is added to the apparent object's base
865 address in order to point to the actual object to which the
866 virtual function should be applied.
867 PFN is a pointer to the virtual function.
869 Note that this macro is g++ specific (FIXME). */
871 #define VTBL_FNADDR_OFFSET 2
873 /* External variables and functions for the objects described above. */
875 /* True if we are nested inside psymtab_to_symtab. */
877 extern int currently_reading_symtab
;
879 /* symtab.c lookup functions */
881 extern const char multiple_symbols_ask
[];
882 extern const char multiple_symbols_all
[];
883 extern const char multiple_symbols_cancel
[];
885 const char *multiple_symbols_select_mode (void);
887 int symbol_matches_domain (enum language symbol_language
,
888 domain_enum symbol_domain
,
891 /* lookup a symbol table by source file name. */
893 extern struct symtab
*lookup_symtab (const char *);
895 /* lookup a symbol by name (optional block) in language. */
897 extern struct symbol
*lookup_symbol_in_language (const char *,
898 const struct block
*,
903 /* lookup a symbol by name (optional block, optional symtab)
904 in the current language. */
906 extern struct symbol
*lookup_symbol (const char *, const struct block
*,
907 const domain_enum
, int *);
909 /* A default version of lookup_symbol_nonlocal for use by languages
910 that can't think of anything better to do. */
912 extern struct symbol
*basic_lookup_symbol_nonlocal (const char *,
913 const struct block
*,
916 /* Some helper functions for languages that need to write their own
917 lookup_symbol_nonlocal functions. */
919 /* Lookup a symbol in the static block associated to BLOCK, if there
920 is one; do nothing if BLOCK is NULL or a global block. */
922 extern struct symbol
*lookup_symbol_static (const char *name
,
923 const struct block
*block
,
924 const domain_enum domain
);
926 /* Lookup a symbol in all files' global blocks (searching psymtabs if
929 extern struct symbol
*lookup_symbol_global (const char *name
,
930 const struct block
*block
,
931 const domain_enum domain
);
933 /* Lookup a symbol within the block BLOCK. This, unlike
934 lookup_symbol_block, will set SYMTAB and BLOCK_FOUND correctly, and
935 will fix up the symbol if necessary. */
937 extern struct symbol
*lookup_symbol_aux_block (const char *name
,
938 const struct block
*block
,
939 const domain_enum domain
);
941 extern struct symbol
*lookup_language_this (const struct language_defn
*lang
,
942 const struct block
*block
);
944 /* Lookup a symbol only in the file static scope of all the objfiles. */
946 struct symbol
*lookup_static_symbol_aux (const char *name
,
947 const domain_enum domain
);
950 /* lookup a symbol by name, within a specified block. */
952 extern struct symbol
*lookup_block_symbol (const struct block
*, const char *,
955 /* lookup a [struct, union, enum] by name, within a specified block. */
957 extern struct type
*lookup_struct (const char *, struct block
*);
959 extern struct type
*lookup_union (const char *, struct block
*);
961 extern struct type
*lookup_enum (const char *, struct block
*);
963 /* from blockframe.c: */
965 /* lookup the function symbol corresponding to the address. */
967 extern struct symbol
*find_pc_function (CORE_ADDR
);
969 /* lookup the function corresponding to the address and section. */
971 extern struct symbol
*find_pc_sect_function (CORE_ADDR
, struct obj_section
*);
973 extern int find_pc_partial_function_gnu_ifunc (CORE_ADDR pc
, const char **name
,
976 int *is_gnu_ifunc_p
);
978 /* lookup function from address, return name, start addr and end addr. */
980 extern int find_pc_partial_function (CORE_ADDR
, const char **, CORE_ADDR
*,
983 extern void clear_pc_function_cache (void);
985 /* lookup partial symbol table by address and section. */
987 extern struct symtab
*find_pc_sect_symtab_via_partial (CORE_ADDR
,
988 struct obj_section
*);
990 /* lookup full symbol table by address. */
992 extern struct symtab
*find_pc_symtab (CORE_ADDR
);
994 /* lookup full symbol table by address and section. */
996 extern struct symtab
*find_pc_sect_symtab (CORE_ADDR
, struct obj_section
*);
998 extern int find_pc_line_pc_range (CORE_ADDR
, CORE_ADDR
*, CORE_ADDR
*);
1000 extern void reread_symbols (void);
1002 extern struct type
*lookup_transparent_type (const char *);
1003 extern struct type
*basic_lookup_transparent_type (const char *);
1006 /* Macro for name of symbol to indicate a file compiled with gcc. */
1007 #ifndef GCC_COMPILED_FLAG_SYMBOL
1008 #define GCC_COMPILED_FLAG_SYMBOL "gcc_compiled."
1011 /* Macro for name of symbol to indicate a file compiled with gcc2. */
1012 #ifndef GCC2_COMPILED_FLAG_SYMBOL
1013 #define GCC2_COMPILED_FLAG_SYMBOL "gcc2_compiled."
1016 extern int in_gnu_ifunc_stub (CORE_ADDR pc
);
1018 /* Functions for resolving STT_GNU_IFUNC symbols which are implemented only
1019 for ELF symbol files. */
1021 struct gnu_ifunc_fns
1023 /* See elf_gnu_ifunc_resolve_addr for its real implementation. */
1024 CORE_ADDR (*gnu_ifunc_resolve_addr
) (struct gdbarch
*gdbarch
, CORE_ADDR pc
);
1026 /* See elf_gnu_ifunc_resolve_name for its real implementation. */
1027 int (*gnu_ifunc_resolve_name
) (const char *function_name
,
1028 CORE_ADDR
*function_address_p
);
1030 /* See elf_gnu_ifunc_resolver_stop for its real implementation. */
1031 void (*gnu_ifunc_resolver_stop
) (struct breakpoint
*b
);
1033 /* See elf_gnu_ifunc_resolver_return_stop for its real implementation. */
1034 void (*gnu_ifunc_resolver_return_stop
) (struct breakpoint
*b
);
1037 #define gnu_ifunc_resolve_addr gnu_ifunc_fns_p->gnu_ifunc_resolve_addr
1038 #define gnu_ifunc_resolve_name gnu_ifunc_fns_p->gnu_ifunc_resolve_name
1039 #define gnu_ifunc_resolver_stop gnu_ifunc_fns_p->gnu_ifunc_resolver_stop
1040 #define gnu_ifunc_resolver_return_stop \
1041 gnu_ifunc_fns_p->gnu_ifunc_resolver_return_stop
1043 extern const struct gnu_ifunc_fns
*gnu_ifunc_fns_p
;
1045 extern CORE_ADDR
find_solib_trampoline_target (struct frame_info
*, CORE_ADDR
);
1047 struct symtab_and_line
1049 /* The program space of this sal. */
1050 struct program_space
*pspace
;
1052 struct symtab
*symtab
;
1053 struct obj_section
*section
;
1054 /* Line number. Line numbers start at 1 and proceed through symtab->nlines.
1055 0 is never a valid line number; it is used to indicate that line number
1056 information is not available. */
1064 /* The probe associated with this symtab_and_line. */
1065 struct probe
*probe
;
1068 extern void init_sal (struct symtab_and_line
*sal
);
1070 struct symtabs_and_lines
1072 struct symtab_and_line
*sals
;
1078 /* Some types and macros needed for exception catchpoints.
1079 Can't put these in target.h because symtab_and_line isn't
1080 known there. This file will be included by breakpoint.c,
1081 hppa-tdep.c, etc. */
1083 /* Enums for exception-handling support. */
1084 enum exception_event_kind
1092 /* Given a pc value, return line number it is in. Second arg nonzero means
1093 if pc is on the boundary use the previous statement's line number. */
1095 extern struct symtab_and_line
find_pc_line (CORE_ADDR
, int);
1097 /* Same function, but specify a section as well as an address. */
1099 extern struct symtab_and_line
find_pc_sect_line (CORE_ADDR
,
1100 struct obj_section
*, int);
1102 /* Given a symtab and line number, return the pc there. */
1104 extern int find_line_pc (struct symtab
*, int, CORE_ADDR
*);
1106 extern int find_line_pc_range (struct symtab_and_line
, CORE_ADDR
*,
1109 extern void resolve_sal_pc (struct symtab_and_line
*);
1111 /* Given a string, return the line specified by it. For commands like "list"
1112 and "breakpoint". */
1114 extern struct symtabs_and_lines
decode_line_spec (char *, int);
1116 extern struct symtabs_and_lines
decode_line_spec_1 (char *, int);
1120 void maintenance_print_symbols (char *, int);
1122 void maintenance_print_psymbols (char *, int);
1124 void maintenance_print_msymbols (char *, int);
1126 void maintenance_print_objfiles (char *, int);
1128 void maintenance_info_symtabs (char *, int);
1130 void maintenance_info_psymtabs (char *, int);
1132 void maintenance_check_symtabs (char *, int);
1136 void maintenance_print_statistics (char *, int);
1138 /* Symbol-reading stuff in symfile.c and solib.c. */
1140 extern void clear_solib (void);
1144 extern int identify_source_line (struct symtab
*, int, int, CORE_ADDR
);
1146 extern void print_source_lines (struct symtab
*, int, int, int);
1148 extern void forget_cached_source_info_for_objfile (struct objfile
*);
1149 extern void forget_cached_source_info (void);
1151 extern void select_source_symtab (struct symtab
*);
1153 extern char **default_make_symbol_completion_list_break_on
1154 (char *text
, char *word
, const char *break_on
);
1155 extern char **default_make_symbol_completion_list (char *, char *);
1156 extern char **make_symbol_completion_list (char *, char *);
1157 extern char **make_symbol_completion_list_fn (struct cmd_list_element
*,
1160 extern char **make_file_symbol_completion_list (char *, char *, char *);
1162 extern char **make_source_files_completion_list (char *, char *);
1166 int matching_obj_sections (struct obj_section
*, struct obj_section
*);
1168 extern const char *find_main_filename (void);
1170 extern struct symtab
*find_line_symtab (struct symtab
*, int, int *, int *);
1172 extern struct symtab_and_line
find_function_start_sal (struct symbol
*sym
,
1175 extern void skip_prologue_sal (struct symtab_and_line
*);
1179 extern void clear_symtab_users (int add_flags
);
1181 extern enum language
deduce_language_from_filename (const char *);
1185 extern int in_prologue (struct gdbarch
*gdbarch
,
1186 CORE_ADDR pc
, CORE_ADDR func_start
);
1188 extern CORE_ADDR
skip_prologue_using_sal (struct gdbarch
*gdbarch
,
1189 CORE_ADDR func_addr
);
1191 extern struct symbol
*fixup_symbol_section (struct symbol
*,
1194 /* Symbol searching */
1196 /* When using search_symbols, a list of the following structs is returned.
1197 Callers must free the search list using free_search_symbols! */
1198 struct symbol_search
1200 /* The block in which the match was found. Could be, for example,
1201 STATIC_BLOCK or GLOBAL_BLOCK. */
1204 /* Information describing what was found.
1206 If symtab abd symbol are NOT NULL, then information was found
1208 struct symtab
*symtab
;
1209 struct symbol
*symbol
;
1211 /* If msymbol is non-null, then a match was made on something for
1212 which only minimal_symbols exist. */
1213 struct minimal_symbol
*msymbol
;
1215 /* A link to the next match, or NULL for the end. */
1216 struct symbol_search
*next
;
1219 extern void search_symbols (char *, enum search_domain
, int, char **,
1220 struct symbol_search
**);
1221 extern void free_search_symbols (struct symbol_search
*);
1222 extern struct cleanup
*make_cleanup_free_search_symbols (struct symbol_search
1225 /* The name of the ``main'' function.
1226 FIXME: cagney/2001-03-20: Can't make main_name() const since some
1227 of the calling code currently assumes that the string isn't
1229 extern void set_main_name (const char *name
);
1230 extern /*const */ char *main_name (void);
1231 extern enum language language_of_main
;
1233 /* Check global symbols in objfile. */
1234 struct symbol
*lookup_global_symbol_from_objfile (const struct objfile
*,
1236 const domain_enum domain
);
1238 /* Return 1 if the supplied producer string matches the ARM RealView
1239 compiler (armcc). */
1240 int producer_is_realview (const char *producer
);
1242 void fixup_section (struct general_symbol_info
*ginfo
,
1243 CORE_ADDR addr
, struct objfile
*objfile
);
1245 struct objfile
*lookup_objfile_from_block (const struct block
*block
);
1247 extern int basenames_may_differ
;
1249 int compare_filenames_for_search (const char *filename
,
1250 const char *search_name
,
1253 int iterate_over_some_symtabs (const char *name
,
1254 const char *full_path
,
1255 const char *real_path
,
1256 int (*callback
) (struct symtab
*symtab
,
1259 struct symtab
*first
,
1260 struct symtab
*after_last
);
1262 void iterate_over_symtabs (const char *name
,
1263 int (*callback
) (struct symtab
*symtab
,
1267 DEF_VEC_I (CORE_ADDR
);
1269 VEC (CORE_ADDR
) *find_pcs_for_symtab_line (struct symtab
*symtab
, int line
,
1270 struct linetable_entry
**best_entry
);
1272 /* Callback for LA_ITERATE_OVER_SYMBOLS. The callback will be called
1273 once per matching symbol SYM, with DATA being the argument of the
1274 same name that was passed to LA_ITERATE_OVER_SYMBOLS. The callback
1275 should return nonzero to indicate that LA_ITERATE_OVER_SYMBOLS
1276 should continue iterating, or zero to indicate that the iteration
1279 typedef int (symbol_found_callback_ftype
) (struct symbol
*sym
, void *data
);
1281 void iterate_over_symbols (const struct block
*block
, const char *name
,
1282 const domain_enum domain
,
1283 symbol_found_callback_ftype
*callback
,
1286 struct cleanup
*demangle_for_lookup (const char *name
, enum language lang
,
1287 const char **result_name
);
1289 #endif /* !defined(SYMTAB_H) */