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,
53 /* SECTINDEX must be valid for associated BFD or set to -1. */
57 /* Define an array of addresses to accommodate non-contiguous dynamic
58 loading of modules. This is for use when entering commands, so we
59 can keep track of the section names until we read the file and can
60 map them to bfd sections. This structure is also used by solib.c
61 to communicate the section addresses in shared objects to
62 symbol_file_add (). */
64 struct section_addr_info
66 /* The number of sections for which address information is
69 /* Sections whose names are file format dependent. */
70 struct other_sections other[1];
74 /* A table listing the load segments in a symfile, and which segment
75 each BFD section belongs to. */
76 struct symfile_segment_data
78 /* How many segments are present in this file. If there are
79 two, the text segment is the first one and the data segment
83 /* If NUM_SEGMENTS is greater than zero, the original base address
85 CORE_ADDR *segment_bases;
87 /* If NUM_SEGMENTS is greater than zero, the memory size of each
89 CORE_ADDR *segment_sizes;
91 /* If NUM_SEGMENTS is greater than zero, this is an array of entries
92 recording which segment contains each BFD section.
93 SEGMENT_INFO[I] is S+1 if the I'th BFD section belongs to segment
94 S, or zero if it is not in any segment. */
98 /* Callback for quick_symbol_functions->map_symbol_filenames. */
100 typedef void (symbol_filename_ftype) (const char *filename,
101 const char *fullname, void *data);
103 /* Callback for quick_symbol_functions->expand_symtabs_matching
104 to match a file name. */
106 typedef bool (expand_symtabs_file_matcher_ftype) (const char *filename,
109 /* Callback for quick_symbol_functions->expand_symtabs_matching
110 to match a symbol name. */
112 typedef bool (expand_symtabs_symbol_matcher_ftype) (const char *name);
114 /* Callback for quick_symbol_functions->expand_symtabs_matching
115 to be called after a symtab has been expanded. */
117 typedef void (expand_symtabs_exp_notify_ftype) (compunit_symtab *symtab);
119 /* The "quick" symbol functions exist so that symbol readers can
120 avoiding an initial read of all the symbols. For example, symbol
121 readers might choose to use the "partial symbol table" utilities,
122 which is one implementation of the quick symbol functions.
124 The quick symbol functions are generally opaque: the underlying
125 representation is hidden from the caller.
127 In general, these functions should only look at whatever special
128 index the symbol reader creates -- looking through the symbol
129 tables themselves is handled by generic code. If a function is
130 defined as returning a "symbol table", this means that the function
131 should only return a newly-created symbol table; it should not
132 examine pre-existing ones.
134 The exact list of functions here was determined in an ad hoc way
135 based on gdb's history. */
137 struct quick_symbol_functions
139 /* Return true if this objfile has any "partial" symbols
141 int (*has_symbols) (struct objfile *objfile);
143 /* Return the symbol table for the "last" file appearing in
145 struct symtab *(*find_last_source_symtab) (struct objfile *objfile);
147 /* Forget all cached full file names for OBJFILE. */
148 void (*forget_cached_source_info) (struct objfile *objfile);
150 /* Expand and iterate over each "partial" symbol table in OBJFILE
151 where the source file is named NAME.
153 If NAME is not absolute, a match after a '/' in the symbol table's
154 file name will also work, REAL_PATH is NULL then. If NAME is
155 absolute then REAL_PATH is non-NULL absolute file name as resolved
156 via gdb_realpath from NAME.
158 If a match is found, the "partial" symbol table is expanded.
159 Then, this calls iterate_over_some_symtabs (or equivalent) over
160 all newly-created symbol tables, passing CALLBACK to it.
161 The result of this call is returned. */
162 bool (*map_symtabs_matching_filename)
163 (struct objfile *objfile, const char *name, const char *real_path,
164 gdb::function_view<bool (symtab *)> callback);
166 /* Check to see if the symbol is defined in a "partial" symbol table
167 of OBJFILE. BLOCK_INDEX should be either GLOBAL_BLOCK or STATIC_BLOCK,
168 depending on whether we want to search global symbols or static
169 symbols. NAME is the name of the symbol to look for. DOMAIN
170 indicates what sort of symbol to search for.
172 Returns the newly-expanded compunit in which the symbol is
173 defined, or NULL if no such symbol table exists. If OBJFILE
174 contains !TYPE_OPAQUE symbol prefer its compunit. If it contains
175 only TYPE_OPAQUE symbol(s), return at least that compunit. */
176 struct compunit_symtab *(*lookup_symbol) (struct objfile *objfile,
177 int block_index, const char *name,
180 /* Print statistics about any indices loaded for OBJFILE. The
181 statistics should be printed to gdb_stdout. This is used for
182 "maint print statistics". */
183 void (*print_stats) (struct objfile *objfile);
185 /* Dump any indices loaded for OBJFILE. The dump should go to
186 gdb_stdout. This is used for "maint print objfiles". */
187 void (*dump) (struct objfile *objfile);
189 /* This is called by objfile_relocate to relocate any indices loaded
191 void (*relocate) (struct objfile *objfile,
192 const struct section_offsets *new_offsets,
193 const struct section_offsets *delta);
195 /* Find all the symbols in OBJFILE named FUNC_NAME, and ensure that
196 the corresponding symbol tables are loaded. */
197 void (*expand_symtabs_for_function) (struct objfile *objfile,
198 const char *func_name);
200 /* Read all symbol tables associated with OBJFILE. */
201 void (*expand_all_symtabs) (struct objfile *objfile);
203 /* Read all symbol tables associated with OBJFILE which have
204 symtab_to_fullname equal to FULLNAME.
205 This is for the purposes of examining code only, e.g., expand_line_sal.
206 The routine may ignore debug info that is known to not be useful with
207 code, e.g., DW_TAG_type_unit for dwarf debug info. */
208 void (*expand_symtabs_with_fullname) (struct objfile *objfile,
209 const char *fullname);
211 /* Find global or static symbols in all tables that are in DOMAIN
212 and for which MATCH (symbol name, NAME) == 0, passing each to
213 CALLBACK, reading in partial symbol tables as needed. Look
214 through global symbols if GLOBAL and otherwise static symbols.
215 Passes NAME, NAMESPACE, and DATA to CALLBACK with each symbol
216 found. After each block is processed, passes NULL to CALLBACK.
217 MATCH must be weaker than strcmp_iw_ordered in the sense that
218 strcmp_iw_ordered(x,y) == 0 --> MATCH(x,y) == 0. ORDERED_COMPARE,
219 if non-null, must be an ordering relation compatible with
220 strcmp_iw_ordered in the sense that
221 strcmp_iw_ordered(x,y) == 0 --> ORDERED_COMPARE(x,y) == 0
223 strcmp_iw_ordered(x,y) <= 0 --> ORDERED_COMPARE(x,y) <= 0
224 (allowing strcmp_iw_ordered(x,y) < 0 while ORDERED_COMPARE(x, y) == 0).
225 CALLBACK returns 0 to indicate that the scan should continue, or
226 non-zero to indicate that the scan should be terminated. */
228 void (*map_matching_symbols) (struct objfile *,
229 const char *name, domain_enum domain,
231 int (*callback) (struct block *,
232 struct symbol *, void *),
234 symbol_name_match_type match,
235 symbol_compare_ftype *ordered_compare);
237 /* Expand all symbol tables in OBJFILE matching some criteria.
239 FILE_MATCHER is called for each file in OBJFILE. The file name
240 is passed to it. If the matcher returns false, the file is
241 skipped. If FILE_MATCHER is NULL the file is not skipped. If
242 BASENAMES is true the matcher should consider only file base
243 names (the passed file name is already only the lbasename'd
246 Otherwise, if KIND does not match, this symbol is skipped.
248 If even KIND matches, SYMBOL_MATCHER is called for each symbol
249 defined in the file. The symbol "search" name is passed to
252 If SYMBOL_MATCHER returns false, then the symbol is skipped.
254 Otherwise, the symbol's symbol table is expanded. */
255 void (*expand_symtabs_matching)
256 (struct objfile *objfile,
257 gdb::function_view<expand_symtabs_file_matcher_ftype> file_matcher,
258 const lookup_name_info &lookup_name,
259 gdb::function_view<expand_symtabs_symbol_matcher_ftype> symbol_matcher,
260 gdb::function_view<expand_symtabs_exp_notify_ftype> expansion_notify,
261 enum search_domain kind);
263 /* Return the comp unit from OBJFILE that contains PC and
264 SECTION. Return NULL if there is no such compunit. This
265 should return the compunit that contains a symbol whose
266 address exactly matches PC, or, if there is no exact match, the
267 compunit that contains a symbol whose address is closest to
269 struct compunit_symtab *(*find_pc_sect_compunit_symtab)
270 (struct objfile *objfile, struct bound_minimal_symbol msymbol,
271 CORE_ADDR pc, struct obj_section *section, int warn_if_readin);
273 /* Return the comp unit from OBJFILE that contains a symbol at
274 ADDRESS. Return NULL if there is no such comp unit. Unlike
275 find_pc_sect_compunit_symtab, any sort of symbol (not just text
276 symbols) can be considered, and only exact address matches are
277 considered. This pointer may be NULL. */
278 struct compunit_symtab *(*find_compunit_symtab_by_address)
279 (struct objfile *objfile, CORE_ADDR address);
281 /* Call a callback for every file defined in OBJFILE whose symtab is
282 not already read in. FUN is the callback. It is passed the file's
283 FILENAME, the file's FULLNAME (if need_fullname is non-zero), and
284 the DATA passed to this function. */
285 void (*map_symbol_filenames) (struct objfile *objfile,
286 symbol_filename_ftype *fun, void *data,
290 /* Structure of functions used for probe support. If one of these functions
291 is provided, all must be. */
295 /* If non-NULL, return a reference to vector of probe objects. */
296 const std::vector<probe *> &(*sym_get_probes) (struct objfile *);
299 /* Structure to keep track of symbol reading functions for various
300 object file types. */
304 /* Initializes anything that is global to the entire symbol table.
305 It is called during symbol_file_add, when we begin debugging an
306 entirely new program. */
308 void (*sym_new_init) (struct objfile *);
310 /* Reads any initial information from a symbol file, and initializes
311 the struct sym_fns SF in preparation for sym_read(). It is
312 called every time we read a symbol file for any reason. */
314 void (*sym_init) (struct objfile *);
316 /* sym_read (objfile, symfile_flags) Reads a symbol file into a psymtab
317 (or possibly a symtab). OBJFILE is the objfile struct for the
318 file we are reading. SYMFILE_FLAGS are the flags passed to
319 symbol_file_add & co. */
321 void (*sym_read) (struct objfile *, symfile_add_flags);
323 /* Read the partial symbols for an objfile. This may be NULL, in which case
324 gdb has to check other ways if this objfile has any symbols. This may
325 only be non-NULL if the objfile actually does have debuginfo available.
328 void (*sym_read_psymbols) (struct objfile *);
330 /* Called when we are finished with an objfile. Should do all
331 cleanup that is specific to the object file format for the
332 particular objfile. */
334 void (*sym_finish) (struct objfile *);
337 /* This function produces a file-dependent section_offsets
338 structure, allocated in the objfile's storage.
340 The section_addr_info structure contains the offset of loadable and
341 allocated sections, relative to the absolute offsets found in the BFD. */
343 void (*sym_offsets) (struct objfile *, const struct section_addr_info *);
345 /* This function produces a format-independent description of
346 the segments of ABFD. Each segment is a unit of the file
347 which may be relocated independently. */
349 struct symfile_segment_data *(*sym_segments) (bfd *abfd);
351 /* This function should read the linetable from the objfile when
352 the line table cannot be read while processing the debugging
355 void (*sym_read_linetable) (struct objfile *);
357 /* Relocate the contents of a debug section SECTP. The
358 contents are stored in BUF if it is non-NULL, or returned in a
359 malloc'd buffer otherwise. */
361 bfd_byte *(*sym_relocate) (struct objfile *, asection *sectp, bfd_byte *buf);
363 /* If non-NULL, this objfile has probe support, and all the probe
364 functions referred to here will be non-NULL. */
365 const struct sym_probe_fns *sym_probe_fns;
367 /* The "quick" (aka partial) symbol functions for this symbol
369 const struct quick_symbol_functions *qf;
372 extern struct section_addr_info *
373 build_section_addr_info_from_objfile (const struct objfile *objfile);
375 extern void relative_addr_info_to_section_offsets
376 (struct section_offsets *section_offsets, int num_sections,
377 const struct section_addr_info *addrs);
379 extern void addr_info_make_relative (struct section_addr_info *addrs,
382 /* The default version of sym_fns.sym_offsets for readers that don't
383 do anything special. */
385 extern void default_symfile_offsets (struct objfile *objfile,
386 const struct section_addr_info *);
388 /* The default version of sym_fns.sym_segments for readers that don't
389 do anything special. */
391 extern struct symfile_segment_data *default_symfile_segments (bfd *abfd);
393 /* The default version of sym_fns.sym_relocate for readers that don't
394 do anything special. */
396 extern bfd_byte *default_symfile_relocate (struct objfile *objfile,
397 asection *sectp, bfd_byte *buf);
399 extern struct symtab *allocate_symtab (struct compunit_symtab *, const char *)
400 ATTRIBUTE_NONNULL (1);
402 extern struct compunit_symtab *allocate_compunit_symtab (struct objfile *,
404 ATTRIBUTE_NONNULL (1);
406 extern void add_compunit_symtab_to_objfile (struct compunit_symtab *cu);
408 extern void add_symtab_fns (enum bfd_flavour flavour, const struct sym_fns *);
410 extern void clear_symtab_users (symfile_add_flags add_flags);
412 extern enum language deduce_language_from_filename (const char *);
414 /* Map the filename extension EXT to the language LANG. Any previous
415 association of EXT will be removed. EXT will be copied by this
417 extern void add_filename_language (const char *ext, enum language lang);
419 extern struct objfile *symbol_file_add (const char *, symfile_add_flags,
420 struct section_addr_info *, objfile_flags);
422 extern struct objfile *symbol_file_add_from_bfd (bfd *, const char *, symfile_add_flags,
423 struct section_addr_info *,
424 objfile_flags, struct objfile *parent);
426 extern void symbol_file_add_separate (bfd *, const char *, symfile_add_flags,
429 extern char *find_separate_debug_file_by_debuglink (struct objfile *);
431 /* Create a new section_addr_info, with room for NUM_SECTIONS. */
433 extern struct section_addr_info *alloc_section_addr_info (size_t
436 /* Build (allocate and populate) a section_addr_info struct from an
437 existing section table. */
439 extern struct section_addr_info
440 *build_section_addr_info_from_section_table (const struct target_section
442 const struct target_section
445 /* Free all memory allocated by
446 build_section_addr_info_from_section_table. */
448 extern void free_section_addr_info (struct section_addr_info *);
453 /* If non-zero, shared library symbols will be added automatically
454 when the inferior is created, new libraries are loaded, or when
455 attaching to the inferior. This is almost always what users will
456 want to have happen; but for very large programs, the startup time
457 will be excessive, and so if this is a problem, the user can clear
458 this flag and then add the shared library symbols as needed. Note
459 that there is a potential for confusion, since if the shared
460 library symbols are not loaded, commands like "info fun" will *not*
461 report all the functions that are actually present. */
463 extern int auto_solib_add;
467 extern void set_initial_language (void);
469 extern void find_lowest_section (bfd *, asection *, void *);
471 extern gdb_bfd_ref_ptr symfile_bfd_open (const char *);
473 extern int get_section_index (struct objfile *, const char *);
475 extern int print_symbol_loading_p (int from_tty, int mainline, int full);
477 /* Utility functions for overlay sections: */
478 extern enum overlay_debugging_state
484 extern int overlay_cache_invalid;
486 /* Return the "mapped" overlay section containing the PC. */
487 extern struct obj_section *find_pc_mapped_section (CORE_ADDR);
489 /* Return any overlay section containing the PC (even in its LMA
491 extern struct obj_section *find_pc_overlay (CORE_ADDR);
493 /* Return true if the section is an overlay. */
494 extern int section_is_overlay (struct obj_section *);
496 /* Return true if the overlay section is currently "mapped". */
497 extern int section_is_mapped (struct obj_section *);
499 /* Return true if pc belongs to section's VMA. */
500 extern CORE_ADDR pc_in_mapped_range (CORE_ADDR, struct obj_section *);
502 /* Return true if pc belongs to section's LMA. */
503 extern CORE_ADDR pc_in_unmapped_range (CORE_ADDR, struct obj_section *);
505 /* Map an address from a section's LMA to its VMA. */
506 extern CORE_ADDR overlay_mapped_address (CORE_ADDR, struct obj_section *);
508 /* Map an address from a section's VMA to its LMA. */
509 extern CORE_ADDR overlay_unmapped_address (CORE_ADDR, struct obj_section *);
511 /* Convert an address in an overlay section (force into VMA range). */
512 extern CORE_ADDR symbol_overlayed_address (CORE_ADDR, struct obj_section *);
514 /* Load symbols from a file. */
515 extern void symbol_file_add_main (const char *args,
516 symfile_add_flags add_flags);
518 /* Clear GDB symbol tables. */
519 extern void symbol_file_clear (int from_tty);
521 /* Default overlay update function. */
522 extern void simple_overlay_update (struct obj_section *);
524 extern bfd_byte *symfile_relocate_debug_section (struct objfile *, asection *,
527 extern int symfile_map_offsets_to_segments (bfd *,
528 const struct symfile_segment_data *,
529 struct section_offsets *,
530 int, const CORE_ADDR *);
531 struct symfile_segment_data *get_symfile_segment_data (bfd *abfd);
532 void free_symfile_segment_data (struct symfile_segment_data *data);
534 extern scoped_restore_tmpl<int> increment_reading_symtab (void);
536 void expand_symtabs_matching
537 (gdb::function_view<expand_symtabs_file_matcher_ftype> file_matcher,
538 const lookup_name_info &lookup_name,
539 gdb::function_view<expand_symtabs_symbol_matcher_ftype> symbol_matcher,
540 gdb::function_view<expand_symtabs_exp_notify_ftype> expansion_notify,
541 enum search_domain kind);
543 void map_symbol_filenames (symbol_filename_ftype *fun, void *data,
546 /* From dwarf2read.c */
548 /* Names for a dwarf2 debugging section. The field NORMAL is the normal
549 section name (usually from the DWARF standard), while the field COMPRESSED
550 is the name of compressed sections. If your object file format doesn't
551 support compressed sections, the field COMPRESSED can be NULL. Likewise,
552 the debugging section is not supported, the field NORMAL can be NULL too.
553 It doesn't make sense to have a NULL NORMAL field but a non-NULL COMPRESSED
556 struct dwarf2_section_names {
558 const char *compressed;
561 /* List of names for dward2 debugging sections. Also most object file formats
562 use the standardized (ie ELF) names, some (eg XCOFF) have customized names
564 The table for the standard names is defined in dwarf2read.c. Please
565 update all instances of dwarf2_debug_sections if you add a field to this
566 structure. It is always safe to use { NULL, NULL } in this case. */
568 struct dwarf2_debug_sections {
569 struct dwarf2_section_names info;
570 struct dwarf2_section_names abbrev;
571 struct dwarf2_section_names line;
572 struct dwarf2_section_names loc;
573 struct dwarf2_section_names loclists;
574 struct dwarf2_section_names macinfo;
575 struct dwarf2_section_names macro;
576 struct dwarf2_section_names str;
577 struct dwarf2_section_names line_str;
578 struct dwarf2_section_names ranges;
579 struct dwarf2_section_names rnglists;
580 struct dwarf2_section_names types;
581 struct dwarf2_section_names addr;
582 struct dwarf2_section_names frame;
583 struct dwarf2_section_names eh_frame;
584 struct dwarf2_section_names gdb_index;
585 struct dwarf2_section_names debug_names;
586 struct dwarf2_section_names debug_aranges;
587 /* This field has no meaning, but exists solely to catch changes to
588 this structure which are not reflected in some instance. */
592 extern int dwarf2_has_info (struct objfile *,
593 const struct dwarf2_debug_sections *);
595 /* Dwarf2 sections that can be accessed by dwarf2_get_section_info. */
596 enum dwarf2_section_enum {
601 extern void dwarf2_get_section_info (struct objfile *,
602 enum dwarf2_section_enum,
603 asection **, const gdb_byte **,
606 /* A DWARF names index variant. */
607 enum class dw_index_kind
609 /* GDB's own .gdb_index format. */
612 /* DWARF5 .debug_names. */
616 /* Initialize for reading DWARF for OBJFILE. Return false if this
617 file will use psymtabs, or true if using an index, in which case
618 *INDEX_KIND is set to the index variant in use. */
619 extern bool dwarf2_initialize_objfile (struct objfile *objfile,
620 dw_index_kind *index_kind);
622 extern void dwarf2_build_psymtabs (struct objfile *);
623 extern void dwarf2_build_frame_info (struct objfile *);
625 void dwarf2_free_objfile (struct objfile *);
627 /* From mdebugread.c */
629 extern void mdebug_build_psymtabs (minimal_symbol_reader &,
631 const struct ecoff_debug_swap *,
632 struct ecoff_debug_info *);
634 extern void elfmdebug_build_psymtabs (struct objfile *,
635 const struct ecoff_debug_swap *,
638 /* From minidebug.c. */
640 extern gdb_bfd_ref_ptr find_separate_debug_file_in_section (struct objfile *);
642 /* True if we are printing debug output about separate debug info files. */
644 extern int separate_debug_file_debug;
646 #endif /* !defined(SYMFILE_H) */