1 /* Symbol table definitions for GDB.
3 Copyright (C) 1986-2014 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). */
117 const struct block *block;
119 const gdb_byte *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. */
173 extern void symbol_set_demangled_name (struct general_symbol_info *,
177 extern const char *symbol_get_demangled_name
178 (const struct general_symbol_info *);
180 extern CORE_ADDR symbol_overlayed_address (CORE_ADDR, struct obj_section *);
182 /* Note that all the following SYMBOL_* macros are used with the
183 SYMBOL argument being either a partial symbol or
184 a full symbol. Both types have a ginfo field. In particular
185 the SYMBOL_SET_LANGUAGE, SYMBOL_DEMANGLED_NAME, etc.
186 macros cannot be entirely substituted by
187 functions, unless the callers are changed to pass in the ginfo
188 field only, instead of the SYMBOL parameter. */
190 #define SYMBOL_VALUE(symbol) (symbol)->ginfo.value.ivalue
191 #define SYMBOL_VALUE_ADDRESS(symbol) (symbol)->ginfo.value.address
192 #define SYMBOL_VALUE_BYTES(symbol) (symbol)->ginfo.value.bytes
193 #define SYMBOL_VALUE_COMMON_BLOCK(symbol) (symbol)->ginfo.value.common_block
194 #define SYMBOL_BLOCK_VALUE(symbol) (symbol)->ginfo.value.block
195 #define SYMBOL_VALUE_CHAIN(symbol) (symbol)->ginfo.value.chain
196 #define SYMBOL_LANGUAGE(symbol) (symbol)->ginfo.language
197 #define SYMBOL_SECTION(symbol) (symbol)->ginfo.section
198 #define SYMBOL_OBJ_SECTION(objfile, symbol) \
199 (((symbol)->ginfo.section >= 0) \
200 ? (&(((objfile)->sections)[(symbol)->ginfo.section])) \
203 /* Initializes the language dependent portion of a symbol
204 depending upon the language for the symbol. */
205 #define SYMBOL_SET_LANGUAGE(symbol,language,obstack) \
206 (symbol_set_language (&(symbol)->ginfo, (language), (obstack)))
207 extern void symbol_set_language (struct general_symbol_info *symbol,
208 enum language language,
209 struct obstack *obstack);
211 /* Set just the linkage name of a symbol; do not try to demangle
212 it. Used for constructs which do not have a mangled name,
213 e.g. struct tags. Unlike SYMBOL_SET_NAMES, linkage_name must
214 be terminated and either already on the objfile's obstack or
215 permanently allocated. */
216 #define SYMBOL_SET_LINKAGE_NAME(symbol,linkage_name) \
217 (symbol)->ginfo.name = (linkage_name)
219 /* Set the linkage and natural names of a symbol, by demangling
221 #define SYMBOL_SET_NAMES(symbol,linkage_name,len,copy_name,objfile) \
222 symbol_set_names (&(symbol)->ginfo, linkage_name, len, copy_name, objfile)
223 extern void symbol_set_names (struct general_symbol_info *symbol,
224 const char *linkage_name, int len, int copy_name,
225 struct objfile *objfile);
227 /* Now come lots of name accessor macros. Short version as to when to
228 use which: Use SYMBOL_NATURAL_NAME to refer to the name of the
229 symbol in the original source code. Use SYMBOL_LINKAGE_NAME if you
230 want to know what the linker thinks the symbol's name is. Use
231 SYMBOL_PRINT_NAME for output. Use SYMBOL_DEMANGLED_NAME if you
232 specifically need to know whether SYMBOL_NATURAL_NAME and
233 SYMBOL_LINKAGE_NAME are different. */
235 /* Return SYMBOL's "natural" name, i.e. the name that it was called in
236 the original source code. In languages like C++ where symbols may
237 be mangled for ease of manipulation by the linker, this is the
240 #define SYMBOL_NATURAL_NAME(symbol) \
241 (symbol_natural_name (&(symbol)->ginfo))
242 extern const char *symbol_natural_name
243 (const struct general_symbol_info *symbol);
245 /* Return SYMBOL's name from the point of view of the linker. In
246 languages like C++ where symbols may be mangled for ease of
247 manipulation by the linker, this is the mangled name; otherwise,
248 it's the same as SYMBOL_NATURAL_NAME. */
250 #define SYMBOL_LINKAGE_NAME(symbol) (symbol)->ginfo.name
252 /* Return the demangled name for a symbol based on the language for
253 that symbol. If no demangled name exists, return NULL. */
254 #define SYMBOL_DEMANGLED_NAME(symbol) \
255 (symbol_demangled_name (&(symbol)->ginfo))
256 extern const char *symbol_demangled_name
257 (const struct general_symbol_info *symbol);
259 /* Macro that returns a version of the name of a symbol that is
260 suitable for output. In C++ this is the "demangled" form of the
261 name if demangle is on and the "mangled" form of the name if
262 demangle is off. In other languages this is just the symbol name.
263 The result should never be NULL. Don't use this for internal
264 purposes (e.g. storing in a hashtable): it's only suitable for output.
266 N.B. symbol may be anything with a ginfo member,
267 e.g., struct symbol or struct minimal_symbol. */
269 #define SYMBOL_PRINT_NAME(symbol) \
270 (demangle ? SYMBOL_NATURAL_NAME (symbol) : SYMBOL_LINKAGE_NAME (symbol))
273 /* Macro that returns the name to be used when sorting and searching symbols.
274 In C++, Chill, and Java, we search for the demangled form of a name,
275 and so sort symbols accordingly. In Ada, however, we search by mangled
276 name. If there is no distinct demangled name, then SYMBOL_SEARCH_NAME
277 returns the same value (same pointer) as SYMBOL_LINKAGE_NAME. */
278 #define SYMBOL_SEARCH_NAME(symbol) \
279 (symbol_search_name (&(symbol)->ginfo))
280 extern const char *symbol_search_name (const struct general_symbol_info *);
282 /* Return non-zero if NAME matches the "search" name of SYMBOL.
283 Whitespace and trailing parentheses are ignored.
284 See strcmp_iw for details about its behavior. */
285 #define SYMBOL_MATCHES_SEARCH_NAME(symbol, name) \
286 (strcmp_iw (SYMBOL_SEARCH_NAME (symbol), (name)) == 0)
288 /* Classification types for a minimal symbol. These should be taken as
289 "advisory only", since if gdb can't easily figure out a
290 classification it simply selects mst_unknown. It may also have to
291 guess when it can't figure out which is a better match between two
292 types (mst_data versus mst_bss) for example. Since the minimal
293 symbol info is sometimes derived from the BFD library's view of a
294 file, we need to live with what information bfd supplies. */
296 enum minimal_symbol_type
298 mst_unknown = 0, /* Unknown type, the default */
299 mst_text, /* Generally executable instructions */
300 mst_text_gnu_ifunc, /* Executable code returning address
301 of executable code */
302 mst_slot_got_plt, /* GOT entries for .plt sections */
303 mst_data, /* Generally initialized data */
304 mst_bss, /* Generally uninitialized data */
305 mst_abs, /* Generally absolute (nonrelocatable) */
306 /* GDB uses mst_solib_trampoline for the start address of a shared
307 library trampoline entry. Breakpoints for shared library functions
308 are put there if the shared library is not yet loaded.
309 After the shared library is loaded, lookup_minimal_symbol will
310 prefer the minimal symbol from the shared library (usually
311 a mst_text symbol) over the mst_solib_trampoline symbol, and the
312 breakpoints will be moved to their true address in the shared
313 library via breakpoint_re_set. */
314 mst_solib_trampoline, /* Shared library trampoline code */
315 /* For the mst_file* types, the names are only guaranteed to be unique
316 within a given .o file. */
317 mst_file_text, /* Static version of mst_text */
318 mst_file_data, /* Static version of mst_data */
319 mst_file_bss /* Static version of mst_bss */
322 /* Define a simple structure used to hold some very basic information about
323 all defined global symbols (text, data, bss, abs, etc). The only required
324 information is the general_symbol_info.
326 In many cases, even if a file was compiled with no special options for
327 debugging at all, as long as was not stripped it will contain sufficient
328 information to build a useful minimal symbol table using this structure.
329 Even when a file contains enough debugging information to build a full
330 symbol table, these minimal symbols are still useful for quickly mapping
331 between names and addresses, and vice versa. They are also sometimes
332 used to figure out what full symbol table entries need to be read in. */
334 struct minimal_symbol
337 /* The general symbol info required for all types of symbols.
339 The SYMBOL_VALUE_ADDRESS contains the address that this symbol
342 struct general_symbol_info mginfo;
344 /* Size of this symbol. end_psymtab in dbxread.c uses this
345 information to calculate the end of the partial symtab based on the
346 address of the last symbol plus the size of the last symbol. */
350 /* Which source file is this symbol in? Only relevant for mst_file_*. */
351 const char *filename;
353 /* Classification type for this minimal symbol. */
355 ENUM_BITFIELD(minimal_symbol_type) type : 8;
357 /* Non-zero if this symbol was created by gdb.
358 Such symbols do not appear in the output of "info var|fun". */
359 unsigned int created_by_gdb : 1;
361 /* Two flag bits provided for the use of the target. */
362 unsigned int target_flag_1 : 1;
363 unsigned int target_flag_2 : 1;
365 /* Nonzero iff the size of the minimal symbol has been set.
366 Symbol size information can sometimes not be determined, because
367 the object file format may not carry that piece of information. */
368 unsigned int has_size : 1;
370 /* Minimal symbols with the same hash key are kept on a linked
371 list. This is the link. */
373 struct minimal_symbol *hash_next;
375 /* Minimal symbols are stored in two different hash tables. This is
376 the `next' pointer for the demangled hash table. */
378 struct minimal_symbol *demangled_hash_next;
381 #define MSYMBOL_TARGET_FLAG_1(msymbol) (msymbol)->target_flag_1
382 #define MSYMBOL_TARGET_FLAG_2(msymbol) (msymbol)->target_flag_2
383 #define MSYMBOL_SIZE(msymbol) ((msymbol)->size + 0)
384 #define SET_MSYMBOL_SIZE(msymbol, sz) \
387 (msymbol)->size = sz; \
388 (msymbol)->has_size = 1; \
390 #define MSYMBOL_HAS_SIZE(msymbol) ((msymbol)->has_size + 0)
391 #define MSYMBOL_TYPE(msymbol) (msymbol)->type
393 #define MSYMBOL_VALUE(symbol) (symbol)->mginfo.value.ivalue
394 /* The unrelocated address of the minimal symbol. */
395 #define MSYMBOL_VALUE_RAW_ADDRESS(symbol) ((symbol)->mginfo.value.address + 0)
396 /* The relocated address of the minimal symbol, using the section
397 offsets from OBJFILE. */
398 #define MSYMBOL_VALUE_ADDRESS(objfile, symbol) \
399 ((symbol)->mginfo.value.address \
400 + ANOFFSET ((objfile)->section_offsets, ((symbol)->mginfo.section)))
401 /* For a bound minsym, we can easily compute the address directly. */
402 #define BMSYMBOL_VALUE_ADDRESS(symbol) \
403 MSYMBOL_VALUE_ADDRESS ((symbol).objfile, (symbol).minsym)
404 #define SET_MSYMBOL_VALUE_ADDRESS(symbol, new_value) \
405 ((symbol)->mginfo.value.address = (new_value))
406 #define MSYMBOL_VALUE_BYTES(symbol) (symbol)->mginfo.value.bytes
407 #define MSYMBOL_BLOCK_VALUE(symbol) (symbol)->mginfo.value.block
408 #define MSYMBOL_VALUE_CHAIN(symbol) (symbol)->mginfo.value.chain
409 #define MSYMBOL_LANGUAGE(symbol) (symbol)->mginfo.language
410 #define MSYMBOL_SECTION(symbol) (symbol)->mginfo.section
411 #define MSYMBOL_OBJ_SECTION(objfile, symbol) \
412 (((symbol)->mginfo.section >= 0) \
413 ? (&(((objfile)->sections)[(symbol)->mginfo.section])) \
416 #define MSYMBOL_NATURAL_NAME(symbol) \
417 (symbol_natural_name (&(symbol)->mginfo))
418 #define MSYMBOL_LINKAGE_NAME(symbol) (symbol)->mginfo.name
419 #define MSYMBOL_PRINT_NAME(symbol) \
420 (demangle ? MSYMBOL_NATURAL_NAME (symbol) : MSYMBOL_LINKAGE_NAME (symbol))
421 #define MSYMBOL_DEMANGLED_NAME(symbol) \
422 (symbol_demangled_name (&(symbol)->mginfo))
423 #define MSYMBOL_SET_LANGUAGE(symbol,language,obstack) \
424 (symbol_set_language (&(symbol)->mginfo, (language), (obstack)))
425 #define MSYMBOL_SEARCH_NAME(symbol) \
426 (symbol_search_name (&(symbol)->mginfo))
427 #define MSYMBOL_MATCHES_SEARCH_NAME(symbol, name) \
428 (strcmp_iw (MSYMBOL_SEARCH_NAME (symbol), (name)) == 0)
429 #define MSYMBOL_SET_NAMES(symbol,linkage_name,len,copy_name,objfile) \
430 symbol_set_names (&(symbol)->mginfo, linkage_name, len, copy_name, objfile)
436 /* Represent one symbol name; a variable, constant, function or typedef. */
438 /* Different name domains for symbols. Looking up a symbol specifies a
439 domain and ignores symbol definitions in other name domains. */
441 typedef enum domain_enum_tag
443 /* UNDEF_DOMAIN is used when a domain has not been discovered or
444 none of the following apply. This usually indicates an error either
445 in the symbol information or in gdb's handling of symbols. */
449 /* VAR_DOMAIN is the usual domain. In C, this contains variables,
450 function names, typedef names and enum type values. */
454 /* STRUCT_DOMAIN is used in C to hold struct, union and enum type names.
455 Thus, if `struct foo' is used in a C program, it produces a symbol named
456 `foo' in the STRUCT_DOMAIN. */
460 /* MODULE_DOMAIN is used in Fortran to hold module type names. */
464 /* LABEL_DOMAIN may be used for names of labels (for gotos). */
468 /* Fortran common blocks. Their naming must be separate from VAR_DOMAIN.
469 They also always use LOC_COMMON_BLOCK. */
473 extern const char *domain_name (domain_enum);
475 /* Searching domains, used for `search_symbols'. Element numbers are
476 hardcoded in GDB, check all enum uses before changing it. */
480 /* Everything in VAR_DOMAIN minus FUNCTIONS_DOMAIN and
482 VARIABLES_DOMAIN = 0,
484 /* All functions -- for some reason not methods, though. */
485 FUNCTIONS_DOMAIN = 1,
487 /* All defined types */
494 extern const char *search_domain_name (enum search_domain);
496 /* An address-class says where to find the value of a symbol. */
500 /* Not used; catches errors. */
504 /* Value is constant int SYMBOL_VALUE, host byteorder. */
508 /* Value is at fixed address SYMBOL_VALUE_ADDRESS. */
512 /* Value is in register. SYMBOL_VALUE is the register number
513 in the original debug format. SYMBOL_REGISTER_OPS holds a
514 function that can be called to transform this into the
515 actual register number this represents in a specific target
516 architecture (gdbarch).
518 For some symbol formats (stabs, for some compilers at least),
519 the compiler generates two symbols, an argument and a register.
520 In some cases we combine them to a single LOC_REGISTER in symbol
521 reading, but currently not for all cases (e.g. it's passed on the
522 stack and then loaded into a register). */
526 /* It's an argument; the value is at SYMBOL_VALUE offset in arglist. */
530 /* Value address is at SYMBOL_VALUE offset in arglist. */
534 /* Value is in specified register. Just like LOC_REGISTER except the
535 register holds the address of the argument instead of the argument
536 itself. This is currently used for the passing of structs and unions
537 on sparc and hppa. It is also used for call by reference where the
538 address is in a register, at least by mipsread.c. */
542 /* Value is a local variable at SYMBOL_VALUE offset in stack frame. */
546 /* Value not used; definition in SYMBOL_TYPE. Symbols in the domain
547 STRUCT_DOMAIN all have this class. */
551 /* Value is address SYMBOL_VALUE_ADDRESS in the code. */
555 /* In a symbol table, value is SYMBOL_BLOCK_VALUE of a `struct block'.
556 In a partial symbol table, SYMBOL_VALUE_ADDRESS is the start address
557 of the block. Function names have this class. */
561 /* Value is a constant byte-sequence pointed to by SYMBOL_VALUE_BYTES, in
562 target byte order. */
566 /* Value is at fixed address, but the address of the variable has
567 to be determined from the minimal symbol table whenever the
568 variable is referenced.
569 This happens if debugging information for a global symbol is
570 emitted and the corresponding minimal symbol is defined
571 in another object file or runtime common storage.
572 The linker might even remove the minimal symbol if the global
573 symbol is never referenced, in which case the symbol remains
576 GDB would normally find the symbol in the minimal symbol table if it will
577 not find it in the full symbol table. But a reference to an external
578 symbol in a local block shadowing other definition requires full symbol
579 without possibly having its address available for LOC_STATIC. Testcase
580 is provided as `gdb.dwarf2/dw2-unresolved.exp'. */
584 /* The variable does not actually exist in the program.
585 The value is ignored. */
589 /* The variable's address is computed by a set of location
590 functions (see "struct symbol_computed_ops" below). */
593 /* The variable uses general_symbol_info->value->common_block field.
594 It also always uses COMMON_BLOCK_DOMAIN. */
597 /* Not used, just notes the boundary of the enum. */
601 /* The methods needed to implement LOC_COMPUTED. These methods can
602 use the symbol's .aux_value for additional per-symbol information.
604 At present this is only used to implement location expressions. */
606 struct symbol_computed_ops
609 /* Return the value of the variable SYMBOL, relative to the stack
610 frame FRAME. If the variable has been optimized out, return
613 Iff `read_needs_frame (SYMBOL)' is zero, then FRAME may be zero. */
615 struct value *(*read_variable) (struct symbol * symbol,
616 struct frame_info * frame);
618 /* Read variable SYMBOL like read_variable at (callee) FRAME's function
619 entry. SYMBOL should be a function parameter, otherwise
620 NO_ENTRY_VALUE_ERROR will be thrown. */
621 struct value *(*read_variable_at_entry) (struct symbol *symbol,
622 struct frame_info *frame);
624 /* Return non-zero if we need a frame to find the value of the SYMBOL. */
625 int (*read_needs_frame) (struct symbol * symbol);
627 /* Write to STREAM a natural-language description of the location of
628 SYMBOL, in the context of ADDR. */
629 void (*describe_location) (struct symbol * symbol, CORE_ADDR addr,
630 struct ui_file * stream);
632 /* Non-zero if this symbol's address computation is dependent on PC. */
633 unsigned char location_has_loclist;
635 /* Tracepoint support. Append bytecodes to the tracepoint agent
636 expression AX that push the address of the object SYMBOL. Set
637 VALUE appropriately. Note --- for objects in registers, this
638 needn't emit any code; as long as it sets VALUE properly, then
639 the caller will generate the right code in the process of
640 treating this as an lvalue or rvalue. */
642 void (*tracepoint_var_ref) (struct symbol *symbol, struct gdbarch *gdbarch,
643 struct agent_expr *ax, struct axs_value *value);
646 /* The methods needed to implement LOC_BLOCK for inferior functions.
647 These methods can use the symbol's .aux_value for additional
648 per-symbol information. */
650 struct symbol_block_ops
652 /* Fill in *START and *LENGTH with DWARF block data of function
653 FRAMEFUNC valid for inferior context address PC. Set *LENGTH to
654 zero if such location is not valid for PC; *START is left
655 uninitialized in such case. */
656 void (*find_frame_base_location) (struct symbol *framefunc, CORE_ADDR pc,
657 const gdb_byte **start, size_t *length);
660 /* Functions used with LOC_REGISTER and LOC_REGPARM_ADDR. */
662 struct symbol_register_ops
664 int (*register_number) (struct symbol *symbol, struct gdbarch *gdbarch);
667 /* Objects of this type are used to find the address class and the
668 various computed ops vectors of a symbol. */
672 enum address_class aclass;
674 /* Used with LOC_COMPUTED. */
675 const struct symbol_computed_ops *ops_computed;
677 /* Used with LOC_BLOCK. */
678 const struct symbol_block_ops *ops_block;
680 /* Used with LOC_REGISTER and LOC_REGPARM_ADDR. */
681 const struct symbol_register_ops *ops_register;
684 /* The number of bits we reserve in a symbol for the aclass index.
685 This is a #define so that we can have a assertion elsewhere to
686 verify that we have reserved enough space for synthetic address
689 #define SYMBOL_ACLASS_BITS 6
691 /* This structure is space critical. See space comments at the top. */
696 /* The general symbol info required for all types of symbols. */
698 struct general_symbol_info ginfo;
700 /* Data type of value */
704 /* The symbol table containing this symbol. This is the file
705 associated with LINE. It can be NULL during symbols read-in but it is
706 never NULL during normal operation. */
707 struct symtab *symtab;
711 ENUM_BITFIELD(domain_enum_tag) domain : 6;
713 /* Address class. This holds an index into the 'symbol_impls'
714 table. The actual enum address_class value is stored there,
715 alongside any per-class ops vectors. */
717 unsigned int aclass_index : SYMBOL_ACLASS_BITS;
719 /* Whether this is an argument. */
721 unsigned is_argument : 1;
723 /* Whether this is an inlined function (class LOC_BLOCK only). */
724 unsigned is_inlined : 1;
726 /* True if this is a C++ function symbol with template arguments.
727 In this case the symbol is really a "struct template_symbol". */
728 unsigned is_cplus_template_function : 1;
730 /* Line number of this symbol's definition, except for inlined
731 functions. For an inlined function (class LOC_BLOCK and
732 SYMBOL_INLINED set) this is the line number of the function's call
733 site. Inlined function symbols are not definitions, and they are
734 never found by symbol table lookup.
736 FIXME: Should we really make the assumption that nobody will try
737 to debug files longer than 64K lines? What about machine
738 generated programs? */
742 /* An arbitrary data pointer, allowing symbol readers to record
743 additional information on a per-symbol basis. Note that this data
744 must be allocated using the same obstack as the symbol itself. */
745 /* So far it is only used by LOC_COMPUTED to
746 find the location information. For a LOC_BLOCK symbol
747 for a function in a compilation unit compiled with DWARF 2
748 information, this is information used internally by the DWARF 2
749 code --- specifically, the location expression for the frame
750 base for this function. */
751 /* FIXME drow/2003-02-21: For the LOC_BLOCK case, it might be better
752 to add a magic symbol to the block containing this information,
753 or to have a generic debug info annotation slot for symbols. */
757 struct symbol *hash_next;
760 extern const struct symbol_impl *symbol_impls;
762 #define SYMBOL_DOMAIN(symbol) (symbol)->domain
763 #define SYMBOL_IMPL(symbol) (symbol_impls[(symbol)->aclass_index])
764 #define SYMBOL_ACLASS_INDEX(symbol) (symbol)->aclass_index
765 #define SYMBOL_CLASS(symbol) (SYMBOL_IMPL (symbol).aclass)
766 #define SYMBOL_IS_ARGUMENT(symbol) (symbol)->is_argument
767 #define SYMBOL_INLINED(symbol) (symbol)->is_inlined
768 #define SYMBOL_IS_CPLUS_TEMPLATE_FUNCTION(symbol) \
769 (symbol)->is_cplus_template_function
770 #define SYMBOL_TYPE(symbol) (symbol)->type
771 #define SYMBOL_LINE(symbol) (symbol)->line
772 #define SYMBOL_SYMTAB(symbol) (symbol)->symtab
773 #define SYMBOL_COMPUTED_OPS(symbol) (SYMBOL_IMPL (symbol).ops_computed)
774 #define SYMBOL_BLOCK_OPS(symbol) (SYMBOL_IMPL (symbol).ops_block)
775 #define SYMBOL_REGISTER_OPS(symbol) (SYMBOL_IMPL (symbol).ops_register)
776 #define SYMBOL_LOCATION_BATON(symbol) (symbol)->aux_value
777 #define SYMBOL_OBJFILE(symbol) (SYMBOL_SYMTAB (symbol)->objfile)
779 extern int register_symbol_computed_impl (enum address_class,
780 const struct symbol_computed_ops *);
782 extern int register_symbol_block_impl (enum address_class aclass,
783 const struct symbol_block_ops *ops);
785 extern int register_symbol_register_impl (enum address_class,
786 const struct symbol_register_ops *);
788 /* An instance of this type is used to represent a C++ template
789 function. It includes a "struct symbol" as a kind of base class;
790 users downcast to "struct template_symbol *" when needed. A symbol
791 is really of this type iff SYMBOL_IS_CPLUS_TEMPLATE_FUNCTION is
794 struct template_symbol
796 /* The base class. */
799 /* The number of template arguments. */
800 int n_template_arguments;
802 /* The template arguments. This is an array with
803 N_TEMPLATE_ARGUMENTS elements. */
804 struct symbol **template_arguments;
808 /* Each item represents a line-->pc (or the reverse) mapping. This is
809 somewhat more wasteful of space than one might wish, but since only
810 the files which are actually debugged are read in to core, we don't
813 struct linetable_entry
819 /* The order of entries in the linetable is significant. They should
820 be sorted by increasing values of the pc field. If there is more than
821 one entry for a given pc, then I'm not sure what should happen (and
822 I not sure whether we currently handle it the best way).
824 Example: a C for statement generally looks like this
826 10 0x100 - for the init/test part of a for stmt.
829 10 0x400 - for the increment part of a for stmt.
831 If an entry has a line number of zero, it marks the start of a PC
832 range for which no line number information is available. It is
833 acceptable, though wasteful of table space, for such a range to be
840 /* Actually NITEMS elements. If you don't like this use of the
841 `struct hack', you can shove it up your ANSI (seriously, if the
842 committee tells us how to do it, we can probably go along). */
843 struct linetable_entry item[1];
846 /* How to relocate the symbols from each section in a symbol file.
847 Each struct contains an array of offsets.
848 The ordering and meaning of the offsets is file-type-dependent;
849 typically it is indexed by section numbers or symbol types or
852 To give us flexibility in changing the internal representation
853 of these offsets, the ANOFFSET macro must be used to insert and
854 extract offset values in the struct. */
856 struct section_offsets
858 CORE_ADDR offsets[1]; /* As many as needed. */
861 #define ANOFFSET(secoff, whichone) \
863 ? (internal_error (__FILE__, __LINE__, \
864 _("Section index is uninitialized")), -1) \
865 : secoff->offsets[whichone])
867 /* The size of a section_offsets table for N sections. */
868 #define SIZEOF_N_SECTION_OFFSETS(n) \
869 (sizeof (struct section_offsets) \
870 + sizeof (((struct section_offsets *) 0)->offsets) * ((n)-1))
872 /* Each source file or header is represented by a struct symtab.
873 These objects are chained through the `next' field. */
877 /* Unordered chain of all existing symtabs of this objfile. */
881 /* List of all symbol scope blocks for this symtab. May be shared
882 between different symtabs (and normally is for all the symtabs
883 in a given compilation unit). */
885 struct blockvector *blockvector;
887 /* Table mapping core addresses to line numbers for this file.
888 Can be NULL if none. Never shared between different symtabs. */
890 struct linetable *linetable;
892 /* Section in objfile->section_offsets for the blockvector and
893 the linetable. Probably always SECT_OFF_TEXT. */
895 int block_line_section;
897 /* If several symtabs share a blockvector, exactly one of them
898 should be designated the primary, so that the blockvector
899 is relocated exactly once by objfile_relocate. */
901 unsigned int primary : 1;
903 /* Symtab has been compiled with both optimizations and debug info so that
904 GDB may stop skipping prologues as variables locations are valid already
905 at function entry points. */
907 unsigned int locations_valid : 1;
909 /* DWARF unwinder for this CU is valid even for epilogues (PC at the return
910 instruction). This is supported by GCC since 4.5.0. */
912 unsigned int epilogue_unwind_valid : 1;
914 /* The macro table for this symtab. Like the blockvector, this
915 may be shared between different symtabs --- and normally is for
916 all the symtabs in a given compilation unit. */
917 struct macro_table *macro_table;
919 /* Name of this source file. This pointer is never NULL. */
921 const char *filename;
923 /* Directory in which it was compiled, or NULL if we don't know. */
927 /* Total number of lines found in source file. */
931 /* line_charpos[N] is the position of the (N-1)th line of the
932 source file. "position" means something we can lseek() to; it
933 is not guaranteed to be useful any other way. */
937 /* Language of this source file. */
939 enum language language;
941 /* String that identifies the format of the debugging information, such
942 as "stabs", "dwarf 1", "dwarf 2", "coff", etc. This is mostly useful
943 for automated testing of gdb but may also be information that is
944 useful to the user. */
946 const char *debugformat;
948 /* String of producer version information. May be zero. */
950 const char *producer;
952 /* Full name of file as found by searching the source path.
953 NULL if not yet known. */
957 /* Object file from which this symbol information was read. */
959 struct objfile *objfile;
961 /* struct call_site entries for this compilation unit or NULL. */
963 htab_t call_site_htab;
965 /* If non-NULL, then this points to a NULL-terminated vector of
966 included symbol tables. When searching the static or global
967 block of this symbol table, the corresponding block of all
968 included symbol tables will also be searched. Note that this
969 list must be flattened -- the symbol reader is responsible for
970 ensuring that this vector contains the transitive closure of all
971 included symbol tables. */
973 struct symtab **includes;
975 /* If this is an included symbol table, this points to one includer
976 of the table. This user is considered the canonical symbol table
977 containing this one. An included symbol table may itself be
978 included by another. */
983 #define BLOCKVECTOR(symtab) (symtab)->blockvector
984 #define LINETABLE(symtab) (symtab)->linetable
985 #define SYMTAB_PSPACE(symtab) (symtab)->objfile->pspace
987 /* Call this to set the "primary" field in struct symtab. */
988 extern void set_symtab_primary (struct symtab *, int primary);
990 typedef struct symtab *symtab_ptr;
991 DEF_VEC_P (symtab_ptr);
995 /* The virtual function table is now an array of structures which have the
996 form { int16 offset, delta; void *pfn; }.
998 In normal virtual function tables, OFFSET is unused.
999 DELTA is the amount which is added to the apparent object's base
1000 address in order to point to the actual object to which the
1001 virtual function should be applied.
1002 PFN is a pointer to the virtual function.
1004 Note that this macro is g++ specific (FIXME). */
1006 #define VTBL_FNADDR_OFFSET 2
1008 /* External variables and functions for the objects described above. */
1010 /* True if we are nested inside psymtab_to_symtab. */
1012 extern int currently_reading_symtab;
1014 /* symtab.c lookup functions */
1016 extern const char multiple_symbols_ask[];
1017 extern const char multiple_symbols_all[];
1018 extern const char multiple_symbols_cancel[];
1020 const char *multiple_symbols_select_mode (void);
1022 int symbol_matches_domain (enum language symbol_language,
1023 domain_enum symbol_domain,
1024 domain_enum domain);
1026 /* lookup a symbol table by source file name. */
1028 extern struct symtab *lookup_symtab (const char *);
1030 /* An object of this type is passed as the 'is_a_field_of_this'
1031 argument to lookup_symbol and lookup_symbol_in_language. */
1033 struct field_of_this_result
1035 /* The type in which the field was found. If this is NULL then the
1036 symbol was not found in 'this'. If non-NULL, then one of the
1037 other fields will be non-NULL as well. */
1041 /* If the symbol was found as an ordinary field of 'this', then this
1042 is non-NULL and points to the particular field. */
1044 struct field *field;
1046 /* If the symbol was found as an function field of 'this', then this
1047 is non-NULL and points to the particular field. */
1049 struct fn_fieldlist *fn_field;
1052 /* lookup a symbol by name (optional block) in language. */
1054 extern struct symbol *lookup_symbol_in_language (const char *,
1055 const struct block *,
1058 struct field_of_this_result *);
1060 /* lookup a symbol by name (optional block, optional symtab)
1061 in the current language. */
1063 extern struct symbol *lookup_symbol (const char *, const struct block *,
1065 struct field_of_this_result *);
1067 /* A default version of lookup_symbol_nonlocal for use by languages
1068 that can't think of anything better to do. */
1070 extern struct symbol *basic_lookup_symbol_nonlocal (const char *,
1071 const struct block *,
1074 /* Some helper functions for languages that need to write their own
1075 lookup_symbol_nonlocal functions. */
1077 /* Lookup a symbol in the static block associated to BLOCK, if there
1078 is one; do nothing if BLOCK is NULL or a global block. */
1080 extern struct symbol *lookup_symbol_static (const char *name,
1081 const struct block *block,
1082 const domain_enum domain);
1084 /* Lookup a symbol in all files' global blocks (searching psymtabs if
1087 extern struct symbol *lookup_symbol_global (const char *name,
1088 const struct block *block,
1089 const domain_enum domain);
1091 /* Lookup a symbol within the block BLOCK. This, unlike
1092 lookup_symbol_block, will set SYMTAB and BLOCK_FOUND correctly, and
1093 will fix up the symbol if necessary. */
1095 extern struct symbol *lookup_symbol_aux_block (const char *name,
1096 const struct block *block,
1097 const domain_enum domain);
1099 extern struct symbol *lookup_language_this (const struct language_defn *lang,
1100 const struct block *block);
1102 /* Lookup a symbol only in the file static scope of all the objfiles. */
1104 struct symbol *lookup_static_symbol_aux (const char *name,
1105 const domain_enum domain);
1108 /* lookup a symbol by name, within a specified block. */
1110 extern struct symbol *lookup_block_symbol (const struct block *, const char *,
1113 /* lookup a [struct, union, enum] by name, within a specified block. */
1115 extern struct type *lookup_struct (const char *, const struct block *);
1117 extern struct type *lookup_union (const char *, const struct block *);
1119 extern struct type *lookup_enum (const char *, const struct block *);
1121 /* from blockframe.c: */
1123 /* lookup the function symbol corresponding to the address. */
1125 extern struct symbol *find_pc_function (CORE_ADDR);
1127 /* lookup the function corresponding to the address and section. */
1129 extern struct symbol *find_pc_sect_function (CORE_ADDR, struct obj_section *);
1131 extern int find_pc_partial_function_gnu_ifunc (CORE_ADDR pc, const char **name,
1134 int *is_gnu_ifunc_p);
1136 /* lookup function from address, return name, start addr and end addr. */
1138 extern int find_pc_partial_function (CORE_ADDR, const char **, CORE_ADDR *,
1141 extern void clear_pc_function_cache (void);
1143 /* lookup partial symbol table by address and section. */
1145 extern struct symtab *find_pc_sect_symtab_via_partial (CORE_ADDR,
1146 struct obj_section *);
1148 /* lookup full symbol table by address. */
1150 extern struct symtab *find_pc_symtab (CORE_ADDR);
1152 /* lookup full symbol table by address and section. */
1154 extern struct symtab *find_pc_sect_symtab (CORE_ADDR, struct obj_section *);
1156 extern int find_pc_line_pc_range (CORE_ADDR, CORE_ADDR *, CORE_ADDR *);
1158 extern void reread_symbols (void);
1160 extern struct type *lookup_transparent_type (const char *);
1161 extern struct type *basic_lookup_transparent_type (const char *);
1164 /* Macro for name of symbol to indicate a file compiled with gcc. */
1165 #ifndef GCC_COMPILED_FLAG_SYMBOL
1166 #define GCC_COMPILED_FLAG_SYMBOL "gcc_compiled."
1169 /* Macro for name of symbol to indicate a file compiled with gcc2. */
1170 #ifndef GCC2_COMPILED_FLAG_SYMBOL
1171 #define GCC2_COMPILED_FLAG_SYMBOL "gcc2_compiled."
1174 extern int in_gnu_ifunc_stub (CORE_ADDR pc);
1176 /* Functions for resolving STT_GNU_IFUNC symbols which are implemented only
1177 for ELF symbol files. */
1179 struct gnu_ifunc_fns
1181 /* See elf_gnu_ifunc_resolve_addr for its real implementation. */
1182 CORE_ADDR (*gnu_ifunc_resolve_addr) (struct gdbarch *gdbarch, CORE_ADDR pc);
1184 /* See elf_gnu_ifunc_resolve_name for its real implementation. */
1185 int (*gnu_ifunc_resolve_name) (const char *function_name,
1186 CORE_ADDR *function_address_p);
1188 /* See elf_gnu_ifunc_resolver_stop for its real implementation. */
1189 void (*gnu_ifunc_resolver_stop) (struct breakpoint *b);
1191 /* See elf_gnu_ifunc_resolver_return_stop for its real implementation. */
1192 void (*gnu_ifunc_resolver_return_stop) (struct breakpoint *b);
1195 #define gnu_ifunc_resolve_addr gnu_ifunc_fns_p->gnu_ifunc_resolve_addr
1196 #define gnu_ifunc_resolve_name gnu_ifunc_fns_p->gnu_ifunc_resolve_name
1197 #define gnu_ifunc_resolver_stop gnu_ifunc_fns_p->gnu_ifunc_resolver_stop
1198 #define gnu_ifunc_resolver_return_stop \
1199 gnu_ifunc_fns_p->gnu_ifunc_resolver_return_stop
1201 extern const struct gnu_ifunc_fns *gnu_ifunc_fns_p;
1203 extern CORE_ADDR find_solib_trampoline_target (struct frame_info *, CORE_ADDR);
1205 struct symtab_and_line
1207 /* The program space of this sal. */
1208 struct program_space *pspace;
1210 struct symtab *symtab;
1211 struct obj_section *section;
1212 /* Line number. Line numbers start at 1 and proceed through symtab->nlines.
1213 0 is never a valid line number; it is used to indicate that line number
1214 information is not available. */
1222 /* The probe associated with this symtab_and_line. */
1223 struct probe *probe;
1224 /* If PROBE is not NULL, then this is the objfile in which the probe
1226 struct objfile *objfile;
1229 extern void init_sal (struct symtab_and_line *sal);
1231 struct symtabs_and_lines
1233 struct symtab_and_line *sals;
1238 /* Given a pc value, return line number it is in. Second arg nonzero means
1239 if pc is on the boundary use the previous statement's line number. */
1241 extern struct symtab_and_line find_pc_line (CORE_ADDR, int);
1243 /* Same function, but specify a section as well as an address. */
1245 extern struct symtab_and_line find_pc_sect_line (CORE_ADDR,
1246 struct obj_section *, int);
1248 /* Given a symtab and line number, return the pc there. */
1250 extern int find_line_pc (struct symtab *, int, CORE_ADDR *);
1252 extern int find_line_pc_range (struct symtab_and_line, CORE_ADDR *,
1255 extern void resolve_sal_pc (struct symtab_and_line *);
1257 /* Symbol-reading stuff in symfile.c and solib.c. */
1259 extern void clear_solib (void);
1263 extern int identify_source_line (struct symtab *, int, int, CORE_ADDR);
1265 /* Flags passed as 4th argument to print_source_lines. */
1267 enum print_source_lines_flags
1269 /* Do not print an error message. */
1270 PRINT_SOURCE_LINES_NOERROR = (1 << 0),
1272 /* Print the filename in front of the source lines. */
1273 PRINT_SOURCE_LINES_FILENAME = (1 << 1)
1276 extern void print_source_lines (struct symtab *, int, int,
1277 enum print_source_lines_flags);
1279 extern void forget_cached_source_info_for_objfile (struct objfile *);
1280 extern void forget_cached_source_info (void);
1282 extern void select_source_symtab (struct symtab *);
1284 extern VEC (char_ptr) *default_make_symbol_completion_list_break_on
1285 (const char *text, const char *word, const char *break_on,
1286 enum type_code code);
1287 extern VEC (char_ptr) *default_make_symbol_completion_list (const char *,
1290 extern VEC (char_ptr) *make_symbol_completion_list (const char *, const char *);
1291 extern VEC (char_ptr) *make_symbol_completion_type (const char *, const char *,
1293 extern VEC (char_ptr) *make_symbol_completion_list_fn (struct cmd_list_element *,
1297 extern VEC (char_ptr) *make_file_symbol_completion_list (const char *,
1301 extern VEC (char_ptr) *make_source_files_completion_list (const char *,
1306 int matching_obj_sections (struct obj_section *, struct obj_section *);
1308 extern struct symtab *find_line_symtab (struct symtab *, int, int *, int *);
1310 extern struct symtab_and_line find_function_start_sal (struct symbol *sym,
1313 extern void skip_prologue_sal (struct symtab_and_line *);
1317 extern void clear_symtab_users (int add_flags);
1319 extern enum language deduce_language_from_filename (const char *);
1323 extern int in_prologue (struct gdbarch *gdbarch,
1324 CORE_ADDR pc, CORE_ADDR func_start);
1326 extern CORE_ADDR skip_prologue_using_sal (struct gdbarch *gdbarch,
1327 CORE_ADDR func_addr);
1329 extern struct symbol *fixup_symbol_section (struct symbol *,
1332 /* Symbol searching */
1333 /* Note: struct symbol_search, search_symbols, et.al. are declared here,
1334 instead of making them local to symtab.c, for gdbtk's sake. */
1336 /* When using search_symbols, a list of the following structs is returned.
1337 Callers must free the search list using free_search_symbols! */
1338 struct symbol_search
1340 /* The block in which the match was found. Could be, for example,
1341 STATIC_BLOCK or GLOBAL_BLOCK. */
1344 /* Information describing what was found.
1346 If symtab and symbol are NOT NULL, then information was found
1348 struct symtab *symtab;
1349 struct symbol *symbol;
1351 /* If msymbol is non-null, then a match was made on something for
1352 which only minimal_symbols exist. */
1353 struct bound_minimal_symbol msymbol;
1355 /* A link to the next match, or NULL for the end. */
1356 struct symbol_search *next;
1359 extern void search_symbols (char *, enum search_domain, int, char **,
1360 struct symbol_search **);
1361 extern void free_search_symbols (struct symbol_search *);
1362 extern struct cleanup *make_cleanup_free_search_symbols (struct symbol_search
1365 /* The name of the ``main'' function.
1366 FIXME: cagney/2001-03-20: Can't make main_name() const since some
1367 of the calling code currently assumes that the string isn't
1369 extern /*const */ char *main_name (void);
1370 extern enum language main_language (void);
1372 /* Check global symbols in objfile. */
1373 struct symbol *lookup_global_symbol_from_objfile (const struct objfile *,
1375 const domain_enum domain);
1377 /* Return 1 if the supplied producer string matches the ARM RealView
1378 compiler (armcc). */
1379 int producer_is_realview (const char *producer);
1381 void fixup_section (struct general_symbol_info *ginfo,
1382 CORE_ADDR addr, struct objfile *objfile);
1384 struct objfile *lookup_objfile_from_block (const struct block *block);
1386 extern unsigned int symtab_create_debug;
1388 extern int basenames_may_differ;
1390 int compare_filenames_for_search (const char *filename,
1391 const char *search_name);
1393 int iterate_over_some_symtabs (const char *name,
1394 const char *real_path,
1395 int (*callback) (struct symtab *symtab,
1398 struct symtab *first,
1399 struct symtab *after_last);
1401 void iterate_over_symtabs (const char *name,
1402 int (*callback) (struct symtab *symtab,
1406 DEF_VEC_I (CORE_ADDR);
1408 VEC (CORE_ADDR) *find_pcs_for_symtab_line (struct symtab *symtab, int line,
1409 struct linetable_entry **best_entry);
1411 /* Callback for LA_ITERATE_OVER_SYMBOLS. The callback will be called
1412 once per matching symbol SYM, with DATA being the argument of the
1413 same name that was passed to LA_ITERATE_OVER_SYMBOLS. The callback
1414 should return nonzero to indicate that LA_ITERATE_OVER_SYMBOLS
1415 should continue iterating, or zero to indicate that the iteration
1418 typedef int (symbol_found_callback_ftype) (struct symbol *sym, void *data);
1420 void iterate_over_symbols (const struct block *block, const char *name,
1421 const domain_enum domain,
1422 symbol_found_callback_ftype *callback,
1425 struct cleanup *demangle_for_lookup (const char *name, enum language lang,
1426 const char **result_name);
1428 struct symbol *allocate_symbol (struct objfile *);
1430 void initialize_symbol (struct symbol *);
1432 struct template_symbol *allocate_template_symbol (struct objfile *);
1434 #endif /* !defined(SYMTAB_H) */