1 /* Definitions for reading symbol files into GDB.
2 Copyright 1990, 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
4 Free Software Foundation, Inc.
6 This file is part of GDB.
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.
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.
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
20 Foundation, Inc., 59 Temple Place - Suite 330,
21 Boston, MA 02111-1307, USA. */
23 #if !defined (SYMFILE_H)
26 /* This file requires that you first include "bfd.h". */
28 /* Opaque declarations. */
32 /* Partial symbols are stored in the psymbol_cache and pointers to them
33 are kept in a dynamically grown array that is obtained from malloc and
34 grown as necessary via realloc. Each objfile typically has two of these,
35 one for global symbols and one for static symbols. Although this adds
36 a level of indirection for storing or accessing the partial symbols,
37 it allows us to throw away duplicate psymbols and set all pointers
38 to the single saved instance. */
40 struct psymbol_allocation_list
43 /* Pointer to beginning of dynamically allocated array of pointers to
44 partial symbols. The array is dynamically expanded as necessary to
45 accommodate more pointers. */
47 struct partial_symbol **list;
49 /* Pointer to next available slot in which to store a pointer to a partial
52 struct partial_symbol **next;
54 /* Number of allocated pointer slots in current dynamic array (not the
55 number of bytes of storage). The "next" pointer will always point
56 somewhere between list[0] and list[size], and when at list[size] the
57 array will be expanded on the next attempt to store a pointer. */
62 /* Define an array of addresses to accommodate non-contiguous dynamic
63 loading of modules. This is for use when entering commands, so we
64 can keep track of the section names until we read the file and
65 can map them to bfd sections. This structure is also used by
66 solib.c to communicate the section addresses in shared objects to
67 symbol_file_add (). */
69 #define MAX_SECTIONS 64
70 struct section_addr_info
72 /* Sections whose names are file format dependent. */
78 } other[MAX_SECTIONS];
81 /* Structure to keep track of symbol reading functions for various
87 /* BFD flavour that we handle, or (as a special kludge, see xcoffread.c,
88 (enum bfd_flavour)-1 for xcoff). */
90 enum bfd_flavour sym_flavour;
92 /* Initializes anything that is global to the entire symbol table. It is
93 called during symbol_file_add, when we begin debugging an entirely new
96 void (*sym_new_init) (struct objfile *);
98 /* Reads any initial information from a symbol file, and initializes the
99 struct sym_fns SF in preparation for sym_read(). It is called every
100 time we read a symbol file for any reason. */
102 void (*sym_init) (struct objfile *);
104 /* sym_read (objfile, mainline)
105 Reads a symbol file into a psymtab (or possibly a symtab).
106 OBJFILE is the objfile struct for the file we are reading.
107 MAINLINE is 1 if this is the
108 main symbol table being read, and 0 if a secondary
109 symbol file (e.g. shared library or dynamically loaded file)
112 void (*sym_read) (struct objfile *, int);
114 /* Called when we are finished with an objfile. Should do all cleanup
115 that is specific to the object file format for the particular objfile. */
117 void (*sym_finish) (struct objfile *);
119 /* This function produces a file-dependent section_offsets structure,
120 allocated in the objfile's storage, and based on the parameter.
121 The parameter is currently a CORE_ADDR (FIXME!) for backward compatibility
122 with the higher levels of GDB. It should probably be changed to
123 a string, where NULL means the default, and others are parsed in a file
126 void (*sym_offsets) (struct objfile *, struct section_addr_info *);
128 /* Finds the next struct sym_fns. They are allocated and initialized
129 in whatever module implements the functions pointed to; an
130 initializer calls add_symtab_fns to add them to the global chain. */
132 struct sym_fns *next;
136 /* The default version of sym_fns.sym_offsets for readers that don't
137 do anything special. */
140 default_symfile_offsets (struct objfile *objfile, struct section_addr_info *);
144 extend_psymbol_list (struct psymbol_allocation_list *, struct objfile *);
146 /* Add any kind of symbol to a psymbol_allocation_list. */
148 /* #include "demangle.h" */
151 add_psymbol_to_list (char *, int, namespace_enum, enum address_class,
152 struct psymbol_allocation_list *, long, CORE_ADDR,
153 enum language, struct objfile *);
156 add_psymbol_with_dem_name_to_list (char *, int, char *, int, namespace_enum,
158 struct psymbol_allocation_list *,
160 enum language, struct objfile *);
163 extern void init_psymbol_list (struct objfile *, int);
165 extern void sort_pst_symbols (struct partial_symtab *);
167 extern struct symtab *allocate_symtab (char *, struct objfile *);
169 extern int free_named_symtabs (char *);
171 extern void fill_in_vptr_fieldno (struct type *);
173 extern void add_symtab_fns (struct sym_fns *);
175 extern void init_entry_point_info (struct objfile *);
178 syms_from_objfile (struct objfile *, struct section_addr_info *, int, int);
180 extern void new_symfile_objfile (struct objfile *, int, int);
182 extern struct objfile *symbol_file_add (char *, int,
183 struct section_addr_info *, int, int);
185 /* Build (allocate and populate) a section_addr_info struct from
186 an existing section table. */
188 struct section_table;
189 extern struct section_addr_info *
190 build_section_addr_info_from_section_table (const struct section_table *start,
191 const struct section_table *end);
193 /* Free all memory allocated by build_section_addr_info_from_section_table. */
196 free_section_addr_info (struct section_addr_info *);
199 extern struct partial_symtab *start_psymtab_common (struct objfile *,
200 struct section_offsets *,
202 struct partial_symbol **,
203 struct partial_symbol **);
205 /* Sorting your symbols for fast lookup or alphabetical printing. */
207 extern void sort_block_syms (struct block *);
209 extern void sort_symtab_syms (struct symtab *);
211 /* Make a copy of the string at PTR with SIZE characters in the symbol obstack
212 (and add a null character at the end in the copy).
213 Returns the address of the copy. */
215 extern char *obsavestring (const char *, int, struct obstack *);
217 /* Concatenate strings S1, S2 and S3; return the new string.
218 Space is found in the symbol_obstack. */
220 extern char *obconcat (struct obstack *obstackp, const char *, const char *,
225 /* If non-zero, shared library symbols will be added automatically
226 when the inferior is created, new libraries are loaded, or when
227 attaching to the inferior. This is almost always what users will
228 want to have happen; but for very large programs, the startup time
229 will be excessive, and so if this is a problem, the user can clear
230 this flag and then add the shared library symbols as needed. Note
231 that there is a potential for confusion, since if the shared
232 library symbols are not loaded, commands like "info fun" will *not*
233 report all the functions that are actually present. */
235 extern int auto_solib_add;
237 /* For systems that support it, a threshold size in megabytes. If
238 automatically adding a new library's symbol table to those already
239 known to the debugger would cause the total shared library symbol
240 size to exceed this threshhold, then the shlib's symbols are not
241 added. The threshold is ignored if the user explicitly asks for a
242 shlib to be added, such as when using the "sharedlibrary"
245 extern int auto_solib_limit;
249 extern CORE_ADDR entry_point_address (void);
251 extern struct partial_symtab *allocate_psymtab (char *, struct objfile *);
253 extern void discard_psymtab (struct partial_symtab *);
255 extern void find_lowest_section (bfd *, asection *, PTR);
257 extern bfd *symfile_bfd_open (char *);
259 extern int get_section_index (struct objfile *, char *);
261 /* Utility functions for overlay sections: */
262 extern enum overlay_debugging_state {
267 extern int overlay_cache_invalid;
269 /* return the "mapped" overlay section containing the PC */
270 extern asection *find_pc_mapped_section (CORE_ADDR);
272 /* return any overlay section containing the PC (even in its LMA region) */
273 extern asection *find_pc_overlay (CORE_ADDR);
275 /* return true if the section is an overlay */
276 extern int section_is_overlay (asection *);
278 /* return true if the overlay section is currently "mapped" */
279 extern int section_is_mapped (asection *);
281 /* return true if pc belongs to section's VMA */
282 extern CORE_ADDR pc_in_mapped_range (CORE_ADDR, asection *);
284 /* return true if pc belongs to section's LMA */
285 extern CORE_ADDR pc_in_unmapped_range (CORE_ADDR, asection *);
287 /* map an address from a section's LMA to its VMA */
288 extern CORE_ADDR overlay_mapped_address (CORE_ADDR, asection *);
290 /* map an address from a section's VMA to its LMA */
291 extern CORE_ADDR overlay_unmapped_address (CORE_ADDR, asection *);
293 /* convert an address in an overlay section (force into VMA range) */
294 extern CORE_ADDR symbol_overlayed_address (CORE_ADDR, asection *);
296 /* Load symbols from a file. */
297 extern void symbol_file_add_main (char *args, int from_tty);
299 /* Clear GDB symbol tables. */
300 extern void symbol_file_clear (int from_tty);
302 /* From dwarfread.c */
305 dwarf_build_psymtabs (struct objfile *, int, file_ptr, unsigned int,
306 file_ptr, unsigned int);
308 /* From dwarf2read.c */
310 extern int dwarf2_has_info (bfd * abfd);
312 extern void dwarf2_build_psymtabs (struct objfile *, int);
313 extern void dwarf2_build_frame_info (struct objfile *);
315 /* From mdebugread.c */
317 /* Hack to force structures to exist before use in parameter list. */
318 struct ecoff_debug_hack
320 struct ecoff_debug_swap *a;
321 struct ecoff_debug_info *b;
324 mdebug_build_psymtabs (struct objfile *,
325 const struct ecoff_debug_swap *,
326 struct ecoff_debug_info *);
329 elfmdebug_build_psymtabs (struct objfile *,
330 const struct ecoff_debug_swap *, asection *);
332 #endif /* !defined(SYMFILE_H) */