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