Commit | Line | Data |
---|---|---|
c906108c SS |
1 | /* Definitions for reading symbol files into GDB. |
2 | Copyright (C) 1990, 1991, 1992, 1993, 1994, 1996 | |
3 | Free Software Foundation, Inc. | |
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 | |
9 | the Free Software Foundation; either version 2 of the License, or | |
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 JM |
17 | You should have received a copy of the GNU General Public License |
18 | along with this program; if not, write to the Free Software | |
19 | Foundation, Inc., 59 Temple Place - Suite 330, | |
20 | Boston, MA 02111-1307, USA. */ | |
c906108c SS |
21 | |
22 | #if !defined (SYMFILE_H) | |
23 | #define SYMFILE_H | |
24 | ||
25 | /* This file requires that you first include "bfd.h". */ | |
26 | ||
27 | /* Partial symbols are stored in the psymbol_cache and pointers to them | |
28 | are kept in a dynamically grown array that is obtained from malloc and | |
29 | grown as necessary via realloc. Each objfile typically has two of these, | |
30 | one for global symbols and one for static symbols. Although this adds | |
31 | a level of indirection for storing or accessing the partial symbols, | |
32 | it allows us to throw away duplicate psymbols and set all pointers | |
33 | to the single saved instance. */ | |
34 | ||
c5aa993b JM |
35 | struct psymbol_allocation_list |
36 | { | |
c906108c | 37 | |
c5aa993b JM |
38 | /* Pointer to beginning of dynamically allocated array of pointers to |
39 | partial symbols. The array is dynamically expanded as necessary to | |
40 | accommodate more pointers. */ | |
c906108c | 41 | |
c5aa993b | 42 | struct partial_symbol **list; |
c906108c | 43 | |
c5aa993b JM |
44 | /* Pointer to next available slot in which to store a pointer to a partial |
45 | symbol. */ | |
c906108c | 46 | |
c5aa993b | 47 | struct partial_symbol **next; |
c906108c | 48 | |
c5aa993b JM |
49 | /* Number of allocated pointer slots in current dynamic array (not the |
50 | number of bytes of storage). The "next" pointer will always point | |
51 | somewhere between list[0] and list[size], and when at list[size] the | |
52 | array will be expanded on the next attempt to store a pointer. */ | |
c906108c | 53 | |
c5aa993b JM |
54 | int size; |
55 | }; | |
c906108c | 56 | |
62557bbc KB |
57 | /* Define an array of addresses to accommodate non-contiguous dynamic |
58 | loading of modules. This is for use when entering commands, so we | |
59 | can keep track of the section names until we read the file and | |
60 | can map them to bfd sections. This structure is also used by | |
61 | solib.c to communicate the section addresses in shared objects to | |
62 | symbol_file_add (). */ | |
63 | ||
64 | #define MAX_SECTIONS 40 | |
65 | struct section_addr_info | |
66 | { | |
67 | /* Sections whose names are always known to gdb. */ | |
68 | CORE_ADDR text_addr; | |
69 | CORE_ADDR data_addr; | |
70 | CORE_ADDR bss_addr; | |
71 | /* Sections whose names are file format dependant. */ | |
72 | struct other_sections | |
73 | { | |
74 | CORE_ADDR addr; | |
75 | char *name; | |
76 | int sectindex; | |
77 | } other[MAX_SECTIONS]; | |
78 | }; | |
79 | ||
c906108c SS |
80 | /* Structure to keep track of symbol reading functions for various |
81 | object file types. */ | |
82 | ||
c5aa993b JM |
83 | struct sym_fns |
84 | { | |
c906108c | 85 | |
c5aa993b JM |
86 | /* BFD flavour that we handle, or (as a special kludge, see xcoffread.c, |
87 | (enum bfd_flavour)-1 for xcoff). */ | |
c906108c | 88 | |
c5aa993b | 89 | enum bfd_flavour sym_flavour; |
c906108c | 90 | |
c5aa993b JM |
91 | /* Initializes anything that is global to the entire symbol table. It is |
92 | called during symbol_file_add, when we begin debugging an entirely new | |
93 | program. */ | |
c906108c | 94 | |
c5aa993b | 95 | void (*sym_new_init) PARAMS ((struct objfile *)); |
c906108c | 96 | |
c5aa993b JM |
97 | /* Reads any initial information from a symbol file, and initializes the |
98 | struct sym_fns SF in preparation for sym_read(). It is called every | |
99 | time we read a symbol file for any reason. */ | |
c906108c | 100 | |
c5aa993b | 101 | void (*sym_init) PARAMS ((struct objfile *)); |
c906108c | 102 | |
d4f3574e | 103 | /* sym_read (objfile, mainline) |
c5aa993b JM |
104 | Reads a symbol file into a psymtab (or possibly a symtab). |
105 | OBJFILE is the objfile struct for the file we are reading. | |
c5aa993b JM |
106 | MAINLINE is 1 if this is the |
107 | main symbol table being read, and 0 if a secondary | |
108 | symbol file (e.g. shared library or dynamically loaded file) | |
109 | is being read. */ | |
c906108c | 110 | |
96baa820 | 111 | void (*sym_read) PARAMS ((struct objfile *, int)); |
c906108c | 112 | |
c5aa993b JM |
113 | /* Called when we are finished with an objfile. Should do all cleanup |
114 | that is specific to the object file format for the particular objfile. */ | |
c906108c | 115 | |
c5aa993b | 116 | void (*sym_finish) PARAMS ((struct objfile *)); |
c906108c | 117 | |
c5aa993b JM |
118 | /* This function produces a file-dependent section_offsets structure, |
119 | allocated in the objfile's storage, and based on the parameter. | |
120 | The parameter is currently a CORE_ADDR (FIXME!) for backward compatibility | |
121 | with the higher levels of GDB. It should probably be changed to | |
122 | a string, where NULL means the default, and others are parsed in a file | |
d4f3574e | 123 | dependent way. */ |
c906108c | 124 | |
2acceee2 | 125 | void (*sym_offsets) PARAMS ((struct objfile *, struct section_addr_info *)); |
c906108c | 126 | |
c5aa993b JM |
127 | /* Finds the next struct sym_fns. They are allocated and initialized |
128 | in whatever module implements the functions pointed to; an | |
129 | initializer calls add_symtab_fns to add them to the global chain. */ | |
c906108c | 130 | |
c5aa993b JM |
131 | struct sym_fns *next; |
132 | ||
133 | }; | |
c906108c SS |
134 | |
135 | /* The default version of sym_fns.sym_offsets for readers that don't | |
136 | do anything special. */ | |
137 | ||
d4f3574e | 138 | extern void |
2acceee2 | 139 | default_symfile_offsets PARAMS ((struct objfile * objfile, struct section_addr_info *)); |
c906108c SS |
140 | |
141 | ||
142 | extern void | |
143 | extend_psymbol_list PARAMS ((struct psymbol_allocation_list *, | |
144 | struct objfile *)); | |
145 | ||
146 | /* Add any kind of symbol to a psymbol_allocation_list. */ | |
147 | ||
148 | /* #include "demangle.h" */ | |
149 | ||
150 | extern void | |
151 | add_psymbol_to_list PARAMS ((char *, int, namespace_enum, enum address_class, | |
c5aa993b | 152 | struct psymbol_allocation_list *, long, CORE_ADDR, |
c906108c SS |
153 | enum language, struct objfile *)); |
154 | ||
155 | extern void | |
c5aa993b JM |
156 | add_psymbol_with_dem_name_to_list PARAMS ((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 | ||
163 | extern void init_psymbol_list PARAMS ((struct objfile *, int)); | |
164 | ||
165 | extern void | |
166 | sort_pst_symbols PARAMS ((struct partial_symtab *)); | |
167 | ||
168 | extern struct symtab * | |
c5aa993b | 169 | allocate_symtab PARAMS ((char *, struct objfile *)); |
c906108c SS |
170 | |
171 | extern int | |
172 | free_named_symtabs PARAMS ((char *)); | |
173 | ||
174 | extern void | |
175 | fill_in_vptr_fieldno PARAMS ((struct type *)); | |
176 | ||
177 | extern void | |
178 | add_symtab_fns PARAMS ((struct sym_fns *)); | |
179 | ||
180 | extern void | |
181 | init_entry_point_info PARAMS ((struct objfile *)); | |
182 | ||
183 | extern void | |
2acceee2 | 184 | syms_from_objfile PARAMS ((struct objfile *, struct section_addr_info *, int, int)); |
c906108c SS |
185 | |
186 | extern void | |
187 | new_symfile_objfile PARAMS ((struct objfile *, int, int)); | |
188 | ||
62557bbc KB |
189 | extern struct objfile * |
190 | symbol_file_add PARAMS ((char *, int, struct section_addr_info *, int, int)); | |
191 | ||
192 | /* Build (allocate and populate) a section_addr_info struct from | |
193 | an existing section table. */ | |
194 | ||
195 | struct section_table; | |
196 | extern struct section_addr_info * | |
197 | build_section_addr_info_from_section_table (const struct section_table *start, | |
198 | const struct section_table *end); | |
199 | ||
200 | /* Free all memory allocated by build_section_addr_info_from_section_table. */ | |
201 | ||
202 | extern void | |
203 | free_section_addr_info (struct section_addr_info *); | |
204 | ||
205 | ||
c906108c | 206 | extern struct partial_symtab * |
c5aa993b JM |
207 | start_psymtab_common PARAMS ((struct objfile *, struct section_offsets *, |
208 | char *, CORE_ADDR, | |
209 | struct partial_symbol **, | |
210 | struct partial_symbol **)); | |
c906108c SS |
211 | |
212 | /* Sorting your symbols for fast lookup or alphabetical printing. */ | |
213 | ||
214 | extern void | |
215 | sort_block_syms PARAMS ((struct block *)); | |
216 | ||
217 | extern void | |
218 | sort_symtab_syms PARAMS ((struct symtab *)); | |
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 | ||
224 | extern char * | |
c5aa993b | 225 | obsavestring PARAMS ((char *, int, struct obstack *)); |
c906108c SS |
226 | |
227 | /* Concatenate strings S1, S2 and S3; return the new string. | |
228 | Space is found in the symbol_obstack. */ | |
229 | ||
230 | extern char * | |
c5aa993b JM |
231 | obconcat PARAMS ((struct obstack * obstackp, const char *, const char *, |
232 | const char *)); | |
c906108c SS |
233 | |
234 | /* Variables */ | |
235 | ||
236 | /* whether to auto load solibs at startup time: 0/1. | |
237 | ||
238 | On all platforms, 0 means "don't auto load". | |
239 | ||
240 | On HP-UX, > 0 means a threshhold, in megabytes, of symbol table which will | |
241 | be auto loaded. When the cumulative size of solib symbol table exceeds | |
242 | this threshhold, solibs' symbol tables will not be loaded. | |
243 | ||
244 | On other platforms, > 0 means, "always auto load". | |
c5aa993b | 245 | */ |
c906108c SS |
246 | |
247 | extern int auto_solib_add; | |
248 | ||
249 | /* From symfile.c */ | |
250 | ||
251 | extern CORE_ADDR | |
c5aa993b | 252 | entry_point_address PARAMS ((void)); |
c906108c SS |
253 | |
254 | extern struct partial_symtab * | |
c5aa993b | 255 | allocate_psymtab PARAMS ((char *, struct objfile *)); |
c906108c SS |
256 | |
257 | extern void | |
258 | discard_psymtab PARAMS ((struct partial_symtab *)); | |
259 | ||
260 | extern void find_lowest_section PARAMS ((bfd *, asection *, PTR)); | |
261 | ||
c5aa993b | 262 | extern bfd *symfile_bfd_open PARAMS ((char *)); |
c906108c | 263 | |
c906108c SS |
264 | /* Utility functions for overlay sections: */ |
265 | extern int overlay_debugging; | |
266 | extern int overlay_cache_invalid; | |
267 | ||
268 | /* return the "mapped" overlay section containing the PC */ | |
c5aa993b JM |
269 | extern asection * |
270 | find_pc_mapped_section PARAMS ((CORE_ADDR)); | |
c906108c SS |
271 | |
272 | /* return any overlay section containing the PC (even in its LMA region) */ | |
273 | extern asection * | |
c5aa993b | 274 | find_pc_overlay PARAMS ((CORE_ADDR)); |
c906108c SS |
275 | |
276 | /* return true if the section is an overlay */ | |
277 | extern int | |
278 | section_is_overlay PARAMS ((asection *)); | |
279 | ||
280 | /* return true if the overlay section is currently "mapped" */ | |
281 | extern int | |
282 | section_is_mapped PARAMS ((asection *)); | |
283 | ||
284 | /* return true if pc belongs to section's VMA */ | |
285 | extern CORE_ADDR | |
c5aa993b | 286 | pc_in_mapped_range PARAMS ((CORE_ADDR, asection *)); |
c906108c SS |
287 | |
288 | /* return true if pc belongs to section's LMA */ | |
289 | extern CORE_ADDR | |
c5aa993b | 290 | pc_in_unmapped_range PARAMS ((CORE_ADDR, asection *)); |
c906108c SS |
291 | |
292 | /* map an address from a section's LMA to its VMA */ | |
293 | extern CORE_ADDR | |
c5aa993b | 294 | overlay_mapped_address PARAMS ((CORE_ADDR, asection *)); |
c906108c SS |
295 | |
296 | /* map an address from a section's VMA to its LMA */ | |
297 | extern CORE_ADDR | |
c5aa993b | 298 | overlay_unmapped_address PARAMS ((CORE_ADDR, asection *)); |
c906108c SS |
299 | |
300 | /* convert an address in an overlay section (force into VMA range) */ | |
c5aa993b JM |
301 | extern CORE_ADDR |
302 | symbol_overlayed_address PARAMS ((CORE_ADDR, asection *)); | |
c906108c SS |
303 | |
304 | /* From dwarfread.c */ | |
305 | ||
306 | extern void | |
d4f3574e SS |
307 | dwarf_build_psymtabs PARAMS ((struct objfile *, int, file_ptr, unsigned int, |
308 | file_ptr, unsigned int)); | |
c906108c SS |
309 | |
310 | /* From dwarf2read.c */ | |
311 | ||
c5aa993b | 312 | extern int dwarf2_has_info PARAMS ((bfd * abfd)); |
c906108c | 313 | |
d4f3574e SS |
314 | extern void dwarf2_build_psymtabs PARAMS ((struct objfile *, int)); |
315 | ||
c906108c SS |
316 | /* From mdebugread.c */ |
317 | ||
318 | /* Hack to force structures to exist before use in parameter list. */ | |
319 | struct ecoff_debug_hack | |
c5aa993b JM |
320 | { |
321 | struct ecoff_debug_swap *a; | |
322 | struct ecoff_debug_info *b; | |
323 | }; | |
c906108c SS |
324 | extern void |
325 | mdebug_build_psymtabs PARAMS ((struct objfile *, | |
326 | const struct ecoff_debug_swap *, | |
d4f3574e | 327 | struct ecoff_debug_info *)); |
c906108c SS |
328 | |
329 | extern void | |
330 | elfmdebug_build_psymtabs PARAMS ((struct objfile *, | |
331 | const struct ecoff_debug_swap *, | |
d4f3574e | 332 | asection *)); |
c906108c | 333 | |
c5aa993b | 334 | #endif /* !defined(SYMFILE_H) */ |