Commit | Line | Data |
---|---|---|
c906108c | 1 | /* Symbol table definitions for GDB. |
1bac305b | 2 | |
32d0add0 | 3 | Copyright (C) 1986-2015 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; |
06096720 AB |
41 | struct obj_section; |
42 | struct cmd_list_element; | |
c906108c | 43 | |
a7f19c79 MC |
44 | /* Some of the structures in this file are space critical. |
45 | The space-critical structures are: | |
46 | ||
47 | struct general_symbol_info | |
48 | struct symbol | |
49 | struct partial_symbol | |
50 | ||
5bccb4d1 | 51 | These structures are laid out to encourage good packing. |
a7f19c79 MC |
52 | They use ENUM_BITFIELD and short int fields, and they order the |
53 | structure members so that fields less than a word are next | |
c378eb4e | 54 | to each other so they can be packed together. */ |
a7f19c79 MC |
55 | |
56 | /* Rearranged: used ENUM_BITFIELD and rearranged field order in | |
57 | all the space critical structures (plus struct minimal_symbol). | |
58 | Memory usage dropped from 99360768 bytes to 90001408 bytes. | |
59 | I measured this with before-and-after tests of | |
60 | "HEAD-old-gdb -readnow HEAD-old-gdb" and | |
61 | "HEAD-new-gdb -readnow HEAD-old-gdb" on native i686-pc-linux-gnu, | |
62 | red hat linux 8, with LD_LIBRARY_PATH=/usr/lib/debug, | |
63 | typing "maint space 1" at the first command prompt. | |
64 | ||
65 | Here is another measurement (from andrew c): | |
66 | # no /usr/lib/debug, just plain glibc, like a normal user | |
67 | gdb HEAD-old-gdb | |
68 | (gdb) break internal_error | |
69 | (gdb) run | |
70 | (gdb) maint internal-error | |
71 | (gdb) backtrace | |
72 | (gdb) maint space 1 | |
73 | ||
74 | gdb gdb_6_0_branch 2003-08-19 space used: 8896512 | |
75 | gdb HEAD 2003-08-19 space used: 8904704 | |
76 | gdb HEAD 2003-08-21 space used: 8396800 (+symtab.h) | |
77 | gdb HEAD 2003-08-21 space used: 8265728 (+gdbtypes.h) | |
78 | ||
79 | The third line shows the savings from the optimizations in symtab.h. | |
80 | The fourth line shows the savings from the optimizations in | |
81 | gdbtypes.h. Both optimizations are in gdb HEAD now. | |
82 | ||
83 | --chastain 2003-08-21 */ | |
84 | ||
c906108c SS |
85 | /* Define a structure for the information that is common to all symbol types, |
86 | including minimal symbols, partial symbols, and full symbols. In a | |
87 | multilanguage environment, some language specific information may need to | |
c378eb4e | 88 | be recorded along with each symbol. */ |
c906108c | 89 | |
c378eb4e | 90 | /* This structure is space critical. See space comments at the top. */ |
c906108c SS |
91 | |
92 | struct general_symbol_info | |
17c5ed2c | 93 | { |
22abf04a | 94 | /* Name of the symbol. This is a required field. Storage for the |
4a146b47 EZ |
95 | name is allocated on the objfile_obstack for the associated |
96 | objfile. For languages like C++ that make a distinction between | |
97 | the mangled name and demangled name, this is the mangled | |
98 | name. */ | |
c906108c | 99 | |
0d5cff50 | 100 | const char *name; |
c906108c | 101 | |
17c5ed2c DC |
102 | /* Value of the symbol. Which member of this union to use, and what |
103 | it means, depends on what kind of symbol this is and its | |
104 | SYMBOL_CLASS. See comments there for more details. All of these | |
105 | are in host byte order (though what they point to might be in | |
106 | target byte order, e.g. LOC_CONST_BYTES). */ | |
c906108c | 107 | |
17c5ed2c DC |
108 | union |
109 | { | |
12df843f | 110 | LONGEST ivalue; |
c906108c | 111 | |
3977b71f | 112 | const struct block *block; |
c906108c | 113 | |
d47a1bc1 | 114 | const gdb_byte *bytes; |
c906108c | 115 | |
17c5ed2c | 116 | CORE_ADDR address; |
c906108c | 117 | |
5a352474 | 118 | /* A common block. Used with LOC_COMMON_BLOCK. */ |
4357ac6c | 119 | |
17a40b44 | 120 | const struct common_block *common_block; |
4357ac6c | 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 | { | |
f85f34ed TT |
133 | /* A pointer to an obstack that can be used for storage associated |
134 | with this symbol. This is only used by Ada, and only when the | |
135 | 'ada_mangled' field is zero. */ | |
136 | struct obstack *obstack; | |
137 | ||
afa16725 | 138 | /* This is used by languages which wish to store a demangled name. |
7c5fdd25 | 139 | currently used by Ada, C++, Java, and Objective C. */ |
afa16725 | 140 | struct mangled_lang |
17c5ed2c | 141 | { |
0d5cff50 | 142 | const char *demangled_name; |
17c5ed2c | 143 | } |
afa16725 | 144 | mangled_lang; |
17c5ed2c DC |
145 | } |
146 | language_specific; | |
c5aa993b | 147 | |
17c5ed2c DC |
148 | /* Record the source code language that applies to this symbol. |
149 | This is used to select one of the fields from the language specific | |
c378eb4e | 150 | union above. */ |
c5aa993b | 151 | |
51cdc993 | 152 | ENUM_BITFIELD(language) language : LANGUAGE_BITS; |
c5aa993b | 153 | |
f85f34ed TT |
154 | /* This is only used by Ada. If set, then the 'mangled_lang' field |
155 | of language_specific is valid. Otherwise, the 'obstack' field is | |
156 | valid. */ | |
157 | unsigned int ada_mangled : 1; | |
158 | ||
17c5ed2c DC |
159 | /* Which section is this symbol in? This is an index into |
160 | section_offsets for this objfile. Negative means that the symbol | |
e27d198c | 161 | does not get relocated relative to a section. */ |
c5aa993b | 162 | |
17c5ed2c | 163 | short section; |
17c5ed2c | 164 | }; |
c906108c | 165 | |
cfc594ee TT |
166 | extern void symbol_set_demangled_name (struct general_symbol_info *, |
167 | const char *, | |
ccde22c0 | 168 | struct obstack *); |
b250c185 | 169 | |
0d5cff50 DE |
170 | extern const char *symbol_get_demangled_name |
171 | (const struct general_symbol_info *); | |
b250c185 | 172 | |
714835d5 | 173 | extern CORE_ADDR symbol_overlayed_address (CORE_ADDR, struct obj_section *); |
c906108c | 174 | |
88cda038 | 175 | /* Note that all the following SYMBOL_* macros are used with the |
efd66ac6 TT |
176 | SYMBOL argument being either a partial symbol or |
177 | a full symbol. Both types have a ginfo field. In particular | |
33e5013e | 178 | the SYMBOL_SET_LANGUAGE, SYMBOL_DEMANGLED_NAME, etc. |
d6350901 | 179 | macros cannot be entirely substituted by |
88cda038 EZ |
180 | functions, unless the callers are changed to pass in the ginfo |
181 | field only, instead of the SYMBOL parameter. */ | |
182 | ||
c906108c SS |
183 | #define SYMBOL_VALUE(symbol) (symbol)->ginfo.value.ivalue |
184 | #define SYMBOL_VALUE_ADDRESS(symbol) (symbol)->ginfo.value.address | |
185 | #define SYMBOL_VALUE_BYTES(symbol) (symbol)->ginfo.value.bytes | |
4357ac6c | 186 | #define SYMBOL_VALUE_COMMON_BLOCK(symbol) (symbol)->ginfo.value.common_block |
c906108c SS |
187 | #define SYMBOL_BLOCK_VALUE(symbol) (symbol)->ginfo.value.block |
188 | #define SYMBOL_VALUE_CHAIN(symbol) (symbol)->ginfo.value.chain | |
189 | #define SYMBOL_LANGUAGE(symbol) (symbol)->ginfo.language | |
190 | #define SYMBOL_SECTION(symbol) (symbol)->ginfo.section | |
e27d198c TT |
191 | #define SYMBOL_OBJ_SECTION(objfile, symbol) \ |
192 | (((symbol)->ginfo.section >= 0) \ | |
193 | ? (&(((objfile)->sections)[(symbol)->ginfo.section])) \ | |
194 | : NULL) | |
c906108c | 195 | |
89aad1f9 | 196 | /* Initializes the language dependent portion of a symbol |
c378eb4e | 197 | depending upon the language for the symbol. */ |
f85f34ed TT |
198 | #define SYMBOL_SET_LANGUAGE(symbol,language,obstack) \ |
199 | (symbol_set_language (&(symbol)->ginfo, (language), (obstack))) | |
33e5013e | 200 | extern void symbol_set_language (struct general_symbol_info *symbol, |
f85f34ed TT |
201 | enum language language, |
202 | struct obstack *obstack); | |
c906108c | 203 | |
3567439c DJ |
204 | /* Set just the linkage name of a symbol; do not try to demangle |
205 | it. Used for constructs which do not have a mangled name, | |
206 | e.g. struct tags. Unlike SYMBOL_SET_NAMES, linkage_name must | |
1c9e8358 TT |
207 | be terminated and either already on the objfile's obstack or |
208 | permanently allocated. */ | |
3567439c DJ |
209 | #define SYMBOL_SET_LINKAGE_NAME(symbol,linkage_name) \ |
210 | (symbol)->ginfo.name = (linkage_name) | |
211 | ||
212 | /* Set the linkage and natural names of a symbol, by demangling | |
213 | the linkage name. */ | |
04a679b8 TT |
214 | #define SYMBOL_SET_NAMES(symbol,linkage_name,len,copy_name,objfile) \ |
215 | symbol_set_names (&(symbol)->ginfo, linkage_name, len, copy_name, objfile) | |
2de7ced7 | 216 | extern void symbol_set_names (struct general_symbol_info *symbol, |
04a679b8 | 217 | const char *linkage_name, int len, int copy_name, |
2de7ced7 DJ |
218 | struct objfile *objfile); |
219 | ||
22abf04a DC |
220 | /* Now come lots of name accessor macros. Short version as to when to |
221 | use which: Use SYMBOL_NATURAL_NAME to refer to the name of the | |
222 | symbol in the original source code. Use SYMBOL_LINKAGE_NAME if you | |
223 | want to know what the linker thinks the symbol's name is. Use | |
224 | SYMBOL_PRINT_NAME for output. Use SYMBOL_DEMANGLED_NAME if you | |
225 | specifically need to know whether SYMBOL_NATURAL_NAME and | |
3567439c | 226 | SYMBOL_LINKAGE_NAME are different. */ |
22abf04a DC |
227 | |
228 | /* Return SYMBOL's "natural" name, i.e. the name that it was called in | |
229 | the original source code. In languages like C++ where symbols may | |
230 | be mangled for ease of manipulation by the linker, this is the | |
231 | demangled name. */ | |
232 | ||
233 | #define SYMBOL_NATURAL_NAME(symbol) \ | |
234 | (symbol_natural_name (&(symbol)->ginfo)) | |
0d5cff50 DE |
235 | extern const char *symbol_natural_name |
236 | (const struct general_symbol_info *symbol); | |
22abf04a DC |
237 | |
238 | /* Return SYMBOL's name from the point of view of the linker. In | |
239 | languages like C++ where symbols may be mangled for ease of | |
240 | manipulation by the linker, this is the mangled name; otherwise, | |
3567439c | 241 | it's the same as SYMBOL_NATURAL_NAME. */ |
22abf04a DC |
242 | |
243 | #define SYMBOL_LINKAGE_NAME(symbol) (symbol)->ginfo.name | |
244 | ||
9cc0d196 | 245 | /* Return the demangled name for a symbol based on the language for |
c378eb4e | 246 | that symbol. If no demangled name exists, return NULL. */ |
9cc0d196 EZ |
247 | #define SYMBOL_DEMANGLED_NAME(symbol) \ |
248 | (symbol_demangled_name (&(symbol)->ginfo)) | |
0d5cff50 DE |
249 | extern const char *symbol_demangled_name |
250 | (const struct general_symbol_info *symbol); | |
c906108c | 251 | |
de5ad195 DC |
252 | /* Macro that returns a version of the name of a symbol that is |
253 | suitable for output. In C++ this is the "demangled" form of the | |
254 | name if demangle is on and the "mangled" form of the name if | |
255 | demangle is off. In other languages this is just the symbol name. | |
256 | The result should never be NULL. Don't use this for internal | |
50f182aa DE |
257 | purposes (e.g. storing in a hashtable): it's only suitable for output. |
258 | ||
259 | N.B. symbol may be anything with a ginfo member, | |
260 | e.g., struct symbol or struct minimal_symbol. */ | |
de5ad195 DC |
261 | |
262 | #define SYMBOL_PRINT_NAME(symbol) \ | |
22abf04a | 263 | (demangle ? SYMBOL_NATURAL_NAME (symbol) : SYMBOL_LINKAGE_NAME (symbol)) |
50f182aa | 264 | extern int demangle; |
c906108c | 265 | |
c378eb4e | 266 | /* Macro that returns the name to be used when sorting and searching symbols. |
91101fe5 | 267 | In C++ and Java, we search for the demangled form of a name, |
4725b721 PH |
268 | and so sort symbols accordingly. In Ada, however, we search by mangled |
269 | name. If there is no distinct demangled name, then SYMBOL_SEARCH_NAME | |
c378eb4e | 270 | returns the same value (same pointer) as SYMBOL_LINKAGE_NAME. */ |
4725b721 PH |
271 | #define SYMBOL_SEARCH_NAME(symbol) \ |
272 | (symbol_search_name (&(symbol)->ginfo)) | |
0d5cff50 | 273 | extern const char *symbol_search_name (const struct general_symbol_info *); |
4725b721 | 274 | |
e9111bf7 DE |
275 | /* Return non-zero if NAME matches the "search" name of SYMBOL. |
276 | Whitespace and trailing parentheses are ignored. | |
277 | See strcmp_iw for details about its behavior. */ | |
4725b721 PH |
278 | #define SYMBOL_MATCHES_SEARCH_NAME(symbol, name) \ |
279 | (strcmp_iw (SYMBOL_SEARCH_NAME (symbol), (name)) == 0) | |
280 | ||
87193939 MC |
281 | /* Classification types for a minimal symbol. These should be taken as |
282 | "advisory only", since if gdb can't easily figure out a | |
283 | classification it simply selects mst_unknown. It may also have to | |
284 | guess when it can't figure out which is a better match between two | |
285 | types (mst_data versus mst_bss) for example. Since the minimal | |
286 | symbol info is sometimes derived from the BFD library's view of a | |
c378eb4e | 287 | file, we need to live with what information bfd supplies. */ |
87193939 MC |
288 | |
289 | enum minimal_symbol_type | |
290 | { | |
291 | mst_unknown = 0, /* Unknown type, the default */ | |
292 | mst_text, /* Generally executable instructions */ | |
0875794a JK |
293 | mst_text_gnu_ifunc, /* Executable code returning address |
294 | of executable code */ | |
295 | mst_slot_got_plt, /* GOT entries for .plt sections */ | |
87193939 MC |
296 | mst_data, /* Generally initialized data */ |
297 | mst_bss, /* Generally uninitialized data */ | |
298 | mst_abs, /* Generally absolute (nonrelocatable) */ | |
299 | /* GDB uses mst_solib_trampoline for the start address of a shared | |
300 | library trampoline entry. Breakpoints for shared library functions | |
301 | are put there if the shared library is not yet loaded. | |
302 | After the shared library is loaded, lookup_minimal_symbol will | |
303 | prefer the minimal symbol from the shared library (usually | |
304 | a mst_text symbol) over the mst_solib_trampoline symbol, and the | |
305 | breakpoints will be moved to their true address in the shared | |
306 | library via breakpoint_re_set. */ | |
307 | mst_solib_trampoline, /* Shared library trampoline code */ | |
308 | /* For the mst_file* types, the names are only guaranteed to be unique | |
309 | within a given .o file. */ | |
310 | mst_file_text, /* Static version of mst_text */ | |
311 | mst_file_data, /* Static version of mst_data */ | |
51cdc993 DE |
312 | mst_file_bss, /* Static version of mst_bss */ |
313 | nr_minsym_types | |
87193939 MC |
314 | }; |
315 | ||
51cdc993 DE |
316 | /* The number of enum minimal_symbol_type values, with some padding for |
317 | reasonable growth. */ | |
318 | #define MINSYM_TYPE_BITS 4 | |
319 | gdb_static_assert (nr_minsym_types <= (1 << MINSYM_TYPE_BITS)); | |
320 | ||
c906108c SS |
321 | /* Define a simple structure used to hold some very basic information about |
322 | all defined global symbols (text, data, bss, abs, etc). The only required | |
323 | information is the general_symbol_info. | |
324 | ||
325 | In many cases, even if a file was compiled with no special options for | |
326 | debugging at all, as long as was not stripped it will contain sufficient | |
327 | information to build a useful minimal symbol table using this structure. | |
328 | Even when a file contains enough debugging information to build a full | |
329 | symbol table, these minimal symbols are still useful for quickly mapping | |
330 | between names and addresses, and vice versa. They are also sometimes | |
c378eb4e | 331 | used to figure out what full symbol table entries need to be read in. */ |
c906108c SS |
332 | |
333 | struct minimal_symbol | |
17c5ed2c | 334 | { |
c906108c | 335 | |
17c5ed2c | 336 | /* The general symbol info required for all types of symbols. |
c906108c | 337 | |
17c5ed2c DC |
338 | The SYMBOL_VALUE_ADDRESS contains the address that this symbol |
339 | corresponds to. */ | |
c906108c | 340 | |
efd66ac6 | 341 | struct general_symbol_info mginfo; |
c906108c | 342 | |
8763cede | 343 | /* Size of this symbol. dbx_end_psymtab in dbxread.c uses this |
f594e5e9 MC |
344 | information to calculate the end of the partial symtab based on the |
345 | address of the last symbol plus the size of the last symbol. */ | |
346 | ||
347 | unsigned long size; | |
348 | ||
17c5ed2c | 349 | /* Which source file is this symbol in? Only relevant for mst_file_*. */ |
04aba065 | 350 | const char *filename; |
c906108c | 351 | |
87193939 | 352 | /* Classification type for this minimal symbol. */ |
17c5ed2c | 353 | |
51cdc993 | 354 | ENUM_BITFIELD(minimal_symbol_type) type : MINSYM_TYPE_BITS; |
17c5ed2c | 355 | |
422d65e7 DE |
356 | /* Non-zero if this symbol was created by gdb. |
357 | Such symbols do not appear in the output of "info var|fun". */ | |
358 | unsigned int created_by_gdb : 1; | |
359 | ||
b887350f TT |
360 | /* Two flag bits provided for the use of the target. */ |
361 | unsigned int target_flag_1 : 1; | |
362 | unsigned int target_flag_2 : 1; | |
363 | ||
d9eaeb59 JB |
364 | /* Nonzero iff the size of the minimal symbol has been set. |
365 | Symbol size information can sometimes not be determined, because | |
366 | the object file format may not carry that piece of information. */ | |
367 | unsigned int has_size : 1; | |
368 | ||
17c5ed2c DC |
369 | /* Minimal symbols with the same hash key are kept on a linked |
370 | list. This is the link. */ | |
371 | ||
372 | struct minimal_symbol *hash_next; | |
373 | ||
374 | /* Minimal symbols are stored in two different hash tables. This is | |
375 | the `next' pointer for the demangled hash table. */ | |
376 | ||
377 | struct minimal_symbol *demangled_hash_next; | |
378 | }; | |
c906108c | 379 | |
b887350f TT |
380 | #define MSYMBOL_TARGET_FLAG_1(msymbol) (msymbol)->target_flag_1 |
381 | #define MSYMBOL_TARGET_FLAG_2(msymbol) (msymbol)->target_flag_2 | |
d9eaeb59 JB |
382 | #define MSYMBOL_SIZE(msymbol) ((msymbol)->size + 0) |
383 | #define SET_MSYMBOL_SIZE(msymbol, sz) \ | |
384 | do \ | |
385 | { \ | |
386 | (msymbol)->size = sz; \ | |
387 | (msymbol)->has_size = 1; \ | |
388 | } while (0) | |
389 | #define MSYMBOL_HAS_SIZE(msymbol) ((msymbol)->has_size + 0) | |
c906108c | 390 | #define MSYMBOL_TYPE(msymbol) (msymbol)->type |
c906108c | 391 | |
efd66ac6 | 392 | #define MSYMBOL_VALUE(symbol) (symbol)->mginfo.value.ivalue |
77e371c0 TT |
393 | /* The unrelocated address of the minimal symbol. */ |
394 | #define MSYMBOL_VALUE_RAW_ADDRESS(symbol) ((symbol)->mginfo.value.address + 0) | |
2273f0ac TT |
395 | /* The relocated address of the minimal symbol, using the section |
396 | offsets from OBJFILE. */ | |
77e371c0 TT |
397 | #define MSYMBOL_VALUE_ADDRESS(objfile, symbol) \ |
398 | ((symbol)->mginfo.value.address \ | |
2273f0ac | 399 | + ANOFFSET ((objfile)->section_offsets, ((symbol)->mginfo.section))) |
77e371c0 TT |
400 | /* For a bound minsym, we can easily compute the address directly. */ |
401 | #define BMSYMBOL_VALUE_ADDRESS(symbol) \ | |
402 | MSYMBOL_VALUE_ADDRESS ((symbol).objfile, (symbol).minsym) | |
403 | #define SET_MSYMBOL_VALUE_ADDRESS(symbol, new_value) \ | |
40c1a007 | 404 | ((symbol)->mginfo.value.address = (new_value)) |
efd66ac6 TT |
405 | #define MSYMBOL_VALUE_BYTES(symbol) (symbol)->mginfo.value.bytes |
406 | #define MSYMBOL_BLOCK_VALUE(symbol) (symbol)->mginfo.value.block | |
407 | #define MSYMBOL_VALUE_CHAIN(symbol) (symbol)->mginfo.value.chain | |
408 | #define MSYMBOL_LANGUAGE(symbol) (symbol)->mginfo.language | |
409 | #define MSYMBOL_SECTION(symbol) (symbol)->mginfo.section | |
410 | #define MSYMBOL_OBJ_SECTION(objfile, symbol) \ | |
411 | (((symbol)->mginfo.section >= 0) \ | |
412 | ? (&(((objfile)->sections)[(symbol)->mginfo.section])) \ | |
413 | : NULL) | |
414 | ||
415 | #define MSYMBOL_NATURAL_NAME(symbol) \ | |
416 | (symbol_natural_name (&(symbol)->mginfo)) | |
417 | #define MSYMBOL_LINKAGE_NAME(symbol) (symbol)->mginfo.name | |
418 | #define MSYMBOL_PRINT_NAME(symbol) \ | |
419 | (demangle ? MSYMBOL_NATURAL_NAME (symbol) : MSYMBOL_LINKAGE_NAME (symbol)) | |
420 | #define MSYMBOL_DEMANGLED_NAME(symbol) \ | |
421 | (symbol_demangled_name (&(symbol)->mginfo)) | |
422 | #define MSYMBOL_SET_LANGUAGE(symbol,language,obstack) \ | |
423 | (symbol_set_language (&(symbol)->mginfo, (language), (obstack))) | |
424 | #define MSYMBOL_SEARCH_NAME(symbol) \ | |
425 | (symbol_search_name (&(symbol)->mginfo)) | |
426 | #define MSYMBOL_MATCHES_SEARCH_NAME(symbol, name) \ | |
427 | (strcmp_iw (MSYMBOL_SEARCH_NAME (symbol), (name)) == 0) | |
428 | #define MSYMBOL_SET_NAMES(symbol,linkage_name,len,copy_name,objfile) \ | |
429 | symbol_set_names (&(symbol)->mginfo, linkage_name, len, copy_name, objfile) | |
430 | ||
c35384fb TT |
431 | #include "minsyms.h" |
432 | ||
c906108c | 433 | \f |
c5aa993b | 434 | |
c906108c SS |
435 | /* Represent one symbol name; a variable, constant, function or typedef. */ |
436 | ||
176620f1 | 437 | /* Different name domains for symbols. Looking up a symbol specifies a |
c378eb4e | 438 | domain and ignores symbol definitions in other name domains. */ |
c906108c | 439 | |
87193939 | 440 | typedef enum domain_enum_tag |
17c5ed2c | 441 | { |
176620f1 | 442 | /* UNDEF_DOMAIN is used when a domain has not been discovered or |
17c5ed2c | 443 | none of the following apply. This usually indicates an error either |
c378eb4e | 444 | in the symbol information or in gdb's handling of symbols. */ |
c906108c | 445 | |
176620f1 | 446 | UNDEF_DOMAIN, |
c906108c | 447 | |
176620f1 | 448 | /* VAR_DOMAIN is the usual domain. In C, this contains variables, |
c378eb4e | 449 | function names, typedef names and enum type values. */ |
c906108c | 450 | |
176620f1 | 451 | VAR_DOMAIN, |
c906108c | 452 | |
176620f1 | 453 | /* STRUCT_DOMAIN is used in C to hold struct, union and enum type names. |
17c5ed2c | 454 | Thus, if `struct foo' is used in a C program, it produces a symbol named |
c378eb4e | 455 | `foo' in the STRUCT_DOMAIN. */ |
c906108c | 456 | |
176620f1 | 457 | STRUCT_DOMAIN, |
c906108c | 458 | |
530e8392 KB |
459 | /* MODULE_DOMAIN is used in Fortran to hold module type names. */ |
460 | ||
461 | MODULE_DOMAIN, | |
462 | ||
0f5238ed | 463 | /* LABEL_DOMAIN may be used for names of labels (for gotos). */ |
c906108c | 464 | |
4357ac6c TT |
465 | LABEL_DOMAIN, |
466 | ||
5a352474 JK |
467 | /* Fortran common blocks. Their naming must be separate from VAR_DOMAIN. |
468 | They also always use LOC_COMMON_BLOCK. */ | |
51cdc993 DE |
469 | COMMON_BLOCK_DOMAIN, |
470 | ||
471 | /* This must remain last. */ | |
472 | NR_DOMAINS | |
8903c50d | 473 | } domain_enum; |
c906108c | 474 | |
c01feb36 DE |
475 | /* The number of bits in a symbol used to represent the domain. */ |
476 | ||
51cdc993 DE |
477 | #define SYMBOL_DOMAIN_BITS 3 |
478 | gdb_static_assert (NR_DOMAINS <= (1 << SYMBOL_DOMAIN_BITS)); | |
c01feb36 | 479 | |
20c681d1 DE |
480 | extern const char *domain_name (domain_enum); |
481 | ||
e8930875 JK |
482 | /* Searching domains, used for `search_symbols'. Element numbers are |
483 | hardcoded in GDB, check all enum uses before changing it. */ | |
c906108c | 484 | |
8903c50d TT |
485 | enum search_domain |
486 | { | |
bd2e94ce TT |
487 | /* Everything in VAR_DOMAIN minus FUNCTIONS_DOMAIN and |
488 | TYPES_DOMAIN. */ | |
e8930875 | 489 | VARIABLES_DOMAIN = 0, |
c906108c | 490 | |
c378eb4e | 491 | /* All functions -- for some reason not methods, though. */ |
e8930875 | 492 | FUNCTIONS_DOMAIN = 1, |
c906108c | 493 | |
17c5ed2c | 494 | /* All defined types */ |
e8930875 | 495 | TYPES_DOMAIN = 2, |
7b08b9eb JK |
496 | |
497 | /* Any type. */ | |
498 | ALL_DOMAIN = 3 | |
8903c50d | 499 | }; |
c906108c | 500 | |
20c681d1 DE |
501 | extern const char *search_domain_name (enum search_domain); |
502 | ||
c906108c SS |
503 | /* An address-class says where to find the value of a symbol. */ |
504 | ||
505 | enum address_class | |
17c5ed2c | 506 | { |
c378eb4e | 507 | /* Not used; catches errors. */ |
c5aa993b | 508 | |
17c5ed2c | 509 | LOC_UNDEF, |
c906108c | 510 | |
c378eb4e | 511 | /* Value is constant int SYMBOL_VALUE, host byteorder. */ |
c906108c | 512 | |
17c5ed2c | 513 | LOC_CONST, |
c906108c | 514 | |
c378eb4e | 515 | /* Value is at fixed address SYMBOL_VALUE_ADDRESS. */ |
c906108c | 516 | |
17c5ed2c | 517 | LOC_STATIC, |
c906108c | 518 | |
768a979c UW |
519 | /* Value is in register. SYMBOL_VALUE is the register number |
520 | in the original debug format. SYMBOL_REGISTER_OPS holds a | |
521 | function that can be called to transform this into the | |
522 | actual register number this represents in a specific target | |
523 | architecture (gdbarch). | |
2a2d4dc3 AS |
524 | |
525 | For some symbol formats (stabs, for some compilers at least), | |
526 | the compiler generates two symbols, an argument and a register. | |
527 | In some cases we combine them to a single LOC_REGISTER in symbol | |
528 | reading, but currently not for all cases (e.g. it's passed on the | |
529 | stack and then loaded into a register). */ | |
c906108c | 530 | |
17c5ed2c | 531 | LOC_REGISTER, |
c906108c | 532 | |
17c5ed2c | 533 | /* It's an argument; the value is at SYMBOL_VALUE offset in arglist. */ |
c906108c | 534 | |
17c5ed2c | 535 | LOC_ARG, |
c906108c | 536 | |
17c5ed2c | 537 | /* Value address is at SYMBOL_VALUE offset in arglist. */ |
c906108c | 538 | |
17c5ed2c | 539 | LOC_REF_ARG, |
c906108c | 540 | |
2a2d4dc3 | 541 | /* Value is in specified register. Just like LOC_REGISTER except the |
17c5ed2c | 542 | register holds the address of the argument instead of the argument |
c378eb4e | 543 | itself. This is currently used for the passing of structs and unions |
17c5ed2c DC |
544 | on sparc and hppa. It is also used for call by reference where the |
545 | address is in a register, at least by mipsread.c. */ | |
c906108c | 546 | |
17c5ed2c | 547 | LOC_REGPARM_ADDR, |
c906108c | 548 | |
17c5ed2c | 549 | /* Value is a local variable at SYMBOL_VALUE offset in stack frame. */ |
c906108c | 550 | |
17c5ed2c | 551 | LOC_LOCAL, |
c906108c | 552 | |
176620f1 EZ |
553 | /* Value not used; definition in SYMBOL_TYPE. Symbols in the domain |
554 | STRUCT_DOMAIN all have this class. */ | |
c906108c | 555 | |
17c5ed2c | 556 | LOC_TYPEDEF, |
c906108c | 557 | |
c378eb4e | 558 | /* Value is address SYMBOL_VALUE_ADDRESS in the code. */ |
c906108c | 559 | |
17c5ed2c | 560 | LOC_LABEL, |
c906108c | 561 | |
17c5ed2c DC |
562 | /* In a symbol table, value is SYMBOL_BLOCK_VALUE of a `struct block'. |
563 | In a partial symbol table, SYMBOL_VALUE_ADDRESS is the start address | |
c378eb4e | 564 | of the block. Function names have this class. */ |
c906108c | 565 | |
17c5ed2c | 566 | LOC_BLOCK, |
c906108c | 567 | |
17c5ed2c DC |
568 | /* Value is a constant byte-sequence pointed to by SYMBOL_VALUE_BYTES, in |
569 | target byte order. */ | |
c906108c | 570 | |
17c5ed2c | 571 | LOC_CONST_BYTES, |
c906108c | 572 | |
17c5ed2c DC |
573 | /* Value is at fixed address, but the address of the variable has |
574 | to be determined from the minimal symbol table whenever the | |
575 | variable is referenced. | |
576 | This happens if debugging information for a global symbol is | |
577 | emitted and the corresponding minimal symbol is defined | |
578 | in another object file or runtime common storage. | |
579 | The linker might even remove the minimal symbol if the global | |
580 | symbol is never referenced, in which case the symbol remains | |
de40b933 JK |
581 | unresolved. |
582 | ||
583 | GDB would normally find the symbol in the minimal symbol table if it will | |
584 | not find it in the full symbol table. But a reference to an external | |
585 | symbol in a local block shadowing other definition requires full symbol | |
586 | without possibly having its address available for LOC_STATIC. Testcase | |
587 | is provided as `gdb.dwarf2/dw2-unresolved.exp'. */ | |
c906108c | 588 | |
17c5ed2c | 589 | LOC_UNRESOLVED, |
c906108c | 590 | |
17c5ed2c DC |
591 | /* The variable does not actually exist in the program. |
592 | The value is ignored. */ | |
c906108c | 593 | |
17c5ed2c | 594 | LOC_OPTIMIZED_OUT, |
c906108c | 595 | |
4c2df51b | 596 | /* The variable's address is computed by a set of location |
768a979c | 597 | functions (see "struct symbol_computed_ops" below). */ |
4c2df51b | 598 | LOC_COMPUTED, |
5a352474 JK |
599 | |
600 | /* The variable uses general_symbol_info->value->common_block field. | |
601 | It also always uses COMMON_BLOCK_DOMAIN. */ | |
602 | LOC_COMMON_BLOCK, | |
f1e6e072 TT |
603 | |
604 | /* Not used, just notes the boundary of the enum. */ | |
605 | LOC_FINAL_VALUE | |
4c2df51b DJ |
606 | }; |
607 | ||
51cdc993 DE |
608 | /* The number of bits needed for values in enum address_class, with some |
609 | padding for reasonable growth, and room for run-time registered address | |
610 | classes. See symtab.c:MAX_SYMBOL_IMPLS. | |
611 | This is a #define so that we can have a assertion elsewhere to | |
612 | verify that we have reserved enough space for synthetic address | |
613 | classes. */ | |
614 | #define SYMBOL_ACLASS_BITS 5 | |
615 | gdb_static_assert (LOC_FINAL_VALUE <= (1 << SYMBOL_ACLASS_BITS)); | |
616 | ||
768a979c | 617 | /* The methods needed to implement LOC_COMPUTED. These methods can |
a67af2b9 AC |
618 | use the symbol's .aux_value for additional per-symbol information. |
619 | ||
620 | At present this is only used to implement location expressions. */ | |
621 | ||
768a979c | 622 | struct symbol_computed_ops |
4c2df51b DJ |
623 | { |
624 | ||
625 | /* Return the value of the variable SYMBOL, relative to the stack | |
626 | frame FRAME. If the variable has been optimized out, return | |
627 | zero. | |
628 | ||
629 | Iff `read_needs_frame (SYMBOL)' is zero, then FRAME may be zero. */ | |
630 | ||
631 | struct value *(*read_variable) (struct symbol * symbol, | |
632 | struct frame_info * frame); | |
633 | ||
e18b2753 JK |
634 | /* Read variable SYMBOL like read_variable at (callee) FRAME's function |
635 | entry. SYMBOL should be a function parameter, otherwise | |
636 | NO_ENTRY_VALUE_ERROR will be thrown. */ | |
637 | struct value *(*read_variable_at_entry) (struct symbol *symbol, | |
638 | struct frame_info *frame); | |
639 | ||
4c2df51b DJ |
640 | /* Return non-zero if we need a frame to find the value of the SYMBOL. */ |
641 | int (*read_needs_frame) (struct symbol * symbol); | |
642 | ||
643 | /* Write to STREAM a natural-language description of the location of | |
08922a10 SS |
644 | SYMBOL, in the context of ADDR. */ |
645 | void (*describe_location) (struct symbol * symbol, CORE_ADDR addr, | |
646 | struct ui_file * stream); | |
4c2df51b | 647 | |
f1e6e072 TT |
648 | /* Non-zero if this symbol's address computation is dependent on PC. */ |
649 | unsigned char location_has_loclist; | |
650 | ||
4c2df51b DJ |
651 | /* Tracepoint support. Append bytecodes to the tracepoint agent |
652 | expression AX that push the address of the object SYMBOL. Set | |
653 | VALUE appropriately. Note --- for objects in registers, this | |
654 | needn't emit any code; as long as it sets VALUE properly, then | |
655 | the caller will generate the right code in the process of | |
656 | treating this as an lvalue or rvalue. */ | |
657 | ||
505e835d UW |
658 | void (*tracepoint_var_ref) (struct symbol *symbol, struct gdbarch *gdbarch, |
659 | struct agent_expr *ax, struct axs_value *value); | |
bb2ec1b3 TT |
660 | |
661 | /* Generate C code to compute the location of SYMBOL. The C code is | |
662 | emitted to STREAM. GDBARCH is the current architecture and PC is | |
663 | the PC at which SYMBOL's location should be evaluated. | |
664 | REGISTERS_USED is a vector indexed by register number; the | |
665 | generator function should set an element in this vector if the | |
666 | corresponding register is needed by the location computation. | |
667 | The generated C code must assign the location to a local | |
668 | variable; this variable's name is RESULT_NAME. */ | |
669 | ||
670 | void (*generate_c_location) (struct symbol *symbol, struct ui_file *stream, | |
671 | struct gdbarch *gdbarch, | |
672 | unsigned char *registers_used, | |
673 | CORE_ADDR pc, const char *result_name); | |
674 | ||
17c5ed2c | 675 | }; |
c906108c | 676 | |
f1e6e072 TT |
677 | /* The methods needed to implement LOC_BLOCK for inferior functions. |
678 | These methods can use the symbol's .aux_value for additional | |
679 | per-symbol information. */ | |
680 | ||
681 | struct symbol_block_ops | |
682 | { | |
683 | /* Fill in *START and *LENGTH with DWARF block data of function | |
684 | FRAMEFUNC valid for inferior context address PC. Set *LENGTH to | |
685 | zero if such location is not valid for PC; *START is left | |
686 | uninitialized in such case. */ | |
687 | void (*find_frame_base_location) (struct symbol *framefunc, CORE_ADDR pc, | |
688 | const gdb_byte **start, size_t *length); | |
63e43d3a PMR |
689 | |
690 | /* Return the frame base address. FRAME is the frame for which we want to | |
691 | compute the base address while FRAMEFUNC is the symbol for the | |
692 | corresponding function. Return 0 on failure (FRAMEFUNC may not hold the | |
693 | information we need). | |
694 | ||
695 | This method is designed to work with static links (nested functions | |
696 | handling). Static links are function properties whose evaluation returns | |
697 | the frame base address for the enclosing frame. However, there are | |
698 | multiple definitions for "frame base": the content of the frame base | |
699 | register, the CFA as defined by DWARF unwinding information, ... | |
700 | ||
701 | So this specific method is supposed to compute the frame base address such | |
702 | as for nested fuctions, the static link computes the same address. For | |
703 | instance, considering DWARF debugging information, the static link is | |
704 | computed with DW_AT_static_link and this method must be used to compute | |
705 | the corresponding DW_AT_frame_base attribute. */ | |
706 | CORE_ADDR (*get_frame_base) (struct symbol *framefunc, | |
707 | struct frame_info *frame); | |
f1e6e072 TT |
708 | }; |
709 | ||
768a979c UW |
710 | /* Functions used with LOC_REGISTER and LOC_REGPARM_ADDR. */ |
711 | ||
712 | struct symbol_register_ops | |
713 | { | |
714 | int (*register_number) (struct symbol *symbol, struct gdbarch *gdbarch); | |
715 | }; | |
716 | ||
f1e6e072 TT |
717 | /* Objects of this type are used to find the address class and the |
718 | various computed ops vectors of a symbol. */ | |
719 | ||
720 | struct symbol_impl | |
721 | { | |
722 | enum address_class aclass; | |
723 | ||
724 | /* Used with LOC_COMPUTED. */ | |
725 | const struct symbol_computed_ops *ops_computed; | |
726 | ||
727 | /* Used with LOC_BLOCK. */ | |
728 | const struct symbol_block_ops *ops_block; | |
729 | ||
730 | /* Used with LOC_REGISTER and LOC_REGPARM_ADDR. */ | |
731 | const struct symbol_register_ops *ops_register; | |
732 | }; | |
733 | ||
c378eb4e | 734 | /* This structure is space critical. See space comments at the top. */ |
a7f19c79 | 735 | |
c906108c | 736 | struct symbol |
17c5ed2c | 737 | { |
c906108c | 738 | |
c378eb4e | 739 | /* The general symbol info required for all types of symbols. */ |
c906108c | 740 | |
17c5ed2c | 741 | struct general_symbol_info ginfo; |
c906108c | 742 | |
17c5ed2c | 743 | /* Data type of value */ |
c906108c | 744 | |
17c5ed2c | 745 | struct type *type; |
c906108c | 746 | |
1994afbf | 747 | /* The owner of this symbol. |
e2ada9cb | 748 | Which one to use is defined by symbol.is_objfile_owned. */ |
1994afbf DE |
749 | |
750 | union | |
751 | { | |
752 | /* The symbol table containing this symbol. This is the file associated | |
753 | with LINE. It can be NULL during symbols read-in but it is never NULL | |
754 | during normal operation. */ | |
755 | struct symtab *symtab; | |
756 | ||
757 | /* For types defined by the architecture. */ | |
758 | struct gdbarch *arch; | |
759 | } owner; | |
cb1df416 | 760 | |
176620f1 | 761 | /* Domain code. */ |
c906108c | 762 | |
c01feb36 | 763 | ENUM_BITFIELD(domain_enum_tag) domain : SYMBOL_DOMAIN_BITS; |
c906108c | 764 | |
f1e6e072 TT |
765 | /* Address class. This holds an index into the 'symbol_impls' |
766 | table. The actual enum address_class value is stored there, | |
767 | alongside any per-class ops vectors. */ | |
c906108c | 768 | |
f1e6e072 | 769 | unsigned int aclass_index : SYMBOL_ACLASS_BITS; |
c906108c | 770 | |
1994afbf DE |
771 | /* If non-zero then symbol is objfile-owned, use owner.symtab. |
772 | Otherwise symbol is arch-owned, use owner.arch. */ | |
773 | ||
774 | unsigned int is_objfile_owned : 1; | |
775 | ||
2a2d4dc3 AS |
776 | /* Whether this is an argument. */ |
777 | ||
778 | unsigned is_argument : 1; | |
779 | ||
edb3359d DJ |
780 | /* Whether this is an inlined function (class LOC_BLOCK only). */ |
781 | unsigned is_inlined : 1; | |
782 | ||
34eaf542 TT |
783 | /* True if this is a C++ function symbol with template arguments. |
784 | In this case the symbol is really a "struct template_symbol". */ | |
785 | unsigned is_cplus_template_function : 1; | |
786 | ||
edb3359d DJ |
787 | /* Line number of this symbol's definition, except for inlined |
788 | functions. For an inlined function (class LOC_BLOCK and | |
789 | SYMBOL_INLINED set) this is the line number of the function's call | |
790 | site. Inlined function symbols are not definitions, and they are | |
791 | never found by symbol table lookup. | |
1994afbf | 792 | If this symbol is arch-owned, LINE shall be zero. |
edb3359d DJ |
793 | |
794 | FIXME: Should we really make the assumption that nobody will try | |
795 | to debug files longer than 64K lines? What about machine | |
796 | generated programs? */ | |
c906108c | 797 | |
17c5ed2c | 798 | unsigned short line; |
c906108c | 799 | |
10f4ecb8 UW |
800 | /* An arbitrary data pointer, allowing symbol readers to record |
801 | additional information on a per-symbol basis. Note that this data | |
802 | must be allocated using the same obstack as the symbol itself. */ | |
1cd36e54 DE |
803 | /* So far it is only used by: |
804 | LOC_COMPUTED: to find the location information | |
805 | LOC_BLOCK (DWARF2 function): information used internally by the | |
806 | DWARF 2 code --- specifically, the location expression for the frame | |
10f4ecb8 UW |
807 | base for this function. */ |
808 | /* FIXME drow/2003-02-21: For the LOC_BLOCK case, it might be better | |
809 | to add a magic symbol to the block containing this information, | |
810 | or to have a generic debug info annotation slot for symbols. */ | |
811 | ||
812 | void *aux_value; | |
c906108c | 813 | |
17c5ed2c DC |
814 | struct symbol *hash_next; |
815 | }; | |
c906108c | 816 | |
d12307c1 PMR |
817 | /* Several lookup functions return both a symbol and the block in which the |
818 | symbol is found. This structure is used in these cases. */ | |
819 | ||
820 | struct block_symbol | |
821 | { | |
822 | /* The symbol that was found, or NULL if no symbol was found. */ | |
823 | struct symbol *symbol; | |
824 | ||
825 | /* If SYMBOL is not NULL, then this is the block in which the symbol is | |
826 | defined. */ | |
827 | const struct block *block; | |
828 | }; | |
829 | ||
f1e6e072 | 830 | extern const struct symbol_impl *symbol_impls; |
c906108c | 831 | |
1994afbf DE |
832 | /* Note: There is no accessor macro for symbol.owner because it is |
833 | "private". */ | |
834 | ||
176620f1 | 835 | #define SYMBOL_DOMAIN(symbol) (symbol)->domain |
f1e6e072 TT |
836 | #define SYMBOL_IMPL(symbol) (symbol_impls[(symbol)->aclass_index]) |
837 | #define SYMBOL_ACLASS_INDEX(symbol) (symbol)->aclass_index | |
838 | #define SYMBOL_CLASS(symbol) (SYMBOL_IMPL (symbol).aclass) | |
1994afbf | 839 | #define SYMBOL_OBJFILE_OWNED(symbol) ((symbol)->is_objfile_owned) |
2a2d4dc3 | 840 | #define SYMBOL_IS_ARGUMENT(symbol) (symbol)->is_argument |
edb3359d | 841 | #define SYMBOL_INLINED(symbol) (symbol)->is_inlined |
34eaf542 TT |
842 | #define SYMBOL_IS_CPLUS_TEMPLATE_FUNCTION(symbol) \ |
843 | (symbol)->is_cplus_template_function | |
c906108c SS |
844 | #define SYMBOL_TYPE(symbol) (symbol)->type |
845 | #define SYMBOL_LINE(symbol) (symbol)->line | |
f1e6e072 TT |
846 | #define SYMBOL_COMPUTED_OPS(symbol) (SYMBOL_IMPL (symbol).ops_computed) |
847 | #define SYMBOL_BLOCK_OPS(symbol) (SYMBOL_IMPL (symbol).ops_block) | |
848 | #define SYMBOL_REGISTER_OPS(symbol) (SYMBOL_IMPL (symbol).ops_register) | |
10f4ecb8 | 849 | #define SYMBOL_LOCATION_BATON(symbol) (symbol)->aux_value |
34eaf542 | 850 | |
f1e6e072 TT |
851 | extern int register_symbol_computed_impl (enum address_class, |
852 | const struct symbol_computed_ops *); | |
853 | ||
854 | extern int register_symbol_block_impl (enum address_class aclass, | |
855 | const struct symbol_block_ops *ops); | |
856 | ||
857 | extern int register_symbol_register_impl (enum address_class, | |
858 | const struct symbol_register_ops *); | |
859 | ||
08be3fe3 DE |
860 | /* Return the OBJFILE of SYMBOL. |
861 | It is an error to call this if symbol.is_objfile_owned is false, which | |
862 | only happens for architecture-provided types. */ | |
863 | ||
864 | extern struct objfile *symbol_objfile (const struct symbol *symbol); | |
865 | ||
866 | /* Return the ARCH of SYMBOL. */ | |
867 | ||
868 | extern struct gdbarch *symbol_arch (const struct symbol *symbol); | |
869 | ||
870 | /* Return the SYMTAB of SYMBOL. | |
871 | It is an error to call this if symbol.is_objfile_owned is false, which | |
872 | only happens for architecture-provided types. */ | |
873 | ||
874 | extern struct symtab *symbol_symtab (const struct symbol *symbol); | |
875 | ||
876 | /* Set the symtab of SYMBOL to SYMTAB. | |
877 | It is an error to call this if symbol.is_objfile_owned is false, which | |
878 | only happens for architecture-provided types. */ | |
879 | ||
880 | extern void symbol_set_symtab (struct symbol *symbol, struct symtab *symtab); | |
881 | ||
34eaf542 TT |
882 | /* An instance of this type is used to represent a C++ template |
883 | function. It includes a "struct symbol" as a kind of base class; | |
884 | users downcast to "struct template_symbol *" when needed. A symbol | |
885 | is really of this type iff SYMBOL_IS_CPLUS_TEMPLATE_FUNCTION is | |
886 | true. */ | |
887 | ||
888 | struct template_symbol | |
889 | { | |
890 | /* The base class. */ | |
891 | struct symbol base; | |
892 | ||
893 | /* The number of template arguments. */ | |
894 | int n_template_arguments; | |
895 | ||
896 | /* The template arguments. This is an array with | |
897 | N_TEMPLATE_ARGUMENTS elements. */ | |
898 | struct symbol **template_arguments; | |
899 | }; | |
900 | ||
c906108c | 901 | \f |
c906108c SS |
902 | /* Each item represents a line-->pc (or the reverse) mapping. This is |
903 | somewhat more wasteful of space than one might wish, but since only | |
904 | the files which are actually debugged are read in to core, we don't | |
905 | waste much space. */ | |
906 | ||
907 | struct linetable_entry | |
17c5ed2c DC |
908 | { |
909 | int line; | |
910 | CORE_ADDR pc; | |
911 | }; | |
c906108c SS |
912 | |
913 | /* The order of entries in the linetable is significant. They should | |
914 | be sorted by increasing values of the pc field. If there is more than | |
915 | one entry for a given pc, then I'm not sure what should happen (and | |
916 | I not sure whether we currently handle it the best way). | |
917 | ||
918 | Example: a C for statement generally looks like this | |
919 | ||
c5aa993b JM |
920 | 10 0x100 - for the init/test part of a for stmt. |
921 | 20 0x200 | |
922 | 30 0x300 | |
923 | 10 0x400 - for the increment part of a for stmt. | |
c906108c | 924 | |
e8717518 FF |
925 | If an entry has a line number of zero, it marks the start of a PC |
926 | range for which no line number information is available. It is | |
927 | acceptable, though wasteful of table space, for such a range to be | |
928 | zero length. */ | |
c906108c SS |
929 | |
930 | struct linetable | |
17c5ed2c DC |
931 | { |
932 | int nitems; | |
c906108c | 933 | |
17c5ed2c DC |
934 | /* Actually NITEMS elements. If you don't like this use of the |
935 | `struct hack', you can shove it up your ANSI (seriously, if the | |
936 | committee tells us how to do it, we can probably go along). */ | |
937 | struct linetable_entry item[1]; | |
938 | }; | |
c906108c | 939 | |
c906108c SS |
940 | /* How to relocate the symbols from each section in a symbol file. |
941 | Each struct contains an array of offsets. | |
942 | The ordering and meaning of the offsets is file-type-dependent; | |
943 | typically it is indexed by section numbers or symbol types or | |
944 | something like that. | |
945 | ||
946 | To give us flexibility in changing the internal representation | |
947 | of these offsets, the ANOFFSET macro must be used to insert and | |
948 | extract offset values in the struct. */ | |
949 | ||
950 | struct section_offsets | |
17c5ed2c | 951 | { |
c378eb4e | 952 | CORE_ADDR offsets[1]; /* As many as needed. */ |
17c5ed2c | 953 | }; |
c906108c | 954 | |
a4c8257b | 955 | #define ANOFFSET(secoff, whichone) \ |
3e43a32a MS |
956 | ((whichone == -1) \ |
957 | ? (internal_error (__FILE__, __LINE__, \ | |
958 | _("Section index is uninitialized")), -1) \ | |
959 | : secoff->offsets[whichone]) | |
c906108c | 960 | |
b29c9944 JB |
961 | /* The size of a section_offsets table for N sections. */ |
962 | #define SIZEOF_N_SECTION_OFFSETS(n) \ | |
c906108c | 963 | (sizeof (struct section_offsets) \ |
b29c9944 JB |
964 | + sizeof (((struct section_offsets *) 0)->offsets) * ((n)-1)) |
965 | ||
c378eb4e | 966 | /* Each source file or header is represented by a struct symtab. |
43f3e411 | 967 | The name "symtab" is historical, another name for it is "filetab". |
c906108c SS |
968 | These objects are chained through the `next' field. */ |
969 | ||
970 | struct symtab | |
17c5ed2c | 971 | { |
b7236fbe DE |
972 | /* Unordered chain of all filetabs in the compunit, with the exception |
973 | that the "main" source file is the first entry in the list. */ | |
c906108c | 974 | |
17c5ed2c | 975 | struct symtab *next; |
c906108c | 976 | |
43f3e411 | 977 | /* Backlink to containing compunit symtab. */ |
c906108c | 978 | |
43f3e411 | 979 | struct compunit_symtab *compunit_symtab; |
c906108c | 980 | |
17c5ed2c DC |
981 | /* Table mapping core addresses to line numbers for this file. |
982 | Can be NULL if none. Never shared between different symtabs. */ | |
c906108c | 983 | |
17c5ed2c | 984 | struct linetable *linetable; |
c906108c | 985 | |
4e04028d | 986 | /* Name of this source file. This pointer is never NULL. */ |
c906108c | 987 | |
21ea9eec | 988 | const char *filename; |
c906108c | 989 | |
17c5ed2c | 990 | /* Total number of lines found in source file. */ |
c906108c | 991 | |
17c5ed2c | 992 | int nlines; |
c906108c | 993 | |
17c5ed2c DC |
994 | /* line_charpos[N] is the position of the (N-1)th line of the |
995 | source file. "position" means something we can lseek() to; it | |
996 | is not guaranteed to be useful any other way. */ | |
c906108c | 997 | |
17c5ed2c | 998 | int *line_charpos; |
c906108c | 999 | |
17c5ed2c | 1000 | /* Language of this source file. */ |
c906108c | 1001 | |
17c5ed2c | 1002 | enum language language; |
c906108c | 1003 | |
43f3e411 DE |
1004 | /* Full name of file as found by searching the source path. |
1005 | NULL if not yet known. */ | |
1006 | ||
1007 | char *fullname; | |
1008 | }; | |
1009 | ||
1010 | #define SYMTAB_COMPUNIT(symtab) ((symtab)->compunit_symtab) | |
1011 | #define SYMTAB_LINETABLE(symtab) ((symtab)->linetable) | |
1012 | #define SYMTAB_LANGUAGE(symtab) ((symtab)->language) | |
1013 | #define SYMTAB_BLOCKVECTOR(symtab) \ | |
1014 | COMPUNIT_BLOCKVECTOR (SYMTAB_COMPUNIT (symtab)) | |
1015 | #define SYMTAB_OBJFILE(symtab) \ | |
1016 | COMPUNIT_OBJFILE (SYMTAB_COMPUNIT (symtab)) | |
1017 | #define SYMTAB_PSPACE(symtab) (SYMTAB_OBJFILE (symtab)->pspace) | |
1018 | #define SYMTAB_DIRNAME(symtab) \ | |
1019 | COMPUNIT_DIRNAME (SYMTAB_COMPUNIT (symtab)) | |
1020 | ||
1021 | typedef struct symtab *symtab_ptr; | |
1022 | DEF_VEC_P (symtab_ptr); | |
1023 | ||
1024 | /* Compunit symtabs contain the actual "symbol table", aka blockvector, as well | |
1025 | as the list of all source files (what gdb has historically associated with | |
1026 | the term "symtab"). | |
1027 | Additional information is recorded here that is common to all symtabs in a | |
1028 | compilation unit (DWARF or otherwise). | |
1029 | ||
1030 | Example: | |
1031 | For the case of a program built out of these files: | |
1032 | ||
1033 | foo.c | |
1034 | foo1.h | |
1035 | foo2.h | |
1036 | bar.c | |
1037 | foo1.h | |
1038 | bar.h | |
1039 | ||
1040 | This is recorded as: | |
1041 | ||
1042 | objfile -> foo.c(cu) -> bar.c(cu) -> NULL | |
1043 | | | | |
1044 | v v | |
1045 | foo.c bar.c | |
1046 | | | | |
1047 | v v | |
1048 | foo1.h foo1.h | |
1049 | | | | |
1050 | v v | |
1051 | foo2.h bar.h | |
1052 | | | | |
1053 | v v | |
1054 | NULL NULL | |
1055 | ||
1056 | where "foo.c(cu)" and "bar.c(cu)" are struct compunit_symtab objects, | |
1057 | and the files foo.c, etc. are struct symtab objects. */ | |
1058 | ||
1059 | struct compunit_symtab | |
1060 | { | |
1061 | /* Unordered chain of all compunit symtabs of this objfile. */ | |
1062 | struct compunit_symtab *next; | |
1063 | ||
1064 | /* Object file from which this symtab information was read. */ | |
1065 | struct objfile *objfile; | |
1066 | ||
1067 | /* Name of the symtab. | |
1068 | This is *not* intended to be a usable filename, and is | |
1069 | for debugging purposes only. */ | |
1070 | const char *name; | |
1071 | ||
1072 | /* Unordered list of file symtabs, except that by convention the "main" | |
1073 | source file (e.g., .c, .cc) is guaranteed to be first. | |
1074 | Each symtab is a file, either the "main" source file (e.g., .c, .cc) | |
1075 | or header (e.g., .h). */ | |
1076 | struct symtab *filetabs; | |
1077 | ||
1078 | /* Last entry in FILETABS list. | |
1079 | Subfiles are added to the end of the list so they accumulate in order, | |
1080 | with the main source subfile living at the front. | |
1081 | The main reason is so that the main source file symtab is at the head | |
1082 | of the list, and the rest appear in order for debugging convenience. */ | |
1083 | struct symtab *last_filetab; | |
1084 | ||
1085 | /* Non-NULL string that identifies the format of the debugging information, | |
1086 | such as "stabs", "dwarf 1", "dwarf 2", "coff", etc. This is mostly useful | |
17c5ed2c | 1087 | for automated testing of gdb but may also be information that is |
c378eb4e | 1088 | useful to the user. */ |
554d387d | 1089 | const char *debugformat; |
c906108c | 1090 | |
43f3e411 | 1091 | /* String of producer version information, or NULL if we don't know. */ |
554d387d | 1092 | const char *producer; |
c906108c | 1093 | |
43f3e411 DE |
1094 | /* Directory in which it was compiled, or NULL if we don't know. */ |
1095 | const char *dirname; | |
c906108c | 1096 | |
43f3e411 DE |
1097 | /* List of all symbol scope blocks for this symtab. It is shared among |
1098 | all symtabs in a given compilation unit. */ | |
1099 | const struct blockvector *blockvector; | |
c906108c | 1100 | |
43f3e411 DE |
1101 | /* Section in objfile->section_offsets for the blockvector and |
1102 | the linetable. Probably always SECT_OFF_TEXT. */ | |
1103 | int block_line_section; | |
c906108c | 1104 | |
43f3e411 DE |
1105 | /* Symtab has been compiled with both optimizations and debug info so that |
1106 | GDB may stop skipping prologues as variables locations are valid already | |
1107 | at function entry points. */ | |
1108 | unsigned int locations_valid : 1; | |
c906108c | 1109 | |
43f3e411 DE |
1110 | /* DWARF unwinder for this CU is valid even for epilogues (PC at the return |
1111 | instruction). This is supported by GCC since 4.5.0. */ | |
1112 | unsigned int epilogue_unwind_valid : 1; | |
8e3b41a9 | 1113 | |
43f3e411 | 1114 | /* struct call_site entries for this compilation unit or NULL. */ |
8e3b41a9 | 1115 | htab_t call_site_htab; |
b5b04b5b | 1116 | |
43f3e411 DE |
1117 | /* The macro table for this symtab. Like the blockvector, this |
1118 | is shared between different symtabs in a given compilation unit. | |
1119 | It's debatable whether it *should* be shared among all the symtabs in | |
1120 | the given compilation unit, but it currently is. */ | |
1121 | struct macro_table *macro_table; | |
1122 | ||
b5b04b5b | 1123 | /* If non-NULL, then this points to a NULL-terminated vector of |
43f3e411 DE |
1124 | included compunits. When searching the static or global |
1125 | block of this compunit, the corresponding block of all | |
1126 | included compunits will also be searched. Note that this | |
b5b04b5b TT |
1127 | list must be flattened -- the symbol reader is responsible for |
1128 | ensuring that this vector contains the transitive closure of all | |
43f3e411 DE |
1129 | included compunits. */ |
1130 | struct compunit_symtab **includes; | |
b5b04b5b | 1131 | |
43f3e411 DE |
1132 | /* If this is an included compunit, this points to one includer |
1133 | of the table. This user is considered the canonical compunit | |
1134 | containing this one. An included compunit may itself be | |
b5b04b5b | 1135 | included by another. */ |
43f3e411 | 1136 | struct compunit_symtab *user; |
17c5ed2c | 1137 | }; |
c906108c | 1138 | |
43f3e411 DE |
1139 | #define COMPUNIT_OBJFILE(cust) ((cust)->objfile) |
1140 | #define COMPUNIT_FILETABS(cust) ((cust)->filetabs) | |
1141 | #define COMPUNIT_DEBUGFORMAT(cust) ((cust)->debugformat) | |
1142 | #define COMPUNIT_PRODUCER(cust) ((cust)->producer) | |
1143 | #define COMPUNIT_DIRNAME(cust) ((cust)->dirname) | |
1144 | #define COMPUNIT_BLOCKVECTOR(cust) ((cust)->blockvector) | |
1145 | #define COMPUNIT_BLOCK_LINE_SECTION(cust) ((cust)->block_line_section) | |
1146 | #define COMPUNIT_LOCATIONS_VALID(cust) ((cust)->locations_valid) | |
1147 | #define COMPUNIT_EPILOGUE_UNWIND_VALID(cust) ((cust)->epilogue_unwind_valid) | |
1148 | #define COMPUNIT_CALL_SITE_HTAB(cust) ((cust)->call_site_htab) | |
1149 | #define COMPUNIT_MACRO_TABLE(cust) ((cust)->macro_table) | |
ec94af83 | 1150 | |
43f3e411 | 1151 | /* Iterate over all file tables (struct symtab) within a compunit. */ |
db0fec5c | 1152 | |
43f3e411 DE |
1153 | #define ALL_COMPUNIT_FILETABS(cu, s) \ |
1154 | for ((s) = (cu) -> filetabs; (s) != NULL; (s) = (s) -> next) | |
1155 | ||
1156 | /* Return the primary symtab of CUST. */ | |
1157 | ||
1158 | extern struct symtab * | |
1159 | compunit_primary_filetab (const struct compunit_symtab *cust); | |
1160 | ||
1161 | /* Return the language of CUST. */ | |
1162 | ||
1163 | extern enum language compunit_language (const struct compunit_symtab *cust); | |
1164 | ||
1165 | typedef struct compunit_symtab *compunit_symtab_ptr; | |
1166 | DEF_VEC_P (compunit_symtab_ptr); | |
ec94af83 | 1167 | |
c906108c | 1168 | \f |
c5aa993b | 1169 | |
c906108c | 1170 | /* The virtual function table is now an array of structures which have the |
a960f249 | 1171 | form { int16 offset, delta; void *pfn; }. |
c906108c SS |
1172 | |
1173 | In normal virtual function tables, OFFSET is unused. | |
1174 | DELTA is the amount which is added to the apparent object's base | |
1175 | address in order to point to the actual object to which the | |
1176 | virtual function should be applied. | |
1177 | PFN is a pointer to the virtual function. | |
1178 | ||
c378eb4e | 1179 | Note that this macro is g++ specific (FIXME). */ |
c5aa993b | 1180 | |
c906108c SS |
1181 | #define VTBL_FNADDR_OFFSET 2 |
1182 | ||
c378eb4e | 1183 | /* External variables and functions for the objects described above. */ |
c906108c | 1184 | |
c378eb4e | 1185 | /* True if we are nested inside psymtab_to_symtab. */ |
c906108c SS |
1186 | |
1187 | extern int currently_reading_symtab; | |
1188 | ||
c906108c SS |
1189 | /* symtab.c lookup functions */ |
1190 | ||
7fc830e2 MK |
1191 | extern const char multiple_symbols_ask[]; |
1192 | extern const char multiple_symbols_all[]; | |
1193 | extern const char multiple_symbols_cancel[]; | |
717d2f5a JB |
1194 | |
1195 | const char *multiple_symbols_select_mode (void); | |
1196 | ||
4186eb54 KS |
1197 | int symbol_matches_domain (enum language symbol_language, |
1198 | domain_enum symbol_domain, | |
1199 | domain_enum domain); | |
1200 | ||
c378eb4e | 1201 | /* lookup a symbol table by source file name. */ |
c906108c | 1202 | |
1f8cc6db | 1203 | extern struct symtab *lookup_symtab (const char *); |
c906108c | 1204 | |
1993b719 TT |
1205 | /* An object of this type is passed as the 'is_a_field_of_this' |
1206 | argument to lookup_symbol and lookup_symbol_in_language. */ | |
1207 | ||
1208 | struct field_of_this_result | |
1209 | { | |
1210 | /* The type in which the field was found. If this is NULL then the | |
1211 | symbol was not found in 'this'. If non-NULL, then one of the | |
1212 | other fields will be non-NULL as well. */ | |
1213 | ||
1214 | struct type *type; | |
1215 | ||
1216 | /* If the symbol was found as an ordinary field of 'this', then this | |
1217 | is non-NULL and points to the particular field. */ | |
1218 | ||
1219 | struct field *field; | |
1220 | ||
cf901d3b | 1221 | /* If the symbol was found as a function field of 'this', then this |
1993b719 TT |
1222 | is non-NULL and points to the particular field. */ |
1223 | ||
1224 | struct fn_fieldlist *fn_field; | |
1225 | }; | |
1226 | ||
cf901d3b DE |
1227 | /* Find the definition for a specified symbol name NAME |
1228 | in domain DOMAIN in language LANGUAGE, visible from lexical block BLOCK | |
1229 | if non-NULL or from global/static blocks if BLOCK is NULL. | |
1230 | Returns the struct symbol pointer, or NULL if no symbol is found. | |
1231 | C++: if IS_A_FIELD_OF_THIS is non-NULL on entry, check to see if | |
1232 | NAME is a field of the current implied argument `this'. If so fill in the | |
1233 | fields of IS_A_FIELD_OF_THIS, otherwise the fields are set to NULL. | |
cf901d3b | 1234 | The symbol's section is fixed up if necessary. */ |
53c5240f | 1235 | |
d12307c1 PMR |
1236 | extern struct block_symbol |
1237 | lookup_symbol_in_language (const char *, | |
1238 | const struct block *, | |
1239 | const domain_enum, | |
1240 | enum language, | |
1241 | struct field_of_this_result *); | |
53c5240f | 1242 | |
cf901d3b | 1243 | /* Same as lookup_symbol_in_language, but using the current language. */ |
c906108c | 1244 | |
d12307c1 PMR |
1245 | extern struct block_symbol lookup_symbol (const char *, |
1246 | const struct block *, | |
1247 | const domain_enum, | |
1248 | struct field_of_this_result *); | |
c906108c | 1249 | |
5f9a71c3 | 1250 | /* A default version of lookup_symbol_nonlocal for use by languages |
cf901d3b DE |
1251 | that can't think of anything better to do. |
1252 | This implements the C lookup rules. */ | |
5f9a71c3 | 1253 | |
d12307c1 | 1254 | extern struct block_symbol |
f606139a DE |
1255 | basic_lookup_symbol_nonlocal (const struct language_defn *langdef, |
1256 | const char *, | |
1257 | const struct block *, | |
1258 | const domain_enum); | |
5f9a71c3 DC |
1259 | |
1260 | /* Some helper functions for languages that need to write their own | |
1261 | lookup_symbol_nonlocal functions. */ | |
1262 | ||
1263 | /* Lookup a symbol in the static block associated to BLOCK, if there | |
cf901d3b | 1264 | is one; do nothing if BLOCK is NULL or a global block. |
d12307c1 | 1265 | Upon success fixes up the symbol's section if necessary. */ |
5f9a71c3 | 1266 | |
d12307c1 PMR |
1267 | extern struct block_symbol |
1268 | lookup_symbol_in_static_block (const char *name, | |
1269 | const struct block *block, | |
1270 | const domain_enum domain); | |
5f9a71c3 | 1271 | |
08724ab7 | 1272 | /* Search all static file-level symbols for NAME from DOMAIN. |
d12307c1 | 1273 | Upon success fixes up the symbol's section if necessary. */ |
08724ab7 | 1274 | |
d12307c1 PMR |
1275 | extern struct block_symbol lookup_static_symbol (const char *name, |
1276 | const domain_enum domain); | |
08724ab7 | 1277 | |
cf901d3b | 1278 | /* Lookup a symbol in all files' global blocks. |
67be31e5 DE |
1279 | |
1280 | If BLOCK is non-NULL then it is used for two things: | |
1281 | 1) If a target-specific lookup routine for libraries exists, then use the | |
1282 | routine for the objfile of BLOCK, and | |
1283 | 2) The objfile of BLOCK is used to assist in determining the search order | |
1284 | if the target requires it. | |
1285 | See gdbarch_iterate_over_objfiles_in_search_order. | |
1286 | ||
d12307c1 | 1287 | Upon success fixes up the symbol's section if necessary. */ |
5f9a71c3 | 1288 | |
d12307c1 PMR |
1289 | extern struct block_symbol |
1290 | lookup_global_symbol (const char *name, | |
1291 | const struct block *block, | |
1292 | const domain_enum domain); | |
5f9a71c3 | 1293 | |
d1a2d36d | 1294 | /* Lookup a symbol in block BLOCK. |
d12307c1 | 1295 | Upon success fixes up the symbol's section if necessary. */ |
5f9a71c3 | 1296 | |
d12307c1 PMR |
1297 | extern struct symbol * |
1298 | lookup_symbol_in_block (const char *name, | |
1299 | const struct block *block, | |
1300 | const domain_enum domain); | |
5f9a71c3 | 1301 | |
cf901d3b DE |
1302 | /* Look up the `this' symbol for LANG in BLOCK. Return the symbol if |
1303 | found, or NULL if not found. */ | |
1304 | ||
d12307c1 PMR |
1305 | extern struct block_symbol |
1306 | lookup_language_this (const struct language_defn *lang, | |
1307 | const struct block *block); | |
66a17cb6 | 1308 | |
cf901d3b | 1309 | /* Lookup a [struct, union, enum] by name, within a specified block. */ |
c906108c | 1310 | |
270140bd | 1311 | extern struct type *lookup_struct (const char *, const struct block *); |
c906108c | 1312 | |
270140bd | 1313 | extern struct type *lookup_union (const char *, const struct block *); |
c906108c | 1314 | |
270140bd | 1315 | extern struct type *lookup_enum (const char *, const struct block *); |
c906108c | 1316 | |
c906108c SS |
1317 | /* from blockframe.c: */ |
1318 | ||
c378eb4e | 1319 | /* lookup the function symbol corresponding to the address. */ |
c906108c | 1320 | |
a14ed312 | 1321 | extern struct symbol *find_pc_function (CORE_ADDR); |
c906108c | 1322 | |
c378eb4e | 1323 | /* lookup the function corresponding to the address and section. */ |
c906108c | 1324 | |
714835d5 | 1325 | extern struct symbol *find_pc_sect_function (CORE_ADDR, struct obj_section *); |
c5aa993b | 1326 | |
2c02bd72 | 1327 | extern int find_pc_partial_function_gnu_ifunc (CORE_ADDR pc, const char **name, |
11c81455 JK |
1328 | CORE_ADDR *address, |
1329 | CORE_ADDR *endaddr, | |
1330 | int *is_gnu_ifunc_p); | |
1331 | ||
c378eb4e | 1332 | /* lookup function from address, return name, start addr and end addr. */ |
c906108c | 1333 | |
2c02bd72 | 1334 | extern int find_pc_partial_function (CORE_ADDR, const char **, CORE_ADDR *, |
570b8f7c | 1335 | CORE_ADDR *); |
c906108c | 1336 | |
a14ed312 | 1337 | extern void clear_pc_function_cache (void); |
c906108c | 1338 | |
2097ae25 | 1339 | /* Expand symtab containing PC, SECTION if not already expanded. */ |
c906108c | 1340 | |
2097ae25 | 1341 | extern void expand_symtab_containing_pc (CORE_ADDR, struct obj_section *); |
c906108c | 1342 | |
c378eb4e | 1343 | /* lookup full symbol table by address. */ |
c906108c | 1344 | |
43f3e411 | 1345 | extern struct compunit_symtab *find_pc_compunit_symtab (CORE_ADDR); |
c906108c | 1346 | |
c378eb4e | 1347 | /* lookup full symbol table by address and section. */ |
c906108c | 1348 | |
43f3e411 DE |
1349 | extern struct compunit_symtab * |
1350 | find_pc_sect_compunit_symtab (CORE_ADDR, struct obj_section *); | |
c906108c | 1351 | |
a14ed312 | 1352 | extern int find_pc_line_pc_range (CORE_ADDR, CORE_ADDR *, CORE_ADDR *); |
c906108c | 1353 | |
a14ed312 | 1354 | extern void reread_symbols (void); |
c906108c | 1355 | |
cf901d3b DE |
1356 | /* Look up a type named NAME in STRUCT_DOMAIN in the current language. |
1357 | The type returned must not be opaque -- i.e., must have at least one field | |
1358 | defined. */ | |
1359 | ||
a14ed312 | 1360 | extern struct type *lookup_transparent_type (const char *); |
c906108c | 1361 | |
cf901d3b | 1362 | extern struct type *basic_lookup_transparent_type (const char *); |
c906108c | 1363 | |
c378eb4e | 1364 | /* Macro for name of symbol to indicate a file compiled with gcc. */ |
c906108c SS |
1365 | #ifndef GCC_COMPILED_FLAG_SYMBOL |
1366 | #define GCC_COMPILED_FLAG_SYMBOL "gcc_compiled." | |
1367 | #endif | |
1368 | ||
c378eb4e | 1369 | /* Macro for name of symbol to indicate a file compiled with gcc2. */ |
c906108c SS |
1370 | #ifndef GCC2_COMPILED_FLAG_SYMBOL |
1371 | #define GCC2_COMPILED_FLAG_SYMBOL "gcc2_compiled." | |
1372 | #endif | |
1373 | ||
0875794a JK |
1374 | extern int in_gnu_ifunc_stub (CORE_ADDR pc); |
1375 | ||
07be84bf JK |
1376 | /* Functions for resolving STT_GNU_IFUNC symbols which are implemented only |
1377 | for ELF symbol files. */ | |
1378 | ||
1379 | struct gnu_ifunc_fns | |
1380 | { | |
1381 | /* See elf_gnu_ifunc_resolve_addr for its real implementation. */ | |
1382 | CORE_ADDR (*gnu_ifunc_resolve_addr) (struct gdbarch *gdbarch, CORE_ADDR pc); | |
1383 | ||
1384 | /* See elf_gnu_ifunc_resolve_name for its real implementation. */ | |
1385 | int (*gnu_ifunc_resolve_name) (const char *function_name, | |
1386 | CORE_ADDR *function_address_p); | |
0e30163f JK |
1387 | |
1388 | /* See elf_gnu_ifunc_resolver_stop for its real implementation. */ | |
1389 | void (*gnu_ifunc_resolver_stop) (struct breakpoint *b); | |
1390 | ||
1391 | /* See elf_gnu_ifunc_resolver_return_stop for its real implementation. */ | |
1392 | void (*gnu_ifunc_resolver_return_stop) (struct breakpoint *b); | |
07be84bf JK |
1393 | }; |
1394 | ||
1395 | #define gnu_ifunc_resolve_addr gnu_ifunc_fns_p->gnu_ifunc_resolve_addr | |
1396 | #define gnu_ifunc_resolve_name gnu_ifunc_fns_p->gnu_ifunc_resolve_name | |
0e30163f JK |
1397 | #define gnu_ifunc_resolver_stop gnu_ifunc_fns_p->gnu_ifunc_resolver_stop |
1398 | #define gnu_ifunc_resolver_return_stop \ | |
1399 | gnu_ifunc_fns_p->gnu_ifunc_resolver_return_stop | |
07be84bf JK |
1400 | |
1401 | extern const struct gnu_ifunc_fns *gnu_ifunc_fns_p; | |
1402 | ||
52f729a7 | 1403 | extern CORE_ADDR find_solib_trampoline_target (struct frame_info *, CORE_ADDR); |
c906108c | 1404 | |
c906108c | 1405 | struct symtab_and_line |
17c5ed2c | 1406 | { |
6c95b8df PA |
1407 | /* The program space of this sal. */ |
1408 | struct program_space *pspace; | |
1409 | ||
17c5ed2c | 1410 | struct symtab *symtab; |
714835d5 | 1411 | struct obj_section *section; |
17c5ed2c DC |
1412 | /* Line number. Line numbers start at 1 and proceed through symtab->nlines. |
1413 | 0 is never a valid line number; it is used to indicate that line number | |
1414 | information is not available. */ | |
1415 | int line; | |
1416 | ||
1417 | CORE_ADDR pc; | |
1418 | CORE_ADDR end; | |
ed0616c6 VP |
1419 | int explicit_pc; |
1420 | int explicit_line; | |
55aa24fb SDJ |
1421 | |
1422 | /* The probe associated with this symtab_and_line. */ | |
1423 | struct probe *probe; | |
729662a5 TT |
1424 | /* If PROBE is not NULL, then this is the objfile in which the probe |
1425 | originated. */ | |
1426 | struct objfile *objfile; | |
17c5ed2c | 1427 | }; |
c906108c | 1428 | |
fe39c653 | 1429 | extern void init_sal (struct symtab_and_line *sal); |
c906108c SS |
1430 | |
1431 | struct symtabs_and_lines | |
17c5ed2c DC |
1432 | { |
1433 | struct symtab_and_line *sals; | |
1434 | int nelts; | |
1435 | }; | |
c5aa993b | 1436 | \f |
c906108c | 1437 | |
c906108c SS |
1438 | /* Given a pc value, return line number it is in. Second arg nonzero means |
1439 | if pc is on the boundary use the previous statement's line number. */ | |
1440 | ||
a14ed312 | 1441 | extern struct symtab_and_line find_pc_line (CORE_ADDR, int); |
c906108c | 1442 | |
c378eb4e | 1443 | /* Same function, but specify a section as well as an address. */ |
c906108c | 1444 | |
714835d5 UW |
1445 | extern struct symtab_and_line find_pc_sect_line (CORE_ADDR, |
1446 | struct obj_section *, int); | |
c906108c | 1447 | |
34248c3a DE |
1448 | /* Wrapper around find_pc_line to just return the symtab. */ |
1449 | ||
1450 | extern struct symtab *find_pc_line_symtab (CORE_ADDR); | |
1451 | ||
c906108c SS |
1452 | /* Given a symtab and line number, return the pc there. */ |
1453 | ||
a14ed312 | 1454 | extern int find_line_pc (struct symtab *, int, CORE_ADDR *); |
c906108c | 1455 | |
570b8f7c AC |
1456 | extern int find_line_pc_range (struct symtab_and_line, CORE_ADDR *, |
1457 | CORE_ADDR *); | |
c906108c | 1458 | |
a14ed312 | 1459 | extern void resolve_sal_pc (struct symtab_and_line *); |
c906108c | 1460 | |
f176c4b5 | 1461 | /* solib.c */ |
c906108c | 1462 | |
a14ed312 | 1463 | extern void clear_solib (void); |
c906108c | 1464 | |
c906108c SS |
1465 | /* source.c */ |
1466 | ||
a14ed312 | 1467 | extern int identify_source_line (struct symtab *, int, int, CORE_ADDR); |
c906108c | 1468 | |
dfaae886 MM |
1469 | /* Flags passed as 4th argument to print_source_lines. */ |
1470 | ||
1471 | enum print_source_lines_flags | |
1472 | { | |
1473 | /* Do not print an error message. */ | |
4cd29721 MM |
1474 | PRINT_SOURCE_LINES_NOERROR = (1 << 0), |
1475 | ||
1476 | /* Print the filename in front of the source lines. */ | |
1477 | PRINT_SOURCE_LINES_FILENAME = (1 << 1) | |
dfaae886 MM |
1478 | }; |
1479 | ||
1480 | extern void print_source_lines (struct symtab *, int, int, | |
1481 | enum print_source_lines_flags); | |
c906108c | 1482 | |
00174a86 | 1483 | extern void forget_cached_source_info_for_objfile (struct objfile *); |
a14ed312 | 1484 | extern void forget_cached_source_info (void); |
c906108c | 1485 | |
a14ed312 | 1486 | extern void select_source_symtab (struct symtab *); |
c906108c | 1487 | |
49c4e619 | 1488 | extern VEC (char_ptr) *default_make_symbol_completion_list_break_on |
6f937416 | 1489 | (const char *text, const char *word, const char *break_on, |
2f68a895 | 1490 | enum type_code code); |
6f937416 PA |
1491 | extern VEC (char_ptr) *default_make_symbol_completion_list (const char *, |
1492 | const char *, | |
2f68a895 | 1493 | enum type_code); |
6f937416 PA |
1494 | extern VEC (char_ptr) *make_symbol_completion_list (const char *, const char *); |
1495 | extern VEC (char_ptr) *make_symbol_completion_type (const char *, const char *, | |
2f68a895 | 1496 | enum type_code); |
49c4e619 | 1497 | extern VEC (char_ptr) *make_symbol_completion_list_fn (struct cmd_list_element *, |
6f937416 PA |
1498 | const char *, |
1499 | const char *); | |
c906108c | 1500 | |
6f937416 PA |
1501 | extern VEC (char_ptr) *make_file_symbol_completion_list (const char *, |
1502 | const char *, | |
1503 | const char *); | |
c94fdfd0 | 1504 | |
6f937416 PA |
1505 | extern VEC (char_ptr) *make_source_files_completion_list (const char *, |
1506 | const char *); | |
c94fdfd0 | 1507 | |
c906108c SS |
1508 | /* symtab.c */ |
1509 | ||
714835d5 | 1510 | int matching_obj_sections (struct obj_section *, struct obj_section *); |
94277a38 | 1511 | |
50641945 FN |
1512 | extern struct symtab *find_line_symtab (struct symtab *, int, int *, int *); |
1513 | ||
17c5ed2c DC |
1514 | extern struct symtab_and_line find_function_start_sal (struct symbol *sym, |
1515 | int); | |
50641945 | 1516 | |
059acae7 UW |
1517 | extern void skip_prologue_sal (struct symtab_and_line *); |
1518 | ||
c906108c SS |
1519 | /* symtab.c */ |
1520 | ||
d80b854b UW |
1521 | extern CORE_ADDR skip_prologue_using_sal (struct gdbarch *gdbarch, |
1522 | CORE_ADDR func_addr); | |
634aa483 | 1523 | |
a14ed312 KB |
1524 | extern struct symbol *fixup_symbol_section (struct symbol *, |
1525 | struct objfile *); | |
c906108c SS |
1526 | |
1527 | /* Symbol searching */ | |
5c04624b DE |
1528 | /* Note: struct symbol_search, search_symbols, et.al. are declared here, |
1529 | instead of making them local to symtab.c, for gdbtk's sake. */ | |
c906108c SS |
1530 | |
1531 | /* When using search_symbols, a list of the following structs is returned. | |
c378eb4e | 1532 | Callers must free the search list using free_search_symbols! */ |
c906108c | 1533 | struct symbol_search |
17c5ed2c | 1534 | { |
c378eb4e MS |
1535 | /* The block in which the match was found. Could be, for example, |
1536 | STATIC_BLOCK or GLOBAL_BLOCK. */ | |
17c5ed2c | 1537 | int block; |
c906108c | 1538 | |
17c5ed2c | 1539 | /* Information describing what was found. |
c906108c | 1540 | |
d01060f0 | 1541 | If symbol is NOT NULL, then information was found for this match. */ |
17c5ed2c | 1542 | struct symbol *symbol; |
c906108c | 1543 | |
17c5ed2c | 1544 | /* If msymbol is non-null, then a match was made on something for |
c378eb4e | 1545 | which only minimal_symbols exist. */ |
7c7b6655 | 1546 | struct bound_minimal_symbol msymbol; |
c906108c | 1547 | |
c378eb4e | 1548 | /* A link to the next match, or NULL for the end. */ |
17c5ed2c DC |
1549 | struct symbol_search *next; |
1550 | }; | |
c906108c | 1551 | |
96142726 TT |
1552 | extern void search_symbols (const char *, enum search_domain, int, |
1553 | const char **, struct symbol_search **); | |
a14ed312 | 1554 | extern void free_search_symbols (struct symbol_search *); |
17c5ed2c | 1555 | extern struct cleanup *make_cleanup_free_search_symbols (struct symbol_search |
b52109bc | 1556 | **); |
c906108c | 1557 | |
51cc5b07 AC |
1558 | /* The name of the ``main'' function. |
1559 | FIXME: cagney/2001-03-20: Can't make main_name() const since some | |
1560 | of the calling code currently assumes that the string isn't | |
c378eb4e | 1561 | const. */ |
17c5ed2c | 1562 | extern /*const */ char *main_name (void); |
9e6c82ad | 1563 | extern enum language main_language (void); |
51cc5b07 | 1564 | |
cf901d3b DE |
1565 | /* Lookup symbol NAME from DOMAIN in MAIN_OBJFILE's global blocks. |
1566 | This searches MAIN_OBJFILE as well as any associated separate debug info | |
1567 | objfiles of MAIN_OBJFILE. | |
d12307c1 | 1568 | Upon success fixes up the symbol's section if necessary. */ |
cf901d3b | 1569 | |
d12307c1 | 1570 | extern struct block_symbol |
efad9b6a | 1571 | lookup_global_symbol_from_objfile (struct objfile *main_objfile, |
cf901d3b DE |
1572 | const char *name, |
1573 | const domain_enum domain); | |
3a40aaa0 | 1574 | |
a6c727b2 DJ |
1575 | /* Return 1 if the supplied producer string matches the ARM RealView |
1576 | compiler (armcc). */ | |
1577 | int producer_is_realview (const char *producer); | |
3a40aaa0 | 1578 | |
ccefe4c4 TT |
1579 | void fixup_section (struct general_symbol_info *ginfo, |
1580 | CORE_ADDR addr, struct objfile *objfile); | |
1581 | ||
cf901d3b DE |
1582 | /* Look up objfile containing BLOCK. */ |
1583 | ||
c0201579 JK |
1584 | struct objfile *lookup_objfile_from_block (const struct block *block); |
1585 | ||
db0fec5c | 1586 | extern unsigned int symtab_create_debug; |
45cfd468 | 1587 | |
cc485e62 DE |
1588 | extern unsigned int symbol_lookup_debug; |
1589 | ||
c011a4f4 DE |
1590 | extern int basenames_may_differ; |
1591 | ||
4aac40c8 | 1592 | int compare_filenames_for_search (const char *filename, |
b57a636e | 1593 | const char *search_name); |
4aac40c8 | 1594 | |
f8eba3c6 | 1595 | int iterate_over_some_symtabs (const char *name, |
f8eba3c6 TT |
1596 | const char *real_path, |
1597 | int (*callback) (struct symtab *symtab, | |
1598 | void *data), | |
1599 | void *data, | |
43f3e411 DE |
1600 | struct compunit_symtab *first, |
1601 | struct compunit_symtab *after_last); | |
f8eba3c6 TT |
1602 | |
1603 | void iterate_over_symtabs (const char *name, | |
1604 | int (*callback) (struct symtab *symtab, | |
1605 | void *data), | |
1606 | void *data); | |
1607 | ||
1608 | DEF_VEC_I (CORE_ADDR); | |
1609 | ||
1610 | VEC (CORE_ADDR) *find_pcs_for_symtab_line (struct symtab *symtab, int line, | |
1611 | struct linetable_entry **best_entry); | |
1612 | ||
8e704927 GB |
1613 | /* Callback for LA_ITERATE_OVER_SYMBOLS. The callback will be called |
1614 | once per matching symbol SYM, with DATA being the argument of the | |
1615 | same name that was passed to LA_ITERATE_OVER_SYMBOLS. The callback | |
1616 | should return nonzero to indicate that LA_ITERATE_OVER_SYMBOLS | |
1617 | should continue iterating, or zero to indicate that the iteration | |
1618 | should end. */ | |
1619 | ||
1620 | typedef int (symbol_found_callback_ftype) (struct symbol *sym, void *data); | |
1621 | ||
f8eba3c6 TT |
1622 | void iterate_over_symbols (const struct block *block, const char *name, |
1623 | const domain_enum domain, | |
8e704927 | 1624 | symbol_found_callback_ftype *callback, |
f8eba3c6 TT |
1625 | void *data); |
1626 | ||
1627 | struct cleanup *demangle_for_lookup (const char *name, enum language lang, | |
1628 | const char **result_name); | |
1629 | ||
e623cf5d TT |
1630 | struct symbol *allocate_symbol (struct objfile *); |
1631 | ||
38bf1463 | 1632 | void initialize_objfile_symbol (struct symbol *); |
e623cf5d TT |
1633 | |
1634 | struct template_symbol *allocate_template_symbol (struct objfile *); | |
1635 | ||
c906108c | 1636 | #endif /* !defined(SYMTAB_H) */ |