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