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). */
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 #define MSYMBOL_VALUE_ADDRESS(symbol) ((symbol)->mginfo.value.address + 0)
395 #define SET_MSYMBOL_VALUE_ADDRESS(symbol, new_value) \
396 ((symbol)->mginfo.value.address = (new_value))
397 #define MSYMBOL_VALUE_BYTES(symbol) (symbol)->mginfo.value.bytes
398 #define MSYMBOL_BLOCK_VALUE(symbol) (symbol)->mginfo.value.block
399 #define MSYMBOL_VALUE_CHAIN(symbol) (symbol)->mginfo.value.chain
400 #define MSYMBOL_LANGUAGE(symbol) (symbol)->mginfo.language
401 #define MSYMBOL_SECTION(symbol) (symbol)->mginfo.section
402 #define MSYMBOL_OBJ_SECTION(objfile, symbol) \
403 (((symbol)->mginfo.section >= 0) \
404 ? (&(((objfile)->sections)[(symbol)->mginfo.section])) \
407 #define MSYMBOL_NATURAL_NAME(symbol) \
408 (symbol_natural_name (&(symbol)->mginfo))
409 #define MSYMBOL_LINKAGE_NAME(symbol) (symbol)->mginfo.name
410 #define MSYMBOL_PRINT_NAME(symbol) \
411 (demangle ? MSYMBOL_NATURAL_NAME (symbol) : MSYMBOL_LINKAGE_NAME (symbol))
412 #define MSYMBOL_DEMANGLED_NAME(symbol) \
413 (symbol_demangled_name (&(symbol)->mginfo))
414 #define MSYMBOL_SET_LANGUAGE(symbol,language,obstack) \
415 (symbol_set_language (&(symbol)->mginfo, (language), (obstack)))
416 #define MSYMBOL_SEARCH_NAME(symbol) \
417 (symbol_search_name (&(symbol)->mginfo))
418 #define MSYMBOL_MATCHES_SEARCH_NAME(symbol, name) \
419 (strcmp_iw (MSYMBOL_SEARCH_NAME (symbol), (name)) == 0)
420 #define MSYMBOL_SET_NAMES(symbol,linkage_name,len,copy_name,objfile) \
421 symbol_set_names (&(symbol)->mginfo, linkage_name, len, copy_name, objfile)
427 /* Represent one symbol name; a variable, constant, function or typedef. */
429 /* Different name domains for symbols. Looking up a symbol specifies a
430 domain and ignores symbol definitions in other name domains. */
432 typedef enum domain_enum_tag
434 /* UNDEF_DOMAIN is used when a domain has not been discovered or
435 none of the following apply. This usually indicates an error either
436 in the symbol information or in gdb's handling of symbols. */
440 /* VAR_DOMAIN is the usual domain. In C, this contains variables,
441 function names, typedef names and enum type values. */
445 /* STRUCT_DOMAIN is used in C to hold struct, union and enum type names.
446 Thus, if `struct foo' is used in a C program, it produces a symbol named
447 `foo' in the STRUCT_DOMAIN. */
451 /* MODULE_DOMAIN is used in Fortran to hold module type names. */
455 /* LABEL_DOMAIN may be used for names of labels (for gotos). */
459 /* Fortran common blocks. Their naming must be separate from VAR_DOMAIN.
460 They also always use LOC_COMMON_BLOCK. */
464 extern const char *domain_name (domain_enum);
466 /* Searching domains, used for `search_symbols'. Element numbers are
467 hardcoded in GDB, check all enum uses before changing it. */
471 /* Everything in VAR_DOMAIN minus FUNCTIONS_DOMAIN and
473 VARIABLES_DOMAIN = 0,
475 /* All functions -- for some reason not methods, though. */
476 FUNCTIONS_DOMAIN = 1,
478 /* All defined types */
485 extern const char *search_domain_name (enum search_domain);
487 /* An address-class says where to find the value of a symbol. */
491 /* Not used; catches errors. */
495 /* Value is constant int SYMBOL_VALUE, host byteorder. */
499 /* Value is at fixed address SYMBOL_VALUE_ADDRESS. */
503 /* Value is in register. SYMBOL_VALUE is the register number
504 in the original debug format. SYMBOL_REGISTER_OPS holds a
505 function that can be called to transform this into the
506 actual register number this represents in a specific target
507 architecture (gdbarch).
509 For some symbol formats (stabs, for some compilers at least),
510 the compiler generates two symbols, an argument and a register.
511 In some cases we combine them to a single LOC_REGISTER in symbol
512 reading, but currently not for all cases (e.g. it's passed on the
513 stack and then loaded into a register). */
517 /* It's an argument; the value is at SYMBOL_VALUE offset in arglist. */
521 /* Value address is at SYMBOL_VALUE offset in arglist. */
525 /* Value is in specified register. Just like LOC_REGISTER except the
526 register holds the address of the argument instead of the argument
527 itself. This is currently used for the passing of structs and unions
528 on sparc and hppa. It is also used for call by reference where the
529 address is in a register, at least by mipsread.c. */
533 /* Value is a local variable at SYMBOL_VALUE offset in stack frame. */
537 /* Value not used; definition in SYMBOL_TYPE. Symbols in the domain
538 STRUCT_DOMAIN all have this class. */
542 /* Value is address SYMBOL_VALUE_ADDRESS in the code. */
546 /* In a symbol table, value is SYMBOL_BLOCK_VALUE of a `struct block'.
547 In a partial symbol table, SYMBOL_VALUE_ADDRESS is the start address
548 of the block. Function names have this class. */
552 /* Value is a constant byte-sequence pointed to by SYMBOL_VALUE_BYTES, in
553 target byte order. */
557 /* Value is at fixed address, but the address of the variable has
558 to be determined from the minimal symbol table whenever the
559 variable is referenced.
560 This happens if debugging information for a global symbol is
561 emitted and the corresponding minimal symbol is defined
562 in another object file or runtime common storage.
563 The linker might even remove the minimal symbol if the global
564 symbol is never referenced, in which case the symbol remains
567 GDB would normally find the symbol in the minimal symbol table if it will
568 not find it in the full symbol table. But a reference to an external
569 symbol in a local block shadowing other definition requires full symbol
570 without possibly having its address available for LOC_STATIC. Testcase
571 is provided as `gdb.dwarf2/dw2-unresolved.exp'. */
575 /* The variable does not actually exist in the program.
576 The value is ignored. */
580 /* The variable's address is computed by a set of location
581 functions (see "struct symbol_computed_ops" below). */
584 /* The variable uses general_symbol_info->value->common_block field.
585 It also always uses COMMON_BLOCK_DOMAIN. */
588 /* Not used, just notes the boundary of the enum. */
592 /* The methods needed to implement LOC_COMPUTED. These methods can
593 use the symbol's .aux_value for additional per-symbol information.
595 At present this is only used to implement location expressions. */
597 struct symbol_computed_ops
600 /* Return the value of the variable SYMBOL, relative to the stack
601 frame FRAME. If the variable has been optimized out, return
604 Iff `read_needs_frame (SYMBOL)' is zero, then FRAME may be zero. */
606 struct value *(*read_variable) (struct symbol * symbol,
607 struct frame_info * frame);
609 /* Read variable SYMBOL like read_variable at (callee) FRAME's function
610 entry. SYMBOL should be a function parameter, otherwise
611 NO_ENTRY_VALUE_ERROR will be thrown. */
612 struct value *(*read_variable_at_entry) (struct symbol *symbol,
613 struct frame_info *frame);
615 /* Return non-zero if we need a frame to find the value of the SYMBOL. */
616 int (*read_needs_frame) (struct symbol * symbol);
618 /* Write to STREAM a natural-language description of the location of
619 SYMBOL, in the context of ADDR. */
620 void (*describe_location) (struct symbol * symbol, CORE_ADDR addr,
621 struct ui_file * stream);
623 /* Non-zero if this symbol's address computation is dependent on PC. */
624 unsigned char location_has_loclist;
626 /* Tracepoint support. Append bytecodes to the tracepoint agent
627 expression AX that push the address of the object SYMBOL. Set
628 VALUE appropriately. Note --- for objects in registers, this
629 needn't emit any code; as long as it sets VALUE properly, then
630 the caller will generate the right code in the process of
631 treating this as an lvalue or rvalue. */
633 void (*tracepoint_var_ref) (struct symbol *symbol, struct gdbarch *gdbarch,
634 struct agent_expr *ax, struct axs_value *value);
637 /* The methods needed to implement LOC_BLOCK for inferior functions.
638 These methods can use the symbol's .aux_value for additional
639 per-symbol information. */
641 struct symbol_block_ops
643 /* Fill in *START and *LENGTH with DWARF block data of function
644 FRAMEFUNC valid for inferior context address PC. Set *LENGTH to
645 zero if such location is not valid for PC; *START is left
646 uninitialized in such case. */
647 void (*find_frame_base_location) (struct symbol *framefunc, CORE_ADDR pc,
648 const gdb_byte **start, size_t *length);
651 /* Functions used with LOC_REGISTER and LOC_REGPARM_ADDR. */
653 struct symbol_register_ops
655 int (*register_number) (struct symbol *symbol, struct gdbarch *gdbarch);
658 /* Objects of this type are used to find the address class and the
659 various computed ops vectors of a symbol. */
663 enum address_class aclass;
665 /* Used with LOC_COMPUTED. */
666 const struct symbol_computed_ops *ops_computed;
668 /* Used with LOC_BLOCK. */
669 const struct symbol_block_ops *ops_block;
671 /* Used with LOC_REGISTER and LOC_REGPARM_ADDR. */
672 const struct symbol_register_ops *ops_register;
675 /* The number of bits we reserve in a symbol for the aclass index.
676 This is a #define so that we can have a assertion elsewhere to
677 verify that we have reserved enough space for synthetic address
680 #define SYMBOL_ACLASS_BITS 6
682 /* This structure is space critical. See space comments at the top. */
687 /* The general symbol info required for all types of symbols. */
689 struct general_symbol_info ginfo;
691 /* Data type of value */
695 /* The symbol table containing this symbol. This is the file
696 associated with LINE. It can be NULL during symbols read-in but it is
697 never NULL during normal operation. */
698 struct symtab *symtab;
702 ENUM_BITFIELD(domain_enum_tag) domain : 6;
704 /* Address class. This holds an index into the 'symbol_impls'
705 table. The actual enum address_class value is stored there,
706 alongside any per-class ops vectors. */
708 unsigned int aclass_index : SYMBOL_ACLASS_BITS;
710 /* Whether this is an argument. */
712 unsigned is_argument : 1;
714 /* Whether this is an inlined function (class LOC_BLOCK only). */
715 unsigned is_inlined : 1;
717 /* True if this is a C++ function symbol with template arguments.
718 In this case the symbol is really a "struct template_symbol". */
719 unsigned is_cplus_template_function : 1;
721 /* Line number of this symbol's definition, except for inlined
722 functions. For an inlined function (class LOC_BLOCK and
723 SYMBOL_INLINED set) this is the line number of the function's call
724 site. Inlined function symbols are not definitions, and they are
725 never found by symbol table lookup.
727 FIXME: Should we really make the assumption that nobody will try
728 to debug files longer than 64K lines? What about machine
729 generated programs? */
733 /* An arbitrary data pointer, allowing symbol readers to record
734 additional information on a per-symbol basis. Note that this data
735 must be allocated using the same obstack as the symbol itself. */
736 /* So far it is only used by LOC_COMPUTED to
737 find the location information. For a LOC_BLOCK symbol
738 for a function in a compilation unit compiled with DWARF 2
739 information, this is information used internally by the DWARF 2
740 code --- specifically, the location expression for the frame
741 base for this function. */
742 /* FIXME drow/2003-02-21: For the LOC_BLOCK case, it might be better
743 to add a magic symbol to the block containing this information,
744 or to have a generic debug info annotation slot for symbols. */
748 struct symbol *hash_next;
751 extern const struct symbol_impl *symbol_impls;
753 #define SYMBOL_DOMAIN(symbol) (symbol)->domain
754 #define SYMBOL_IMPL(symbol) (symbol_impls[(symbol)->aclass_index])
755 #define SYMBOL_ACLASS_INDEX(symbol) (symbol)->aclass_index
756 #define SYMBOL_CLASS(symbol) (SYMBOL_IMPL (symbol).aclass)
757 #define SYMBOL_IS_ARGUMENT(symbol) (symbol)->is_argument
758 #define SYMBOL_INLINED(symbol) (symbol)->is_inlined
759 #define SYMBOL_IS_CPLUS_TEMPLATE_FUNCTION(symbol) \
760 (symbol)->is_cplus_template_function
761 #define SYMBOL_TYPE(symbol) (symbol)->type
762 #define SYMBOL_LINE(symbol) (symbol)->line
763 #define SYMBOL_SYMTAB(symbol) (symbol)->symtab
764 #define SYMBOL_COMPUTED_OPS(symbol) (SYMBOL_IMPL (symbol).ops_computed)
765 #define SYMBOL_BLOCK_OPS(symbol) (SYMBOL_IMPL (symbol).ops_block)
766 #define SYMBOL_REGISTER_OPS(symbol) (SYMBOL_IMPL (symbol).ops_register)
767 #define SYMBOL_LOCATION_BATON(symbol) (symbol)->aux_value
768 #define SYMBOL_OBJFILE(symbol) (SYMBOL_SYMTAB (symbol)->objfile)
770 extern int register_symbol_computed_impl (enum address_class,
771 const struct symbol_computed_ops *);
773 extern int register_symbol_block_impl (enum address_class aclass,
774 const struct symbol_block_ops *ops);
776 extern int register_symbol_register_impl (enum address_class,
777 const struct symbol_register_ops *);
779 /* An instance of this type is used to represent a C++ template
780 function. It includes a "struct symbol" as a kind of base class;
781 users downcast to "struct template_symbol *" when needed. A symbol
782 is really of this type iff SYMBOL_IS_CPLUS_TEMPLATE_FUNCTION is
785 struct template_symbol
787 /* The base class. */
790 /* The number of template arguments. */
791 int n_template_arguments;
793 /* The template arguments. This is an array with
794 N_TEMPLATE_ARGUMENTS elements. */
795 struct symbol **template_arguments;
799 /* Each item represents a line-->pc (or the reverse) mapping. This is
800 somewhat more wasteful of space than one might wish, but since only
801 the files which are actually debugged are read in to core, we don't
804 struct linetable_entry
810 /* The order of entries in the linetable is significant. They should
811 be sorted by increasing values of the pc field. If there is more than
812 one entry for a given pc, then I'm not sure what should happen (and
813 I not sure whether we currently handle it the best way).
815 Example: a C for statement generally looks like this
817 10 0x100 - for the init/test part of a for stmt.
820 10 0x400 - for the increment part of a for stmt.
822 If an entry has a line number of zero, it marks the start of a PC
823 range for which no line number information is available. It is
824 acceptable, though wasteful of table space, for such a range to be
831 /* Actually NITEMS elements. If you don't like this use of the
832 `struct hack', you can shove it up your ANSI (seriously, if the
833 committee tells us how to do it, we can probably go along). */
834 struct linetable_entry item[1];
837 /* How to relocate the symbols from each section in a symbol file.
838 Each struct contains an array of offsets.
839 The ordering and meaning of the offsets is file-type-dependent;
840 typically it is indexed by section numbers or symbol types or
843 To give us flexibility in changing the internal representation
844 of these offsets, the ANOFFSET macro must be used to insert and
845 extract offset values in the struct. */
847 struct section_offsets
849 CORE_ADDR offsets[1]; /* As many as needed. */
852 #define ANOFFSET(secoff, whichone) \
854 ? (internal_error (__FILE__, __LINE__, \
855 _("Section index is uninitialized")), -1) \
856 : secoff->offsets[whichone])
858 /* The size of a section_offsets table for N sections. */
859 #define SIZEOF_N_SECTION_OFFSETS(n) \
860 (sizeof (struct section_offsets) \
861 + sizeof (((struct section_offsets *) 0)->offsets) * ((n)-1))
863 /* Each source file or header is represented by a struct symtab.
864 These objects are chained through the `next' field. */
868 /* Unordered chain of all existing symtabs of this objfile. */
872 /* List of all symbol scope blocks for this symtab. May be shared
873 between different symtabs (and normally is for all the symtabs
874 in a given compilation unit). */
876 struct blockvector *blockvector;
878 /* Table mapping core addresses to line numbers for this file.
879 Can be NULL if none. Never shared between different symtabs. */
881 struct linetable *linetable;
883 /* Section in objfile->section_offsets for the blockvector and
884 the linetable. Probably always SECT_OFF_TEXT. */
886 int block_line_section;
888 /* If several symtabs share a blockvector, exactly one of them
889 should be designated the primary, so that the blockvector
890 is relocated exactly once by objfile_relocate. */
892 unsigned int primary : 1;
894 /* Symtab has been compiled with both optimizations and debug info so that
895 GDB may stop skipping prologues as variables locations are valid already
896 at function entry points. */
898 unsigned int locations_valid : 1;
900 /* DWARF unwinder for this CU is valid even for epilogues (PC at the return
901 instruction). This is supported by GCC since 4.5.0. */
903 unsigned int epilogue_unwind_valid : 1;
905 /* The macro table for this symtab. Like the blockvector, this
906 may be shared between different symtabs --- and normally is for
907 all the symtabs in a given compilation unit. */
908 struct macro_table *macro_table;
910 /* Name of this source file. This pointer is never NULL. */
912 const char *filename;
914 /* Directory in which it was compiled, or NULL if we don't know. */
918 /* Total number of lines found in source file. */
922 /* line_charpos[N] is the position of the (N-1)th line of the
923 source file. "position" means something we can lseek() to; it
924 is not guaranteed to be useful any other way. */
928 /* Language of this source file. */
930 enum language language;
932 /* String that identifies the format of the debugging information, such
933 as "stabs", "dwarf 1", "dwarf 2", "coff", etc. This is mostly useful
934 for automated testing of gdb but may also be information that is
935 useful to the user. */
937 const char *debugformat;
939 /* String of producer version information. May be zero. */
941 const char *producer;
943 /* Full name of file as found by searching the source path.
944 NULL if not yet known. */
948 /* Object file from which this symbol information was read. */
950 struct objfile *objfile;
952 /* struct call_site entries for this compilation unit or NULL. */
954 htab_t call_site_htab;
956 /* If non-NULL, then this points to a NULL-terminated vector of
957 included symbol tables. When searching the static or global
958 block of this symbol table, the corresponding block of all
959 included symbol tables will also be searched. Note that this
960 list must be flattened -- the symbol reader is responsible for
961 ensuring that this vector contains the transitive closure of all
962 included symbol tables. */
964 struct symtab **includes;
966 /* If this is an included symbol table, this points to one includer
967 of the table. This user is considered the canonical symbol table
968 containing this one. An included symbol table may itself be
969 included by another. */
974 #define BLOCKVECTOR(symtab) (symtab)->blockvector
975 #define LINETABLE(symtab) (symtab)->linetable
976 #define SYMTAB_PSPACE(symtab) (symtab)->objfile->pspace
978 /* Call this to set the "primary" field in struct symtab. */
979 extern void set_symtab_primary (struct symtab *, int primary);
981 typedef struct symtab *symtab_ptr;
982 DEF_VEC_P (symtab_ptr);
986 /* The virtual function table is now an array of structures which have the
987 form { int16 offset, delta; void *pfn; }.
989 In normal virtual function tables, OFFSET is unused.
990 DELTA is the amount which is added to the apparent object's base
991 address in order to point to the actual object to which the
992 virtual function should be applied.
993 PFN is a pointer to the virtual function.
995 Note that this macro is g++ specific (FIXME). */
997 #define VTBL_FNADDR_OFFSET 2
999 /* External variables and functions for the objects described above. */
1001 /* True if we are nested inside psymtab_to_symtab. */
1003 extern int currently_reading_symtab;
1005 /* symtab.c lookup functions */
1007 extern const char multiple_symbols_ask[];
1008 extern const char multiple_symbols_all[];
1009 extern const char multiple_symbols_cancel[];
1011 const char *multiple_symbols_select_mode (void);
1013 int symbol_matches_domain (enum language symbol_language,
1014 domain_enum symbol_domain,
1015 domain_enum domain);
1017 /* lookup a symbol table by source file name. */
1019 extern struct symtab *lookup_symtab (const char *);
1021 /* An object of this type is passed as the 'is_a_field_of_this'
1022 argument to lookup_symbol and lookup_symbol_in_language. */
1024 struct field_of_this_result
1026 /* The type in which the field was found. If this is NULL then the
1027 symbol was not found in 'this'. If non-NULL, then one of the
1028 other fields will be non-NULL as well. */
1032 /* If the symbol was found as an ordinary field of 'this', then this
1033 is non-NULL and points to the particular field. */
1035 struct field *field;
1037 /* If the symbol was found as an function field of 'this', then this
1038 is non-NULL and points to the particular field. */
1040 struct fn_fieldlist *fn_field;
1043 /* lookup a symbol by name (optional block) in language. */
1045 extern struct symbol *lookup_symbol_in_language (const char *,
1046 const struct block *,
1049 struct field_of_this_result *);
1051 /* lookup a symbol by name (optional block, optional symtab)
1052 in the current language. */
1054 extern struct symbol *lookup_symbol (const char *, const struct block *,
1056 struct field_of_this_result *);
1058 /* A default version of lookup_symbol_nonlocal for use by languages
1059 that can't think of anything better to do. */
1061 extern struct symbol *basic_lookup_symbol_nonlocal (const char *,
1062 const struct block *,
1065 /* Some helper functions for languages that need to write their own
1066 lookup_symbol_nonlocal functions. */
1068 /* Lookup a symbol in the static block associated to BLOCK, if there
1069 is one; do nothing if BLOCK is NULL or a global block. */
1071 extern struct symbol *lookup_symbol_static (const char *name,
1072 const struct block *block,
1073 const domain_enum domain);
1075 /* Lookup a symbol in all files' global blocks (searching psymtabs if
1078 extern struct symbol *lookup_symbol_global (const char *name,
1079 const struct block *block,
1080 const domain_enum domain);
1082 /* Lookup a symbol within the block BLOCK. This, unlike
1083 lookup_symbol_block, will set SYMTAB and BLOCK_FOUND correctly, and
1084 will fix up the symbol if necessary. */
1086 extern struct symbol *lookup_symbol_aux_block (const char *name,
1087 const struct block *block,
1088 const domain_enum domain);
1090 extern struct symbol *lookup_language_this (const struct language_defn *lang,
1091 const struct block *block);
1093 /* Lookup a symbol only in the file static scope of all the objfiles. */
1095 struct symbol *lookup_static_symbol_aux (const char *name,
1096 const domain_enum domain);
1099 /* lookup a symbol by name, within a specified block. */
1101 extern struct symbol *lookup_block_symbol (const struct block *, const char *,
1104 /* lookup a [struct, union, enum] by name, within a specified block. */
1106 extern struct type *lookup_struct (const char *, const struct block *);
1108 extern struct type *lookup_union (const char *, const struct block *);
1110 extern struct type *lookup_enum (const char *, const struct block *);
1112 /* from blockframe.c: */
1114 /* lookup the function symbol corresponding to the address. */
1116 extern struct symbol *find_pc_function (CORE_ADDR);
1118 /* lookup the function corresponding to the address and section. */
1120 extern struct symbol *find_pc_sect_function (CORE_ADDR, struct obj_section *);
1122 extern int find_pc_partial_function_gnu_ifunc (CORE_ADDR pc, const char **name,
1125 int *is_gnu_ifunc_p);
1127 /* lookup function from address, return name, start addr and end addr. */
1129 extern int find_pc_partial_function (CORE_ADDR, const char **, CORE_ADDR *,
1132 extern void clear_pc_function_cache (void);
1134 /* lookup partial symbol table by address and section. */
1136 extern struct symtab *find_pc_sect_symtab_via_partial (CORE_ADDR,
1137 struct obj_section *);
1139 /* lookup full symbol table by address. */
1141 extern struct symtab *find_pc_symtab (CORE_ADDR);
1143 /* lookup full symbol table by address and section. */
1145 extern struct symtab *find_pc_sect_symtab (CORE_ADDR, struct obj_section *);
1147 extern int find_pc_line_pc_range (CORE_ADDR, CORE_ADDR *, CORE_ADDR *);
1149 extern void reread_symbols (void);
1151 extern struct type *lookup_transparent_type (const char *);
1152 extern struct type *basic_lookup_transparent_type (const char *);
1155 /* Macro for name of symbol to indicate a file compiled with gcc. */
1156 #ifndef GCC_COMPILED_FLAG_SYMBOL
1157 #define GCC_COMPILED_FLAG_SYMBOL "gcc_compiled."
1160 /* Macro for name of symbol to indicate a file compiled with gcc2. */
1161 #ifndef GCC2_COMPILED_FLAG_SYMBOL
1162 #define GCC2_COMPILED_FLAG_SYMBOL "gcc2_compiled."
1165 extern int in_gnu_ifunc_stub (CORE_ADDR pc);
1167 /* Functions for resolving STT_GNU_IFUNC symbols which are implemented only
1168 for ELF symbol files. */
1170 struct gnu_ifunc_fns
1172 /* See elf_gnu_ifunc_resolve_addr for its real implementation. */
1173 CORE_ADDR (*gnu_ifunc_resolve_addr) (struct gdbarch *gdbarch, CORE_ADDR pc);
1175 /* See elf_gnu_ifunc_resolve_name for its real implementation. */
1176 int (*gnu_ifunc_resolve_name) (const char *function_name,
1177 CORE_ADDR *function_address_p);
1179 /* See elf_gnu_ifunc_resolver_stop for its real implementation. */
1180 void (*gnu_ifunc_resolver_stop) (struct breakpoint *b);
1182 /* See elf_gnu_ifunc_resolver_return_stop for its real implementation. */
1183 void (*gnu_ifunc_resolver_return_stop) (struct breakpoint *b);
1186 #define gnu_ifunc_resolve_addr gnu_ifunc_fns_p->gnu_ifunc_resolve_addr
1187 #define gnu_ifunc_resolve_name gnu_ifunc_fns_p->gnu_ifunc_resolve_name
1188 #define gnu_ifunc_resolver_stop gnu_ifunc_fns_p->gnu_ifunc_resolver_stop
1189 #define gnu_ifunc_resolver_return_stop \
1190 gnu_ifunc_fns_p->gnu_ifunc_resolver_return_stop
1192 extern const struct gnu_ifunc_fns *gnu_ifunc_fns_p;
1194 extern CORE_ADDR find_solib_trampoline_target (struct frame_info *, CORE_ADDR);
1196 struct symtab_and_line
1198 /* The program space of this sal. */
1199 struct program_space *pspace;
1201 struct symtab *symtab;
1202 struct obj_section *section;
1203 /* Line number. Line numbers start at 1 and proceed through symtab->nlines.
1204 0 is never a valid line number; it is used to indicate that line number
1205 information is not available. */
1213 /* The probe associated with this symtab_and_line. */
1214 struct probe *probe;
1217 extern void init_sal (struct symtab_and_line *sal);
1219 struct symtabs_and_lines
1221 struct symtab_and_line *sals;
1226 /* Given a pc value, return line number it is in. Second arg nonzero means
1227 if pc is on the boundary use the previous statement's line number. */
1229 extern struct symtab_and_line find_pc_line (CORE_ADDR, int);
1231 /* Same function, but specify a section as well as an address. */
1233 extern struct symtab_and_line find_pc_sect_line (CORE_ADDR,
1234 struct obj_section *, int);
1236 /* Given a symtab and line number, return the pc there. */
1238 extern int find_line_pc (struct symtab *, int, CORE_ADDR *);
1240 extern int find_line_pc_range (struct symtab_and_line, CORE_ADDR *,
1243 extern void resolve_sal_pc (struct symtab_and_line *);
1245 /* Symbol-reading stuff in symfile.c and solib.c. */
1247 extern void clear_solib (void);
1251 extern int identify_source_line (struct symtab *, int, int, CORE_ADDR);
1253 /* Flags passed as 4th argument to print_source_lines. */
1255 enum print_source_lines_flags
1257 /* Do not print an error message. */
1258 PRINT_SOURCE_LINES_NOERROR = (1 << 0),
1260 /* Print the filename in front of the source lines. */
1261 PRINT_SOURCE_LINES_FILENAME = (1 << 1)
1264 extern void print_source_lines (struct symtab *, int, int,
1265 enum print_source_lines_flags);
1267 extern void forget_cached_source_info_for_objfile (struct objfile *);
1268 extern void forget_cached_source_info (void);
1270 extern void select_source_symtab (struct symtab *);
1272 extern VEC (char_ptr) *default_make_symbol_completion_list_break_on
1273 (const char *text, const char *word, const char *break_on,
1274 enum type_code code);
1275 extern VEC (char_ptr) *default_make_symbol_completion_list (const char *,
1278 extern VEC (char_ptr) *make_symbol_completion_list (const char *, const char *);
1279 extern VEC (char_ptr) *make_symbol_completion_type (const char *, const char *,
1281 extern VEC (char_ptr) *make_symbol_completion_list_fn (struct cmd_list_element *,
1285 extern VEC (char_ptr) *make_file_symbol_completion_list (const char *,
1289 extern VEC (char_ptr) *make_source_files_completion_list (const char *,
1294 int matching_obj_sections (struct obj_section *, struct obj_section *);
1296 extern struct symtab *find_line_symtab (struct symtab *, int, int *, int *);
1298 extern struct symtab_and_line find_function_start_sal (struct symbol *sym,
1301 extern void skip_prologue_sal (struct symtab_and_line *);
1305 extern void clear_symtab_users (int add_flags);
1307 extern enum language deduce_language_from_filename (const char *);
1311 extern int in_prologue (struct gdbarch *gdbarch,
1312 CORE_ADDR pc, CORE_ADDR func_start);
1314 extern CORE_ADDR skip_prologue_using_sal (struct gdbarch *gdbarch,
1315 CORE_ADDR func_addr);
1317 extern struct symbol *fixup_symbol_section (struct symbol *,
1320 /* Symbol searching */
1321 /* Note: struct symbol_search, search_symbols, et.al. are declared here,
1322 instead of making them local to symtab.c, for gdbtk's sake. */
1324 /* When using search_symbols, a list of the following structs is returned.
1325 Callers must free the search list using free_search_symbols! */
1326 struct symbol_search
1328 /* The block in which the match was found. Could be, for example,
1329 STATIC_BLOCK or GLOBAL_BLOCK. */
1332 /* Information describing what was found.
1334 If symtab and symbol are NOT NULL, then information was found
1336 struct symtab *symtab;
1337 struct symbol *symbol;
1339 /* If msymbol is non-null, then a match was made on something for
1340 which only minimal_symbols exist. */
1341 struct bound_minimal_symbol msymbol;
1343 /* A link to the next match, or NULL for the end. */
1344 struct symbol_search *next;
1347 extern void search_symbols (char *, enum search_domain, int, char **,
1348 struct symbol_search **);
1349 extern void free_search_symbols (struct symbol_search *);
1350 extern struct cleanup *make_cleanup_free_search_symbols (struct symbol_search
1353 /* The name of the ``main'' function.
1354 FIXME: cagney/2001-03-20: Can't make main_name() const since some
1355 of the calling code currently assumes that the string isn't
1357 extern /*const */ char *main_name (void);
1358 extern enum language main_language (void);
1360 /* Check global symbols in objfile. */
1361 struct symbol *lookup_global_symbol_from_objfile (const struct objfile *,
1363 const domain_enum domain);
1365 /* Return 1 if the supplied producer string matches the ARM RealView
1366 compiler (armcc). */
1367 int producer_is_realview (const char *producer);
1369 void fixup_section (struct general_symbol_info *ginfo,
1370 CORE_ADDR addr, struct objfile *objfile);
1372 struct objfile *lookup_objfile_from_block (const struct block *block);
1374 extern unsigned int symtab_create_debug;
1376 extern int basenames_may_differ;
1378 int compare_filenames_for_search (const char *filename,
1379 const char *search_name);
1381 int iterate_over_some_symtabs (const char *name,
1382 const char *real_path,
1383 int (*callback) (struct symtab *symtab,
1386 struct symtab *first,
1387 struct symtab *after_last);
1389 void iterate_over_symtabs (const char *name,
1390 int (*callback) (struct symtab *symtab,
1394 DEF_VEC_I (CORE_ADDR);
1396 VEC (CORE_ADDR) *find_pcs_for_symtab_line (struct symtab *symtab, int line,
1397 struct linetable_entry **best_entry);
1399 /* Callback for LA_ITERATE_OVER_SYMBOLS. The callback will be called
1400 once per matching symbol SYM, with DATA being the argument of the
1401 same name that was passed to LA_ITERATE_OVER_SYMBOLS. The callback
1402 should return nonzero to indicate that LA_ITERATE_OVER_SYMBOLS
1403 should continue iterating, or zero to indicate that the iteration
1406 typedef int (symbol_found_callback_ftype) (struct symbol *sym, void *data);
1408 void iterate_over_symbols (const struct block *block, const char *name,
1409 const domain_enum domain,
1410 symbol_found_callback_ftype *callback,
1413 struct cleanup *demangle_for_lookup (const char *name, enum language lang,
1414 const char **result_name);
1416 struct symbol *allocate_symbol (struct objfile *);
1418 void initialize_symbol (struct symbol *);
1420 struct template_symbol *allocate_template_symbol (struct objfile *);
1422 #endif /* !defined(SYMTAB_H) */