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