1 /* Symbol table definitions for GDB.
3 Copyright (C) 1986, 1988, 1989, 1990, 1991, 1992, 1993, 1994, 1995, 1996,
4 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2007, 2008, 2009, 2010
5 Free Software Foundation, Inc.
7 This file is part of GDB.
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 3 of the License, or
12 (at your option) any later version.
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
19 You should have received a copy of the GNU General Public License
20 along with this program. If not, see <http://www.gnu.org/licenses/>. */
22 #if !defined (SYMTAB_H)
25 /* Opaque declarations. */
37 /* Some of the structures in this file are space critical.
38 The space-critical structures are:
40 struct general_symbol_info
44 These structures are laid out to encourage good packing.
45 They use ENUM_BITFIELD and short int fields, and they order the
46 structure members so that fields less than a word are next
47 to each other so they can be packed together. */
49 /* Rearranged: used ENUM_BITFIELD and rearranged field order in
50 all the space critical structures (plus struct minimal_symbol).
51 Memory usage dropped from 99360768 bytes to 90001408 bytes.
52 I measured this with before-and-after tests of
53 "HEAD-old-gdb -readnow HEAD-old-gdb" and
54 "HEAD-new-gdb -readnow HEAD-old-gdb" on native i686-pc-linux-gnu,
55 red hat linux 8, with LD_LIBRARY_PATH=/usr/lib/debug,
56 typing "maint space 1" at the first command prompt.
58 Here is another measurement (from andrew c):
59 # no /usr/lib/debug, just plain glibc, like a normal user
61 (gdb) break internal_error
63 (gdb) maint internal-error
67 gdb gdb_6_0_branch 2003-08-19 space used: 8896512
68 gdb HEAD 2003-08-19 space used: 8904704
69 gdb HEAD 2003-08-21 space used: 8396800 (+symtab.h)
70 gdb HEAD 2003-08-21 space used: 8265728 (+gdbtypes.h)
72 The third line shows the savings from the optimizations in symtab.h.
73 The fourth line shows the savings from the optimizations in
74 gdbtypes.h. Both optimizations are in gdb HEAD now.
76 --chastain 2003-08-21 */
80 /* Define a structure for the information that is common to all symbol types,
81 including minimal symbols, partial symbols, and full symbols. In a
82 multilanguage environment, some language specific information may need to
83 be recorded along with each symbol. */
85 /* This structure is space critical. See space comments at the top. */
87 struct general_symbol_info
89 /* Name of the symbol. This is a required field. Storage for the
90 name is allocated on the objfile_obstack for the associated
91 objfile. For languages like C++ that make a distinction between
92 the mangled name and demangled name, this is the mangled
97 /* Value of the symbol. Which member of this union to use, and what
98 it means, depends on what kind of symbol this is and its
99 SYMBOL_CLASS. See comments there for more details. All of these
100 are in host byte order (though what they point to might be in
101 target byte order, e.g. LOC_CONST_BYTES). */
105 /* The fact that this is a long not a LONGEST mainly limits the
106 range of a LOC_CONST. Since LOC_CONST_BYTES exists, I'm not
107 sure that is a big deal. */
116 /* for opaque typedef struct chain */
118 struct symbol *chain;
122 /* Since one and only one language can apply, wrap the language specific
123 information inside a union. */
127 struct cplus_specific
129 /* This is in fact used for C++, Java, and Objective C. */
130 char *demangled_name;
136 /* Record the source code language that applies to this symbol.
137 This is used to select one of the fields from the language specific
140 ENUM_BITFIELD(language) language : 8;
142 /* Which section is this symbol in? This is an index into
143 section_offsets for this objfile. Negative means that the symbol
144 does not get relocated relative to a section.
145 Disclaimer: currently this is just used for xcoff, so don't
146 expect all symbol-reading code to set it correctly (the ELF code
147 also tries to set it correctly). */
151 /* The section associated with this symbol. */
153 struct obj_section *obj_section;
156 extern CORE_ADDR symbol_overlayed_address (CORE_ADDR, struct obj_section *);
158 /* Note that all the following SYMBOL_* macros are used with the
159 SYMBOL argument being either a partial symbol, a minimal symbol or
160 a full symbol. All three types have a ginfo field. In particular
161 the SYMBOL_INIT_LANGUAGE_SPECIFIC, SYMBOL_DEMANGLED_NAME, etc.
162 macros cannot be entirely substituted by
163 functions, unless the callers are changed to pass in the ginfo
164 field only, instead of the SYMBOL parameter. */
166 #define SYMBOL_VALUE(symbol) (symbol)->ginfo.value.ivalue
167 #define SYMBOL_VALUE_ADDRESS(symbol) (symbol)->ginfo.value.address
168 #define SYMBOL_VALUE_BYTES(symbol) (symbol)->ginfo.value.bytes
169 #define SYMBOL_BLOCK_VALUE(symbol) (symbol)->ginfo.value.block
170 #define SYMBOL_VALUE_CHAIN(symbol) (symbol)->ginfo.value.chain
171 #define SYMBOL_LANGUAGE(symbol) (symbol)->ginfo.language
172 #define SYMBOL_SECTION(symbol) (symbol)->ginfo.section
173 #define SYMBOL_OBJ_SECTION(symbol) (symbol)->ginfo.obj_section
175 /* Initializes the language dependent portion of a symbol
176 depending upon the language for the symbol. */
177 #define SYMBOL_INIT_LANGUAGE_SPECIFIC(symbol,language) \
178 (symbol_init_language_specific (&(symbol)->ginfo, (language)))
179 extern void symbol_init_language_specific (struct general_symbol_info *symbol,
180 enum language language);
182 /* Set just the linkage name of a symbol; do not try to demangle
183 it. Used for constructs which do not have a mangled name,
184 e.g. struct tags. Unlike SYMBOL_SET_NAMES, linkage_name must
185 be terminated and either already on the objfile's obstack or
186 permanently allocated. */
187 #define SYMBOL_SET_LINKAGE_NAME(symbol,linkage_name) \
188 (symbol)->ginfo.name = (linkage_name)
190 /* Set the linkage and natural names of a symbol, by demangling
192 #define SYMBOL_SET_NAMES(symbol,linkage_name,len,copy_name,objfile) \
193 symbol_set_names (&(symbol)->ginfo, linkage_name, len, copy_name, objfile)
194 extern void symbol_set_names (struct general_symbol_info *symbol,
195 const char *linkage_name, int len, int copy_name,
196 struct objfile *objfile);
198 /* Now come lots of name accessor macros. Short version as to when to
199 use which: Use SYMBOL_NATURAL_NAME to refer to the name of the
200 symbol in the original source code. Use SYMBOL_LINKAGE_NAME if you
201 want to know what the linker thinks the symbol's name is. Use
202 SYMBOL_PRINT_NAME for output. Use SYMBOL_DEMANGLED_NAME if you
203 specifically need to know whether SYMBOL_NATURAL_NAME and
204 SYMBOL_LINKAGE_NAME are different. */
206 /* Return SYMBOL's "natural" name, i.e. the name that it was called in
207 the original source code. In languages like C++ where symbols may
208 be mangled for ease of manipulation by the linker, this is the
211 #define SYMBOL_NATURAL_NAME(symbol) \
212 (symbol_natural_name (&(symbol)->ginfo))
213 extern char *symbol_natural_name (const struct general_symbol_info *symbol);
215 /* Return SYMBOL's name from the point of view of the linker. In
216 languages like C++ where symbols may be mangled for ease of
217 manipulation by the linker, this is the mangled name; otherwise,
218 it's the same as SYMBOL_NATURAL_NAME. */
220 #define SYMBOL_LINKAGE_NAME(symbol) (symbol)->ginfo.name
222 /* Return the demangled name for a symbol based on the language for
223 that symbol. If no demangled name exists, return NULL. */
224 #define SYMBOL_DEMANGLED_NAME(symbol) \
225 (symbol_demangled_name (&(symbol)->ginfo))
226 extern char *symbol_demangled_name (const struct general_symbol_info *symbol);
228 /* Macro that returns a version of the name of a symbol that is
229 suitable for output. In C++ this is the "demangled" form of the
230 name if demangle is on and the "mangled" form of the name if
231 demangle is off. In other languages this is just the symbol name.
232 The result should never be NULL. Don't use this for internal
233 purposes (e.g. storing in a hashtable): it's only suitable for
236 #define SYMBOL_PRINT_NAME(symbol) \
237 (demangle ? SYMBOL_NATURAL_NAME (symbol) : SYMBOL_LINKAGE_NAME (symbol))
239 /* Macro that tests a symbol for a match against a specified name string.
240 First test the unencoded name, then looks for and test a C++ encoded
241 name if it exists. Note that whitespace is ignored while attempting to
242 match a C++ encoded name, so that "foo::bar(int,long)" is the same as
243 "foo :: bar (int, long)".
244 Evaluates to zero if the match fails, or nonzero if it succeeds. */
246 /* Macro that tests a symbol for a match against a specified name
247 string. It tests against SYMBOL_NATURAL_NAME, and it ignores
248 whitespace and trailing parentheses. (See strcmp_iw for details
249 about its behavior.) */
251 #define SYMBOL_MATCHES_NATURAL_NAME(symbol, name) \
252 (strcmp_iw (SYMBOL_NATURAL_NAME (symbol), (name)) == 0)
254 /* Macro that returns the name to be used when sorting and searching symbols.
255 In C++, Chill, and Java, we search for the demangled form of a name,
256 and so sort symbols accordingly. In Ada, however, we search by mangled
257 name. If there is no distinct demangled name, then SYMBOL_SEARCH_NAME
258 returns the same value (same pointer) as SYMBOL_LINKAGE_NAME. */
259 #define SYMBOL_SEARCH_NAME(symbol) \
260 (symbol_search_name (&(symbol)->ginfo))
261 extern char *symbol_search_name (const struct general_symbol_info *);
263 /* Analogous to SYMBOL_MATCHES_NATURAL_NAME, but uses the search
265 #define SYMBOL_MATCHES_SEARCH_NAME(symbol, name) \
266 (strcmp_iw (SYMBOL_SEARCH_NAME (symbol), (name)) == 0)
268 /* Classification types for a minimal symbol. These should be taken as
269 "advisory only", since if gdb can't easily figure out a
270 classification it simply selects mst_unknown. It may also have to
271 guess when it can't figure out which is a better match between two
272 types (mst_data versus mst_bss) for example. Since the minimal
273 symbol info is sometimes derived from the BFD library's view of a
274 file, we need to live with what information bfd supplies. */
276 enum minimal_symbol_type
278 mst_unknown = 0, /* Unknown type, the default */
279 mst_text, /* Generally executable instructions */
280 mst_data, /* Generally initialized data */
281 mst_bss, /* Generally uninitialized data */
282 mst_abs, /* Generally absolute (nonrelocatable) */
283 /* GDB uses mst_solib_trampoline for the start address of a shared
284 library trampoline entry. Breakpoints for shared library functions
285 are put there if the shared library is not yet loaded.
286 After the shared library is loaded, lookup_minimal_symbol will
287 prefer the minimal symbol from the shared library (usually
288 a mst_text symbol) over the mst_solib_trampoline symbol, and the
289 breakpoints will be moved to their true address in the shared
290 library via breakpoint_re_set. */
291 mst_solib_trampoline, /* Shared library trampoline code */
292 /* For the mst_file* types, the names are only guaranteed to be unique
293 within a given .o file. */
294 mst_file_text, /* Static version of mst_text */
295 mst_file_data, /* Static version of mst_data */
296 mst_file_bss /* Static version of mst_bss */
299 /* Define a simple structure used to hold some very basic information about
300 all defined global symbols (text, data, bss, abs, etc). The only required
301 information is the general_symbol_info.
303 In many cases, even if a file was compiled with no special options for
304 debugging at all, as long as was not stripped it will contain sufficient
305 information to build a useful minimal symbol table using this structure.
306 Even when a file contains enough debugging information to build a full
307 symbol table, these minimal symbols are still useful for quickly mapping
308 between names and addresses, and vice versa. They are also sometimes
309 used to figure out what full symbol table entries need to be read in. */
311 struct minimal_symbol
314 /* The general symbol info required for all types of symbols.
316 The SYMBOL_VALUE_ADDRESS contains the address that this symbol
319 struct general_symbol_info ginfo;
321 /* Size of this symbol. end_psymtab in dbxread.c uses this
322 information to calculate the end of the partial symtab based on the
323 address of the last symbol plus the size of the last symbol. */
327 /* Which source file is this symbol in? Only relevant for mst_file_*. */
330 /* Classification type for this minimal symbol. */
332 ENUM_BITFIELD(minimal_symbol_type) type : 8;
334 /* Two flag bits provided for the use of the target. */
335 unsigned int target_flag_1 : 1;
336 unsigned int target_flag_2 : 1;
338 /* Minimal symbols with the same hash key are kept on a linked
339 list. This is the link. */
341 struct minimal_symbol *hash_next;
343 /* Minimal symbols are stored in two different hash tables. This is
344 the `next' pointer for the demangled hash table. */
346 struct minimal_symbol *demangled_hash_next;
349 #define MSYMBOL_TARGET_FLAG_1(msymbol) (msymbol)->target_flag_1
350 #define MSYMBOL_TARGET_FLAG_2(msymbol) (msymbol)->target_flag_2
351 #define MSYMBOL_SIZE(msymbol) (msymbol)->size
352 #define MSYMBOL_TYPE(msymbol) (msymbol)->type
356 /* Represent one symbol name; a variable, constant, function or typedef. */
358 /* Different name domains for symbols. Looking up a symbol specifies a
359 domain and ignores symbol definitions in other name domains. */
361 typedef enum domain_enum_tag
363 /* UNDEF_DOMAIN is used when a domain has not been discovered or
364 none of the following apply. This usually indicates an error either
365 in the symbol information or in gdb's handling of symbols. */
369 /* VAR_DOMAIN is the usual domain. In C, this contains variables,
370 function names, typedef names and enum type values. */
374 /* STRUCT_DOMAIN is used in C to hold struct, union and enum type names.
375 Thus, if `struct foo' is used in a C program, it produces a symbol named
376 `foo' in the STRUCT_DOMAIN. */
380 /* LABEL_DOMAIN may be used for names of labels (for gotos);
381 currently it is not used and labels are not recorded at all. */
385 /* Searching domains. These overlap with VAR_DOMAIN, providing
386 some granularity with the search_symbols function. */
388 /* Everything in VAR_DOMAIN minus FUNCTIONS_DOMAIN and
392 /* All functions -- for some reason not methods, though. */
395 /* All defined types */
400 /* An address-class says where to find the value of a symbol. */
404 /* Not used; catches errors */
408 /* Value is constant int SYMBOL_VALUE, host byteorder */
412 /* Value is at fixed address SYMBOL_VALUE_ADDRESS */
416 /* Value is in register. SYMBOL_VALUE is the register number
417 in the original debug format. SYMBOL_REGISTER_OPS holds a
418 function that can be called to transform this into the
419 actual register number this represents in a specific target
420 architecture (gdbarch).
422 For some symbol formats (stabs, for some compilers at least),
423 the compiler generates two symbols, an argument and a register.
424 In some cases we combine them to a single LOC_REGISTER in symbol
425 reading, but currently not for all cases (e.g. it's passed on the
426 stack and then loaded into a register). */
430 /* It's an argument; the value is at SYMBOL_VALUE offset in arglist. */
434 /* Value address is at SYMBOL_VALUE offset in arglist. */
438 /* Value is in specified register. Just like LOC_REGISTER except the
439 register holds the address of the argument instead of the argument
440 itself. This is currently used for the passing of structs and unions
441 on sparc and hppa. It is also used for call by reference where the
442 address is in a register, at least by mipsread.c. */
446 /* Value is a local variable at SYMBOL_VALUE offset in stack frame. */
450 /* Value not used; definition in SYMBOL_TYPE. Symbols in the domain
451 STRUCT_DOMAIN all have this class. */
455 /* Value is address SYMBOL_VALUE_ADDRESS in the code */
459 /* In a symbol table, value is SYMBOL_BLOCK_VALUE of a `struct block'.
460 In a partial symbol table, SYMBOL_VALUE_ADDRESS is the start address
461 of the block. Function names have this class. */
465 /* Value is a constant byte-sequence pointed to by SYMBOL_VALUE_BYTES, in
466 target byte order. */
470 /* Value is at fixed address, but the address of the variable has
471 to be determined from the minimal symbol table whenever the
472 variable is referenced.
473 This happens if debugging information for a global symbol is
474 emitted and the corresponding minimal symbol is defined
475 in another object file or runtime common storage.
476 The linker might even remove the minimal symbol if the global
477 symbol is never referenced, in which case the symbol remains
480 GDB would normally find the symbol in the minimal symbol table if it will
481 not find it in the full symbol table. But a reference to an external
482 symbol in a local block shadowing other definition requires full symbol
483 without possibly having its address available for LOC_STATIC. Testcase
484 is provided as `gdb.dwarf2/dw2-unresolved.exp'. */
488 /* The variable does not actually exist in the program.
489 The value is ignored. */
493 /* The variable's address is computed by a set of location
494 functions (see "struct symbol_computed_ops" below). */
498 /* The methods needed to implement LOC_COMPUTED. These methods can
499 use the symbol's .aux_value for additional per-symbol information.
501 At present this is only used to implement location expressions. */
503 struct symbol_computed_ops
506 /* Return the value of the variable SYMBOL, relative to the stack
507 frame FRAME. If the variable has been optimized out, return
510 Iff `read_needs_frame (SYMBOL)' is zero, then FRAME may be zero. */
512 struct value *(*read_variable) (struct symbol * symbol,
513 struct frame_info * frame);
515 /* Return non-zero if we need a frame to find the value of the SYMBOL. */
516 int (*read_needs_frame) (struct symbol * symbol);
518 /* Write to STREAM a natural-language description of the location of
520 int (*describe_location) (struct symbol * symbol, struct ui_file * stream);
522 /* Tracepoint support. Append bytecodes to the tracepoint agent
523 expression AX that push the address of the object SYMBOL. Set
524 VALUE appropriately. Note --- for objects in registers, this
525 needn't emit any code; as long as it sets VALUE properly, then
526 the caller will generate the right code in the process of
527 treating this as an lvalue or rvalue. */
529 void (*tracepoint_var_ref) (struct symbol *symbol, struct gdbarch *gdbarch,
530 struct agent_expr *ax, struct axs_value *value);
533 /* Functions used with LOC_REGISTER and LOC_REGPARM_ADDR. */
535 struct symbol_register_ops
537 int (*register_number) (struct symbol *symbol, struct gdbarch *gdbarch);
540 /* This structure is space critical. See space comments at the top. */
545 /* The general symbol info required for all types of symbols. */
547 struct general_symbol_info ginfo;
549 /* Data type of value */
553 /* The symbol table containing this symbol. This is the file
554 associated with LINE. It can be NULL during symbols read-in but it is
555 never NULL during normal operation. */
556 struct symtab *symtab;
560 ENUM_BITFIELD(domain_enum_tag) domain : 6;
563 /* NOTE: cagney/2003-11-02: The fields "aclass" and "ops" contain
564 overlapping information. By creating a per-aclass ops vector, or
565 using the aclass as an index into an ops table, the aclass and
566 ops fields can be merged. The latter, for instance, would shave
567 32-bits from each symbol (relative to a symbol lookup, any table
568 index overhead would be in the noise). */
570 ENUM_BITFIELD(address_class) aclass : 6;
572 /* Whether this is an argument. */
574 unsigned is_argument : 1;
576 /* Whether this is an inlined function (class LOC_BLOCK only). */
577 unsigned is_inlined : 1;
579 /* Line number of this symbol's definition, except for inlined
580 functions. For an inlined function (class LOC_BLOCK and
581 SYMBOL_INLINED set) this is the line number of the function's call
582 site. Inlined function symbols are not definitions, and they are
583 never found by symbol table lookup.
585 FIXME: Should we really make the assumption that nobody will try
586 to debug files longer than 64K lines? What about machine
587 generated programs? */
591 /* Method's for symbol's of this class. */
592 /* NOTE: cagney/2003-11-02: See comment above attached to "aclass". */
596 /* Used with LOC_COMPUTED. */
597 const struct symbol_computed_ops *ops_computed;
599 /* Used with LOC_REGISTER and LOC_REGPARM_ADDR. */
600 const struct symbol_register_ops *ops_register;
603 /* An arbitrary data pointer, allowing symbol readers to record
604 additional information on a per-symbol basis. Note that this data
605 must be allocated using the same obstack as the symbol itself. */
606 /* So far it is only used by LOC_COMPUTED to
607 find the location information. For a LOC_BLOCK symbol
608 for a function in a compilation unit compiled with DWARF 2
609 information, this is information used internally by the DWARF 2
610 code --- specifically, the location expression for the frame
611 base for this function. */
612 /* FIXME drow/2003-02-21: For the LOC_BLOCK case, it might be better
613 to add a magic symbol to the block containing this information,
614 or to have a generic debug info annotation slot for symbols. */
618 struct symbol *hash_next;
622 #define SYMBOL_DOMAIN(symbol) (symbol)->domain
623 #define SYMBOL_CLASS(symbol) (symbol)->aclass
624 #define SYMBOL_IS_ARGUMENT(symbol) (symbol)->is_argument
625 #define SYMBOL_INLINED(symbol) (symbol)->is_inlined
626 #define SYMBOL_TYPE(symbol) (symbol)->type
627 #define SYMBOL_LINE(symbol) (symbol)->line
628 #define SYMBOL_SYMTAB(symbol) (symbol)->symtab
629 #define SYMBOL_COMPUTED_OPS(symbol) (symbol)->ops.ops_computed
630 #define SYMBOL_REGISTER_OPS(symbol) (symbol)->ops.ops_register
631 #define SYMBOL_LOCATION_BATON(symbol) (symbol)->aux_value
633 /* Each item represents a line-->pc (or the reverse) mapping. This is
634 somewhat more wasteful of space than one might wish, but since only
635 the files which are actually debugged are read in to core, we don't
638 struct linetable_entry
644 /* The order of entries in the linetable is significant. They should
645 be sorted by increasing values of the pc field. If there is more than
646 one entry for a given pc, then I'm not sure what should happen (and
647 I not sure whether we currently handle it the best way).
649 Example: a C for statement generally looks like this
651 10 0x100 - for the init/test part of a for stmt.
654 10 0x400 - for the increment part of a for stmt.
656 If an entry has a line number of zero, it marks the start of a PC
657 range for which no line number information is available. It is
658 acceptable, though wasteful of table space, for such a range to be
665 /* Actually NITEMS elements. If you don't like this use of the
666 `struct hack', you can shove it up your ANSI (seriously, if the
667 committee tells us how to do it, we can probably go along). */
668 struct linetable_entry item[1];
671 /* How to relocate the symbols from each section in a symbol file.
672 Each struct contains an array of offsets.
673 The ordering and meaning of the offsets is file-type-dependent;
674 typically it is indexed by section numbers or symbol types or
677 To give us flexibility in changing the internal representation
678 of these offsets, the ANOFFSET macro must be used to insert and
679 extract offset values in the struct. */
681 struct section_offsets
683 CORE_ADDR offsets[1]; /* As many as needed. */
686 #define ANOFFSET(secoff, whichone) \
688 ? (internal_error (__FILE__, __LINE__, _("Section index is uninitialized")), -1) \
689 : secoff->offsets[whichone])
691 /* The size of a section_offsets table for N sections. */
692 #define SIZEOF_N_SECTION_OFFSETS(n) \
693 (sizeof (struct section_offsets) \
694 + sizeof (((struct section_offsets *) 0)->offsets) * ((n)-1))
696 /* Each source file or header is represented by a struct symtab.
697 These objects are chained through the `next' field. */
702 /* Chain of all existing symtabs. */
706 /* List of all symbol scope blocks for this symtab. May be shared
707 between different symtabs (and normally is for all the symtabs
708 in a given compilation unit). */
710 struct blockvector *blockvector;
712 /* Table mapping core addresses to line numbers for this file.
713 Can be NULL if none. Never shared between different symtabs. */
715 struct linetable *linetable;
717 /* Section in objfile->section_offsets for the blockvector and
718 the linetable. Probably always SECT_OFF_TEXT. */
720 int block_line_section;
722 /* If several symtabs share a blockvector, exactly one of them
723 should be designated the primary, so that the blockvector
724 is relocated exactly once by objfile_relocate. */
728 /* The macro table for this symtab. Like the blockvector, this
729 may be shared between different symtabs --- and normally is for
730 all the symtabs in a given compilation unit. */
731 struct macro_table *macro_table;
733 /* Name of this source file. */
737 /* Directory in which it was compiled, or NULL if we don't know. */
741 /* This component says how to free the data we point to:
742 free_nothing => do nothing; some other symtab will free
743 the data this one uses.
744 free_linetable => free just the linetable. FIXME: Is this redundant
745 with the primary field? */
749 free_nothing, free_linetable
753 /* A function to call to free space, if necessary. This is IN
754 ADDITION to the action indicated by free_code. */
756 void (*free_func)(struct symtab *symtab);
758 /* Total number of lines found in source file. */
762 /* line_charpos[N] is the position of the (N-1)th line of the
763 source file. "position" means something we can lseek() to; it
764 is not guaranteed to be useful any other way. */
768 /* Language of this source file. */
770 enum language language;
772 /* String that identifies the format of the debugging information, such
773 as "stabs", "dwarf 1", "dwarf 2", "coff", etc. This is mostly useful
774 for automated testing of gdb but may also be information that is
775 useful to the user. */
779 /* String of producer version information. May be zero. */
783 /* Full name of file as found by searching the source path.
784 NULL if not yet known. */
788 /* Object file from which this symbol information was read. */
790 struct objfile *objfile;
794 #define BLOCKVECTOR(symtab) (symtab)->blockvector
795 #define LINETABLE(symtab) (symtab)->linetable
796 #define SYMTAB_PSPACE(symtab) (symtab)->objfile->pspace
799 /* The virtual function table is now an array of structures which have the
800 form { int16 offset, delta; void *pfn; }.
802 In normal virtual function tables, OFFSET is unused.
803 DELTA is the amount which is added to the apparent object's base
804 address in order to point to the actual object to which the
805 virtual function should be applied.
806 PFN is a pointer to the virtual function.
808 Note that this macro is g++ specific (FIXME). */
810 #define VTBL_FNADDR_OFFSET 2
812 /* External variables and functions for the objects described above. */
814 /* See the comment in symfile.c about how current_objfile is used. */
816 extern struct objfile *current_objfile;
818 /* True if we are nested inside psymtab_to_symtab. */
820 extern int currently_reading_symtab;
824 extern int asm_demangle;
826 /* symtab.c lookup functions */
828 extern const char multiple_symbols_ask[];
829 extern const char multiple_symbols_all[];
830 extern const char multiple_symbols_cancel[];
832 const char *multiple_symbols_select_mode (void);
834 int symbol_matches_domain (enum language symbol_language,
835 domain_enum symbol_domain,
838 /* lookup a symbol table by source file name */
840 extern struct symtab *lookup_symtab (const char *);
842 /* lookup a symbol by name (optional block) in language. */
844 extern struct symbol *lookup_symbol_in_language (const char *,
845 const struct block *,
850 /* lookup a symbol by name (optional block, optional symtab)
851 in the current language */
853 extern struct symbol *lookup_symbol (const char *, const struct block *,
854 const domain_enum, int *);
856 /* A default version of lookup_symbol_nonlocal for use by languages
857 that can't think of anything better to do. */
859 extern struct symbol *basic_lookup_symbol_nonlocal (const char *,
860 const struct block *,
863 /* Some helper functions for languages that need to write their own
864 lookup_symbol_nonlocal functions. */
866 /* Lookup a symbol in the static block associated to BLOCK, if there
867 is one; do nothing if BLOCK is NULL or a global block. */
869 extern struct symbol *lookup_symbol_static (const char *name,
870 const struct block *block,
871 const domain_enum domain);
873 /* Lookup a symbol in all files' global blocks (searching psymtabs if
876 extern struct symbol *lookup_symbol_global (const char *name,
877 const struct block *block,
878 const domain_enum domain);
880 /* Lookup a symbol within the block BLOCK. This, unlike
881 lookup_symbol_block, will set SYMTAB and BLOCK_FOUND correctly, and
882 will fix up the symbol if necessary. */
884 extern struct symbol *lookup_symbol_aux_block (const char *name,
885 const struct block *block,
886 const domain_enum domain);
888 /* lookup a symbol by name, within a specified block */
890 extern struct symbol *lookup_block_symbol (const struct block *, const char *,
893 /* lookup a [struct, union, enum] by name, within a specified block */
895 extern struct type *lookup_struct (char *, struct block *);
897 extern struct type *lookup_union (char *, struct block *);
899 extern struct type *lookup_enum (char *, struct block *);
901 /* from blockframe.c: */
903 /* lookup the function symbol corresponding to the address */
905 extern struct symbol *find_pc_function (CORE_ADDR);
907 /* lookup the function corresponding to the address and section */
909 extern struct symbol *find_pc_sect_function (CORE_ADDR, struct obj_section *);
911 /* lookup function from address, return name, start addr and end addr */
913 extern int find_pc_partial_function (CORE_ADDR, char **, CORE_ADDR *,
916 extern void clear_pc_function_cache (void);
918 /* lookup partial symbol table by address and section */
920 extern struct symtab *find_pc_sect_symtab_via_partial (CORE_ADDR,
921 struct obj_section *);
923 /* lookup full symbol table by address */
925 extern struct symtab *find_pc_symtab (CORE_ADDR);
927 /* lookup full symbol table by address and section */
929 extern struct symtab *find_pc_sect_symtab (CORE_ADDR, struct obj_section *);
931 extern int find_pc_line_pc_range (CORE_ADDR, CORE_ADDR *, CORE_ADDR *);
933 extern void reread_symbols (void);
935 extern struct type *lookup_transparent_type (const char *);
936 extern struct type *basic_lookup_transparent_type (const char *);
939 /* Macro for name of symbol to indicate a file compiled with gcc. */
940 #ifndef GCC_COMPILED_FLAG_SYMBOL
941 #define GCC_COMPILED_FLAG_SYMBOL "gcc_compiled."
944 /* Macro for name of symbol to indicate a file compiled with gcc2. */
945 #ifndef GCC2_COMPILED_FLAG_SYMBOL
946 #define GCC2_COMPILED_FLAG_SYMBOL "gcc2_compiled."
949 /* Functions for dealing with the minimal symbol table, really a misc
950 address<->symbol mapping for things we don't have debug symbols for. */
952 extern void prim_record_minimal_symbol (const char *, CORE_ADDR,
953 enum minimal_symbol_type,
956 extern struct minimal_symbol *prim_record_minimal_symbol_full
957 (const char *, int, int, CORE_ADDR,
958 enum minimal_symbol_type,
959 int section, asection * bfd_section, struct objfile *);
961 extern struct minimal_symbol *prim_record_minimal_symbol_and_info
962 (const char *, CORE_ADDR,
963 enum minimal_symbol_type,
964 int section, asection * bfd_section, struct objfile *);
966 extern unsigned int msymbol_hash_iw (const char *);
968 extern unsigned int msymbol_hash (const char *);
970 extern struct objfile * msymbol_objfile (struct minimal_symbol *sym);
973 add_minsym_to_hash_table (struct minimal_symbol *sym,
974 struct minimal_symbol **table);
976 extern struct minimal_symbol *lookup_minimal_symbol (const char *,
980 extern struct minimal_symbol *lookup_minimal_symbol_text (const char *,
983 struct minimal_symbol *lookup_minimal_symbol_solib_trampoline (const char *,
987 extern struct minimal_symbol *lookup_minimal_symbol_by_pc_name
988 (CORE_ADDR, const char *, struct objfile *);
990 extern struct minimal_symbol *lookup_minimal_symbol_by_pc (CORE_ADDR);
992 extern struct minimal_symbol *
993 lookup_minimal_symbol_and_objfile (const char *,
996 extern struct minimal_symbol
997 *lookup_minimal_symbol_by_pc_section (CORE_ADDR, struct obj_section *);
999 extern struct minimal_symbol
1000 *lookup_solib_trampoline_symbol_by_pc (CORE_ADDR);
1002 extern CORE_ADDR find_solib_trampoline_target (struct frame_info *, CORE_ADDR);
1004 extern void init_minimal_symbol_collection (void);
1006 extern struct cleanup *make_cleanup_discard_minimal_symbols (void);
1008 extern void install_minimal_symbols (struct objfile *);
1010 /* Sort all the minimal symbols in OBJFILE. */
1012 extern void msymbols_sort (struct objfile *objfile);
1014 struct symtab_and_line
1016 /* The program space of this sal. */
1017 struct program_space *pspace;
1019 struct symtab *symtab;
1020 struct obj_section *section;
1021 /* Line number. Line numbers start at 1 and proceed through symtab->nlines.
1022 0 is never a valid line number; it is used to indicate that line number
1023 information is not available. */
1032 extern void init_sal (struct symtab_and_line *sal);
1034 struct symtabs_and_lines
1036 struct symtab_and_line *sals;
1042 /* Some types and macros needed for exception catchpoints.
1043 Can't put these in target.h because symtab_and_line isn't
1044 known there. This file will be included by breakpoint.c,
1045 hppa-tdep.c, etc. */
1047 /* Enums for exception-handling support */
1048 enum exception_event_kind
1056 /* Given a pc value, return line number it is in. Second arg nonzero means
1057 if pc is on the boundary use the previous statement's line number. */
1059 extern struct symtab_and_line find_pc_line (CORE_ADDR, int);
1061 /* Same function, but specify a section as well as an address */
1063 extern struct symtab_and_line find_pc_sect_line (CORE_ADDR,
1064 struct obj_section *, int);
1066 /* Given a symtab and line number, return the pc there. */
1068 extern int find_line_pc (struct symtab *, int, CORE_ADDR *);
1070 extern int find_line_pc_range (struct symtab_and_line, CORE_ADDR *,
1073 extern void resolve_sal_pc (struct symtab_and_line *);
1075 /* Given a string, return the line specified by it. For commands like "list"
1076 and "breakpoint". */
1078 extern struct symtabs_and_lines decode_line_spec (char *, int);
1080 extern struct symtabs_and_lines decode_line_spec_1 (char *, int);
1084 void maintenance_print_symbols (char *, int);
1086 void maintenance_print_psymbols (char *, int);
1088 void maintenance_print_msymbols (char *, int);
1090 void maintenance_print_objfiles (char *, int);
1092 void maintenance_info_symtabs (char *, int);
1094 void maintenance_info_psymtabs (char *, int);
1096 void maintenance_check_symtabs (char *, int);
1100 void maintenance_print_statistics (char *, int);
1102 extern void free_symtab (struct symtab *);
1104 /* Symbol-reading stuff in symfile.c and solib.c. */
1106 extern void clear_solib (void);
1110 extern int identify_source_line (struct symtab *, int, int, CORE_ADDR);
1112 extern void print_source_lines (struct symtab *, int, int, int);
1114 extern void forget_cached_source_info (void);
1116 extern void select_source_symtab (struct symtab *);
1118 extern char **default_make_symbol_completion_list (char *, char *);
1119 extern char **make_symbol_completion_list (char *, char *);
1120 extern char **make_symbol_completion_list_fn (struct cmd_list_element *,
1123 extern char **make_file_symbol_completion_list (char *, char *, char *);
1125 extern char **make_source_files_completion_list (char *, char *);
1129 int matching_obj_sections (struct obj_section *, struct obj_section *);
1131 extern char *find_main_filename (void);
1133 extern struct symtab *find_line_symtab (struct symtab *, int, int *, int *);
1135 extern struct symtab_and_line find_function_start_sal (struct symbol *sym,
1138 extern void skip_prologue_sal (struct symtab_and_line *);
1142 extern void clear_symtab_users (void);
1144 extern enum language deduce_language_from_filename (char *);
1148 extern int in_prologue (struct gdbarch *gdbarch,
1149 CORE_ADDR pc, CORE_ADDR func_start);
1151 extern CORE_ADDR skip_prologue_using_sal (struct gdbarch *gdbarch,
1152 CORE_ADDR func_addr);
1154 extern struct symbol *fixup_symbol_section (struct symbol *,
1157 /* Symbol searching */
1159 /* When using search_symbols, a list of the following structs is returned.
1160 Callers must free the search list using free_search_symbols! */
1161 struct symbol_search
1163 /* The block in which the match was found. Could be, for example,
1164 STATIC_BLOCK or GLOBAL_BLOCK. */
1167 /* Information describing what was found.
1169 If symtab abd symbol are NOT NULL, then information was found
1171 struct symtab *symtab;
1172 struct symbol *symbol;
1174 /* If msymbol is non-null, then a match was made on something for
1175 which only minimal_symbols exist. */
1176 struct minimal_symbol *msymbol;
1178 /* A link to the next match, or NULL for the end. */
1179 struct symbol_search *next;
1182 extern void search_symbols (char *, domain_enum, int, char **,
1183 struct symbol_search **);
1184 extern void free_search_symbols (struct symbol_search *);
1185 extern struct cleanup *make_cleanup_free_search_symbols (struct symbol_search
1188 /* The name of the ``main'' function.
1189 FIXME: cagney/2001-03-20: Can't make main_name() const since some
1190 of the calling code currently assumes that the string isn't
1192 extern void set_main_name (const char *name);
1193 extern /*const */ char *main_name (void);
1195 /* Check global symbols in objfile. */
1196 struct symbol *lookup_global_symbol_from_objfile (const struct objfile *objfile,
1198 const domain_enum domain);
1200 extern struct symtabs_and_lines expand_line_sal (struct symtab_and_line sal);
1202 /* Return 1 if the supplied producer string matches the ARM RealView
1203 compiler (armcc). */
1204 int producer_is_realview (const char *producer);
1206 void fixup_section (struct general_symbol_info *ginfo,
1207 CORE_ADDR addr, struct objfile *objfile);
1209 #endif /* !defined(SYMTAB_H) */