]> git.ipfire.org Git - thirdparty/binutils-gdb.git/blob - gdb/symfile.h
Copyright updates for 2007.
[thirdparty/binutils-gdb.git] / gdb / symfile.h
1 /* Definitions for reading symbol files into GDB.
2
3 Copyright (C) 1990, 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
4 2000, 2001, 2002, 2003, 2004, 2007 Free Software Foundation, Inc.
5
6 This file is part of GDB.
7
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.
12
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.
17
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., 51 Franklin Street, Fifth Floor,
21 Boston, MA 02110-1301, USA. */
22
23 #if !defined (SYMFILE_H)
24 #define SYMFILE_H
25
26 /* This file requires that you first include "bfd.h". */
27
28 /* Opaque declarations. */
29 struct section_table;
30 struct objfile;
31 struct obstack;
32 struct block;
33
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. */
41
42 struct psymbol_allocation_list
43 {
44
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. */
48
49 struct partial_symbol **list;
50
51 /* Pointer to next available slot in which to store a pointer to a
52 partial symbol. */
53
54 struct partial_symbol **next;
55
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. */
61
62 int size;
63 };
64
65 /* Define an array of addresses to accommodate non-contiguous dynamic
66 loading of modules. This is for use when entering commands, so we
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
73 {
74 /* The number of sections for which address information is
75 available. */
76 size_t num_sections;
77 /* Sections whose names are file format dependent. */
78 struct other_sections
79 {
80 CORE_ADDR addr;
81 char *name;
82 int sectindex;
83 } other[1];
84 };
85
86 /* Structure to keep track of symbol reading functions for various
87 object file types. */
88
89 struct sym_fns
90 {
91
92 /* BFD flavour that we handle, or (as a special kludge, see
93 xcoffread.c, (enum bfd_flavour)-1 for xcoff). */
94
95 enum bfd_flavour sym_flavour;
96
97 /* Initializes anything that is global to the entire symbol table.
98 It is called during symbol_file_add, when we begin debugging an
99 entirely new program. */
100
101 void (*sym_new_init) (struct objfile *);
102
103 /* Reads any initial information from a symbol file, and initializes
104 the struct sym_fns SF in preparation for sym_read(). It is
105 called every time we read a symbol file for any reason. */
106
107 void (*sym_init) (struct objfile *);
108
109 /* sym_read (objfile, mainline) Reads a symbol file into a psymtab
110 (or possibly a symtab). OBJFILE is the objfile struct for the
111 file we are reading. MAINLINE is 1 if this is the main symbol
112 table being read, and 0 if a secondary symbol file (e.g. shared
113 library or dynamically loaded file) is being read. */
114
115 void (*sym_read) (struct objfile *, int);
116
117 /* Called when we are finished with an objfile. Should do all
118 cleanup that is specific to the object file format for the
119 particular objfile. */
120
121 void (*sym_finish) (struct objfile *);
122
123 /* This function produces a file-dependent section_offsets
124 structure, allocated in the objfile's storage, and based on the
125 parameter. The parameter is currently a CORE_ADDR (FIXME!) for
126 backward compatibility with the higher levels of GDB. It should
127 probably be changed to a string, where NULL means the default,
128 and others are parsed in a file dependent way. */
129
130 void (*sym_offsets) (struct objfile *, struct section_addr_info *);
131
132 /* Finds the next struct sym_fns. They are allocated and
133 initialized in whatever module implements the functions pointed
134 to; an initializer calls add_symtab_fns to add them to the global
135 chain. */
136
137 struct sym_fns *next;
138
139 };
140
141 /* The default version of sym_fns.sym_offsets for readers that don't
142 do anything special. */
143
144 extern void default_symfile_offsets (struct objfile *objfile,
145 struct section_addr_info *);
146
147
148 extern void extend_psymbol_list (struct psymbol_allocation_list *,
149 struct objfile *);
150
151 /* Add any kind of symbol to a psymbol_allocation_list. */
152
153 /* #include "demangle.h" */
154
155 extern const
156 struct partial_symbol *add_psymbol_to_list (char *, int, domain_enum,
157 enum address_class,
158 struct psymbol_allocation_list *,
159 long, CORE_ADDR,
160 enum language, struct objfile *);
161
162 extern void add_psymbol_with_dem_name_to_list (char *, int, char *, int,
163 domain_enum,
164 enum address_class,
165 struct psymbol_allocation_list
166 *, long, CORE_ADDR,
167 enum language,
168 struct objfile *);
169
170
171 extern void init_psymbol_list (struct objfile *, int);
172
173 extern void sort_pst_symbols (struct partial_symtab *);
174
175 extern struct symtab *allocate_symtab (char *, struct objfile *);
176
177 extern int free_named_symtabs (char *);
178
179 extern void fill_in_vptr_fieldno (struct type *);
180
181 extern void add_symtab_fns (struct sym_fns *);
182
183 extern void syms_from_objfile (struct objfile *,
184 struct section_addr_info *,
185 struct section_offsets *, int, int, int);
186
187 extern void new_symfile_objfile (struct objfile *, int, int);
188
189 extern struct objfile *symbol_file_add (char *, int,
190 struct section_addr_info *, int, int);
191
192 extern struct objfile *symbol_file_add_from_bfd (bfd *, int,
193 struct section_addr_info *,
194 int, int);
195
196 /* Create a new section_addr_info, with room for NUM_SECTIONS. */
197
198 extern struct section_addr_info *alloc_section_addr_info (size_t
199 num_sections);
200
201 /* Return a freshly allocated copy of ADDRS. The section names, if
202 any, are also freshly allocated copies of those in ADDRS. */
203 extern struct section_addr_info *(copy_section_addr_info
204 (struct section_addr_info *addrs));
205
206 /* Build (allocate and populate) a section_addr_info struct from an
207 existing section table. */
208
209 extern struct section_addr_info
210 *build_section_addr_info_from_section_table (const struct section_table
211 *start,
212 const struct section_table
213 *end);
214
215 /* Free all memory allocated by
216 build_section_addr_info_from_section_table. */
217
218 extern void free_section_addr_info (struct section_addr_info *);
219
220
221 extern struct partial_symtab *start_psymtab_common (struct objfile *,
222 struct section_offsets *,
223 char *, CORE_ADDR,
224 struct partial_symbol **,
225 struct partial_symbol **);
226
227 /* Make a copy of the string at PTR with SIZE characters in the symbol
228 obstack (and add a null character at the end in the copy). Returns
229 the address of the copy. */
230
231 extern char *obsavestring (const char *, int, struct obstack *);
232
233 /* Concatenate strings S1, S2 and S3; return the new string. Space is
234 found in the OBSTACKP */
235
236 extern char *obconcat (struct obstack *obstackp, const char *, const char *,
237 const char *);
238
239 /* Variables */
240
241 /* If non-zero, shared library symbols will be added automatically
242 when the inferior is created, new libraries are loaded, or when
243 attaching to the inferior. This is almost always what users will
244 want to have happen; but for very large programs, the startup time
245 will be excessive, and so if this is a problem, the user can clear
246 this flag and then add the shared library symbols as needed. Note
247 that there is a potential for confusion, since if the shared
248 library symbols are not loaded, commands like "info fun" will *not*
249 report all the functions that are actually present. */
250
251 extern int auto_solib_add;
252
253 /* For systems that support it, a threshold size in megabytes. If
254 automatically adding a new library's symbol table to those already
255 known to the debugger would cause the total shared library symbol
256 size to exceed this threshhold, then the shlib's symbols are not
257 added. The threshold is ignored if the user explicitly asks for a
258 shlib to be added, such as when using the "sharedlibrary" command. */
259
260 extern int auto_solib_limit;
261
262 /* From symfile.c */
263
264 extern struct partial_symtab *allocate_psymtab (char *, struct objfile *);
265
266 extern void discard_psymtab (struct partial_symtab *);
267
268 extern void find_lowest_section (bfd *, asection *, void *);
269
270 extern bfd *symfile_bfd_open (char *);
271
272 extern int get_section_index (struct objfile *, char *);
273
274 /* Utility functions for overlay sections: */
275 extern enum overlay_debugging_state
276 {
277 ovly_off,
278 ovly_on,
279 ovly_auto
280 } overlay_debugging;
281 extern int overlay_cache_invalid;
282
283 /* Return the "mapped" overlay section containing the PC. */
284 extern asection *find_pc_mapped_section (CORE_ADDR);
285
286 /* Return any overlay section containing the PC (even in its LMA
287 region). */
288 extern asection *find_pc_overlay (CORE_ADDR);
289
290 /* Return true if the section is an overlay. */
291 extern int section_is_overlay (asection *);
292
293 /* Return true if the overlay section is currently "mapped". */
294 extern int section_is_mapped (asection *);
295
296 /* Return true if pc belongs to section's VMA. */
297 extern CORE_ADDR pc_in_mapped_range (CORE_ADDR, asection *);
298
299 /* Return true if pc belongs to section's LMA. */
300 extern CORE_ADDR pc_in_unmapped_range (CORE_ADDR, asection *);
301
302 /* Map an address from a section's LMA to its VMA. */
303 extern CORE_ADDR overlay_mapped_address (CORE_ADDR, asection *);
304
305 /* Map an address from a section's VMA to its LMA. */
306 extern CORE_ADDR overlay_unmapped_address (CORE_ADDR, asection *);
307
308 /* Convert an address in an overlay section (force into VMA range). */
309 extern CORE_ADDR symbol_overlayed_address (CORE_ADDR, asection *);
310
311 /* Load symbols from a file. */
312 extern void symbol_file_add_main (char *args, int from_tty);
313
314 /* Clear GDB symbol tables. */
315 extern void symbol_file_clear (int from_tty);
316
317 extern bfd_byte *symfile_relocate_debug_section (bfd *abfd, asection *sectp,
318 bfd_byte * buf);
319
320 /* From dwarfread.c */
321
322 extern void dwarf_build_psymtabs (struct objfile *, int, file_ptr,
323 unsigned int, file_ptr, unsigned int);
324
325 /* From dwarf2read.c */
326
327 extern int dwarf2_has_info (struct objfile *);
328
329 extern void dwarf2_build_psymtabs (struct objfile *, int);
330 extern void dwarf2_build_frame_info (struct objfile *);
331
332 /* From mdebugread.c */
333
334 /* Hack to force structures to exist before use in parameter list. */
335 struct ecoff_debug_hack
336 {
337 struct ecoff_debug_swap *a;
338 struct ecoff_debug_info *b;
339 };
340
341 extern void mdebug_build_psymtabs (struct objfile *,
342 const struct ecoff_debug_swap *,
343 struct ecoff_debug_info *);
344
345 extern void elfmdebug_build_psymtabs (struct objfile *,
346 const struct ecoff_debug_swap *,
347 asection *);
348
349 #endif /* !defined(SYMFILE_H) */