1 /* Definitions for reading symbol files into GDB.
3 Copyright (C) 1990-2020 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 /* Check to see if the global symbol is defined in a "partial" symbol table
187 of OBJFILE. NAME is the name of the symbol to look for. DOMAIN
188 indicates what sort of symbol to search for.
190 If found, sets *symbol_found_p to true and returns the symbol language.
191 defined, or NULL if no such symbol table exists. */
192 enum language (*lookup_global_symbol_language
) (struct objfile
*objfile
,
195 bool *symbol_found_p
);
197 /* Print statistics about any indices loaded for OBJFILE. The
198 statistics should be printed to gdb_stdout. This is used for
199 "maint print statistics". */
200 void (*print_stats
) (struct objfile
*objfile
);
202 /* Dump any indices loaded for OBJFILE. The dump should go to
203 gdb_stdout. This is used for "maint print objfiles". */
204 void (*dump
) (struct objfile
*objfile
);
206 /* Find all the symbols in OBJFILE named FUNC_NAME, and ensure that
207 the corresponding symbol tables are loaded. */
208 void (*expand_symtabs_for_function
) (struct objfile
*objfile
,
209 const char *func_name
);
211 /* Read all symbol tables associated with OBJFILE. */
212 void (*expand_all_symtabs
) (struct objfile
*objfile
);
214 /* Read all symbol tables associated with OBJFILE which have
215 symtab_to_fullname equal to FULLNAME.
216 This is for the purposes of examining code only, e.g., expand_line_sal.
217 The routine may ignore debug info that is known to not be useful with
218 code, e.g., DW_TAG_type_unit for dwarf debug info. */
219 void (*expand_symtabs_with_fullname
) (struct objfile
*objfile
,
220 const char *fullname
);
222 /* Find global or static symbols in all tables that are in DOMAIN
223 and for which MATCH (symbol name, NAME) == 0, passing each to
224 CALLBACK, reading in partial symbol tables as needed. Look
225 through global symbols if GLOBAL and otherwise static symbols.
226 Passes NAME and NAMESPACE to CALLBACK with each symbol
227 found. After each block is processed, passes NULL to CALLBACK.
228 MATCH must be weaker than strcmp_iw_ordered in the sense that
229 strcmp_iw_ordered(x,y) == 0 --> MATCH(x,y) == 0. ORDERED_COMPARE,
230 if non-null, must be an ordering relation compatible with
231 strcmp_iw_ordered in the sense that
232 strcmp_iw_ordered(x,y) == 0 --> ORDERED_COMPARE(x,y) == 0
234 strcmp_iw_ordered(x,y) <= 0 --> ORDERED_COMPARE(x,y) <= 0
235 (allowing strcmp_iw_ordered(x,y) < 0 while ORDERED_COMPARE(x, y) == 0).
236 CALLBACK returns true to indicate that the scan should continue, or
237 false to indicate that the scan should be terminated. */
239 void (*map_matching_symbols
)
241 const lookup_name_info
&lookup_name
,
244 gdb::function_view
<symbol_found_callback_ftype
> callback
,
245 symbol_compare_ftype
*ordered_compare
);
247 /* Expand all symbol tables in OBJFILE matching some criteria.
249 FILE_MATCHER is called for each file in OBJFILE. The file name
250 is passed to it. If the matcher returns false, the file is
251 skipped. If FILE_MATCHER is NULL the file is not skipped. If
252 BASENAMES is true the matcher should consider only file base
253 names (the passed file name is already only the lbasename'd
256 If the file is not skipped, and SYMBOL_MATCHER and LOOKUP_NAME are NULL,
257 the symbol table is expanded.
259 Otherwise, individual symbols are considered.
261 If KIND does not match, the symbol is skipped.
263 If the symbol name does not match LOOKUP_NAME, the symbol is skipped.
265 If SYMBOL_MATCHER returns false, then the symbol is skipped.
267 Otherwise, the symbol's symbol table is expanded. */
268 void (*expand_symtabs_matching
)
269 (struct objfile
*objfile
,
270 gdb::function_view
<expand_symtabs_file_matcher_ftype
> file_matcher
,
271 const lookup_name_info
*lookup_name
,
272 gdb::function_view
<expand_symtabs_symbol_matcher_ftype
> symbol_matcher
,
273 gdb::function_view
<expand_symtabs_exp_notify_ftype
> expansion_notify
,
274 enum search_domain kind
);
276 /* Return the comp unit from OBJFILE that contains PC and
277 SECTION. Return NULL if there is no such compunit. This
278 should return the compunit that contains a symbol whose
279 address exactly matches PC, or, if there is no exact match, the
280 compunit that contains a symbol whose address is closest to
282 struct compunit_symtab
*(*find_pc_sect_compunit_symtab
)
283 (struct objfile
*objfile
, struct bound_minimal_symbol msymbol
,
284 CORE_ADDR pc
, struct obj_section
*section
, int warn_if_readin
);
286 /* Return the comp unit from OBJFILE that contains a symbol at
287 ADDRESS. Return NULL if there is no such comp unit. Unlike
288 find_pc_sect_compunit_symtab, any sort of symbol (not just text
289 symbols) can be considered, and only exact address matches are
290 considered. This pointer may be NULL. */
291 struct compunit_symtab
*(*find_compunit_symtab_by_address
)
292 (struct objfile
*objfile
, CORE_ADDR address
);
294 /* Call a callback for every file defined in OBJFILE whose symtab is
295 not already read in. FUN is the callback. It is passed the file's
296 FILENAME, the file's FULLNAME (if need_fullname is non-zero), and
297 the DATA passed to this function. */
298 void (*map_symbol_filenames
) (struct objfile
*objfile
,
299 symbol_filename_ftype
*fun
, void *data
,
303 /* Structure of functions used for probe support. If one of these functions
304 is provided, all must be. */
308 /* If non-NULL, return a reference to vector of probe objects. */
309 const std::vector
<std::unique_ptr
<probe
>> &(*sym_get_probes
)
313 /* Structure to keep track of symbol reading functions for various
314 object file types. */
318 /* Initializes anything that is global to the entire symbol table.
319 It is called during symbol_file_add, when we begin debugging an
320 entirely new program. */
322 void (*sym_new_init
) (struct objfile
*);
324 /* Reads any initial information from a symbol file, and initializes
325 the struct sym_fns SF in preparation for sym_read(). It is
326 called every time we read a symbol file for any reason. */
328 void (*sym_init
) (struct objfile
*);
330 /* sym_read (objfile, symfile_flags) Reads a symbol file into a psymtab
331 (or possibly a symtab). OBJFILE is the objfile struct for the
332 file we are reading. SYMFILE_FLAGS are the flags passed to
333 symbol_file_add & co. */
335 void (*sym_read
) (struct objfile
*, symfile_add_flags
);
337 /* Read the partial symbols for an objfile. This may be NULL, in which case
338 gdb has to check other ways if this objfile has any symbols. This may
339 only be non-NULL if the objfile actually does have debuginfo available.
342 void (*sym_read_psymbols
) (struct objfile
*);
344 /* Called when we are finished with an objfile. Should do all
345 cleanup that is specific to the object file format for the
346 particular objfile. */
348 void (*sym_finish
) (struct objfile
*);
351 /* This function produces a file-dependent section_offsets
352 structure, allocated in the objfile's storage.
354 The section_addr_info structure contains the offset of loadable and
355 allocated sections, relative to the absolute offsets found in the BFD. */
357 void (*sym_offsets
) (struct objfile
*, const section_addr_info
&);
359 /* This function produces a format-independent description of
360 the segments of ABFD. Each segment is a unit of the file
361 which may be relocated independently. */
363 struct symfile_segment_data
*(*sym_segments
) (bfd
*abfd
);
365 /* This function should read the linetable from the objfile when
366 the line table cannot be read while processing the debugging
369 void (*sym_read_linetable
) (struct objfile
*);
371 /* Relocate the contents of a debug section SECTP. The
372 contents are stored in BUF if it is non-NULL, or returned in a
373 malloc'd buffer otherwise. */
375 bfd_byte
*(*sym_relocate
) (struct objfile
*, asection
*sectp
, bfd_byte
*buf
);
377 /* If non-NULL, this objfile has probe support, and all the probe
378 functions referred to here will be non-NULL. */
379 const struct sym_probe_fns
*sym_probe_fns
;
381 /* The "quick" (aka partial) symbol functions for this symbol
383 const struct quick_symbol_functions
*qf
;
386 extern section_addr_info
387 build_section_addr_info_from_objfile (const struct objfile
*objfile
);
389 extern void relative_addr_info_to_section_offsets
390 (section_offsets
§ion_offsets
, const section_addr_info
&addrs
);
392 extern void addr_info_make_relative (section_addr_info
*addrs
,
395 /* The default version of sym_fns.sym_offsets for readers that don't
396 do anything special. */
398 extern void default_symfile_offsets (struct objfile
*objfile
,
399 const section_addr_info
&);
401 /* The default version of sym_fns.sym_segments for readers that don't
402 do anything special. */
404 extern struct symfile_segment_data
*default_symfile_segments (bfd
*abfd
);
406 /* The default version of sym_fns.sym_relocate for readers that don't
407 do anything special. */
409 extern bfd_byte
*default_symfile_relocate (struct objfile
*objfile
,
410 asection
*sectp
, bfd_byte
*buf
);
412 extern struct symtab
*allocate_symtab (struct compunit_symtab
*, const char *)
413 ATTRIBUTE_NONNULL (1);
415 extern struct compunit_symtab
*allocate_compunit_symtab (struct objfile
*,
417 ATTRIBUTE_NONNULL (1);
419 extern void add_compunit_symtab_to_objfile (struct compunit_symtab
*cu
);
421 extern void add_symtab_fns (enum bfd_flavour flavour
, const struct sym_fns
*);
423 extern void clear_symtab_users (symfile_add_flags add_flags
);
425 extern enum language
deduce_language_from_filename (const char *);
427 /* Map the filename extension EXT to the language LANG. Any previous
428 association of EXT will be removed. EXT will be copied by this
430 extern void add_filename_language (const char *ext
, enum language lang
);
432 extern struct objfile
*symbol_file_add (const char *, symfile_add_flags
,
433 section_addr_info
*, objfile_flags
);
435 extern struct objfile
*symbol_file_add_from_bfd (bfd
*, const char *, symfile_add_flags
,
437 objfile_flags
, struct objfile
*parent
);
439 extern void symbol_file_add_separate (bfd
*, const char *, symfile_add_flags
,
442 extern std::string
find_separate_debug_file_by_debuglink (struct objfile
*);
444 /* Build (allocate and populate) a section_addr_info struct from an
445 existing section table. */
447 extern section_addr_info
448 build_section_addr_info_from_section_table (const struct target_section
450 const struct target_section
455 /* If true, shared library symbols will be added automatically
456 when the inferior is created, new libraries are loaded, or when
457 attaching to the inferior. This is almost always what users will
458 want to have happen; but for very large programs, the startup time
459 will be excessive, and so if this is a problem, the user can clear
460 this flag and then add the shared library symbols as needed. Note
461 that there is a potential for confusion, since if the shared
462 library symbols are not loaded, commands like "info fun" will *not*
463 report all the functions that are actually present. */
465 extern bool auto_solib_add
;
469 extern void set_initial_language (void);
471 extern void find_lowest_section (bfd
*, asection
*, void *);
473 extern gdb_bfd_ref_ptr
symfile_bfd_open (const char *);
475 extern int get_section_index (struct objfile
*, const char *);
477 extern int print_symbol_loading_p (int from_tty
, int mainline
, int full
);
479 /* Utility functions for overlay sections: */
480 extern enum overlay_debugging_state
486 extern int overlay_cache_invalid
;
488 /* Return the "mapped" overlay section containing the PC. */
489 extern struct obj_section
*find_pc_mapped_section (CORE_ADDR
);
491 /* Return any overlay section containing the PC (even in its LMA
493 extern struct obj_section
*find_pc_overlay (CORE_ADDR
);
495 /* Return true if the section is an overlay. */
496 extern int section_is_overlay (struct obj_section
*);
498 /* Return true if the overlay section is currently "mapped". */
499 extern int section_is_mapped (struct obj_section
*);
501 /* Return true if pc belongs to section's VMA. */
502 extern CORE_ADDR
pc_in_mapped_range (CORE_ADDR
, struct obj_section
*);
504 /* Return true if pc belongs to section's LMA. */
505 extern CORE_ADDR
pc_in_unmapped_range (CORE_ADDR
, struct obj_section
*);
507 /* Map an address from a section's LMA to its VMA. */
508 extern CORE_ADDR
overlay_mapped_address (CORE_ADDR
, struct obj_section
*);
510 /* Map an address from a section's VMA to its LMA. */
511 extern CORE_ADDR
overlay_unmapped_address (CORE_ADDR
, struct obj_section
*);
513 /* Convert an address in an overlay section (force into VMA range). */
514 extern CORE_ADDR
symbol_overlayed_address (CORE_ADDR
, struct obj_section
*);
516 /* Load symbols from a file. */
517 extern void symbol_file_add_main (const char *args
,
518 symfile_add_flags add_flags
);
520 /* Clear GDB symbol tables. */
521 extern void symbol_file_clear (int from_tty
);
523 /* Default overlay update function. */
524 extern void simple_overlay_update (struct obj_section
*);
526 extern bfd_byte
*symfile_relocate_debug_section (struct objfile
*, asection
*,
529 extern int symfile_map_offsets_to_segments (bfd
*,
530 const struct symfile_segment_data
*,
532 int, const CORE_ADDR
*);
533 struct symfile_segment_data
*get_symfile_segment_data (bfd
*abfd
);
534 void free_symfile_segment_data (struct symfile_segment_data
*data
);
536 extern scoped_restore_tmpl
<int> increment_reading_symtab (void);
538 void expand_symtabs_matching
539 (gdb::function_view
<expand_symtabs_file_matcher_ftype
> file_matcher
,
540 const lookup_name_info
&lookup_name
,
541 gdb::function_view
<expand_symtabs_symbol_matcher_ftype
> symbol_matcher
,
542 gdb::function_view
<expand_symtabs_exp_notify_ftype
> expansion_notify
,
543 enum search_domain kind
);
545 void map_symbol_filenames (symbol_filename_ftype
*fun
, void *data
,
548 /* Target-agnostic function to load the sections of an executable into memory.
550 ARGS should be in the form "EXECUTABLE [OFFSET]", where OFFSET is an
551 optional offset to apply to each section. */
552 extern void generic_load (const char *args
, int from_tty
);
554 /* From dwarf2read.c */
556 /* Names for a dwarf2 debugging section. The field NORMAL is the normal
557 section name (usually from the DWARF standard), while the field COMPRESSED
558 is the name of compressed sections. If your object file format doesn't
559 support compressed sections, the field COMPRESSED can be NULL. Likewise,
560 the debugging section is not supported, the field NORMAL can be NULL too.
561 It doesn't make sense to have a NULL NORMAL field but a non-NULL COMPRESSED
564 struct dwarf2_section_names
{
566 const char *compressed
;
569 /* List of names for dward2 debugging sections. Also most object file formats
570 use the standardized (ie ELF) names, some (eg XCOFF) have customized names
572 The table for the standard names is defined in dwarf2read.c. Please
573 update all instances of dwarf2_debug_sections if you add a field to this
574 structure. It is always safe to use { NULL, NULL } in this case. */
576 struct dwarf2_debug_sections
{
577 struct dwarf2_section_names info
;
578 struct dwarf2_section_names abbrev
;
579 struct dwarf2_section_names line
;
580 struct dwarf2_section_names loc
;
581 struct dwarf2_section_names loclists
;
582 struct dwarf2_section_names macinfo
;
583 struct dwarf2_section_names macro
;
584 struct dwarf2_section_names str
;
585 struct dwarf2_section_names str_offsets
;
586 struct dwarf2_section_names line_str
;
587 struct dwarf2_section_names ranges
;
588 struct dwarf2_section_names rnglists
;
589 struct dwarf2_section_names types
;
590 struct dwarf2_section_names addr
;
591 struct dwarf2_section_names frame
;
592 struct dwarf2_section_names eh_frame
;
593 struct dwarf2_section_names gdb_index
;
594 struct dwarf2_section_names debug_names
;
595 struct dwarf2_section_names debug_aranges
;
596 /* This field has no meaning, but exists solely to catch changes to
597 this structure which are not reflected in some instance. */
601 extern int dwarf2_has_info (struct objfile
*,
602 const struct dwarf2_debug_sections
*,
605 /* Dwarf2 sections that can be accessed by dwarf2_get_section_info. */
606 enum dwarf2_section_enum
{
611 extern void dwarf2_get_section_info (struct objfile
*,
612 enum dwarf2_section_enum
,
613 asection
**, const gdb_byte
**,
616 /* A DWARF names index variant. */
617 enum class dw_index_kind
619 /* GDB's own .gdb_index format. */
622 /* DWARF5 .debug_names. */
626 /* Initialize for reading DWARF for OBJFILE. Return false if this
627 file will use psymtabs, or true if using an index, in which case
628 *INDEX_KIND is set to the index variant in use. */
629 extern bool dwarf2_initialize_objfile (struct objfile
*objfile
,
630 dw_index_kind
*index_kind
);
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 minidebug.c. */
639 extern gdb_bfd_ref_ptr
find_separate_debug_file_in_section (struct objfile
*);
641 /* True if we are printing debug output about separate debug info files. */
643 extern bool separate_debug_file_debug
;
645 #endif /* !defined(SYMFILE_H) */