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