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