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