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 SS |
56 | |
57 | /* Structure to keep track of symbol reading functions for various | |
58 | object file types. */ | |
59 | ||
c5aa993b JM |
60 | struct sym_fns |
61 | { | |
c906108c | 62 | |
c5aa993b JM |
63 | /* BFD flavour that we handle, or (as a special kludge, see xcoffread.c, |
64 | (enum bfd_flavour)-1 for xcoff). */ | |
c906108c | 65 | |
c5aa993b | 66 | enum bfd_flavour sym_flavour; |
c906108c | 67 | |
c5aa993b JM |
68 | /* Initializes anything that is global to the entire symbol table. It is |
69 | called during symbol_file_add, when we begin debugging an entirely new | |
70 | program. */ | |
c906108c | 71 | |
c5aa993b | 72 | void (*sym_new_init) PARAMS ((struct objfile *)); |
c906108c | 73 | |
c5aa993b JM |
74 | /* Reads any initial information from a symbol file, and initializes the |
75 | struct sym_fns SF in preparation for sym_read(). It is called every | |
76 | time we read a symbol file for any reason. */ | |
c906108c | 77 | |
c5aa993b | 78 | void (*sym_init) PARAMS ((struct objfile *)); |
c906108c | 79 | |
c5aa993b JM |
80 | /* sym_read (objfile, addr, mainline) |
81 | Reads a symbol file into a psymtab (or possibly a symtab). | |
82 | OBJFILE is the objfile struct for the file we are reading. | |
83 | SECTION_OFFSETS | |
84 | are the offset between the file's specified section addresses and | |
85 | their true addresses in memory. | |
86 | MAINLINE is 1 if this is the | |
87 | main symbol table being read, and 0 if a secondary | |
88 | symbol file (e.g. shared library or dynamically loaded file) | |
89 | is being read. */ | |
c906108c | 90 | |
c5aa993b | 91 | void (*sym_read) PARAMS ((struct objfile *, struct section_offsets *, int)); |
c906108c | 92 | |
c5aa993b JM |
93 | /* Called when we are finished with an objfile. Should do all cleanup |
94 | that is specific to the object file format for the particular objfile. */ | |
c906108c | 95 | |
c5aa993b | 96 | void (*sym_finish) PARAMS ((struct objfile *)); |
c906108c | 97 | |
c5aa993b JM |
98 | /* This function produces a file-dependent section_offsets structure, |
99 | allocated in the objfile's storage, and based on the parameter. | |
100 | The parameter is currently a CORE_ADDR (FIXME!) for backward compatibility | |
101 | with the higher levels of GDB. It should probably be changed to | |
102 | a string, where NULL means the default, and others are parsed in a file | |
103 | dependent way. The result of this function is handed in to sym_read. */ | |
c906108c | 104 | |
c5aa993b | 105 | struct section_offsets *(*sym_offsets) PARAMS ((struct objfile *, CORE_ADDR)); |
c906108c | 106 | |
c5aa993b JM |
107 | /* Finds the next struct sym_fns. They are allocated and initialized |
108 | in whatever module implements the functions pointed to; an | |
109 | initializer calls add_symtab_fns to add them to the global chain. */ | |
c906108c | 110 | |
c5aa993b JM |
111 | struct sym_fns *next; |
112 | ||
113 | }; | |
c906108c SS |
114 | |
115 | /* The default version of sym_fns.sym_offsets for readers that don't | |
116 | do anything special. */ | |
117 | ||
118 | extern struct section_offsets * | |
c5aa993b | 119 | default_symfile_offsets PARAMS ((struct objfile * objfile, CORE_ADDR addr)); |
c906108c SS |
120 | |
121 | ||
122 | extern void | |
123 | extend_psymbol_list PARAMS ((struct psymbol_allocation_list *, | |
124 | struct objfile *)); | |
125 | ||
126 | /* Add any kind of symbol to a psymbol_allocation_list. */ | |
127 | ||
128 | /* #include "demangle.h" */ | |
129 | ||
130 | extern void | |
131 | add_psymbol_to_list PARAMS ((char *, int, namespace_enum, enum address_class, | |
c5aa993b | 132 | struct psymbol_allocation_list *, long, CORE_ADDR, |
c906108c SS |
133 | enum language, struct objfile *)); |
134 | ||
135 | extern void | |
c5aa993b JM |
136 | add_psymbol_with_dem_name_to_list PARAMS ((char *, int, char *, int, namespace_enum, |
137 | enum address_class, | |
138 | struct psymbol_allocation_list *, | |
139 | long, CORE_ADDR, | |
140 | enum language, struct objfile *)); | |
c906108c SS |
141 | |
142 | ||
143 | extern void init_psymbol_list PARAMS ((struct objfile *, int)); | |
144 | ||
145 | extern void | |
146 | sort_pst_symbols PARAMS ((struct partial_symtab *)); | |
147 | ||
148 | extern struct symtab * | |
c5aa993b | 149 | allocate_symtab PARAMS ((char *, struct objfile *)); |
c906108c SS |
150 | |
151 | extern int | |
152 | free_named_symtabs PARAMS ((char *)); | |
153 | ||
154 | extern void | |
155 | fill_in_vptr_fieldno PARAMS ((struct type *)); | |
156 | ||
157 | extern void | |
158 | add_symtab_fns PARAMS ((struct sym_fns *)); | |
159 | ||
160 | extern void | |
161 | init_entry_point_info PARAMS ((struct objfile *)); | |
162 | ||
163 | extern void | |
164 | syms_from_objfile PARAMS ((struct objfile *, CORE_ADDR, int, int)); | |
165 | ||
166 | extern void | |
167 | new_symfile_objfile PARAMS ((struct objfile *, int, int)); | |
168 | ||
169 | extern struct partial_symtab * | |
c5aa993b JM |
170 | start_psymtab_common PARAMS ((struct objfile *, struct section_offsets *, |
171 | char *, CORE_ADDR, | |
172 | struct partial_symbol **, | |
173 | struct partial_symbol **)); | |
c906108c SS |
174 | |
175 | /* Sorting your symbols for fast lookup or alphabetical printing. */ | |
176 | ||
177 | extern void | |
178 | sort_block_syms PARAMS ((struct block *)); | |
179 | ||
180 | extern void | |
181 | sort_symtab_syms PARAMS ((struct symtab *)); | |
182 | ||
183 | /* Make a copy of the string at PTR with SIZE characters in the symbol obstack | |
184 | (and add a null character at the end in the copy). | |
185 | Returns the address of the copy. */ | |
186 | ||
187 | extern char * | |
c5aa993b | 188 | obsavestring PARAMS ((char *, int, struct obstack *)); |
c906108c SS |
189 | |
190 | /* Concatenate strings S1, S2 and S3; return the new string. | |
191 | Space is found in the symbol_obstack. */ | |
192 | ||
193 | extern char * | |
c5aa993b JM |
194 | obconcat PARAMS ((struct obstack * obstackp, const char *, const char *, |
195 | const char *)); | |
c906108c SS |
196 | |
197 | /* Variables */ | |
198 | ||
199 | /* whether to auto load solibs at startup time: 0/1. | |
200 | ||
201 | On all platforms, 0 means "don't auto load". | |
202 | ||
203 | On HP-UX, > 0 means a threshhold, in megabytes, of symbol table which will | |
204 | be auto loaded. When the cumulative size of solib symbol table exceeds | |
205 | this threshhold, solibs' symbol tables will not be loaded. | |
206 | ||
207 | On other platforms, > 0 means, "always auto load". | |
c5aa993b | 208 | */ |
c906108c SS |
209 | |
210 | extern int auto_solib_add; | |
211 | ||
212 | /* From symfile.c */ | |
213 | ||
214 | extern CORE_ADDR | |
c5aa993b | 215 | entry_point_address PARAMS ((void)); |
c906108c SS |
216 | |
217 | extern struct partial_symtab * | |
c5aa993b | 218 | allocate_psymtab PARAMS ((char *, struct objfile *)); |
c906108c SS |
219 | |
220 | extern void | |
221 | discard_psymtab PARAMS ((struct partial_symtab *)); | |
222 | ||
223 | extern void find_lowest_section PARAMS ((bfd *, asection *, PTR)); | |
224 | ||
c5aa993b | 225 | extern bfd *symfile_bfd_open PARAMS ((char *)); |
c906108c SS |
226 | |
227 | /* Remote targets may wish to use this as their load function. */ | |
228 | extern void generic_load PARAMS ((char *name, int from_tty)); | |
229 | ||
230 | /* Utility functions for overlay sections: */ | |
231 | extern int overlay_debugging; | |
232 | extern int overlay_cache_invalid; | |
233 | ||
234 | /* return the "mapped" overlay section containing the PC */ | |
c5aa993b JM |
235 | extern asection * |
236 | find_pc_mapped_section PARAMS ((CORE_ADDR)); | |
c906108c SS |
237 | |
238 | /* return any overlay section containing the PC (even in its LMA region) */ | |
239 | extern asection * | |
c5aa993b | 240 | find_pc_overlay PARAMS ((CORE_ADDR)); |
c906108c SS |
241 | |
242 | /* return true if the section is an overlay */ | |
243 | extern int | |
244 | section_is_overlay PARAMS ((asection *)); | |
245 | ||
246 | /* return true if the overlay section is currently "mapped" */ | |
247 | extern int | |
248 | section_is_mapped PARAMS ((asection *)); | |
249 | ||
250 | /* return true if pc belongs to section's VMA */ | |
251 | extern CORE_ADDR | |
c5aa993b | 252 | pc_in_mapped_range PARAMS ((CORE_ADDR, asection *)); |
c906108c SS |
253 | |
254 | /* return true if pc belongs to section's LMA */ | |
255 | extern CORE_ADDR | |
c5aa993b | 256 | pc_in_unmapped_range PARAMS ((CORE_ADDR, asection *)); |
c906108c SS |
257 | |
258 | /* map an address from a section's LMA to its VMA */ | |
259 | extern CORE_ADDR | |
c5aa993b | 260 | overlay_mapped_address PARAMS ((CORE_ADDR, asection *)); |
c906108c SS |
261 | |
262 | /* map an address from a section's VMA to its LMA */ | |
263 | extern CORE_ADDR | |
c5aa993b | 264 | overlay_unmapped_address PARAMS ((CORE_ADDR, asection *)); |
c906108c SS |
265 | |
266 | /* convert an address in an overlay section (force into VMA range) */ | |
c5aa993b JM |
267 | extern CORE_ADDR |
268 | symbol_overlayed_address PARAMS ((CORE_ADDR, asection *)); | |
c906108c SS |
269 | |
270 | /* From dwarfread.c */ | |
271 | ||
272 | extern void | |
273 | dwarf_build_psymtabs PARAMS ((struct objfile *, struct section_offsets *, int, | |
c5aa993b | 274 | file_ptr, unsigned int, file_ptr, unsigned int)); |
c906108c SS |
275 | |
276 | /* From dwarf2read.c */ | |
277 | ||
c5aa993b | 278 | extern int dwarf2_has_info PARAMS ((bfd * abfd)); |
c906108c SS |
279 | |
280 | extern void dwarf2_build_psymtabs PARAMS ((struct objfile *, | |
281 | struct section_offsets *, | |
282 | int)); | |
283 | /* From mdebugread.c */ | |
284 | ||
285 | /* Hack to force structures to exist before use in parameter list. */ | |
286 | struct ecoff_debug_hack | |
c5aa993b JM |
287 | { |
288 | struct ecoff_debug_swap *a; | |
289 | struct ecoff_debug_info *b; | |
290 | }; | |
c906108c SS |
291 | extern void |
292 | mdebug_build_psymtabs PARAMS ((struct objfile *, | |
293 | const struct ecoff_debug_swap *, | |
294 | struct ecoff_debug_info *, | |
295 | struct section_offsets *)); | |
296 | ||
297 | extern void | |
298 | elfmdebug_build_psymtabs PARAMS ((struct objfile *, | |
299 | const struct ecoff_debug_swap *, | |
300 | asection *, | |
301 | struct section_offsets *)); | |
302 | ||
c5aa993b | 303 | #endif /* !defined(SYMFILE_H) */ |