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