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