1 /* Symbol table definitions for GDB.
3 Copyright (C) 1986-2013 Free Software Foundation, Inc.
5 This file is part of GDB.
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program. If not, see <http://www.gnu.org/licenses/>. */
20 #if !defined (SYMTAB_H)
27 /* Opaque declarations. */
42 /* Some of the structures in this file are space critical.
43 The space-critical structures are:
45 struct general_symbol_info
49 These structures are laid out to encourage good packing.
50 They use ENUM_BITFIELD and short int fields, and they order the
51 structure members so that fields less than a word are next
52 to each other so they can be packed together. */
54 /* Rearranged: used ENUM_BITFIELD and rearranged field order in
55 all the space critical structures (plus struct minimal_symbol).
56 Memory usage dropped from 99360768 bytes to 90001408 bytes.
57 I measured this with before-and-after tests of
58 "HEAD-old-gdb -readnow HEAD-old-gdb" and
59 "HEAD-new-gdb -readnow HEAD-old-gdb" on native i686-pc-linux-gnu,
60 red hat linux 8, with LD_LIBRARY_PATH=/usr/lib/debug,
61 typing "maint space 1" at the first command prompt.
63 Here is another measurement (from andrew c):
64 # no /usr/lib/debug, just plain glibc, like a normal user
66 (gdb) break internal_error
68 (gdb) maint internal-error
72 gdb gdb_6_0_branch 2003-08-19 space used: 8896512
73 gdb HEAD 2003-08-19 space used: 8904704
74 gdb HEAD 2003-08-21 space used: 8396800 (+symtab.h)
75 gdb HEAD 2003-08-21 space used: 8265728 (+gdbtypes.h)
77 The third line shows the savings from the optimizations in symtab.h.
78 The fourth line shows the savings from the optimizations in
79 gdbtypes.h. Both optimizations are in gdb HEAD now.
81 --chastain 2003-08-21 */
83 /* Struct for storing C++ specific information. Allocated when needed. */
87 const char *demangled_name
;
90 /* Define a structure for the information that is common to all symbol types,
91 including minimal symbols, partial symbols, and full symbols. In a
92 multilanguage environment, some language specific information may need to
93 be recorded along with each symbol. */
95 /* This structure is space critical. See space comments at the top. */
97 struct general_symbol_info
99 /* Name of the symbol. This is a required field. Storage for the
100 name is allocated on the objfile_obstack for the associated
101 objfile. For languages like C++ that make a distinction between
102 the mangled name and demangled name, this is the mangled
107 /* Value of the symbol. Which member of this union to use, and what
108 it means, depends on what kind of symbol this is and its
109 SYMBOL_CLASS. See comments there for more details. All of these
110 are in host byte order (though what they point to might be in
111 target byte order, e.g. LOC_CONST_BYTES). */
123 /* A common block. Used with COMMON_BLOCK_DOMAIN. */
125 struct common_block
*common_block
;
127 /* For opaque typedef struct chain. */
129 struct symbol
*chain
;
133 /* Since one and only one language can apply, wrap the language specific
134 information inside a union. */
138 /* This is used by languages which wish to store a demangled name.
139 currently used by Ada, Java, and Objective C. */
142 const char *demangled_name
;
146 struct cplus_specific
*cplus_specific
;
150 /* Record the source code language that applies to this symbol.
151 This is used to select one of the fields from the language specific
154 ENUM_BITFIELD(language
) language
: 8;
156 /* Which section is this symbol in? This is an index into
157 section_offsets for this objfile. Negative means that the symbol
158 does not get relocated relative to a section.
159 Disclaimer: currently this is just used for xcoff, so don't
160 expect all symbol-reading code to set it correctly (the ELF code
161 also tries to set it correctly). */
165 /* The section associated with this symbol. It can be NULL. */
167 struct obj_section
*obj_section
;
170 extern void symbol_set_demangled_name (struct general_symbol_info
*, char *,
173 extern const char *symbol_get_demangled_name
174 (const struct general_symbol_info
*);
176 extern CORE_ADDR
symbol_overlayed_address (CORE_ADDR
, struct obj_section
*);
178 /* Note that all the following SYMBOL_* macros are used with the
179 SYMBOL argument being either a partial symbol, a minimal symbol or
180 a full symbol. All three types have a ginfo field. In particular
181 the SYMBOL_SET_LANGUAGE, SYMBOL_DEMANGLED_NAME, etc.
182 macros cannot be entirely substituted by
183 functions, unless the callers are changed to pass in the ginfo
184 field only, instead of the SYMBOL parameter. */
186 #define SYMBOL_VALUE(symbol) (symbol)->ginfo.value.ivalue
187 #define SYMBOL_VALUE_ADDRESS(symbol) (symbol)->ginfo.value.address
188 #define SYMBOL_VALUE_BYTES(symbol) (symbol)->ginfo.value.bytes
189 #define SYMBOL_VALUE_COMMON_BLOCK(symbol) (symbol)->ginfo.value.common_block
190 #define SYMBOL_BLOCK_VALUE(symbol) (symbol)->ginfo.value.block
191 #define SYMBOL_VALUE_CHAIN(symbol) (symbol)->ginfo.value.chain
192 #define SYMBOL_LANGUAGE(symbol) (symbol)->ginfo.language
193 #define SYMBOL_SECTION(symbol) (symbol)->ginfo.section
194 #define SYMBOL_OBJ_SECTION(symbol) (symbol)->ginfo.obj_section
196 /* Initializes the language dependent portion of a symbol
197 depending upon the language for the symbol. */
198 #define SYMBOL_SET_LANGUAGE(symbol,language) \
199 (symbol_set_language (&(symbol)->ginfo, (language)))
200 extern void symbol_set_language (struct general_symbol_info
*symbol
,
201 enum language language
);
203 /* Set just the linkage name of a symbol; do not try to demangle
204 it. Used for constructs which do not have a mangled name,
205 e.g. struct tags. Unlike SYMBOL_SET_NAMES, linkage_name must
206 be terminated and either already on the objfile's obstack or
207 permanently allocated. */
208 #define SYMBOL_SET_LINKAGE_NAME(symbol,linkage_name) \
209 (symbol)->ginfo.name = (linkage_name)
211 /* Set the linkage and natural names of a symbol, by demangling
213 #define SYMBOL_SET_NAMES(symbol,linkage_name,len,copy_name,objfile) \
214 symbol_set_names (&(symbol)->ginfo, linkage_name, len, copy_name, objfile)
215 extern void symbol_set_names (struct general_symbol_info
*symbol
,
216 const char *linkage_name
, int len
, int copy_name
,
217 struct objfile
*objfile
);
219 /* Now come lots of name accessor macros. Short version as to when to
220 use which: Use SYMBOL_NATURAL_NAME to refer to the name of the
221 symbol in the original source code. Use SYMBOL_LINKAGE_NAME if you
222 want to know what the linker thinks the symbol's name is. Use
223 SYMBOL_PRINT_NAME for output. Use SYMBOL_DEMANGLED_NAME if you
224 specifically need to know whether SYMBOL_NATURAL_NAME and
225 SYMBOL_LINKAGE_NAME are different. */
227 /* Return SYMBOL's "natural" name, i.e. the name that it was called in
228 the original source code. In languages like C++ where symbols may
229 be mangled for ease of manipulation by the linker, this is the
232 #define SYMBOL_NATURAL_NAME(symbol) \
233 (symbol_natural_name (&(symbol)->ginfo))
234 extern const char *symbol_natural_name
235 (const struct general_symbol_info
*symbol
);
237 /* Return SYMBOL's name from the point of view of the linker. In
238 languages like C++ where symbols may be mangled for ease of
239 manipulation by the linker, this is the mangled name; otherwise,
240 it's the same as SYMBOL_NATURAL_NAME. */
242 #define SYMBOL_LINKAGE_NAME(symbol) (symbol)->ginfo.name
244 /* Return the demangled name for a symbol based on the language for
245 that symbol. If no demangled name exists, return NULL. */
246 #define SYMBOL_DEMANGLED_NAME(symbol) \
247 (symbol_demangled_name (&(symbol)->ginfo))
248 extern const char *symbol_demangled_name
249 (const struct general_symbol_info
*symbol
);
251 /* Macro that returns a version of the name of a symbol that is
252 suitable for output. In C++ this is the "demangled" form of the
253 name if demangle is on and the "mangled" form of the name if
254 demangle is off. In other languages this is just the symbol name.
255 The result should never be NULL. Don't use this for internal
256 purposes (e.g. storing in a hashtable): it's only suitable for output.
258 N.B. symbol may be anything with a ginfo member,
259 e.g., struct symbol or struct minimal_symbol. */
261 #define SYMBOL_PRINT_NAME(symbol) \
262 (demangle ? SYMBOL_NATURAL_NAME (symbol) : SYMBOL_LINKAGE_NAME (symbol))
265 /* Macro that returns the name to be used when sorting and searching symbols.
266 In C++, Chill, and Java, we search for the demangled form of a name,
267 and so sort symbols accordingly. In Ada, however, we search by mangled
268 name. If there is no distinct demangled name, then SYMBOL_SEARCH_NAME
269 returns the same value (same pointer) as SYMBOL_LINKAGE_NAME. */
270 #define SYMBOL_SEARCH_NAME(symbol) \
271 (symbol_search_name (&(symbol)->ginfo))
272 extern const char *symbol_search_name (const struct general_symbol_info
*);
274 /* Return non-zero if NAME matches the "search" name of SYMBOL.
275 Whitespace and trailing parentheses are ignored.
276 See strcmp_iw for details about its behavior. */
277 #define SYMBOL_MATCHES_SEARCH_NAME(symbol, name) \
278 (strcmp_iw (SYMBOL_SEARCH_NAME (symbol), (name)) == 0)
280 /* Classification types for a minimal symbol. These should be taken as
281 "advisory only", since if gdb can't easily figure out a
282 classification it simply selects mst_unknown. It may also have to
283 guess when it can't figure out which is a better match between two
284 types (mst_data versus mst_bss) for example. Since the minimal
285 symbol info is sometimes derived from the BFD library's view of a
286 file, we need to live with what information bfd supplies. */
288 enum minimal_symbol_type
290 mst_unknown
= 0, /* Unknown type, the default */
291 mst_text
, /* Generally executable instructions */
292 mst_text_gnu_ifunc
, /* Executable code returning address
293 of executable code */
294 mst_slot_got_plt
, /* GOT entries for .plt sections */
295 mst_data
, /* Generally initialized data */
296 mst_bss
, /* Generally uninitialized data */
297 mst_abs
, /* Generally absolute (nonrelocatable) */
298 /* GDB uses mst_solib_trampoline for the start address of a shared
299 library trampoline entry. Breakpoints for shared library functions
300 are put there if the shared library is not yet loaded.
301 After the shared library is loaded, lookup_minimal_symbol will
302 prefer the minimal symbol from the shared library (usually
303 a mst_text symbol) over the mst_solib_trampoline symbol, and the
304 breakpoints will be moved to their true address in the shared
305 library via breakpoint_re_set. */
306 mst_solib_trampoline
, /* Shared library trampoline code */
307 /* For the mst_file* types, the names are only guaranteed to be unique
308 within a given .o file. */
309 mst_file_text
, /* Static version of mst_text */
310 mst_file_data
, /* Static version of mst_data */
311 mst_file_bss
/* Static version of mst_bss */
314 /* Define a simple structure used to hold some very basic information about
315 all defined global symbols (text, data, bss, abs, etc). The only required
316 information is the general_symbol_info.
318 In many cases, even if a file was compiled with no special options for
319 debugging at all, as long as was not stripped it will contain sufficient
320 information to build a useful minimal symbol table using this structure.
321 Even when a file contains enough debugging information to build a full
322 symbol table, these minimal symbols are still useful for quickly mapping
323 between names and addresses, and vice versa. They are also sometimes
324 used to figure out what full symbol table entries need to be read in. */
326 struct minimal_symbol
329 /* The general symbol info required for all types of symbols.
331 The SYMBOL_VALUE_ADDRESS contains the address that this symbol
334 struct general_symbol_info ginfo
;
336 /* Size of this symbol. end_psymtab in dbxread.c uses this
337 information to calculate the end of the partial symtab based on the
338 address of the last symbol plus the size of the last symbol. */
342 /* Which source file is this symbol in? Only relevant for mst_file_*. */
343 const char *filename
;
345 /* Classification type for this minimal symbol. */
347 ENUM_BITFIELD(minimal_symbol_type
) type
: 8;
349 /* Non-zero if this symbol was created by gdb.
350 Such symbols do not appear in the output of "info var|fun". */
351 unsigned int created_by_gdb
: 1;
353 /* Two flag bits provided for the use of the target. */
354 unsigned int target_flag_1
: 1;
355 unsigned int target_flag_2
: 1;
357 /* Nonzero iff the size of the minimal symbol has been set.
358 Symbol size information can sometimes not be determined, because
359 the object file format may not carry that piece of information. */
360 unsigned int has_size
: 1;
362 /* Minimal symbols with the same hash key are kept on a linked
363 list. This is the link. */
365 struct minimal_symbol
*hash_next
;
367 /* Minimal symbols are stored in two different hash tables. This is
368 the `next' pointer for the demangled hash table. */
370 struct minimal_symbol
*demangled_hash_next
;
373 #define MSYMBOL_TARGET_FLAG_1(msymbol) (msymbol)->target_flag_1
374 #define MSYMBOL_TARGET_FLAG_2(msymbol) (msymbol)->target_flag_2
375 #define MSYMBOL_SIZE(msymbol) ((msymbol)->size + 0)
376 #define SET_MSYMBOL_SIZE(msymbol, sz) \
379 (msymbol)->size = sz; \
380 (msymbol)->has_size = 1; \
382 #define MSYMBOL_HAS_SIZE(msymbol) ((msymbol)->has_size + 0)
383 #define MSYMBOL_TYPE(msymbol) (msymbol)->type
389 /* Represent one symbol name; a variable, constant, function or typedef. */
391 /* Different name domains for symbols. Looking up a symbol specifies a
392 domain and ignores symbol definitions in other name domains. */
394 typedef enum domain_enum_tag
396 /* UNDEF_DOMAIN is used when a domain has not been discovered or
397 none of the following apply. This usually indicates an error either
398 in the symbol information or in gdb's handling of symbols. */
402 /* VAR_DOMAIN is the usual domain. In C, this contains variables,
403 function names, typedef names and enum type values. */
407 /* STRUCT_DOMAIN is used in C to hold struct, union and enum type names.
408 Thus, if `struct foo' is used in a C program, it produces a symbol named
409 `foo' in the STRUCT_DOMAIN. */
413 /* LABEL_DOMAIN may be used for names of labels (for gotos). */
417 /* Fortran common blocks. Their naming must be separate from VAR_DOMAIN. */
421 /* Searching domains, used for `search_symbols'. Element numbers are
422 hardcoded in GDB, check all enum uses before changing it. */
426 /* Everything in VAR_DOMAIN minus FUNCTIONS_DOMAIN and
428 VARIABLES_DOMAIN
= 0,
430 /* All functions -- for some reason not methods, though. */
431 FUNCTIONS_DOMAIN
= 1,
433 /* All defined types */
440 /* An address-class says where to find the value of a symbol. */
444 /* Not used; catches errors. */
448 /* Value is constant int SYMBOL_VALUE, host byteorder. */
452 /* Value is at fixed address SYMBOL_VALUE_ADDRESS. */
456 /* Value is in register. SYMBOL_VALUE is the register number
457 in the original debug format. SYMBOL_REGISTER_OPS holds a
458 function that can be called to transform this into the
459 actual register number this represents in a specific target
460 architecture (gdbarch).
462 For some symbol formats (stabs, for some compilers at least),
463 the compiler generates two symbols, an argument and a register.
464 In some cases we combine them to a single LOC_REGISTER in symbol
465 reading, but currently not for all cases (e.g. it's passed on the
466 stack and then loaded into a register). */
470 /* It's an argument; the value is at SYMBOL_VALUE offset in arglist. */
474 /* Value address is at SYMBOL_VALUE offset in arglist. */
478 /* Value is in specified register. Just like LOC_REGISTER except the
479 register holds the address of the argument instead of the argument
480 itself. This is currently used for the passing of structs and unions
481 on sparc and hppa. It is also used for call by reference where the
482 address is in a register, at least by mipsread.c. */
486 /* Value is a local variable at SYMBOL_VALUE offset in stack frame. */
490 /* Value not used; definition in SYMBOL_TYPE. Symbols in the domain
491 STRUCT_DOMAIN all have this class. */
495 /* Value is address SYMBOL_VALUE_ADDRESS in the code. */
499 /* In a symbol table, value is SYMBOL_BLOCK_VALUE of a `struct block'.
500 In a partial symbol table, SYMBOL_VALUE_ADDRESS is the start address
501 of the block. Function names have this class. */
505 /* Value is a constant byte-sequence pointed to by SYMBOL_VALUE_BYTES, in
506 target byte order. */
510 /* Value is at fixed address, but the address of the variable has
511 to be determined from the minimal symbol table whenever the
512 variable is referenced.
513 This happens if debugging information for a global symbol is
514 emitted and the corresponding minimal symbol is defined
515 in another object file or runtime common storage.
516 The linker might even remove the minimal symbol if the global
517 symbol is never referenced, in which case the symbol remains
520 GDB would normally find the symbol in the minimal symbol table if it will
521 not find it in the full symbol table. But a reference to an external
522 symbol in a local block shadowing other definition requires full symbol
523 without possibly having its address available for LOC_STATIC. Testcase
524 is provided as `gdb.dwarf2/dw2-unresolved.exp'. */
528 /* The variable does not actually exist in the program.
529 The value is ignored. */
533 /* The variable's address is computed by a set of location
534 functions (see "struct symbol_computed_ops" below). */
538 /* The methods needed to implement LOC_COMPUTED. These methods can
539 use the symbol's .aux_value for additional per-symbol information.
541 At present this is only used to implement location expressions. */
543 struct symbol_computed_ops
546 /* Return the value of the variable SYMBOL, relative to the stack
547 frame FRAME. If the variable has been optimized out, return
550 Iff `read_needs_frame (SYMBOL)' is zero, then FRAME may be zero. */
552 struct value
*(*read_variable
) (struct symbol
* symbol
,
553 struct frame_info
* frame
);
555 /* Read variable SYMBOL like read_variable at (callee) FRAME's function
556 entry. SYMBOL should be a function parameter, otherwise
557 NO_ENTRY_VALUE_ERROR will be thrown. */
558 struct value
*(*read_variable_at_entry
) (struct symbol
*symbol
,
559 struct frame_info
*frame
);
561 /* Return non-zero if we need a frame to find the value of the SYMBOL. */
562 int (*read_needs_frame
) (struct symbol
* symbol
);
564 /* Write to STREAM a natural-language description of the location of
565 SYMBOL, in the context of ADDR. */
566 void (*describe_location
) (struct symbol
* symbol
, CORE_ADDR addr
,
567 struct ui_file
* stream
);
569 /* Tracepoint support. Append bytecodes to the tracepoint agent
570 expression AX that push the address of the object SYMBOL. Set
571 VALUE appropriately. Note --- for objects in registers, this
572 needn't emit any code; as long as it sets VALUE properly, then
573 the caller will generate the right code in the process of
574 treating this as an lvalue or rvalue. */
576 void (*tracepoint_var_ref
) (struct symbol
*symbol
, struct gdbarch
*gdbarch
,
577 struct agent_expr
*ax
, struct axs_value
*value
);
580 /* Functions used with LOC_REGISTER and LOC_REGPARM_ADDR. */
582 struct symbol_register_ops
584 int (*register_number
) (struct symbol
*symbol
, struct gdbarch
*gdbarch
);
587 /* This structure is space critical. See space comments at the top. */
592 /* The general symbol info required for all types of symbols. */
594 struct general_symbol_info ginfo
;
596 /* Data type of value */
600 /* The symbol table containing this symbol. This is the file
601 associated with LINE. It can be NULL during symbols read-in but it is
602 never NULL during normal operation. */
603 struct symtab
*symtab
;
607 ENUM_BITFIELD(domain_enum_tag
) domain
: 6;
610 /* NOTE: cagney/2003-11-02: The fields "aclass" and "ops" contain
611 overlapping information. By creating a per-aclass ops vector, or
612 using the aclass as an index into an ops table, the aclass and
613 ops fields can be merged. The latter, for instance, would shave
614 32-bits from each symbol (relative to a symbol lookup, any table
615 index overhead would be in the noise). */
617 ENUM_BITFIELD(address_class
) aclass
: 6;
619 /* Whether this is an argument. */
621 unsigned is_argument
: 1;
623 /* Whether this is an inlined function (class LOC_BLOCK only). */
624 unsigned is_inlined
: 1;
626 /* True if this is a C++ function symbol with template arguments.
627 In this case the symbol is really a "struct template_symbol". */
628 unsigned is_cplus_template_function
: 1;
630 /* Line number of this symbol's definition, except for inlined
631 functions. For an inlined function (class LOC_BLOCK and
632 SYMBOL_INLINED set) this is the line number of the function's call
633 site. Inlined function symbols are not definitions, and they are
634 never found by symbol table lookup.
636 FIXME: Should we really make the assumption that nobody will try
637 to debug files longer than 64K lines? What about machine
638 generated programs? */
642 /* Method's for symbol's of this class. */
643 /* NOTE: cagney/2003-11-02: See comment above attached to "aclass". */
647 /* Used with LOC_COMPUTED. */
648 const struct symbol_computed_ops
*ops_computed
;
650 /* Used with LOC_REGISTER and LOC_REGPARM_ADDR. */
651 const struct symbol_register_ops
*ops_register
;
654 /* An arbitrary data pointer, allowing symbol readers to record
655 additional information on a per-symbol basis. Note that this data
656 must be allocated using the same obstack as the symbol itself. */
657 /* So far it is only used by LOC_COMPUTED to
658 find the location information. For a LOC_BLOCK symbol
659 for a function in a compilation unit compiled with DWARF 2
660 information, this is information used internally by the DWARF 2
661 code --- specifically, the location expression for the frame
662 base for this function. */
663 /* FIXME drow/2003-02-21: For the LOC_BLOCK case, it might be better
664 to add a magic symbol to the block containing this information,
665 or to have a generic debug info annotation slot for symbols. */
669 struct symbol
*hash_next
;
673 #define SYMBOL_DOMAIN(symbol) (symbol)->domain
674 #define SYMBOL_CLASS(symbol) (symbol)->aclass
675 #define SYMBOL_IS_ARGUMENT(symbol) (symbol)->is_argument
676 #define SYMBOL_INLINED(symbol) (symbol)->is_inlined
677 #define SYMBOL_IS_CPLUS_TEMPLATE_FUNCTION(symbol) \
678 (symbol)->is_cplus_template_function
679 #define SYMBOL_TYPE(symbol) (symbol)->type
680 #define SYMBOL_LINE(symbol) (symbol)->line
681 #define SYMBOL_SYMTAB(symbol) (symbol)->symtab
682 #define SYMBOL_COMPUTED_OPS(symbol) (symbol)->ops.ops_computed
683 #define SYMBOL_REGISTER_OPS(symbol) (symbol)->ops.ops_register
684 #define SYMBOL_LOCATION_BATON(symbol) (symbol)->aux_value
686 /* An instance of this type is used to represent a C++ template
687 function. It includes a "struct symbol" as a kind of base class;
688 users downcast to "struct template_symbol *" when needed. A symbol
689 is really of this type iff SYMBOL_IS_CPLUS_TEMPLATE_FUNCTION is
692 struct template_symbol
694 /* The base class. */
697 /* The number of template arguments. */
698 int n_template_arguments
;
700 /* The template arguments. This is an array with
701 N_TEMPLATE_ARGUMENTS elements. */
702 struct symbol
**template_arguments
;
706 /* Each item represents a line-->pc (or the reverse) mapping. This is
707 somewhat more wasteful of space than one might wish, but since only
708 the files which are actually debugged are read in to core, we don't
711 struct linetable_entry
717 /* The order of entries in the linetable is significant. They should
718 be sorted by increasing values of the pc field. If there is more than
719 one entry for a given pc, then I'm not sure what should happen (and
720 I not sure whether we currently handle it the best way).
722 Example: a C for statement generally looks like this
724 10 0x100 - for the init/test part of a for stmt.
727 10 0x400 - for the increment part of a for stmt.
729 If an entry has a line number of zero, it marks the start of a PC
730 range for which no line number information is available. It is
731 acceptable, though wasteful of table space, for such a range to be
738 /* Actually NITEMS elements. If you don't like this use of the
739 `struct hack', you can shove it up your ANSI (seriously, if the
740 committee tells us how to do it, we can probably go along). */
741 struct linetable_entry item
[1];
744 /* How to relocate the symbols from each section in a symbol file.
745 Each struct contains an array of offsets.
746 The ordering and meaning of the offsets is file-type-dependent;
747 typically it is indexed by section numbers or symbol types or
750 To give us flexibility in changing the internal representation
751 of these offsets, the ANOFFSET macro must be used to insert and
752 extract offset values in the struct. */
754 struct section_offsets
756 CORE_ADDR offsets
[1]; /* As many as needed. */
759 #define ANOFFSET(secoff, whichone) \
761 ? (internal_error (__FILE__, __LINE__, \
762 _("Section index is uninitialized")), -1) \
763 : secoff->offsets[whichone])
765 /* The size of a section_offsets table for N sections. */
766 #define SIZEOF_N_SECTION_OFFSETS(n) \
767 (sizeof (struct section_offsets) \
768 + sizeof (((struct section_offsets *) 0)->offsets) * ((n)-1))
770 /* Each source file or header is represented by a struct symtab.
771 These objects are chained through the `next' field. */
775 /* Unordered chain of all existing symtabs of this objfile. */
779 /* List of all symbol scope blocks for this symtab. May be shared
780 between different symtabs (and normally is for all the symtabs
781 in a given compilation unit). */
783 struct blockvector
*blockvector
;
785 /* Table mapping core addresses to line numbers for this file.
786 Can be NULL if none. Never shared between different symtabs. */
788 struct linetable
*linetable
;
790 /* Section in objfile->section_offsets for the blockvector and
791 the linetable. Probably always SECT_OFF_TEXT. */
793 int block_line_section
;
795 /* If several symtabs share a blockvector, exactly one of them
796 should be designated the primary, so that the blockvector
797 is relocated exactly once by objfile_relocate. */
799 unsigned int primary
: 1;
801 /* Symtab has been compiled with both optimizations and debug info so that
802 GDB may stop skipping prologues as variables locations are valid already
803 at function entry points. */
805 unsigned int locations_valid
: 1;
807 /* DWARF unwinder for this CU is valid even for epilogues (PC at the return
808 instruction). This is supported by GCC since 4.5.0. */
810 unsigned int epilogue_unwind_valid
: 1;
812 /* The macro table for this symtab. Like the blockvector, this
813 may be shared between different symtabs --- and normally is for
814 all the symtabs in a given compilation unit. */
815 struct macro_table
*macro_table
;
817 /* Name of this source file. This pointer is never NULL. */
821 /* Directory in which it was compiled, or NULL if we don't know. */
825 /* Total number of lines found in source file. */
829 /* line_charpos[N] is the position of the (N-1)th line of the
830 source file. "position" means something we can lseek() to; it
831 is not guaranteed to be useful any other way. */
835 /* Language of this source file. */
837 enum language language
;
839 /* String that identifies the format of the debugging information, such
840 as "stabs", "dwarf 1", "dwarf 2", "coff", etc. This is mostly useful
841 for automated testing of gdb but may also be information that is
842 useful to the user. */
844 const char *debugformat
;
846 /* String of producer version information. May be zero. */
848 const char *producer
;
850 /* Full name of file as found by searching the source path.
851 NULL if not yet known. */
855 /* Object file from which this symbol information was read. */
857 struct objfile
*objfile
;
859 /* struct call_site entries for this compilation unit or NULL. */
861 htab_t call_site_htab
;
863 /* If non-NULL, then this points to a NULL-terminated vector of
864 included symbol tables. When searching the static or global
865 block of this symbol table, the corresponding block of all
866 included symbol tables will also be searched. Note that this
867 list must be flattened -- the symbol reader is responsible for
868 ensuring that this vector contains the transitive closure of all
869 included symbol tables. */
871 struct symtab
**includes
;
873 /* If this is an included symbol table, this points to one includer
874 of the table. This user is considered the canonical symbol table
875 containing this one. An included symbol table may itself be
876 included by another. */
881 #define BLOCKVECTOR(symtab) (symtab)->blockvector
882 #define LINETABLE(symtab) (symtab)->linetable
883 #define SYMTAB_PSPACE(symtab) (symtab)->objfile->pspace
886 /* The virtual function table is now an array of structures which have the
887 form { int16 offset, delta; void *pfn; }.
889 In normal virtual function tables, OFFSET is unused.
890 DELTA is the amount which is added to the apparent object's base
891 address in order to point to the actual object to which the
892 virtual function should be applied.
893 PFN is a pointer to the virtual function.
895 Note that this macro is g++ specific (FIXME). */
897 #define VTBL_FNADDR_OFFSET 2
899 /* External variables and functions for the objects described above. */
901 /* True if we are nested inside psymtab_to_symtab. */
903 extern int currently_reading_symtab
;
905 /* symtab.c lookup functions */
907 extern const char multiple_symbols_ask
[];
908 extern const char multiple_symbols_all
[];
909 extern const char multiple_symbols_cancel
[];
911 const char *multiple_symbols_select_mode (void);
913 int symbol_matches_domain (enum language symbol_language
,
914 domain_enum symbol_domain
,
917 /* lookup a symbol table by source file name. */
919 extern struct symtab
*lookup_symtab (const char *);
921 /* An object of this type is passed as the 'is_a_field_of_this'
922 argument to lookup_symbol and lookup_symbol_in_language. */
924 struct field_of_this_result
926 /* The type in which the field was found. If this is NULL then the
927 symbol was not found in 'this'. If non-NULL, then one of the
928 other fields will be non-NULL as well. */
932 /* If the symbol was found as an ordinary field of 'this', then this
933 is non-NULL and points to the particular field. */
937 /* If the symbol was found as an function field of 'this', then this
938 is non-NULL and points to the particular field. */
940 struct fn_fieldlist
*fn_field
;
943 /* lookup a symbol by name (optional block) in language. */
945 extern struct symbol
*lookup_symbol_in_language (const char *,
946 const struct block
*,
949 struct field_of_this_result
*);
951 /* lookup a symbol by name (optional block, optional symtab)
952 in the current language. */
954 extern struct symbol
*lookup_symbol (const char *, const struct block
*,
956 struct field_of_this_result
*);
958 /* A default version of lookup_symbol_nonlocal for use by languages
959 that can't think of anything better to do. */
961 extern struct symbol
*basic_lookup_symbol_nonlocal (const char *,
962 const struct block
*,
965 /* Some helper functions for languages that need to write their own
966 lookup_symbol_nonlocal functions. */
968 /* Lookup a symbol in the static block associated to BLOCK, if there
969 is one; do nothing if BLOCK is NULL or a global block. */
971 extern struct symbol
*lookup_symbol_static (const char *name
,
972 const struct block
*block
,
973 const domain_enum domain
);
975 /* Lookup a symbol in all files' global blocks (searching psymtabs if
978 extern struct symbol
*lookup_symbol_global (const char *name
,
979 const struct block
*block
,
980 const domain_enum domain
);
982 /* Lookup a symbol within the block BLOCK. This, unlike
983 lookup_symbol_block, will set SYMTAB and BLOCK_FOUND correctly, and
984 will fix up the symbol if necessary. */
986 extern struct symbol
*lookup_symbol_aux_block (const char *name
,
987 const struct block
*block
,
988 const domain_enum domain
);
990 extern struct symbol
*lookup_language_this (const struct language_defn
*lang
,
991 const struct block
*block
);
993 /* Lookup a symbol only in the file static scope of all the objfiles. */
995 struct symbol
*lookup_static_symbol_aux (const char *name
,
996 const domain_enum domain
);
999 /* lookup a symbol by name, within a specified block. */
1001 extern struct symbol
*lookup_block_symbol (const struct block
*, const char *,
1004 /* lookup a [struct, union, enum] by name, within a specified block. */
1006 extern struct type
*lookup_struct (const char *, const struct block
*);
1008 extern struct type
*lookup_union (const char *, const struct block
*);
1010 extern struct type
*lookup_enum (const char *, const struct block
*);
1012 /* from blockframe.c: */
1014 /* lookup the function symbol corresponding to the address. */
1016 extern struct symbol
*find_pc_function (CORE_ADDR
);
1018 /* lookup the function corresponding to the address and section. */
1020 extern struct symbol
*find_pc_sect_function (CORE_ADDR
, struct obj_section
*);
1022 extern int find_pc_partial_function_gnu_ifunc (CORE_ADDR pc
, const char **name
,
1025 int *is_gnu_ifunc_p
);
1027 /* lookup function from address, return name, start addr and end addr. */
1029 extern int find_pc_partial_function (CORE_ADDR
, const char **, CORE_ADDR
*,
1032 extern void clear_pc_function_cache (void);
1034 /* lookup partial symbol table by address and section. */
1036 extern struct symtab
*find_pc_sect_symtab_via_partial (CORE_ADDR
,
1037 struct obj_section
*);
1039 /* lookup full symbol table by address. */
1041 extern struct symtab
*find_pc_symtab (CORE_ADDR
);
1043 /* lookup full symbol table by address and section. */
1045 extern struct symtab
*find_pc_sect_symtab (CORE_ADDR
, struct obj_section
*);
1047 extern int find_pc_line_pc_range (CORE_ADDR
, CORE_ADDR
*, CORE_ADDR
*);
1049 extern void reread_symbols (void);
1051 extern struct type
*lookup_transparent_type (const char *);
1052 extern struct type
*basic_lookup_transparent_type (const char *);
1055 /* Macro for name of symbol to indicate a file compiled with gcc. */
1056 #ifndef GCC_COMPILED_FLAG_SYMBOL
1057 #define GCC_COMPILED_FLAG_SYMBOL "gcc_compiled."
1060 /* Macro for name of symbol to indicate a file compiled with gcc2. */
1061 #ifndef GCC2_COMPILED_FLAG_SYMBOL
1062 #define GCC2_COMPILED_FLAG_SYMBOL "gcc2_compiled."
1065 extern int in_gnu_ifunc_stub (CORE_ADDR pc
);
1067 /* Functions for resolving STT_GNU_IFUNC symbols which are implemented only
1068 for ELF symbol files. */
1070 struct gnu_ifunc_fns
1072 /* See elf_gnu_ifunc_resolve_addr for its real implementation. */
1073 CORE_ADDR (*gnu_ifunc_resolve_addr
) (struct gdbarch
*gdbarch
, CORE_ADDR pc
);
1075 /* See elf_gnu_ifunc_resolve_name for its real implementation. */
1076 int (*gnu_ifunc_resolve_name
) (const char *function_name
,
1077 CORE_ADDR
*function_address_p
);
1079 /* See elf_gnu_ifunc_resolver_stop for its real implementation. */
1080 void (*gnu_ifunc_resolver_stop
) (struct breakpoint
*b
);
1082 /* See elf_gnu_ifunc_resolver_return_stop for its real implementation. */
1083 void (*gnu_ifunc_resolver_return_stop
) (struct breakpoint
*b
);
1086 #define gnu_ifunc_resolve_addr gnu_ifunc_fns_p->gnu_ifunc_resolve_addr
1087 #define gnu_ifunc_resolve_name gnu_ifunc_fns_p->gnu_ifunc_resolve_name
1088 #define gnu_ifunc_resolver_stop gnu_ifunc_fns_p->gnu_ifunc_resolver_stop
1089 #define gnu_ifunc_resolver_return_stop \
1090 gnu_ifunc_fns_p->gnu_ifunc_resolver_return_stop
1092 extern const struct gnu_ifunc_fns
*gnu_ifunc_fns_p
;
1094 extern CORE_ADDR
find_solib_trampoline_target (struct frame_info
*, CORE_ADDR
);
1096 struct symtab_and_line
1098 /* The program space of this sal. */
1099 struct program_space
*pspace
;
1101 struct symtab
*symtab
;
1102 struct obj_section
*section
;
1103 /* Line number. Line numbers start at 1 and proceed through symtab->nlines.
1104 0 is never a valid line number; it is used to indicate that line number
1105 information is not available. */
1113 /* The probe associated with this symtab_and_line. */
1114 struct probe
*probe
;
1117 extern void init_sal (struct symtab_and_line
*sal
);
1119 struct symtabs_and_lines
1121 struct symtab_and_line
*sals
;
1126 /* Given a pc value, return line number it is in. Second arg nonzero means
1127 if pc is on the boundary use the previous statement's line number. */
1129 extern struct symtab_and_line
find_pc_line (CORE_ADDR
, int);
1131 /* Same function, but specify a section as well as an address. */
1133 extern struct symtab_and_line
find_pc_sect_line (CORE_ADDR
,
1134 struct obj_section
*, int);
1136 /* Given a symtab and line number, return the pc there. */
1138 extern int find_line_pc (struct symtab
*, int, CORE_ADDR
*);
1140 extern int find_line_pc_range (struct symtab_and_line
, CORE_ADDR
*,
1143 extern void resolve_sal_pc (struct symtab_and_line
*);
1145 /* Symbol-reading stuff in symfile.c and solib.c. */
1147 extern void clear_solib (void);
1151 extern int identify_source_line (struct symtab
*, int, int, CORE_ADDR
);
1153 /* Flags passed as 4th argument to print_source_lines. */
1155 enum print_source_lines_flags
1157 /* Do not print an error message. */
1158 PRINT_SOURCE_LINES_NOERROR
= (1 << 0),
1160 /* Print the filename in front of the source lines. */
1161 PRINT_SOURCE_LINES_FILENAME
= (1 << 1)
1164 extern void print_source_lines (struct symtab
*, int, int,
1165 enum print_source_lines_flags
);
1167 extern void forget_cached_source_info_for_objfile (struct objfile
*);
1168 extern void forget_cached_source_info (void);
1170 extern void select_source_symtab (struct symtab
*);
1172 extern VEC (char_ptr
) *default_make_symbol_completion_list_break_on
1173 (char *text
, char *word
, const char *break_on
,
1174 enum type_code code
);
1175 extern VEC (char_ptr
) *default_make_symbol_completion_list (char *, char *,
1177 extern VEC (char_ptr
) *make_symbol_completion_list (char *, char *);
1178 extern VEC (char_ptr
) *make_symbol_completion_type (char *, char *,
1180 extern VEC (char_ptr
) *make_symbol_completion_list_fn (struct cmd_list_element
*,
1183 extern VEC (char_ptr
) *make_file_symbol_completion_list (char *,
1186 extern VEC (char_ptr
) *make_source_files_completion_list (char *, char *);
1190 int matching_obj_sections (struct obj_section
*, struct obj_section
*);
1192 extern const char *find_main_filename (void);
1194 extern struct symtab
*find_line_symtab (struct symtab
*, int, int *, int *);
1196 extern struct symtab_and_line
find_function_start_sal (struct symbol
*sym
,
1199 extern void skip_prologue_sal (struct symtab_and_line
*);
1203 extern void clear_symtab_users (int add_flags
);
1205 extern enum language
deduce_language_from_filename (const char *);
1209 extern int in_prologue (struct gdbarch
*gdbarch
,
1210 CORE_ADDR pc
, CORE_ADDR func_start
);
1212 extern CORE_ADDR
skip_prologue_using_sal (struct gdbarch
*gdbarch
,
1213 CORE_ADDR func_addr
);
1215 extern struct symbol
*fixup_symbol_section (struct symbol
*,
1218 /* Symbol searching */
1219 /* Note: struct symbol_search, search_symbols, et.al. are declared here,
1220 instead of making them local to symtab.c, for gdbtk's sake. */
1222 /* When using search_symbols, a list of the following structs is returned.
1223 Callers must free the search list using free_search_symbols! */
1224 struct symbol_search
1226 /* The block in which the match was found. Could be, for example,
1227 STATIC_BLOCK or GLOBAL_BLOCK. */
1230 /* Information describing what was found.
1232 If symtab abd symbol are NOT NULL, then information was found
1234 struct symtab
*symtab
;
1235 struct symbol
*symbol
;
1237 /* If msymbol is non-null, then a match was made on something for
1238 which only minimal_symbols exist. */
1239 struct minimal_symbol
*msymbol
;
1241 /* A link to the next match, or NULL for the end. */
1242 struct symbol_search
*next
;
1245 extern void search_symbols (char *, enum search_domain
, int, char **,
1246 struct symbol_search
**);
1247 extern void free_search_symbols (struct symbol_search
*);
1248 extern struct cleanup
*make_cleanup_free_search_symbols (struct symbol_search
1251 /* The name of the ``main'' function.
1252 FIXME: cagney/2001-03-20: Can't make main_name() const since some
1253 of the calling code currently assumes that the string isn't
1255 extern void set_main_name (const char *name
);
1256 extern /*const */ char *main_name (void);
1257 extern enum language language_of_main
;
1259 /* Check global symbols in objfile. */
1260 struct symbol
*lookup_global_symbol_from_objfile (const struct objfile
*,
1262 const domain_enum domain
);
1264 /* Return 1 if the supplied producer string matches the ARM RealView
1265 compiler (armcc). */
1266 int producer_is_realview (const char *producer
);
1268 void fixup_section (struct general_symbol_info
*ginfo
,
1269 CORE_ADDR addr
, struct objfile
*objfile
);
1271 struct objfile
*lookup_objfile_from_block (const struct block
*block
);
1273 extern int symtab_create_debug
;
1275 extern int basenames_may_differ
;
1277 int compare_filenames_for_search (const char *filename
,
1278 const char *search_name
);
1280 int iterate_over_some_symtabs (const char *name
,
1281 const char *full_path
,
1282 const char *real_path
,
1283 int (*callback
) (struct symtab
*symtab
,
1286 struct symtab
*first
,
1287 struct symtab
*after_last
);
1289 void iterate_over_symtabs (const char *name
,
1290 int (*callback
) (struct symtab
*symtab
,
1294 DEF_VEC_I (CORE_ADDR
);
1296 VEC (CORE_ADDR
) *find_pcs_for_symtab_line (struct symtab
*symtab
, int line
,
1297 struct linetable_entry
**best_entry
);
1299 /* Callback for LA_ITERATE_OVER_SYMBOLS. The callback will be called
1300 once per matching symbol SYM, with DATA being the argument of the
1301 same name that was passed to LA_ITERATE_OVER_SYMBOLS. The callback
1302 should return nonzero to indicate that LA_ITERATE_OVER_SYMBOLS
1303 should continue iterating, or zero to indicate that the iteration
1306 typedef int (symbol_found_callback_ftype
) (struct symbol
*sym
, void *data
);
1308 void iterate_over_symbols (const struct block
*block
, const char *name
,
1309 const domain_enum domain
,
1310 symbol_found_callback_ftype
*callback
,
1313 struct cleanup
*demangle_for_lookup (const char *name
, enum language lang
,
1314 const char **result_name
);
1316 #endif /* !defined(SYMTAB_H) */