1 /* Definitions for reading symbol files into GDB.
3 Copyright (C) 1990-2019 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 "gdbsupport/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
,
50 other_sections (CORE_ADDR addr_
, std::string
&&name_
, int sectindex_
)
52 name (std::move (name_
)),
53 sectindex (sectindex_
)
57 other_sections (other_sections
&&other
) = default;
59 DISABLE_COPY_AND_ASSIGN (other_sections
);
64 /* SECTINDEX must be valid for associated BFD or set to -1.
65 See syms_from_objfile_1 for an exception to this rule.
70 /* Define an array of addresses to accommodate non-contiguous dynamic
71 loading of modules. This is for use when entering commands, so we
72 can keep track of the section names until we read the file and can
73 map them to bfd sections. This structure is also used by solib.c
74 to communicate the section addresses in shared objects to
75 symbol_file_add (). */
77 typedef std::vector
<other_sections
> section_addr_info
;
79 /* A table listing the load segments in a symfile, and which segment
80 each BFD section belongs to. */
81 struct symfile_segment_data
83 /* How many segments are present in this file. If there are
84 two, the text segment is the first one and the data segment
88 /* If NUM_SEGMENTS is greater than zero, the original base address
90 CORE_ADDR
*segment_bases
;
92 /* If NUM_SEGMENTS is greater than zero, the memory size of each
94 CORE_ADDR
*segment_sizes
;
96 /* If NUM_SEGMENTS is greater than zero, this is an array of entries
97 recording which segment contains each BFD section.
98 SEGMENT_INFO[I] is S+1 if the I'th BFD section belongs to segment
99 S, or zero if it is not in any segment. */
103 /* Callback for quick_symbol_functions->map_symbol_filenames. */
105 typedef void (symbol_filename_ftype
) (const char *filename
,
106 const char *fullname
, void *data
);
108 /* Callback for quick_symbol_functions->expand_symtabs_matching
109 to match a file name. */
111 typedef bool (expand_symtabs_file_matcher_ftype
) (const char *filename
,
114 /* Callback for quick_symbol_functions->expand_symtabs_matching
115 to match a symbol name. */
117 typedef bool (expand_symtabs_symbol_matcher_ftype
) (const char *name
);
119 /* Callback for quick_symbol_functions->expand_symtabs_matching
120 to be called after a symtab has been expanded. */
122 typedef void (expand_symtabs_exp_notify_ftype
) (compunit_symtab
*symtab
);
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 NAME is not absolute, a match after a '/' in the symbol table's
159 file name will also work, REAL_PATH is NULL then. If NAME is
160 absolute then REAL_PATH is non-NULL absolute file name as resolved
161 via gdb_realpath from NAME.
163 If a match is found, the "partial" symbol table is expanded.
164 Then, this calls iterate_over_some_symtabs (or equivalent) over
165 all newly-created symbol tables, passing CALLBACK to it.
166 The result of this call is returned. */
167 bool (*map_symtabs_matching_filename
)
168 (struct objfile
*objfile
, const char *name
, const char *real_path
,
169 gdb::function_view
<bool (symtab
*)> callback
);
171 /* Check to see if the symbol is defined in a "partial" symbol table
172 of OBJFILE. BLOCK_INDEX should be either GLOBAL_BLOCK or STATIC_BLOCK,
173 depending on whether we want to search global symbols or static
174 symbols. NAME is the name of the symbol to look for. DOMAIN
175 indicates what sort of symbol to search for.
177 Returns the newly-expanded compunit in which the symbol is
178 defined, or NULL if no such symbol table exists. If OBJFILE
179 contains !TYPE_OPAQUE symbol prefer its compunit. If it contains
180 only TYPE_OPAQUE symbol(s), return at least that compunit. */
181 struct compunit_symtab
*(*lookup_symbol
) (struct objfile
*objfile
,
182 block_enum block_index
,
186 /* Print statistics about any indices loaded for OBJFILE. The
187 statistics should be printed to gdb_stdout. This is used for
188 "maint print statistics". */
189 void (*print_stats
) (struct objfile
*objfile
);
191 /* Dump any indices loaded for OBJFILE. The dump should go to
192 gdb_stdout. This is used for "maint print objfiles". */
193 void (*dump
) (struct objfile
*objfile
);
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
) (const 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
<std::unique_ptr
<probe
>> &(*sym_get_probes
)
300 /* Structure to keep track of symbol reading functions for various
301 object file types. */
305 /* Initializes anything that is global to the entire symbol table.
306 It is called during symbol_file_add, when we begin debugging an
307 entirely new program. */
309 void (*sym_new_init
) (struct objfile
*);
311 /* Reads any initial information from a symbol file, and initializes
312 the struct sym_fns SF in preparation for sym_read(). It is
313 called every time we read a symbol file for any reason. */
315 void (*sym_init
) (struct objfile
*);
317 /* sym_read (objfile, symfile_flags) Reads a symbol file into a psymtab
318 (or possibly a symtab). OBJFILE is the objfile struct for the
319 file we are reading. SYMFILE_FLAGS are the flags passed to
320 symbol_file_add & co. */
322 void (*sym_read
) (struct objfile
*, symfile_add_flags
);
324 /* Read the partial symbols for an objfile. This may be NULL, in which case
325 gdb has to check other ways if this objfile has any symbols. This may
326 only be non-NULL if the objfile actually does have debuginfo available.
329 void (*sym_read_psymbols
) (struct objfile
*);
331 /* Called when we are finished with an objfile. Should do all
332 cleanup that is specific to the object file format for the
333 particular objfile. */
335 void (*sym_finish
) (struct objfile
*);
338 /* This function produces a file-dependent section_offsets
339 structure, allocated in the objfile's storage.
341 The section_addr_info structure contains the offset of loadable and
342 allocated sections, relative to the absolute offsets found in the BFD. */
344 void (*sym_offsets
) (struct objfile
*, const section_addr_info
&);
346 /* This function produces a format-independent description of
347 the segments of ABFD. Each segment is a unit of the file
348 which may be relocated independently. */
350 struct symfile_segment_data
*(*sym_segments
) (bfd
*abfd
);
352 /* This function should read the linetable from the objfile when
353 the line table cannot be read while processing the debugging
356 void (*sym_read_linetable
) (struct objfile
*);
358 /* Relocate the contents of a debug section SECTP. The
359 contents are stored in BUF if it is non-NULL, or returned in a
360 malloc'd buffer otherwise. */
362 bfd_byte
*(*sym_relocate
) (struct objfile
*, asection
*sectp
, bfd_byte
*buf
);
364 /* If non-NULL, this objfile has probe support, and all the probe
365 functions referred to here will be non-NULL. */
366 const struct sym_probe_fns
*sym_probe_fns
;
368 /* The "quick" (aka partial) symbol functions for this symbol
370 const struct quick_symbol_functions
*qf
;
373 extern section_addr_info
374 build_section_addr_info_from_objfile (const struct objfile
*objfile
);
376 extern void relative_addr_info_to_section_offsets
377 (struct section_offsets
*section_offsets
, int num_sections
,
378 const section_addr_info
&addrs
);
380 extern void addr_info_make_relative (section_addr_info
*addrs
,
383 /* The default version of sym_fns.sym_offsets for readers that don't
384 do anything special. */
386 extern void default_symfile_offsets (struct objfile
*objfile
,
387 const section_addr_info
&);
389 /* The default version of sym_fns.sym_segments for readers that don't
390 do anything special. */
392 extern struct symfile_segment_data
*default_symfile_segments (bfd
*abfd
);
394 /* The default version of sym_fns.sym_relocate for readers that don't
395 do anything special. */
397 extern bfd_byte
*default_symfile_relocate (struct objfile
*objfile
,
398 asection
*sectp
, bfd_byte
*buf
);
400 extern struct symtab
*allocate_symtab (struct compunit_symtab
*, const char *)
401 ATTRIBUTE_NONNULL (1);
403 extern struct compunit_symtab
*allocate_compunit_symtab (struct objfile
*,
405 ATTRIBUTE_NONNULL (1);
407 extern void add_compunit_symtab_to_objfile (struct compunit_symtab
*cu
);
409 extern void add_symtab_fns (enum bfd_flavour flavour
, const struct sym_fns
*);
411 extern void clear_symtab_users (symfile_add_flags add_flags
);
413 extern enum language
deduce_language_from_filename (const char *);
415 /* Map the filename extension EXT to the language LANG. Any previous
416 association of EXT will be removed. EXT will be copied by this
418 extern void add_filename_language (const char *ext
, enum language lang
);
420 extern struct objfile
*symbol_file_add (const char *, symfile_add_flags
,
421 section_addr_info
*, objfile_flags
);
423 extern struct objfile
*symbol_file_add_from_bfd (bfd
*, const char *, symfile_add_flags
,
425 objfile_flags
, struct objfile
*parent
);
427 extern void symbol_file_add_separate (bfd
*, const char *, symfile_add_flags
,
430 extern std::string
find_separate_debug_file_by_debuglink (struct objfile
*);
432 /* Build (allocate and populate) a section_addr_info struct from an
433 existing section table. */
435 extern section_addr_info
436 build_section_addr_info_from_section_table (const struct target_section
438 const struct target_section
443 /* If non-zero, shared library symbols will be added automatically
444 when the inferior is created, new libraries are loaded, or when
445 attaching to the inferior. This is almost always what users will
446 want to have happen; but for very large programs, the startup time
447 will be excessive, and so if this is a problem, the user can clear
448 this flag and then add the shared library symbols as needed. Note
449 that there is a potential for confusion, since if the shared
450 library symbols are not loaded, commands like "info fun" will *not*
451 report all the functions that are actually present. */
453 extern int auto_solib_add
;
457 extern void set_initial_language (void);
459 extern void find_lowest_section (bfd
*, asection
*, void *);
461 extern gdb_bfd_ref_ptr
symfile_bfd_open (const char *);
463 extern int get_section_index (struct objfile
*, const char *);
465 extern int print_symbol_loading_p (int from_tty
, int mainline
, int full
);
467 /* Utility functions for overlay sections: */
468 extern enum overlay_debugging_state
474 extern int overlay_cache_invalid
;
476 /* Return the "mapped" overlay section containing the PC. */
477 extern struct obj_section
*find_pc_mapped_section (CORE_ADDR
);
479 /* Return any overlay section containing the PC (even in its LMA
481 extern struct obj_section
*find_pc_overlay (CORE_ADDR
);
483 /* Return true if the section is an overlay. */
484 extern int section_is_overlay (struct obj_section
*);
486 /* Return true if the overlay section is currently "mapped". */
487 extern int section_is_mapped (struct obj_section
*);
489 /* Return true if pc belongs to section's VMA. */
490 extern CORE_ADDR
pc_in_mapped_range (CORE_ADDR
, struct obj_section
*);
492 /* Return true if pc belongs to section's LMA. */
493 extern CORE_ADDR
pc_in_unmapped_range (CORE_ADDR
, struct obj_section
*);
495 /* Map an address from a section's LMA to its VMA. */
496 extern CORE_ADDR
overlay_mapped_address (CORE_ADDR
, struct obj_section
*);
498 /* Map an address from a section's VMA to its LMA. */
499 extern CORE_ADDR
overlay_unmapped_address (CORE_ADDR
, struct obj_section
*);
501 /* Convert an address in an overlay section (force into VMA range). */
502 extern CORE_ADDR
symbol_overlayed_address (CORE_ADDR
, struct obj_section
*);
504 /* Load symbols from a file. */
505 extern void symbol_file_add_main (const char *args
,
506 symfile_add_flags add_flags
);
508 /* Clear GDB symbol tables. */
509 extern void symbol_file_clear (int from_tty
);
511 /* Default overlay update function. */
512 extern void simple_overlay_update (struct obj_section
*);
514 extern bfd_byte
*symfile_relocate_debug_section (struct objfile
*, asection
*,
517 extern int symfile_map_offsets_to_segments (bfd
*,
518 const struct symfile_segment_data
*,
519 struct section_offsets
*,
520 int, const CORE_ADDR
*);
521 struct symfile_segment_data
*get_symfile_segment_data (bfd
*abfd
);
522 void free_symfile_segment_data (struct symfile_segment_data
*data
);
524 extern scoped_restore_tmpl
<int> increment_reading_symtab (void);
526 void expand_symtabs_matching
527 (gdb::function_view
<expand_symtabs_file_matcher_ftype
> file_matcher
,
528 const lookup_name_info
&lookup_name
,
529 gdb::function_view
<expand_symtabs_symbol_matcher_ftype
> symbol_matcher
,
530 gdb::function_view
<expand_symtabs_exp_notify_ftype
> expansion_notify
,
531 enum search_domain kind
);
533 void map_symbol_filenames (symbol_filename_ftype
*fun
, void *data
,
536 /* Target-agnostic function to load the sections of an executable into memory.
538 ARGS should be in the form "EXECUTABLE [OFFSET]", where OFFSET is an
539 optional offset to apply to each section. */
540 extern void generic_load (const char *args
, int from_tty
);
542 /* From dwarf2read.c */
544 /* Names for a dwarf2 debugging section. The field NORMAL is the normal
545 section name (usually from the DWARF standard), while the field COMPRESSED
546 is the name of compressed sections. If your object file format doesn't
547 support compressed sections, the field COMPRESSED can be NULL. Likewise,
548 the debugging section is not supported, the field NORMAL can be NULL too.
549 It doesn't make sense to have a NULL NORMAL field but a non-NULL COMPRESSED
552 struct dwarf2_section_names
{
554 const char *compressed
;
557 /* List of names for dward2 debugging sections. Also most object file formats
558 use the standardized (ie ELF) names, some (eg XCOFF) have customized names
560 The table for the standard names is defined in dwarf2read.c. Please
561 update all instances of dwarf2_debug_sections if you add a field to this
562 structure. It is always safe to use { NULL, NULL } in this case. */
564 struct dwarf2_debug_sections
{
565 struct dwarf2_section_names info
;
566 struct dwarf2_section_names abbrev
;
567 struct dwarf2_section_names line
;
568 struct dwarf2_section_names loc
;
569 struct dwarf2_section_names loclists
;
570 struct dwarf2_section_names macinfo
;
571 struct dwarf2_section_names macro
;
572 struct dwarf2_section_names str
;
573 struct dwarf2_section_names line_str
;
574 struct dwarf2_section_names ranges
;
575 struct dwarf2_section_names rnglists
;
576 struct dwarf2_section_names types
;
577 struct dwarf2_section_names addr
;
578 struct dwarf2_section_names frame
;
579 struct dwarf2_section_names eh_frame
;
580 struct dwarf2_section_names gdb_index
;
581 struct dwarf2_section_names debug_names
;
582 struct dwarf2_section_names debug_aranges
;
583 /* This field has no meaning, but exists solely to catch changes to
584 this structure which are not reflected in some instance. */
588 extern int dwarf2_has_info (struct objfile
*,
589 const struct dwarf2_debug_sections
*);
591 /* Dwarf2 sections that can be accessed by dwarf2_get_section_info. */
592 enum dwarf2_section_enum
{
597 extern void dwarf2_get_section_info (struct objfile
*,
598 enum dwarf2_section_enum
,
599 asection
**, const gdb_byte
**,
602 /* A DWARF names index variant. */
603 enum class dw_index_kind
605 /* GDB's own .gdb_index format. */
608 /* DWARF5 .debug_names. */
612 /* Initialize for reading DWARF for OBJFILE. Return false if this
613 file will use psymtabs, or true if using an index, in which case
614 *INDEX_KIND is set to the index variant in use. */
615 extern bool dwarf2_initialize_objfile (struct objfile
*objfile
,
616 dw_index_kind
*index_kind
);
618 extern void dwarf2_build_psymtabs (struct objfile
*);
619 extern void dwarf2_build_frame_info (struct objfile
*);
621 void dwarf2_free_objfile (struct objfile
*);
623 /* From minidebug.c. */
625 extern gdb_bfd_ref_ptr
find_separate_debug_file_in_section (struct objfile
*);
627 /* True if we are printing debug output about separate debug info files. */
629 extern int separate_debug_file_debug
;
631 #endif /* !defined(SYMFILE_H) */