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