1 /* Definitions for reading symbol files into GDB.
3 Copyright (C) 1990, 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
4 2000, 2001, 2002, 2003, 2004, 2007, 2008, 2009, 2010
5 Free Software Foundation, Inc.
7 This file is part of GDB.
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
11 the Free Software Foundation; either version 3 of the License, or
12 (at your option) any later version.
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.
19 You should have received a copy of the GNU General Public License
20 along with this program. If not, see <http://www.gnu.org/licenses/>. */
22 #if !defined (SYMFILE_H)
25 /* This file requires that you first include "bfd.h". */
28 /* Opaque declarations. */
29 struct target_section
;
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. */
43 struct psymbol_allocation_list
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. */
50 struct partial_symbol
**list
;
52 /* Pointer to next available slot in which to store a pointer to a
55 struct partial_symbol
**next
;
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
66 /* Define an array of addresses to accommodate non-contiguous dynamic
67 loading of modules. This is for use when entering commands, so we
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 (). */
73 struct section_addr_info
75 /* The number of sections for which address information is
78 /* Sections whose names are file format dependent. */
88 /* A table listing the load segments in a symfile, and which segment
89 each BFD section belongs to. */
90 struct symfile_segment_data
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
97 /* If NUM_SEGMENTS is greater than zero, the original base address
99 CORE_ADDR
*segment_bases
;
101 /* If NUM_SEGMENTS is greater than zero, the memory size of each
103 CORE_ADDR
*segment_sizes
;
105 /* If NUM_SEGMENTS is greater than zero, this is an array of entries
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. */
112 /* Structure to keep track of symbol reading functions for various
113 object file types. */
118 /* BFD flavour that we handle, or (as a special kludge, see
119 xcoffread.c, (enum bfd_flavour)-1 for xcoff). */
121 enum bfd_flavour sym_flavour
;
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. */
127 void (*sym_new_init
) (struct objfile
*);
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. */
133 void (*sym_init
) (struct objfile
*);
135 /* sym_read (objfile, symfile_flags) Reads a symbol file into a psymtab
136 (or possibly a symtab). OBJFILE is the objfile struct for the
137 file we are reading. SYMFILE_FLAGS are the flags passed to
138 symbol_file_add & co. */
140 void (*sym_read
) (struct objfile
*, int);
142 /* Called when we are finished with an objfile. Should do all
143 cleanup that is specific to the object file format for the
144 particular objfile. */
146 void (*sym_finish
) (struct objfile
*);
148 /* This function produces a file-dependent section_offsets
149 structure, allocated in the objfile's storage, and based on the
150 parameter. The parameter is currently a CORE_ADDR (FIXME!) for
151 backward compatibility with the higher levels of GDB. It should
152 probably be changed to a string, where NULL means the default,
153 and others are parsed in a file dependent way. */
155 void (*sym_offsets
) (struct objfile
*, struct section_addr_info
*);
157 /* This function produces a format-independent description of
158 the segments of ABFD. Each segment is a unit of the file
159 which may be relocated independently. */
161 struct symfile_segment_data
*(*sym_segments
) (bfd
*abfd
);
163 /* This function should read the linetable from the objfile when
164 the line table cannot be read while processing the debugging
166 void (*sym_read_linetable
) (void);
168 /* Finds the next struct sym_fns. They are allocated and
169 initialized in whatever module implements the functions pointed
170 to; an initializer calls add_symtab_fns to add them to the global
173 struct sym_fns
*next
;
177 extern void relative_addr_info_to_section_offsets
178 (struct section_offsets
*section_offsets
, int num_sections
,
179 struct section_addr_info
*addrs
);
181 extern void addr_info_make_relative (struct section_addr_info
*addrs
,
184 /* The default version of sym_fns.sym_offsets for readers that don't
185 do anything special. */
187 extern void default_symfile_offsets (struct objfile
*objfile
,
188 struct section_addr_info
*);
190 /* The default version of sym_fns.sym_segments for readers that don't
191 do anything special. */
193 extern struct symfile_segment_data
*default_symfile_segments (bfd
*abfd
);
195 extern void extend_psymbol_list (struct psymbol_allocation_list
*,
198 /* Add any kind of symbol to a psymbol_allocation_list. */
200 /* #include "demangle.h" */
203 struct partial_symbol
*add_psymbol_to_list (char *, int, int, domain_enum
,
205 struct psymbol_allocation_list
*,
207 enum language
, struct objfile
*);
209 extern void init_psymbol_list (struct objfile
*, int);
211 extern void sort_pst_symbols (struct partial_symtab
*);
213 extern struct symtab
*allocate_symtab (char *, struct objfile
*);
215 extern int free_named_symtabs (char *);
217 extern void add_symtab_fns (struct sym_fns
*);
219 /* This enum encodes bit-flags passed as ADD_FLAGS parameter to
220 syms_from_objfile, symbol_file_add, etc. */
222 enum symfile_add_flags
224 /* Be chatty about what you are doing. */
225 SYMFILE_VERBOSE
= 1 << 1,
227 /* This is the main symbol file (as opposed to symbol file for dynamically
229 SYMFILE_MAINLINE
= 1 << 2,
231 /* Do not call breakpoint_re_set when adding this symbol file. */
232 SYMFILE_DEFER_BP_RESET
= 1 << 3
235 extern void syms_from_objfile (struct objfile
*,
236 struct section_addr_info
*,
237 struct section_offsets
*, int, int);
239 extern void new_symfile_objfile (struct objfile
*, int);
241 extern struct objfile
*symbol_file_add (char *, int,
242 struct section_addr_info
*, int);
244 extern struct objfile
*symbol_file_add_from_bfd (bfd
*, int,
245 struct section_addr_info
*,
248 extern void symbol_file_add_separate (bfd
*, int, struct objfile
*);
250 extern char *find_separate_debug_file_by_debuglink (struct objfile
*);
252 /* Create a new section_addr_info, with room for NUM_SECTIONS. */
254 extern struct section_addr_info
*alloc_section_addr_info (size_t
257 /* Return a freshly allocated copy of ADDRS. The section names, if
258 any, are also freshly allocated copies of those in ADDRS. */
259 extern struct section_addr_info
*(copy_section_addr_info
260 (struct section_addr_info
*addrs
));
262 /* Build (allocate and populate) a section_addr_info struct from an
263 existing section table. */
265 extern struct section_addr_info
266 *build_section_addr_info_from_section_table (const struct target_section
268 const struct target_section
271 /* Free all memory allocated by
272 build_section_addr_info_from_section_table. */
274 extern void free_section_addr_info (struct section_addr_info
*);
277 extern struct partial_symtab
*start_psymtab_common (struct objfile
*,
278 struct section_offsets
*,
279 const char *, CORE_ADDR
,
280 struct partial_symbol
**,
281 struct partial_symbol
**);
283 /* Make a copy of the string at PTR with SIZE characters in the symbol
284 obstack (and add a null character at the end in the copy). Returns
285 the address of the copy. */
287 extern char *obsavestring (const char *, int, struct obstack
*);
289 /* Concatenate strings S1, S2 and S3; return the new string. Space is
290 found in the OBSTACKP */
292 extern char *obconcat (struct obstack
*obstackp
, const char *, const char *,
297 /* If non-zero, shared library symbols will be added automatically
298 when the inferior is created, new libraries are loaded, or when
299 attaching to the inferior. This is almost always what users will
300 want to have happen; but for very large programs, the startup time
301 will be excessive, and so if this is a problem, the user can clear
302 this flag and then add the shared library symbols as needed. Note
303 that there is a potential for confusion, since if the shared
304 library symbols are not loaded, commands like "info fun" will *not*
305 report all the functions that are actually present. */
307 extern int auto_solib_add
;
309 /* For systems that support it, a threshold size in megabytes. If
310 automatically adding a new library's symbol table to those already
311 known to the debugger would cause the total shared library symbol
312 size to exceed this threshhold, then the shlib's symbols are not
313 added. The threshold is ignored if the user explicitly asks for a
314 shlib to be added, such as when using the "sharedlibrary" command. */
316 extern int auto_solib_limit
;
320 extern void set_initial_language (void);
322 extern struct partial_symtab
*allocate_psymtab (const char *,
325 extern void discard_psymtab (struct partial_symtab
*);
327 extern void find_lowest_section (bfd
*, asection
*, void *);
329 extern bfd
*symfile_bfd_open (char *);
331 extern bfd
*bfd_open_maybe_remote (const char *);
333 extern int get_section_index (struct objfile
*, char *);
335 /* Utility functions for overlay sections: */
336 extern enum overlay_debugging_state
342 extern int overlay_cache_invalid
;
344 /* Return the "mapped" overlay section containing the PC. */
345 extern struct obj_section
*find_pc_mapped_section (CORE_ADDR
);
347 /* Return any overlay section containing the PC (even in its LMA
349 extern struct obj_section
*find_pc_overlay (CORE_ADDR
);
351 /* Return true if the section is an overlay. */
352 extern int section_is_overlay (struct obj_section
*);
354 /* Return true if the overlay section is currently "mapped". */
355 extern int section_is_mapped (struct obj_section
*);
357 /* Return true if pc belongs to section's VMA. */
358 extern CORE_ADDR
pc_in_mapped_range (CORE_ADDR
, struct obj_section
*);
360 /* Return true if pc belongs to section's LMA. */
361 extern CORE_ADDR
pc_in_unmapped_range (CORE_ADDR
, struct obj_section
*);
363 /* Map an address from a section's LMA to its VMA. */
364 extern CORE_ADDR
overlay_mapped_address (CORE_ADDR
, struct obj_section
*);
366 /* Map an address from a section's VMA to its LMA. */
367 extern CORE_ADDR
overlay_unmapped_address (CORE_ADDR
, struct obj_section
*);
369 /* Convert an address in an overlay section (force into VMA range). */
370 extern CORE_ADDR
symbol_overlayed_address (CORE_ADDR
, struct obj_section
*);
372 /* Load symbols from a file. */
373 extern void symbol_file_add_main (char *args
, int from_tty
);
375 /* Clear GDB symbol tables. */
376 extern void symbol_file_clear (int from_tty
);
378 /* Default overlay update function. */
379 extern void simple_overlay_update (struct obj_section
*);
381 extern bfd_byte
*symfile_relocate_debug_section (bfd
*abfd
, asection
*sectp
,
384 extern int symfile_map_offsets_to_segments (bfd
*,
385 struct symfile_segment_data
*,
386 struct section_offsets
*,
387 int, const CORE_ADDR
*);
388 struct symfile_segment_data
*get_symfile_segment_data (bfd
*abfd
);
389 void free_symfile_segment_data (struct symfile_segment_data
*data
);
391 /* From dwarf2read.c */
393 extern int dwarf2_has_info (struct objfile
*);
395 extern void dwarf2_build_psymtabs (struct objfile
*);
396 extern void dwarf2_build_frame_info (struct objfile
*);
398 void dwarf2_free_objfile (struct objfile
*);
400 /* From mdebugread.c */
402 /* Hack to force structures to exist before use in parameter list. */
403 struct ecoff_debug_hack
405 struct ecoff_debug_swap
*a
;
406 struct ecoff_debug_info
*b
;
409 extern void mdebug_build_psymtabs (struct objfile
*,
410 const struct ecoff_debug_swap
*,
411 struct ecoff_debug_info
*);
413 extern void elfmdebug_build_psymtabs (struct objfile
*,
414 const struct ecoff_debug_swap
*,
417 #endif /* !defined(SYMFILE_H) */