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 /* This is used by languages which wish to store a demangled name.
139 currently used by Ada, Java, and Objective C. */
142 const char *demangled_name;
146 struct cplus_specific *cplus_specific;
150 /* Record the source code language that applies to this symbol.
151 This is used to select one of the fields from the language specific
154 ENUM_BITFIELD(language) language : 8;
156 /* Which section is this symbol in? This is an index into
157 section_offsets for this objfile. Negative means that the symbol
158 does not get relocated relative to a section.
159 Disclaimer: currently this is just used for xcoff, so don't
160 expect all symbol-reading code to set it correctly (the ELF code
161 also tries to set it correctly). */
165 /* The section associated with this symbol. It can be NULL. */
167 struct obj_section *obj_section;
170 extern void symbol_set_demangled_name (struct general_symbol_info *,
174 extern const char *symbol_get_demangled_name
175 (const struct general_symbol_info *);
177 extern CORE_ADDR symbol_overlayed_address (CORE_ADDR, struct obj_section *);
179 /* Note that all the following SYMBOL_* macros are used with the
180 SYMBOL argument being either a partial symbol, a minimal symbol or
181 a full symbol. All three types have a ginfo field. In particular
182 the SYMBOL_SET_LANGUAGE, SYMBOL_DEMANGLED_NAME, etc.
183 macros cannot be entirely substituted by
184 functions, unless the callers are changed to pass in the ginfo
185 field only, instead of the SYMBOL parameter. */
187 #define SYMBOL_VALUE(symbol) (symbol)->ginfo.value.ivalue
188 #define SYMBOL_VALUE_ADDRESS(symbol) (symbol)->ginfo.value.address
189 #define SYMBOL_VALUE_BYTES(symbol) (symbol)->ginfo.value.bytes
190 #define SYMBOL_VALUE_COMMON_BLOCK(symbol) (symbol)->ginfo.value.common_block
191 #define SYMBOL_BLOCK_VALUE(symbol) (symbol)->ginfo.value.block
192 #define SYMBOL_VALUE_CHAIN(symbol) (symbol)->ginfo.value.chain
193 #define SYMBOL_LANGUAGE(symbol) (symbol)->ginfo.language
194 #define SYMBOL_SECTION(symbol) (symbol)->ginfo.section
195 #define SYMBOL_OBJ_SECTION(symbol) (symbol)->ginfo.obj_section
197 /* Initializes the language dependent portion of a symbol
198 depending upon the language for the symbol. */
199 #define SYMBOL_SET_LANGUAGE(symbol,language) \
200 (symbol_set_language (&(symbol)->ginfo, (language)))
201 extern void symbol_set_language (struct general_symbol_info *symbol,
202 enum language language);
204 /* Set just the linkage name of a symbol; do not try to demangle
205 it. Used for constructs which do not have a mangled name,
206 e.g. struct tags. Unlike SYMBOL_SET_NAMES, linkage_name must
207 be terminated and either already on the objfile's obstack or
208 permanently allocated. */
209 #define SYMBOL_SET_LINKAGE_NAME(symbol,linkage_name) \
210 (symbol)->ginfo.name = (linkage_name)
212 /* Set the linkage and natural names of a symbol, by demangling
214 #define SYMBOL_SET_NAMES(symbol,linkage_name,len,copy_name,objfile) \
215 symbol_set_names (&(symbol)->ginfo, linkage_name, len, copy_name, objfile)
216 extern void symbol_set_names (struct general_symbol_info *symbol,
217 const char *linkage_name, int len, int copy_name,
218 struct objfile *objfile);
220 /* Now come lots of name accessor macros. Short version as to when to
221 use which: Use SYMBOL_NATURAL_NAME to refer to the name of the
222 symbol in the original source code. Use SYMBOL_LINKAGE_NAME if you
223 want to know what the linker thinks the symbol's name is. Use
224 SYMBOL_PRINT_NAME for output. Use SYMBOL_DEMANGLED_NAME if you
225 specifically need to know whether SYMBOL_NATURAL_NAME and
226 SYMBOL_LINKAGE_NAME are different. */
228 /* Return SYMBOL's "natural" name, i.e. the name that it was called in
229 the original source code. In languages like C++ where symbols may
230 be mangled for ease of manipulation by the linker, this is the
233 #define SYMBOL_NATURAL_NAME(symbol) \
234 (symbol_natural_name (&(symbol)->ginfo))
235 extern const char *symbol_natural_name
236 (const struct general_symbol_info *symbol);
238 /* Return SYMBOL's name from the point of view of the linker. In
239 languages like C++ where symbols may be mangled for ease of
240 manipulation by the linker, this is the mangled name; otherwise,
241 it's the same as SYMBOL_NATURAL_NAME. */
243 #define SYMBOL_LINKAGE_NAME(symbol) (symbol)->ginfo.name
245 /* Return the demangled name for a symbol based on the language for
246 that symbol. If no demangled name exists, return NULL. */
247 #define SYMBOL_DEMANGLED_NAME(symbol) \
248 (symbol_demangled_name (&(symbol)->ginfo))
249 extern const char *symbol_demangled_name
250 (const struct general_symbol_info *symbol);
252 /* Macro that returns a version of the name of a symbol that is
253 suitable for output. In C++ this is the "demangled" form of the
254 name if demangle is on and the "mangled" form of the name if
255 demangle is off. In other languages this is just the symbol name.
256 The result should never be NULL. Don't use this for internal
257 purposes (e.g. storing in a hashtable): it's only suitable for output.
259 N.B. symbol may be anything with a ginfo member,
260 e.g., struct symbol or struct minimal_symbol. */
262 #define SYMBOL_PRINT_NAME(symbol) \
263 (demangle ? SYMBOL_NATURAL_NAME (symbol) : SYMBOL_LINKAGE_NAME (symbol))
266 /* Macro that returns the name to be used when sorting and searching symbols.
267 In C++, Chill, and Java, we search for the demangled form of a name,
268 and so sort symbols accordingly. In Ada, however, we search by mangled
269 name. If there is no distinct demangled name, then SYMBOL_SEARCH_NAME
270 returns the same value (same pointer) as SYMBOL_LINKAGE_NAME. */
271 #define SYMBOL_SEARCH_NAME(symbol) \
272 (symbol_search_name (&(symbol)->ginfo))
273 extern const char *symbol_search_name (const struct general_symbol_info *);
275 /* Return non-zero if NAME matches the "search" name of SYMBOL.
276 Whitespace and trailing parentheses are ignored.
277 See strcmp_iw for details about its behavior. */
278 #define SYMBOL_MATCHES_SEARCH_NAME(symbol, name) \
279 (strcmp_iw (SYMBOL_SEARCH_NAME (symbol), (name)) == 0)
281 /* Classification types for a minimal symbol. These should be taken as
282 "advisory only", since if gdb can't easily figure out a
283 classification it simply selects mst_unknown. It may also have to
284 guess when it can't figure out which is a better match between two
285 types (mst_data versus mst_bss) for example. Since the minimal
286 symbol info is sometimes derived from the BFD library's view of a
287 file, we need to live with what information bfd supplies. */
289 enum minimal_symbol_type
291 mst_unknown = 0, /* Unknown type, the default */
292 mst_text, /* Generally executable instructions */
293 mst_text_gnu_ifunc, /* Executable code returning address
294 of executable code */
295 mst_slot_got_plt, /* GOT entries for .plt sections */
296 mst_data, /* Generally initialized data */
297 mst_bss, /* Generally uninitialized data */
298 mst_abs, /* Generally absolute (nonrelocatable) */
299 /* GDB uses mst_solib_trampoline for the start address of a shared
300 library trampoline entry. Breakpoints for shared library functions
301 are put there if the shared library is not yet loaded.
302 After the shared library is loaded, lookup_minimal_symbol will
303 prefer the minimal symbol from the shared library (usually
304 a mst_text symbol) over the mst_solib_trampoline symbol, and the
305 breakpoints will be moved to their true address in the shared
306 library via breakpoint_re_set. */
307 mst_solib_trampoline, /* Shared library trampoline code */
308 /* For the mst_file* types, the names are only guaranteed to be unique
309 within a given .o file. */
310 mst_file_text, /* Static version of mst_text */
311 mst_file_data, /* Static version of mst_data */
312 mst_file_bss /* Static version of mst_bss */
315 /* Define a simple structure used to hold some very basic information about
316 all defined global symbols (text, data, bss, abs, etc). The only required
317 information is the general_symbol_info.
319 In many cases, even if a file was compiled with no special options for
320 debugging at all, as long as was not stripped it will contain sufficient
321 information to build a useful minimal symbol table using this structure.
322 Even when a file contains enough debugging information to build a full
323 symbol table, these minimal symbols are still useful for quickly mapping
324 between names and addresses, and vice versa. They are also sometimes
325 used to figure out what full symbol table entries need to be read in. */
327 struct minimal_symbol
330 /* The general symbol info required for all types of symbols.
332 The SYMBOL_VALUE_ADDRESS contains the address that this symbol
335 struct general_symbol_info ginfo;
337 /* Size of this symbol. end_psymtab in dbxread.c uses this
338 information to calculate the end of the partial symtab based on the
339 address of the last symbol plus the size of the last symbol. */
343 /* Which source file is this symbol in? Only relevant for mst_file_*. */
344 const char *filename;
346 /* Classification type for this minimal symbol. */
348 ENUM_BITFIELD(minimal_symbol_type) type : 8;
350 /* Non-zero if this symbol was created by gdb.
351 Such symbols do not appear in the output of "info var|fun". */
352 unsigned int created_by_gdb : 1;
354 /* Two flag bits provided for the use of the target. */
355 unsigned int target_flag_1 : 1;
356 unsigned int target_flag_2 : 1;
358 /* Nonzero iff the size of the minimal symbol has been set.
359 Symbol size information can sometimes not be determined, because
360 the object file format may not carry that piece of information. */
361 unsigned int has_size : 1;
363 /* Minimal symbols with the same hash key are kept on a linked
364 list. This is the link. */
366 struct minimal_symbol *hash_next;
368 /* Minimal symbols are stored in two different hash tables. This is
369 the `next' pointer for the demangled hash table. */
371 struct minimal_symbol *demangled_hash_next;
374 #define MSYMBOL_TARGET_FLAG_1(msymbol) (msymbol)->target_flag_1
375 #define MSYMBOL_TARGET_FLAG_2(msymbol) (msymbol)->target_flag_2
376 #define MSYMBOL_SIZE(msymbol) ((msymbol)->size + 0)
377 #define SET_MSYMBOL_SIZE(msymbol, sz) \
380 (msymbol)->size = sz; \
381 (msymbol)->has_size = 1; \
383 #define MSYMBOL_HAS_SIZE(msymbol) ((msymbol)->has_size + 0)
384 #define MSYMBOL_TYPE(msymbol) (msymbol)->type
390 /* Represent one symbol name; a variable, constant, function or typedef. */
392 /* Different name domains for symbols. Looking up a symbol specifies a
393 domain and ignores symbol definitions in other name domains. */
395 typedef enum domain_enum_tag
397 /* UNDEF_DOMAIN is used when a domain has not been discovered or
398 none of the following apply. This usually indicates an error either
399 in the symbol information or in gdb's handling of symbols. */
403 /* VAR_DOMAIN is the usual domain. In C, this contains variables,
404 function names, typedef names and enum type values. */
408 /* STRUCT_DOMAIN is used in C to hold struct, union and enum type names.
409 Thus, if `struct foo' is used in a C program, it produces a symbol named
410 `foo' in the STRUCT_DOMAIN. */
414 /* LABEL_DOMAIN may be used for names of labels (for gotos). */
418 /* Fortran common blocks. Their naming must be separate from VAR_DOMAIN.
419 They also always use LOC_COMMON_BLOCK. */
423 /* Searching domains, used for `search_symbols'. Element numbers are
424 hardcoded in GDB, check all enum uses before changing it. */
428 /* Everything in VAR_DOMAIN minus FUNCTIONS_DOMAIN and
430 VARIABLES_DOMAIN = 0,
432 /* All functions -- for some reason not methods, though. */
433 FUNCTIONS_DOMAIN = 1,
435 /* All defined types */
442 /* An address-class says where to find the value of a symbol. */
446 /* Not used; catches errors. */
450 /* Value is constant int SYMBOL_VALUE, host byteorder. */
454 /* Value is at fixed address SYMBOL_VALUE_ADDRESS. */
458 /* Value is in register. SYMBOL_VALUE is the register number
459 in the original debug format. SYMBOL_REGISTER_OPS holds a
460 function that can be called to transform this into the
461 actual register number this represents in a specific target
462 architecture (gdbarch).
464 For some symbol formats (stabs, for some compilers at least),
465 the compiler generates two symbols, an argument and a register.
466 In some cases we combine them to a single LOC_REGISTER in symbol
467 reading, but currently not for all cases (e.g. it's passed on the
468 stack and then loaded into a register). */
472 /* It's an argument; the value is at SYMBOL_VALUE offset in arglist. */
476 /* Value address is at SYMBOL_VALUE offset in arglist. */
480 /* Value is in specified register. Just like LOC_REGISTER except the
481 register holds the address of the argument instead of the argument
482 itself. This is currently used for the passing of structs and unions
483 on sparc and hppa. It is also used for call by reference where the
484 address is in a register, at least by mipsread.c. */
488 /* Value is a local variable at SYMBOL_VALUE offset in stack frame. */
492 /* Value not used; definition in SYMBOL_TYPE. Symbols in the domain
493 STRUCT_DOMAIN all have this class. */
497 /* Value is address SYMBOL_VALUE_ADDRESS in the code. */
501 /* In a symbol table, value is SYMBOL_BLOCK_VALUE of a `struct block'.
502 In a partial symbol table, SYMBOL_VALUE_ADDRESS is the start address
503 of the block. Function names have this class. */
507 /* Value is a constant byte-sequence pointed to by SYMBOL_VALUE_BYTES, in
508 target byte order. */
512 /* Value is at fixed address, but the address of the variable has
513 to be determined from the minimal symbol table whenever the
514 variable is referenced.
515 This happens if debugging information for a global symbol is
516 emitted and the corresponding minimal symbol is defined
517 in another object file or runtime common storage.
518 The linker might even remove the minimal symbol if the global
519 symbol is never referenced, in which case the symbol remains
522 GDB would normally find the symbol in the minimal symbol table if it will
523 not find it in the full symbol table. But a reference to an external
524 symbol in a local block shadowing other definition requires full symbol
525 without possibly having its address available for LOC_STATIC. Testcase
526 is provided as `gdb.dwarf2/dw2-unresolved.exp'. */
530 /* The variable does not actually exist in the program.
531 The value is ignored. */
535 /* The variable's address is computed by a set of location
536 functions (see "struct symbol_computed_ops" below). */
539 /* The variable uses general_symbol_info->value->common_block field.
540 It also always uses COMMON_BLOCK_DOMAIN. */
543 /* Not used, just notes the boundary of the enum. */
547 /* The methods needed to implement LOC_COMPUTED. These methods can
548 use the symbol's .aux_value for additional per-symbol information.
550 At present this is only used to implement location expressions. */
552 struct symbol_computed_ops
555 /* Return the value of the variable SYMBOL, relative to the stack
556 frame FRAME. If the variable has been optimized out, return
559 Iff `read_needs_frame (SYMBOL)' is zero, then FRAME may be zero. */
561 struct value *(*read_variable) (struct symbol * symbol,
562 struct frame_info * frame);
564 /* Read variable SYMBOL like read_variable at (callee) FRAME's function
565 entry. SYMBOL should be a function parameter, otherwise
566 NO_ENTRY_VALUE_ERROR will be thrown. */
567 struct value *(*read_variable_at_entry) (struct symbol *symbol,
568 struct frame_info *frame);
570 /* Return non-zero if we need a frame to find the value of the SYMBOL. */
571 int (*read_needs_frame) (struct symbol * symbol);
573 /* Write to STREAM a natural-language description of the location of
574 SYMBOL, in the context of ADDR. */
575 void (*describe_location) (struct symbol * symbol, CORE_ADDR addr,
576 struct ui_file * stream);
578 /* Non-zero if this symbol's address computation is dependent on PC. */
579 unsigned char location_has_loclist;
581 /* Tracepoint support. Append bytecodes to the tracepoint agent
582 expression AX that push the address of the object SYMBOL. Set
583 VALUE appropriately. Note --- for objects in registers, this
584 needn't emit any code; as long as it sets VALUE properly, then
585 the caller will generate the right code in the process of
586 treating this as an lvalue or rvalue. */
588 void (*tracepoint_var_ref) (struct symbol *symbol, struct gdbarch *gdbarch,
589 struct agent_expr *ax, struct axs_value *value);
592 /* The methods needed to implement LOC_BLOCK for inferior functions.
593 These methods can use the symbol's .aux_value for additional
594 per-symbol information. */
596 struct symbol_block_ops
598 /* Fill in *START and *LENGTH with DWARF block data of function
599 FRAMEFUNC valid for inferior context address PC. Set *LENGTH to
600 zero if such location is not valid for PC; *START is left
601 uninitialized in such case. */
602 void (*find_frame_base_location) (struct symbol *framefunc, CORE_ADDR pc,
603 const gdb_byte **start, size_t *length);
606 /* Functions used with LOC_REGISTER and LOC_REGPARM_ADDR. */
608 struct symbol_register_ops
610 int (*register_number) (struct symbol *symbol, struct gdbarch *gdbarch);
613 /* Objects of this type are used to find the address class and the
614 various computed ops vectors of a symbol. */
618 enum address_class aclass;
620 /* Used with LOC_COMPUTED. */
621 const struct symbol_computed_ops *ops_computed;
623 /* Used with LOC_BLOCK. */
624 const struct symbol_block_ops *ops_block;
626 /* Used with LOC_REGISTER and LOC_REGPARM_ADDR. */
627 const struct symbol_register_ops *ops_register;
630 /* The number of bits we reserve in a symbol for the aclass index.
631 This is a #define so that we can have a assertion elsewhere to
632 verify that we have reserved enough space for synthetic address
635 #define SYMBOL_ACLASS_BITS 6
637 /* This structure is space critical. See space comments at the top. */
642 /* The general symbol info required for all types of symbols. */
644 struct general_symbol_info ginfo;
646 /* Data type of value */
650 /* The symbol table containing this symbol. This is the file
651 associated with LINE. It can be NULL during symbols read-in but it is
652 never NULL during normal operation. */
653 struct symtab *symtab;
657 ENUM_BITFIELD(domain_enum_tag) domain : 6;
659 /* Address class. This holds an index into the 'symbol_impls'
660 table. The actual enum address_class value is stored there,
661 alongside any per-class ops vectors. */
663 unsigned int aclass_index : SYMBOL_ACLASS_BITS;
665 /* Whether this is an argument. */
667 unsigned is_argument : 1;
669 /* Whether this is an inlined function (class LOC_BLOCK only). */
670 unsigned is_inlined : 1;
672 /* True if this is a C++ function symbol with template arguments.
673 In this case the symbol is really a "struct template_symbol". */
674 unsigned is_cplus_template_function : 1;
676 /* Line number of this symbol's definition, except for inlined
677 functions. For an inlined function (class LOC_BLOCK and
678 SYMBOL_INLINED set) this is the line number of the function's call
679 site. Inlined function symbols are not definitions, and they are
680 never found by symbol table lookup.
682 FIXME: Should we really make the assumption that nobody will try
683 to debug files longer than 64K lines? What about machine
684 generated programs? */
688 /* An arbitrary data pointer, allowing symbol readers to record
689 additional information on a per-symbol basis. Note that this data
690 must be allocated using the same obstack as the symbol itself. */
691 /* So far it is only used by LOC_COMPUTED to
692 find the location information. For a LOC_BLOCK symbol
693 for a function in a compilation unit compiled with DWARF 2
694 information, this is information used internally by the DWARF 2
695 code --- specifically, the location expression for the frame
696 base for this function. */
697 /* FIXME drow/2003-02-21: For the LOC_BLOCK case, it might be better
698 to add a magic symbol to the block containing this information,
699 or to have a generic debug info annotation slot for symbols. */
703 struct symbol *hash_next;
706 extern const struct symbol_impl *symbol_impls;
708 #define SYMBOL_DOMAIN(symbol) (symbol)->domain
709 #define SYMBOL_IMPL(symbol) (symbol_impls[(symbol)->aclass_index])
710 #define SYMBOL_ACLASS_INDEX(symbol) (symbol)->aclass_index
711 #define SYMBOL_CLASS(symbol) (SYMBOL_IMPL (symbol).aclass)
712 #define SYMBOL_IS_ARGUMENT(symbol) (symbol)->is_argument
713 #define SYMBOL_INLINED(symbol) (symbol)->is_inlined
714 #define SYMBOL_IS_CPLUS_TEMPLATE_FUNCTION(symbol) \
715 (symbol)->is_cplus_template_function
716 #define SYMBOL_TYPE(symbol) (symbol)->type
717 #define SYMBOL_LINE(symbol) (symbol)->line
718 #define SYMBOL_SYMTAB(symbol) (symbol)->symtab
719 #define SYMBOL_COMPUTED_OPS(symbol) (SYMBOL_IMPL (symbol).ops_computed)
720 #define SYMBOL_BLOCK_OPS(symbol) (SYMBOL_IMPL (symbol).ops_block)
721 #define SYMBOL_REGISTER_OPS(symbol) (SYMBOL_IMPL (symbol).ops_register)
722 #define SYMBOL_LOCATION_BATON(symbol) (symbol)->aux_value
724 extern int register_symbol_computed_impl (enum address_class,
725 const struct symbol_computed_ops *);
727 extern int register_symbol_block_impl (enum address_class aclass,
728 const struct symbol_block_ops *ops);
730 extern int register_symbol_register_impl (enum address_class,
731 const struct symbol_register_ops *);
733 /* An instance of this type is used to represent a C++ template
734 function. It includes a "struct symbol" as a kind of base class;
735 users downcast to "struct template_symbol *" when needed. A symbol
736 is really of this type iff SYMBOL_IS_CPLUS_TEMPLATE_FUNCTION is
739 struct template_symbol
741 /* The base class. */
744 /* The number of template arguments. */
745 int n_template_arguments;
747 /* The template arguments. This is an array with
748 N_TEMPLATE_ARGUMENTS elements. */
749 struct symbol **template_arguments;
753 /* Each item represents a line-->pc (or the reverse) mapping. This is
754 somewhat more wasteful of space than one might wish, but since only
755 the files which are actually debugged are read in to core, we don't
758 struct linetable_entry
764 /* The order of entries in the linetable is significant. They should
765 be sorted by increasing values of the pc field. If there is more than
766 one entry for a given pc, then I'm not sure what should happen (and
767 I not sure whether we currently handle it the best way).
769 Example: a C for statement generally looks like this
771 10 0x100 - for the init/test part of a for stmt.
774 10 0x400 - for the increment part of a for stmt.
776 If an entry has a line number of zero, it marks the start of a PC
777 range for which no line number information is available. It is
778 acceptable, though wasteful of table space, for such a range to be
785 /* Actually NITEMS elements. If you don't like this use of the
786 `struct hack', you can shove it up your ANSI (seriously, if the
787 committee tells us how to do it, we can probably go along). */
788 struct linetable_entry item[1];
791 /* How to relocate the symbols from each section in a symbol file.
792 Each struct contains an array of offsets.
793 The ordering and meaning of the offsets is file-type-dependent;
794 typically it is indexed by section numbers or symbol types or
797 To give us flexibility in changing the internal representation
798 of these offsets, the ANOFFSET macro must be used to insert and
799 extract offset values in the struct. */
801 struct section_offsets
803 CORE_ADDR offsets[1]; /* As many as needed. */
806 #define ANOFFSET(secoff, whichone) \
808 ? (internal_error (__FILE__, __LINE__, \
809 _("Section index is uninitialized")), -1) \
810 : secoff->offsets[whichone])
812 /* The size of a section_offsets table for N sections. */
813 #define SIZEOF_N_SECTION_OFFSETS(n) \
814 (sizeof (struct section_offsets) \
815 + sizeof (((struct section_offsets *) 0)->offsets) * ((n)-1))
817 /* Each source file or header is represented by a struct symtab.
818 These objects are chained through the `next' field. */
822 /* Unordered chain of all existing symtabs of this objfile. */
826 /* List of all symbol scope blocks for this symtab. May be shared
827 between different symtabs (and normally is for all the symtabs
828 in a given compilation unit). */
830 struct blockvector *blockvector;
832 /* Table mapping core addresses to line numbers for this file.
833 Can be NULL if none. Never shared between different symtabs. */
835 struct linetable *linetable;
837 /* Section in objfile->section_offsets for the blockvector and
838 the linetable. Probably always SECT_OFF_TEXT. */
840 int block_line_section;
842 /* If several symtabs share a blockvector, exactly one of them
843 should be designated the primary, so that the blockvector
844 is relocated exactly once by objfile_relocate. */
846 unsigned int primary : 1;
848 /* Symtab has been compiled with both optimizations and debug info so that
849 GDB may stop skipping prologues as variables locations are valid already
850 at function entry points. */
852 unsigned int locations_valid : 1;
854 /* DWARF unwinder for this CU is valid even for epilogues (PC at the return
855 instruction). This is supported by GCC since 4.5.0. */
857 unsigned int epilogue_unwind_valid : 1;
859 /* The macro table for this symtab. Like the blockvector, this
860 may be shared between different symtabs --- and normally is for
861 all the symtabs in a given compilation unit. */
862 struct macro_table *macro_table;
864 /* Name of this source file. This pointer is never NULL. */
868 /* Directory in which it was compiled, or NULL if we don't know. */
872 /* Total number of lines found in source file. */
876 /* line_charpos[N] is the position of the (N-1)th line of the
877 source file. "position" means something we can lseek() to; it
878 is not guaranteed to be useful any other way. */
882 /* Language of this source file. */
884 enum language language;
886 /* String that identifies the format of the debugging information, such
887 as "stabs", "dwarf 1", "dwarf 2", "coff", etc. This is mostly useful
888 for automated testing of gdb but may also be information that is
889 useful to the user. */
891 const char *debugformat;
893 /* String of producer version information. May be zero. */
895 const char *producer;
897 /* Full name of file as found by searching the source path.
898 NULL if not yet known. */
902 /* Object file from which this symbol information was read. */
904 struct objfile *objfile;
906 /* struct call_site entries for this compilation unit or NULL. */
908 htab_t call_site_htab;
910 /* If non-NULL, then this points to a NULL-terminated vector of
911 included symbol tables. When searching the static or global
912 block of this symbol table, the corresponding block of all
913 included symbol tables will also be searched. Note that this
914 list must be flattened -- the symbol reader is responsible for
915 ensuring that this vector contains the transitive closure of all
916 included symbol tables. */
918 struct symtab **includes;
920 /* If this is an included symbol table, this points to one includer
921 of the table. This user is considered the canonical symbol table
922 containing this one. An included symbol table may itself be
923 included by another. */
928 #define BLOCKVECTOR(symtab) (symtab)->blockvector
929 #define LINETABLE(symtab) (symtab)->linetable
930 #define SYMTAB_PSPACE(symtab) (symtab)->objfile->pspace
933 /* The virtual function table is now an array of structures which have the
934 form { int16 offset, delta; void *pfn; }.
936 In normal virtual function tables, OFFSET is unused.
937 DELTA is the amount which is added to the apparent object's base
938 address in order to point to the actual object to which the
939 virtual function should be applied.
940 PFN is a pointer to the virtual function.
942 Note that this macro is g++ specific (FIXME). */
944 #define VTBL_FNADDR_OFFSET 2
946 /* External variables and functions for the objects described above. */
948 /* True if we are nested inside psymtab_to_symtab. */
950 extern int currently_reading_symtab;
952 /* symtab.c lookup functions */
954 extern const char multiple_symbols_ask[];
955 extern const char multiple_symbols_all[];
956 extern const char multiple_symbols_cancel[];
958 const char *multiple_symbols_select_mode (void);
960 int symbol_matches_domain (enum language symbol_language,
961 domain_enum symbol_domain,
964 /* lookup a symbol table by source file name. */
966 extern struct symtab *lookup_symtab (const char *);
968 /* An object of this type is passed as the 'is_a_field_of_this'
969 argument to lookup_symbol and lookup_symbol_in_language. */
971 struct field_of_this_result
973 /* The type in which the field was found. If this is NULL then the
974 symbol was not found in 'this'. If non-NULL, then one of the
975 other fields will be non-NULL as well. */
979 /* If the symbol was found as an ordinary field of 'this', then this
980 is non-NULL and points to the particular field. */
984 /* If the symbol was found as an function field of 'this', then this
985 is non-NULL and points to the particular field. */
987 struct fn_fieldlist *fn_field;
990 /* lookup a symbol by name (optional block) in language. */
992 extern struct symbol *lookup_symbol_in_language (const char *,
993 const struct block *,
996 struct field_of_this_result *);
998 /* lookup a symbol by name (optional block, optional symtab)
999 in the current language. */
1001 extern struct symbol *lookup_symbol (const char *, const struct block *,
1003 struct field_of_this_result *);
1005 /* A default version of lookup_symbol_nonlocal for use by languages
1006 that can't think of anything better to do. */
1008 extern struct symbol *basic_lookup_symbol_nonlocal (const char *,
1009 const struct block *,
1012 /* Some helper functions for languages that need to write their own
1013 lookup_symbol_nonlocal functions. */
1015 /* Lookup a symbol in the static block associated to BLOCK, if there
1016 is one; do nothing if BLOCK is NULL or a global block. */
1018 extern struct symbol *lookup_symbol_static (const char *name,
1019 const struct block *block,
1020 const domain_enum domain);
1022 /* Lookup a symbol in all files' global blocks (searching psymtabs if
1025 extern struct symbol *lookup_symbol_global (const char *name,
1026 const struct block *block,
1027 const domain_enum domain);
1029 /* Lookup a symbol within the block BLOCK. This, unlike
1030 lookup_symbol_block, will set SYMTAB and BLOCK_FOUND correctly, and
1031 will fix up the symbol if necessary. */
1033 extern struct symbol *lookup_symbol_aux_block (const char *name,
1034 const struct block *block,
1035 const domain_enum domain);
1037 extern struct symbol *lookup_language_this (const struct language_defn *lang,
1038 const struct block *block);
1040 /* Lookup a symbol only in the file static scope of all the objfiles. */
1042 struct symbol *lookup_static_symbol_aux (const char *name,
1043 const domain_enum domain);
1046 /* lookup a symbol by name, within a specified block. */
1048 extern struct symbol *lookup_block_symbol (const struct block *, const char *,
1051 /* lookup a [struct, union, enum] by name, within a specified block. */
1053 extern struct type *lookup_struct (const char *, const struct block *);
1055 extern struct type *lookup_union (const char *, const struct block *);
1057 extern struct type *lookup_enum (const char *, const struct block *);
1059 /* from blockframe.c: */
1061 /* lookup the function symbol corresponding to the address. */
1063 extern struct symbol *find_pc_function (CORE_ADDR);
1065 /* lookup the function corresponding to the address and section. */
1067 extern struct symbol *find_pc_sect_function (CORE_ADDR, struct obj_section *);
1069 extern int find_pc_partial_function_gnu_ifunc (CORE_ADDR pc, const char **name,
1072 int *is_gnu_ifunc_p);
1074 /* lookup function from address, return name, start addr and end addr. */
1076 extern int find_pc_partial_function (CORE_ADDR, const char **, CORE_ADDR *,
1079 extern void clear_pc_function_cache (void);
1081 /* lookup partial symbol table by address and section. */
1083 extern struct symtab *find_pc_sect_symtab_via_partial (CORE_ADDR,
1084 struct obj_section *);
1086 /* lookup full symbol table by address. */
1088 extern struct symtab *find_pc_symtab (CORE_ADDR);
1090 /* lookup full symbol table by address and section. */
1092 extern struct symtab *find_pc_sect_symtab (CORE_ADDR, struct obj_section *);
1094 extern int find_pc_line_pc_range (CORE_ADDR, CORE_ADDR *, CORE_ADDR *);
1096 extern void reread_symbols (void);
1098 extern struct type *lookup_transparent_type (const char *);
1099 extern struct type *basic_lookup_transparent_type (const char *);
1102 /* Macro for name of symbol to indicate a file compiled with gcc. */
1103 #ifndef GCC_COMPILED_FLAG_SYMBOL
1104 #define GCC_COMPILED_FLAG_SYMBOL "gcc_compiled."
1107 /* Macro for name of symbol to indicate a file compiled with gcc2. */
1108 #ifndef GCC2_COMPILED_FLAG_SYMBOL
1109 #define GCC2_COMPILED_FLAG_SYMBOL "gcc2_compiled."
1112 extern int in_gnu_ifunc_stub (CORE_ADDR pc);
1114 /* Functions for resolving STT_GNU_IFUNC symbols which are implemented only
1115 for ELF symbol files. */
1117 struct gnu_ifunc_fns
1119 /* See elf_gnu_ifunc_resolve_addr for its real implementation. */
1120 CORE_ADDR (*gnu_ifunc_resolve_addr) (struct gdbarch *gdbarch, CORE_ADDR pc);
1122 /* See elf_gnu_ifunc_resolve_name for its real implementation. */
1123 int (*gnu_ifunc_resolve_name) (const char *function_name,
1124 CORE_ADDR *function_address_p);
1126 /* See elf_gnu_ifunc_resolver_stop for its real implementation. */
1127 void (*gnu_ifunc_resolver_stop) (struct breakpoint *b);
1129 /* See elf_gnu_ifunc_resolver_return_stop for its real implementation. */
1130 void (*gnu_ifunc_resolver_return_stop) (struct breakpoint *b);
1133 #define gnu_ifunc_resolve_addr gnu_ifunc_fns_p->gnu_ifunc_resolve_addr
1134 #define gnu_ifunc_resolve_name gnu_ifunc_fns_p->gnu_ifunc_resolve_name
1135 #define gnu_ifunc_resolver_stop gnu_ifunc_fns_p->gnu_ifunc_resolver_stop
1136 #define gnu_ifunc_resolver_return_stop \
1137 gnu_ifunc_fns_p->gnu_ifunc_resolver_return_stop
1139 extern const struct gnu_ifunc_fns *gnu_ifunc_fns_p;
1141 extern CORE_ADDR find_solib_trampoline_target (struct frame_info *, CORE_ADDR);
1143 struct symtab_and_line
1145 /* The program space of this sal. */
1146 struct program_space *pspace;
1148 struct symtab *symtab;
1149 struct obj_section *section;
1150 /* Line number. Line numbers start at 1 and proceed through symtab->nlines.
1151 0 is never a valid line number; it is used to indicate that line number
1152 information is not available. */
1160 /* The probe associated with this symtab_and_line. */
1161 struct probe *probe;
1164 extern void init_sal (struct symtab_and_line *sal);
1166 struct symtabs_and_lines
1168 struct symtab_and_line *sals;
1173 /* Given a pc value, return line number it is in. Second arg nonzero means
1174 if pc is on the boundary use the previous statement's line number. */
1176 extern struct symtab_and_line find_pc_line (CORE_ADDR, int);
1178 /* Same function, but specify a section as well as an address. */
1180 extern struct symtab_and_line find_pc_sect_line (CORE_ADDR,
1181 struct obj_section *, int);
1183 /* Given a symtab and line number, return the pc there. */
1185 extern int find_line_pc (struct symtab *, int, CORE_ADDR *);
1187 extern int find_line_pc_range (struct symtab_and_line, CORE_ADDR *,
1190 extern void resolve_sal_pc (struct symtab_and_line *);
1192 /* Symbol-reading stuff in symfile.c and solib.c. */
1194 extern void clear_solib (void);
1198 extern int identify_source_line (struct symtab *, int, int, CORE_ADDR);
1200 /* Flags passed as 4th argument to print_source_lines. */
1202 enum print_source_lines_flags
1204 /* Do not print an error message. */
1205 PRINT_SOURCE_LINES_NOERROR = (1 << 0),
1207 /* Print the filename in front of the source lines. */
1208 PRINT_SOURCE_LINES_FILENAME = (1 << 1)
1211 extern void print_source_lines (struct symtab *, int, int,
1212 enum print_source_lines_flags);
1214 extern void forget_cached_source_info_for_objfile (struct objfile *);
1215 extern void forget_cached_source_info (void);
1217 extern void select_source_symtab (struct symtab *);
1219 extern VEC (char_ptr) *default_make_symbol_completion_list_break_on
1220 (const char *text, const char *word, const char *break_on,
1221 enum type_code code);
1222 extern VEC (char_ptr) *default_make_symbol_completion_list (const char *,
1225 extern VEC (char_ptr) *make_symbol_completion_list (const char *, const char *);
1226 extern VEC (char_ptr) *make_symbol_completion_type (const char *, const char *,
1228 extern VEC (char_ptr) *make_symbol_completion_list_fn (struct cmd_list_element *,
1232 extern VEC (char_ptr) *make_file_symbol_completion_list (const char *,
1236 extern VEC (char_ptr) *make_source_files_completion_list (const char *,
1241 int matching_obj_sections (struct obj_section *, struct obj_section *);
1243 extern const char *find_main_filename (void);
1245 extern struct symtab *find_line_symtab (struct symtab *, int, int *, int *);
1247 extern struct symtab_and_line find_function_start_sal (struct symbol *sym,
1250 extern void skip_prologue_sal (struct symtab_and_line *);
1254 extern void clear_symtab_users (int add_flags);
1256 extern enum language deduce_language_from_filename (const char *);
1260 extern int in_prologue (struct gdbarch *gdbarch,
1261 CORE_ADDR pc, CORE_ADDR func_start);
1263 extern CORE_ADDR skip_prologue_using_sal (struct gdbarch *gdbarch,
1264 CORE_ADDR func_addr);
1266 extern struct symbol *fixup_symbol_section (struct symbol *,
1269 /* Symbol searching */
1270 /* Note: struct symbol_search, search_symbols, et.al. are declared here,
1271 instead of making them local to symtab.c, for gdbtk's sake. */
1273 /* When using search_symbols, a list of the following structs is returned.
1274 Callers must free the search list using free_search_symbols! */
1275 struct symbol_search
1277 /* The block in which the match was found. Could be, for example,
1278 STATIC_BLOCK or GLOBAL_BLOCK. */
1281 /* Information describing what was found.
1283 If symtab abd symbol are NOT NULL, then information was found
1285 struct symtab *symtab;
1286 struct symbol *symbol;
1288 /* If msymbol is non-null, then a match was made on something for
1289 which only minimal_symbols exist. */
1290 struct minimal_symbol *msymbol;
1292 /* A link to the next match, or NULL for the end. */
1293 struct symbol_search *next;
1296 extern void search_symbols (char *, enum search_domain, int, char **,
1297 struct symbol_search **);
1298 extern void free_search_symbols (struct symbol_search *);
1299 extern struct cleanup *make_cleanup_free_search_symbols (struct symbol_search
1302 /* The name of the ``main'' function.
1303 FIXME: cagney/2001-03-20: Can't make main_name() const since some
1304 of the calling code currently assumes that the string isn't
1306 extern void set_main_name (const char *name);
1307 extern /*const */ char *main_name (void);
1308 extern enum language language_of_main;
1310 /* Check global symbols in objfile. */
1311 struct symbol *lookup_global_symbol_from_objfile (const struct objfile *,
1313 const domain_enum domain);
1315 /* Return 1 if the supplied producer string matches the ARM RealView
1316 compiler (armcc). */
1317 int producer_is_realview (const char *producer);
1319 void fixup_section (struct general_symbol_info *ginfo,
1320 CORE_ADDR addr, struct objfile *objfile);
1322 struct objfile *lookup_objfile_from_block (const struct block *block);
1324 extern int symtab_create_debug;
1326 extern int basenames_may_differ;
1328 int compare_filenames_for_search (const char *filename,
1329 const char *search_name);
1331 int iterate_over_some_symtabs (const char *name,
1332 const char *real_path,
1333 int (*callback) (struct symtab *symtab,
1336 struct symtab *first,
1337 struct symtab *after_last);
1339 void iterate_over_symtabs (const char *name,
1340 int (*callback) (struct symtab *symtab,
1344 DEF_VEC_I (CORE_ADDR);
1346 VEC (CORE_ADDR) *find_pcs_for_symtab_line (struct symtab *symtab, int line,
1347 struct linetable_entry **best_entry);
1349 /* Callback for LA_ITERATE_OVER_SYMBOLS. The callback will be called
1350 once per matching symbol SYM, with DATA being the argument of the
1351 same name that was passed to LA_ITERATE_OVER_SYMBOLS. The callback
1352 should return nonzero to indicate that LA_ITERATE_OVER_SYMBOLS
1353 should continue iterating, or zero to indicate that the iteration
1356 typedef int (symbol_found_callback_ftype) (struct symbol *sym, void *data);
1358 void iterate_over_symbols (const struct block *block, const char *name,
1359 const domain_enum domain,
1360 symbol_found_callback_ftype *callback,
1363 struct cleanup *demangle_for_lookup (const char *name, enum language lang,
1364 const char **result_name);
1366 #endif /* !defined(SYMTAB_H) */