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