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 | |
a9762ec7 | 10 | the Free Software Foundation; either version 3 of the License, or |
c5aa993b | 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 | 18 | You should have received a copy of the GNU General Public License |
a9762ec7 | 19 | along with this program. If not, see <http://www.gnu.org/licenses/>. */ |
c906108c SS |
20 | |
21 | #if !defined (SYMFILE_H) | |
22 | #define SYMFILE_H | |
23 | ||
24 | /* This file requires that you first include "bfd.h". */ | |
16708cba | 25 | #include "symtab.h" |
c906108c | 26 | |
63ca651f | 27 | /* Opaque declarations. */ |
3a6c3343 | 28 | struct section_table; |
da3331ec | 29 | struct objfile; |
1c772458 | 30 | struct obj_section; |
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 | ||
31d99776 DJ |
86 | struct symfile_segment_data |
87 | { | |
88 | /* How many segments are present in this file. If there are | |
89 | two, the text segment is the first one and the data segment | |
90 | is the second one. */ | |
91 | int num_segments; | |
92 | ||
93 | /* If NUM_SEGMENTS is greater than zero, the original base address | |
94 | of each segment. */ | |
95 | CORE_ADDR *segment_bases; | |
96 | ||
97 | /* If NUM_SEGMENTS is greater than zero, the memory size of each | |
98 | segment. */ | |
99 | CORE_ADDR *segment_sizes; | |
100 | ||
101 | /* If NUM_SEGMENTS is greater than zero, this is an array of entries | |
102 | recording which segment contains each BFD section. It is | |
103 | ordered by section index. A zero means that the section is not | |
104 | in any segment. */ | |
105 | int *segment_info; | |
106 | }; | |
107 | ||
c906108c SS |
108 | /* Structure to keep track of symbol reading functions for various |
109 | object file types. */ | |
110 | ||
c5aa993b | 111 | struct sym_fns |
3a6c3343 | 112 | { |
c906108c | 113 | |
3a6c3343 AC |
114 | /* BFD flavour that we handle, or (as a special kludge, see |
115 | xcoffread.c, (enum bfd_flavour)-1 for xcoff). */ | |
c906108c | 116 | |
3a6c3343 | 117 | enum bfd_flavour sym_flavour; |
c906108c | 118 | |
3a6c3343 AC |
119 | /* Initializes anything that is global to the entire symbol table. |
120 | It is called during symbol_file_add, when we begin debugging an | |
121 | entirely new program. */ | |
c906108c | 122 | |
3a6c3343 | 123 | void (*sym_new_init) (struct objfile *); |
c906108c | 124 | |
3a6c3343 AC |
125 | /* Reads any initial information from a symbol file, and initializes |
126 | the struct sym_fns SF in preparation for sym_read(). It is | |
127 | called every time we read a symbol file for any reason. */ | |
c906108c | 128 | |
3a6c3343 | 129 | void (*sym_init) (struct objfile *); |
c906108c | 130 | |
3a6c3343 AC |
131 | /* sym_read (objfile, mainline) Reads a symbol file into a psymtab |
132 | (or possibly a symtab). OBJFILE is the objfile struct for the | |
133 | file we are reading. MAINLINE is 1 if this is the main symbol | |
134 | table being read, and 0 if a secondary symbol file (e.g. shared | |
135 | library or dynamically loaded file) is being read. */ | |
c906108c | 136 | |
3a6c3343 | 137 | void (*sym_read) (struct objfile *, int); |
c906108c | 138 | |
3a6c3343 AC |
139 | /* Called when we are finished with an objfile. Should do all |
140 | cleanup that is specific to the object file format for the | |
141 | particular objfile. */ | |
c906108c | 142 | |
3a6c3343 | 143 | void (*sym_finish) (struct objfile *); |
c906108c | 144 | |
3a6c3343 AC |
145 | /* This function produces a file-dependent section_offsets |
146 | structure, allocated in the objfile's storage, and based on the | |
147 | parameter. The parameter is currently a CORE_ADDR (FIXME!) for | |
148 | backward compatibility with the higher levels of GDB. It should | |
149 | probably be changed to a string, where NULL means the default, | |
150 | and others are parsed in a file dependent way. */ | |
c906108c | 151 | |
3a6c3343 | 152 | void (*sym_offsets) (struct objfile *, struct section_addr_info *); |
c906108c | 153 | |
31d99776 DJ |
154 | /* This function produces a format-independent description of |
155 | the segments of ABFD. Each segment is a unit of the file | |
156 | which may be relocated independently. */ | |
157 | ||
158 | struct symfile_segment_data *(*sym_segments) (bfd *abfd); | |
159 | ||
c295b2e5 JB |
160 | /* This function should read the linetable from the objfile when |
161 | the line table cannot be read while processing the debugging | |
162 | information. */ | |
163 | void (*sym_read_linetable) (void); | |
164 | ||
3a6c3343 AC |
165 | /* Finds the next struct sym_fns. They are allocated and |
166 | initialized in whatever module implements the functions pointed | |
167 | to; an initializer calls add_symtab_fns to add them to the global | |
168 | chain. */ | |
c906108c | 169 | |
3a6c3343 | 170 | struct sym_fns *next; |
c5aa993b | 171 | |
3a6c3343 | 172 | }; |
c906108c SS |
173 | |
174 | /* The default version of sym_fns.sym_offsets for readers that don't | |
175 | do anything special. */ | |
176 | ||
570b8f7c AC |
177 | extern void default_symfile_offsets (struct objfile *objfile, |
178 | struct section_addr_info *); | |
c906108c | 179 | |
31d99776 DJ |
180 | /* The default version of sym_fns.sym_segments for readers that don't |
181 | do anything special. */ | |
182 | ||
183 | extern struct symfile_segment_data *default_symfile_segments (bfd *abfd); | |
c906108c | 184 | |
570b8f7c AC |
185 | extern void extend_psymbol_list (struct psymbol_allocation_list *, |
186 | struct objfile *); | |
c906108c | 187 | |
3a6c3343 | 188 | /* Add any kind of symbol to a psymbol_allocation_list. */ |
c906108c SS |
189 | |
190 | /* #include "demangle.h" */ | |
191 | ||
5c4e30ca DC |
192 | extern const |
193 | struct partial_symbol *add_psymbol_to_list (char *, int, domain_enum, | |
194 | enum address_class, | |
195 | struct psymbol_allocation_list *, | |
196 | long, CORE_ADDR, | |
197 | enum language, struct objfile *); | |
c906108c | 198 | |
a14ed312 | 199 | extern void init_psymbol_list (struct objfile *, int); |
c906108c | 200 | |
a14ed312 | 201 | extern void sort_pst_symbols (struct partial_symtab *); |
c906108c | 202 | |
a14ed312 | 203 | extern struct symtab *allocate_symtab (char *, struct objfile *); |
c906108c | 204 | |
a14ed312 | 205 | extern int free_named_symtabs (char *); |
c906108c | 206 | |
a14ed312 | 207 | extern void fill_in_vptr_fieldno (struct type *); |
c906108c | 208 | |
a14ed312 | 209 | extern void add_symtab_fns (struct sym_fns *); |
c906108c | 210 | |
7e8580c1 | 211 | extern void syms_from_objfile (struct objfile *, |
3a6c3343 AC |
212 | struct section_addr_info *, |
213 | struct section_offsets *, int, int, int); | |
c906108c | 214 | |
a14ed312 | 215 | extern void new_symfile_objfile (struct objfile *, int, int); |
c906108c | 216 | |
a14ed312 KB |
217 | extern struct objfile *symbol_file_add (char *, int, |
218 | struct section_addr_info *, int, int); | |
62557bbc | 219 | |
eb4556d7 JB |
220 | extern struct objfile *symbol_file_add_from_bfd (bfd *, int, |
221 | struct section_addr_info *, | |
222 | int, int); | |
223 | ||
a39a16c4 MM |
224 | /* Create a new section_addr_info, with room for NUM_SECTIONS. */ |
225 | ||
3a6c3343 AC |
226 | extern struct section_addr_info *alloc_section_addr_info (size_t |
227 | num_sections); | |
a39a16c4 | 228 | |
7b90c3f9 JB |
229 | /* Return a freshly allocated copy of ADDRS. The section names, if |
230 | any, are also freshly allocated copies of those in ADDRS. */ | |
231 | extern struct section_addr_info *(copy_section_addr_info | |
232 | (struct section_addr_info *addrs)); | |
233 | ||
3a6c3343 AC |
234 | /* Build (allocate and populate) a section_addr_info struct from an |
235 | existing section table. */ | |
62557bbc | 236 | |
3a6c3343 AC |
237 | extern struct section_addr_info |
238 | *build_section_addr_info_from_section_table (const struct section_table | |
239 | *start, | |
240 | const struct section_table | |
241 | *end); | |
62557bbc | 242 | |
3a6c3343 AC |
243 | /* Free all memory allocated by |
244 | build_section_addr_info_from_section_table. */ | |
62557bbc | 245 | |
570b8f7c | 246 | extern void free_section_addr_info (struct section_addr_info *); |
62557bbc KB |
247 | |
248 | ||
a14ed312 KB |
249 | extern struct partial_symtab *start_psymtab_common (struct objfile *, |
250 | struct section_offsets *, | |
251 | char *, CORE_ADDR, | |
252 | struct partial_symbol **, | |
253 | struct partial_symbol **); | |
c906108c | 254 | |
3a6c3343 AC |
255 | /* Make a copy of the string at PTR with SIZE characters in the symbol |
256 | obstack (and add a null character at the end in the copy). Returns | |
257 | the address of the copy. */ | |
c906108c | 258 | |
63ca651f | 259 | extern char *obsavestring (const char *, int, struct obstack *); |
c906108c | 260 | |
3a6c3343 | 261 | /* Concatenate strings S1, S2 and S3; return the new string. Space is |
4a146b47 | 262 | found in the OBSTACKP */ |
c906108c | 263 | |
a14ed312 KB |
264 | extern char *obconcat (struct obstack *obstackp, const char *, const char *, |
265 | const char *); | |
c906108c SS |
266 | |
267 | /* Variables */ | |
268 | ||
b7209cb4 FF |
269 | /* If non-zero, shared library symbols will be added automatically |
270 | when the inferior is created, new libraries are loaded, or when | |
271 | attaching to the inferior. This is almost always what users will | |
272 | want to have happen; but for very large programs, the startup time | |
273 | will be excessive, and so if this is a problem, the user can clear | |
274 | this flag and then add the shared library symbols as needed. Note | |
275 | that there is a potential for confusion, since if the shared | |
276 | library symbols are not loaded, commands like "info fun" will *not* | |
3a6c3343 | 277 | report all the functions that are actually present. */ |
c906108c | 278 | |
b7209cb4 | 279 | extern int auto_solib_add; |
c906108c | 280 | |
b7209cb4 FF |
281 | /* For systems that support it, a threshold size in megabytes. If |
282 | automatically adding a new library's symbol table to those already | |
283 | known to the debugger would cause the total shared library symbol | |
284 | size to exceed this threshhold, then the shlib's symbols are not | |
285 | added. The threshold is ignored if the user explicitly asks for a | |
3a6c3343 | 286 | shlib to be added, such as when using the "sharedlibrary" command. */ |
c906108c | 287 | |
b7209cb4 | 288 | extern int auto_solib_limit; |
c906108c SS |
289 | |
290 | /* From symfile.c */ | |
291 | ||
a14ed312 | 292 | extern struct partial_symtab *allocate_psymtab (char *, struct objfile *); |
c906108c | 293 | |
a14ed312 | 294 | extern void discard_psymtab (struct partial_symtab *); |
c906108c | 295 | |
4efb68b1 | 296 | extern void find_lowest_section (bfd *, asection *, void *); |
c906108c | 297 | |
a14ed312 | 298 | extern bfd *symfile_bfd_open (char *); |
c906108c | 299 | |
e2f6d8e5 JB |
300 | extern int get_section_index (struct objfile *, char *); |
301 | ||
c906108c | 302 | /* Utility functions for overlay sections: */ |
3a6c3343 AC |
303 | extern enum overlay_debugging_state |
304 | { | |
305 | ovly_off, | |
306 | ovly_on, | |
d874f1e2 MS |
307 | ovly_auto |
308 | } overlay_debugging; | |
c906108c SS |
309 | extern int overlay_cache_invalid; |
310 | ||
3a6c3343 | 311 | /* Return the "mapped" overlay section containing the PC. */ |
a14ed312 | 312 | extern asection *find_pc_mapped_section (CORE_ADDR); |
c906108c | 313 | |
3a6c3343 AC |
314 | /* Return any overlay section containing the PC (even in its LMA |
315 | region). */ | |
a14ed312 | 316 | extern asection *find_pc_overlay (CORE_ADDR); |
c906108c | 317 | |
3a6c3343 | 318 | /* Return true if the section is an overlay. */ |
a14ed312 | 319 | extern int section_is_overlay (asection *); |
c906108c | 320 | |
3a6c3343 | 321 | /* Return true if the overlay section is currently "mapped". */ |
a14ed312 | 322 | extern int section_is_mapped (asection *); |
c906108c | 323 | |
3a6c3343 | 324 | /* Return true if pc belongs to section's VMA. */ |
a14ed312 | 325 | extern CORE_ADDR pc_in_mapped_range (CORE_ADDR, asection *); |
c906108c | 326 | |
3a6c3343 | 327 | /* Return true if pc belongs to section's LMA. */ |
a14ed312 | 328 | extern CORE_ADDR pc_in_unmapped_range (CORE_ADDR, asection *); |
c906108c | 329 | |
3a6c3343 | 330 | /* Map an address from a section's LMA to its VMA. */ |
a14ed312 | 331 | extern CORE_ADDR overlay_mapped_address (CORE_ADDR, asection *); |
c906108c | 332 | |
3a6c3343 | 333 | /* Map an address from a section's VMA to its LMA. */ |
a14ed312 | 334 | extern CORE_ADDR overlay_unmapped_address (CORE_ADDR, asection *); |
c906108c | 335 | |
3a6c3343 | 336 | /* Convert an address in an overlay section (force into VMA range). */ |
a14ed312 | 337 | extern CORE_ADDR symbol_overlayed_address (CORE_ADDR, asection *); |
c906108c | 338 | |
3a6c3343 | 339 | /* Load symbols from a file. */ |
1adeb98a FN |
340 | extern void symbol_file_add_main (char *args, int from_tty); |
341 | ||
3a6c3343 | 342 | /* Clear GDB symbol tables. */ |
1adeb98a FN |
343 | extern void symbol_file_clear (int from_tty); |
344 | ||
1c772458 UW |
345 | /* Default overlay update function. */ |
346 | extern void simple_overlay_update (struct obj_section *); | |
347 | ||
086df311 | 348 | extern bfd_byte *symfile_relocate_debug_section (bfd *abfd, asection *sectp, |
3a6c3343 | 349 | bfd_byte * buf); |
086df311 | 350 | |
31d99776 DJ |
351 | extern int symfile_map_offsets_to_segments (bfd *, |
352 | struct symfile_segment_data *, | |
353 | struct section_offsets *, | |
354 | int, const CORE_ADDR *); | |
355 | struct symfile_segment_data *get_symfile_segment_data (bfd *abfd); | |
356 | void free_symfile_segment_data (struct symfile_segment_data *data); | |
357 | ||
c906108c SS |
358 | /* From dwarf2read.c */ |
359 | ||
c5edf76a | 360 | extern int dwarf2_has_info (struct objfile *); |
c906108c | 361 | |
a14ed312 | 362 | extern void dwarf2_build_psymtabs (struct objfile *, int); |
b6af0555 | 363 | extern void dwarf2_build_frame_info (struct objfile *); |
d4f3574e | 364 | |
c906108c SS |
365 | /* From mdebugread.c */ |
366 | ||
367 | /* Hack to force structures to exist before use in parameter list. */ | |
368 | struct ecoff_debug_hack | |
3a6c3343 AC |
369 | { |
370 | struct ecoff_debug_swap *a; | |
371 | struct ecoff_debug_info *b; | |
372 | }; | |
373 | ||
374 | extern void mdebug_build_psymtabs (struct objfile *, | |
375 | const struct ecoff_debug_swap *, | |
376 | struct ecoff_debug_info *); | |
377 | ||
378 | extern void elfmdebug_build_psymtabs (struct objfile *, | |
379 | const struct ecoff_debug_swap *, | |
380 | asection *); | |
c906108c | 381 | |
c5aa993b | 382 | #endif /* !defined(SYMFILE_H) */ |