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