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