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