PARAMS removal.
[deliverable/binutils-gdb.git] / gdb / symfile.h
1 /* Definitions for reading symbol files into GDB.
2 Copyright (C) 1990, 1991, 1992, 1993, 1994, 1996
3 Free Software Foundation, Inc.
4
5 This file is part of GDB.
6
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2 of the License, or
10 (at your option) any later version.
11
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
16
17 You should have received a copy of the GNU General Public License
18 along with this program; if not, write to the Free Software
19 Foundation, Inc., 59 Temple Place - Suite 330,
20 Boston, MA 02111-1307, USA. */
21
22 #if !defined (SYMFILE_H)
23 #define SYMFILE_H
24
25 /* This file requires that you first include "bfd.h". */
26
27 /* Partial symbols are stored in the psymbol_cache and pointers to them
28 are kept in a dynamically grown array that is obtained from malloc and
29 grown as necessary via realloc. Each objfile typically has two of these,
30 one for global symbols and one for static symbols. Although this adds
31 a level of indirection for storing or accessing the partial symbols,
32 it allows us to throw away duplicate psymbols and set all pointers
33 to the single saved instance. */
34
35 struct psymbol_allocation_list
36 {
37
38 /* Pointer to beginning of dynamically allocated array of pointers to
39 partial symbols. The array is dynamically expanded as necessary to
40 accommodate more pointers. */
41
42 struct partial_symbol **list;
43
44 /* Pointer to next available slot in which to store a pointer to a partial
45 symbol. */
46
47 struct partial_symbol **next;
48
49 /* Number of allocated pointer slots in current dynamic array (not the
50 number of bytes of storage). The "next" pointer will always point
51 somewhere between list[0] and list[size], and when at list[size] the
52 array will be expanded on the next attempt to store a pointer. */
53
54 int size;
55 };
56
57 /* Define an array of addresses to accommodate non-contiguous dynamic
58 loading of modules. This is for use when entering commands, so we
59 can keep track of the section names until we read the file and
60 can map them to bfd sections. This structure is also used by
61 solib.c to communicate the section addresses in shared objects to
62 symbol_file_add (). */
63
64 #define MAX_SECTIONS 40
65 struct section_addr_info
66 {
67 /* Sections whose names are file format dependant. */
68 struct other_sections
69 {
70 CORE_ADDR addr;
71 char *name;
72 int sectindex;
73 } other[MAX_SECTIONS];
74 };
75
76 /* Structure to keep track of symbol reading functions for various
77 object file types. */
78
79 struct sym_fns
80 {
81
82 /* BFD flavour that we handle, or (as a special kludge, see xcoffread.c,
83 (enum bfd_flavour)-1 for xcoff). */
84
85 enum bfd_flavour sym_flavour;
86
87 /* Initializes anything that is global to the entire symbol table. It is
88 called during symbol_file_add, when we begin debugging an entirely new
89 program. */
90
91 void (*sym_new_init) PARAMS ((struct objfile *));
92
93 /* Reads any initial information from a symbol file, and initializes the
94 struct sym_fns SF in preparation for sym_read(). It is called every
95 time we read a symbol file for any reason. */
96
97 void (*sym_init) PARAMS ((struct objfile *));
98
99 /* sym_read (objfile, mainline)
100 Reads a symbol file into a psymtab (or possibly a symtab).
101 OBJFILE is the objfile struct for the file we are reading.
102 MAINLINE is 1 if this is the
103 main symbol table being read, and 0 if a secondary
104 symbol file (e.g. shared library or dynamically loaded file)
105 is being read. */
106
107 void (*sym_read) PARAMS ((struct objfile *, int));
108
109 /* Called when we are finished with an objfile. Should do all cleanup
110 that is specific to the object file format for the particular objfile. */
111
112 void (*sym_finish) PARAMS ((struct objfile *));
113
114 /* This function produces a file-dependent section_offsets structure,
115 allocated in the objfile's storage, and based on the parameter.
116 The parameter is currently a CORE_ADDR (FIXME!) for backward compatibility
117 with the higher levels of GDB. It should probably be changed to
118 a string, where NULL means the default, and others are parsed in a file
119 dependent way. */
120
121 void (*sym_offsets) PARAMS ((struct objfile *, struct section_addr_info *));
122
123 /* Finds the next struct sym_fns. They are allocated and initialized
124 in whatever module implements the functions pointed to; an
125 initializer calls add_symtab_fns to add them to the global chain. */
126
127 struct sym_fns *next;
128
129 };
130
131 /* The default version of sym_fns.sym_offsets for readers that don't
132 do anything special. */
133
134 extern void
135 default_symfile_offsets (struct objfile *objfile, struct section_addr_info *);
136
137
138 extern void
139 extend_psymbol_list (struct psymbol_allocation_list *, struct objfile *);
140
141 /* Add any kind of symbol to a psymbol_allocation_list. */
142
143 /* #include "demangle.h" */
144
145 extern void
146 add_psymbol_to_list (char *, int, namespace_enum, enum address_class,
147 struct psymbol_allocation_list *, long, CORE_ADDR,
148 enum language, struct objfile *);
149
150 extern void
151 add_psymbol_with_dem_name_to_list (char *, int, char *, int, namespace_enum,
152 enum address_class,
153 struct psymbol_allocation_list *,
154 long, CORE_ADDR,
155 enum language, struct objfile *);
156
157
158 extern void init_psymbol_list (struct objfile *, int);
159
160 extern void sort_pst_symbols (struct partial_symtab *);
161
162 extern struct symtab *allocate_symtab (char *, struct objfile *);
163
164 extern int free_named_symtabs (char *);
165
166 extern void fill_in_vptr_fieldno (struct type *);
167
168 extern void add_symtab_fns (struct sym_fns *);
169
170 extern void init_entry_point_info (struct objfile *);
171
172 extern void
173 syms_from_objfile (struct objfile *, struct section_addr_info *, int, int);
174
175 extern void new_symfile_objfile (struct objfile *, int, int);
176
177 extern struct objfile *symbol_file_add (char *, int,
178 struct section_addr_info *, int, int);
179
180 /* Build (allocate and populate) a section_addr_info struct from
181 an existing section table. */
182
183 struct section_table;
184 extern struct section_addr_info *
185 build_section_addr_info_from_section_table (const struct section_table *start,
186 const struct section_table *end);
187
188 /* Free all memory allocated by build_section_addr_info_from_section_table. */
189
190 extern void
191 free_section_addr_info (struct section_addr_info *);
192
193
194 extern struct partial_symtab *start_psymtab_common (struct objfile *,
195 struct section_offsets *,
196 char *, CORE_ADDR,
197 struct partial_symbol **,
198 struct partial_symbol **);
199
200 /* Sorting your symbols for fast lookup or alphabetical printing. */
201
202 extern void sort_block_syms (struct block *);
203
204 extern void sort_symtab_syms (struct symtab *);
205
206 /* Make a copy of the string at PTR with SIZE characters in the symbol obstack
207 (and add a null character at the end in the copy).
208 Returns the address of the copy. */
209
210 extern char *obsavestring (char *, int, struct obstack *);
211
212 /* Concatenate strings S1, S2 and S3; return the new string.
213 Space is found in the symbol_obstack. */
214
215 extern char *obconcat (struct obstack *obstackp, const char *, const char *,
216 const char *);
217
218 /* Variables */
219
220 /* whether to auto load solibs at startup time: 0/1.
221
222 On all platforms, 0 means "don't auto load".
223
224 On HP-UX, > 0 means a threshhold, in megabytes, of symbol table which will
225 be auto loaded. When the cumulative size of solib symbol table exceeds
226 this threshhold, solibs' symbol tables will not be loaded.
227
228 On other platforms, > 0 means, "always auto load".
229 */
230
231 extern int auto_solib_add;
232
233 /* From symfile.c */
234
235 extern CORE_ADDR entry_point_address (void);
236
237 extern struct partial_symtab *allocate_psymtab (char *, struct objfile *);
238
239 extern void discard_psymtab (struct partial_symtab *);
240
241 extern void find_lowest_section (bfd *, asection *, PTR);
242
243 extern bfd *symfile_bfd_open (char *);
244
245 /* Utility functions for overlay sections: */
246 extern int overlay_debugging;
247 extern int overlay_cache_invalid;
248
249 /* return the "mapped" overlay section containing the PC */
250 extern asection *find_pc_mapped_section (CORE_ADDR);
251
252 /* return any overlay section containing the PC (even in its LMA region) */
253 extern asection *find_pc_overlay (CORE_ADDR);
254
255 /* return true if the section is an overlay */
256 extern int section_is_overlay (asection *);
257
258 /* return true if the overlay section is currently "mapped" */
259 extern int section_is_mapped (asection *);
260
261 /* return true if pc belongs to section's VMA */
262 extern CORE_ADDR pc_in_mapped_range (CORE_ADDR, asection *);
263
264 /* return true if pc belongs to section's LMA */
265 extern CORE_ADDR pc_in_unmapped_range (CORE_ADDR, asection *);
266
267 /* map an address from a section's LMA to its VMA */
268 extern CORE_ADDR overlay_mapped_address (CORE_ADDR, asection *);
269
270 /* map an address from a section's VMA to its LMA */
271 extern CORE_ADDR overlay_unmapped_address (CORE_ADDR, asection *);
272
273 /* convert an address in an overlay section (force into VMA range) */
274 extern CORE_ADDR symbol_overlayed_address (CORE_ADDR, asection *);
275
276 /* From dwarfread.c */
277
278 extern void
279 dwarf_build_psymtabs (struct objfile *, int, file_ptr, unsigned int,
280 file_ptr, unsigned int);
281
282 /* From dwarf2read.c */
283
284 extern int dwarf2_has_info (bfd * abfd);
285
286 extern void dwarf2_build_psymtabs (struct objfile *, int);
287
288 /* From mdebugread.c */
289
290 /* Hack to force structures to exist before use in parameter list. */
291 struct ecoff_debug_hack
292 {
293 struct ecoff_debug_swap *a;
294 struct ecoff_debug_info *b;
295 };
296 extern void
297 mdebug_build_psymtabs (struct objfile *,
298 const struct ecoff_debug_swap *,
299 struct ecoff_debug_info *);
300
301 extern void
302 elfmdebug_build_psymtabs (struct objfile *,
303 const struct ecoff_debug_swap *, asection *);
304
305 #endif /* !defined(SYMFILE_H) */
This page took 0.035992 seconds and 5 git commands to generate.