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