1 /* Definitions for reading symbol files into GDB.
3 Copyright (C) 1990-2017 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". */
26 #include "symfile-add-flags.h"
27 #include "objfile-flags.h"
29 #include "common/function-view.h"
31 /* Opaque declarations. */
32 struct target_section;
43 /* Comparison function for symbol look ups. */
45 typedef int (symbol_compare_ftype) (const char *string1,
48 /* Partial symbols are stored in the psymbol_cache and pointers to
49 them are kept in a dynamically grown array that is obtained from
50 malloc and grown as necessary via realloc. Each objfile typically
51 has two of these, one for global symbols and one for static
52 symbols. Although this adds a level of indirection for storing or
53 accessing the partial symbols, it allows us to throw away duplicate
54 psymbols and set all pointers to the single saved instance. */
56 struct psymbol_allocation_list
59 /* Pointer to beginning of dynamically allocated array of pointers
60 to partial symbols. The array is dynamically expanded as
61 necessary to accommodate more pointers. */
63 struct partial_symbol **list;
65 /* Pointer to next available slot in which to store a pointer to a
68 struct partial_symbol **next;
70 /* Number of allocated pointer slots in current dynamic array (not
71 the number of bytes of storage). The "next" pointer will always
72 point somewhere between list[0] and list[size], and when at
73 list[size] the array will be expanded on the next attempt to
84 /* SECTINDEX must be valid for associated BFD or set to -1. */
88 /* Define an array of addresses to accommodate non-contiguous dynamic
89 loading of modules. This is for use when entering commands, so we
90 can keep track of the section names until we read the file and can
91 map them to bfd sections. This structure is also used by solib.c
92 to communicate the section addresses in shared objects to
93 symbol_file_add (). */
95 struct section_addr_info
97 /* The number of sections for which address information is
100 /* Sections whose names are file format dependent. */
101 struct other_sections other[1];
105 /* A table listing the load segments in a symfile, and which segment
106 each BFD section belongs to. */
107 struct symfile_segment_data
109 /* How many segments are present in this file. If there are
110 two, the text segment is the first one and the data segment
111 is the second one. */
114 /* If NUM_SEGMENTS is greater than zero, the original base address
116 CORE_ADDR *segment_bases;
118 /* If NUM_SEGMENTS is greater than zero, the memory size of each
120 CORE_ADDR *segment_sizes;
122 /* If NUM_SEGMENTS is greater than zero, this is an array of entries
123 recording which segment contains each BFD section.
124 SEGMENT_INFO[I] is S+1 if the I'th BFD section belongs to segment
125 S, or zero if it is not in any segment. */
129 /* Callback for quick_symbol_functions->map_symbol_filenames. */
131 typedef void (symbol_filename_ftype) (const char *filename,
132 const char *fullname, void *data);
134 /* Callback for quick_symbol_functions->expand_symtabs_matching
135 to match a file name. */
137 typedef bool (expand_symtabs_file_matcher_ftype) (const char *filename,
140 /* Callback for quick_symbol_functions->expand_symtabs_matching
141 to match a symbol name. */
143 typedef bool (expand_symtabs_symbol_matcher_ftype) (const char *name);
145 /* Callback for quick_symbol_functions->expand_symtabs_matching
146 to be called after a symtab has been expanded. */
148 typedef void (expand_symtabs_exp_notify_ftype) (compunit_symtab *symtab);
150 /* The "quick" symbol functions exist so that symbol readers can
151 avoiding an initial read of all the symbols. For example, symbol
152 readers might choose to use the "partial symbol table" utilities,
153 which is one implementation of the quick symbol functions.
155 The quick symbol functions are generally opaque: the underlying
156 representation is hidden from the caller.
158 In general, these functions should only look at whatever special
159 index the symbol reader creates -- looking through the symbol
160 tables themselves is handled by generic code. If a function is
161 defined as returning a "symbol table", this means that the function
162 should only return a newly-created symbol table; it should not
163 examine pre-existing ones.
165 The exact list of functions here was determined in an ad hoc way
166 based on gdb's history. */
168 struct quick_symbol_functions
170 /* Return true if this objfile has any "partial" symbols
172 int (*has_symbols) (struct objfile *objfile);
174 /* Return the symbol table for the "last" file appearing in
176 struct symtab *(*find_last_source_symtab) (struct objfile *objfile);
178 /* Forget all cached full file names for OBJFILE. */
179 void (*forget_cached_source_info) (struct objfile *objfile);
181 /* Expand and iterate over each "partial" symbol table in OBJFILE
182 where the source file is named NAME.
184 If NAME is not absolute, a match after a '/' in the symbol table's
185 file name will also work, REAL_PATH is NULL then. If NAME is
186 absolute then REAL_PATH is non-NULL absolute file name as resolved
187 via gdb_realpath from NAME.
189 If a match is found, the "partial" symbol table is expanded.
190 Then, this calls iterate_over_some_symtabs (or equivalent) over
191 all newly-created symbol tables, passing CALLBACK to it.
192 The result of this call is returned. */
193 bool (*map_symtabs_matching_filename)
194 (struct objfile *objfile, const char *name, const char *real_path,
195 gdb::function_view<bool (symtab *)> callback);
197 /* Check to see if the symbol is defined in a "partial" symbol table
198 of OBJFILE. BLOCK_INDEX should be either GLOBAL_BLOCK or STATIC_BLOCK,
199 depending on whether we want to search global symbols or static
200 symbols. NAME is the name of the symbol to look for. DOMAIN
201 indicates what sort of symbol to search for.
203 Returns the newly-expanded compunit in which the symbol is
204 defined, or NULL if no such symbol table exists. If OBJFILE
205 contains !TYPE_OPAQUE symbol prefer its compunit. If it contains
206 only TYPE_OPAQUE symbol(s), return at least that compunit. */
207 struct compunit_symtab *(*lookup_symbol) (struct objfile *objfile,
208 int block_index, const char *name,
211 /* Print statistics about any indices loaded for OBJFILE. The
212 statistics should be printed to gdb_stdout. This is used for
213 "maint print statistics". */
214 void (*print_stats) (struct objfile *objfile);
216 /* Dump any indices loaded for OBJFILE. The dump should go to
217 gdb_stdout. This is used for "maint print objfiles". */
218 void (*dump) (struct objfile *objfile);
220 /* This is called by objfile_relocate to relocate any indices loaded
222 void (*relocate) (struct objfile *objfile,
223 const struct section_offsets *new_offsets,
224 const struct section_offsets *delta);
226 /* Find all the symbols in OBJFILE named FUNC_NAME, and ensure that
227 the corresponding symbol tables are loaded. */
228 void (*expand_symtabs_for_function) (struct objfile *objfile,
229 const char *func_name);
231 /* Read all symbol tables associated with OBJFILE. */
232 void (*expand_all_symtabs) (struct objfile *objfile);
234 /* Read all symbol tables associated with OBJFILE which have
235 symtab_to_fullname equal to FULLNAME.
236 This is for the purposes of examining code only, e.g., expand_line_sal.
237 The routine may ignore debug info that is known to not be useful with
238 code, e.g., DW_TAG_type_unit for dwarf debug info. */
239 void (*expand_symtabs_with_fullname) (struct objfile *objfile,
240 const char *fullname);
242 /* Find global or static symbols in all tables that are in DOMAIN
243 and for which MATCH (symbol name, NAME) == 0, passing each to
244 CALLBACK, reading in partial symbol tables as needed. Look
245 through global symbols if GLOBAL and otherwise static symbols.
246 Passes NAME, NAMESPACE, and DATA to CALLBACK with each symbol
247 found. After each block is processed, passes NULL to CALLBACK.
248 MATCH must be weaker than strcmp_iw_ordered in the sense that
249 strcmp_iw_ordered(x,y) == 0 --> MATCH(x,y) == 0. ORDERED_COMPARE,
250 if non-null, must be an ordering relation compatible with
251 strcmp_iw_ordered in the sense that
252 strcmp_iw_ordered(x,y) == 0 --> ORDERED_COMPARE(x,y) == 0
254 strcmp_iw_ordered(x,y) <= 0 --> ORDERED_COMPARE(x,y) <= 0
255 (allowing strcmp_iw_ordered(x,y) < 0 while ORDERED_COMPARE(x, y) == 0).
256 CALLBACK returns 0 to indicate that the scan should continue, or
257 non-zero to indicate that the scan should be terminated. */
259 void (*map_matching_symbols) (struct objfile *,
260 const char *name, domain_enum domain,
262 int (*callback) (struct block *,
263 struct symbol *, void *),
265 symbol_compare_ftype *match,
266 symbol_compare_ftype *ordered_compare);
268 /* Expand all symbol tables in OBJFILE matching some criteria.
270 FILE_MATCHER is called for each file in OBJFILE. The file name
271 is passed to it. If the matcher returns false, the file is
272 skipped. If FILE_MATCHER is NULL the file is not skipped. If
273 BASENAMES is true the matcher should consider only file base
274 names (the passed file name is already only the lbasename'd
277 Otherwise, if KIND does not match, this symbol is skipped.
279 If even KIND matches, SYMBOL_MATCHER is called for each symbol
280 defined in the file. The symbol "search" name is passed to
283 If SYMBOL_MATCHER returns false, then the symbol is skipped.
285 Otherwise, the symbol's symbol table is expanded. */
286 void (*expand_symtabs_matching)
287 (struct objfile *objfile,
288 gdb::function_view<expand_symtabs_file_matcher_ftype> file_matcher,
289 gdb::function_view<expand_symtabs_symbol_matcher_ftype> symbol_matcher,
290 gdb::function_view<expand_symtabs_exp_notify_ftype> expansion_notify,
291 enum search_domain kind);
293 /* Return the comp unit from OBJFILE that contains PC and
294 SECTION. Return NULL if there is no such compunit. This
295 should return the compunit that contains a symbol whose
296 address exactly matches PC, or, if there is no exact match, the
297 compunit that contains a symbol whose address is closest to
299 struct compunit_symtab *(*find_pc_sect_compunit_symtab)
300 (struct objfile *objfile, struct bound_minimal_symbol msymbol,
301 CORE_ADDR pc, struct obj_section *section, int warn_if_readin);
303 /* Call a callback for every file defined in OBJFILE whose symtab is
304 not already read in. FUN is the callback. It is passed the file's
305 FILENAME, the file's FULLNAME (if need_fullname is non-zero), and
306 the DATA passed to this function. */
307 void (*map_symbol_filenames) (struct objfile *objfile,
308 symbol_filename_ftype *fun, void *data,
312 /* Structure of functions used for probe support. If one of these functions
313 is provided, all must be. */
317 /* If non-NULL, return an array of probe objects.
319 The returned value does not have to be freed and it has lifetime of the
321 VEC (probe_p) *(*sym_get_probes) (struct objfile *);
324 /* Structure to keep track of symbol reading functions for various
325 object file types. */
329 /* Initializes anything that is global to the entire symbol table.
330 It is called during symbol_file_add, when we begin debugging an
331 entirely new program. */
333 void (*sym_new_init) (struct objfile *);
335 /* Reads any initial information from a symbol file, and initializes
336 the struct sym_fns SF in preparation for sym_read(). It is
337 called every time we read a symbol file for any reason. */
339 void (*sym_init) (struct objfile *);
341 /* sym_read (objfile, symfile_flags) Reads a symbol file into a psymtab
342 (or possibly a symtab). OBJFILE is the objfile struct for the
343 file we are reading. SYMFILE_FLAGS are the flags passed to
344 symbol_file_add & co. */
346 void (*sym_read) (struct objfile *, symfile_add_flags);
348 /* Read the partial symbols for an objfile. This may be NULL, in which case
349 gdb has to check other ways if this objfile has any symbols. This may
350 only be non-NULL if the objfile actually does have debuginfo available.
353 void (*sym_read_psymbols) (struct objfile *);
355 /* Called when we are finished with an objfile. Should do all
356 cleanup that is specific to the object file format for the
357 particular objfile. */
359 void (*sym_finish) (struct objfile *);
362 /* This function produces a file-dependent section_offsets
363 structure, allocated in the objfile's storage.
365 The section_addr_info structure contains the offset of loadable and
366 allocated sections, relative to the absolute offsets found in the BFD. */
368 void (*sym_offsets) (struct objfile *, const struct section_addr_info *);
370 /* This function produces a format-independent description of
371 the segments of ABFD. Each segment is a unit of the file
372 which may be relocated independently. */
374 struct symfile_segment_data *(*sym_segments) (bfd *abfd);
376 /* This function should read the linetable from the objfile when
377 the line table cannot be read while processing the debugging
380 void (*sym_read_linetable) (struct objfile *);
382 /* Relocate the contents of a debug section SECTP. The
383 contents are stored in BUF if it is non-NULL, or returned in a
384 malloc'd buffer otherwise. */
386 bfd_byte *(*sym_relocate) (struct objfile *, asection *sectp, bfd_byte *buf);
388 /* If non-NULL, this objfile has probe support, and all the probe
389 functions referred to here will be non-NULL. */
390 const struct sym_probe_fns *sym_probe_fns;
392 /* The "quick" (aka partial) symbol functions for this symbol
394 const struct quick_symbol_functions *qf;
397 extern struct section_addr_info *
398 build_section_addr_info_from_objfile (const struct objfile *objfile);
400 extern void relative_addr_info_to_section_offsets
401 (struct section_offsets *section_offsets, int num_sections,
402 const struct section_addr_info *addrs);
404 extern void addr_info_make_relative (struct section_addr_info *addrs,
407 /* The default version of sym_fns.sym_offsets for readers that don't
408 do anything special. */
410 extern void default_symfile_offsets (struct objfile *objfile,
411 const struct section_addr_info *);
413 /* The default version of sym_fns.sym_segments for readers that don't
414 do anything special. */
416 extern struct symfile_segment_data *default_symfile_segments (bfd *abfd);
418 /* The default version of sym_fns.sym_relocate for readers that don't
419 do anything special. */
421 extern bfd_byte *default_symfile_relocate (struct objfile *objfile,
422 asection *sectp, bfd_byte *buf);
424 extern struct symtab *allocate_symtab (struct compunit_symtab *, const char *)
425 ATTRIBUTE_NONNULL (1);
427 extern struct compunit_symtab *allocate_compunit_symtab (struct objfile *,
429 ATTRIBUTE_NONNULL (1);
431 extern void add_compunit_symtab_to_objfile (struct compunit_symtab *cu);
433 extern void add_symtab_fns (enum bfd_flavour flavour, const struct sym_fns *);
435 extern void clear_symtab_users (symfile_add_flags add_flags);
437 extern enum language deduce_language_from_filename (const char *);
439 /* Map the filename extension EXT to the language LANG. Any previous
440 association of EXT will be removed. EXT will be copied by this
442 extern void add_filename_language (const char *ext, enum language lang);
444 extern struct objfile *symbol_file_add (const char *, symfile_add_flags,
445 struct section_addr_info *, objfile_flags);
447 extern struct objfile *symbol_file_add_from_bfd (bfd *, const char *, symfile_add_flags,
448 struct section_addr_info *,
449 objfile_flags, struct objfile *parent);
451 extern void symbol_file_add_separate (bfd *, const char *, symfile_add_flags,
454 extern char *find_separate_debug_file_by_debuglink (struct objfile *);
456 /* Create a new section_addr_info, with room for NUM_SECTIONS. */
458 extern struct section_addr_info *alloc_section_addr_info (size_t
461 /* Build (allocate and populate) a section_addr_info struct from an
462 existing section table. */
464 extern struct section_addr_info
465 *build_section_addr_info_from_section_table (const struct target_section
467 const struct target_section
470 /* Free all memory allocated by
471 build_section_addr_info_from_section_table. */
473 extern void free_section_addr_info (struct section_addr_info *);
478 /* If non-zero, shared library symbols will be added automatically
479 when the inferior is created, new libraries are loaded, or when
480 attaching to the inferior. This is almost always what users will
481 want to have happen; but for very large programs, the startup time
482 will be excessive, and so if this is a problem, the user can clear
483 this flag and then add the shared library symbols as needed. Note
484 that there is a potential for confusion, since if the shared
485 library symbols are not loaded, commands like "info fun" will *not*
486 report all the functions that are actually present. */
488 extern int auto_solib_add;
492 extern void set_initial_language (void);
494 extern void find_lowest_section (bfd *, asection *, void *);
496 extern gdb_bfd_ref_ptr symfile_bfd_open (const char *);
498 extern int get_section_index (struct objfile *, const char *);
500 extern int print_symbol_loading_p (int from_tty, int mainline, int full);
502 /* Utility functions for overlay sections: */
503 extern enum overlay_debugging_state
509 extern int overlay_cache_invalid;
511 /* Return the "mapped" overlay section containing the PC. */
512 extern struct obj_section *find_pc_mapped_section (CORE_ADDR);
514 /* Return any overlay section containing the PC (even in its LMA
516 extern struct obj_section *find_pc_overlay (CORE_ADDR);
518 /* Return true if the section is an overlay. */
519 extern int section_is_overlay (struct obj_section *);
521 /* Return true if the overlay section is currently "mapped". */
522 extern int section_is_mapped (struct obj_section *);
524 /* Return true if pc belongs to section's VMA. */
525 extern CORE_ADDR pc_in_mapped_range (CORE_ADDR, struct obj_section *);
527 /* Return true if pc belongs to section's LMA. */
528 extern CORE_ADDR pc_in_unmapped_range (CORE_ADDR, struct obj_section *);
530 /* Map an address from a section's LMA to its VMA. */
531 extern CORE_ADDR overlay_mapped_address (CORE_ADDR, struct obj_section *);
533 /* Map an address from a section's VMA to its LMA. */
534 extern CORE_ADDR overlay_unmapped_address (CORE_ADDR, struct obj_section *);
536 /* Convert an address in an overlay section (force into VMA range). */
537 extern CORE_ADDR symbol_overlayed_address (CORE_ADDR, struct obj_section *);
539 /* Load symbols from a file. */
540 extern void symbol_file_add_main (const char *args,
541 symfile_add_flags add_flags);
543 /* Clear GDB symbol tables. */
544 extern void symbol_file_clear (int from_tty);
546 /* Default overlay update function. */
547 extern void simple_overlay_update (struct obj_section *);
549 extern bfd_byte *symfile_relocate_debug_section (struct objfile *, asection *,
552 extern int symfile_map_offsets_to_segments (bfd *,
553 const struct symfile_segment_data *,
554 struct section_offsets *,
555 int, const CORE_ADDR *);
556 struct symfile_segment_data *get_symfile_segment_data (bfd *abfd);
557 void free_symfile_segment_data (struct symfile_segment_data *data);
559 extern scoped_restore_tmpl<int> increment_reading_symtab (void);
561 void expand_symtabs_matching
562 (gdb::function_view<expand_symtabs_file_matcher_ftype> file_matcher,
563 gdb::function_view<expand_symtabs_symbol_matcher_ftype> symbol_matcher,
564 gdb::function_view<expand_symtabs_exp_notify_ftype> expansion_notify,
565 enum search_domain kind);
567 void map_symbol_filenames (symbol_filename_ftype *fun, void *data,
570 /* From dwarf2read.c */
572 /* Names for a dwarf2 debugging section. The field NORMAL is the normal
573 section name (usually from the DWARF standard), while the field COMPRESSED
574 is the name of compressed sections. If your object file format doesn't
575 support compressed sections, the field COMPRESSED can be NULL. Likewise,
576 the debugging section is not supported, the field NORMAL can be NULL too.
577 It doesn't make sense to have a NULL NORMAL field but a non-NULL COMPRESSED
580 struct dwarf2_section_names {
582 const char *compressed;
585 /* List of names for dward2 debugging sections. Also most object file formats
586 use the standardized (ie ELF) names, some (eg XCOFF) have customized names
588 The table for the standard names is defined in dwarf2read.c. Please
589 update all instances of dwarf2_debug_sections if you add a field to this
590 structure. It is always safe to use { NULL, NULL } in this case. */
592 struct dwarf2_debug_sections {
593 struct dwarf2_section_names info;
594 struct dwarf2_section_names abbrev;
595 struct dwarf2_section_names line;
596 struct dwarf2_section_names loc;
597 struct dwarf2_section_names loclists;
598 struct dwarf2_section_names macinfo;
599 struct dwarf2_section_names macro;
600 struct dwarf2_section_names str;
601 struct dwarf2_section_names line_str;
602 struct dwarf2_section_names ranges;
603 struct dwarf2_section_names rnglists;
604 struct dwarf2_section_names types;
605 struct dwarf2_section_names addr;
606 struct dwarf2_section_names frame;
607 struct dwarf2_section_names eh_frame;
608 struct dwarf2_section_names gdb_index;
609 /* This field has no meaning, but exists solely to catch changes to
610 this structure which are not reflected in some instance. */
614 extern int dwarf2_has_info (struct objfile *,
615 const struct dwarf2_debug_sections *);
617 /* Dwarf2 sections that can be accessed by dwarf2_get_section_info. */
618 enum dwarf2_section_enum {
623 extern void dwarf2_get_section_info (struct objfile *,
624 enum dwarf2_section_enum,
625 asection **, const gdb_byte **,
628 extern int dwarf2_initialize_objfile (struct objfile *);
629 extern void dwarf2_build_psymtabs (struct objfile *);
630 extern void dwarf2_build_frame_info (struct objfile *);
632 void dwarf2_free_objfile (struct objfile *);
634 /* From mdebugread.c */
636 extern void mdebug_build_psymtabs (minimal_symbol_reader &,
638 const struct ecoff_debug_swap *,
639 struct ecoff_debug_info *);
641 extern void elfmdebug_build_psymtabs (struct objfile *,
642 const struct ecoff_debug_swap *,
645 /* From minidebug.c. */
647 extern gdb_bfd_ref_ptr find_separate_debug_file_in_section (struct objfile *);
649 /* True if we are printing debug output about separate debug info files. */
651 extern int separate_debug_file_debug;
653 #endif /* !defined(SYMFILE_H) */