Commit | Line | Data |
---|---|---|
c906108c | 1 | /* Definitions for reading symbol files into GDB. |
3a6c3343 | 2 | |
6aba47ca | 3 | Copyright (C) 1990, 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, |
4c38e0a4 | 4 | 2000, 2001, 2002, 2003, 2004, 2007, 2008, 2009, 2010 |
0fb0cc75 | 5 | Free Software Foundation, Inc. |
c906108c | 6 | |
c5aa993b | 7 | This file is part of GDB. |
c906108c | 8 | |
c5aa993b JM |
9 | This program is free software; you can redistribute it and/or modify |
10 | it under the terms of the GNU General Public License as published by | |
a9762ec7 | 11 | the Free Software Foundation; either version 3 of the License, or |
c5aa993b | 12 | (at your option) any later version. |
c906108c | 13 | |
c5aa993b JM |
14 | This program is distributed in the hope that it will be useful, |
15 | but WITHOUT ANY WARRANTY; without even the implied warranty of | |
16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
17 | GNU General Public License for more details. | |
c906108c | 18 | |
c5aa993b | 19 | You should have received a copy of the GNU General Public License |
a9762ec7 | 20 | along with this program. If not, see <http://www.gnu.org/licenses/>. */ |
c906108c SS |
21 | |
22 | #if !defined (SYMFILE_H) | |
23 | #define SYMFILE_H | |
24 | ||
25 | /* This file requires that you first include "bfd.h". */ | |
16708cba | 26 | #include "symtab.h" |
c906108c | 27 | |
63ca651f | 28 | /* Opaque declarations. */ |
0542c86d | 29 | struct target_section; |
da3331ec | 30 | struct objfile; |
1c772458 | 31 | struct obj_section; |
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; | |
672d9c23 JK |
83 | |
84 | /* SECTINDEX must be valid for associated BFD if ADDR is not zero. */ | |
62557bbc | 85 | int sectindex; |
a39a16c4 | 86 | } other[1]; |
62557bbc KB |
87 | }; |
88 | ||
28c32713 JB |
89 | |
90 | /* A table listing the load segments in a symfile, and which segment | |
91 | each BFD section belongs to. */ | |
31d99776 DJ |
92 | struct symfile_segment_data |
93 | { | |
94 | /* How many segments are present in this file. If there are | |
95 | two, the text segment is the first one and the data segment | |
96 | is the second one. */ | |
97 | int num_segments; | |
98 | ||
99 | /* If NUM_SEGMENTS is greater than zero, the original base address | |
100 | of each segment. */ | |
101 | CORE_ADDR *segment_bases; | |
102 | ||
103 | /* If NUM_SEGMENTS is greater than zero, the memory size of each | |
104 | segment. */ | |
105 | CORE_ADDR *segment_sizes; | |
106 | ||
107 | /* If NUM_SEGMENTS is greater than zero, this is an array of entries | |
28c32713 JB |
108 | recording which segment contains each BFD section. |
109 | SEGMENT_INFO[I] is S+1 if the I'th BFD section belongs to segment | |
110 | S, or zero if it is not in any segment. */ | |
31d99776 DJ |
111 | int *segment_info; |
112 | }; | |
113 | ||
c906108c SS |
114 | /* Structure to keep track of symbol reading functions for various |
115 | object file types. */ | |
116 | ||
c5aa993b | 117 | struct sym_fns |
3a6c3343 | 118 | { |
c906108c | 119 | |
3a6c3343 AC |
120 | /* BFD flavour that we handle, or (as a special kludge, see |
121 | xcoffread.c, (enum bfd_flavour)-1 for xcoff). */ | |
c906108c | 122 | |
3a6c3343 | 123 | enum bfd_flavour sym_flavour; |
c906108c | 124 | |
3a6c3343 AC |
125 | /* Initializes anything that is global to the entire symbol table. |
126 | It is called during symbol_file_add, when we begin debugging an | |
127 | entirely new program. */ | |
c906108c | 128 | |
3a6c3343 | 129 | void (*sym_new_init) (struct objfile *); |
c906108c | 130 | |
3a6c3343 AC |
131 | /* Reads any initial information from a symbol file, and initializes |
132 | the struct sym_fns SF in preparation for sym_read(). It is | |
133 | called every time we read a symbol file for any reason. */ | |
c906108c | 134 | |
3a6c3343 | 135 | void (*sym_init) (struct objfile *); |
c906108c | 136 | |
f4352531 | 137 | /* sym_read (objfile, symfile_flags) Reads a symbol file into a psymtab |
3a6c3343 | 138 | (or possibly a symtab). OBJFILE is the objfile struct for the |
f4352531 TG |
139 | file we are reading. SYMFILE_FLAGS are the flags passed to |
140 | symbol_file_add & co. */ | |
c906108c | 141 | |
3a6c3343 | 142 | void (*sym_read) (struct objfile *, int); |
c906108c | 143 | |
3a6c3343 AC |
144 | /* Called when we are finished with an objfile. Should do all |
145 | cleanup that is specific to the object file format for the | |
146 | particular objfile. */ | |
c906108c | 147 | |
3a6c3343 | 148 | void (*sym_finish) (struct objfile *); |
c906108c | 149 | |
3a6c3343 AC |
150 | /* This function produces a file-dependent section_offsets |
151 | structure, allocated in the objfile's storage, and based on the | |
152 | parameter. The parameter is currently a CORE_ADDR (FIXME!) for | |
153 | backward compatibility with the higher levels of GDB. It should | |
154 | probably be changed to a string, where NULL means the default, | |
155 | and others are parsed in a file dependent way. */ | |
c906108c | 156 | |
3a6c3343 | 157 | void (*sym_offsets) (struct objfile *, struct section_addr_info *); |
c906108c | 158 | |
31d99776 DJ |
159 | /* This function produces a format-independent description of |
160 | the segments of ABFD. Each segment is a unit of the file | |
161 | which may be relocated independently. */ | |
162 | ||
163 | struct symfile_segment_data *(*sym_segments) (bfd *abfd); | |
164 | ||
c295b2e5 JB |
165 | /* This function should read the linetable from the objfile when |
166 | the line table cannot be read while processing the debugging | |
167 | information. */ | |
ac8035ab | 168 | |
c295b2e5 JB |
169 | void (*sym_read_linetable) (void); |
170 | ||
ac8035ab TG |
171 | /* Relocate the contents of a debug section SECTP. The |
172 | contents are stored in BUF if it is non-NULL, or returned in a | |
173 | malloc'd buffer otherwise. */ | |
174 | ||
175 | bfd_byte *(*sym_relocate) (struct objfile *, asection *sectp, bfd_byte *buf); | |
176 | ||
3a6c3343 AC |
177 | /* Finds the next struct sym_fns. They are allocated and |
178 | initialized in whatever module implements the functions pointed | |
179 | to; an initializer calls add_symtab_fns to add them to the global | |
180 | chain. */ | |
c906108c | 181 | |
3a6c3343 | 182 | struct sym_fns *next; |
c5aa993b | 183 | |
3a6c3343 | 184 | }; |
c906108c | 185 | |
567995e1 JK |
186 | extern struct section_addr_info * |
187 | build_section_addr_info_from_objfile (const struct objfile *objfile); | |
188 | ||
75242ef4 JK |
189 | extern void relative_addr_info_to_section_offsets |
190 | (struct section_offsets *section_offsets, int num_sections, | |
191 | struct section_addr_info *addrs); | |
192 | ||
193 | extern void addr_info_make_relative (struct section_addr_info *addrs, | |
194 | bfd *abfd); | |
195 | ||
c906108c SS |
196 | /* The default version of sym_fns.sym_offsets for readers that don't |
197 | do anything special. */ | |
198 | ||
570b8f7c AC |
199 | extern void default_symfile_offsets (struct objfile *objfile, |
200 | struct section_addr_info *); | |
c906108c | 201 | |
31d99776 DJ |
202 | /* The default version of sym_fns.sym_segments for readers that don't |
203 | do anything special. */ | |
204 | ||
205 | extern struct symfile_segment_data *default_symfile_segments (bfd *abfd); | |
c906108c | 206 | |
ac8035ab TG |
207 | /* The default version of sym_fns.sym_relocate for readers that don't |
208 | do anything special. */ | |
209 | ||
210 | extern bfd_byte *default_symfile_relocate (struct objfile *objfile, | |
211 | asection *sectp, bfd_byte *buf); | |
212 | ||
570b8f7c AC |
213 | extern void extend_psymbol_list (struct psymbol_allocation_list *, |
214 | struct objfile *); | |
c906108c | 215 | |
3a6c3343 | 216 | /* Add any kind of symbol to a psymbol_allocation_list. */ |
c906108c SS |
217 | |
218 | /* #include "demangle.h" */ | |
219 | ||
5c4e30ca | 220 | extern const |
04a679b8 | 221 | struct partial_symbol *add_psymbol_to_list (char *, int, int, domain_enum, |
5c4e30ca DC |
222 | enum address_class, |
223 | struct psymbol_allocation_list *, | |
224 | long, CORE_ADDR, | |
225 | enum language, struct objfile *); | |
c906108c | 226 | |
a14ed312 | 227 | extern void init_psymbol_list (struct objfile *, int); |
c906108c | 228 | |
a14ed312 | 229 | extern void sort_pst_symbols (struct partial_symtab *); |
c906108c | 230 | |
a14ed312 | 231 | extern struct symtab *allocate_symtab (char *, struct objfile *); |
c906108c | 232 | |
a14ed312 | 233 | extern void add_symtab_fns (struct sym_fns *); |
c906108c | 234 | |
7eedccfa PP |
235 | /* This enum encodes bit-flags passed as ADD_FLAGS parameter to |
236 | syms_from_objfile, symbol_file_add, etc. */ | |
237 | ||
238 | enum symfile_add_flags | |
239 | { | |
240 | /* Be chatty about what you are doing. */ | |
241 | SYMFILE_VERBOSE = 1 << 1, | |
242 | ||
243 | /* This is the main symbol file (as opposed to symbol file for dynamically | |
244 | loaded code). */ | |
245 | SYMFILE_MAINLINE = 1 << 2, | |
246 | ||
247 | /* Do not call breakpoint_re_set when adding this symbol file. */ | |
248 | SYMFILE_DEFER_BP_RESET = 1 << 3 | |
249 | }; | |
250 | ||
7e8580c1 | 251 | extern void syms_from_objfile (struct objfile *, |
3a6c3343 | 252 | struct section_addr_info *, |
7eedccfa | 253 | struct section_offsets *, int, int); |
c906108c | 254 | |
7eedccfa | 255 | extern void new_symfile_objfile (struct objfile *, int); |
c906108c | 256 | |
a14ed312 | 257 | extern struct objfile *symbol_file_add (char *, int, |
7eedccfa | 258 | struct section_addr_info *, int); |
62557bbc | 259 | |
eb4556d7 JB |
260 | extern struct objfile *symbol_file_add_from_bfd (bfd *, int, |
261 | struct section_addr_info *, | |
7eedccfa | 262 | int); |
eb4556d7 | 263 | |
15d123c9 | 264 | extern void symbol_file_add_separate (bfd *, int, struct objfile *); |
9cce227f | 265 | |
15d123c9 | 266 | extern char *find_separate_debug_file_by_debuglink (struct objfile *); |
9cce227f | 267 | |
a39a16c4 MM |
268 | /* Create a new section_addr_info, with room for NUM_SECTIONS. */ |
269 | ||
3a6c3343 AC |
270 | extern struct section_addr_info *alloc_section_addr_info (size_t |
271 | num_sections); | |
a39a16c4 | 272 | |
3a6c3343 AC |
273 | /* Build (allocate and populate) a section_addr_info struct from an |
274 | existing section table. */ | |
62557bbc | 275 | |
3a6c3343 | 276 | extern struct section_addr_info |
0542c86d | 277 | *build_section_addr_info_from_section_table (const struct target_section |
3a6c3343 | 278 | *start, |
0542c86d | 279 | const struct target_section |
3a6c3343 | 280 | *end); |
62557bbc | 281 | |
3a6c3343 AC |
282 | /* Free all memory allocated by |
283 | build_section_addr_info_from_section_table. */ | |
62557bbc | 284 | |
570b8f7c | 285 | extern void free_section_addr_info (struct section_addr_info *); |
62557bbc KB |
286 | |
287 | ||
a14ed312 KB |
288 | extern struct partial_symtab *start_psymtab_common (struct objfile *, |
289 | struct section_offsets *, | |
d85a05f0 | 290 | const char *, CORE_ADDR, |
a14ed312 KB |
291 | struct partial_symbol **, |
292 | struct partial_symbol **); | |
c906108c | 293 | |
3a6c3343 AC |
294 | /* Make a copy of the string at PTR with SIZE characters in the symbol |
295 | obstack (and add a null character at the end in the copy). Returns | |
296 | the address of the copy. */ | |
c906108c | 297 | |
63ca651f | 298 | extern char *obsavestring (const char *, int, struct obstack *); |
c906108c | 299 | |
3a6c3343 | 300 | /* Concatenate strings S1, S2 and S3; return the new string. Space is |
4a146b47 | 301 | found in the OBSTACKP */ |
c906108c | 302 | |
a14ed312 KB |
303 | extern char *obconcat (struct obstack *obstackp, const char *, const char *, |
304 | const char *); | |
c906108c SS |
305 | |
306 | /* Variables */ | |
307 | ||
b7209cb4 FF |
308 | /* If non-zero, shared library symbols will be added automatically |
309 | when the inferior is created, new libraries are loaded, or when | |
310 | attaching to the inferior. This is almost always what users will | |
311 | want to have happen; but for very large programs, the startup time | |
312 | will be excessive, and so if this is a problem, the user can clear | |
313 | this flag and then add the shared library symbols as needed. Note | |
314 | that there is a potential for confusion, since if the shared | |
315 | library symbols are not loaded, commands like "info fun" will *not* | |
3a6c3343 | 316 | report all the functions that are actually present. */ |
c906108c | 317 | |
b7209cb4 | 318 | extern int auto_solib_add; |
c906108c | 319 | |
b7209cb4 FF |
320 | /* For systems that support it, a threshold size in megabytes. If |
321 | automatically adding a new library's symbol table to those already | |
322 | known to the debugger would cause the total shared library symbol | |
323 | size to exceed this threshhold, then the shlib's symbols are not | |
324 | added. The threshold is ignored if the user explicitly asks for a | |
3a6c3343 | 325 | shlib to be added, such as when using the "sharedlibrary" command. */ |
c906108c | 326 | |
b7209cb4 | 327 | extern int auto_solib_limit; |
c906108c SS |
328 | |
329 | /* From symfile.c */ | |
330 | ||
8b60591b JB |
331 | extern void set_initial_language (void); |
332 | ||
d85a05f0 DJ |
333 | extern struct partial_symtab *allocate_psymtab (const char *, |
334 | struct objfile *); | |
c906108c | 335 | |
a14ed312 | 336 | extern void discard_psymtab (struct partial_symtab *); |
c906108c | 337 | |
4efb68b1 | 338 | extern void find_lowest_section (bfd *, asection *, void *); |
c906108c | 339 | |
a14ed312 | 340 | extern bfd *symfile_bfd_open (char *); |
c906108c | 341 | |
874f5765 TG |
342 | extern bfd *bfd_open_maybe_remote (const char *); |
343 | ||
e2f6d8e5 JB |
344 | extern int get_section_index (struct objfile *, char *); |
345 | ||
c906108c | 346 | /* Utility functions for overlay sections: */ |
3a6c3343 AC |
347 | extern enum overlay_debugging_state |
348 | { | |
349 | ovly_off, | |
350 | ovly_on, | |
d874f1e2 MS |
351 | ovly_auto |
352 | } overlay_debugging; | |
c906108c SS |
353 | extern int overlay_cache_invalid; |
354 | ||
3a6c3343 | 355 | /* Return the "mapped" overlay section containing the PC. */ |
714835d5 | 356 | extern struct obj_section *find_pc_mapped_section (CORE_ADDR); |
c906108c | 357 | |
3a6c3343 AC |
358 | /* Return any overlay section containing the PC (even in its LMA |
359 | region). */ | |
714835d5 | 360 | extern struct obj_section *find_pc_overlay (CORE_ADDR); |
c906108c | 361 | |
3a6c3343 | 362 | /* Return true if the section is an overlay. */ |
714835d5 | 363 | extern int section_is_overlay (struct obj_section *); |
c906108c | 364 | |
3a6c3343 | 365 | /* Return true if the overlay section is currently "mapped". */ |
714835d5 | 366 | extern int section_is_mapped (struct obj_section *); |
c906108c | 367 | |
3a6c3343 | 368 | /* Return true if pc belongs to section's VMA. */ |
714835d5 | 369 | extern CORE_ADDR pc_in_mapped_range (CORE_ADDR, struct obj_section *); |
c906108c | 370 | |
3a6c3343 | 371 | /* Return true if pc belongs to section's LMA. */ |
714835d5 | 372 | extern CORE_ADDR pc_in_unmapped_range (CORE_ADDR, struct obj_section *); |
c906108c | 373 | |
3a6c3343 | 374 | /* Map an address from a section's LMA to its VMA. */ |
714835d5 | 375 | extern CORE_ADDR overlay_mapped_address (CORE_ADDR, struct obj_section *); |
c906108c | 376 | |
3a6c3343 | 377 | /* Map an address from a section's VMA to its LMA. */ |
714835d5 | 378 | extern CORE_ADDR overlay_unmapped_address (CORE_ADDR, struct obj_section *); |
c906108c | 379 | |
3a6c3343 | 380 | /* Convert an address in an overlay section (force into VMA range). */ |
714835d5 | 381 | extern CORE_ADDR symbol_overlayed_address (CORE_ADDR, struct obj_section *); |
c906108c | 382 | |
3a6c3343 | 383 | /* Load symbols from a file. */ |
1adeb98a FN |
384 | extern void symbol_file_add_main (char *args, int from_tty); |
385 | ||
3a6c3343 | 386 | /* Clear GDB symbol tables. */ |
1adeb98a FN |
387 | extern void symbol_file_clear (int from_tty); |
388 | ||
1c772458 UW |
389 | /* Default overlay update function. */ |
390 | extern void simple_overlay_update (struct obj_section *); | |
391 | ||
ac8035ab TG |
392 | extern bfd_byte *symfile_relocate_debug_section (struct objfile *, asection *, |
393 | bfd_byte *); | |
086df311 | 394 | |
31d99776 DJ |
395 | extern int symfile_map_offsets_to_segments (bfd *, |
396 | struct symfile_segment_data *, | |
397 | struct section_offsets *, | |
398 | int, const CORE_ADDR *); | |
399 | struct symfile_segment_data *get_symfile_segment_data (bfd *abfd); | |
400 | void free_symfile_segment_data (struct symfile_segment_data *data); | |
401 | ||
c906108c SS |
402 | /* From dwarf2read.c */ |
403 | ||
c5edf76a | 404 | extern int dwarf2_has_info (struct objfile *); |
c906108c | 405 | |
f29dff0a | 406 | extern void dwarf2_build_psymtabs (struct objfile *); |
b6af0555 | 407 | extern void dwarf2_build_frame_info (struct objfile *); |
d4f3574e | 408 | |
fe3e1990 DJ |
409 | void dwarf2_free_objfile (struct objfile *); |
410 | ||
c906108c SS |
411 | /* From mdebugread.c */ |
412 | ||
413 | /* Hack to force structures to exist before use in parameter list. */ | |
414 | struct ecoff_debug_hack | |
3a6c3343 AC |
415 | { |
416 | struct ecoff_debug_swap *a; | |
417 | struct ecoff_debug_info *b; | |
418 | }; | |
419 | ||
420 | extern void mdebug_build_psymtabs (struct objfile *, | |
421 | const struct ecoff_debug_swap *, | |
422 | struct ecoff_debug_info *); | |
423 | ||
424 | extern void elfmdebug_build_psymtabs (struct objfile *, | |
425 | const struct ecoff_debug_swap *, | |
426 | asection *); | |
c906108c | 427 | |
c5aa993b | 428 | #endif /* !defined(SYMFILE_H) */ |