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