1 /* Symbol table definitions for GDB.
3 Copyright (C) 1986, 1988-2004, 2007-2012 Free Software Foundation,
6 This file is part of GDB.
8 This program is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 3 of the License, or
11 (at your option) any later version.
13 This program is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with this program. If not, see <http://www.gnu.org/licenses/>. */
21 #if !defined (SYMTAB_H)
27 /* Opaque declarations. */
41 /* Some of the structures in this file are space critical.
42 The space-critical structures are:
44 struct general_symbol_info
48 These structures are laid out to encourage good packing.
49 They use ENUM_BITFIELD and short int fields, and they order the
50 structure members so that fields less than a word are next
51 to each other so they can be packed together. */
53 /* Rearranged: used ENUM_BITFIELD and rearranged field order in
54 all the space critical structures (plus struct minimal_symbol).
55 Memory usage dropped from 99360768 bytes to 90001408 bytes.
56 I measured this with before-and-after tests of
57 "HEAD-old-gdb -readnow HEAD-old-gdb" and
58 "HEAD-new-gdb -readnow HEAD-old-gdb" on native i686-pc-linux-gnu,
59 red hat linux 8, with LD_LIBRARY_PATH=/usr/lib/debug,
60 typing "maint space 1" at the first command prompt.
62 Here is another measurement (from andrew c):
63 # no /usr/lib/debug, just plain glibc, like a normal user
65 (gdb) break internal_error
67 (gdb) maint internal-error
71 gdb gdb_6_0_branch 2003-08-19 space used: 8896512
72 gdb HEAD 2003-08-19 space used: 8904704
73 gdb HEAD 2003-08-21 space used: 8396800 (+symtab.h)
74 gdb HEAD 2003-08-21 space used: 8265728 (+gdbtypes.h)
76 The third line shows the savings from the optimizations in symtab.h.
77 The fourth line shows the savings from the optimizations in
78 gdbtypes.h. Both optimizations are in gdb HEAD now.
80 --chastain 2003-08-21 */
82 /* Struct for storing C++ specific information. Allocated when needed. */
86 const char *demangled_name
;
89 /* Define a structure for the information that is common to all symbol types,
90 including minimal symbols, partial symbols, and full symbols. In a
91 multilanguage environment, some language specific information may need to
92 be recorded along with each symbol. */
94 /* This structure is space critical. See space comments at the top. */
96 struct general_symbol_info
98 /* Name of the symbol. This is a required field. Storage for the
99 name is allocated on the objfile_obstack for the associated
100 objfile. For languages like C++ that make a distinction between
101 the mangled name and demangled name, this is the mangled
106 /* Value of the symbol. Which member of this union to use, and what
107 it means, depends on what kind of symbol this is and its
108 SYMBOL_CLASS. See comments there for more details. All of these
109 are in host byte order (though what they point to might be in
110 target byte order, e.g. LOC_CONST_BYTES). */
122 /* For opaque typedef struct chain. */
124 struct symbol
*chain
;
128 /* Since one and only one language can apply, wrap the language specific
129 information inside a union. */
133 /* This is used by languages which wish to store a demangled name.
134 currently used by Ada, Java, and Objective C. */
137 const char *demangled_name
;
141 struct cplus_specific
*cplus_specific
;
145 /* Record the source code language that applies to this symbol.
146 This is used to select one of the fields from the language specific
149 ENUM_BITFIELD(language
) language
: 8;
151 /* Which section is this symbol in? This is an index into
152 section_offsets for this objfile. Negative means that the symbol
153 does not get relocated relative to a section.
154 Disclaimer: currently this is just used for xcoff, so don't
155 expect all symbol-reading code to set it correctly (the ELF code
156 also tries to set it correctly). */
160 /* The section associated with this symbol. It can be NULL. */
162 struct obj_section
*obj_section
;
165 extern void symbol_set_demangled_name (struct general_symbol_info
*, char *,
168 extern const char *symbol_get_demangled_name
169 (const struct general_symbol_info
*);
171 extern CORE_ADDR
symbol_overlayed_address (CORE_ADDR
, struct obj_section
*);
173 /* Note that all the following SYMBOL_* macros are used with the
174 SYMBOL argument being either a partial symbol, a minimal symbol or
175 a full symbol. All three types have a ginfo field. In particular
176 the SYMBOL_SET_LANGUAGE, SYMBOL_DEMANGLED_NAME, etc.
177 macros cannot be entirely substituted by
178 functions, unless the callers are changed to pass in the ginfo
179 field only, instead of the SYMBOL parameter. */
181 #define SYMBOL_VALUE(symbol) (symbol)->ginfo.value.ivalue
182 #define SYMBOL_VALUE_ADDRESS(symbol) (symbol)->ginfo.value.address
183 #define SYMBOL_VALUE_BYTES(symbol) (symbol)->ginfo.value.bytes
184 #define SYMBOL_BLOCK_VALUE(symbol) (symbol)->ginfo.value.block
185 #define SYMBOL_VALUE_CHAIN(symbol) (symbol)->ginfo.value.chain
186 #define SYMBOL_LANGUAGE(symbol) (symbol)->ginfo.language
187 #define SYMBOL_SECTION(symbol) (symbol)->ginfo.section
188 #define SYMBOL_OBJ_SECTION(symbol) (symbol)->ginfo.obj_section
190 /* Initializes the language dependent portion of a symbol
191 depending upon the language for the symbol. */
192 #define SYMBOL_SET_LANGUAGE(symbol,language) \
193 (symbol_set_language (&(symbol)->ginfo, (language)))
194 extern void symbol_set_language (struct general_symbol_info
*symbol
,
195 enum language language
);
197 /* Set just the linkage name of a symbol; do not try to demangle
198 it. Used for constructs which do not have a mangled name,
199 e.g. struct tags. Unlike SYMBOL_SET_NAMES, linkage_name must
200 be terminated and either already on the objfile's obstack or
201 permanently allocated. */
202 #define SYMBOL_SET_LINKAGE_NAME(symbol,linkage_name) \
203 (symbol)->ginfo.name = (linkage_name)
205 /* Set the linkage and natural names of a symbol, by demangling
207 #define SYMBOL_SET_NAMES(symbol,linkage_name,len,copy_name,objfile) \
208 symbol_set_names (&(symbol)->ginfo, linkage_name, len, copy_name, objfile)
209 extern void symbol_set_names (struct general_symbol_info
*symbol
,
210 const char *linkage_name
, int len
, int copy_name
,
211 struct objfile
*objfile
);
213 /* Now come lots of name accessor macros. Short version as to when to
214 use which: Use SYMBOL_NATURAL_NAME to refer to the name of the
215 symbol in the original source code. Use SYMBOL_LINKAGE_NAME if you
216 want to know what the linker thinks the symbol's name is. Use
217 SYMBOL_PRINT_NAME for output. Use SYMBOL_DEMANGLED_NAME if you
218 specifically need to know whether SYMBOL_NATURAL_NAME and
219 SYMBOL_LINKAGE_NAME are different. */
221 /* Return SYMBOL's "natural" name, i.e. the name that it was called in
222 the original source code. In languages like C++ where symbols may
223 be mangled for ease of manipulation by the linker, this is the
226 #define SYMBOL_NATURAL_NAME(symbol) \
227 (symbol_natural_name (&(symbol)->ginfo))
228 extern const char *symbol_natural_name
229 (const struct general_symbol_info
*symbol
);
231 /* Return SYMBOL's name from the point of view of the linker. In
232 languages like C++ where symbols may be mangled for ease of
233 manipulation by the linker, this is the mangled name; otherwise,
234 it's the same as SYMBOL_NATURAL_NAME. */
236 #define SYMBOL_LINKAGE_NAME(symbol) (symbol)->ginfo.name
238 /* Return the demangled name for a symbol based on the language for
239 that symbol. If no demangled name exists, return NULL. */
240 #define SYMBOL_DEMANGLED_NAME(symbol) \
241 (symbol_demangled_name (&(symbol)->ginfo))
242 extern const char *symbol_demangled_name
243 (const struct general_symbol_info
*symbol
);
245 /* Macro that returns a version of the name of a symbol that is
246 suitable for output. In C++ this is the "demangled" form of the
247 name if demangle is on and the "mangled" form of the name if
248 demangle is off. In other languages this is just the symbol name.
249 The result should never be NULL. Don't use this for internal
250 purposes (e.g. storing in a hashtable): it's only suitable for output.
252 N.B. symbol may be anything with a ginfo member,
253 e.g., struct symbol or struct minimal_symbol. */
255 #define SYMBOL_PRINT_NAME(symbol) \
256 (demangle ? SYMBOL_NATURAL_NAME (symbol) : SYMBOL_LINKAGE_NAME (symbol))
259 /* Macro that returns the name to be used when sorting and searching symbols.
260 In C++, Chill, and Java, we search for the demangled form of a name,
261 and so sort symbols accordingly. In Ada, however, we search by mangled
262 name. If there is no distinct demangled name, then SYMBOL_SEARCH_NAME
263 returns the same value (same pointer) as SYMBOL_LINKAGE_NAME. */
264 #define SYMBOL_SEARCH_NAME(symbol) \
265 (symbol_search_name (&(symbol)->ginfo))
266 extern const char *symbol_search_name (const struct general_symbol_info
*);
268 /* Return non-zero if NAME matches the "search" name of SYMBOL.
269 Whitespace and trailing parentheses are ignored.
270 See strcmp_iw for details about its behavior. */
271 #define SYMBOL_MATCHES_SEARCH_NAME(symbol, name) \
272 (strcmp_iw (SYMBOL_SEARCH_NAME (symbol), (name)) == 0)
274 /* Classification types for a minimal symbol. These should be taken as
275 "advisory only", since if gdb can't easily figure out a
276 classification it simply selects mst_unknown. It may also have to
277 guess when it can't figure out which is a better match between two
278 types (mst_data versus mst_bss) for example. Since the minimal
279 symbol info is sometimes derived from the BFD library's view of a
280 file, we need to live with what information bfd supplies. */
282 enum minimal_symbol_type
284 mst_unknown
= 0, /* Unknown type, the default */
285 mst_text
, /* Generally executable instructions */
286 mst_text_gnu_ifunc
, /* Executable code returning address
287 of executable code */
288 mst_slot_got_plt
, /* GOT entries for .plt sections */
289 mst_data
, /* Generally initialized data */
290 mst_bss
, /* Generally uninitialized data */
291 mst_abs
, /* Generally absolute (nonrelocatable) */
292 /* GDB uses mst_solib_trampoline for the start address of a shared
293 library trampoline entry. Breakpoints for shared library functions
294 are put there if the shared library is not yet loaded.
295 After the shared library is loaded, lookup_minimal_symbol will
296 prefer the minimal symbol from the shared library (usually
297 a mst_text symbol) over the mst_solib_trampoline symbol, and the
298 breakpoints will be moved to their true address in the shared
299 library via breakpoint_re_set. */
300 mst_solib_trampoline
, /* Shared library trampoline code */
301 /* For the mst_file* types, the names are only guaranteed to be unique
302 within a given .o file. */
303 mst_file_text
, /* Static version of mst_text */
304 mst_file_data
, /* Static version of mst_data */
305 mst_file_bss
/* Static version of mst_bss */
308 /* Define a simple structure used to hold some very basic information about
309 all defined global symbols (text, data, bss, abs, etc). The only required
310 information is the general_symbol_info.
312 In many cases, even if a file was compiled with no special options for
313 debugging at all, as long as was not stripped it will contain sufficient
314 information to build a useful minimal symbol table using this structure.
315 Even when a file contains enough debugging information to build a full
316 symbol table, these minimal symbols are still useful for quickly mapping
317 between names and addresses, and vice versa. They are also sometimes
318 used to figure out what full symbol table entries need to be read in. */
320 struct minimal_symbol
323 /* The general symbol info required for all types of symbols.
325 The SYMBOL_VALUE_ADDRESS contains the address that this symbol
328 struct general_symbol_info ginfo
;
330 /* Size of this symbol. end_psymtab in dbxread.c uses this
331 information to calculate the end of the partial symtab based on the
332 address of the last symbol plus the size of the last symbol. */
336 /* Which source file is this symbol in? Only relevant for mst_file_*. */
337 const char *filename
;
339 /* Classification type for this minimal symbol. */
341 ENUM_BITFIELD(minimal_symbol_type
) type
: 8;
343 /* Non-zero if this symbol was created by gdb.
344 Such symbols do not appear in the output of "info var|fun". */
345 unsigned int created_by_gdb
: 1;
347 /* Two flag bits provided for the use of the target. */
348 unsigned int target_flag_1
: 1;
349 unsigned int target_flag_2
: 1;
351 /* Nonzero iff the size of the minimal symbol has been set.
352 Symbol size information can sometimes not be determined, because
353 the object file format may not carry that piece of information. */
354 unsigned int has_size
: 1;
356 /* Minimal symbols with the same hash key are kept on a linked
357 list. This is the link. */
359 struct minimal_symbol
*hash_next
;
361 /* Minimal symbols are stored in two different hash tables. This is
362 the `next' pointer for the demangled hash table. */
364 struct minimal_symbol
*demangled_hash_next
;
367 #define MSYMBOL_TARGET_FLAG_1(msymbol) (msymbol)->target_flag_1
368 #define MSYMBOL_TARGET_FLAG_2(msymbol) (msymbol)->target_flag_2
369 #define MSYMBOL_SIZE(msymbol) ((msymbol)->size + 0)
370 #define SET_MSYMBOL_SIZE(msymbol, sz) \
373 (msymbol)->size = sz; \
374 (msymbol)->has_size = 1; \
376 #define MSYMBOL_HAS_SIZE(msymbol) ((msymbol)->has_size + 0)
377 #define MSYMBOL_TYPE(msymbol) (msymbol)->type
383 /* Represent one symbol name; a variable, constant, function or typedef. */
385 /* Different name domains for symbols. Looking up a symbol specifies a
386 domain and ignores symbol definitions in other name domains. */
388 typedef enum domain_enum_tag
390 /* UNDEF_DOMAIN is used when a domain has not been discovered or
391 none of the following apply. This usually indicates an error either
392 in the symbol information or in gdb's handling of symbols. */
396 /* VAR_DOMAIN is the usual domain. In C, this contains variables,
397 function names, typedef names and enum type values. */
401 /* STRUCT_DOMAIN is used in C to hold struct, union and enum type names.
402 Thus, if `struct foo' is used in a C program, it produces a symbol named
403 `foo' in the STRUCT_DOMAIN. */
407 /* LABEL_DOMAIN may be used for names of labels (for gotos). */
412 /* Searching domains, used for `search_symbols'. Element numbers are
413 hardcoded in GDB, check all enum uses before changing it. */
417 /* Everything in VAR_DOMAIN minus FUNCTIONS_DOMAIN and
419 VARIABLES_DOMAIN
= 0,
421 /* All functions -- for some reason not methods, though. */
422 FUNCTIONS_DOMAIN
= 1,
424 /* All defined types */
431 /* An address-class says where to find the value of a symbol. */
435 /* Not used; catches errors. */
439 /* Value is constant int SYMBOL_VALUE, host byteorder. */
443 /* Value is at fixed address SYMBOL_VALUE_ADDRESS. */
447 /* Value is in register. SYMBOL_VALUE is the register number
448 in the original debug format. SYMBOL_REGISTER_OPS holds a
449 function that can be called to transform this into the
450 actual register number this represents in a specific target
451 architecture (gdbarch).
453 For some symbol formats (stabs, for some compilers at least),
454 the compiler generates two symbols, an argument and a register.
455 In some cases we combine them to a single LOC_REGISTER in symbol
456 reading, but currently not for all cases (e.g. it's passed on the
457 stack and then loaded into a register). */
461 /* It's an argument; the value is at SYMBOL_VALUE offset in arglist. */
465 /* Value address is at SYMBOL_VALUE offset in arglist. */
469 /* Value is in specified register. Just like LOC_REGISTER except the
470 register holds the address of the argument instead of the argument
471 itself. This is currently used for the passing of structs and unions
472 on sparc and hppa. It is also used for call by reference where the
473 address is in a register, at least by mipsread.c. */
477 /* Value is a local variable at SYMBOL_VALUE offset in stack frame. */
481 /* Value not used; definition in SYMBOL_TYPE. Symbols in the domain
482 STRUCT_DOMAIN all have this class. */
486 /* Value is address SYMBOL_VALUE_ADDRESS in the code. */
490 /* In a symbol table, value is SYMBOL_BLOCK_VALUE of a `struct block'.
491 In a partial symbol table, SYMBOL_VALUE_ADDRESS is the start address
492 of the block. Function names have this class. */
496 /* Value is a constant byte-sequence pointed to by SYMBOL_VALUE_BYTES, in
497 target byte order. */
501 /* Value is at fixed address, but the address of the variable has
502 to be determined from the minimal symbol table whenever the
503 variable is referenced.
504 This happens if debugging information for a global symbol is
505 emitted and the corresponding minimal symbol is defined
506 in another object file or runtime common storage.
507 The linker might even remove the minimal symbol if the global
508 symbol is never referenced, in which case the symbol remains
511 GDB would normally find the symbol in the minimal symbol table if it will
512 not find it in the full symbol table. But a reference to an external
513 symbol in a local block shadowing other definition requires full symbol
514 without possibly having its address available for LOC_STATIC. Testcase
515 is provided as `gdb.dwarf2/dw2-unresolved.exp'. */
519 /* The variable does not actually exist in the program.
520 The value is ignored. */
524 /* The variable's address is computed by a set of location
525 functions (see "struct symbol_computed_ops" below). */
529 /* The methods needed to implement LOC_COMPUTED. These methods can
530 use the symbol's .aux_value for additional per-symbol information.
532 At present this is only used to implement location expressions. */
534 struct symbol_computed_ops
537 /* Return the value of the variable SYMBOL, relative to the stack
538 frame FRAME. If the variable has been optimized out, return
541 Iff `read_needs_frame (SYMBOL)' is zero, then FRAME may be zero. */
543 struct value
*(*read_variable
) (struct symbol
* symbol
,
544 struct frame_info
* frame
);
546 /* Read variable SYMBOL like read_variable at (callee) FRAME's function
547 entry. SYMBOL should be a function parameter, otherwise
548 NO_ENTRY_VALUE_ERROR will be thrown. */
549 struct value
*(*read_variable_at_entry
) (struct symbol
*symbol
,
550 struct frame_info
*frame
);
552 /* Return non-zero if we need a frame to find the value of the SYMBOL. */
553 int (*read_needs_frame
) (struct symbol
* symbol
);
555 /* Write to STREAM a natural-language description of the location of
556 SYMBOL, in the context of ADDR. */
557 void (*describe_location
) (struct symbol
* symbol
, CORE_ADDR addr
,
558 struct ui_file
* stream
);
560 /* Tracepoint support. Append bytecodes to the tracepoint agent
561 expression AX that push the address of the object SYMBOL. Set
562 VALUE appropriately. Note --- for objects in registers, this
563 needn't emit any code; as long as it sets VALUE properly, then
564 the caller will generate the right code in the process of
565 treating this as an lvalue or rvalue. */
567 void (*tracepoint_var_ref
) (struct symbol
*symbol
, struct gdbarch
*gdbarch
,
568 struct agent_expr
*ax
, struct axs_value
*value
);
571 /* Functions used with LOC_REGISTER and LOC_REGPARM_ADDR. */
573 struct symbol_register_ops
575 int (*register_number
) (struct symbol
*symbol
, struct gdbarch
*gdbarch
);
578 /* This structure is space critical. See space comments at the top. */
583 /* The general symbol info required for all types of symbols. */
585 struct general_symbol_info ginfo
;
587 /* Data type of value */
591 /* The symbol table containing this symbol. This is the file
592 associated with LINE. It can be NULL during symbols read-in but it is
593 never NULL during normal operation. */
594 struct symtab
*symtab
;
598 ENUM_BITFIELD(domain_enum_tag
) domain
: 6;
601 /* NOTE: cagney/2003-11-02: The fields "aclass" and "ops" contain
602 overlapping information. By creating a per-aclass ops vector, or
603 using the aclass as an index into an ops table, the aclass and
604 ops fields can be merged. The latter, for instance, would shave
605 32-bits from each symbol (relative to a symbol lookup, any table
606 index overhead would be in the noise). */
608 ENUM_BITFIELD(address_class
) aclass
: 6;
610 /* Whether this is an argument. */
612 unsigned is_argument
: 1;
614 /* Whether this is an inlined function (class LOC_BLOCK only). */
615 unsigned is_inlined
: 1;
617 /* True if this is a C++ function symbol with template arguments.
618 In this case the symbol is really a "struct template_symbol". */
619 unsigned is_cplus_template_function
: 1;
621 /* Line number of this symbol's definition, except for inlined
622 functions. For an inlined function (class LOC_BLOCK and
623 SYMBOL_INLINED set) this is the line number of the function's call
624 site. Inlined function symbols are not definitions, and they are
625 never found by symbol table lookup.
627 FIXME: Should we really make the assumption that nobody will try
628 to debug files longer than 64K lines? What about machine
629 generated programs? */
633 /* Method's for symbol's of this class. */
634 /* NOTE: cagney/2003-11-02: See comment above attached to "aclass". */
638 /* Used with LOC_COMPUTED. */
639 const struct symbol_computed_ops
*ops_computed
;
641 /* Used with LOC_REGISTER and LOC_REGPARM_ADDR. */
642 const struct symbol_register_ops
*ops_register
;
645 /* An arbitrary data pointer, allowing symbol readers to record
646 additional information on a per-symbol basis. Note that this data
647 must be allocated using the same obstack as the symbol itself. */
648 /* So far it is only used by LOC_COMPUTED to
649 find the location information. For a LOC_BLOCK symbol
650 for a function in a compilation unit compiled with DWARF 2
651 information, this is information used internally by the DWARF 2
652 code --- specifically, the location expression for the frame
653 base for this function. */
654 /* FIXME drow/2003-02-21: For the LOC_BLOCK case, it might be better
655 to add a magic symbol to the block containing this information,
656 or to have a generic debug info annotation slot for symbols. */
660 struct symbol
*hash_next
;
664 #define SYMBOL_DOMAIN(symbol) (symbol)->domain
665 #define SYMBOL_CLASS(symbol) (symbol)->aclass
666 #define SYMBOL_IS_ARGUMENT(symbol) (symbol)->is_argument
667 #define SYMBOL_INLINED(symbol) (symbol)->is_inlined
668 #define SYMBOL_IS_CPLUS_TEMPLATE_FUNCTION(symbol) \
669 (symbol)->is_cplus_template_function
670 #define SYMBOL_TYPE(symbol) (symbol)->type
671 #define SYMBOL_LINE(symbol) (symbol)->line
672 #define SYMBOL_SYMTAB(symbol) (symbol)->symtab
673 #define SYMBOL_COMPUTED_OPS(symbol) (symbol)->ops.ops_computed
674 #define SYMBOL_REGISTER_OPS(symbol) (symbol)->ops.ops_register
675 #define SYMBOL_LOCATION_BATON(symbol) (symbol)->aux_value
677 /* An instance of this type is used to represent a C++ template
678 function. It includes a "struct symbol" as a kind of base class;
679 users downcast to "struct template_symbol *" when needed. A symbol
680 is really of this type iff SYMBOL_IS_CPLUS_TEMPLATE_FUNCTION is
683 struct template_symbol
685 /* The base class. */
688 /* The number of template arguments. */
689 int n_template_arguments
;
691 /* The template arguments. This is an array with
692 N_TEMPLATE_ARGUMENTS elements. */
693 struct symbol
**template_arguments
;
697 /* Each item represents a line-->pc (or the reverse) mapping. This is
698 somewhat more wasteful of space than one might wish, but since only
699 the files which are actually debugged are read in to core, we don't
702 struct linetable_entry
708 /* The order of entries in the linetable is significant. They should
709 be sorted by increasing values of the pc field. If there is more than
710 one entry for a given pc, then I'm not sure what should happen (and
711 I not sure whether we currently handle it the best way).
713 Example: a C for statement generally looks like this
715 10 0x100 - for the init/test part of a for stmt.
718 10 0x400 - for the increment part of a for stmt.
720 If an entry has a line number of zero, it marks the start of a PC
721 range for which no line number information is available. It is
722 acceptable, though wasteful of table space, for such a range to be
729 /* Actually NITEMS elements. If you don't like this use of the
730 `struct hack', you can shove it up your ANSI (seriously, if the
731 committee tells us how to do it, we can probably go along). */
732 struct linetable_entry item
[1];
735 /* How to relocate the symbols from each section in a symbol file.
736 Each struct contains an array of offsets.
737 The ordering and meaning of the offsets is file-type-dependent;
738 typically it is indexed by section numbers or symbol types or
741 To give us flexibility in changing the internal representation
742 of these offsets, the ANOFFSET macro must be used to insert and
743 extract offset values in the struct. */
745 struct section_offsets
747 CORE_ADDR offsets
[1]; /* As many as needed. */
750 #define ANOFFSET(secoff, whichone) \
752 ? (internal_error (__FILE__, __LINE__, \
753 _("Section index is uninitialized")), -1) \
754 : secoff->offsets[whichone])
756 /* The size of a section_offsets table for N sections. */
757 #define SIZEOF_N_SECTION_OFFSETS(n) \
758 (sizeof (struct section_offsets) \
759 + sizeof (((struct section_offsets *) 0)->offsets) * ((n)-1))
761 /* Each source file or header is represented by a struct symtab.
762 These objects are chained through the `next' field. */
766 /* Unordered chain of all existing symtabs of this objfile. */
770 /* List of all symbol scope blocks for this symtab. May be shared
771 between different symtabs (and normally is for all the symtabs
772 in a given compilation unit). */
774 struct blockvector
*blockvector
;
776 /* Table mapping core addresses to line numbers for this file.
777 Can be NULL if none. Never shared between different symtabs. */
779 struct linetable
*linetable
;
781 /* Section in objfile->section_offsets for the blockvector and
782 the linetable. Probably always SECT_OFF_TEXT. */
784 int block_line_section
;
786 /* If several symtabs share a blockvector, exactly one of them
787 should be designated the primary, so that the blockvector
788 is relocated exactly once by objfile_relocate. */
790 unsigned int primary
: 1;
792 /* Symtab has been compiled with both optimizations and debug info so that
793 GDB may stop skipping prologues as variables locations are valid already
794 at function entry points. */
796 unsigned int locations_valid
: 1;
798 /* DWARF unwinder for this CU is valid even for epilogues (PC at the return
799 instruction). This is supported by GCC since 4.5.0. */
801 unsigned int epilogue_unwind_valid
: 1;
803 /* The macro table for this symtab. Like the blockvector, this
804 may be shared between different symtabs --- and normally is for
805 all the symtabs in a given compilation unit. */
806 struct macro_table
*macro_table
;
808 /* Name of this source file. */
812 /* Directory in which it was compiled, or NULL if we don't know. */
816 /* Total number of lines found in source file. */
820 /* line_charpos[N] is the position of the (N-1)th line of the
821 source file. "position" means something we can lseek() to; it
822 is not guaranteed to be useful any other way. */
826 /* Language of this source file. */
828 enum language language
;
830 /* String that identifies the format of the debugging information, such
831 as "stabs", "dwarf 1", "dwarf 2", "coff", etc. This is mostly useful
832 for automated testing of gdb but may also be information that is
833 useful to the user. */
835 const char *debugformat
;
837 /* String of producer version information. May be zero. */
839 const char *producer
;
841 /* Full name of file as found by searching the source path.
842 NULL if not yet known. */
846 /* Object file from which this symbol information was read. */
848 struct objfile
*objfile
;
850 /* struct call_site entries for this compilation unit or NULL. */
852 htab_t call_site_htab
;
854 /* If non-NULL, then this points to a NULL-terminated vector of
855 included symbol tables. When searching the static or global
856 block of this symbol table, the corresponding block of all
857 included symbol tables will also be searched. Note that this
858 list must be flattened -- the symbol reader is responsible for
859 ensuring that this vector contains the transitive closure of all
860 included symbol tables. */
862 struct symtab
**includes
;
864 /* If this is an included symbol table, this points to one includer
865 of the table. This user is considered the canonical symbol table
866 containing this one. An included symbol table may itself be
867 included by another. */
872 #define BLOCKVECTOR(symtab) (symtab)->blockvector
873 #define LINETABLE(symtab) (symtab)->linetable
874 #define SYMTAB_PSPACE(symtab) (symtab)->objfile->pspace
877 /* The virtual function table is now an array of structures which have the
878 form { int16 offset, delta; void *pfn; }.
880 In normal virtual function tables, OFFSET is unused.
881 DELTA is the amount which is added to the apparent object's base
882 address in order to point to the actual object to which the
883 virtual function should be applied.
884 PFN is a pointer to the virtual function.
886 Note that this macro is g++ specific (FIXME). */
888 #define VTBL_FNADDR_OFFSET 2
890 /* External variables and functions for the objects described above. */
892 /* True if we are nested inside psymtab_to_symtab. */
894 extern int currently_reading_symtab
;
896 /* symtab.c lookup functions */
898 extern const char multiple_symbols_ask
[];
899 extern const char multiple_symbols_all
[];
900 extern const char multiple_symbols_cancel
[];
902 const char *multiple_symbols_select_mode (void);
904 int symbol_matches_domain (enum language symbol_language
,
905 domain_enum symbol_domain
,
908 /* lookup a symbol table by source file name. */
910 extern struct symtab
*lookup_symtab (const char *);
912 /* lookup a symbol by name (optional block) in language. */
914 extern struct symbol
*lookup_symbol_in_language (const char *,
915 const struct block
*,
920 /* lookup a symbol by name (optional block, optional symtab)
921 in the current language. */
923 extern struct symbol
*lookup_symbol (const char *, const struct block
*,
924 const domain_enum
, int *);
926 /* A default version of lookup_symbol_nonlocal for use by languages
927 that can't think of anything better to do. */
929 extern struct symbol
*basic_lookup_symbol_nonlocal (const char *,
930 const struct block
*,
933 /* Some helper functions for languages that need to write their own
934 lookup_symbol_nonlocal functions. */
936 /* Lookup a symbol in the static block associated to BLOCK, if there
937 is one; do nothing if BLOCK is NULL or a global block. */
939 extern struct symbol
*lookup_symbol_static (const char *name
,
940 const struct block
*block
,
941 const domain_enum domain
);
943 /* Lookup a symbol in all files' global blocks (searching psymtabs if
946 extern struct symbol
*lookup_symbol_global (const char *name
,
947 const struct block
*block
,
948 const domain_enum domain
);
950 /* Lookup a symbol within the block BLOCK. This, unlike
951 lookup_symbol_block, will set SYMTAB and BLOCK_FOUND correctly, and
952 will fix up the symbol if necessary. */
954 extern struct symbol
*lookup_symbol_aux_block (const char *name
,
955 const struct block
*block
,
956 const domain_enum domain
);
958 extern struct symbol
*lookup_language_this (const struct language_defn
*lang
,
959 const struct block
*block
);
961 /* Lookup a symbol only in the file static scope of all the objfiles. */
963 struct symbol
*lookup_static_symbol_aux (const char *name
,
964 const domain_enum domain
);
967 /* lookup a symbol by name, within a specified block. */
969 extern struct symbol
*lookup_block_symbol (const struct block
*, const char *,
972 /* lookup a [struct, union, enum] by name, within a specified block. */
974 extern struct type
*lookup_struct (const char *, struct block
*);
976 extern struct type
*lookup_union (const char *, struct block
*);
978 extern struct type
*lookup_enum (const char *, struct block
*);
980 /* from blockframe.c: */
982 /* lookup the function symbol corresponding to the address. */
984 extern struct symbol
*find_pc_function (CORE_ADDR
);
986 /* lookup the function corresponding to the address and section. */
988 extern struct symbol
*find_pc_sect_function (CORE_ADDR
, struct obj_section
*);
990 extern int find_pc_partial_function_gnu_ifunc (CORE_ADDR pc
, const char **name
,
993 int *is_gnu_ifunc_p
);
995 /* lookup function from address, return name, start addr and end addr. */
997 extern int find_pc_partial_function (CORE_ADDR
, const char **, CORE_ADDR
*,
1000 extern void clear_pc_function_cache (void);
1002 /* lookup partial symbol table by address and section. */
1004 extern struct symtab
*find_pc_sect_symtab_via_partial (CORE_ADDR
,
1005 struct obj_section
*);
1007 /* lookup full symbol table by address. */
1009 extern struct symtab
*find_pc_symtab (CORE_ADDR
);
1011 /* lookup full symbol table by address and section. */
1013 extern struct symtab
*find_pc_sect_symtab (CORE_ADDR
, struct obj_section
*);
1015 extern int find_pc_line_pc_range (CORE_ADDR
, CORE_ADDR
*, CORE_ADDR
*);
1017 extern void reread_symbols (void);
1019 extern struct type
*lookup_transparent_type (const char *);
1020 extern struct type
*basic_lookup_transparent_type (const char *);
1023 /* Macro for name of symbol to indicate a file compiled with gcc. */
1024 #ifndef GCC_COMPILED_FLAG_SYMBOL
1025 #define GCC_COMPILED_FLAG_SYMBOL "gcc_compiled."
1028 /* Macro for name of symbol to indicate a file compiled with gcc2. */
1029 #ifndef GCC2_COMPILED_FLAG_SYMBOL
1030 #define GCC2_COMPILED_FLAG_SYMBOL "gcc2_compiled."
1033 extern int in_gnu_ifunc_stub (CORE_ADDR pc
);
1035 /* Functions for resolving STT_GNU_IFUNC symbols which are implemented only
1036 for ELF symbol files. */
1038 struct gnu_ifunc_fns
1040 /* See elf_gnu_ifunc_resolve_addr for its real implementation. */
1041 CORE_ADDR (*gnu_ifunc_resolve_addr
) (struct gdbarch
*gdbarch
, CORE_ADDR pc
);
1043 /* See elf_gnu_ifunc_resolve_name for its real implementation. */
1044 int (*gnu_ifunc_resolve_name
) (const char *function_name
,
1045 CORE_ADDR
*function_address_p
);
1047 /* See elf_gnu_ifunc_resolver_stop for its real implementation. */
1048 void (*gnu_ifunc_resolver_stop
) (struct breakpoint
*b
);
1050 /* See elf_gnu_ifunc_resolver_return_stop for its real implementation. */
1051 void (*gnu_ifunc_resolver_return_stop
) (struct breakpoint
*b
);
1054 #define gnu_ifunc_resolve_addr gnu_ifunc_fns_p->gnu_ifunc_resolve_addr
1055 #define gnu_ifunc_resolve_name gnu_ifunc_fns_p->gnu_ifunc_resolve_name
1056 #define gnu_ifunc_resolver_stop gnu_ifunc_fns_p->gnu_ifunc_resolver_stop
1057 #define gnu_ifunc_resolver_return_stop \
1058 gnu_ifunc_fns_p->gnu_ifunc_resolver_return_stop
1060 extern const struct gnu_ifunc_fns
*gnu_ifunc_fns_p
;
1062 extern CORE_ADDR
find_solib_trampoline_target (struct frame_info
*, CORE_ADDR
);
1064 struct symtab_and_line
1066 /* The program space of this sal. */
1067 struct program_space
*pspace
;
1069 struct symtab
*symtab
;
1070 struct obj_section
*section
;
1071 /* Line number. Line numbers start at 1 and proceed through symtab->nlines.
1072 0 is never a valid line number; it is used to indicate that line number
1073 information is not available. */
1081 /* The probe associated with this symtab_and_line. */
1082 struct probe
*probe
;
1085 extern void init_sal (struct symtab_and_line
*sal
);
1087 struct symtabs_and_lines
1089 struct symtab_and_line
*sals
;
1095 /* Some types and macros needed for exception catchpoints.
1096 Can't put these in target.h because symtab_and_line isn't
1097 known there. This file will be included by breakpoint.c,
1098 hppa-tdep.c, etc. */
1100 /* Enums for exception-handling support. */
1101 enum exception_event_kind
1109 /* Given a pc value, return line number it is in. Second arg nonzero means
1110 if pc is on the boundary use the previous statement's line number. */
1112 extern struct symtab_and_line
find_pc_line (CORE_ADDR
, int);
1114 /* Same function, but specify a section as well as an address. */
1116 extern struct symtab_and_line
find_pc_sect_line (CORE_ADDR
,
1117 struct obj_section
*, int);
1119 /* Given a symtab and line number, return the pc there. */
1121 extern int find_line_pc (struct symtab
*, int, CORE_ADDR
*);
1123 extern int find_line_pc_range (struct symtab_and_line
, CORE_ADDR
*,
1126 extern void resolve_sal_pc (struct symtab_and_line
*);
1130 void maintenance_print_symbols (char *, int);
1132 void maintenance_print_psymbols (char *, int);
1134 void maintenance_print_msymbols (char *, int);
1136 void maintenance_print_objfiles (char *, int);
1138 void maintenance_info_symtabs (char *, int);
1140 void maintenance_info_psymtabs (char *, int);
1142 void maintenance_check_symtabs (char *, int);
1146 void maintenance_print_statistics (char *, int);
1148 /* Symbol-reading stuff in symfile.c and solib.c. */
1150 extern void clear_solib (void);
1154 extern int identify_source_line (struct symtab
*, int, int, CORE_ADDR
);
1156 extern void print_source_lines (struct symtab
*, int, int, int);
1158 extern void forget_cached_source_info_for_objfile (struct objfile
*);
1159 extern void forget_cached_source_info (void);
1161 extern void select_source_symtab (struct symtab
*);
1163 extern VEC (char_ptr
) *default_make_symbol_completion_list_break_on
1164 (char *text
, char *word
, const char *break_on
);
1165 extern VEC (char_ptr
) *default_make_symbol_completion_list (char *, char *);
1166 extern VEC (char_ptr
) *make_symbol_completion_list (char *, char *);
1167 extern VEC (char_ptr
) *make_symbol_completion_list_fn (struct cmd_list_element
*,
1170 extern VEC (char_ptr
) *make_file_symbol_completion_list (char *,
1173 extern VEC (char_ptr
) *make_source_files_completion_list (char *, char *);
1177 int matching_obj_sections (struct obj_section
*, struct obj_section
*);
1179 extern const char *find_main_filename (void);
1181 extern struct symtab
*find_line_symtab (struct symtab
*, int, int *, int *);
1183 extern struct symtab_and_line
find_function_start_sal (struct symbol
*sym
,
1186 extern void skip_prologue_sal (struct symtab_and_line
*);
1190 extern void clear_symtab_users (int add_flags
);
1192 extern enum language
deduce_language_from_filename (const char *);
1196 extern int in_prologue (struct gdbarch
*gdbarch
,
1197 CORE_ADDR pc
, CORE_ADDR func_start
);
1199 extern CORE_ADDR
skip_prologue_using_sal (struct gdbarch
*gdbarch
,
1200 CORE_ADDR func_addr
);
1202 extern struct symbol
*fixup_symbol_section (struct symbol
*,
1205 /* Symbol searching */
1207 /* When using search_symbols, a list of the following structs is returned.
1208 Callers must free the search list using free_search_symbols! */
1209 struct symbol_search
1211 /* The block in which the match was found. Could be, for example,
1212 STATIC_BLOCK or GLOBAL_BLOCK. */
1215 /* Information describing what was found.
1217 If symtab abd symbol are NOT NULL, then information was found
1219 struct symtab
*symtab
;
1220 struct symbol
*symbol
;
1222 /* If msymbol is non-null, then a match was made on something for
1223 which only minimal_symbols exist. */
1224 struct minimal_symbol
*msymbol
;
1226 /* A link to the next match, or NULL for the end. */
1227 struct symbol_search
*next
;
1230 extern void search_symbols (char *, enum search_domain
, int, char **,
1231 struct symbol_search
**);
1232 extern void free_search_symbols (struct symbol_search
*);
1233 extern struct cleanup
*make_cleanup_free_search_symbols (struct symbol_search
1236 /* The name of the ``main'' function.
1237 FIXME: cagney/2001-03-20: Can't make main_name() const since some
1238 of the calling code currently assumes that the string isn't
1240 extern void set_main_name (const char *name
);
1241 extern /*const */ char *main_name (void);
1242 extern enum language language_of_main
;
1244 /* Check global symbols in objfile. */
1245 struct symbol
*lookup_global_symbol_from_objfile (const struct objfile
*,
1247 const domain_enum domain
);
1249 /* Return 1 if the supplied producer string matches the ARM RealView
1250 compiler (armcc). */
1251 int producer_is_realview (const char *producer
);
1253 void fixup_section (struct general_symbol_info
*ginfo
,
1254 CORE_ADDR addr
, struct objfile
*objfile
);
1256 struct objfile
*lookup_objfile_from_block (const struct block
*block
);
1258 extern int symtab_create_debug
;
1260 extern int basenames_may_differ
;
1262 int compare_filenames_for_search (const char *filename
,
1263 const char *search_name
,
1266 int iterate_over_some_symtabs (const char *name
,
1267 const char *full_path
,
1268 const char *real_path
,
1269 int (*callback
) (struct symtab
*symtab
,
1272 struct symtab
*first
,
1273 struct symtab
*after_last
);
1275 void iterate_over_symtabs (const char *name
,
1276 int (*callback
) (struct symtab
*symtab
,
1280 DEF_VEC_I (CORE_ADDR
);
1282 VEC (CORE_ADDR
) *find_pcs_for_symtab_line (struct symtab
*symtab
, int line
,
1283 struct linetable_entry
**best_entry
);
1285 /* Callback for LA_ITERATE_OVER_SYMBOLS. The callback will be called
1286 once per matching symbol SYM, with DATA being the argument of the
1287 same name that was passed to LA_ITERATE_OVER_SYMBOLS. The callback
1288 should return nonzero to indicate that LA_ITERATE_OVER_SYMBOLS
1289 should continue iterating, or zero to indicate that the iteration
1292 typedef int (symbol_found_callback_ftype
) (struct symbol
*sym
, void *data
);
1294 void iterate_over_symbols (const struct block
*block
, const char *name
,
1295 const domain_enum domain
,
1296 symbol_found_callback_ftype
*callback
,
1299 struct cleanup
*demangle_for_lookup (const char *name
, enum language lang
,
1300 const char **result_name
);
1302 #endif /* !defined(SYMTAB_H) */