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, 2011
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 /* Comparison function for symbol look ups. */
37 typedef int (symbol_compare_ftype) (const char *string1,
40 /* Partial symbols are stored in the psymbol_cache and pointers to
41 them are kept in a dynamically grown array that is obtained from
42 malloc and grown as necessary via realloc. Each objfile typically
43 has two of these, one for global symbols and one for static
44 symbols. Although this adds a level of indirection for storing or
45 accessing the partial symbols, it allows us to throw away duplicate
46 psymbols and set all pointers to the single saved instance. */
48 struct psymbol_allocation_list
51 /* Pointer to beginning of dynamically allocated array of pointers
52 to partial symbols. The array is dynamically expanded as
53 necessary to accommodate more pointers. */
55 struct partial_symbol **list;
57 /* Pointer to next available slot in which to store a pointer to a
60 struct partial_symbol **next;
62 /* Number of allocated pointer slots in current dynamic array (not
63 the number of bytes of storage). The "next" pointer will always
64 point somewhere between list[0] and list[size], and when at
65 list[size] the array will be expanded on the next attempt to
71 /* Define an array of addresses to accommodate non-contiguous dynamic
72 loading of modules. This is for use when entering commands, so we
73 can keep track of the section names until we read the file and can
74 map them to bfd sections. This structure is also used by solib.c
75 to communicate the section addresses in shared objects to
76 symbol_file_add (). */
78 struct section_addr_info
80 /* The number of sections for which address information is
83 /* Sections whose names are file format dependent. */
89 /* SECTINDEX must be valid for associated BFD or set to -1. */
95 /* A table listing the load segments in a symfile, and which segment
96 each BFD section belongs to. */
97 struct symfile_segment_data
99 /* How many segments are present in this file. If there are
100 two, the text segment is the first one and the data segment
101 is the second one. */
104 /* If NUM_SEGMENTS is greater than zero, the original base address
106 CORE_ADDR *segment_bases;
108 /* If NUM_SEGMENTS is greater than zero, the memory size of each
110 CORE_ADDR *segment_sizes;
112 /* If NUM_SEGMENTS is greater than zero, this is an array of entries
113 recording which segment contains each BFD section.
114 SEGMENT_INFO[I] is S+1 if the I'th BFD section belongs to segment
115 S, or zero if it is not in any segment. */
119 /* Callback for quick_symbol_functions->map_symbol_filenames. */
121 typedef void (symbol_filename_ftype) (const char *filename,
122 const char *fullname, void *data);
124 /* The "quick" symbol functions exist so that symbol readers can
125 avoiding an initial read of all the symbols. For example, symbol
126 readers might choose to use the "partial symbol table" utilities,
127 which is one implementation of the quick symbol functions.
129 The quick symbol functions are generally opaque: the underlying
130 representation is hidden from the caller.
132 In general, these functions should only look at whatever special
133 index the symbol reader creates -- looking through the symbol
134 tables themselves is handled by generic code. If a function is
135 defined as returning a "symbol table", this means that the function
136 should only return a newly-created symbol table; it should not
137 examine pre-existing ones.
139 The exact list of functions here was determined in an ad hoc way
140 based on gdb's history. */
142 struct quick_symbol_functions
144 /* Return true if this objfile has any "partial" symbols
146 int (*has_symbols) (struct objfile *objfile);
148 /* Return the symbol table for the "last" file appearing in
150 struct symtab *(*find_last_source_symtab) (struct objfile *objfile);
152 /* Forget all cached full file names for OBJFILE. */
153 void (*forget_cached_source_info) (struct objfile *objfile);
155 /* Expand and iterate over each "partial" symbol table in OBJFILE
156 where the source file is named NAME.
158 If there is no '/' in the name, a match after a '/' in the symbol
159 table's file name will also work. FULL_PATH is the absolute file
160 name, and REAL_PATH is the same, run through gdb_realpath.
162 If a match is found, the "partial" symbol table is expanded.
163 Then, this calls iterate_over_some_symtabs (or equivalent) over
164 all newly-created symbol tables, passing CALLBACK and DATA to it.
165 The result of this call is returned. */
166 int (*map_symtabs_matching_filename) (struct objfile *objfile,
168 const char *full_path,
169 const char *real_path,
170 int (*callback) (struct symtab *,
174 /* Check to see if the symbol is defined in a "partial" symbol table
175 of OBJFILE. KIND should be either GLOBAL_BLOCK or STATIC_BLOCK,
176 depending on whether we want to search global symbols or static
177 symbols. NAME is the name of the symbol to look for. DOMAIN
178 indicates what sort of symbol to search for.
180 Returns the newly-expanded symbol table in which the symbol is
181 defined, or NULL if no such symbol table exists. */
182 struct symtab *(*lookup_symbol) (struct objfile *objfile,
183 int kind, const char *name,
186 /* This is called to expand symbol tables before looking up a
187 symbol. A backend can choose to implement this and then have its
188 `lookup_symbol' hook always return NULL, or the reverse. (It
189 doesn't make sense to implement both.) The arguments are as for
191 void (*pre_expand_symtabs_matching) (struct objfile *objfile,
192 enum block_enum block_kind,
196 /* Print statistics about any indices loaded for OBJFILE. The
197 statistics should be printed to gdb_stdout. This is used for
198 "maint print statistics". */
199 void (*print_stats) (struct objfile *objfile);
201 /* Dump any indices loaded for OBJFILE. The dump should go to
202 gdb_stdout. This is used for "maint print objfiles". */
203 void (*dump) (struct objfile *objfile);
205 /* This is called by objfile_relocate to relocate any indices loaded
207 void (*relocate) (struct objfile *objfile,
208 struct section_offsets *new_offsets,
209 struct section_offsets *delta);
211 /* Find all the symbols in OBJFILE named FUNC_NAME, and ensure that
212 the corresponding symbol tables are loaded. */
213 void (*expand_symtabs_for_function) (struct objfile *objfile,
214 const char *func_name);
216 /* Read all symbol tables associated with OBJFILE. */
217 void (*expand_all_symtabs) (struct objfile *objfile);
219 /* Read all symbol tables associated with OBJFILE which have the
221 This is for the purposes of examining code only, e.g., expand_line_sal.
222 The routine may ignore debug info that is known to not be useful with
223 code, e.g., DW_TAG_type_unit for dwarf debug info. */
224 void (*expand_symtabs_with_filename) (struct objfile *objfile,
225 const char *filename);
227 /* Return the file name of the file holding the global symbol in OBJFILE
228 named NAME. If no such symbol exists in OBJFILE, return NULL. */
229 const char *(*find_symbol_file) (struct objfile *objfile, const char *name);
231 /* Find global or static symbols in all tables that are in NAMESPACE
232 and for which MATCH (symbol name, NAME) == 0, passing each to
233 CALLBACK, reading in partial symbol tables as needed. Look
234 through global symbols if GLOBAL and otherwise static symbols.
235 Passes NAME, NAMESPACE, and DATA to CALLBACK with each symbol
236 found. After each block is processed, passes NULL to CALLBACK.
237 MATCH must be weaker than strcmp_iw_ordered in the sense that
238 strcmp_iw_ordered(x,y) == 0 --> MATCH(x,y) == 0. ORDERED_COMPARE,
239 if non-null, must be an ordering relation compatible with
240 strcmp_iw_ordered in the sense that
241 strcmp_iw_ordered(x,y) == 0 --> ORDERED_COMPARE(x,y) == 0
243 strcmp_iw_ordered(x,y) <= 0 --> ORDERED_COMPARE(x,y) <= 0
244 (allowing strcmp_iw_ordered(x,y) < 0 while ORDERED_COMPARE(x, y) == 0).
245 CALLBACK returns 0 to indicate that the scan should continue, or
246 non-zero to indicate that the scan should be terminated. */
248 void (*map_matching_symbols) (const char *name, domain_enum namespace,
249 struct objfile *, int global,
250 int (*callback) (struct block *,
251 struct symbol *, void *),
253 symbol_compare_ftype *match,
254 symbol_compare_ftype *ordered_compare);
256 /* Expand all symbol tables in OBJFILE matching some criteria.
258 FILE_MATCHER is called for each file in OBJFILE. The file name
259 and the DATA argument are passed to it. If it returns zero, this
260 file is skipped. If FILE_MATCHER is NULL such file is not skipped.
262 Otherwise, if KIND does not match this symbol is skipped.
264 If even KIND matches, then NAME_MATCHER is called for each symbol
265 defined in the file. The current language, the symbol name and
266 DATA are passed to NAME_MATCHER. The symbol "search" name should
267 be passed to NAME_MATCHER (see la_symbol_name_compare in struct
268 language_defn for more details on this).
270 If NAME_MATCHER returns zero, then this symbol is skipped.
272 Otherwise, this symbol's symbol table is expanded.
274 DATA is user data that is passed unmodified to the callback
276 void (*expand_symtabs_matching)
277 (struct objfile *objfile,
278 int (*file_matcher) (const char *, void *),
279 int (*name_matcher) (const struct language_defn *, const char *, void *),
280 enum search_domain kind,
283 /* Return the symbol table from OBJFILE that contains PC and
284 SECTION. Return NULL if there is no such symbol table. This
285 should return the symbol table that contains a symbol whose
286 address exactly matches PC, or, if there is no exact match, the
287 symbol table that contains a symbol whose address is closest to
289 struct symtab *(*find_pc_sect_symtab) (struct objfile *objfile,
290 struct minimal_symbol *msymbol,
292 struct obj_section *section,
295 /* Call a callback for every file defined in OBJFILE whose symtab is
296 not already read in. FUN is the callback. It is passed the file's
297 FILENAME, the file's FULLNAME (if need_fullname is non-zero), and
298 the DATA passed to this function. */
299 void (*map_symbol_filenames) (struct objfile *objfile,
300 symbol_filename_ftype *fun, void *data,
304 /* Structure to keep track of symbol reading functions for various
305 object file types. */
310 /* BFD flavour that we handle, or (as a special kludge, see
311 xcoffread.c, (enum bfd_flavour)-1 for xcoff). */
313 enum bfd_flavour sym_flavour;
315 /* Initializes anything that is global to the entire symbol table.
316 It is called during symbol_file_add, when we begin debugging an
317 entirely new program. */
319 void (*sym_new_init) (struct objfile *);
321 /* Reads any initial information from a symbol file, and initializes
322 the struct sym_fns SF in preparation for sym_read(). It is
323 called every time we read a symbol file for any reason. */
325 void (*sym_init) (struct objfile *);
327 /* sym_read (objfile, symfile_flags) Reads a symbol file into a psymtab
328 (or possibly a symtab). OBJFILE is the objfile struct for the
329 file we are reading. SYMFILE_FLAGS are the flags passed to
330 symbol_file_add & co. */
332 void (*sym_read) (struct objfile *, int);
334 /* Read the partial symbols for an objfile. This may be NULL, in which case
335 gdb has to check other ways if this objfile has any symbols. This may
336 only be non-NULL if the objfile actually does have debuginfo available.
339 void (*sym_read_psymbols) (struct objfile *);
341 /* Called when we are finished with an objfile. Should do all
342 cleanup that is specific to the object file format for the
343 particular objfile. */
345 void (*sym_finish) (struct objfile *);
347 /* This function produces a file-dependent section_offsets
348 structure, allocated in the objfile's storage, and based on the
349 parameter. The parameter is currently a CORE_ADDR (FIXME!) for
350 backward compatibility with the higher levels of GDB. It should
351 probably be changed to a string, where NULL means the default,
352 and others are parsed in a file dependent way. */
354 void (*sym_offsets) (struct objfile *, struct section_addr_info *);
356 /* This function produces a format-independent description of
357 the segments of ABFD. Each segment is a unit of the file
358 which may be relocated independently. */
360 struct symfile_segment_data *(*sym_segments) (bfd *abfd);
362 /* This function should read the linetable from the objfile when
363 the line table cannot be read while processing the debugging
366 void (*sym_read_linetable) (void);
368 /* Relocate the contents of a debug section SECTP. The
369 contents are stored in BUF if it is non-NULL, or returned in a
370 malloc'd buffer otherwise. */
372 bfd_byte *(*sym_relocate) (struct objfile *, asection *sectp, bfd_byte *buf);
374 /* The "quick" (aka partial) symbol functions for this symbol
376 const struct quick_symbol_functions *qf;
379 extern struct section_addr_info *
380 build_section_addr_info_from_objfile (const struct objfile *objfile);
382 extern void relative_addr_info_to_section_offsets
383 (struct section_offsets *section_offsets, int num_sections,
384 struct section_addr_info *addrs);
386 extern void addr_info_make_relative (struct section_addr_info *addrs,
389 /* The default version of sym_fns.sym_offsets for readers that don't
390 do anything special. */
392 extern void default_symfile_offsets (struct objfile *objfile,
393 struct section_addr_info *);
395 /* The default version of sym_fns.sym_segments for readers that don't
396 do anything special. */
398 extern struct symfile_segment_data *default_symfile_segments (bfd *abfd);
400 /* The default version of sym_fns.sym_relocate for readers that don't
401 do anything special. */
403 extern bfd_byte *default_symfile_relocate (struct objfile *objfile,
404 asection *sectp, bfd_byte *buf);
406 extern struct symtab *allocate_symtab (const char *, struct objfile *);
408 extern void add_symtab_fns (const struct sym_fns *);
410 /* This enum encodes bit-flags passed as ADD_FLAGS parameter to
411 syms_from_objfile, symbol_file_add, etc. */
413 enum symfile_add_flags
415 /* Be chatty about what you are doing. */
416 SYMFILE_VERBOSE = 1 << 1,
418 /* This is the main symbol file (as opposed to symbol file for dynamically
420 SYMFILE_MAINLINE = 1 << 2,
422 /* Do not call breakpoint_re_set when adding this symbol file. */
423 SYMFILE_DEFER_BP_RESET = 1 << 3,
425 /* Do not immediately read symbols for this file. By default,
426 symbols are read when the objfile is created. */
427 SYMFILE_NO_READ = 1 << 4
430 extern void syms_from_objfile (struct objfile *,
431 struct section_addr_info *,
432 struct section_offsets *, int, int);
434 extern void new_symfile_objfile (struct objfile *, int);
436 extern struct objfile *symbol_file_add (char *, int,
437 struct section_addr_info *, int);
439 extern struct objfile *symbol_file_add_from_bfd (bfd *, int,
440 struct section_addr_info *,
441 int, struct objfile *parent);
443 extern void symbol_file_add_separate (bfd *, int, struct objfile *);
445 extern char *find_separate_debug_file_by_debuglink (struct objfile *);
447 /* Create a new section_addr_info, with room for NUM_SECTIONS. */
449 extern struct section_addr_info *alloc_section_addr_info (size_t
452 /* Build (allocate and populate) a section_addr_info struct from an
453 existing section table. */
455 extern struct section_addr_info
456 *build_section_addr_info_from_section_table (const struct target_section
458 const struct target_section
461 /* Free all memory allocated by
462 build_section_addr_info_from_section_table. */
464 extern void free_section_addr_info (struct section_addr_info *);
467 /* Make a copy of the string at PTR with SIZE characters in the symbol
468 obstack (and add a null character at the end in the copy). Returns
469 the address of the copy. */
471 extern char *obsavestring (const char *, int, struct obstack *);
473 /* Concatenate NULL terminated variable argument list of `const char
474 *' strings; return the new string. Space is found in the OBSTACKP.
475 Argument list must be terminated by a sentinel expression `(char *)
478 extern char *obconcat (struct obstack *obstackp, ...) ATTRIBUTE_SENTINEL;
482 /* If non-zero, shared library symbols will be added automatically
483 when the inferior is created, new libraries are loaded, or when
484 attaching to the inferior. This is almost always what users will
485 want to have happen; but for very large programs, the startup time
486 will be excessive, and so if this is a problem, the user can clear
487 this flag and then add the shared library symbols as needed. Note
488 that there is a potential for confusion, since if the shared
489 library symbols are not loaded, commands like "info fun" will *not*
490 report all the functions that are actually present. */
492 extern int auto_solib_add;
496 extern void set_initial_language (void);
498 extern void find_lowest_section (bfd *, asection *, void *);
500 extern bfd *symfile_bfd_open (char *);
502 extern bfd *bfd_open_maybe_remote (const char *);
504 extern int get_section_index (struct objfile *, char *);
506 /* Utility functions for overlay sections: */
507 extern enum overlay_debugging_state
513 extern int overlay_cache_invalid;
515 /* Return the "mapped" overlay section containing the PC. */
516 extern struct obj_section *find_pc_mapped_section (CORE_ADDR);
518 /* Return any overlay section containing the PC (even in its LMA
520 extern struct obj_section *find_pc_overlay (CORE_ADDR);
522 /* Return true if the section is an overlay. */
523 extern int section_is_overlay (struct obj_section *);
525 /* Return true if the overlay section is currently "mapped". */
526 extern int section_is_mapped (struct obj_section *);
528 /* Return true if pc belongs to section's VMA. */
529 extern CORE_ADDR pc_in_mapped_range (CORE_ADDR, struct obj_section *);
531 /* Return true if pc belongs to section's LMA. */
532 extern CORE_ADDR pc_in_unmapped_range (CORE_ADDR, struct obj_section *);
534 /* Map an address from a section's LMA to its VMA. */
535 extern CORE_ADDR overlay_mapped_address (CORE_ADDR, struct obj_section *);
537 /* Map an address from a section's VMA to its LMA. */
538 extern CORE_ADDR overlay_unmapped_address (CORE_ADDR, struct obj_section *);
540 /* Convert an address in an overlay section (force into VMA range). */
541 extern CORE_ADDR symbol_overlayed_address (CORE_ADDR, struct obj_section *);
543 /* Load symbols from a file. */
544 extern void symbol_file_add_main (char *args, int from_tty);
546 /* Clear GDB symbol tables. */
547 extern void symbol_file_clear (int from_tty);
549 /* Default overlay update function. */
550 extern void simple_overlay_update (struct obj_section *);
552 extern bfd_byte *symfile_relocate_debug_section (struct objfile *, asection *,
555 extern int symfile_map_offsets_to_segments (bfd *,
556 struct symfile_segment_data *,
557 struct section_offsets *,
558 int, const CORE_ADDR *);
559 struct symfile_segment_data *get_symfile_segment_data (bfd *abfd);
560 void free_symfile_segment_data (struct symfile_segment_data *data);
562 extern struct cleanup *increment_reading_symtab (void);
564 /* From dwarf2read.c */
566 /* Names for a dwarf2 debugging section. The field NORMAL is the normal
567 section name (usually from the DWARF standard), while the field COMPRESSED
568 is the name of compressed sections. If your object file format doesn't
569 support compressed sections, the field COMPRESSED can be NULL. Likewise,
570 the debugging section is not supported, the field NORMAL can be NULL too.
571 It doesn't make sense to have a NULL NORMAL field but a non-NULL COMPRESSED
574 struct dwarf2_section_names {
576 const char *compressed;
579 /* List of names for dward2 debugging sections. Also most object file formats
580 use the standardized (ie ELF) names, some (eg XCOFF) have customized names
582 The table for the standard names is defined in dwarf2read.c. Please
583 update all instances of dwarf2_debug_sections if you add a field to this
584 structure. It is always safe to use { NULL, NULL } in this case. */
586 struct dwarf2_debug_sections {
587 struct dwarf2_section_names info;
588 struct dwarf2_section_names abbrev;
589 struct dwarf2_section_names line;
590 struct dwarf2_section_names loc;
591 struct dwarf2_section_names macinfo;
592 struct dwarf2_section_names macro;
593 struct dwarf2_section_names str;
594 struct dwarf2_section_names ranges;
595 struct dwarf2_section_names types;
596 struct dwarf2_section_names frame;
597 struct dwarf2_section_names eh_frame;
598 struct dwarf2_section_names gdb_index;
599 /* This field has no meaning, but exists solely to catch changes to
600 this structure which are not reflected in some instance. */
604 extern int dwarf2_has_info (struct objfile *,
605 const struct dwarf2_debug_sections *);
607 /* Dwarf2 sections that can be accessed by dwarf2_get_section_info. */
608 enum dwarf2_section_enum {
613 extern void dwarf2_get_section_info (struct objfile *,
614 enum dwarf2_section_enum,
615 asection **, gdb_byte **,
618 extern int dwarf2_initialize_objfile (struct objfile *);
619 extern void dwarf2_build_psymtabs (struct objfile *);
620 extern void dwarf2_build_frame_info (struct objfile *);
622 void dwarf2_free_objfile (struct objfile *);
624 /* From mdebugread.c */
626 /* Hack to force structures to exist before use in parameter list. */
627 struct ecoff_debug_hack
629 struct ecoff_debug_swap *a;
630 struct ecoff_debug_info *b;
633 extern void mdebug_build_psymtabs (struct objfile *,
634 const struct ecoff_debug_swap *,
635 struct ecoff_debug_info *);
637 extern void elfmdebug_build_psymtabs (struct objfile *,
638 const struct ecoff_debug_swap *,
641 #endif /* !defined(SYMFILE_H) */