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