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