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