Commit | Line | Data |
---|---|---|
c906108c | 1 | /* Definitions for reading symbol files into GDB. |
3a6c3343 | 2 | |
28e7fd62 | 3 | Copyright (C) 1990-2013 Free Software Foundation, Inc. |
c906108c | 4 | |
c5aa993b | 5 | This file is part of GDB. |
c906108c | 6 | |
c5aa993b JM |
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 | |
a9762ec7 | 9 | the Free Software Foundation; either version 3 of the License, or |
c5aa993b | 10 | (at your option) any later version. |
c906108c | 11 | |
c5aa993b JM |
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. | |
c906108c | 16 | |
c5aa993b | 17 | You should have received a copy of the GNU General Public License |
a9762ec7 | 18 | along with this program. If not, see <http://www.gnu.org/licenses/>. */ |
c906108c SS |
19 | |
20 | #if !defined (SYMFILE_H) | |
21 | #define SYMFILE_H | |
22 | ||
23 | /* This file requires that you first include "bfd.h". */ | |
16708cba | 24 | #include "symtab.h" |
48faced0 | 25 | #include "probe.h" |
c906108c | 26 | |
63ca651f | 27 | /* Opaque declarations. */ |
0542c86d | 28 | struct target_section; |
da3331ec | 29 | struct objfile; |
1c772458 | 30 | struct obj_section; |
63ca651f | 31 | struct obstack; |
fe898f56 | 32 | struct block; |
55aa24fb SDJ |
33 | struct probe; |
34 | struct value; | |
35 | struct frame_info; | |
36 | struct agent_expr; | |
37 | struct axs_value; | |
63ca651f | 38 | |
2edb89d3 JK |
39 | /* Comparison function for symbol look ups. */ |
40 | ||
41 | typedef int (symbol_compare_ftype) (const char *string1, | |
42 | const char *string2); | |
43 | ||
3a6c3343 AC |
44 | /* Partial symbols are stored in the psymbol_cache and pointers to |
45 | them are kept in a dynamically grown array that is obtained from | |
46 | malloc and grown as necessary via realloc. Each objfile typically | |
47 | has two of these, one for global symbols and one for static | |
48 | symbols. Although this adds a level of indirection for storing or | |
49 | accessing the partial symbols, it allows us to throw away duplicate | |
50 | psymbols and set all pointers to the single saved instance. */ | |
c906108c | 51 | |
c5aa993b | 52 | struct psymbol_allocation_list |
3a6c3343 | 53 | { |
c906108c | 54 | |
3a6c3343 AC |
55 | /* Pointer to beginning of dynamically allocated array of pointers |
56 | to partial symbols. The array is dynamically expanded as | |
57 | necessary to accommodate more pointers. */ | |
c906108c | 58 | |
3a6c3343 | 59 | struct partial_symbol **list; |
c906108c | 60 | |
3a6c3343 AC |
61 | /* Pointer to next available slot in which to store a pointer to a |
62 | partial symbol. */ | |
c906108c | 63 | |
3a6c3343 | 64 | struct partial_symbol **next; |
c906108c | 65 | |
3a6c3343 AC |
66 | /* Number of allocated pointer slots in current dynamic array (not |
67 | the number of bytes of storage). The "next" pointer will always | |
68 | point somewhere between list[0] and list[size], and when at | |
69 | list[size] the array will be expanded on the next attempt to | |
70 | store a pointer. */ | |
c906108c | 71 | |
3a6c3343 AC |
72 | int size; |
73 | }; | |
c906108c | 74 | |
62557bbc KB |
75 | /* Define an array of addresses to accommodate non-contiguous dynamic |
76 | loading of modules. This is for use when entering commands, so we | |
3a6c3343 AC |
77 | can keep track of the section names until we read the file and can |
78 | map them to bfd sections. This structure is also used by solib.c | |
79 | to communicate the section addresses in shared objects to | |
80 | symbol_file_add (). */ | |
81 | ||
82 | struct section_addr_info | |
62557bbc | 83 | { |
a39a16c4 MM |
84 | /* The number of sections for which address information is |
85 | available. */ | |
86 | size_t num_sections; | |
c378eb4e | 87 | /* Sections whose names are file format dependent. */ |
62557bbc KB |
88 | struct other_sections |
89 | { | |
90 | CORE_ADDR addr; | |
91 | char *name; | |
672d9c23 | 92 | |
5488dafb | 93 | /* SECTINDEX must be valid for associated BFD or set to -1. */ |
62557bbc | 94 | int sectindex; |
a39a16c4 | 95 | } other[1]; |
62557bbc KB |
96 | }; |
97 | ||
28c32713 JB |
98 | |
99 | /* A table listing the load segments in a symfile, and which segment | |
100 | each BFD section belongs to. */ | |
31d99776 DJ |
101 | struct symfile_segment_data |
102 | { | |
103 | /* How many segments are present in this file. If there are | |
104 | two, the text segment is the first one and the data segment | |
105 | is the second one. */ | |
106 | int num_segments; | |
107 | ||
108 | /* If NUM_SEGMENTS is greater than zero, the original base address | |
109 | of each segment. */ | |
110 | CORE_ADDR *segment_bases; | |
111 | ||
112 | /* If NUM_SEGMENTS is greater than zero, the memory size of each | |
113 | segment. */ | |
114 | CORE_ADDR *segment_sizes; | |
115 | ||
116 | /* If NUM_SEGMENTS is greater than zero, this is an array of entries | |
28c32713 JB |
117 | recording which segment contains each BFD section. |
118 | SEGMENT_INFO[I] is S+1 if the I'th BFD section belongs to segment | |
119 | S, or zero if it is not in any segment. */ | |
31d99776 DJ |
120 | int *segment_info; |
121 | }; | |
122 | ||
44b13c5a JK |
123 | /* Callback for quick_symbol_functions->map_symbol_filenames. */ |
124 | ||
125 | typedef void (symbol_filename_ftype) (const char *filename, | |
126 | const char *fullname, void *data); | |
127 | ||
ccefe4c4 TT |
128 | /* The "quick" symbol functions exist so that symbol readers can |
129 | avoiding an initial read of all the symbols. For example, symbol | |
130 | readers might choose to use the "partial symbol table" utilities, | |
131 | which is one implementation of the quick symbol functions. | |
132 | ||
133 | The quick symbol functions are generally opaque: the underlying | |
134 | representation is hidden from the caller. | |
135 | ||
136 | In general, these functions should only look at whatever special | |
137 | index the symbol reader creates -- looking through the symbol | |
138 | tables themselves is handled by generic code. If a function is | |
139 | defined as returning a "symbol table", this means that the function | |
140 | should only return a newly-created symbol table; it should not | |
141 | examine pre-existing ones. | |
142 | ||
143 | The exact list of functions here was determined in an ad hoc way | |
144 | based on gdb's history. */ | |
145 | ||
146 | struct quick_symbol_functions | |
147 | { | |
148 | /* Return true if this objfile has any "partial" symbols | |
149 | available. */ | |
150 | int (*has_symbols) (struct objfile *objfile); | |
151 | ||
152 | /* Return the symbol table for the "last" file appearing in | |
153 | OBJFILE. */ | |
154 | struct symtab *(*find_last_source_symtab) (struct objfile *objfile); | |
155 | ||
156 | /* Forget all cached full file names for OBJFILE. */ | |
157 | void (*forget_cached_source_info) (struct objfile *objfile); | |
158 | ||
f8eba3c6 TT |
159 | /* Expand and iterate over each "partial" symbol table in OBJFILE |
160 | where the source file is named NAME. | |
161 | ||
af529f8f JK |
162 | If NAME is not absolute, a match after a '/' in the symbol table's |
163 | file name will also work, REAL_PATH is NULL then. If NAME is | |
164 | absolute then REAL_PATH is non-NULL absolute file name as resolved | |
165 | via gdb_realpath from NAME. | |
f8eba3c6 TT |
166 | |
167 | If a match is found, the "partial" symbol table is expanded. | |
168 | Then, this calls iterate_over_some_symtabs (or equivalent) over | |
169 | all newly-created symbol tables, passing CALLBACK and DATA to it. | |
170 | The result of this call is returned. */ | |
171 | int (*map_symtabs_matching_filename) (struct objfile *objfile, | |
172 | const char *name, | |
f8eba3c6 TT |
173 | const char *real_path, |
174 | int (*callback) (struct symtab *, | |
175 | void *), | |
176 | void *data); | |
ccefe4c4 TT |
177 | |
178 | /* Check to see if the symbol is defined in a "partial" symbol table | |
179 | of OBJFILE. KIND should be either GLOBAL_BLOCK or STATIC_BLOCK, | |
180 | depending on whether we want to search global symbols or static | |
181 | symbols. NAME is the name of the symbol to look for. DOMAIN | |
182 | indicates what sort of symbol to search for. | |
183 | ||
184 | Returns the newly-expanded symbol table in which the symbol is | |
bfb05775 JK |
185 | defined, or NULL if no such symbol table exists. If OBJFILE |
186 | contains !TYPE_OPAQUE symbol prefer its symtab. If it contains | |
187 | only TYPE_OPAQUE symbol(s), return at least that symtab. */ | |
ccefe4c4 TT |
188 | struct symtab *(*lookup_symbol) (struct objfile *objfile, |
189 | int kind, const char *name, | |
190 | domain_enum domain); | |
191 | ||
192 | /* Print statistics about any indices loaded for OBJFILE. The | |
193 | statistics should be printed to gdb_stdout. This is used for | |
194 | "maint print statistics". */ | |
195 | void (*print_stats) (struct objfile *objfile); | |
196 | ||
197 | /* Dump any indices loaded for OBJFILE. The dump should go to | |
198 | gdb_stdout. This is used for "maint print objfiles". */ | |
199 | void (*dump) (struct objfile *objfile); | |
200 | ||
201 | /* This is called by objfile_relocate to relocate any indices loaded | |
202 | for OBJFILE. */ | |
203 | void (*relocate) (struct objfile *objfile, | |
3189cb12 DE |
204 | const struct section_offsets *new_offsets, |
205 | const struct section_offsets *delta); | |
ccefe4c4 TT |
206 | |
207 | /* Find all the symbols in OBJFILE named FUNC_NAME, and ensure that | |
208 | the corresponding symbol tables are loaded. */ | |
209 | void (*expand_symtabs_for_function) (struct objfile *objfile, | |
210 | const char *func_name); | |
211 | ||
212 | /* Read all symbol tables associated with OBJFILE. */ | |
213 | void (*expand_all_symtabs) (struct objfile *objfile); | |
214 | ||
652a8996 JK |
215 | /* Read all symbol tables associated with OBJFILE which have |
216 | symtab_to_fullname equal to FULLNAME. | |
d4637a04 DE |
217 | This is for the purposes of examining code only, e.g., expand_line_sal. |
218 | The routine may ignore debug info that is known to not be useful with | |
219 | code, e.g., DW_TAG_type_unit for dwarf debug info. */ | |
652a8996 JK |
220 | void (*expand_symtabs_with_fullname) (struct objfile *objfile, |
221 | const char *fullname); | |
ccefe4c4 | 222 | |
40658b94 PH |
223 | /* Find global or static symbols in all tables that are in NAMESPACE |
224 | and for which MATCH (symbol name, NAME) == 0, passing each to | |
265e52c3 | 225 | CALLBACK, reading in partial symbol tables as needed. Look |
c378eb4e | 226 | through global symbols if GLOBAL and otherwise static symbols. |
40658b94 PH |
227 | Passes NAME, NAMESPACE, and DATA to CALLBACK with each symbol |
228 | found. After each block is processed, passes NULL to CALLBACK. | |
1e3a8f45 JB |
229 | MATCH must be weaker than strcmp_iw_ordered in the sense that |
230 | strcmp_iw_ordered(x,y) == 0 --> MATCH(x,y) == 0. ORDERED_COMPARE, | |
231 | if non-null, must be an ordering relation compatible with | |
232 | strcmp_iw_ordered in the sense that | |
233 | strcmp_iw_ordered(x,y) == 0 --> ORDERED_COMPARE(x,y) == 0 | |
40658b94 | 234 | and |
1e3a8f45 JB |
235 | strcmp_iw_ordered(x,y) <= 0 --> ORDERED_COMPARE(x,y) <= 0 |
236 | (allowing strcmp_iw_ordered(x,y) < 0 while ORDERED_COMPARE(x, y) == 0). | |
40658b94 PH |
237 | CALLBACK returns 0 to indicate that the scan should continue, or |
238 | non-zero to indicate that the scan should be terminated. */ | |
239 | ||
240 | void (*map_matching_symbols) (const char *name, domain_enum namespace, | |
241 | struct objfile *, int global, | |
242 | int (*callback) (struct block *, | |
243 | struct symbol *, void *), | |
244 | void *data, | |
2edb89d3 JK |
245 | symbol_compare_ftype *match, |
246 | symbol_compare_ftype *ordered_compare); | |
ccefe4c4 TT |
247 | |
248 | /* Expand all symbol tables in OBJFILE matching some criteria. | |
249 | ||
250 | FILE_MATCHER is called for each file in OBJFILE. The file name | |
251 | and the DATA argument are passed to it. If it returns zero, this | |
7b08b9eb | 252 | file is skipped. If FILE_MATCHER is NULL such file is not skipped. |
fbd9ab74 JK |
253 | If BASENAMES is non-zero the function should consider only base name of |
254 | DATA (passed file name is already only the lbasename part). | |
ccefe4c4 | 255 | |
7b08b9eb | 256 | Otherwise, if KIND does not match this symbol is skipped. |
74ccd7f5 | 257 | |
f8eba3c6 | 258 | If even KIND matches, then NAME_MATCHER is called for each symbol |
e078317b JB |
259 | defined in the file. The symbol "search" name and DATA are passed |
260 | to NAME_MATCHER. | |
ccefe4c4 TT |
261 | |
262 | If NAME_MATCHER returns zero, then this symbol is skipped. | |
263 | ||
7b08b9eb JK |
264 | Otherwise, this symbol's symbol table is expanded. |
265 | ||
ccefe4c4 TT |
266 | DATA is user data that is passed unmodified to the callback |
267 | functions. */ | |
f8eba3c6 TT |
268 | void (*expand_symtabs_matching) |
269 | (struct objfile *objfile, | |
fbd9ab74 | 270 | int (*file_matcher) (const char *, void *, int basenames), |
e078317b | 271 | int (*name_matcher) (const char *, void *), |
f8eba3c6 TT |
272 | enum search_domain kind, |
273 | void *data); | |
ccefe4c4 TT |
274 | |
275 | /* Return the symbol table from OBJFILE that contains PC and | |
276 | SECTION. Return NULL if there is no such symbol table. This | |
277 | should return the symbol table that contains a symbol whose | |
278 | address exactly matches PC, or, if there is no exact match, the | |
279 | symbol table that contains a symbol whose address is closest to | |
280 | PC. */ | |
281 | struct symtab *(*find_pc_sect_symtab) (struct objfile *objfile, | |
282 | struct minimal_symbol *msymbol, | |
283 | CORE_ADDR pc, | |
284 | struct obj_section *section, | |
285 | int warn_if_readin); | |
286 | ||
ad727bb2 | 287 | /* Call a callback for every file defined in OBJFILE whose symtab is |
44b13c5a | 288 | not already read in. FUN is the callback. It is passed the file's |
74e2f255 DE |
289 | FILENAME, the file's FULLNAME (if need_fullname is non-zero), and |
290 | the DATA passed to this function. */ | |
ccefe4c4 | 291 | void (*map_symbol_filenames) (struct objfile *objfile, |
74e2f255 DE |
292 | symbol_filename_ftype *fun, void *data, |
293 | int need_fullname); | |
ccefe4c4 TT |
294 | }; |
295 | ||
55aa24fb SDJ |
296 | /* Structure of functions used for probe support. If one of these functions |
297 | is provided, all must be. */ | |
298 | ||
299 | struct sym_probe_fns | |
300 | { | |
301 | /* If non-NULL, return an array of probe objects. | |
302 | ||
303 | The returned value does not have to be freed and it has lifetime of the | |
304 | OBJFILE. */ | |
305 | VEC (probe_p) *(*sym_get_probes) (struct objfile *); | |
306 | ||
307 | /* Return the number of arguments available to PROBE. PROBE will | |
308 | have come from a call to this objfile's sym_get_probes method. | |
309 | If you provide an implementation of sym_get_probes, you must | |
310 | implement this method as well. */ | |
6bac7473 | 311 | unsigned (*sym_get_probe_argument_count) (struct probe *probe); |
55aa24fb | 312 | |
25f9533e SDJ |
313 | /* Return 1 if the probe interface can evaluate the arguments of probe |
314 | PROBE, zero otherwise. This function can be probe-specific, informing | |
315 | whether only the arguments of PROBE can be evaluated, of generic, | |
316 | informing whether the probe interface is able to evaluate any kind of | |
317 | argument. If you provide an implementation of sym_get_probes, you must | |
318 | implement this method as well. */ | |
319 | int (*can_evaluate_probe_arguments) (struct probe *probe); | |
320 | ||
55aa24fb SDJ |
321 | /* Evaluate the Nth argument available to PROBE. PROBE will have |
322 | come from a call to this objfile's sym_get_probes method. N will | |
323 | be between 0 and the number of arguments available to this probe. | |
324 | FRAME is the frame in which the evaluation is done; the frame's | |
325 | PC will match the address of the probe. If you provide an | |
326 | implementation of sym_get_probes, you must implement this method | |
327 | as well. */ | |
6bac7473 | 328 | struct value *(*sym_evaluate_probe_argument) (struct probe *probe, |
55aa24fb SDJ |
329 | unsigned n); |
330 | ||
331 | /* Compile the Nth probe argument to an agent expression. PROBE | |
332 | will have come from a call to this objfile's sym_get_probes | |
333 | method. N will be between 0 and the number of arguments | |
334 | available to this probe. EXPR and VALUE are the agent expression | |
335 | that is being updated. */ | |
6bac7473 | 336 | void (*sym_compile_to_ax) (struct probe *probe, |
55aa24fb SDJ |
337 | struct agent_expr *expr, |
338 | struct axs_value *value, | |
339 | unsigned n); | |
340 | ||
341 | /* Relocate the probe section of OBJFILE. */ | |
342 | void (*sym_relocate_probe) (struct objfile *objfile, | |
3189cb12 DE |
343 | const struct section_offsets *new_offsets, |
344 | const struct section_offsets *delta); | |
55aa24fb SDJ |
345 | }; |
346 | ||
c906108c SS |
347 | /* Structure to keep track of symbol reading functions for various |
348 | object file types. */ | |
349 | ||
c5aa993b | 350 | struct sym_fns |
3a6c3343 | 351 | { |
c906108c | 352 | |
3a6c3343 AC |
353 | /* BFD flavour that we handle, or (as a special kludge, see |
354 | xcoffread.c, (enum bfd_flavour)-1 for xcoff). */ | |
c906108c | 355 | |
3a6c3343 | 356 | enum bfd_flavour sym_flavour; |
c906108c | 357 | |
3a6c3343 AC |
358 | /* Initializes anything that is global to the entire symbol table. |
359 | It is called during symbol_file_add, when we begin debugging an | |
360 | entirely new program. */ | |
c906108c | 361 | |
3a6c3343 | 362 | void (*sym_new_init) (struct objfile *); |
c906108c | 363 | |
3a6c3343 AC |
364 | /* Reads any initial information from a symbol file, and initializes |
365 | the struct sym_fns SF in preparation for sym_read(). It is | |
366 | called every time we read a symbol file for any reason. */ | |
c906108c | 367 | |
3a6c3343 | 368 | void (*sym_init) (struct objfile *); |
c906108c | 369 | |
f4352531 | 370 | /* sym_read (objfile, symfile_flags) Reads a symbol file into a psymtab |
3a6c3343 | 371 | (or possibly a symtab). OBJFILE is the objfile struct for the |
f4352531 TG |
372 | file we are reading. SYMFILE_FLAGS are the flags passed to |
373 | symbol_file_add & co. */ | |
c906108c | 374 | |
3a6c3343 | 375 | void (*sym_read) (struct objfile *, int); |
c906108c | 376 | |
3e03848b JK |
377 | /* Read the partial symbols for an objfile. This may be NULL, in which case |
378 | gdb has to check other ways if this objfile has any symbols. This may | |
379 | only be non-NULL if the objfile actually does have debuginfo available. | |
380 | */ | |
b11896a5 TT |
381 | |
382 | void (*sym_read_psymbols) (struct objfile *); | |
383 | ||
3a6c3343 AC |
384 | /* Called when we are finished with an objfile. Should do all |
385 | cleanup that is specific to the object file format for the | |
386 | particular objfile. */ | |
c906108c | 387 | |
3a6c3343 | 388 | void (*sym_finish) (struct objfile *); |
c906108c | 389 | |
3a6c3343 AC |
390 | /* This function produces a file-dependent section_offsets |
391 | structure, allocated in the objfile's storage, and based on the | |
392 | parameter. The parameter is currently a CORE_ADDR (FIXME!) for | |
393 | backward compatibility with the higher levels of GDB. It should | |
394 | probably be changed to a string, where NULL means the default, | |
395 | and others are parsed in a file dependent way. */ | |
c906108c | 396 | |
3189cb12 | 397 | void (*sym_offsets) (struct objfile *, const struct section_addr_info *); |
c906108c | 398 | |
31d99776 DJ |
399 | /* This function produces a format-independent description of |
400 | the segments of ABFD. Each segment is a unit of the file | |
401 | which may be relocated independently. */ | |
402 | ||
403 | struct symfile_segment_data *(*sym_segments) (bfd *abfd); | |
404 | ||
c295b2e5 JB |
405 | /* This function should read the linetable from the objfile when |
406 | the line table cannot be read while processing the debugging | |
407 | information. */ | |
ac8035ab | 408 | |
c295b2e5 JB |
409 | void (*sym_read_linetable) (void); |
410 | ||
ac8035ab TG |
411 | /* Relocate the contents of a debug section SECTP. The |
412 | contents are stored in BUF if it is non-NULL, or returned in a | |
413 | malloc'd buffer otherwise. */ | |
414 | ||
415 | bfd_byte *(*sym_relocate) (struct objfile *, asection *sectp, bfd_byte *buf); | |
416 | ||
55aa24fb SDJ |
417 | /* If non-NULL, this objfile has probe support, and all the probe |
418 | functions referred to here will be non-NULL. */ | |
419 | const struct sym_probe_fns *sym_probe_fns; | |
420 | ||
ccefe4c4 TT |
421 | /* The "quick" (aka partial) symbol functions for this symbol |
422 | reader. */ | |
423 | const struct quick_symbol_functions *qf; | |
3a6c3343 | 424 | }; |
c906108c | 425 | |
567995e1 | 426 | extern struct section_addr_info * |
3e43a32a | 427 | build_section_addr_info_from_objfile (const struct objfile *objfile); |
567995e1 | 428 | |
75242ef4 JK |
429 | extern void relative_addr_info_to_section_offsets |
430 | (struct section_offsets *section_offsets, int num_sections, | |
3189cb12 | 431 | const struct section_addr_info *addrs); |
75242ef4 JK |
432 | |
433 | extern void addr_info_make_relative (struct section_addr_info *addrs, | |
434 | bfd *abfd); | |
435 | ||
c906108c SS |
436 | /* The default version of sym_fns.sym_offsets for readers that don't |
437 | do anything special. */ | |
438 | ||
570b8f7c | 439 | extern void default_symfile_offsets (struct objfile *objfile, |
3189cb12 | 440 | const struct section_addr_info *); |
c906108c | 441 | |
31d99776 DJ |
442 | /* The default version of sym_fns.sym_segments for readers that don't |
443 | do anything special. */ | |
444 | ||
445 | extern struct symfile_segment_data *default_symfile_segments (bfd *abfd); | |
c906108c | 446 | |
ac8035ab TG |
447 | /* The default version of sym_fns.sym_relocate for readers that don't |
448 | do anything special. */ | |
449 | ||
450 | extern bfd_byte *default_symfile_relocate (struct objfile *objfile, | |
451 | asection *sectp, bfd_byte *buf); | |
452 | ||
4e04028d JK |
453 | extern struct symtab *allocate_symtab (const char *, struct objfile *) |
454 | ATTRIBUTE_NONNULL (1); | |
c906108c | 455 | |
00b5771c | 456 | extern void add_symtab_fns (const struct sym_fns *); |
c906108c | 457 | |
7eedccfa | 458 | /* This enum encodes bit-flags passed as ADD_FLAGS parameter to |
6bf667bb | 459 | symbol_file_add, etc. */ |
7eedccfa PP |
460 | |
461 | enum symfile_add_flags | |
462 | { | |
463 | /* Be chatty about what you are doing. */ | |
464 | SYMFILE_VERBOSE = 1 << 1, | |
465 | ||
466 | /* This is the main symbol file (as opposed to symbol file for dynamically | |
467 | loaded code). */ | |
468 | SYMFILE_MAINLINE = 1 << 2, | |
469 | ||
470 | /* Do not call breakpoint_re_set when adding this symbol file. */ | |
b11896a5 TT |
471 | SYMFILE_DEFER_BP_RESET = 1 << 3, |
472 | ||
473 | /* Do not immediately read symbols for this file. By default, | |
474 | symbols are read when the objfile is created. */ | |
475 | SYMFILE_NO_READ = 1 << 4 | |
7eedccfa PP |
476 | }; |
477 | ||
7eedccfa | 478 | extern void new_symfile_objfile (struct objfile *, int); |
c906108c | 479 | |
a14ed312 | 480 | extern struct objfile *symbol_file_add (char *, int, |
7eedccfa | 481 | struct section_addr_info *, int); |
62557bbc | 482 | |
eb4556d7 JB |
483 | extern struct objfile *symbol_file_add_from_bfd (bfd *, int, |
484 | struct section_addr_info *, | |
63524580 | 485 | int, struct objfile *parent); |
eb4556d7 | 486 | |
15d123c9 | 487 | extern void symbol_file_add_separate (bfd *, int, struct objfile *); |
9cce227f | 488 | |
15d123c9 | 489 | extern char *find_separate_debug_file_by_debuglink (struct objfile *); |
9cce227f | 490 | |
a39a16c4 MM |
491 | /* Create a new section_addr_info, with room for NUM_SECTIONS. */ |
492 | ||
3a6c3343 AC |
493 | extern struct section_addr_info *alloc_section_addr_info (size_t |
494 | num_sections); | |
a39a16c4 | 495 | |
3a6c3343 AC |
496 | /* Build (allocate and populate) a section_addr_info struct from an |
497 | existing section table. */ | |
62557bbc | 498 | |
3a6c3343 | 499 | extern struct section_addr_info |
0542c86d | 500 | *build_section_addr_info_from_section_table (const struct target_section |
3a6c3343 | 501 | *start, |
0542c86d | 502 | const struct target_section |
3a6c3343 | 503 | *end); |
62557bbc | 504 | |
3a6c3343 AC |
505 | /* Free all memory allocated by |
506 | build_section_addr_info_from_section_table. */ | |
62557bbc | 507 | |
570b8f7c | 508 | extern void free_section_addr_info (struct section_addr_info *); |
62557bbc KB |
509 | |
510 | ||
c906108c SS |
511 | /* Variables */ |
512 | ||
b7209cb4 FF |
513 | /* If non-zero, shared library symbols will be added automatically |
514 | when the inferior is created, new libraries are loaded, or when | |
515 | attaching to the inferior. This is almost always what users will | |
516 | want to have happen; but for very large programs, the startup time | |
517 | will be excessive, and so if this is a problem, the user can clear | |
518 | this flag and then add the shared library symbols as needed. Note | |
519 | that there is a potential for confusion, since if the shared | |
520 | library symbols are not loaded, commands like "info fun" will *not* | |
3a6c3343 | 521 | report all the functions that are actually present. */ |
c906108c | 522 | |
b7209cb4 | 523 | extern int auto_solib_add; |
c906108c | 524 | |
c906108c SS |
525 | /* From symfile.c */ |
526 | ||
8b60591b JB |
527 | extern void set_initial_language (void); |
528 | ||
4efb68b1 | 529 | extern void find_lowest_section (bfd *, asection *, void *); |
c906108c | 530 | |
a14ed312 | 531 | extern bfd *symfile_bfd_open (char *); |
c906108c | 532 | |
08d2cd74 | 533 | extern bfd *gdb_bfd_open_maybe_remote (const char *); |
874f5765 | 534 | |
e2f6d8e5 JB |
535 | extern int get_section_index (struct objfile *, char *); |
536 | ||
c906108c | 537 | /* Utility functions for overlay sections: */ |
3a6c3343 AC |
538 | extern enum overlay_debugging_state |
539 | { | |
540 | ovly_off, | |
541 | ovly_on, | |
d874f1e2 MS |
542 | ovly_auto |
543 | } overlay_debugging; | |
c906108c SS |
544 | extern int overlay_cache_invalid; |
545 | ||
3a6c3343 | 546 | /* Return the "mapped" overlay section containing the PC. */ |
714835d5 | 547 | extern struct obj_section *find_pc_mapped_section (CORE_ADDR); |
c906108c | 548 | |
3a6c3343 AC |
549 | /* Return any overlay section containing the PC (even in its LMA |
550 | region). */ | |
714835d5 | 551 | extern struct obj_section *find_pc_overlay (CORE_ADDR); |
c906108c | 552 | |
3a6c3343 | 553 | /* Return true if the section is an overlay. */ |
714835d5 | 554 | extern int section_is_overlay (struct obj_section *); |
c906108c | 555 | |
3a6c3343 | 556 | /* Return true if the overlay section is currently "mapped". */ |
714835d5 | 557 | extern int section_is_mapped (struct obj_section *); |
c906108c | 558 | |
3a6c3343 | 559 | /* Return true if pc belongs to section's VMA. */ |
714835d5 | 560 | extern CORE_ADDR pc_in_mapped_range (CORE_ADDR, struct obj_section *); |
c906108c | 561 | |
3a6c3343 | 562 | /* Return true if pc belongs to section's LMA. */ |
714835d5 | 563 | extern CORE_ADDR pc_in_unmapped_range (CORE_ADDR, struct obj_section *); |
c906108c | 564 | |
3a6c3343 | 565 | /* Map an address from a section's LMA to its VMA. */ |
714835d5 | 566 | extern CORE_ADDR overlay_mapped_address (CORE_ADDR, struct obj_section *); |
c906108c | 567 | |
3a6c3343 | 568 | /* Map an address from a section's VMA to its LMA. */ |
714835d5 | 569 | extern CORE_ADDR overlay_unmapped_address (CORE_ADDR, struct obj_section *); |
c906108c | 570 | |
3a6c3343 | 571 | /* Convert an address in an overlay section (force into VMA range). */ |
714835d5 | 572 | extern CORE_ADDR symbol_overlayed_address (CORE_ADDR, struct obj_section *); |
c906108c | 573 | |
3a6c3343 | 574 | /* Load symbols from a file. */ |
1adeb98a FN |
575 | extern void symbol_file_add_main (char *args, int from_tty); |
576 | ||
3a6c3343 | 577 | /* Clear GDB symbol tables. */ |
1adeb98a FN |
578 | extern void symbol_file_clear (int from_tty); |
579 | ||
1c772458 UW |
580 | /* Default overlay update function. */ |
581 | extern void simple_overlay_update (struct obj_section *); | |
582 | ||
ac8035ab TG |
583 | extern bfd_byte *symfile_relocate_debug_section (struct objfile *, asection *, |
584 | bfd_byte *); | |
086df311 | 585 | |
31d99776 | 586 | extern int symfile_map_offsets_to_segments (bfd *, |
3189cb12 | 587 | const struct symfile_segment_data *, |
31d99776 DJ |
588 | struct section_offsets *, |
589 | int, const CORE_ADDR *); | |
590 | struct symfile_segment_data *get_symfile_segment_data (bfd *abfd); | |
591 | void free_symfile_segment_data (struct symfile_segment_data *data); | |
592 | ||
ccefe4c4 TT |
593 | extern struct cleanup *increment_reading_symtab (void); |
594 | ||
c906108c SS |
595 | /* From dwarf2read.c */ |
596 | ||
251d32d9 TG |
597 | /* Names for a dwarf2 debugging section. The field NORMAL is the normal |
598 | section name (usually from the DWARF standard), while the field COMPRESSED | |
599 | is the name of compressed sections. If your object file format doesn't | |
600 | support compressed sections, the field COMPRESSED can be NULL. Likewise, | |
601 | the debugging section is not supported, the field NORMAL can be NULL too. | |
602 | It doesn't make sense to have a NULL NORMAL field but a non-NULL COMPRESSED | |
603 | field. */ | |
604 | ||
605 | struct dwarf2_section_names { | |
606 | const char *normal; | |
607 | const char *compressed; | |
608 | }; | |
609 | ||
610 | /* List of names for dward2 debugging sections. Also most object file formats | |
611 | use the standardized (ie ELF) names, some (eg XCOFF) have customized names | |
612 | due to restrictions. | |
613 | The table for the standard names is defined in dwarf2read.c. Please | |
614 | update all instances of dwarf2_debug_sections if you add a field to this | |
615 | structure. It is always safe to use { NULL, NULL } in this case. */ | |
616 | ||
617 | struct dwarf2_debug_sections { | |
618 | struct dwarf2_section_names info; | |
619 | struct dwarf2_section_names abbrev; | |
620 | struct dwarf2_section_names line; | |
621 | struct dwarf2_section_names loc; | |
622 | struct dwarf2_section_names macinfo; | |
cf2c3c16 | 623 | struct dwarf2_section_names macro; |
251d32d9 TG |
624 | struct dwarf2_section_names str; |
625 | struct dwarf2_section_names ranges; | |
626 | struct dwarf2_section_names types; | |
3019eac3 | 627 | struct dwarf2_section_names addr; |
251d32d9 TG |
628 | struct dwarf2_section_names frame; |
629 | struct dwarf2_section_names eh_frame; | |
630 | struct dwarf2_section_names gdb_index; | |
24d3216f TT |
631 | /* This field has no meaning, but exists solely to catch changes to |
632 | this structure which are not reflected in some instance. */ | |
633 | int sentinel; | |
251d32d9 TG |
634 | }; |
635 | ||
636 | extern int dwarf2_has_info (struct objfile *, | |
637 | const struct dwarf2_debug_sections *); | |
c906108c | 638 | |
3017a003 TG |
639 | /* Dwarf2 sections that can be accessed by dwarf2_get_section_info. */ |
640 | enum dwarf2_section_enum { | |
641 | DWARF2_DEBUG_FRAME, | |
642 | DWARF2_EH_FRAME | |
643 | }; | |
644 | ||
645 | extern void dwarf2_get_section_info (struct objfile *, | |
646 | enum dwarf2_section_enum, | |
d521ce57 | 647 | asection **, const gdb_byte **, |
3017a003 TG |
648 | bfd_size_type *); |
649 | ||
9291a0cd | 650 | extern int dwarf2_initialize_objfile (struct objfile *); |
f29dff0a | 651 | extern void dwarf2_build_psymtabs (struct objfile *); |
b6af0555 | 652 | extern void dwarf2_build_frame_info (struct objfile *); |
d4f3574e | 653 | |
fe3e1990 DJ |
654 | void dwarf2_free_objfile (struct objfile *); |
655 | ||
c906108c SS |
656 | /* From mdebugread.c */ |
657 | ||
3a6c3343 AC |
658 | extern void mdebug_build_psymtabs (struct objfile *, |
659 | const struct ecoff_debug_swap *, | |
660 | struct ecoff_debug_info *); | |
661 | ||
662 | extern void elfmdebug_build_psymtabs (struct objfile *, | |
663 | const struct ecoff_debug_swap *, | |
664 | asection *); | |
c906108c | 665 | |
608e2dbb TT |
666 | /* From minidebug.c. */ |
667 | ||
668 | extern bfd *find_separate_debug_file_in_section (struct objfile *); | |
669 | ||
c5aa993b | 670 | #endif /* !defined(SYMFILE_H) */ |