Commit | Line | Data |
---|---|---|
c906108c | 1 | /* Symbol table definitions for GDB. |
1bac305b AC |
2 | |
3 | Copyright 1986, 1988, 1989, 1990, 1991, 1992, 1993, 1994, 1995, | |
4 | 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003 Free Software | |
5 | Foundation, Inc. | |
c906108c | 6 | |
c5aa993b | 7 | This file is part of GDB. |
c906108c | 8 | |
c5aa993b JM |
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 2 of the License, or | |
12 | (at your option) any later version. | |
c906108c | 13 | |
c5aa993b JM |
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. | |
c906108c | 18 | |
c5aa993b JM |
19 | You should have received a copy of the GNU General Public License |
20 | along with this program; if not, write to the Free Software | |
21 | Foundation, Inc., 59 Temple Place - Suite 330, | |
22 | Boston, MA 02111-1307, USA. */ | |
c906108c SS |
23 | |
24 | #if !defined (SYMTAB_H) | |
25 | #define SYMTAB_H 1 | |
26 | ||
5f8a3188 | 27 | /* Opaque declarations. */ |
da3331ec AC |
28 | struct ui_file; |
29 | struct frame_info; | |
30 | struct symbol; | |
5f8a3188 | 31 | struct obstack; |
6a2f5abf | 32 | struct objfile; |
fe898f56 DC |
33 | struct block; |
34 | struct blockvector; | |
4c2df51b DJ |
35 | struct axs_value; |
36 | struct agent_expr; | |
c906108c | 37 | |
a7f19c79 MC |
38 | /* Some of the structures in this file are space critical. |
39 | The space-critical structures are: | |
40 | ||
41 | struct general_symbol_info | |
42 | struct symbol | |
43 | struct partial_symbol | |
44 | ||
45 | These structures are layed out to encourage good packing. | |
46 | They use ENUM_BITFIELD and short int fields, and they order the | |
47 | structure members so that fields less than a word are next | |
48 | to each other so they can be packed together. */ | |
49 | ||
50 | /* Rearranged: used ENUM_BITFIELD and rearranged field order in | |
51 | all the space critical structures (plus struct minimal_symbol). | |
52 | Memory usage dropped from 99360768 bytes to 90001408 bytes. | |
53 | I measured this with before-and-after tests of | |
54 | "HEAD-old-gdb -readnow HEAD-old-gdb" and | |
55 | "HEAD-new-gdb -readnow HEAD-old-gdb" on native i686-pc-linux-gnu, | |
56 | red hat linux 8, with LD_LIBRARY_PATH=/usr/lib/debug, | |
57 | typing "maint space 1" at the first command prompt. | |
58 | ||
59 | Here is another measurement (from andrew c): | |
60 | # no /usr/lib/debug, just plain glibc, like a normal user | |
61 | gdb HEAD-old-gdb | |
62 | (gdb) break internal_error | |
63 | (gdb) run | |
64 | (gdb) maint internal-error | |
65 | (gdb) backtrace | |
66 | (gdb) maint space 1 | |
67 | ||
68 | gdb gdb_6_0_branch 2003-08-19 space used: 8896512 | |
69 | gdb HEAD 2003-08-19 space used: 8904704 | |
70 | gdb HEAD 2003-08-21 space used: 8396800 (+symtab.h) | |
71 | gdb HEAD 2003-08-21 space used: 8265728 (+gdbtypes.h) | |
72 | ||
73 | The third line shows the savings from the optimizations in symtab.h. | |
74 | The fourth line shows the savings from the optimizations in | |
75 | gdbtypes.h. Both optimizations are in gdb HEAD now. | |
76 | ||
77 | --chastain 2003-08-21 */ | |
78 | ||
79 | ||
80 | ||
c906108c SS |
81 | /* Define a structure for the information that is common to all symbol types, |
82 | including minimal symbols, partial symbols, and full symbols. In a | |
83 | multilanguage environment, some language specific information may need to | |
a7f19c79 | 84 | be recorded along with each symbol. */ |
c906108c | 85 | |
a7f19c79 | 86 | /* This structure is space critical. See space comments at the top. */ |
c906108c SS |
87 | |
88 | struct general_symbol_info | |
17c5ed2c | 89 | { |
22abf04a DC |
90 | /* Name of the symbol. This is a required field. Storage for the |
91 | name is allocated on the psymbol_obstack or symbol_obstack for | |
92 | the associated objfile. For languages like C++ that make a | |
93 | distinction between the mangled name and demangled name, this is | |
94 | the mangled name. */ | |
c906108c | 95 | |
17c5ed2c | 96 | char *name; |
c906108c | 97 | |
17c5ed2c DC |
98 | /* Value of the symbol. Which member of this union to use, and what |
99 | it means, depends on what kind of symbol this is and its | |
100 | SYMBOL_CLASS. See comments there for more details. All of these | |
101 | are in host byte order (though what they point to might be in | |
102 | target byte order, e.g. LOC_CONST_BYTES). */ | |
c906108c | 103 | |
17c5ed2c DC |
104 | union |
105 | { | |
106 | /* The fact that this is a long not a LONGEST mainly limits the | |
107 | range of a LOC_CONST. Since LOC_CONST_BYTES exists, I'm not | |
108 | sure that is a big deal. */ | |
109 | long ivalue; | |
c906108c | 110 | |
17c5ed2c | 111 | struct block *block; |
c906108c | 112 | |
17c5ed2c | 113 | char *bytes; |
c906108c | 114 | |
17c5ed2c | 115 | CORE_ADDR address; |
c906108c | 116 | |
17c5ed2c | 117 | /* for opaque typedef struct chain */ |
c906108c | 118 | |
17c5ed2c DC |
119 | struct symbol *chain; |
120 | } | |
121 | value; | |
c906108c | 122 | |
17c5ed2c DC |
123 | /* Since one and only one language can apply, wrap the language specific |
124 | information inside a union. */ | |
c906108c | 125 | |
17c5ed2c DC |
126 | union |
127 | { | |
22abf04a | 128 | struct cplus_specific |
17c5ed2c | 129 | { |
22abf04a | 130 | /* This is in fact used for C++, Java, and Objective C. */ |
17c5ed2c DC |
131 | char *demangled_name; |
132 | } | |
133 | cplus_specific; | |
17c5ed2c DC |
134 | } |
135 | language_specific; | |
c5aa993b | 136 | |
17c5ed2c DC |
137 | /* Record the source code language that applies to this symbol. |
138 | This is used to select one of the fields from the language specific | |
139 | union above. */ | |
c5aa993b | 140 | |
87193939 | 141 | ENUM_BITFIELD(language) language : 8; |
c5aa993b | 142 | |
17c5ed2c DC |
143 | /* Which section is this symbol in? This is an index into |
144 | section_offsets for this objfile. Negative means that the symbol | |
145 | does not get relocated relative to a section. | |
146 | Disclaimer: currently this is just used for xcoff, so don't | |
147 | expect all symbol-reading code to set it correctly (the ELF code | |
148 | also tries to set it correctly). */ | |
c5aa993b | 149 | |
17c5ed2c | 150 | short section; |
c5aa993b | 151 | |
17c5ed2c | 152 | /* The bfd section associated with this symbol. */ |
c5aa993b | 153 | |
17c5ed2c DC |
154 | asection *bfd_section; |
155 | }; | |
c906108c | 156 | |
a14ed312 | 157 | extern CORE_ADDR symbol_overlayed_address (CORE_ADDR, asection *); |
c906108c | 158 | |
88cda038 EZ |
159 | /* Note that all the following SYMBOL_* macros are used with the |
160 | SYMBOL argument being either a partial symbol, a minimal symbol or | |
161 | a full symbol. All three types have a ginfo field. In particular | |
162 | the SYMBOL_INIT_LANGUAGE_SPECIFIC, SYMBOL_INIT_DEMANGLED_NAME, | |
163 | SYMBOL_DEMANGLED_NAME macros cannot be entirely substituted by | |
164 | functions, unless the callers are changed to pass in the ginfo | |
165 | field only, instead of the SYMBOL parameter. */ | |
166 | ||
22abf04a | 167 | #define DEPRECATED_SYMBOL_NAME(symbol) (symbol)->ginfo.name |
c906108c SS |
168 | #define SYMBOL_VALUE(symbol) (symbol)->ginfo.value.ivalue |
169 | #define SYMBOL_VALUE_ADDRESS(symbol) (symbol)->ginfo.value.address | |
170 | #define SYMBOL_VALUE_BYTES(symbol) (symbol)->ginfo.value.bytes | |
171 | #define SYMBOL_BLOCK_VALUE(symbol) (symbol)->ginfo.value.block | |
172 | #define SYMBOL_VALUE_CHAIN(symbol) (symbol)->ginfo.value.chain | |
173 | #define SYMBOL_LANGUAGE(symbol) (symbol)->ginfo.language | |
174 | #define SYMBOL_SECTION(symbol) (symbol)->ginfo.section | |
175 | #define SYMBOL_BFD_SECTION(symbol) (symbol)->ginfo.bfd_section | |
176 | ||
177 | #define SYMBOL_CPLUS_DEMANGLED_NAME(symbol) \ | |
178 | (symbol)->ginfo.language_specific.cplus_specific.demangled_name | |
179 | ||
89aad1f9 | 180 | /* Initializes the language dependent portion of a symbol |
c906108c | 181 | depending upon the language for the symbol. */ |
89aad1f9 EZ |
182 | #define SYMBOL_INIT_LANGUAGE_SPECIFIC(symbol,language) \ |
183 | (symbol_init_language_specific (&(symbol)->ginfo, (language))) | |
184 | extern void symbol_init_language_specific (struct general_symbol_info *symbol, | |
185 | enum language language); | |
c906108c | 186 | |
12af6855 | 187 | #define SYMBOL_INIT_DEMANGLED_NAME(symbol,obstack) \ |
2de7ced7 | 188 | (symbol_init_demangled_name (&(symbol)->ginfo, (obstack))) |
12af6855 | 189 | extern void symbol_init_demangled_name (struct general_symbol_info *symbol, |
17c5ed2c DC |
190 | struct obstack *obstack); |
191 | ||
980cae7a DC |
192 | #define SYMBOL_SET_NAMES(symbol,linkage_name,len,objfile) \ |
193 | symbol_set_names (&(symbol)->ginfo, linkage_name, len, objfile) | |
2de7ced7 | 194 | extern void symbol_set_names (struct general_symbol_info *symbol, |
980cae7a | 195 | const char *linkage_name, int len, |
2de7ced7 DJ |
196 | struct objfile *objfile); |
197 | ||
22abf04a DC |
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. Don't use | |
205 | DEPRECATED_SYMBOL_NAME at all: instances of that macro should be | |
206 | replaced by SYMBOL_NATURAL_NAME, SYMBOL_LINKAGE_NAME, or perhaps | |
207 | SYMBOL_PRINT_NAME. */ | |
208 | ||
209 | /* Return SYMBOL's "natural" name, i.e. the name that it was called in | |
210 | the original source code. In languages like C++ where symbols may | |
211 | be mangled for ease of manipulation by the linker, this is the | |
212 | demangled name. */ | |
213 | ||
214 | #define SYMBOL_NATURAL_NAME(symbol) \ | |
215 | (symbol_natural_name (&(symbol)->ginfo)) | |
216 | extern char *symbol_natural_name (const struct general_symbol_info *symbol); | |
217 | ||
218 | /* Return SYMBOL's name from the point of view of the linker. In | |
219 | languages like C++ where symbols may be mangled for ease of | |
220 | manipulation by the linker, this is the mangled name; otherwise, | |
221 | it's the same as SYMBOL_NATURAL_NAME. This is currently identical | |
222 | to DEPRECATED_SYMBOL_NAME, but please use SYMBOL_LINKAGE_NAME when | |
223 | appropriate: it conveys the additional semantic information that | |
224 | you really have thought about the issue and decided that you mean | |
225 | SYMBOL_LINKAGE_NAME instead of SYMBOL_NATURAL_NAME. */ | |
226 | ||
227 | #define SYMBOL_LINKAGE_NAME(symbol) (symbol)->ginfo.name | |
228 | ||
9cc0d196 EZ |
229 | /* Return the demangled name for a symbol based on the language for |
230 | that symbol. If no demangled name exists, return NULL. */ | |
231 | #define SYMBOL_DEMANGLED_NAME(symbol) \ | |
232 | (symbol_demangled_name (&(symbol)->ginfo)) | |
233 | extern char *symbol_demangled_name (struct general_symbol_info *symbol); | |
c906108c | 234 | |
de5ad195 DC |
235 | /* Macro that returns a version of the name of a symbol that is |
236 | suitable for output. In C++ this is the "demangled" form of the | |
237 | name if demangle is on and the "mangled" form of the name if | |
238 | demangle is off. In other languages this is just the symbol name. | |
239 | The result should never be NULL. Don't use this for internal | |
240 | purposes (e.g. storing in a hashtable): it's only suitable for | |
241 | output. */ | |
242 | ||
243 | #define SYMBOL_PRINT_NAME(symbol) \ | |
22abf04a | 244 | (demangle ? SYMBOL_NATURAL_NAME (symbol) : SYMBOL_LINKAGE_NAME (symbol)) |
c906108c | 245 | |
c906108c SS |
246 | /* Macro that tests a symbol for a match against a specified name string. |
247 | First test the unencoded name, then looks for and test a C++ encoded | |
248 | name if it exists. Note that whitespace is ignored while attempting to | |
249 | match a C++ encoded name, so that "foo::bar(int,long)" is the same as | |
250 | "foo :: bar (int, long)". | |
251 | Evaluates to zero if the match fails, or nonzero if it succeeds. */ | |
252 | ||
8e437497 DC |
253 | /* Macro that tests a symbol for a match against a specified name |
254 | string. It tests against SYMBOL_NATURAL_NAME, and it ignores | |
255 | whitespace and trailing parentheses. (See strcmp_iw for details | |
256 | about its behavior.) */ | |
257 | ||
258 | #define SYMBOL_MATCHES_NATURAL_NAME(symbol, name) \ | |
259 | (strcmp_iw (SYMBOL_NATURAL_NAME (symbol), (name)) == 0) | |
260 | ||
87193939 MC |
261 | /* Classification types for a minimal symbol. These should be taken as |
262 | "advisory only", since if gdb can't easily figure out a | |
263 | classification it simply selects mst_unknown. It may also have to | |
264 | guess when it can't figure out which is a better match between two | |
265 | types (mst_data versus mst_bss) for example. Since the minimal | |
266 | symbol info is sometimes derived from the BFD library's view of a | |
267 | file, we need to live with what information bfd supplies. */ | |
268 | ||
269 | enum minimal_symbol_type | |
270 | { | |
271 | mst_unknown = 0, /* Unknown type, the default */ | |
272 | mst_text, /* Generally executable instructions */ | |
273 | mst_data, /* Generally initialized data */ | |
274 | mst_bss, /* Generally uninitialized data */ | |
275 | mst_abs, /* Generally absolute (nonrelocatable) */ | |
276 | /* GDB uses mst_solib_trampoline for the start address of a shared | |
277 | library trampoline entry. Breakpoints for shared library functions | |
278 | are put there if the shared library is not yet loaded. | |
279 | After the shared library is loaded, lookup_minimal_symbol will | |
280 | prefer the minimal symbol from the shared library (usually | |
281 | a mst_text symbol) over the mst_solib_trampoline symbol, and the | |
282 | breakpoints will be moved to their true address in the shared | |
283 | library via breakpoint_re_set. */ | |
284 | mst_solib_trampoline, /* Shared library trampoline code */ | |
285 | /* For the mst_file* types, the names are only guaranteed to be unique | |
286 | within a given .o file. */ | |
287 | mst_file_text, /* Static version of mst_text */ | |
288 | mst_file_data, /* Static version of mst_data */ | |
289 | mst_file_bss /* Static version of mst_bss */ | |
290 | }; | |
291 | ||
c906108c SS |
292 | /* Define a simple structure used to hold some very basic information about |
293 | all defined global symbols (text, data, bss, abs, etc). The only required | |
294 | information is the general_symbol_info. | |
295 | ||
296 | In many cases, even if a file was compiled with no special options for | |
297 | debugging at all, as long as was not stripped it will contain sufficient | |
298 | information to build a useful minimal symbol table using this structure. | |
299 | Even when a file contains enough debugging information to build a full | |
300 | symbol table, these minimal symbols are still useful for quickly mapping | |
301 | between names and addresses, and vice versa. They are also sometimes | |
302 | used to figure out what full symbol table entries need to be read in. */ | |
303 | ||
304 | struct minimal_symbol | |
17c5ed2c | 305 | { |
c906108c | 306 | |
17c5ed2c | 307 | /* The general symbol info required for all types of symbols. |
c906108c | 308 | |
17c5ed2c DC |
309 | The SYMBOL_VALUE_ADDRESS contains the address that this symbol |
310 | corresponds to. */ | |
c906108c | 311 | |
17c5ed2c | 312 | struct general_symbol_info ginfo; |
c906108c | 313 | |
17c5ed2c DC |
314 | /* The info field is available for caching machine-specific information |
315 | so it doesn't have to rederive the info constantly (over a serial line). | |
316 | It is initialized to zero and stays that way until target-dependent code | |
317 | sets it. Storage for any data pointed to by this field should be allo- | |
318 | cated on the symbol_obstack for the associated objfile. | |
319 | The type would be "void *" except for reasons of compatibility with older | |
320 | compilers. This field is optional. | |
c906108c | 321 | |
17c5ed2c DC |
322 | Currently, the AMD 29000 tdep.c uses it to remember things it has decoded |
323 | from the instructions in the function header, and the MIPS-16 code uses | |
324 | it to identify 16-bit procedures. */ | |
c906108c | 325 | |
17c5ed2c | 326 | char *info; |
c906108c | 327 | |
f594e5e9 MC |
328 | /* Size of this symbol. end_psymtab in dbxread.c uses this |
329 | information to calculate the end of the partial symtab based on the | |
330 | address of the last symbol plus the size of the last symbol. */ | |
331 | ||
332 | unsigned long size; | |
333 | ||
c906108c | 334 | #ifdef SOFUN_ADDRESS_MAYBE_MISSING |
17c5ed2c DC |
335 | /* Which source file is this symbol in? Only relevant for mst_file_*. */ |
336 | char *filename; | |
c906108c SS |
337 | #endif |
338 | ||
87193939 | 339 | /* Classification type for this minimal symbol. */ |
17c5ed2c | 340 | |
87193939 | 341 | ENUM_BITFIELD(minimal_symbol_type) type : 8; |
17c5ed2c DC |
342 | |
343 | /* Minimal symbols with the same hash key are kept on a linked | |
344 | list. This is the link. */ | |
345 | ||
346 | struct minimal_symbol *hash_next; | |
347 | ||
348 | /* Minimal symbols are stored in two different hash tables. This is | |
349 | the `next' pointer for the demangled hash table. */ | |
350 | ||
351 | struct minimal_symbol *demangled_hash_next; | |
352 | }; | |
c906108c SS |
353 | |
354 | #define MSYMBOL_INFO(msymbol) (msymbol)->info | |
f594e5e9 | 355 | #define MSYMBOL_SIZE(msymbol) (msymbol)->size |
c906108c | 356 | #define MSYMBOL_TYPE(msymbol) (msymbol)->type |
c906108c | 357 | |
c906108c | 358 | \f |
c5aa993b | 359 | |
c906108c SS |
360 | /* Represent one symbol name; a variable, constant, function or typedef. */ |
361 | ||
176620f1 EZ |
362 | /* Different name domains for symbols. Looking up a symbol specifies a |
363 | domain and ignores symbol definitions in other name domains. */ | |
c906108c | 364 | |
87193939 | 365 | typedef enum domain_enum_tag |
17c5ed2c | 366 | { |
176620f1 | 367 | /* UNDEF_DOMAIN is used when a domain has not been discovered or |
17c5ed2c DC |
368 | none of the following apply. This usually indicates an error either |
369 | in the symbol information or in gdb's handling of symbols. */ | |
c906108c | 370 | |
176620f1 | 371 | UNDEF_DOMAIN, |
c906108c | 372 | |
176620f1 | 373 | /* VAR_DOMAIN is the usual domain. In C, this contains variables, |
17c5ed2c | 374 | function names, typedef names and enum type values. */ |
c906108c | 375 | |
176620f1 | 376 | VAR_DOMAIN, |
c906108c | 377 | |
176620f1 | 378 | /* STRUCT_DOMAIN is used in C to hold struct, union and enum type names. |
17c5ed2c | 379 | Thus, if `struct foo' is used in a C program, it produces a symbol named |
176620f1 | 380 | `foo' in the STRUCT_DOMAIN. */ |
c906108c | 381 | |
176620f1 | 382 | STRUCT_DOMAIN, |
c906108c | 383 | |
176620f1 | 384 | /* LABEL_DOMAIN may be used for names of labels (for gotos); |
17c5ed2c | 385 | currently it is not used and labels are not recorded at all. */ |
c906108c | 386 | |
176620f1 | 387 | LABEL_DOMAIN, |
c906108c | 388 | |
176620f1 | 389 | /* Searching domains. These overlap with VAR_DOMAIN, providing |
17c5ed2c | 390 | some granularity with the search_symbols function. */ |
c906108c | 391 | |
176620f1 EZ |
392 | /* Everything in VAR_DOMAIN minus FUNCTIONS_-, TYPES_-, and |
393 | METHODS_DOMAIN */ | |
394 | VARIABLES_DOMAIN, | |
c906108c | 395 | |
17c5ed2c | 396 | /* All functions -- for some reason not methods, though. */ |
176620f1 | 397 | FUNCTIONS_DOMAIN, |
c906108c | 398 | |
17c5ed2c | 399 | /* All defined types */ |
176620f1 | 400 | TYPES_DOMAIN, |
c906108c | 401 | |
17c5ed2c | 402 | /* All class methods -- why is this separated out? */ |
176620f1 | 403 | METHODS_DOMAIN |
17c5ed2c | 404 | } |
176620f1 | 405 | domain_enum; |
c906108c SS |
406 | |
407 | /* An address-class says where to find the value of a symbol. */ | |
408 | ||
409 | enum address_class | |
17c5ed2c DC |
410 | { |
411 | /* Not used; catches errors */ | |
c5aa993b | 412 | |
17c5ed2c | 413 | LOC_UNDEF, |
c906108c | 414 | |
17c5ed2c | 415 | /* Value is constant int SYMBOL_VALUE, host byteorder */ |
c906108c | 416 | |
17c5ed2c | 417 | LOC_CONST, |
c906108c | 418 | |
17c5ed2c | 419 | /* Value is at fixed address SYMBOL_VALUE_ADDRESS */ |
c906108c | 420 | |
17c5ed2c | 421 | LOC_STATIC, |
c906108c | 422 | |
17c5ed2c | 423 | /* Value is in register. SYMBOL_VALUE is the register number. */ |
c906108c | 424 | |
17c5ed2c | 425 | LOC_REGISTER, |
c906108c | 426 | |
17c5ed2c | 427 | /* It's an argument; the value is at SYMBOL_VALUE offset in arglist. */ |
c906108c | 428 | |
17c5ed2c | 429 | LOC_ARG, |
c906108c | 430 | |
17c5ed2c | 431 | /* Value address is at SYMBOL_VALUE offset in arglist. */ |
c906108c | 432 | |
17c5ed2c | 433 | LOC_REF_ARG, |
c906108c | 434 | |
17c5ed2c DC |
435 | /* Value is in register number SYMBOL_VALUE. Just like LOC_REGISTER |
436 | except this is an argument. Probably the cleaner way to handle | |
437 | this would be to separate address_class (which would include | |
42efa47a AC |
438 | separate ARG and LOCAL to deal with the frame's arguments |
439 | (get_frame_args_address) versus the frame's locals | |
440 | (get_frame_locals_address), and an is_argument flag. | |
c906108c | 441 | |
17c5ed2c DC |
442 | For some symbol formats (stabs, for some compilers at least), |
443 | the compiler generates two symbols, an argument and a register. | |
444 | In some cases we combine them to a single LOC_REGPARM in symbol | |
445 | reading, but currently not for all cases (e.g. it's passed on the | |
446 | stack and then loaded into a register). */ | |
c906108c | 447 | |
17c5ed2c | 448 | LOC_REGPARM, |
c906108c | 449 | |
17c5ed2c DC |
450 | /* Value is in specified register. Just like LOC_REGPARM except the |
451 | register holds the address of the argument instead of the argument | |
452 | itself. This is currently used for the passing of structs and unions | |
453 | on sparc and hppa. It is also used for call by reference where the | |
454 | address is in a register, at least by mipsread.c. */ | |
c906108c | 455 | |
17c5ed2c | 456 | LOC_REGPARM_ADDR, |
c906108c | 457 | |
17c5ed2c | 458 | /* Value is a local variable at SYMBOL_VALUE offset in stack frame. */ |
c906108c | 459 | |
17c5ed2c | 460 | LOC_LOCAL, |
c906108c | 461 | |
176620f1 EZ |
462 | /* Value not used; definition in SYMBOL_TYPE. Symbols in the domain |
463 | STRUCT_DOMAIN all have this class. */ | |
c906108c | 464 | |
17c5ed2c | 465 | LOC_TYPEDEF, |
c906108c | 466 | |
17c5ed2c | 467 | /* Value is address SYMBOL_VALUE_ADDRESS in the code */ |
c906108c | 468 | |
17c5ed2c | 469 | LOC_LABEL, |
c906108c | 470 | |
17c5ed2c DC |
471 | /* In a symbol table, value is SYMBOL_BLOCK_VALUE of a `struct block'. |
472 | In a partial symbol table, SYMBOL_VALUE_ADDRESS is the start address | |
473 | of the block. Function names have this class. */ | |
c906108c | 474 | |
17c5ed2c | 475 | LOC_BLOCK, |
c906108c | 476 | |
17c5ed2c DC |
477 | /* Value is a constant byte-sequence pointed to by SYMBOL_VALUE_BYTES, in |
478 | target byte order. */ | |
c906108c | 479 | |
17c5ed2c | 480 | LOC_CONST_BYTES, |
c906108c | 481 | |
17c5ed2c DC |
482 | /* Value is arg at SYMBOL_VALUE offset in stack frame. Differs from |
483 | LOC_LOCAL in that symbol is an argument; differs from LOC_ARG in | |
42efa47a AC |
484 | that we find it in the frame (get_frame_locals_address), not in |
485 | the arglist (get_frame_args_address). Added for i960, which | |
486 | passes args in regs then copies to frame. */ | |
c906108c | 487 | |
17c5ed2c | 488 | LOC_LOCAL_ARG, |
c906108c | 489 | |
17c5ed2c DC |
490 | /* Value is at SYMBOL_VALUE offset from the current value of |
491 | register number SYMBOL_BASEREG. This exists mainly for the same | |
492 | things that LOC_LOCAL and LOC_ARG do; but we need to do this | |
493 | instead because on 88k DWARF gives us the offset from the | |
494 | frame/stack pointer, rather than the offset from the "canonical | |
495 | frame address" used by COFF, stabs, etc., and we don't know how | |
496 | to convert between these until we start examining prologues. | |
c906108c | 497 | |
17c5ed2c DC |
498 | Note that LOC_BASEREG is much less general than a DWARF expression. |
499 | We don't need the generality (at least not yet), and storing a general | |
500 | DWARF expression would presumably take up more space than the existing | |
501 | scheme. */ | |
c906108c | 502 | |
17c5ed2c | 503 | LOC_BASEREG, |
c906108c | 504 | |
17c5ed2c | 505 | /* Same as LOC_BASEREG but it is an argument. */ |
c906108c | 506 | |
17c5ed2c | 507 | LOC_BASEREG_ARG, |
c906108c | 508 | |
17c5ed2c DC |
509 | /* Value is at fixed address, but the address of the variable has |
510 | to be determined from the minimal symbol table whenever the | |
511 | variable is referenced. | |
512 | This happens if debugging information for a global symbol is | |
513 | emitted and the corresponding minimal symbol is defined | |
514 | in another object file or runtime common storage. | |
515 | The linker might even remove the minimal symbol if the global | |
516 | symbol is never referenced, in which case the symbol remains | |
517 | unresolved. */ | |
c906108c | 518 | |
17c5ed2c | 519 | LOC_UNRESOLVED, |
c906108c | 520 | |
17c5ed2c | 521 | /* Value is at a thread-specific location calculated by a |
407caf07 | 522 | target-specific method. This is used only by hppa. */ |
c906108c | 523 | |
407caf07 | 524 | LOC_HP_THREAD_LOCAL_STATIC, |
c906108c | 525 | |
17c5ed2c DC |
526 | /* The variable does not actually exist in the program. |
527 | The value is ignored. */ | |
c906108c | 528 | |
17c5ed2c | 529 | LOC_OPTIMIZED_OUT, |
c906108c | 530 | |
17c5ed2c DC |
531 | /* The variable is static, but actually lives at * (address). |
532 | * I.e. do an extra indirection to get to it. | |
533 | * This is used on HP-UX to get at globals that are allocated | |
534 | * in shared libraries, where references from images other | |
535 | * than the one where the global was allocated are done | |
536 | * with a level of indirection. | |
537 | */ | |
c906108c | 538 | |
4c2df51b DJ |
539 | LOC_INDIRECT, |
540 | ||
541 | /* The variable's address is computed by a set of location | |
542 | functions (see "struct location_funcs" below). */ | |
543 | LOC_COMPUTED, | |
544 | ||
545 | /* Same as LOC_COMPUTED, but for function arguments. */ | |
546 | LOC_COMPUTED_ARG | |
547 | }; | |
548 | ||
549 | /* A structure of function pointers describing the location of a | |
550 | variable, structure member, or structure base class. | |
551 | ||
552 | These functions' BATON arguments are generic data pointers, holding | |
553 | whatever data the functions need --- the code which provides this | |
554 | structure also provides the actual contents of the baton, and | |
555 | decides its form. However, there may be other rules about where | |
556 | the baton data must be allocated; whoever is pointing to this | |
557 | `struct location_funcs' object will know the rules. For example, | |
558 | when a symbol S's location is LOC_COMPUTED, then | |
559 | SYMBOL_LOCATION_FUNCS(S) is pointing to a location_funcs structure, | |
560 | and SYMBOL_LOCATION_BATON(S) is the baton, which must be allocated | |
561 | on the same obstack as the symbol itself. */ | |
562 | ||
563 | struct location_funcs | |
564 | { | |
565 | ||
566 | /* Return the value of the variable SYMBOL, relative to the stack | |
567 | frame FRAME. If the variable has been optimized out, return | |
568 | zero. | |
569 | ||
570 | Iff `read_needs_frame (SYMBOL)' is zero, then FRAME may be zero. */ | |
571 | ||
572 | struct value *(*read_variable) (struct symbol * symbol, | |
573 | struct frame_info * frame); | |
574 | ||
575 | /* Return non-zero if we need a frame to find the value of the SYMBOL. */ | |
576 | int (*read_needs_frame) (struct symbol * symbol); | |
577 | ||
578 | /* Write to STREAM a natural-language description of the location of | |
579 | SYMBOL. */ | |
580 | int (*describe_location) (struct symbol * symbol, struct ui_file * stream); | |
581 | ||
582 | /* Tracepoint support. Append bytecodes to the tracepoint agent | |
583 | expression AX that push the address of the object SYMBOL. Set | |
584 | VALUE appropriately. Note --- for objects in registers, this | |
585 | needn't emit any code; as long as it sets VALUE properly, then | |
586 | the caller will generate the right code in the process of | |
587 | treating this as an lvalue or rvalue. */ | |
588 | ||
589 | void (*tracepoint_var_ref) (struct symbol * symbol, struct agent_expr * ax, | |
590 | struct axs_value * value); | |
17c5ed2c | 591 | }; |
c906108c | 592 | |
a7f19c79 MC |
593 | /* This structure is space critical. See space comments at the top. */ |
594 | ||
c906108c | 595 | struct symbol |
17c5ed2c | 596 | { |
c906108c | 597 | |
17c5ed2c | 598 | /* The general symbol info required for all types of symbols. */ |
c906108c | 599 | |
17c5ed2c | 600 | struct general_symbol_info ginfo; |
c906108c | 601 | |
17c5ed2c | 602 | /* Data type of value */ |
c906108c | 603 | |
17c5ed2c | 604 | struct type *type; |
c906108c | 605 | |
176620f1 | 606 | /* Domain code. */ |
c906108c | 607 | |
87193939 | 608 | ENUM_BITFIELD(domain_enum_tag) domain : 6; |
c906108c | 609 | |
17c5ed2c | 610 | /* Address class */ |
c906108c | 611 | |
87193939 | 612 | ENUM_BITFIELD(address_class) aclass : 6; |
c906108c | 613 | |
17c5ed2c DC |
614 | /* Line number of definition. FIXME: Should we really make the assumption |
615 | that nobody will try to debug files longer than 64K lines? What about | |
616 | machine generated programs? */ | |
c906108c | 617 | |
17c5ed2c | 618 | unsigned short line; |
c906108c | 619 | |
17c5ed2c DC |
620 | /* Some symbols require an additional value to be recorded on a per- |
621 | symbol basis. Stash those values here. */ | |
c5aa993b | 622 | |
17c5ed2c DC |
623 | union |
624 | { | |
625 | /* Used by LOC_BASEREG and LOC_BASEREG_ARG. */ | |
626 | short basereg; | |
9d774e44 | 627 | |
4c2df51b DJ |
628 | /* For a LOC_COMPUTED or LOC_COMPUTED_ARG symbol, this is the |
629 | baton and location_funcs structure to find its location. For a | |
630 | LOC_BLOCK symbol for a function in a compilation unit compiled | |
631 | with DWARF 2 information, this is information used internally | |
632 | by the DWARF 2 code --- specifically, the location expression | |
633 | for the frame base for this function. */ | |
634 | /* FIXME drow/2003-02-21: For the LOC_BLOCK case, it might be better | |
635 | to add a magic symbol to the block containing this information, | |
636 | or to have a generic debug info annotation slot for symbols. */ | |
637 | struct | |
638 | { | |
639 | void *baton; | |
640 | struct location_funcs *funcs; | |
641 | } loc; | |
17c5ed2c DC |
642 | } |
643 | aux_value; | |
c906108c | 644 | |
17c5ed2c DC |
645 | struct symbol *hash_next; |
646 | }; | |
c906108c SS |
647 | |
648 | ||
176620f1 | 649 | #define SYMBOL_DOMAIN(symbol) (symbol)->domain |
c906108c SS |
650 | #define SYMBOL_CLASS(symbol) (symbol)->aclass |
651 | #define SYMBOL_TYPE(symbol) (symbol)->type | |
652 | #define SYMBOL_LINE(symbol) (symbol)->line | |
653 | #define SYMBOL_BASEREG(symbol) (symbol)->aux_value.basereg | |
9d774e44 | 654 | #define SYMBOL_OBJFILE(symbol) (symbol)->aux_value.objfile |
4c2df51b DJ |
655 | #define SYMBOL_LOCATION_BATON(symbol) (symbol)->aux_value.loc.baton |
656 | #define SYMBOL_LOCATION_FUNCS(symbol) (symbol)->aux_value.loc.funcs | |
c906108c | 657 | \f |
176620f1 | 658 | /* A partial_symbol records the name, domain, and address class of |
c906108c SS |
659 | symbols whose types we have not parsed yet. For functions, it also |
660 | contains their memory address, so we can find them from a PC value. | |
661 | Each partial_symbol sits in a partial_symtab, all of which are chained | |
a960f249 | 662 | on a partial symtab list and which points to the corresponding |
c906108c SS |
663 | normal symtab once the partial_symtab has been referenced. */ |
664 | ||
a7f19c79 MC |
665 | /* This structure is space critical. See space comments at the top. */ |
666 | ||
c906108c | 667 | struct partial_symbol |
17c5ed2c | 668 | { |
c906108c | 669 | |
17c5ed2c | 670 | /* The general symbol info required for all types of symbols. */ |
c906108c | 671 | |
17c5ed2c | 672 | struct general_symbol_info ginfo; |
c906108c | 673 | |
17c5ed2c | 674 | /* Name space code. */ |
c906108c | 675 | |
87193939 | 676 | ENUM_BITFIELD(domain_enum_tag) domain : 6; |
c906108c | 677 | |
17c5ed2c | 678 | /* Address class (for info_symbols) */ |
c906108c | 679 | |
87193939 | 680 | ENUM_BITFIELD(address_class) aclass : 6; |
c906108c | 681 | |
17c5ed2c | 682 | }; |
c906108c | 683 | |
176620f1 | 684 | #define PSYMBOL_DOMAIN(psymbol) (psymbol)->domain |
c906108c | 685 | #define PSYMBOL_CLASS(psymbol) (psymbol)->aclass |
c906108c | 686 | \f |
c5aa993b | 687 | |
c906108c SS |
688 | /* Each item represents a line-->pc (or the reverse) mapping. This is |
689 | somewhat more wasteful of space than one might wish, but since only | |
690 | the files which are actually debugged are read in to core, we don't | |
691 | waste much space. */ | |
692 | ||
693 | struct linetable_entry | |
17c5ed2c DC |
694 | { |
695 | int line; | |
696 | CORE_ADDR pc; | |
697 | }; | |
c906108c SS |
698 | |
699 | /* The order of entries in the linetable is significant. They should | |
700 | be sorted by increasing values of the pc field. If there is more than | |
701 | one entry for a given pc, then I'm not sure what should happen (and | |
702 | I not sure whether we currently handle it the best way). | |
703 | ||
704 | Example: a C for statement generally looks like this | |
705 | ||
c5aa993b JM |
706 | 10 0x100 - for the init/test part of a for stmt. |
707 | 20 0x200 | |
708 | 30 0x300 | |
709 | 10 0x400 - for the increment part of a for stmt. | |
c906108c | 710 | |
e8717518 FF |
711 | If an entry has a line number of zero, it marks the start of a PC |
712 | range for which no line number information is available. It is | |
713 | acceptable, though wasteful of table space, for such a range to be | |
714 | zero length. */ | |
c906108c SS |
715 | |
716 | struct linetable | |
17c5ed2c DC |
717 | { |
718 | int nitems; | |
c906108c | 719 | |
17c5ed2c DC |
720 | /* Actually NITEMS elements. If you don't like this use of the |
721 | `struct hack', you can shove it up your ANSI (seriously, if the | |
722 | committee tells us how to do it, we can probably go along). */ | |
723 | struct linetable_entry item[1]; | |
724 | }; | |
c906108c | 725 | |
c906108c SS |
726 | /* How to relocate the symbols from each section in a symbol file. |
727 | Each struct contains an array of offsets. | |
728 | The ordering and meaning of the offsets is file-type-dependent; | |
729 | typically it is indexed by section numbers or symbol types or | |
730 | something like that. | |
731 | ||
732 | To give us flexibility in changing the internal representation | |
733 | of these offsets, the ANOFFSET macro must be used to insert and | |
734 | extract offset values in the struct. */ | |
735 | ||
736 | struct section_offsets | |
17c5ed2c DC |
737 | { |
738 | CORE_ADDR offsets[1]; /* As many as needed. */ | |
739 | }; | |
c906108c | 740 | |
a4c8257b | 741 | #define ANOFFSET(secoff, whichone) \ |
8e65ff28 AC |
742 | ((whichone == -1) \ |
743 | ? (internal_error (__FILE__, __LINE__, "Section index is uninitialized"), -1) \ | |
744 | : secoff->offsets[whichone]) | |
c906108c | 745 | |
b29c9944 JB |
746 | /* The size of a section_offsets table for N sections. */ |
747 | #define SIZEOF_N_SECTION_OFFSETS(n) \ | |
c906108c | 748 | (sizeof (struct section_offsets) \ |
b29c9944 JB |
749 | + sizeof (((struct section_offsets *) 0)->offsets) * ((n)-1)) |
750 | ||
a960f249 | 751 | /* Each source file or header is represented by a struct symtab. |
c906108c SS |
752 | These objects are chained through the `next' field. */ |
753 | ||
754 | struct symtab | |
17c5ed2c | 755 | { |
c906108c | 756 | |
17c5ed2c | 757 | /* Chain of all existing symtabs. */ |
c906108c | 758 | |
17c5ed2c | 759 | struct symtab *next; |
c906108c | 760 | |
17c5ed2c DC |
761 | /* List of all symbol scope blocks for this symtab. May be shared |
762 | between different symtabs (and normally is for all the symtabs | |
763 | in a given compilation unit). */ | |
c906108c | 764 | |
17c5ed2c | 765 | struct blockvector *blockvector; |
c906108c | 766 | |
17c5ed2c DC |
767 | /* Table mapping core addresses to line numbers for this file. |
768 | Can be NULL if none. Never shared between different symtabs. */ | |
c906108c | 769 | |
17c5ed2c | 770 | struct linetable *linetable; |
c906108c | 771 | |
17c5ed2c DC |
772 | /* Section in objfile->section_offsets for the blockvector and |
773 | the linetable. Probably always SECT_OFF_TEXT. */ | |
c906108c | 774 | |
17c5ed2c | 775 | int block_line_section; |
c906108c | 776 | |
17c5ed2c DC |
777 | /* If several symtabs share a blockvector, exactly one of them |
778 | should be designated the primary, so that the blockvector | |
779 | is relocated exactly once by objfile_relocate. */ | |
c906108c | 780 | |
17c5ed2c | 781 | int primary; |
c906108c | 782 | |
17c5ed2c DC |
783 | /* The macro table for this symtab. Like the blockvector, this |
784 | may be shared between different symtabs --- and normally is for | |
785 | all the symtabs in a given compilation unit. */ | |
786 | struct macro_table *macro_table; | |
99d9066e | 787 | |
17c5ed2c | 788 | /* Name of this source file. */ |
c906108c | 789 | |
17c5ed2c | 790 | char *filename; |
c906108c | 791 | |
17c5ed2c | 792 | /* Directory in which it was compiled, or NULL if we don't know. */ |
c906108c | 793 | |
17c5ed2c | 794 | char *dirname; |
c906108c | 795 | |
17c5ed2c DC |
796 | /* This component says how to free the data we point to: |
797 | free_contents => do a tree walk and free each object. | |
798 | free_nothing => do nothing; some other symtab will free | |
799 | the data this one uses. | |
800 | free_linetable => free just the linetable. FIXME: Is this redundant | |
801 | with the primary field? */ | |
c906108c | 802 | |
17c5ed2c DC |
803 | enum free_code |
804 | { | |
805 | free_nothing, free_contents, free_linetable | |
806 | } | |
807 | free_code; | |
c906108c | 808 | |
de4f826b DC |
809 | /* A function to call to free space, if necessary. This is IN |
810 | ADDITION to the action indicated by free_code. */ | |
c5aa993b | 811 | |
de4f826b | 812 | void (*free_func)(struct symtab *symtab); |
c906108c | 813 | |
17c5ed2c | 814 | /* Total number of lines found in source file. */ |
c906108c | 815 | |
17c5ed2c | 816 | int nlines; |
c906108c | 817 | |
17c5ed2c DC |
818 | /* line_charpos[N] is the position of the (N-1)th line of the |
819 | source file. "position" means something we can lseek() to; it | |
820 | is not guaranteed to be useful any other way. */ | |
c906108c | 821 | |
17c5ed2c | 822 | int *line_charpos; |
c906108c | 823 | |
17c5ed2c | 824 | /* Language of this source file. */ |
c906108c | 825 | |
17c5ed2c | 826 | enum language language; |
c906108c | 827 | |
17c5ed2c DC |
828 | /* String that identifies the format of the debugging information, such |
829 | as "stabs", "dwarf 1", "dwarf 2", "coff", etc. This is mostly useful | |
830 | for automated testing of gdb but may also be information that is | |
831 | useful to the user. */ | |
c906108c | 832 | |
17c5ed2c | 833 | char *debugformat; |
c906108c | 834 | |
17c5ed2c | 835 | /* String of version information. May be zero. */ |
c906108c | 836 | |
17c5ed2c | 837 | char *version; |
c906108c | 838 | |
17c5ed2c DC |
839 | /* Full name of file as found by searching the source path. |
840 | NULL if not yet known. */ | |
c906108c | 841 | |
17c5ed2c | 842 | char *fullname; |
c906108c | 843 | |
17c5ed2c | 844 | /* Object file from which this symbol information was read. */ |
c906108c | 845 | |
17c5ed2c | 846 | struct objfile *objfile; |
c906108c | 847 | |
17c5ed2c | 848 | }; |
c906108c SS |
849 | |
850 | #define BLOCKVECTOR(symtab) (symtab)->blockvector | |
851 | #define LINETABLE(symtab) (symtab)->linetable | |
c906108c | 852 | \f |
c5aa993b | 853 | |
c906108c SS |
854 | /* Each source file that has not been fully read in is represented by |
855 | a partial_symtab. This contains the information on where in the | |
856 | executable the debugging symbols for a specific file are, and a | |
857 | list of names of global symbols which are located in this file. | |
858 | They are all chained on partial symtab lists. | |
859 | ||
860 | Even after the source file has been read into a symtab, the | |
861 | partial_symtab remains around. They are allocated on an obstack, | |
862 | psymbol_obstack. FIXME, this is bad for dynamic linking or VxWorks- | |
863 | style execution of a bunch of .o's. */ | |
864 | ||
865 | struct partial_symtab | |
17c5ed2c | 866 | { |
c906108c | 867 | |
17c5ed2c | 868 | /* Chain of all existing partial symtabs. */ |
c906108c | 869 | |
17c5ed2c | 870 | struct partial_symtab *next; |
c906108c | 871 | |
17c5ed2c | 872 | /* Name of the source file which this partial_symtab defines */ |
c906108c | 873 | |
17c5ed2c | 874 | char *filename; |
c906108c | 875 | |
17c5ed2c | 876 | /* Full path of the source file. NULL if not known. */ |
58d370e0 | 877 | |
17c5ed2c | 878 | char *fullname; |
58d370e0 | 879 | |
17c5ed2c | 880 | /* Information about the object file from which symbols should be read. */ |
c906108c | 881 | |
17c5ed2c | 882 | struct objfile *objfile; |
c906108c | 883 | |
17c5ed2c | 884 | /* Set of relocation offsets to apply to each section. */ |
c906108c | 885 | |
17c5ed2c | 886 | struct section_offsets *section_offsets; |
c906108c | 887 | |
17c5ed2c DC |
888 | /* Range of text addresses covered by this file; texthigh is the |
889 | beginning of the next section. */ | |
c906108c | 890 | |
17c5ed2c DC |
891 | CORE_ADDR textlow; |
892 | CORE_ADDR texthigh; | |
c906108c | 893 | |
17c5ed2c DC |
894 | /* Array of pointers to all of the partial_symtab's which this one |
895 | depends on. Since this array can only be set to previous or | |
896 | the current (?) psymtab, this dependency tree is guaranteed not | |
897 | to have any loops. "depends on" means that symbols must be read | |
898 | for the dependencies before being read for this psymtab; this is | |
899 | for type references in stabs, where if foo.c includes foo.h, declarations | |
900 | in foo.h may use type numbers defined in foo.c. For other debugging | |
901 | formats there may be no need to use dependencies. */ | |
c906108c | 902 | |
17c5ed2c | 903 | struct partial_symtab **dependencies; |
c906108c | 904 | |
17c5ed2c | 905 | int number_of_dependencies; |
c906108c | 906 | |
17c5ed2c DC |
907 | /* Global symbol list. This list will be sorted after readin to |
908 | improve access. Binary search will be the usual method of | |
909 | finding a symbol within it. globals_offset is an integer offset | |
910 | within global_psymbols[]. */ | |
c906108c | 911 | |
17c5ed2c DC |
912 | int globals_offset; |
913 | int n_global_syms; | |
c906108c | 914 | |
17c5ed2c DC |
915 | /* Static symbol list. This list will *not* be sorted after readin; |
916 | to find a symbol in it, exhaustive search must be used. This is | |
917 | reasonable because searches through this list will eventually | |
918 | lead to either the read in of a files symbols for real (assumed | |
919 | to take a *lot* of time; check) or an error (and we don't care | |
920 | how long errors take). This is an offset and size within | |
921 | static_psymbols[]. */ | |
c906108c | 922 | |
17c5ed2c DC |
923 | int statics_offset; |
924 | int n_static_syms; | |
c906108c | 925 | |
17c5ed2c DC |
926 | /* Pointer to symtab eventually allocated for this source file, 0 if |
927 | !readin or if we haven't looked for the symtab after it was readin. */ | |
c906108c | 928 | |
17c5ed2c | 929 | struct symtab *symtab; |
c906108c | 930 | |
17c5ed2c DC |
931 | /* Pointer to function which will read in the symtab corresponding to |
932 | this psymtab. */ | |
c906108c | 933 | |
17c5ed2c | 934 | void (*read_symtab) (struct partial_symtab *); |
c906108c | 935 | |
17c5ed2c DC |
936 | /* Information that lets read_symtab() locate the part of the symbol table |
937 | that this psymtab corresponds to. This information is private to the | |
938 | format-dependent symbol reading routines. For further detail examine | |
939 | the various symbol reading modules. Should really be (void *) but is | |
940 | (char *) as with other such gdb variables. (FIXME) */ | |
c906108c | 941 | |
17c5ed2c | 942 | char *read_symtab_private; |
c906108c | 943 | |
17c5ed2c | 944 | /* Non-zero if the symtab corresponding to this psymtab has been readin */ |
c906108c | 945 | |
17c5ed2c DC |
946 | unsigned char readin; |
947 | }; | |
c906108c SS |
948 | |
949 | /* A fast way to get from a psymtab to its symtab (after the first time). */ | |
950 | #define PSYMTAB_TO_SYMTAB(pst) \ | |
951 | ((pst) -> symtab != NULL ? (pst) -> symtab : psymtab_to_symtab (pst)) | |
c906108c | 952 | \f |
c5aa993b | 953 | |
c906108c | 954 | /* The virtual function table is now an array of structures which have the |
a960f249 | 955 | form { int16 offset, delta; void *pfn; }. |
c906108c SS |
956 | |
957 | In normal virtual function tables, OFFSET is unused. | |
958 | DELTA is the amount which is added to the apparent object's base | |
959 | address in order to point to the actual object to which the | |
960 | virtual function should be applied. | |
961 | PFN is a pointer to the virtual function. | |
962 | ||
963 | Note that this macro is g++ specific (FIXME). */ | |
c5aa993b | 964 | |
c906108c SS |
965 | #define VTBL_FNADDR_OFFSET 2 |
966 | ||
c906108c SS |
967 | /* External variables and functions for the objects described above. */ |
968 | ||
c906108c SS |
969 | /* See the comment in symfile.c about how current_objfile is used. */ |
970 | ||
971 | extern struct objfile *current_objfile; | |
972 | ||
973 | /* True if we are nested inside psymtab_to_symtab. */ | |
974 | ||
975 | extern int currently_reading_symtab; | |
976 | ||
977 | /* From utils.c. */ | |
978 | extern int demangle; | |
979 | extern int asm_demangle; | |
980 | ||
981 | /* symtab.c lookup functions */ | |
982 | ||
983 | /* lookup a symbol table by source file name */ | |
984 | ||
1f8cc6db | 985 | extern struct symtab *lookup_symtab (const char *); |
c906108c SS |
986 | |
987 | /* lookup a symbol by name (optional block, optional symtab) */ | |
988 | ||
a14ed312 | 989 | extern struct symbol *lookup_symbol (const char *, const struct block *, |
176620f1 | 990 | const domain_enum, int *, |
a14ed312 | 991 | struct symtab **); |
c906108c | 992 | |
5f9a71c3 DC |
993 | /* A default version of lookup_symbol_nonlocal for use by languages |
994 | that can't think of anything better to do. */ | |
995 | ||
996 | extern struct symbol *basic_lookup_symbol_nonlocal (const char *, | |
997 | const char *, | |
998 | const struct block *, | |
999 | const domain_enum, | |
1000 | struct symtab **); | |
1001 | ||
1002 | /* Some helper functions for languages that need to write their own | |
1003 | lookup_symbol_nonlocal functions. */ | |
1004 | ||
1005 | /* Lookup a symbol in the static block associated to BLOCK, if there | |
1006 | is one; do nothing if BLOCK is NULL or a global block. */ | |
1007 | ||
1008 | extern struct symbol *lookup_symbol_static (const char *name, | |
1009 | const char *linkage_name, | |
1010 | const struct block *block, | |
1011 | const domain_enum domain, | |
1012 | struct symtab **symtab); | |
1013 | ||
1014 | /* Lookup a symbol in all files' global blocks (searching psymtabs if | |
1015 | necessary). */ | |
1016 | ||
1017 | extern struct symbol *lookup_symbol_global (const char *name, | |
1018 | const char *linkage_name, | |
1019 | const domain_enum domain, | |
1020 | struct symtab **symtab); | |
1021 | ||
1022 | /* Lookup a symbol within the block BLOCK. This, unlike | |
1023 | lookup_symbol_block, will set SYMTAB and BLOCK_FOUND correctly, and | |
1024 | will fix up the symbol if necessary. */ | |
1025 | ||
1026 | extern struct symbol *lookup_symbol_aux_block (const char *name, | |
1027 | const char *linkage_name, | |
1028 | const struct block *block, | |
1029 | const domain_enum domain, | |
1030 | struct symtab **symtab); | |
1031 | ||
b6429628 DC |
1032 | /* Lookup a partial symbol. */ |
1033 | ||
1034 | extern struct partial_symbol *lookup_partial_symbol (struct partial_symtab *, | |
1035 | const char *, | |
1036 | const char *, int, | |
1037 | domain_enum); | |
1038 | ||
c906108c | 1039 | /* lookup a symbol by name, within a specified block */ |
c5aa993b | 1040 | |
a14ed312 | 1041 | extern struct symbol *lookup_block_symbol (const struct block *, const char *, |
3121eff0 | 1042 | const char *, |
176620f1 | 1043 | const domain_enum); |
c906108c SS |
1044 | |
1045 | /* lookup a [struct, union, enum] by name, within a specified block */ | |
1046 | ||
a14ed312 | 1047 | extern struct type *lookup_struct (char *, struct block *); |
c906108c | 1048 | |
a14ed312 | 1049 | extern struct type *lookup_union (char *, struct block *); |
c906108c | 1050 | |
a14ed312 | 1051 | extern struct type *lookup_enum (char *, struct block *); |
c906108c | 1052 | |
c906108c SS |
1053 | /* from blockframe.c: */ |
1054 | ||
1055 | /* lookup the function symbol corresponding to the address */ | |
1056 | ||
a14ed312 | 1057 | extern struct symbol *find_pc_function (CORE_ADDR); |
c906108c SS |
1058 | |
1059 | /* lookup the function corresponding to the address and section */ | |
1060 | ||
a14ed312 | 1061 | extern struct symbol *find_pc_sect_function (CORE_ADDR, asection *); |
c5aa993b | 1062 | |
c906108c SS |
1063 | /* lookup function from address, return name, start addr and end addr */ |
1064 | ||
570b8f7c AC |
1065 | extern int find_pc_partial_function (CORE_ADDR, char **, CORE_ADDR *, |
1066 | CORE_ADDR *); | |
c906108c | 1067 | |
a14ed312 | 1068 | extern void clear_pc_function_cache (void); |
c906108c | 1069 | |
5ae5f592 AC |
1070 | extern int find_pc_sect_partial_function (CORE_ADDR, asection *, |
1071 | char **, CORE_ADDR *, CORE_ADDR *); | |
c906108c SS |
1072 | |
1073 | /* from symtab.c: */ | |
1074 | ||
1075 | /* lookup partial symbol table by filename */ | |
1076 | ||
1f8cc6db | 1077 | extern struct partial_symtab *lookup_partial_symtab (const char *); |
c906108c SS |
1078 | |
1079 | /* lookup partial symbol table by address */ | |
1080 | ||
a14ed312 | 1081 | extern struct partial_symtab *find_pc_psymtab (CORE_ADDR); |
c906108c SS |
1082 | |
1083 | /* lookup partial symbol table by address and section */ | |
1084 | ||
a14ed312 | 1085 | extern struct partial_symtab *find_pc_sect_psymtab (CORE_ADDR, asection *); |
c906108c SS |
1086 | |
1087 | /* lookup full symbol table by address */ | |
1088 | ||
a14ed312 | 1089 | extern struct symtab *find_pc_symtab (CORE_ADDR); |
c906108c SS |
1090 | |
1091 | /* lookup full symbol table by address and section */ | |
1092 | ||
a14ed312 | 1093 | extern struct symtab *find_pc_sect_symtab (CORE_ADDR, asection *); |
c906108c SS |
1094 | |
1095 | /* lookup partial symbol by address */ | |
1096 | ||
a14ed312 KB |
1097 | extern struct partial_symbol *find_pc_psymbol (struct partial_symtab *, |
1098 | CORE_ADDR); | |
c906108c SS |
1099 | |
1100 | /* lookup partial symbol by address and section */ | |
1101 | ||
a14ed312 KB |
1102 | extern struct partial_symbol *find_pc_sect_psymbol (struct partial_symtab *, |
1103 | CORE_ADDR, asection *); | |
c906108c | 1104 | |
a14ed312 | 1105 | extern int find_pc_line_pc_range (CORE_ADDR, CORE_ADDR *, CORE_ADDR *); |
c906108c | 1106 | |
a14ed312 | 1107 | extern void reread_symbols (void); |
c906108c | 1108 | |
a14ed312 | 1109 | extern struct type *lookup_transparent_type (const char *); |
c906108c SS |
1110 | |
1111 | ||
1112 | /* Macro for name of symbol to indicate a file compiled with gcc. */ | |
1113 | #ifndef GCC_COMPILED_FLAG_SYMBOL | |
1114 | #define GCC_COMPILED_FLAG_SYMBOL "gcc_compiled." | |
1115 | #endif | |
1116 | ||
1117 | /* Macro for name of symbol to indicate a file compiled with gcc2. */ | |
1118 | #ifndef GCC2_COMPILED_FLAG_SYMBOL | |
1119 | #define GCC2_COMPILED_FLAG_SYMBOL "gcc2_compiled." | |
1120 | #endif | |
1121 | ||
1122 | /* Functions for dealing with the minimal symbol table, really a misc | |
1123 | address<->symbol mapping for things we don't have debug symbols for. */ | |
1124 | ||
a14ed312 KB |
1125 | extern void prim_record_minimal_symbol (const char *, CORE_ADDR, |
1126 | enum minimal_symbol_type, | |
1127 | struct objfile *); | |
c906108c SS |
1128 | |
1129 | extern struct minimal_symbol *prim_record_minimal_symbol_and_info | |
a14ed312 KB |
1130 | (const char *, CORE_ADDR, |
1131 | enum minimal_symbol_type, | |
1132 | char *info, int section, asection * bfd_section, struct objfile *); | |
c906108c | 1133 | |
a14ed312 | 1134 | extern unsigned int msymbol_hash_iw (const char *); |
9227b5eb | 1135 | |
a14ed312 | 1136 | extern unsigned int msymbol_hash (const char *); |
9227b5eb JB |
1137 | |
1138 | extern void | |
1139 | add_minsym_to_hash_table (struct minimal_symbol *sym, | |
1140 | struct minimal_symbol **table); | |
1141 | ||
a14ed312 KB |
1142 | extern struct minimal_symbol *lookup_minimal_symbol (const char *, |
1143 | const char *, | |
1144 | struct objfile *); | |
c906108c | 1145 | |
a14ed312 | 1146 | extern struct minimal_symbol *lookup_minimal_symbol_text (const char *, |
a14ed312 | 1147 | struct objfile *); |
c906108c | 1148 | |
a14ed312 | 1149 | struct minimal_symbol *lookup_minimal_symbol_solib_trampoline (const char *, |
a14ed312 KB |
1150 | struct objfile |
1151 | *); | |
c906108c | 1152 | |
a14ed312 | 1153 | extern struct minimal_symbol *lookup_minimal_symbol_by_pc (CORE_ADDR); |
c906108c | 1154 | |
a14ed312 KB |
1155 | extern struct minimal_symbol *lookup_minimal_symbol_by_pc_section (CORE_ADDR, |
1156 | asection | |
1157 | *); | |
c906108c | 1158 | |
a14ed312 KB |
1159 | extern struct minimal_symbol |
1160 | *lookup_solib_trampoline_symbol_by_pc (CORE_ADDR); | |
c906108c | 1161 | |
a14ed312 | 1162 | extern CORE_ADDR find_solib_trampoline_target (CORE_ADDR); |
c906108c | 1163 | |
a14ed312 | 1164 | extern void init_minimal_symbol_collection (void); |
c906108c | 1165 | |
56e290f4 | 1166 | extern struct cleanup *make_cleanup_discard_minimal_symbols (void); |
c906108c | 1167 | |
a14ed312 | 1168 | extern void install_minimal_symbols (struct objfile *); |
c906108c SS |
1169 | |
1170 | /* Sort all the minimal symbols in OBJFILE. */ | |
1171 | ||
a14ed312 | 1172 | extern void msymbols_sort (struct objfile *objfile); |
c906108c SS |
1173 | |
1174 | struct symtab_and_line | |
17c5ed2c DC |
1175 | { |
1176 | struct symtab *symtab; | |
1177 | asection *section; | |
1178 | /* Line number. Line numbers start at 1 and proceed through symtab->nlines. | |
1179 | 0 is never a valid line number; it is used to indicate that line number | |
1180 | information is not available. */ | |
1181 | int line; | |
1182 | ||
1183 | CORE_ADDR pc; | |
1184 | CORE_ADDR end; | |
1185 | }; | |
c906108c | 1186 | |
fe39c653 | 1187 | extern void init_sal (struct symtab_and_line *sal); |
c906108c SS |
1188 | |
1189 | struct symtabs_and_lines | |
17c5ed2c DC |
1190 | { |
1191 | struct symtab_and_line *sals; | |
1192 | int nelts; | |
1193 | }; | |
c5aa993b | 1194 | \f |
c906108c SS |
1195 | |
1196 | ||
c906108c SS |
1197 | /* Some types and macros needed for exception catchpoints. |
1198 | Can't put these in target.h because symtab_and_line isn't | |
1199 | known there. This file will be included by breakpoint.c, | |
1200 | hppa-tdep.c, etc. */ | |
1201 | ||
1202 | /* Enums for exception-handling support */ | |
c5aa993b | 1203 | enum exception_event_kind |
17c5ed2c DC |
1204 | { |
1205 | EX_EVENT_THROW, | |
1206 | EX_EVENT_CATCH | |
1207 | }; | |
c906108c SS |
1208 | |
1209 | /* Type for returning info about an exception */ | |
c5aa993b | 1210 | struct exception_event_record |
17c5ed2c DC |
1211 | { |
1212 | enum exception_event_kind kind; | |
1213 | struct symtab_and_line throw_sal; | |
1214 | struct symtab_and_line catch_sal; | |
1215 | /* This may need to be extended in the future, if | |
1216 | some platforms allow reporting more information, | |
1217 | such as point of rethrow, type of exception object, | |
1218 | type expected by catch clause, etc. */ | |
1219 | }; | |
c906108c SS |
1220 | |
1221 | #define CURRENT_EXCEPTION_KIND (current_exception_event->kind) | |
1222 | #define CURRENT_EXCEPTION_CATCH_SAL (current_exception_event->catch_sal) | |
1223 | #define CURRENT_EXCEPTION_CATCH_LINE (current_exception_event->catch_sal.line) | |
1224 | #define CURRENT_EXCEPTION_CATCH_FILE (current_exception_event->catch_sal.symtab->filename) | |
1225 | #define CURRENT_EXCEPTION_CATCH_PC (current_exception_event->catch_sal.pc) | |
1226 | #define CURRENT_EXCEPTION_THROW_SAL (current_exception_event->throw_sal) | |
1227 | #define CURRENT_EXCEPTION_THROW_LINE (current_exception_event->throw_sal.line) | |
1228 | #define CURRENT_EXCEPTION_THROW_FILE (current_exception_event->throw_sal.symtab->filename) | |
1229 | #define CURRENT_EXCEPTION_THROW_PC (current_exception_event->throw_sal.pc) | |
1230 | \f | |
1231 | ||
1232 | /* Given a pc value, return line number it is in. Second arg nonzero means | |
1233 | if pc is on the boundary use the previous statement's line number. */ | |
1234 | ||
a14ed312 | 1235 | extern struct symtab_and_line find_pc_line (CORE_ADDR, int); |
c906108c SS |
1236 | |
1237 | /* Same function, but specify a section as well as an address */ | |
1238 | ||
a14ed312 | 1239 | extern struct symtab_and_line find_pc_sect_line (CORE_ADDR, asection *, int); |
c906108c | 1240 | |
c906108c SS |
1241 | /* Given a symtab and line number, return the pc there. */ |
1242 | ||
a14ed312 | 1243 | extern int find_line_pc (struct symtab *, int, CORE_ADDR *); |
c906108c | 1244 | |
570b8f7c AC |
1245 | extern int find_line_pc_range (struct symtab_and_line, CORE_ADDR *, |
1246 | CORE_ADDR *); | |
c906108c | 1247 | |
a14ed312 | 1248 | extern void resolve_sal_pc (struct symtab_and_line *); |
c906108c SS |
1249 | |
1250 | /* Given a string, return the line specified by it. For commands like "list" | |
1251 | and "breakpoint". */ | |
1252 | ||
a14ed312 | 1253 | extern struct symtabs_and_lines decode_line_spec (char *, int); |
c906108c | 1254 | |
a14ed312 | 1255 | extern struct symtabs_and_lines decode_line_spec_1 (char *, int); |
c906108c | 1256 | |
c906108c SS |
1257 | /* Symmisc.c */ |
1258 | ||
a14ed312 | 1259 | void maintenance_print_symbols (char *, int); |
c906108c | 1260 | |
a14ed312 | 1261 | void maintenance_print_psymbols (char *, int); |
c906108c | 1262 | |
a14ed312 | 1263 | void maintenance_print_msymbols (char *, int); |
c906108c | 1264 | |
a14ed312 | 1265 | void maintenance_print_objfiles (char *, int); |
c906108c | 1266 | |
5e7b2f39 | 1267 | void maintenance_info_symtabs (char *, int); |
44ea7b70 | 1268 | |
5e7b2f39 | 1269 | void maintenance_info_psymtabs (char *, int); |
44ea7b70 | 1270 | |
a14ed312 | 1271 | void maintenance_check_symtabs (char *, int); |
c906108c SS |
1272 | |
1273 | /* maint.c */ | |
1274 | ||
a14ed312 | 1275 | void maintenance_print_statistics (char *, int); |
c906108c | 1276 | |
a14ed312 | 1277 | extern void free_symtab (struct symtab *); |
c906108c SS |
1278 | |
1279 | /* Symbol-reading stuff in symfile.c and solib.c. */ | |
1280 | ||
a14ed312 | 1281 | extern struct symtab *psymtab_to_symtab (struct partial_symtab *); |
c906108c | 1282 | |
a14ed312 | 1283 | extern void clear_solib (void); |
c906108c | 1284 | |
c906108c SS |
1285 | /* source.c */ |
1286 | ||
a14ed312 | 1287 | extern int identify_source_line (struct symtab *, int, int, CORE_ADDR); |
c906108c | 1288 | |
a14ed312 | 1289 | extern void print_source_lines (struct symtab *, int, int, int); |
c906108c | 1290 | |
a14ed312 | 1291 | extern void forget_cached_source_info (void); |
c906108c | 1292 | |
a14ed312 | 1293 | extern void select_source_symtab (struct symtab *); |
c906108c | 1294 | |
a14ed312 | 1295 | extern char **make_symbol_completion_list (char *, char *); |
c906108c | 1296 | |
c94fdfd0 EZ |
1297 | extern char **make_file_symbol_completion_list (char *, char *, char *); |
1298 | ||
c94fdfd0 EZ |
1299 | extern char **make_source_files_completion_list (char *, char *); |
1300 | ||
c906108c SS |
1301 | /* symtab.c */ |
1302 | ||
a14ed312 | 1303 | extern struct partial_symtab *find_main_psymtab (void); |
c906108c | 1304 | |
50641945 FN |
1305 | extern struct symtab *find_line_symtab (struct symtab *, int, int *, int *); |
1306 | ||
17c5ed2c DC |
1307 | extern struct symtab_and_line find_function_start_sal (struct symbol *sym, |
1308 | int); | |
50641945 | 1309 | |
c906108c SS |
1310 | /* symfile.c */ |
1311 | ||
a14ed312 | 1312 | extern void clear_symtab_users (void); |
c906108c | 1313 | |
a14ed312 | 1314 | extern enum language deduce_language_from_filename (char *); |
c906108c SS |
1315 | |
1316 | /* symtab.c */ | |
1317 | ||
a14ed312 | 1318 | extern int in_prologue (CORE_ADDR pc, CORE_ADDR func_start); |
c906108c | 1319 | |
a14ed312 KB |
1320 | extern struct symbol *fixup_symbol_section (struct symbol *, |
1321 | struct objfile *); | |
c906108c | 1322 | |
7a78d0ee KB |
1323 | extern struct partial_symbol *fixup_psymbol_section (struct partial_symbol |
1324 | *psym, | |
1325 | struct objfile *objfile); | |
1326 | ||
c906108c SS |
1327 | /* Symbol searching */ |
1328 | ||
1329 | /* When using search_symbols, a list of the following structs is returned. | |
7e73cedf | 1330 | Callers must free the search list using free_search_symbols! */ |
c906108c | 1331 | struct symbol_search |
17c5ed2c DC |
1332 | { |
1333 | /* The block in which the match was found. Could be, for example, | |
1334 | STATIC_BLOCK or GLOBAL_BLOCK. */ | |
1335 | int block; | |
c906108c | 1336 | |
17c5ed2c | 1337 | /* Information describing what was found. |
c906108c | 1338 | |
17c5ed2c DC |
1339 | If symtab abd symbol are NOT NULL, then information was found |
1340 | for this match. */ | |
1341 | struct symtab *symtab; | |
1342 | struct symbol *symbol; | |
c906108c | 1343 | |
17c5ed2c DC |
1344 | /* If msymbol is non-null, then a match was made on something for |
1345 | which only minimal_symbols exist. */ | |
1346 | struct minimal_symbol *msymbol; | |
c906108c | 1347 | |
17c5ed2c DC |
1348 | /* A link to the next match, or NULL for the end. */ |
1349 | struct symbol_search *next; | |
1350 | }; | |
c906108c | 1351 | |
176620f1 | 1352 | extern void search_symbols (char *, domain_enum, int, char **, |
a14ed312 KB |
1353 | struct symbol_search **); |
1354 | extern void free_search_symbols (struct symbol_search *); | |
17c5ed2c DC |
1355 | extern struct cleanup *make_cleanup_free_search_symbols (struct symbol_search |
1356 | *); | |
c906108c | 1357 | |
51cc5b07 AC |
1358 | /* The name of the ``main'' function. |
1359 | FIXME: cagney/2001-03-20: Can't make main_name() const since some | |
1360 | of the calling code currently assumes that the string isn't | |
1361 | const. */ | |
1362 | extern void set_main_name (const char *name); | |
17c5ed2c | 1363 | extern /*const */ char *main_name (void); |
51cc5b07 | 1364 | |
c906108c | 1365 | #endif /* !defined(SYMTAB_H) */ |