1 /* Definitions for reading symbol files into GDB.
3 Copyright (C) 1990-2014 Free Software Foundation, Inc.
5 This file is part of GDB.
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 3 of the License, or
10 (at your option) any later version.
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.
17 You should have received a copy of the GNU General Public License
18 along with this program. If not, see <http://www.gnu.org/licenses/>. */
20 #if !defined (SYMFILE_H)
23 /* This file requires that you first include "bfd.h". */
27 /* Opaque declarations. */
28 struct target_section;
39 /* Comparison function for symbol look ups. */
41 typedef int (symbol_compare_ftype) (const char *string1,
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. */
52 struct psymbol_allocation_list
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. */
59 struct partial_symbol **list;
61 /* Pointer to next available slot in which to store a pointer to a
64 struct partial_symbol **next;
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
75 /* Define an array of addresses to accommodate non-contiguous dynamic
76 loading of modules. This is for use when entering commands, so we
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 (). */
82 struct section_addr_info
84 /* The number of sections for which address information is
87 /* Sections whose names are file format dependent. */
93 /* SECTINDEX must be valid for associated BFD or set to -1. */
99 /* A table listing the load segments in a symfile, and which segment
100 each BFD section belongs to. */
101 struct symfile_segment_data
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. */
108 /* If NUM_SEGMENTS is greater than zero, the original base address
110 CORE_ADDR *segment_bases;
112 /* If NUM_SEGMENTS is greater than zero, the memory size of each
114 CORE_ADDR *segment_sizes;
116 /* If NUM_SEGMENTS is greater than zero, this is an array of entries
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. */
123 /* Callback for quick_symbol_functions->map_symbol_filenames. */
125 typedef void (symbol_filename_ftype) (const char *filename,
126 const char *fullname, void *data);
128 /* Callback for quick_symbol_functions->expand_symtabs_matching
129 to match a file name. */
131 typedef int (expand_symtabs_file_matcher_ftype) (const char *filename,
132 void *data, int basenames);
134 /* Callback for quick_symbol_functions->expand_symtabs_matching
135 to match a symbol name. */
137 typedef int (expand_symtabs_symbol_matcher_ftype) (const char *name,
140 /* The "quick" symbol functions exist so that symbol readers can
141 avoiding an initial read of all the symbols. For example, symbol
142 readers might choose to use the "partial symbol table" utilities,
143 which is one implementation of the quick symbol functions.
145 The quick symbol functions are generally opaque: the underlying
146 representation is hidden from the caller.
148 In general, these functions should only look at whatever special
149 index the symbol reader creates -- looking through the symbol
150 tables themselves is handled by generic code. If a function is
151 defined as returning a "symbol table", this means that the function
152 should only return a newly-created symbol table; it should not
153 examine pre-existing ones.
155 The exact list of functions here was determined in an ad hoc way
156 based on gdb's history. */
158 struct quick_symbol_functions
160 /* Return true if this objfile has any "partial" symbols
162 int (*has_symbols) (struct objfile *objfile);
164 /* Return the symbol table for the "last" file appearing in
166 struct symtab *(*find_last_source_symtab) (struct objfile *objfile);
168 /* Forget all cached full file names for OBJFILE. */
169 void (*forget_cached_source_info) (struct objfile *objfile);
171 /* Expand and iterate over each "partial" symbol table in OBJFILE
172 where the source file is named NAME.
174 If NAME is not absolute, a match after a '/' in the symbol table's
175 file name will also work, REAL_PATH is NULL then. If NAME is
176 absolute then REAL_PATH is non-NULL absolute file name as resolved
177 via gdb_realpath from NAME.
179 If a match is found, the "partial" symbol table is expanded.
180 Then, this calls iterate_over_some_symtabs (or equivalent) over
181 all newly-created symbol tables, passing CALLBACK and DATA to it.
182 The result of this call is returned. */
183 int (*map_symtabs_matching_filename) (struct objfile *objfile,
185 const char *real_path,
186 int (*callback) (struct symtab *,
190 /* Check to see if the symbol is defined in a "partial" symbol table
191 of OBJFILE. KIND should be either GLOBAL_BLOCK or STATIC_BLOCK,
192 depending on whether we want to search global symbols or static
193 symbols. NAME is the name of the symbol to look for. DOMAIN
194 indicates what sort of symbol to search for.
196 Returns the newly-expanded symbol table in which the symbol is
197 defined, or NULL if no such symbol table exists. If OBJFILE
198 contains !TYPE_OPAQUE symbol prefer its symtab. If it contains
199 only TYPE_OPAQUE symbol(s), return at least that symtab. */
200 struct symtab *(*lookup_symbol) (struct objfile *objfile,
201 int kind, const char *name,
204 /* Print statistics about any indices loaded for OBJFILE. The
205 statistics should be printed to gdb_stdout. This is used for
206 "maint print statistics". */
207 void (*print_stats) (struct objfile *objfile);
209 /* Dump any indices loaded for OBJFILE. The dump should go to
210 gdb_stdout. This is used for "maint print objfiles". */
211 void (*dump) (struct objfile *objfile);
213 /* This is called by objfile_relocate to relocate any indices loaded
215 void (*relocate) (struct objfile *objfile,
216 const struct section_offsets *new_offsets,
217 const struct section_offsets *delta);
219 /* Find all the symbols in OBJFILE named FUNC_NAME, and ensure that
220 the corresponding symbol tables are loaded. */
221 void (*expand_symtabs_for_function) (struct objfile *objfile,
222 const char *func_name);
224 /* Read all symbol tables associated with OBJFILE. */
225 void (*expand_all_symtabs) (struct objfile *objfile);
227 /* Read all symbol tables associated with OBJFILE which have
228 symtab_to_fullname equal to FULLNAME.
229 This is for the purposes of examining code only, e.g., expand_line_sal.
230 The routine may ignore debug info that is known to not be useful with
231 code, e.g., DW_TAG_type_unit for dwarf debug info. */
232 void (*expand_symtabs_with_fullname) (struct objfile *objfile,
233 const char *fullname);
235 /* Find global or static symbols in all tables that are in NAMESPACE
236 and for which MATCH (symbol name, NAME) == 0, passing each to
237 CALLBACK, reading in partial symbol tables as needed. Look
238 through global symbols if GLOBAL and otherwise static symbols.
239 Passes NAME, NAMESPACE, and DATA to CALLBACK with each symbol
240 found. After each block is processed, passes NULL to CALLBACK.
241 MATCH must be weaker than strcmp_iw_ordered in the sense that
242 strcmp_iw_ordered(x,y) == 0 --> MATCH(x,y) == 0. ORDERED_COMPARE,
243 if non-null, must be an ordering relation compatible with
244 strcmp_iw_ordered in the sense that
245 strcmp_iw_ordered(x,y) == 0 --> ORDERED_COMPARE(x,y) == 0
247 strcmp_iw_ordered(x,y) <= 0 --> ORDERED_COMPARE(x,y) <= 0
248 (allowing strcmp_iw_ordered(x,y) < 0 while ORDERED_COMPARE(x, y) == 0).
249 CALLBACK returns 0 to indicate that the scan should continue, or
250 non-zero to indicate that the scan should be terminated. */
252 void (*map_matching_symbols) (struct objfile *,
253 const char *name, domain_enum namespace,
255 int (*callback) (struct block *,
256 struct symbol *, void *),
258 symbol_compare_ftype *match,
259 symbol_compare_ftype *ordered_compare);
261 /* Expand all symbol tables in OBJFILE matching some criteria.
263 FILE_MATCHER is called for each file in OBJFILE. The file name
264 and the DATA argument are passed to it. If it returns zero, this
265 file is skipped. If FILE_MATCHER is NULL such file is not skipped.
266 If BASENAMES is non-zero the function should consider only base name of
267 DATA (passed file name is already only the lbasename part).
269 Otherwise, if KIND does not match this symbol is skipped.
271 If even KIND matches, then SYMBOL_MATCHER is called for each symbol
272 defined in the file. The symbol "search" name and DATA are passed
275 If SYMBOL_MATCHER returns zero, then this symbol is skipped.
277 Otherwise, this symbol's symbol table is expanded.
279 DATA is user data that is passed unmodified to the callback
281 void (*expand_symtabs_matching)
282 (struct objfile *objfile,
283 expand_symtabs_file_matcher_ftype *file_matcher,
284 expand_symtabs_symbol_matcher_ftype *symbol_matcher,
285 enum search_domain kind,
288 /* Return the symbol table from OBJFILE that contains PC and
289 SECTION. Return NULL if there is no such symbol table. This
290 should return the symbol table that contains a symbol whose
291 address exactly matches PC, or, if there is no exact match, the
292 symbol table that contains a symbol whose address is closest to
294 struct symtab *(*find_pc_sect_symtab) (struct objfile *objfile,
295 struct minimal_symbol *msymbol,
297 struct obj_section *section,
300 /* Call a callback for every file defined in OBJFILE whose symtab is
301 not already read in. FUN is the callback. It is passed the file's
302 FILENAME, the file's FULLNAME (if need_fullname is non-zero), and
303 the DATA passed to this function. */
304 void (*map_symbol_filenames) (struct objfile *objfile,
305 symbol_filename_ftype *fun, void *data,
309 /* Structure of functions used for probe support. If one of these functions
310 is provided, all must be. */
314 /* If non-NULL, return an array of probe objects.
316 The returned value does not have to be freed and it has lifetime of the
318 VEC (probe_p) *(*sym_get_probes) (struct objfile *);
320 /* Relocate the probe section of OBJFILE. */
321 void (*sym_relocate_probe) (struct objfile *objfile,
322 const struct section_offsets *new_offsets,
323 const struct section_offsets *delta);
326 /* Structure to keep track of symbol reading functions for various
327 object file types. */
331 /* Initializes anything that is global to the entire symbol table.
332 It is called during symbol_file_add, when we begin debugging an
333 entirely new program. */
335 void (*sym_new_init) (struct objfile *);
337 /* Reads any initial information from a symbol file, and initializes
338 the struct sym_fns SF in preparation for sym_read(). It is
339 called every time we read a symbol file for any reason. */
341 void (*sym_init) (struct objfile *);
343 /* sym_read (objfile, symfile_flags) Reads a symbol file into a psymtab
344 (or possibly a symtab). OBJFILE is the objfile struct for the
345 file we are reading. SYMFILE_FLAGS are the flags passed to
346 symbol_file_add & co. */
348 void (*sym_read) (struct objfile *, int);
350 /* Read the partial symbols for an objfile. This may be NULL, in which case
351 gdb has to check other ways if this objfile has any symbols. This may
352 only be non-NULL if the objfile actually does have debuginfo available.
355 void (*sym_read_psymbols) (struct objfile *);
357 /* Called when we are finished with an objfile. Should do all
358 cleanup that is specific to the object file format for the
359 particular objfile. */
361 void (*sym_finish) (struct objfile *);
363 /* This function produces a file-dependent section_offsets
364 structure, allocated in the objfile's storage, and based on the
365 parameter. The parameter is currently a CORE_ADDR (FIXME!) for
366 backward compatibility with the higher levels of GDB. It should
367 probably be changed to a string, where NULL means the default,
368 and others are parsed in a file dependent way. */
370 void (*sym_offsets) (struct objfile *, const struct section_addr_info *);
372 /* This function produces a format-independent description of
373 the segments of ABFD. Each segment is a unit of the file
374 which may be relocated independently. */
376 struct symfile_segment_data *(*sym_segments) (bfd *abfd);
378 /* This function should read the linetable from the objfile when
379 the line table cannot be read while processing the debugging
382 void (*sym_read_linetable) (struct objfile *);
384 /* Relocate the contents of a debug section SECTP. The
385 contents are stored in BUF if it is non-NULL, or returned in a
386 malloc'd buffer otherwise. */
388 bfd_byte *(*sym_relocate) (struct objfile *, asection *sectp, bfd_byte *buf);
390 /* If non-NULL, this objfile has probe support, and all the probe
391 functions referred to here will be non-NULL. */
392 const struct sym_probe_fns *sym_probe_fns;
394 /* The "quick" (aka partial) symbol functions for this symbol
396 const struct quick_symbol_functions *qf;
399 extern struct section_addr_info *
400 build_section_addr_info_from_objfile (const struct objfile *objfile);
402 extern void relative_addr_info_to_section_offsets
403 (struct section_offsets *section_offsets, int num_sections,
404 const struct section_addr_info *addrs);
406 extern void addr_info_make_relative (struct section_addr_info *addrs,
409 /* The default version of sym_fns.sym_offsets for readers that don't
410 do anything special. */
412 extern void default_symfile_offsets (struct objfile *objfile,
413 const struct section_addr_info *);
415 /* The default version of sym_fns.sym_segments for readers that don't
416 do anything special. */
418 extern struct symfile_segment_data *default_symfile_segments (bfd *abfd);
420 /* The default version of sym_fns.sym_relocate for readers that don't
421 do anything special. */
423 extern bfd_byte *default_symfile_relocate (struct objfile *objfile,
424 asection *sectp, bfd_byte *buf);
426 extern struct symtab *allocate_symtab (const char *, struct objfile *)
427 ATTRIBUTE_NONNULL (1);
429 extern void add_symtab_fns (enum bfd_flavour flavour, const struct sym_fns *);
431 /* This enum encodes bit-flags passed as ADD_FLAGS parameter to
432 symbol_file_add, etc. */
434 enum symfile_add_flags
436 /* Be chatty about what you are doing. */
437 SYMFILE_VERBOSE = 1 << 1,
439 /* This is the main symbol file (as opposed to symbol file for dynamically
441 SYMFILE_MAINLINE = 1 << 2,
443 /* Do not call breakpoint_re_set when adding this symbol file. */
444 SYMFILE_DEFER_BP_RESET = 1 << 3,
446 /* Do not immediately read symbols for this file. By default,
447 symbols are read when the objfile is created. */
448 SYMFILE_NO_READ = 1 << 4
451 extern void new_symfile_objfile (struct objfile *, int);
453 extern struct objfile *symbol_file_add (const char *, int,
454 struct section_addr_info *, int);
456 extern struct objfile *symbol_file_add_from_bfd (bfd *, const char *, int,
457 struct section_addr_info *,
458 int, struct objfile *parent);
460 extern void symbol_file_add_separate (bfd *, const char *, int,
463 extern char *find_separate_debug_file_by_debuglink (struct objfile *);
465 /* Create a new section_addr_info, with room for NUM_SECTIONS. */
467 extern struct section_addr_info *alloc_section_addr_info (size_t
470 /* Build (allocate and populate) a section_addr_info struct from an
471 existing section table. */
473 extern struct section_addr_info
474 *build_section_addr_info_from_section_table (const struct target_section
476 const struct target_section
479 /* Free all memory allocated by
480 build_section_addr_info_from_section_table. */
482 extern void free_section_addr_info (struct section_addr_info *);
487 /* If non-zero, shared library symbols will be added automatically
488 when the inferior is created, new libraries are loaded, or when
489 attaching to the inferior. This is almost always what users will
490 want to have happen; but for very large programs, the startup time
491 will be excessive, and so if this is a problem, the user can clear
492 this flag and then add the shared library symbols as needed. Note
493 that there is a potential for confusion, since if the shared
494 library symbols are not loaded, commands like "info fun" will *not*
495 report all the functions that are actually present. */
497 extern int auto_solib_add;
501 extern void set_initial_language (void);
503 extern void find_lowest_section (bfd *, asection *, void *);
505 extern bfd *symfile_bfd_open (const char *);
507 extern bfd *gdb_bfd_open_maybe_remote (const char *);
509 extern int get_section_index (struct objfile *, char *);
511 /* Utility functions for overlay sections: */
512 extern enum overlay_debugging_state
518 extern int overlay_cache_invalid;
520 /* Return the "mapped" overlay section containing the PC. */
521 extern struct obj_section *find_pc_mapped_section (CORE_ADDR);
523 /* Return any overlay section containing the PC (even in its LMA
525 extern struct obj_section *find_pc_overlay (CORE_ADDR);
527 /* Return true if the section is an overlay. */
528 extern int section_is_overlay (struct obj_section *);
530 /* Return true if the overlay section is currently "mapped". */
531 extern int section_is_mapped (struct obj_section *);
533 /* Return true if pc belongs to section's VMA. */
534 extern CORE_ADDR pc_in_mapped_range (CORE_ADDR, struct obj_section *);
536 /* Return true if pc belongs to section's LMA. */
537 extern CORE_ADDR pc_in_unmapped_range (CORE_ADDR, struct obj_section *);
539 /* Map an address from a section's LMA to its VMA. */
540 extern CORE_ADDR overlay_mapped_address (CORE_ADDR, struct obj_section *);
542 /* Map an address from a section's VMA to its LMA. */
543 extern CORE_ADDR overlay_unmapped_address (CORE_ADDR, struct obj_section *);
545 /* Convert an address in an overlay section (force into VMA range). */
546 extern CORE_ADDR symbol_overlayed_address (CORE_ADDR, struct obj_section *);
548 /* Load symbols from a file. */
549 extern void symbol_file_add_main (const char *args, int from_tty);
551 /* Clear GDB symbol tables. */
552 extern void symbol_file_clear (int from_tty);
554 /* Default overlay update function. */
555 extern void simple_overlay_update (struct obj_section *);
557 extern bfd_byte *symfile_relocate_debug_section (struct objfile *, asection *,
560 extern int symfile_map_offsets_to_segments (bfd *,
561 const struct symfile_segment_data *,
562 struct section_offsets *,
563 int, const CORE_ADDR *);
564 struct symfile_segment_data *get_symfile_segment_data (bfd *abfd);
565 void free_symfile_segment_data (struct symfile_segment_data *data);
567 extern struct cleanup *increment_reading_symtab (void);
569 void expand_symtabs_matching (expand_symtabs_file_matcher_ftype *,
570 expand_symtabs_symbol_matcher_ftype *,
571 enum search_domain kind, void *data);
573 void map_symbol_filenames (symbol_filename_ftype *fun, void *data,
576 /* From dwarf2read.c */
578 /* Names for a dwarf2 debugging section. The field NORMAL is the normal
579 section name (usually from the DWARF standard), while the field COMPRESSED
580 is the name of compressed sections. If your object file format doesn't
581 support compressed sections, the field COMPRESSED can be NULL. Likewise,
582 the debugging section is not supported, the field NORMAL can be NULL too.
583 It doesn't make sense to have a NULL NORMAL field but a non-NULL COMPRESSED
586 struct dwarf2_section_names {
588 const char *compressed;
591 /* List of names for dward2 debugging sections. Also most object file formats
592 use the standardized (ie ELF) names, some (eg XCOFF) have customized names
594 The table for the standard names is defined in dwarf2read.c. Please
595 update all instances of dwarf2_debug_sections if you add a field to this
596 structure. It is always safe to use { NULL, NULL } in this case. */
598 struct dwarf2_debug_sections {
599 struct dwarf2_section_names info;
600 struct dwarf2_section_names abbrev;
601 struct dwarf2_section_names line;
602 struct dwarf2_section_names loc;
603 struct dwarf2_section_names macinfo;
604 struct dwarf2_section_names macro;
605 struct dwarf2_section_names str;
606 struct dwarf2_section_names ranges;
607 struct dwarf2_section_names types;
608 struct dwarf2_section_names addr;
609 struct dwarf2_section_names frame;
610 struct dwarf2_section_names eh_frame;
611 struct dwarf2_section_names gdb_index;
612 /* This field has no meaning, but exists solely to catch changes to
613 this structure which are not reflected in some instance. */
617 extern int dwarf2_has_info (struct objfile *,
618 const struct dwarf2_debug_sections *);
620 /* Dwarf2 sections that can be accessed by dwarf2_get_section_info. */
621 enum dwarf2_section_enum {
626 extern void dwarf2_get_section_info (struct objfile *,
627 enum dwarf2_section_enum,
628 asection **, const gdb_byte **,
631 extern int dwarf2_initialize_objfile (struct objfile *);
632 extern void dwarf2_build_psymtabs (struct objfile *);
633 extern void dwarf2_build_frame_info (struct objfile *);
635 void dwarf2_free_objfile (struct objfile *);
637 /* From mdebugread.c */
639 extern void mdebug_build_psymtabs (struct objfile *,
640 const struct ecoff_debug_swap *,
641 struct ecoff_debug_info *);
643 extern void elfmdebug_build_psymtabs (struct objfile *,
644 const struct ecoff_debug_swap *,
647 /* From minidebug.c. */
649 extern bfd *find_separate_debug_file_in_section (struct objfile *);
651 #endif /* !defined(SYMFILE_H) */