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
85 segment (CORE_ADDR base
, CORE_ADDR size
)
86 : base (base
), size (size
)
89 /* The original base address the segment. */
92 /* The memory size of the segment. */
96 ~symfile_segment_data ()
98 xfree (this->segment_info
);
101 /* The segments present in this file. If there are
102 two, the text segment is the first one and the data segment
103 is the second one. */
104 std::vector
<segment
> segments
;
106 /* This is an array of entries recording which segment contains each BFD
107 section. SEGMENT_INFO[I] is S+1 if the I'th BFD section belongs to segment
108 S, or zero if it is not in any segment. */
109 int *segment_info
= nullptr;
112 using symfile_segment_data_up
= std::unique_ptr
<symfile_segment_data
>;
114 /* Callback for quick_symbol_functions->map_symbol_filenames. */
116 typedef void (symbol_filename_ftype
) (const char *filename
,
117 const char *fullname
, void *data
);
119 /* Callback for quick_symbol_functions->expand_symtabs_matching
120 to match a file name. */
122 typedef bool (expand_symtabs_file_matcher_ftype
) (const char *filename
,
125 /* Callback for quick_symbol_functions->expand_symtabs_matching
126 to match a symbol name. */
128 typedef bool (expand_symtabs_symbol_matcher_ftype
) (const char *name
);
130 /* Callback for quick_symbol_functions->expand_symtabs_matching
131 to be called after a symtab has been expanded. */
133 typedef void (expand_symtabs_exp_notify_ftype
) (compunit_symtab
*symtab
);
135 /* The "quick" symbol functions exist so that symbol readers can
136 avoiding an initial read of all the symbols. For example, symbol
137 readers might choose to use the "partial symbol table" utilities,
138 which is one implementation of the quick symbol functions.
140 The quick symbol functions are generally opaque: the underlying
141 representation is hidden from the caller.
143 In general, these functions should only look at whatever special
144 index the symbol reader creates -- looking through the symbol
145 tables themselves is handled by generic code. If a function is
146 defined as returning a "symbol table", this means that the function
147 should only return a newly-created symbol table; it should not
148 examine pre-existing ones.
150 The exact list of functions here was determined in an ad hoc way
151 based on gdb's history. */
153 struct quick_symbol_functions
155 /* Return true if this objfile has any "partial" symbols
157 int (*has_symbols
) (struct objfile
*objfile
);
159 /* Return the symbol table for the "last" file appearing in
161 struct symtab
*(*find_last_source_symtab
) (struct objfile
*objfile
);
163 /* Forget all cached full file names for OBJFILE. */
164 void (*forget_cached_source_info
) (struct objfile
*objfile
);
166 /* Expand and iterate over each "partial" symbol table in OBJFILE
167 where the source file is named NAME.
169 If NAME is not absolute, a match after a '/' in the symbol table's
170 file name will also work, REAL_PATH is NULL then. If NAME is
171 absolute then REAL_PATH is non-NULL absolute file name as resolved
172 via gdb_realpath from NAME.
174 If a match is found, the "partial" symbol table is expanded.
175 Then, this calls iterate_over_some_symtabs (or equivalent) over
176 all newly-created symbol tables, passing CALLBACK to it.
177 The result of this call is returned. */
178 bool (*map_symtabs_matching_filename
)
179 (struct objfile
*objfile
, const char *name
, const char *real_path
,
180 gdb::function_view
<bool (symtab
*)> callback
);
182 /* Check to see if the symbol is defined in a "partial" symbol table
183 of OBJFILE. BLOCK_INDEX should be either GLOBAL_BLOCK or STATIC_BLOCK,
184 depending on whether we want to search global symbols or static
185 symbols. NAME is the name of the symbol to look for. DOMAIN
186 indicates what sort of symbol to search for.
188 Returns the newly-expanded compunit in which the symbol is
189 defined, or NULL if no such symbol table exists. If OBJFILE
190 contains !TYPE_OPAQUE symbol prefer its compunit. If it contains
191 only TYPE_OPAQUE symbol(s), return at least that compunit. */
192 struct compunit_symtab
*(*lookup_symbol
) (struct objfile
*objfile
,
193 block_enum block_index
,
197 /* Check to see if the global symbol is defined in a "partial" symbol table
198 of OBJFILE. NAME is the name of the symbol to look for. DOMAIN
199 indicates what sort of symbol to search for.
201 If found, sets *symbol_found_p to true and returns the symbol language.
202 defined, or NULL if no such symbol table exists. */
203 enum language (*lookup_global_symbol_language
) (struct objfile
*objfile
,
206 bool *symbol_found_p
);
208 /* Print statistics about any indices loaded for OBJFILE. The
209 statistics should be printed to gdb_stdout. This is used for
210 "maint print statistics". */
211 void (*print_stats
) (struct objfile
*objfile
);
213 /* Dump any indices loaded for OBJFILE. The dump should go to
214 gdb_stdout. This is used for "maint print objfiles". */
215 void (*dump
) (struct objfile
*objfile
);
217 /* Find all the symbols in OBJFILE named FUNC_NAME, and ensure that
218 the corresponding symbol tables are loaded. */
219 void (*expand_symtabs_for_function
) (struct objfile
*objfile
,
220 const char *func_name
);
222 /* Read all symbol tables associated with OBJFILE. */
223 void (*expand_all_symtabs
) (struct objfile
*objfile
);
225 /* Read all symbol tables associated with OBJFILE which have
226 symtab_to_fullname equal to FULLNAME.
227 This is for the purposes of examining code only, e.g., expand_line_sal.
228 The routine may ignore debug info that is known to not be useful with
229 code, e.g., DW_TAG_type_unit for dwarf debug info. */
230 void (*expand_symtabs_with_fullname
) (struct objfile
*objfile
,
231 const char *fullname
);
233 /* Find global or static symbols in all tables that are in DOMAIN
234 and for which MATCH (symbol name, NAME) == 0, passing each to
235 CALLBACK, reading in partial symbol tables as needed. Look
236 through global symbols if GLOBAL and otherwise static symbols.
237 Passes NAME and NAMESPACE to CALLBACK with each symbol
238 found. After each block is processed, passes NULL to CALLBACK.
239 MATCH must be weaker than strcmp_iw_ordered in the sense that
240 strcmp_iw_ordered(x,y) == 0 --> MATCH(x,y) == 0. ORDERED_COMPARE,
241 if non-null, must be an ordering relation compatible with
242 strcmp_iw_ordered in the sense that
243 strcmp_iw_ordered(x,y) == 0 --> ORDERED_COMPARE(x,y) == 0
245 strcmp_iw_ordered(x,y) <= 0 --> ORDERED_COMPARE(x,y) <= 0
246 (allowing strcmp_iw_ordered(x,y) < 0 while ORDERED_COMPARE(x, y) == 0).
247 CALLBACK returns true to indicate that the scan should continue, or
248 false to indicate that the scan should be terminated. */
250 void (*map_matching_symbols
)
252 const lookup_name_info
&lookup_name
,
255 gdb::function_view
<symbol_found_callback_ftype
> callback
,
256 symbol_compare_ftype
*ordered_compare
);
258 /* Expand all symbol tables in OBJFILE matching some criteria.
260 FILE_MATCHER is called for each file in OBJFILE. The file name
261 is passed to it. If the matcher returns false, the file is
262 skipped. If FILE_MATCHER is NULL the file is not skipped. If
263 BASENAMES is true the matcher should consider only file base
264 names (the passed file name is already only the lbasename'd
267 If the file is not skipped, and SYMBOL_MATCHER and LOOKUP_NAME are NULL,
268 the symbol table is expanded.
270 Otherwise, individual symbols are considered.
272 If KIND does not match, the symbol is skipped.
274 If the symbol name does not match LOOKUP_NAME, the symbol is skipped.
276 If SYMBOL_MATCHER returns false, then the symbol is skipped.
278 Otherwise, the symbol's symbol table is expanded. */
279 void (*expand_symtabs_matching
)
280 (struct objfile
*objfile
,
281 gdb::function_view
<expand_symtabs_file_matcher_ftype
> file_matcher
,
282 const lookup_name_info
*lookup_name
,
283 gdb::function_view
<expand_symtabs_symbol_matcher_ftype
> symbol_matcher
,
284 gdb::function_view
<expand_symtabs_exp_notify_ftype
> expansion_notify
,
285 enum search_domain kind
);
287 /* Return the comp unit from OBJFILE that contains PC and
288 SECTION. Return NULL if there is no such compunit. This
289 should return the compunit that contains a symbol whose
290 address exactly matches PC, or, if there is no exact match, the
291 compunit that contains a symbol whose address is closest to
293 struct compunit_symtab
*(*find_pc_sect_compunit_symtab
)
294 (struct objfile
*objfile
, struct bound_minimal_symbol msymbol
,
295 CORE_ADDR pc
, struct obj_section
*section
, int warn_if_readin
);
297 /* Return the comp unit from OBJFILE that contains a symbol at
298 ADDRESS. Return NULL if there is no such comp unit. Unlike
299 find_pc_sect_compunit_symtab, any sort of symbol (not just text
300 symbols) can be considered, and only exact address matches are
301 considered. This pointer may be NULL. */
302 struct compunit_symtab
*(*find_compunit_symtab_by_address
)
303 (struct objfile
*objfile
, CORE_ADDR address
);
305 /* Call a callback for every file defined in OBJFILE whose symtab is
306 not already read in. FUN is the callback. It is passed the file's
307 FILENAME, the file's FULLNAME (if need_fullname is non-zero), and
308 the DATA passed to this function. */
309 void (*map_symbol_filenames
) (struct objfile
*objfile
,
310 symbol_filename_ftype
*fun
, void *data
,
314 /* Structure of functions used for probe support. If one of these functions
315 is provided, all must be. */
319 /* If non-NULL, return a reference to vector of probe objects. */
320 const std::vector
<std::unique_ptr
<probe
>> &(*sym_get_probes
)
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 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 symfile_segment_data_up (*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 section_addr_info
398 build_section_addr_info_from_objfile (const struct objfile
*objfile
);
400 extern void relative_addr_info_to_section_offsets
401 (section_offsets
§ion_offsets
, const section_addr_info
&addrs
);
403 extern void addr_info_make_relative (section_addr_info
*addrs
,
406 /* The default version of sym_fns.sym_offsets for readers that don't
407 do anything special. */
409 extern void default_symfile_offsets (struct objfile
*objfile
,
410 const section_addr_info
&);
412 /* The default version of sym_fns.sym_segments for readers that don't
413 do anything special. */
415 extern symfile_segment_data_up
default_symfile_segments (bfd
*abfd
);
417 /* The default version of sym_fns.sym_relocate for readers that don't
418 do anything special. */
420 extern bfd_byte
*default_symfile_relocate (struct objfile
*objfile
,
421 asection
*sectp
, bfd_byte
*buf
);
423 extern struct symtab
*allocate_symtab (struct compunit_symtab
*, const char *)
424 ATTRIBUTE_NONNULL (1);
426 extern struct compunit_symtab
*allocate_compunit_symtab (struct objfile
*,
428 ATTRIBUTE_NONNULL (1);
430 extern void add_compunit_symtab_to_objfile (struct compunit_symtab
*cu
);
432 extern void add_symtab_fns (enum bfd_flavour flavour
, const struct sym_fns
*);
434 extern void clear_symtab_users (symfile_add_flags add_flags
);
436 extern enum language
deduce_language_from_filename (const char *);
438 /* Map the filename extension EXT to the language LANG. Any previous
439 association of EXT will be removed. EXT will be copied by this
441 extern void add_filename_language (const char *ext
, enum language lang
);
443 extern struct objfile
*symbol_file_add (const char *, symfile_add_flags
,
444 section_addr_info
*, objfile_flags
);
446 extern struct objfile
*symbol_file_add_from_bfd (bfd
*, const char *, symfile_add_flags
,
448 objfile_flags
, struct objfile
*parent
);
450 extern void symbol_file_add_separate (bfd
*, const char *, symfile_add_flags
,
453 extern std::string
find_separate_debug_file_by_debuglink (struct objfile
*);
455 /* Build (allocate and populate) a section_addr_info struct from an
456 existing section table. */
458 extern section_addr_info
459 build_section_addr_info_from_section_table (const struct target_section
461 const struct target_section
466 /* If true, shared library symbols will be added automatically
467 when the inferior is created, new libraries are loaded, or when
468 attaching to the inferior. This is almost always what users will
469 want to have happen; but for very large programs, the startup time
470 will be excessive, and so if this is a problem, the user can clear
471 this flag and then add the shared library symbols as needed. Note
472 that there is a potential for confusion, since if the shared
473 library symbols are not loaded, commands like "info fun" will *not*
474 report all the functions that are actually present. */
476 extern bool auto_solib_add
;
480 extern void set_initial_language (void);
482 extern void find_lowest_section (bfd
*, asection
*, void *);
484 extern gdb_bfd_ref_ptr
symfile_bfd_open (const char *);
486 extern int get_section_index (struct objfile
*, const char *);
488 extern int print_symbol_loading_p (int from_tty
, int mainline
, int full
);
490 /* Utility functions for overlay sections: */
491 extern enum overlay_debugging_state
497 extern int overlay_cache_invalid
;
499 /* Return the "mapped" overlay section containing the PC. */
500 extern struct obj_section
*find_pc_mapped_section (CORE_ADDR
);
502 /* Return any overlay section containing the PC (even in its LMA
504 extern struct obj_section
*find_pc_overlay (CORE_ADDR
);
506 /* Return true if the section is an overlay. */
507 extern int section_is_overlay (struct obj_section
*);
509 /* Return true if the overlay section is currently "mapped". */
510 extern int section_is_mapped (struct obj_section
*);
512 /* Return true if pc belongs to section's VMA. */
513 extern CORE_ADDR
pc_in_mapped_range (CORE_ADDR
, struct obj_section
*);
515 /* Return true if pc belongs to section's LMA. */
516 extern CORE_ADDR
pc_in_unmapped_range (CORE_ADDR
, struct obj_section
*);
518 /* Map an address from a section's LMA to its VMA. */
519 extern CORE_ADDR
overlay_mapped_address (CORE_ADDR
, struct obj_section
*);
521 /* Map an address from a section's VMA to its LMA. */
522 extern CORE_ADDR
overlay_unmapped_address (CORE_ADDR
, struct obj_section
*);
524 /* Convert an address in an overlay section (force into VMA range). */
525 extern CORE_ADDR
symbol_overlayed_address (CORE_ADDR
, struct obj_section
*);
527 /* Load symbols from a file. */
528 extern void symbol_file_add_main (const char *args
,
529 symfile_add_flags add_flags
);
531 /* Clear GDB symbol tables. */
532 extern void symbol_file_clear (int from_tty
);
534 /* Default overlay update function. */
535 extern void simple_overlay_update (struct obj_section
*);
537 extern bfd_byte
*symfile_relocate_debug_section (struct objfile
*, asection
*,
540 extern int symfile_map_offsets_to_segments (bfd
*,
541 const struct symfile_segment_data
*,
543 int, const CORE_ADDR
*);
544 symfile_segment_data_up
get_symfile_segment_data (bfd
*abfd
);
546 extern scoped_restore_tmpl
<int> increment_reading_symtab (void);
548 void expand_symtabs_matching
549 (gdb::function_view
<expand_symtabs_file_matcher_ftype
> file_matcher
,
550 const lookup_name_info
&lookup_name
,
551 gdb::function_view
<expand_symtabs_symbol_matcher_ftype
> symbol_matcher
,
552 gdb::function_view
<expand_symtabs_exp_notify_ftype
> expansion_notify
,
553 enum search_domain kind
);
555 void map_symbol_filenames (symbol_filename_ftype
*fun
, void *data
,
558 /* Target-agnostic function to load the sections of an executable into memory.
560 ARGS should be in the form "EXECUTABLE [OFFSET]", where OFFSET is an
561 optional offset to apply to each section. */
562 extern void generic_load (const char *args
, int from_tty
);
564 /* From dwarf2read.c */
566 /* Names for a dwarf2 debugging section. The field NORMAL is the normal
567 section name (usually from the DWARF standard), while the field COMPRESSED
568 is the name of compressed sections. If your object file format doesn't
569 support compressed sections, the field COMPRESSED can be NULL. Likewise,
570 the debugging section is not supported, the field NORMAL can be NULL too.
571 It doesn't make sense to have a NULL NORMAL field but a non-NULL COMPRESSED
574 struct dwarf2_section_names
{
576 const char *compressed
;
579 /* List of names for dward2 debugging sections. Also most object file formats
580 use the standardized (ie ELF) names, some (eg XCOFF) have customized names
582 The table for the standard names is defined in dwarf2read.c. Please
583 update all instances of dwarf2_debug_sections if you add a field to this
584 structure. It is always safe to use { NULL, NULL } in this case. */
586 struct dwarf2_debug_sections
{
587 struct dwarf2_section_names info
;
588 struct dwarf2_section_names abbrev
;
589 struct dwarf2_section_names line
;
590 struct dwarf2_section_names loc
;
591 struct dwarf2_section_names loclists
;
592 struct dwarf2_section_names macinfo
;
593 struct dwarf2_section_names macro
;
594 struct dwarf2_section_names str
;
595 struct dwarf2_section_names str_offsets
;
596 struct dwarf2_section_names line_str
;
597 struct dwarf2_section_names ranges
;
598 struct dwarf2_section_names rnglists
;
599 struct dwarf2_section_names types
;
600 struct dwarf2_section_names addr
;
601 struct dwarf2_section_names frame
;
602 struct dwarf2_section_names eh_frame
;
603 struct dwarf2_section_names gdb_index
;
604 struct dwarf2_section_names debug_names
;
605 struct dwarf2_section_names debug_aranges
;
606 /* This field has no meaning, but exists solely to catch changes to
607 this structure which are not reflected in some instance. */
611 extern int dwarf2_has_info (struct objfile
*,
612 const struct dwarf2_debug_sections
*,
615 /* Dwarf2 sections that can be accessed by dwarf2_get_section_info. */
616 enum dwarf2_section_enum
{
621 extern void dwarf2_get_section_info (struct objfile
*,
622 enum dwarf2_section_enum
,
623 asection
**, const gdb_byte
**,
626 /* A DWARF names index variant. */
627 enum class dw_index_kind
629 /* GDB's own .gdb_index format. */
632 /* DWARF5 .debug_names. */
636 /* Initialize for reading DWARF for OBJFILE. Return false if this
637 file will use psymtabs, or true if using an index, in which case
638 *INDEX_KIND is set to the index variant in use. */
639 extern bool dwarf2_initialize_objfile (struct objfile
*objfile
,
640 dw_index_kind
*index_kind
);
642 extern void dwarf2_build_psymtabs (struct objfile
*);
643 extern void dwarf2_build_frame_info (struct objfile
*);
645 void dwarf2_free_objfile (struct objfile
*);
647 /* From minidebug.c. */
649 extern gdb_bfd_ref_ptr
find_separate_debug_file_in_section (struct objfile
*);
651 /* True if we are printing debug output about separate debug info files. */
653 extern bool separate_debug_file_debug
;
655 #endif /* !defined(SYMFILE_H) */