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