1 /* Symbol table definitions for GDB.
3 Copyright (C) 1986-2013 Free Software Foundation, Inc.
5 This file is part of GDB.
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program. If not, see <http://www.gnu.org/licenses/>. */
20 #if !defined (SYMTAB_H)
27 /* Opaque declarations. */
42 /* Some of the structures in this file are space critical.
43 The space-critical structures are:
45 struct general_symbol_info
49 These structures are laid out to encourage good packing.
50 They use ENUM_BITFIELD and short int fields, and they order the
51 structure members so that fields less than a word are next
52 to each other so they can be packed together. */
54 /* Rearranged: used ENUM_BITFIELD and rearranged field order in
55 all the space critical structures (plus struct minimal_symbol).
56 Memory usage dropped from 99360768 bytes to 90001408 bytes.
57 I measured this with before-and-after tests of
58 "HEAD-old-gdb -readnow HEAD-old-gdb" and
59 "HEAD-new-gdb -readnow HEAD-old-gdb" on native i686-pc-linux-gnu,
60 red hat linux 8, with LD_LIBRARY_PATH=/usr/lib/debug,
61 typing "maint space 1" at the first command prompt.
63 Here is another measurement (from andrew c):
64 # no /usr/lib/debug, just plain glibc, like a normal user
66 (gdb) break internal_error
68 (gdb) maint internal-error
72 gdb gdb_6_0_branch 2003-08-19 space used: 8896512
73 gdb HEAD 2003-08-19 space used: 8904704
74 gdb HEAD 2003-08-21 space used: 8396800 (+symtab.h)
75 gdb HEAD 2003-08-21 space used: 8265728 (+gdbtypes.h)
77 The third line shows the savings from the optimizations in symtab.h.
78 The fourth line shows the savings from the optimizations in
79 gdbtypes.h. Both optimizations are in gdb HEAD now.
81 --chastain 2003-08-21 */
83 /* Struct for storing C++ specific information. Allocated when needed. */
87 const char *demangled_name
;
90 /* Define a structure for the information that is common to all symbol types,
91 including minimal symbols, partial symbols, and full symbols. In a
92 multilanguage environment, some language specific information may need to
93 be recorded along with each symbol. */
95 /* This structure is space critical. See space comments at the top. */
97 struct general_symbol_info
99 /* Name of the symbol. This is a required field. Storage for the
100 name is allocated on the objfile_obstack for the associated
101 objfile. For languages like C++ that make a distinction between
102 the mangled name and demangled name, this is the mangled
107 /* Value of the symbol. Which member of this union to use, and what
108 it means, depends on what kind of symbol this is and its
109 SYMBOL_CLASS. See comments there for more details. All of these
110 are in host byte order (though what they point to might be in
111 target byte order, e.g. LOC_CONST_BYTES). */
123 /* A common block. Used with LOC_COMMON_BLOCK. */
125 struct common_block
*common_block
;
127 /* For opaque typedef struct chain. */
129 struct symbol
*chain
;
133 /* Since one and only one language can apply, wrap the language specific
134 information inside a union. */
138 /* A pointer to an obstack that can be used for storage associated
139 with this symbol. This is only used by Ada, and only when the
140 'ada_mangled' field is zero. */
141 struct obstack
*obstack
;
143 /* This is used by languages which wish to store a demangled name.
144 currently used by Ada, Java, and Objective C. */
147 const char *demangled_name
;
151 struct cplus_specific
*cplus_specific
;
155 /* Record the source code language that applies to this symbol.
156 This is used to select one of the fields from the language specific
159 ENUM_BITFIELD(language
) language
: 8;
161 /* This is only used by Ada. If set, then the 'mangled_lang' field
162 of language_specific is valid. Otherwise, the 'obstack' field is
164 unsigned int ada_mangled
: 1;
166 /* Which section is this symbol in? This is an index into
167 section_offsets for this objfile. Negative means that the symbol
168 does not get relocated relative to a section.
169 Disclaimer: currently this is just used for xcoff, so don't
170 expect all symbol-reading code to set it correctly (the ELF code
171 also tries to set it correctly). */
175 /* The section associated with this symbol. It can be NULL. */
177 struct obj_section
*obj_section
;
180 extern void symbol_set_demangled_name (struct general_symbol_info
*,
184 extern const char *symbol_get_demangled_name
185 (const struct general_symbol_info
*);
187 extern CORE_ADDR
symbol_overlayed_address (CORE_ADDR
, struct obj_section
*);
189 /* Note that all the following SYMBOL_* macros are used with the
190 SYMBOL argument being either a partial symbol, a minimal symbol or
191 a full symbol. All three types have a ginfo field. In particular
192 the SYMBOL_SET_LANGUAGE, SYMBOL_DEMANGLED_NAME, etc.
193 macros cannot be entirely substituted by
194 functions, unless the callers are changed to pass in the ginfo
195 field only, instead of the SYMBOL parameter. */
197 #define SYMBOL_VALUE(symbol) (symbol)->ginfo.value.ivalue
198 #define SYMBOL_VALUE_ADDRESS(symbol) (symbol)->ginfo.value.address
199 #define SYMBOL_VALUE_BYTES(symbol) (symbol)->ginfo.value.bytes
200 #define SYMBOL_VALUE_COMMON_BLOCK(symbol) (symbol)->ginfo.value.common_block
201 #define SYMBOL_BLOCK_VALUE(symbol) (symbol)->ginfo.value.block
202 #define SYMBOL_VALUE_CHAIN(symbol) (symbol)->ginfo.value.chain
203 #define SYMBOL_LANGUAGE(symbol) (symbol)->ginfo.language
204 #define SYMBOL_SECTION(symbol) (symbol)->ginfo.section
205 #define SYMBOL_OBJ_SECTION(symbol) (symbol)->ginfo.obj_section
207 /* Initializes the language dependent portion of a symbol
208 depending upon the language for the symbol. */
209 #define SYMBOL_SET_LANGUAGE(symbol,language,obstack) \
210 (symbol_set_language (&(symbol)->ginfo, (language), (obstack)))
211 extern void symbol_set_language (struct general_symbol_info
*symbol
,
212 enum language language
,
213 struct obstack
*obstack
);
215 /* Set just the linkage name of a symbol; do not try to demangle
216 it. Used for constructs which do not have a mangled name,
217 e.g. struct tags. Unlike SYMBOL_SET_NAMES, linkage_name must
218 be terminated and either already on the objfile's obstack or
219 permanently allocated. */
220 #define SYMBOL_SET_LINKAGE_NAME(symbol,linkage_name) \
221 (symbol)->ginfo.name = (linkage_name)
223 /* Set the linkage and natural names of a symbol, by demangling
225 #define SYMBOL_SET_NAMES(symbol,linkage_name,len,copy_name,objfile) \
226 symbol_set_names (&(symbol)->ginfo, linkage_name, len, copy_name, objfile)
227 extern void symbol_set_names (struct general_symbol_info
*symbol
,
228 const char *linkage_name
, int len
, int copy_name
,
229 struct objfile
*objfile
);
231 /* Now come lots of name accessor macros. Short version as to when to
232 use which: Use SYMBOL_NATURAL_NAME to refer to the name of the
233 symbol in the original source code. Use SYMBOL_LINKAGE_NAME if you
234 want to know what the linker thinks the symbol's name is. Use
235 SYMBOL_PRINT_NAME for output. Use SYMBOL_DEMANGLED_NAME if you
236 specifically need to know whether SYMBOL_NATURAL_NAME and
237 SYMBOL_LINKAGE_NAME are different. */
239 /* Return SYMBOL's "natural" name, i.e. the name that it was called in
240 the original source code. In languages like C++ where symbols may
241 be mangled for ease of manipulation by the linker, this is the
244 #define SYMBOL_NATURAL_NAME(symbol) \
245 (symbol_natural_name (&(symbol)->ginfo))
246 extern const char *symbol_natural_name
247 (const struct general_symbol_info
*symbol
);
249 /* Return SYMBOL's name from the point of view of the linker. In
250 languages like C++ where symbols may be mangled for ease of
251 manipulation by the linker, this is the mangled name; otherwise,
252 it's the same as SYMBOL_NATURAL_NAME. */
254 #define SYMBOL_LINKAGE_NAME(symbol) (symbol)->ginfo.name
256 /* Return the demangled name for a symbol based on the language for
257 that symbol. If no demangled name exists, return NULL. */
258 #define SYMBOL_DEMANGLED_NAME(symbol) \
259 (symbol_demangled_name (&(symbol)->ginfo))
260 extern const char *symbol_demangled_name
261 (const struct general_symbol_info
*symbol
);
263 /* Macro that returns a version of the name of a symbol that is
264 suitable for output. In C++ this is the "demangled" form of the
265 name if demangle is on and the "mangled" form of the name if
266 demangle is off. In other languages this is just the symbol name.
267 The result should never be NULL. Don't use this for internal
268 purposes (e.g. storing in a hashtable): it's only suitable for output.
270 N.B. symbol may be anything with a ginfo member,
271 e.g., struct symbol or struct minimal_symbol. */
273 #define SYMBOL_PRINT_NAME(symbol) \
274 (demangle ? SYMBOL_NATURAL_NAME (symbol) : SYMBOL_LINKAGE_NAME (symbol))
277 /* Macro that returns the name to be used when sorting and searching symbols.
278 In C++, Chill, and Java, we search for the demangled form of a name,
279 and so sort symbols accordingly. In Ada, however, we search by mangled
280 name. If there is no distinct demangled name, then SYMBOL_SEARCH_NAME
281 returns the same value (same pointer) as SYMBOL_LINKAGE_NAME. */
282 #define SYMBOL_SEARCH_NAME(symbol) \
283 (symbol_search_name (&(symbol)->ginfo))
284 extern const char *symbol_search_name (const struct general_symbol_info
*);
286 /* Return non-zero if NAME matches the "search" name of SYMBOL.
287 Whitespace and trailing parentheses are ignored.
288 See strcmp_iw for details about its behavior. */
289 #define SYMBOL_MATCHES_SEARCH_NAME(symbol, name) \
290 (strcmp_iw (SYMBOL_SEARCH_NAME (symbol), (name)) == 0)
292 /* Classification types for a minimal symbol. These should be taken as
293 "advisory only", since if gdb can't easily figure out a
294 classification it simply selects mst_unknown. It may also have to
295 guess when it can't figure out which is a better match between two
296 types (mst_data versus mst_bss) for example. Since the minimal
297 symbol info is sometimes derived from the BFD library's view of a
298 file, we need to live with what information bfd supplies. */
300 enum minimal_symbol_type
302 mst_unknown
= 0, /* Unknown type, the default */
303 mst_text
, /* Generally executable instructions */
304 mst_text_gnu_ifunc
, /* Executable code returning address
305 of executable code */
306 mst_slot_got_plt
, /* GOT entries for .plt sections */
307 mst_data
, /* Generally initialized data */
308 mst_bss
, /* Generally uninitialized data */
309 mst_abs
, /* Generally absolute (nonrelocatable) */
310 /* GDB uses mst_solib_trampoline for the start address of a shared
311 library trampoline entry. Breakpoints for shared library functions
312 are put there if the shared library is not yet loaded.
313 After the shared library is loaded, lookup_minimal_symbol will
314 prefer the minimal symbol from the shared library (usually
315 a mst_text symbol) over the mst_solib_trampoline symbol, and the
316 breakpoints will be moved to their true address in the shared
317 library via breakpoint_re_set. */
318 mst_solib_trampoline
, /* Shared library trampoline code */
319 /* For the mst_file* types, the names are only guaranteed to be unique
320 within a given .o file. */
321 mst_file_text
, /* Static version of mst_text */
322 mst_file_data
, /* Static version of mst_data */
323 mst_file_bss
/* Static version of mst_bss */
326 /* Define a simple structure used to hold some very basic information about
327 all defined global symbols (text, data, bss, abs, etc). The only required
328 information is the general_symbol_info.
330 In many cases, even if a file was compiled with no special options for
331 debugging at all, as long as was not stripped it will contain sufficient
332 information to build a useful minimal symbol table using this structure.
333 Even when a file contains enough debugging information to build a full
334 symbol table, these minimal symbols are still useful for quickly mapping
335 between names and addresses, and vice versa. They are also sometimes
336 used to figure out what full symbol table entries need to be read in. */
338 struct minimal_symbol
341 /* The general symbol info required for all types of symbols.
343 The SYMBOL_VALUE_ADDRESS contains the address that this symbol
346 struct general_symbol_info ginfo
;
348 /* Size of this symbol. end_psymtab in dbxread.c uses this
349 information to calculate the end of the partial symtab based on the
350 address of the last symbol plus the size of the last symbol. */
354 /* Which source file is this symbol in? Only relevant for mst_file_*. */
355 const char *filename
;
357 /* Classification type for this minimal symbol. */
359 ENUM_BITFIELD(minimal_symbol_type
) type
: 8;
361 /* Non-zero if this symbol was created by gdb.
362 Such symbols do not appear in the output of "info var|fun". */
363 unsigned int created_by_gdb
: 1;
365 /* Two flag bits provided for the use of the target. */
366 unsigned int target_flag_1
: 1;
367 unsigned int target_flag_2
: 1;
369 /* Nonzero iff the size of the minimal symbol has been set.
370 Symbol size information can sometimes not be determined, because
371 the object file format may not carry that piece of information. */
372 unsigned int has_size
: 1;
374 /* Minimal symbols with the same hash key are kept on a linked
375 list. This is the link. */
377 struct minimal_symbol
*hash_next
;
379 /* Minimal symbols are stored in two different hash tables. This is
380 the `next' pointer for the demangled hash table. */
382 struct minimal_symbol
*demangled_hash_next
;
385 #define MSYMBOL_TARGET_FLAG_1(msymbol) (msymbol)->target_flag_1
386 #define MSYMBOL_TARGET_FLAG_2(msymbol) (msymbol)->target_flag_2
387 #define MSYMBOL_SIZE(msymbol) ((msymbol)->size + 0)
388 #define SET_MSYMBOL_SIZE(msymbol, sz) \
391 (msymbol)->size = sz; \
392 (msymbol)->has_size = 1; \
394 #define MSYMBOL_HAS_SIZE(msymbol) ((msymbol)->has_size + 0)
395 #define MSYMBOL_TYPE(msymbol) (msymbol)->type
401 /* Represent one symbol name; a variable, constant, function or typedef. */
403 /* Different name domains for symbols. Looking up a symbol specifies a
404 domain and ignores symbol definitions in other name domains. */
406 typedef enum domain_enum_tag
408 /* UNDEF_DOMAIN is used when a domain has not been discovered or
409 none of the following apply. This usually indicates an error either
410 in the symbol information or in gdb's handling of symbols. */
414 /* VAR_DOMAIN is the usual domain. In C, this contains variables,
415 function names, typedef names and enum type values. */
419 /* STRUCT_DOMAIN is used in C to hold struct, union and enum type names.
420 Thus, if `struct foo' is used in a C program, it produces a symbol named
421 `foo' in the STRUCT_DOMAIN. */
425 /* LABEL_DOMAIN may be used for names of labels (for gotos). */
429 /* Fortran common blocks. Their naming must be separate from VAR_DOMAIN.
430 They also always use LOC_COMMON_BLOCK. */
434 /* Searching domains, used for `search_symbols'. Element numbers are
435 hardcoded in GDB, check all enum uses before changing it. */
439 /* Everything in VAR_DOMAIN minus FUNCTIONS_DOMAIN and
441 VARIABLES_DOMAIN
= 0,
443 /* All functions -- for some reason not methods, though. */
444 FUNCTIONS_DOMAIN
= 1,
446 /* All defined types */
453 /* An address-class says where to find the value of a symbol. */
457 /* Not used; catches errors. */
461 /* Value is constant int SYMBOL_VALUE, host byteorder. */
465 /* Value is at fixed address SYMBOL_VALUE_ADDRESS. */
469 /* Value is in register. SYMBOL_VALUE is the register number
470 in the original debug format. SYMBOL_REGISTER_OPS holds a
471 function that can be called to transform this into the
472 actual register number this represents in a specific target
473 architecture (gdbarch).
475 For some symbol formats (stabs, for some compilers at least),
476 the compiler generates two symbols, an argument and a register.
477 In some cases we combine them to a single LOC_REGISTER in symbol
478 reading, but currently not for all cases (e.g. it's passed on the
479 stack and then loaded into a register). */
483 /* It's an argument; the value is at SYMBOL_VALUE offset in arglist. */
487 /* Value address is at SYMBOL_VALUE offset in arglist. */
491 /* Value is in specified register. Just like LOC_REGISTER except the
492 register holds the address of the argument instead of the argument
493 itself. This is currently used for the passing of structs and unions
494 on sparc and hppa. It is also used for call by reference where the
495 address is in a register, at least by mipsread.c. */
499 /* Value is a local variable at SYMBOL_VALUE offset in stack frame. */
503 /* Value not used; definition in SYMBOL_TYPE. Symbols in the domain
504 STRUCT_DOMAIN all have this class. */
508 /* Value is address SYMBOL_VALUE_ADDRESS in the code. */
512 /* In a symbol table, value is SYMBOL_BLOCK_VALUE of a `struct block'.
513 In a partial symbol table, SYMBOL_VALUE_ADDRESS is the start address
514 of the block. Function names have this class. */
518 /* Value is a constant byte-sequence pointed to by SYMBOL_VALUE_BYTES, in
519 target byte order. */
523 /* Value is at fixed address, but the address of the variable has
524 to be determined from the minimal symbol table whenever the
525 variable is referenced.
526 This happens if debugging information for a global symbol is
527 emitted and the corresponding minimal symbol is defined
528 in another object file or runtime common storage.
529 The linker might even remove the minimal symbol if the global
530 symbol is never referenced, in which case the symbol remains
533 GDB would normally find the symbol in the minimal symbol table if it will
534 not find it in the full symbol table. But a reference to an external
535 symbol in a local block shadowing other definition requires full symbol
536 without possibly having its address available for LOC_STATIC. Testcase
537 is provided as `gdb.dwarf2/dw2-unresolved.exp'. */
541 /* The variable does not actually exist in the program.
542 The value is ignored. */
546 /* The variable's address is computed by a set of location
547 functions (see "struct symbol_computed_ops" below). */
550 /* The variable uses general_symbol_info->value->common_block field.
551 It also always uses COMMON_BLOCK_DOMAIN. */
554 /* Not used, just notes the boundary of the enum. */
558 /* The methods needed to implement LOC_COMPUTED. These methods can
559 use the symbol's .aux_value for additional per-symbol information.
561 At present this is only used to implement location expressions. */
563 struct symbol_computed_ops
566 /* Return the value of the variable SYMBOL, relative to the stack
567 frame FRAME. If the variable has been optimized out, return
570 Iff `read_needs_frame (SYMBOL)' is zero, then FRAME may be zero. */
572 struct value
*(*read_variable
) (struct symbol
* symbol
,
573 struct frame_info
* frame
);
575 /* Read variable SYMBOL like read_variable at (callee) FRAME's function
576 entry. SYMBOL should be a function parameter, otherwise
577 NO_ENTRY_VALUE_ERROR will be thrown. */
578 struct value
*(*read_variable_at_entry
) (struct symbol
*symbol
,
579 struct frame_info
*frame
);
581 /* Return non-zero if we need a frame to find the value of the SYMBOL. */
582 int (*read_needs_frame
) (struct symbol
* symbol
);
584 /* Write to STREAM a natural-language description of the location of
585 SYMBOL, in the context of ADDR. */
586 void (*describe_location
) (struct symbol
* symbol
, CORE_ADDR addr
,
587 struct ui_file
* stream
);
589 /* Non-zero if this symbol's address computation is dependent on PC. */
590 unsigned char location_has_loclist
;
592 /* Tracepoint support. Append bytecodes to the tracepoint agent
593 expression AX that push the address of the object SYMBOL. Set
594 VALUE appropriately. Note --- for objects in registers, this
595 needn't emit any code; as long as it sets VALUE properly, then
596 the caller will generate the right code in the process of
597 treating this as an lvalue or rvalue. */
599 void (*tracepoint_var_ref
) (struct symbol
*symbol
, struct gdbarch
*gdbarch
,
600 struct agent_expr
*ax
, struct axs_value
*value
);
603 /* The methods needed to implement LOC_BLOCK for inferior functions.
604 These methods can use the symbol's .aux_value for additional
605 per-symbol information. */
607 struct symbol_block_ops
609 /* Fill in *START and *LENGTH with DWARF block data of function
610 FRAMEFUNC valid for inferior context address PC. Set *LENGTH to
611 zero if such location is not valid for PC; *START is left
612 uninitialized in such case. */
613 void (*find_frame_base_location
) (struct symbol
*framefunc
, CORE_ADDR pc
,
614 const gdb_byte
**start
, size_t *length
);
617 /* Functions used with LOC_REGISTER and LOC_REGPARM_ADDR. */
619 struct symbol_register_ops
621 int (*register_number
) (struct symbol
*symbol
, struct gdbarch
*gdbarch
);
624 /* Objects of this type are used to find the address class and the
625 various computed ops vectors of a symbol. */
629 enum address_class aclass
;
631 /* Used with LOC_COMPUTED. */
632 const struct symbol_computed_ops
*ops_computed
;
634 /* Used with LOC_BLOCK. */
635 const struct symbol_block_ops
*ops_block
;
637 /* Used with LOC_REGISTER and LOC_REGPARM_ADDR. */
638 const struct symbol_register_ops
*ops_register
;
641 /* The number of bits we reserve in a symbol for the aclass index.
642 This is a #define so that we can have a assertion elsewhere to
643 verify that we have reserved enough space for synthetic address
646 #define SYMBOL_ACLASS_BITS 6
648 /* This structure is space critical. See space comments at the top. */
653 /* The general symbol info required for all types of symbols. */
655 struct general_symbol_info ginfo
;
657 /* Data type of value */
661 /* The symbol table containing this symbol. This is the file
662 associated with LINE. It can be NULL during symbols read-in but it is
663 never NULL during normal operation. */
664 struct symtab
*symtab
;
668 ENUM_BITFIELD(domain_enum_tag
) domain
: 6;
670 /* Address class. This holds an index into the 'symbol_impls'
671 table. The actual enum address_class value is stored there,
672 alongside any per-class ops vectors. */
674 unsigned int aclass_index
: SYMBOL_ACLASS_BITS
;
676 /* Whether this is an argument. */
678 unsigned is_argument
: 1;
680 /* Whether this is an inlined function (class LOC_BLOCK only). */
681 unsigned is_inlined
: 1;
683 /* True if this is a C++ function symbol with template arguments.
684 In this case the symbol is really a "struct template_symbol". */
685 unsigned is_cplus_template_function
: 1;
687 /* Line number of this symbol's definition, except for inlined
688 functions. For an inlined function (class LOC_BLOCK and
689 SYMBOL_INLINED set) this is the line number of the function's call
690 site. Inlined function symbols are not definitions, and they are
691 never found by symbol table lookup.
693 FIXME: Should we really make the assumption that nobody will try
694 to debug files longer than 64K lines? What about machine
695 generated programs? */
699 /* An arbitrary data pointer, allowing symbol readers to record
700 additional information on a per-symbol basis. Note that this data
701 must be allocated using the same obstack as the symbol itself. */
702 /* So far it is only used by LOC_COMPUTED to
703 find the location information. For a LOC_BLOCK symbol
704 for a function in a compilation unit compiled with DWARF 2
705 information, this is information used internally by the DWARF 2
706 code --- specifically, the location expression for the frame
707 base for this function. */
708 /* FIXME drow/2003-02-21: For the LOC_BLOCK case, it might be better
709 to add a magic symbol to the block containing this information,
710 or to have a generic debug info annotation slot for symbols. */
714 struct symbol
*hash_next
;
717 extern const struct symbol_impl
*symbol_impls
;
719 #define SYMBOL_DOMAIN(symbol) (symbol)->domain
720 #define SYMBOL_IMPL(symbol) (symbol_impls[(symbol)->aclass_index])
721 #define SYMBOL_ACLASS_INDEX(symbol) (symbol)->aclass_index
722 #define SYMBOL_CLASS(symbol) (SYMBOL_IMPL (symbol).aclass)
723 #define SYMBOL_IS_ARGUMENT(symbol) (symbol)->is_argument
724 #define SYMBOL_INLINED(symbol) (symbol)->is_inlined
725 #define SYMBOL_IS_CPLUS_TEMPLATE_FUNCTION(symbol) \
726 (symbol)->is_cplus_template_function
727 #define SYMBOL_TYPE(symbol) (symbol)->type
728 #define SYMBOL_LINE(symbol) (symbol)->line
729 #define SYMBOL_SYMTAB(symbol) (symbol)->symtab
730 #define SYMBOL_COMPUTED_OPS(symbol) (SYMBOL_IMPL (symbol).ops_computed)
731 #define SYMBOL_BLOCK_OPS(symbol) (SYMBOL_IMPL (symbol).ops_block)
732 #define SYMBOL_REGISTER_OPS(symbol) (SYMBOL_IMPL (symbol).ops_register)
733 #define SYMBOL_LOCATION_BATON(symbol) (symbol)->aux_value
735 extern int register_symbol_computed_impl (enum address_class
,
736 const struct symbol_computed_ops
*);
738 extern int register_symbol_block_impl (enum address_class aclass
,
739 const struct symbol_block_ops
*ops
);
741 extern int register_symbol_register_impl (enum address_class
,
742 const struct symbol_register_ops
*);
744 /* An instance of this type is used to represent a C++ template
745 function. It includes a "struct symbol" as a kind of base class;
746 users downcast to "struct template_symbol *" when needed. A symbol
747 is really of this type iff SYMBOL_IS_CPLUS_TEMPLATE_FUNCTION is
750 struct template_symbol
752 /* The base class. */
755 /* The number of template arguments. */
756 int n_template_arguments
;
758 /* The template arguments. This is an array with
759 N_TEMPLATE_ARGUMENTS elements. */
760 struct symbol
**template_arguments
;
764 /* Each item represents a line-->pc (or the reverse) mapping. This is
765 somewhat more wasteful of space than one might wish, but since only
766 the files which are actually debugged are read in to core, we don't
769 struct linetable_entry
775 /* The order of entries in the linetable is significant. They should
776 be sorted by increasing values of the pc field. If there is more than
777 one entry for a given pc, then I'm not sure what should happen (and
778 I not sure whether we currently handle it the best way).
780 Example: a C for statement generally looks like this
782 10 0x100 - for the init/test part of a for stmt.
785 10 0x400 - for the increment part of a for stmt.
787 If an entry has a line number of zero, it marks the start of a PC
788 range for which no line number information is available. It is
789 acceptable, though wasteful of table space, for such a range to be
796 /* Actually NITEMS elements. If you don't like this use of the
797 `struct hack', you can shove it up your ANSI (seriously, if the
798 committee tells us how to do it, we can probably go along). */
799 struct linetable_entry item
[1];
802 /* How to relocate the symbols from each section in a symbol file.
803 Each struct contains an array of offsets.
804 The ordering and meaning of the offsets is file-type-dependent;
805 typically it is indexed by section numbers or symbol types or
808 To give us flexibility in changing the internal representation
809 of these offsets, the ANOFFSET macro must be used to insert and
810 extract offset values in the struct. */
812 struct section_offsets
814 CORE_ADDR offsets
[1]; /* As many as needed. */
817 #define ANOFFSET(secoff, whichone) \
819 ? (internal_error (__FILE__, __LINE__, \
820 _("Section index is uninitialized")), -1) \
821 : secoff->offsets[whichone])
823 /* The size of a section_offsets table for N sections. */
824 #define SIZEOF_N_SECTION_OFFSETS(n) \
825 (sizeof (struct section_offsets) \
826 + sizeof (((struct section_offsets *) 0)->offsets) * ((n)-1))
828 /* Each source file or header is represented by a struct symtab.
829 These objects are chained through the `next' field. */
833 /* Unordered chain of all existing symtabs of this objfile. */
837 /* List of all symbol scope blocks for this symtab. May be shared
838 between different symtabs (and normally is for all the symtabs
839 in a given compilation unit). */
841 struct blockvector
*blockvector
;
843 /* Table mapping core addresses to line numbers for this file.
844 Can be NULL if none. Never shared between different symtabs. */
846 struct linetable
*linetable
;
848 /* Section in objfile->section_offsets for the blockvector and
849 the linetable. Probably always SECT_OFF_TEXT. */
851 int block_line_section
;
853 /* If several symtabs share a blockvector, exactly one of them
854 should be designated the primary, so that the blockvector
855 is relocated exactly once by objfile_relocate. */
857 unsigned int primary
: 1;
859 /* Symtab has been compiled with both optimizations and debug info so that
860 GDB may stop skipping prologues as variables locations are valid already
861 at function entry points. */
863 unsigned int locations_valid
: 1;
865 /* DWARF unwinder for this CU is valid even for epilogues (PC at the return
866 instruction). This is supported by GCC since 4.5.0. */
868 unsigned int epilogue_unwind_valid
: 1;
870 /* The macro table for this symtab. Like the blockvector, this
871 may be shared between different symtabs --- and normally is for
872 all the symtabs in a given compilation unit. */
873 struct macro_table
*macro_table
;
875 /* Name of this source file. This pointer is never NULL. */
879 /* Directory in which it was compiled, or NULL if we don't know. */
883 /* Total number of lines found in source file. */
887 /* line_charpos[N] is the position of the (N-1)th line of the
888 source file. "position" means something we can lseek() to; it
889 is not guaranteed to be useful any other way. */
893 /* Language of this source file. */
895 enum language language
;
897 /* String that identifies the format of the debugging information, such
898 as "stabs", "dwarf 1", "dwarf 2", "coff", etc. This is mostly useful
899 for automated testing of gdb but may also be information that is
900 useful to the user. */
902 const char *debugformat
;
904 /* String of producer version information. May be zero. */
906 const char *producer
;
908 /* Full name of file as found by searching the source path.
909 NULL if not yet known. */
913 /* Object file from which this symbol information was read. */
915 struct objfile
*objfile
;
917 /* struct call_site entries for this compilation unit or NULL. */
919 htab_t call_site_htab
;
921 /* If non-NULL, then this points to a NULL-terminated vector of
922 included symbol tables. When searching the static or global
923 block of this symbol table, the corresponding block of all
924 included symbol tables will also be searched. Note that this
925 list must be flattened -- the symbol reader is responsible for
926 ensuring that this vector contains the transitive closure of all
927 included symbol tables. */
929 struct symtab
**includes
;
931 /* If this is an included symbol table, this points to one includer
932 of the table. This user is considered the canonical symbol table
933 containing this one. An included symbol table may itself be
934 included by another. */
939 #define BLOCKVECTOR(symtab) (symtab)->blockvector
940 #define LINETABLE(symtab) (symtab)->linetable
941 #define SYMTAB_PSPACE(symtab) (symtab)->objfile->pspace
944 /* The virtual function table is now an array of structures which have the
945 form { int16 offset, delta; void *pfn; }.
947 In normal virtual function tables, OFFSET is unused.
948 DELTA is the amount which is added to the apparent object's base
949 address in order to point to the actual object to which the
950 virtual function should be applied.
951 PFN is a pointer to the virtual function.
953 Note that this macro is g++ specific (FIXME). */
955 #define VTBL_FNADDR_OFFSET 2
957 /* External variables and functions for the objects described above. */
959 /* True if we are nested inside psymtab_to_symtab. */
961 extern int currently_reading_symtab
;
963 /* symtab.c lookup functions */
965 extern const char multiple_symbols_ask
[];
966 extern const char multiple_symbols_all
[];
967 extern const char multiple_symbols_cancel
[];
969 const char *multiple_symbols_select_mode (void);
971 int symbol_matches_domain (enum language symbol_language
,
972 domain_enum symbol_domain
,
975 /* lookup a symbol table by source file name. */
977 extern struct symtab
*lookup_symtab (const char *);
979 /* An object of this type is passed as the 'is_a_field_of_this'
980 argument to lookup_symbol and lookup_symbol_in_language. */
982 struct field_of_this_result
984 /* The type in which the field was found. If this is NULL then the
985 symbol was not found in 'this'. If non-NULL, then one of the
986 other fields will be non-NULL as well. */
990 /* If the symbol was found as an ordinary field of 'this', then this
991 is non-NULL and points to the particular field. */
995 /* If the symbol was found as an function field of 'this', then this
996 is non-NULL and points to the particular field. */
998 struct fn_fieldlist
*fn_field
;
1001 /* lookup a symbol by name (optional block) in language. */
1003 extern struct symbol
*lookup_symbol_in_language (const char *,
1004 const struct block
*,
1007 struct field_of_this_result
*);
1009 /* lookup a symbol by name (optional block, optional symtab)
1010 in the current language. */
1012 extern struct symbol
*lookup_symbol (const char *, const struct block
*,
1014 struct field_of_this_result
*);
1016 /* A default version of lookup_symbol_nonlocal for use by languages
1017 that can't think of anything better to do. */
1019 extern struct symbol
*basic_lookup_symbol_nonlocal (const char *,
1020 const struct block
*,
1023 /* Some helper functions for languages that need to write their own
1024 lookup_symbol_nonlocal functions. */
1026 /* Lookup a symbol in the static block associated to BLOCK, if there
1027 is one; do nothing if BLOCK is NULL or a global block. */
1029 extern struct symbol
*lookup_symbol_static (const char *name
,
1030 const struct block
*block
,
1031 const domain_enum domain
);
1033 /* Lookup a symbol in all files' global blocks (searching psymtabs if
1036 extern struct symbol
*lookup_symbol_global (const char *name
,
1037 const struct block
*block
,
1038 const domain_enum domain
);
1040 /* Lookup a symbol within the block BLOCK. This, unlike
1041 lookup_symbol_block, will set SYMTAB and BLOCK_FOUND correctly, and
1042 will fix up the symbol if necessary. */
1044 extern struct symbol
*lookup_symbol_aux_block (const char *name
,
1045 const struct block
*block
,
1046 const domain_enum domain
);
1048 extern struct symbol
*lookup_language_this (const struct language_defn
*lang
,
1049 const struct block
*block
);
1051 /* Lookup a symbol only in the file static scope of all the objfiles. */
1053 struct symbol
*lookup_static_symbol_aux (const char *name
,
1054 const domain_enum domain
);
1057 /* lookup a symbol by name, within a specified block. */
1059 extern struct symbol
*lookup_block_symbol (const struct block
*, const char *,
1062 /* lookup a [struct, union, enum] by name, within a specified block. */
1064 extern struct type
*lookup_struct (const char *, const struct block
*);
1066 extern struct type
*lookup_union (const char *, const struct block
*);
1068 extern struct type
*lookup_enum (const char *, const struct block
*);
1070 /* from blockframe.c: */
1072 /* lookup the function symbol corresponding to the address. */
1074 extern struct symbol
*find_pc_function (CORE_ADDR
);
1076 /* lookup the function corresponding to the address and section. */
1078 extern struct symbol
*find_pc_sect_function (CORE_ADDR
, struct obj_section
*);
1080 extern int find_pc_partial_function_gnu_ifunc (CORE_ADDR pc
, const char **name
,
1083 int *is_gnu_ifunc_p
);
1085 /* lookup function from address, return name, start addr and end addr. */
1087 extern int find_pc_partial_function (CORE_ADDR
, const char **, CORE_ADDR
*,
1090 extern void clear_pc_function_cache (void);
1092 /* lookup partial symbol table by address and section. */
1094 extern struct symtab
*find_pc_sect_symtab_via_partial (CORE_ADDR
,
1095 struct obj_section
*);
1097 /* lookup full symbol table by address. */
1099 extern struct symtab
*find_pc_symtab (CORE_ADDR
);
1101 /* lookup full symbol table by address and section. */
1103 extern struct symtab
*find_pc_sect_symtab (CORE_ADDR
, struct obj_section
*);
1105 extern int find_pc_line_pc_range (CORE_ADDR
, CORE_ADDR
*, CORE_ADDR
*);
1107 extern void reread_symbols (void);
1109 extern struct type
*lookup_transparent_type (const char *);
1110 extern struct type
*basic_lookup_transparent_type (const char *);
1113 /* Macro for name of symbol to indicate a file compiled with gcc. */
1114 #ifndef GCC_COMPILED_FLAG_SYMBOL
1115 #define GCC_COMPILED_FLAG_SYMBOL "gcc_compiled."
1118 /* Macro for name of symbol to indicate a file compiled with gcc2. */
1119 #ifndef GCC2_COMPILED_FLAG_SYMBOL
1120 #define GCC2_COMPILED_FLAG_SYMBOL "gcc2_compiled."
1123 extern int in_gnu_ifunc_stub (CORE_ADDR pc
);
1125 /* Functions for resolving STT_GNU_IFUNC symbols which are implemented only
1126 for ELF symbol files. */
1128 struct gnu_ifunc_fns
1130 /* See elf_gnu_ifunc_resolve_addr for its real implementation. */
1131 CORE_ADDR (*gnu_ifunc_resolve_addr
) (struct gdbarch
*gdbarch
, CORE_ADDR pc
);
1133 /* See elf_gnu_ifunc_resolve_name for its real implementation. */
1134 int (*gnu_ifunc_resolve_name
) (const char *function_name
,
1135 CORE_ADDR
*function_address_p
);
1137 /* See elf_gnu_ifunc_resolver_stop for its real implementation. */
1138 void (*gnu_ifunc_resolver_stop
) (struct breakpoint
*b
);
1140 /* See elf_gnu_ifunc_resolver_return_stop for its real implementation. */
1141 void (*gnu_ifunc_resolver_return_stop
) (struct breakpoint
*b
);
1144 #define gnu_ifunc_resolve_addr gnu_ifunc_fns_p->gnu_ifunc_resolve_addr
1145 #define gnu_ifunc_resolve_name gnu_ifunc_fns_p->gnu_ifunc_resolve_name
1146 #define gnu_ifunc_resolver_stop gnu_ifunc_fns_p->gnu_ifunc_resolver_stop
1147 #define gnu_ifunc_resolver_return_stop \
1148 gnu_ifunc_fns_p->gnu_ifunc_resolver_return_stop
1150 extern const struct gnu_ifunc_fns
*gnu_ifunc_fns_p
;
1152 extern CORE_ADDR
find_solib_trampoline_target (struct frame_info
*, CORE_ADDR
);
1154 struct symtab_and_line
1156 /* The program space of this sal. */
1157 struct program_space
*pspace
;
1159 struct symtab
*symtab
;
1160 struct obj_section
*section
;
1161 /* Line number. Line numbers start at 1 and proceed through symtab->nlines.
1162 0 is never a valid line number; it is used to indicate that line number
1163 information is not available. */
1171 /* The probe associated with this symtab_and_line. */
1172 struct probe
*probe
;
1175 extern void init_sal (struct symtab_and_line
*sal
);
1177 struct symtabs_and_lines
1179 struct symtab_and_line
*sals
;
1184 /* Given a pc value, return line number it is in. Second arg nonzero means
1185 if pc is on the boundary use the previous statement's line number. */
1187 extern struct symtab_and_line
find_pc_line (CORE_ADDR
, int);
1189 /* Same function, but specify a section as well as an address. */
1191 extern struct symtab_and_line
find_pc_sect_line (CORE_ADDR
,
1192 struct obj_section
*, int);
1194 /* Given a symtab and line number, return the pc there. */
1196 extern int find_line_pc (struct symtab
*, int, CORE_ADDR
*);
1198 extern int find_line_pc_range (struct symtab_and_line
, CORE_ADDR
*,
1201 extern void resolve_sal_pc (struct symtab_and_line
*);
1203 /* Symbol-reading stuff in symfile.c and solib.c. */
1205 extern void clear_solib (void);
1209 extern int identify_source_line (struct symtab
*, int, int, CORE_ADDR
);
1211 /* Flags passed as 4th argument to print_source_lines. */
1213 enum print_source_lines_flags
1215 /* Do not print an error message. */
1216 PRINT_SOURCE_LINES_NOERROR
= (1 << 0),
1218 /* Print the filename in front of the source lines. */
1219 PRINT_SOURCE_LINES_FILENAME
= (1 << 1)
1222 extern void print_source_lines (struct symtab
*, int, int,
1223 enum print_source_lines_flags
);
1225 extern void forget_cached_source_info_for_objfile (struct objfile
*);
1226 extern void forget_cached_source_info (void);
1228 extern void select_source_symtab (struct symtab
*);
1230 extern VEC (char_ptr
) *default_make_symbol_completion_list_break_on
1231 (const char *text
, const char *word
, const char *break_on
,
1232 enum type_code code
);
1233 extern VEC (char_ptr
) *default_make_symbol_completion_list (const char *,
1236 extern VEC (char_ptr
) *make_symbol_completion_list (const char *, const char *);
1237 extern VEC (char_ptr
) *make_symbol_completion_type (const char *, const char *,
1239 extern VEC (char_ptr
) *make_symbol_completion_list_fn (struct cmd_list_element
*,
1243 extern VEC (char_ptr
) *make_file_symbol_completion_list (const char *,
1247 extern VEC (char_ptr
) *make_source_files_completion_list (const char *,
1252 int matching_obj_sections (struct obj_section
*, struct obj_section
*);
1254 extern const char *find_main_filename (void);
1256 extern struct symtab
*find_line_symtab (struct symtab
*, int, int *, int *);
1258 extern struct symtab_and_line
find_function_start_sal (struct symbol
*sym
,
1261 extern void skip_prologue_sal (struct symtab_and_line
*);
1265 extern void clear_symtab_users (int add_flags
);
1267 extern enum language
deduce_language_from_filename (const char *);
1271 extern int in_prologue (struct gdbarch
*gdbarch
,
1272 CORE_ADDR pc
, CORE_ADDR func_start
);
1274 extern CORE_ADDR
skip_prologue_using_sal (struct gdbarch
*gdbarch
,
1275 CORE_ADDR func_addr
);
1277 extern struct symbol
*fixup_symbol_section (struct symbol
*,
1280 /* Symbol searching */
1281 /* Note: struct symbol_search, search_symbols, et.al. are declared here,
1282 instead of making them local to symtab.c, for gdbtk's sake. */
1284 /* When using search_symbols, a list of the following structs is returned.
1285 Callers must free the search list using free_search_symbols! */
1286 struct symbol_search
1288 /* The block in which the match was found. Could be, for example,
1289 STATIC_BLOCK or GLOBAL_BLOCK. */
1292 /* Information describing what was found.
1294 If symtab abd symbol are NOT NULL, then information was found
1296 struct symtab
*symtab
;
1297 struct symbol
*symbol
;
1299 /* If msymbol is non-null, then a match was made on something for
1300 which only minimal_symbols exist. */
1301 struct minimal_symbol
*msymbol
;
1303 /* A link to the next match, or NULL for the end. */
1304 struct symbol_search
*next
;
1307 extern void search_symbols (char *, enum search_domain
, int, char **,
1308 struct symbol_search
**);
1309 extern void free_search_symbols (struct symbol_search
*);
1310 extern struct cleanup
*make_cleanup_free_search_symbols (struct symbol_search
1313 /* The name of the ``main'' function.
1314 FIXME: cagney/2001-03-20: Can't make main_name() const since some
1315 of the calling code currently assumes that the string isn't
1317 extern void set_main_name (const char *name
);
1318 extern /*const */ char *main_name (void);
1319 extern enum language language_of_main
;
1321 /* Check global symbols in objfile. */
1322 struct symbol
*lookup_global_symbol_from_objfile (const struct objfile
*,
1324 const domain_enum domain
);
1326 /* Return 1 if the supplied producer string matches the ARM RealView
1327 compiler (armcc). */
1328 int producer_is_realview (const char *producer
);
1330 void fixup_section (struct general_symbol_info
*ginfo
,
1331 CORE_ADDR addr
, struct objfile
*objfile
);
1333 struct objfile
*lookup_objfile_from_block (const struct block
*block
);
1335 extern int symtab_create_debug
;
1337 extern int basenames_may_differ
;
1339 int compare_filenames_for_search (const char *filename
,
1340 const char *search_name
);
1342 int iterate_over_some_symtabs (const char *name
,
1343 const char *real_path
,
1344 int (*callback
) (struct symtab
*symtab
,
1347 struct symtab
*first
,
1348 struct symtab
*after_last
);
1350 void iterate_over_symtabs (const char *name
,
1351 int (*callback
) (struct symtab
*symtab
,
1355 DEF_VEC_I (CORE_ADDR
);
1357 VEC (CORE_ADDR
) *find_pcs_for_symtab_line (struct symtab
*symtab
, int line
,
1358 struct linetable_entry
**best_entry
);
1360 /* Callback for LA_ITERATE_OVER_SYMBOLS. The callback will be called
1361 once per matching symbol SYM, with DATA being the argument of the
1362 same name that was passed to LA_ITERATE_OVER_SYMBOLS. The callback
1363 should return nonzero to indicate that LA_ITERATE_OVER_SYMBOLS
1364 should continue iterating, or zero to indicate that the iteration
1367 typedef int (symbol_found_callback_ftype
) (struct symbol
*sym
, void *data
);
1369 void iterate_over_symbols (const struct block
*block
, const char *name
,
1370 const domain_enum domain
,
1371 symbol_found_callback_ftype
*callback
,
1374 struct cleanup
*demangle_for_lookup (const char *name
, enum language lang
,
1375 const char **result_name
);
1377 struct symbol
*allocate_symbol (struct objfile
*);
1379 void initialize_symbol (struct symbol
*);
1381 struct template_symbol
*allocate_template_symbol (struct objfile
*);
1383 #endif /* !defined(SYMTAB_H) */