Commit | Line | Data |
---|---|---|
c906108c | 1 | /* Definitions for reading symbol files into GDB. |
b6ba6518 | 2 | Copyright 1990, 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, |
086df311 | 3 | 2000, 2001, 2002, 2003 |
c906108c SS |
4 | Free Software Foundation, Inc. |
5 | ||
c5aa993b | 6 | This file is part of GDB. |
c906108c | 7 | |
c5aa993b JM |
8 | This program is free software; you can redistribute it and/or modify |
9 | it under the terms of the GNU General Public License as published by | |
10 | the Free Software Foundation; either version 2 of the License, or | |
11 | (at your option) any later version. | |
c906108c | 12 | |
c5aa993b JM |
13 | This program is distributed in the hope that it will be useful, |
14 | but WITHOUT ANY WARRANTY; without even the implied warranty of | |
15 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
16 | GNU General Public License for more details. | |
c906108c | 17 | |
c5aa993b JM |
18 | You should have received a copy of the GNU General Public License |
19 | along with this program; if not, write to the Free Software | |
20 | Foundation, Inc., 59 Temple Place - Suite 330, | |
21 | Boston, MA 02111-1307, USA. */ | |
c906108c SS |
22 | |
23 | #if !defined (SYMFILE_H) | |
24 | #define SYMFILE_H | |
25 | ||
26 | /* This file requires that you first include "bfd.h". */ | |
27 | ||
63ca651f DC |
28 | /* Opaque declarations. */ |
29 | ||
30 | struct obstack; | |
31 | ||
c906108c SS |
32 | /* Partial symbols are stored in the psymbol_cache and pointers to them |
33 | are kept in a dynamically grown array that is obtained from malloc and | |
34 | grown as necessary via realloc. Each objfile typically has two of these, | |
35 | one for global symbols and one for static symbols. Although this adds | |
36 | a level of indirection for storing or accessing the partial symbols, | |
37 | it allows us to throw away duplicate psymbols and set all pointers | |
38 | to the single saved instance. */ | |
39 | ||
c5aa993b JM |
40 | struct psymbol_allocation_list |
41 | { | |
c906108c | 42 | |
c5aa993b JM |
43 | /* Pointer to beginning of dynamically allocated array of pointers to |
44 | partial symbols. The array is dynamically expanded as necessary to | |
45 | accommodate more pointers. */ | |
c906108c | 46 | |
c5aa993b | 47 | struct partial_symbol **list; |
c906108c | 48 | |
c5aa993b JM |
49 | /* Pointer to next available slot in which to store a pointer to a partial |
50 | symbol. */ | |
c906108c | 51 | |
c5aa993b | 52 | struct partial_symbol **next; |
c906108c | 53 | |
c5aa993b JM |
54 | /* Number of allocated pointer slots in current dynamic array (not the |
55 | number of bytes of storage). The "next" pointer will always point | |
56 | somewhere between list[0] and list[size], and when at list[size] the | |
57 | array will be expanded on the next attempt to store a pointer. */ | |
c906108c | 58 | |
c5aa993b JM |
59 | int size; |
60 | }; | |
c906108c | 61 | |
62557bbc KB |
62 | /* Define an array of addresses to accommodate non-contiguous dynamic |
63 | loading of modules. This is for use when entering commands, so we | |
64 | can keep track of the section names until we read the file and | |
65 | can map them to bfd sections. This structure is also used by | |
66 | solib.c to communicate the section addresses in shared objects to | |
67 | symbol_file_add (). */ | |
68 | ||
8157b967 | 69 | #define MAX_SECTIONS 64 |
62557bbc KB |
70 | struct section_addr_info |
71 | { | |
9d8a64cb | 72 | /* Sections whose names are file format dependent. */ |
62557bbc KB |
73 | struct other_sections |
74 | { | |
75 | CORE_ADDR addr; | |
76 | char *name; | |
77 | int sectindex; | |
78 | } other[MAX_SECTIONS]; | |
79 | }; | |
80 | ||
c906108c SS |
81 | /* Structure to keep track of symbol reading functions for various |
82 | object file types. */ | |
83 | ||
c5aa993b JM |
84 | struct sym_fns |
85 | { | |
c906108c | 86 | |
c5aa993b JM |
87 | /* BFD flavour that we handle, or (as a special kludge, see xcoffread.c, |
88 | (enum bfd_flavour)-1 for xcoff). */ | |
c906108c | 89 | |
c5aa993b | 90 | enum bfd_flavour sym_flavour; |
c906108c | 91 | |
c5aa993b JM |
92 | /* Initializes anything that is global to the entire symbol table. It is |
93 | called during symbol_file_add, when we begin debugging an entirely new | |
94 | program. */ | |
c906108c | 95 | |
507f3c78 | 96 | void (*sym_new_init) (struct objfile *); |
c906108c | 97 | |
c5aa993b JM |
98 | /* Reads any initial information from a symbol file, and initializes the |
99 | struct sym_fns SF in preparation for sym_read(). It is called every | |
100 | time we read a symbol file for any reason. */ | |
c906108c | 101 | |
507f3c78 | 102 | void (*sym_init) (struct objfile *); |
c906108c | 103 | |
d4f3574e | 104 | /* sym_read (objfile, mainline) |
c5aa993b JM |
105 | Reads a symbol file into a psymtab (or possibly a symtab). |
106 | OBJFILE is the objfile struct for the file we are reading. | |
c5aa993b JM |
107 | MAINLINE is 1 if this is the |
108 | main symbol table being read, and 0 if a secondary | |
109 | symbol file (e.g. shared library or dynamically loaded file) | |
110 | is being read. */ | |
c906108c | 111 | |
507f3c78 | 112 | void (*sym_read) (struct objfile *, int); |
c906108c | 113 | |
c5aa993b JM |
114 | /* Called when we are finished with an objfile. Should do all cleanup |
115 | that is specific to the object file format for the particular objfile. */ | |
c906108c | 116 | |
507f3c78 | 117 | void (*sym_finish) (struct objfile *); |
c906108c | 118 | |
c5aa993b JM |
119 | /* This function produces a file-dependent section_offsets structure, |
120 | allocated in the objfile's storage, and based on the parameter. | |
121 | The parameter is currently a CORE_ADDR (FIXME!) for backward compatibility | |
122 | with the higher levels of GDB. It should probably be changed to | |
123 | a string, where NULL means the default, and others are parsed in a file | |
d4f3574e | 124 | dependent way. */ |
c906108c | 125 | |
507f3c78 | 126 | void (*sym_offsets) (struct objfile *, struct section_addr_info *); |
c906108c | 127 | |
c5aa993b JM |
128 | /* Finds the next struct sym_fns. They are allocated and initialized |
129 | in whatever module implements the functions pointed to; an | |
130 | initializer calls add_symtab_fns to add them to the global chain. */ | |
c906108c | 131 | |
c5aa993b JM |
132 | struct sym_fns *next; |
133 | ||
134 | }; | |
c906108c SS |
135 | |
136 | /* The default version of sym_fns.sym_offsets for readers that don't | |
137 | do anything special. */ | |
138 | ||
570b8f7c AC |
139 | extern void default_symfile_offsets (struct objfile *objfile, |
140 | struct section_addr_info *); | |
c906108c SS |
141 | |
142 | ||
570b8f7c AC |
143 | extern void extend_psymbol_list (struct psymbol_allocation_list *, |
144 | struct objfile *); | |
c906108c SS |
145 | |
146 | /* Add any kind of symbol to a psymbol_allocation_list. */ | |
147 | ||
148 | /* #include "demangle.h" */ | |
149 | ||
150 | extern void | |
a14ed312 KB |
151 | add_psymbol_to_list (char *, int, namespace_enum, enum address_class, |
152 | struct psymbol_allocation_list *, long, CORE_ADDR, | |
153 | enum language, struct objfile *); | |
c906108c SS |
154 | |
155 | extern void | |
a14ed312 KB |
156 | add_psymbol_with_dem_name_to_list (char *, int, char *, int, namespace_enum, |
157 | enum address_class, | |
158 | struct psymbol_allocation_list *, | |
159 | long, CORE_ADDR, | |
160 | enum language, struct objfile *); | |
c906108c SS |
161 | |
162 | ||
a14ed312 | 163 | extern void init_psymbol_list (struct objfile *, int); |
c906108c | 164 | |
a14ed312 | 165 | extern void sort_pst_symbols (struct partial_symtab *); |
c906108c | 166 | |
a14ed312 | 167 | extern struct symtab *allocate_symtab (char *, struct objfile *); |
c906108c | 168 | |
a14ed312 | 169 | extern int free_named_symtabs (char *); |
c906108c | 170 | |
a14ed312 | 171 | extern void fill_in_vptr_fieldno (struct type *); |
c906108c | 172 | |
a14ed312 | 173 | extern void add_symtab_fns (struct sym_fns *); |
c906108c | 174 | |
a14ed312 | 175 | extern void init_entry_point_info (struct objfile *); |
c906108c | 176 | |
7e8580c1 JB |
177 | extern void syms_from_objfile (struct objfile *, |
178 | struct section_addr_info *, | |
179 | struct section_offsets *, int, | |
180 | int, int); | |
c906108c | 181 | |
a14ed312 | 182 | extern void new_symfile_objfile (struct objfile *, int, int); |
c906108c | 183 | |
a14ed312 KB |
184 | extern struct objfile *symbol_file_add (char *, int, |
185 | struct section_addr_info *, int, int); | |
62557bbc KB |
186 | |
187 | /* Build (allocate and populate) a section_addr_info struct from | |
188 | an existing section table. */ | |
189 | ||
190 | struct section_table; | |
191 | extern struct section_addr_info * | |
192 | build_section_addr_info_from_section_table (const struct section_table *start, | |
193 | const struct section_table *end); | |
194 | ||
195 | /* Free all memory allocated by build_section_addr_info_from_section_table. */ | |
196 | ||
570b8f7c | 197 | extern void free_section_addr_info (struct section_addr_info *); |
62557bbc KB |
198 | |
199 | ||
a14ed312 KB |
200 | extern struct partial_symtab *start_psymtab_common (struct objfile *, |
201 | struct section_offsets *, | |
202 | char *, CORE_ADDR, | |
203 | struct partial_symbol **, | |
204 | struct partial_symbol **); | |
c906108c SS |
205 | |
206 | /* Sorting your symbols for fast lookup or alphabetical printing. */ | |
207 | ||
a14ed312 | 208 | extern void sort_block_syms (struct block *); |
c906108c | 209 | |
a14ed312 | 210 | extern void sort_symtab_syms (struct symtab *); |
c906108c SS |
211 | |
212 | /* Make a copy of the string at PTR with SIZE characters in the symbol obstack | |
213 | (and add a null character at the end in the copy). | |
214 | Returns the address of the copy. */ | |
215 | ||
63ca651f | 216 | extern char *obsavestring (const char *, int, struct obstack *); |
c906108c SS |
217 | |
218 | /* Concatenate strings S1, S2 and S3; return the new string. | |
219 | Space is found in the symbol_obstack. */ | |
220 | ||
a14ed312 KB |
221 | extern char *obconcat (struct obstack *obstackp, const char *, const char *, |
222 | const char *); | |
c906108c SS |
223 | |
224 | /* Variables */ | |
225 | ||
b7209cb4 FF |
226 | /* If non-zero, shared library symbols will be added automatically |
227 | when the inferior is created, new libraries are loaded, or when | |
228 | attaching to the inferior. This is almost always what users will | |
229 | want to have happen; but for very large programs, the startup time | |
230 | will be excessive, and so if this is a problem, the user can clear | |
231 | this flag and then add the shared library symbols as needed. Note | |
232 | that there is a potential for confusion, since if the shared | |
233 | library symbols are not loaded, commands like "info fun" will *not* | |
234 | report all the functions that are actually present. */ | |
c906108c | 235 | |
b7209cb4 | 236 | extern int auto_solib_add; |
c906108c | 237 | |
b7209cb4 FF |
238 | /* For systems that support it, a threshold size in megabytes. If |
239 | automatically adding a new library's symbol table to those already | |
240 | known to the debugger would cause the total shared library symbol | |
241 | size to exceed this threshhold, then the shlib's symbols are not | |
242 | added. The threshold is ignored if the user explicitly asks for a | |
243 | shlib to be added, such as when using the "sharedlibrary" | |
244 | command. */ | |
c906108c | 245 | |
b7209cb4 | 246 | extern int auto_solib_limit; |
c906108c SS |
247 | |
248 | /* From symfile.c */ | |
249 | ||
a14ed312 | 250 | extern CORE_ADDR entry_point_address (void); |
c906108c | 251 | |
a14ed312 | 252 | extern struct partial_symtab *allocate_psymtab (char *, struct objfile *); |
c906108c | 253 | |
a14ed312 | 254 | extern void discard_psymtab (struct partial_symtab *); |
c906108c | 255 | |
4efb68b1 | 256 | extern void find_lowest_section (bfd *, asection *, void *); |
c906108c | 257 | |
a14ed312 | 258 | extern bfd *symfile_bfd_open (char *); |
c906108c | 259 | |
e2f6d8e5 JB |
260 | extern int get_section_index (struct objfile *, char *); |
261 | ||
c906108c | 262 | /* Utility functions for overlay sections: */ |
d874f1e2 MS |
263 | extern enum overlay_debugging_state { |
264 | ovly_off, | |
265 | ovly_on, | |
266 | ovly_auto | |
267 | } overlay_debugging; | |
c906108c SS |
268 | extern int overlay_cache_invalid; |
269 | ||
270 | /* return the "mapped" overlay section containing the PC */ | |
a14ed312 | 271 | extern asection *find_pc_mapped_section (CORE_ADDR); |
c906108c SS |
272 | |
273 | /* return any overlay section containing the PC (even in its LMA region) */ | |
a14ed312 | 274 | extern asection *find_pc_overlay (CORE_ADDR); |
c906108c SS |
275 | |
276 | /* return true if the section is an overlay */ | |
a14ed312 | 277 | extern int section_is_overlay (asection *); |
c906108c SS |
278 | |
279 | /* return true if the overlay section is currently "mapped" */ | |
a14ed312 | 280 | extern int section_is_mapped (asection *); |
c906108c SS |
281 | |
282 | /* return true if pc belongs to section's VMA */ | |
a14ed312 | 283 | extern CORE_ADDR pc_in_mapped_range (CORE_ADDR, asection *); |
c906108c SS |
284 | |
285 | /* return true if pc belongs to section's LMA */ | |
a14ed312 | 286 | extern CORE_ADDR pc_in_unmapped_range (CORE_ADDR, asection *); |
c906108c SS |
287 | |
288 | /* map an address from a section's LMA to its VMA */ | |
a14ed312 | 289 | extern CORE_ADDR overlay_mapped_address (CORE_ADDR, asection *); |
c906108c SS |
290 | |
291 | /* map an address from a section's VMA to its LMA */ | |
a14ed312 | 292 | extern CORE_ADDR overlay_unmapped_address (CORE_ADDR, asection *); |
c906108c SS |
293 | |
294 | /* convert an address in an overlay section (force into VMA range) */ | |
a14ed312 | 295 | extern CORE_ADDR symbol_overlayed_address (CORE_ADDR, asection *); |
c906108c | 296 | |
1adeb98a FN |
297 | /* Load symbols from a file. */ |
298 | extern void symbol_file_add_main (char *args, int from_tty); | |
299 | ||
300 | /* Clear GDB symbol tables. */ | |
301 | extern void symbol_file_clear (int from_tty); | |
302 | ||
086df311 DJ |
303 | extern bfd_byte *symfile_relocate_debug_section (bfd *abfd, asection *sectp, |
304 | bfd_byte *buf); | |
305 | ||
c906108c SS |
306 | /* From dwarfread.c */ |
307 | ||
308 | extern void | |
a14ed312 KB |
309 | dwarf_build_psymtabs (struct objfile *, int, file_ptr, unsigned int, |
310 | file_ptr, unsigned int); | |
c906108c SS |
311 | |
312 | /* From dwarf2read.c */ | |
313 | ||
a14ed312 | 314 | extern int dwarf2_has_info (bfd * abfd); |
c906108c | 315 | |
a14ed312 | 316 | extern void dwarf2_build_psymtabs (struct objfile *, int); |
b6af0555 | 317 | extern void dwarf2_build_frame_info (struct objfile *); |
d4f3574e | 318 | |
c906108c SS |
319 | /* From mdebugread.c */ |
320 | ||
321 | /* Hack to force structures to exist before use in parameter list. */ | |
322 | struct ecoff_debug_hack | |
c5aa993b JM |
323 | { |
324 | struct ecoff_debug_swap *a; | |
325 | struct ecoff_debug_info *b; | |
326 | }; | |
c906108c | 327 | extern void |
a14ed312 KB |
328 | mdebug_build_psymtabs (struct objfile *, |
329 | const struct ecoff_debug_swap *, | |
330 | struct ecoff_debug_info *); | |
c906108c SS |
331 | |
332 | extern void | |
a14ed312 KB |
333 | elfmdebug_build_psymtabs (struct objfile *, |
334 | const struct ecoff_debug_swap *, asection *); | |
c906108c | 335 | |
c5aa993b | 336 | #endif /* !defined(SYMFILE_H) */ |