1 /* Definitions for reading symbol files into GDB.
3 Copyright (C) 1990-2018 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
,
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. */
68 /* Define an array of addresses to accommodate non-contiguous dynamic
69 loading of modules. This is for use when entering commands, so we
70 can keep track of the section names until we read the file and can
71 map them to bfd sections. This structure is also used by solib.c
72 to communicate the section addresses in shared objects to
73 symbol_file_add (). */
75 typedef std::vector
<other_sections
> section_addr_info
;
77 /* A table listing the load segments in a symfile, and which segment
78 each BFD section belongs to. */
79 struct symfile_segment_data
81 /* How many segments are present in this file. If there are
82 two, the text segment is the first one and the data segment
86 /* If NUM_SEGMENTS is greater than zero, the original base address
88 CORE_ADDR
*segment_bases
;
90 /* If NUM_SEGMENTS is greater than zero, the memory size of each
92 CORE_ADDR
*segment_sizes
;
94 /* If NUM_SEGMENTS is greater than zero, this is an array of entries
95 recording which segment contains each BFD section.
96 SEGMENT_INFO[I] is S+1 if the I'th BFD section belongs to segment
97 S, or zero if it is not in any segment. */
101 /* Callback for quick_symbol_functions->map_symbol_filenames. */
103 typedef void (symbol_filename_ftype
) (const char *filename
,
104 const char *fullname
, void *data
);
106 /* Callback for quick_symbol_functions->expand_symtabs_matching
107 to match a file name. */
109 typedef bool (expand_symtabs_file_matcher_ftype
) (const char *filename
,
112 /* Callback for quick_symbol_functions->expand_symtabs_matching
113 to match a symbol name. */
115 typedef bool (expand_symtabs_symbol_matcher_ftype
) (const char *name
);
117 /* Callback for quick_symbol_functions->expand_symtabs_matching
118 to be called after a symtab has been expanded. */
120 typedef void (expand_symtabs_exp_notify_ftype
) (compunit_symtab
*symtab
);
122 /* The "quick" symbol functions exist so that symbol readers can
123 avoiding an initial read of all the symbols. For example, symbol
124 readers might choose to use the "partial symbol table" utilities,
125 which is one implementation of the quick symbol functions.
127 The quick symbol functions are generally opaque: the underlying
128 representation is hidden from the caller.
130 In general, these functions should only look at whatever special
131 index the symbol reader creates -- looking through the symbol
132 tables themselves is handled by generic code. If a function is
133 defined as returning a "symbol table", this means that the function
134 should only return a newly-created symbol table; it should not
135 examine pre-existing ones.
137 The exact list of functions here was determined in an ad hoc way
138 based on gdb's history. */
140 struct quick_symbol_functions
142 /* Return true if this objfile has any "partial" symbols
144 int (*has_symbols
) (struct objfile
*objfile
);
146 /* Return the symbol table for the "last" file appearing in
148 struct symtab
*(*find_last_source_symtab
) (struct objfile
*objfile
);
150 /* Forget all cached full file names for OBJFILE. */
151 void (*forget_cached_source_info
) (struct objfile
*objfile
);
153 /* Expand and iterate over each "partial" symbol table in OBJFILE
154 where the source file is named NAME.
156 If NAME is not absolute, a match after a '/' in the symbol table's
157 file name will also work, REAL_PATH is NULL then. If NAME is
158 absolute then REAL_PATH is non-NULL absolute file name as resolved
159 via gdb_realpath from NAME.
161 If a match is found, the "partial" symbol table is expanded.
162 Then, this calls iterate_over_some_symtabs (or equivalent) over
163 all newly-created symbol tables, passing CALLBACK to it.
164 The result of this call is returned. */
165 bool (*map_symtabs_matching_filename
)
166 (struct objfile
*objfile
, const char *name
, const char *real_path
,
167 gdb::function_view
<bool (symtab
*)> callback
);
169 /* Check to see if the symbol is defined in a "partial" symbol table
170 of OBJFILE. BLOCK_INDEX should be either GLOBAL_BLOCK or STATIC_BLOCK,
171 depending on whether we want to search global symbols or static
172 symbols. NAME is the name of the symbol to look for. DOMAIN
173 indicates what sort of symbol to search for.
175 Returns the newly-expanded compunit in which the symbol is
176 defined, or NULL if no such symbol table exists. If OBJFILE
177 contains !TYPE_OPAQUE symbol prefer its compunit. If it contains
178 only TYPE_OPAQUE symbol(s), return at least that compunit. */
179 struct compunit_symtab
*(*lookup_symbol
) (struct objfile
*objfile
,
180 int block_index
, const char *name
,
183 /* Print statistics about any indices loaded for OBJFILE. The
184 statistics should be printed to gdb_stdout. This is used for
185 "maint print statistics". */
186 void (*print_stats
) (struct objfile
*objfile
);
188 /* Dump any indices loaded for OBJFILE. The dump should go to
189 gdb_stdout. This is used for "maint print objfiles". */
190 void (*dump
) (struct objfile
*objfile
);
192 /* This is called by objfile_relocate to relocate any indices loaded
194 void (*relocate
) (struct objfile
*objfile
,
195 const struct section_offsets
*new_offsets
,
196 const struct section_offsets
*delta
);
198 /* Find all the symbols in OBJFILE named FUNC_NAME, and ensure that
199 the corresponding symbol tables are loaded. */
200 void (*expand_symtabs_for_function
) (struct objfile
*objfile
,
201 const char *func_name
);
203 /* Read all symbol tables associated with OBJFILE. */
204 void (*expand_all_symtabs
) (struct objfile
*objfile
);
206 /* Read all symbol tables associated with OBJFILE which have
207 symtab_to_fullname equal to FULLNAME.
208 This is for the purposes of examining code only, e.g., expand_line_sal.
209 The routine may ignore debug info that is known to not be useful with
210 code, e.g., DW_TAG_type_unit for dwarf debug info. */
211 void (*expand_symtabs_with_fullname
) (struct objfile
*objfile
,
212 const char *fullname
);
214 /* Find global or static symbols in all tables that are in DOMAIN
215 and for which MATCH (symbol name, NAME) == 0, passing each to
216 CALLBACK, reading in partial symbol tables as needed. Look
217 through global symbols if GLOBAL and otherwise static symbols.
218 Passes NAME, NAMESPACE, and DATA to CALLBACK with each symbol
219 found. After each block is processed, passes NULL to CALLBACK.
220 MATCH must be weaker than strcmp_iw_ordered in the sense that
221 strcmp_iw_ordered(x,y) == 0 --> MATCH(x,y) == 0. ORDERED_COMPARE,
222 if non-null, must be an ordering relation compatible with
223 strcmp_iw_ordered in the sense that
224 strcmp_iw_ordered(x,y) == 0 --> ORDERED_COMPARE(x,y) == 0
226 strcmp_iw_ordered(x,y) <= 0 --> ORDERED_COMPARE(x,y) <= 0
227 (allowing strcmp_iw_ordered(x,y) < 0 while ORDERED_COMPARE(x, y) == 0).
228 CALLBACK returns 0 to indicate that the scan should continue, or
229 non-zero to indicate that the scan should be terminated. */
231 void (*map_matching_symbols
) (struct objfile
*,
232 const char *name
, domain_enum domain
,
234 int (*callback
) (struct block
*,
235 struct symbol
*, void *),
237 symbol_name_match_type match
,
238 symbol_compare_ftype
*ordered_compare
);
240 /* Expand all symbol tables in OBJFILE matching some criteria.
242 FILE_MATCHER is called for each file in OBJFILE. The file name
243 is passed to it. If the matcher returns false, the file is
244 skipped. If FILE_MATCHER is NULL the file is not skipped. If
245 BASENAMES is true the matcher should consider only file base
246 names (the passed file name is already only the lbasename'd
249 Otherwise, if KIND does not match, this symbol is skipped.
251 If even KIND matches, SYMBOL_MATCHER is called for each symbol
252 defined in the file. The symbol "search" name is passed to
255 If SYMBOL_MATCHER returns false, then the symbol is skipped.
257 Otherwise, the symbol's symbol table is expanded. */
258 void (*expand_symtabs_matching
)
259 (struct objfile
*objfile
,
260 gdb::function_view
<expand_symtabs_file_matcher_ftype
> file_matcher
,
261 const lookup_name_info
&lookup_name
,
262 gdb::function_view
<expand_symtabs_symbol_matcher_ftype
> symbol_matcher
,
263 gdb::function_view
<expand_symtabs_exp_notify_ftype
> expansion_notify
,
264 enum search_domain kind
);
266 /* Return the comp unit from OBJFILE that contains PC and
267 SECTION. Return NULL if there is no such compunit. This
268 should return the compunit that contains a symbol whose
269 address exactly matches PC, or, if there is no exact match, the
270 compunit that contains a symbol whose address is closest to
272 struct compunit_symtab
*(*find_pc_sect_compunit_symtab
)
273 (struct objfile
*objfile
, struct bound_minimal_symbol msymbol
,
274 CORE_ADDR pc
, struct obj_section
*section
, int warn_if_readin
);
276 /* Return the comp unit from OBJFILE that contains a symbol at
277 ADDRESS. Return NULL if there is no such comp unit. Unlike
278 find_pc_sect_compunit_symtab, any sort of symbol (not just text
279 symbols) can be considered, and only exact address matches are
280 considered. This pointer may be NULL. */
281 struct compunit_symtab
*(*find_compunit_symtab_by_address
)
282 (struct objfile
*objfile
, CORE_ADDR address
);
284 /* Call a callback for every file defined in OBJFILE whose symtab is
285 not already read in. FUN is the callback. It is passed the file's
286 FILENAME, the file's FULLNAME (if need_fullname is non-zero), and
287 the DATA passed to this function. */
288 void (*map_symbol_filenames
) (struct objfile
*objfile
,
289 symbol_filename_ftype
*fun
, void *data
,
293 /* Structure of functions used for probe support. If one of these functions
294 is provided, all must be. */
298 /* If non-NULL, return a reference to vector of probe objects. */
299 const std::vector
<probe
*> &(*sym_get_probes
) (struct objfile
*);
302 /* Structure to keep track of symbol reading functions for various
303 object file types. */
307 /* Initializes anything that is global to the entire symbol table.
308 It is called during symbol_file_add, when we begin debugging an
309 entirely new program. */
311 void (*sym_new_init
) (struct objfile
*);
313 /* Reads any initial information from a symbol file, and initializes
314 the struct sym_fns SF in preparation for sym_read(). It is
315 called every time we read a symbol file for any reason. */
317 void (*sym_init
) (struct objfile
*);
319 /* sym_read (objfile, symfile_flags) Reads a symbol file into a psymtab
320 (or possibly a symtab). OBJFILE is the objfile struct for the
321 file we are reading. SYMFILE_FLAGS are the flags passed to
322 symbol_file_add & co. */
324 void (*sym_read
) (struct objfile
*, symfile_add_flags
);
326 /* Read the partial symbols for an objfile. This may be NULL, in which case
327 gdb has to check other ways if this objfile has any symbols. This may
328 only be non-NULL if the objfile actually does have debuginfo available.
331 void (*sym_read_psymbols
) (struct objfile
*);
333 /* Called when we are finished with an objfile. Should do all
334 cleanup that is specific to the object file format for the
335 particular objfile. */
337 void (*sym_finish
) (struct objfile
*);
340 /* This function produces a file-dependent section_offsets
341 structure, allocated in the objfile's storage.
343 The section_addr_info structure contains the offset of loadable and
344 allocated sections, relative to the absolute offsets found in the BFD. */
346 void (*sym_offsets
) (struct objfile
*, const section_addr_info
&);
348 /* This function produces a format-independent description of
349 the segments of ABFD. Each segment is a unit of the file
350 which may be relocated independently. */
352 struct symfile_segment_data
*(*sym_segments
) (bfd
*abfd
);
354 /* This function should read the linetable from the objfile when
355 the line table cannot be read while processing the debugging
358 void (*sym_read_linetable
) (struct objfile
*);
360 /* Relocate the contents of a debug section SECTP. The
361 contents are stored in BUF if it is non-NULL, or returned in a
362 malloc'd buffer otherwise. */
364 bfd_byte
*(*sym_relocate
) (struct objfile
*, asection
*sectp
, bfd_byte
*buf
);
366 /* If non-NULL, this objfile has probe support, and all the probe
367 functions referred to here will be non-NULL. */
368 const struct sym_probe_fns
*sym_probe_fns
;
370 /* The "quick" (aka partial) symbol functions for this symbol
372 const struct quick_symbol_functions
*qf
;
375 extern section_addr_info
376 build_section_addr_info_from_objfile (const struct objfile
*objfile
);
378 extern void relative_addr_info_to_section_offsets
379 (struct section_offsets
*section_offsets
, int num_sections
,
380 const section_addr_info
&addrs
);
382 extern void addr_info_make_relative (section_addr_info
*addrs
,
385 /* The default version of sym_fns.sym_offsets for readers that don't
386 do anything special. */
388 extern void default_symfile_offsets (struct objfile
*objfile
,
389 const section_addr_info
&);
391 /* The default version of sym_fns.sym_segments for readers that don't
392 do anything special. */
394 extern struct symfile_segment_data
*default_symfile_segments (bfd
*abfd
);
396 /* The default version of sym_fns.sym_relocate for readers that don't
397 do anything special. */
399 extern bfd_byte
*default_symfile_relocate (struct objfile
*objfile
,
400 asection
*sectp
, bfd_byte
*buf
);
402 extern struct symtab
*allocate_symtab (struct compunit_symtab
*, const char *)
403 ATTRIBUTE_NONNULL (1);
405 extern struct compunit_symtab
*allocate_compunit_symtab (struct objfile
*,
407 ATTRIBUTE_NONNULL (1);
409 extern void add_compunit_symtab_to_objfile (struct compunit_symtab
*cu
);
411 extern void add_symtab_fns (enum bfd_flavour flavour
, const struct sym_fns
*);
413 extern void clear_symtab_users (symfile_add_flags add_flags
);
415 extern enum language
deduce_language_from_filename (const char *);
417 /* Map the filename extension EXT to the language LANG. Any previous
418 association of EXT will be removed. EXT will be copied by this
420 extern void add_filename_language (const char *ext
, enum language lang
);
422 extern struct objfile
*symbol_file_add (const char *, symfile_add_flags
,
423 section_addr_info
*, objfile_flags
);
425 extern struct objfile
*symbol_file_add_from_bfd (bfd
*, const char *, symfile_add_flags
,
427 objfile_flags
, struct objfile
*parent
);
429 extern void symbol_file_add_separate (bfd
*, const char *, symfile_add_flags
,
432 extern std::string
find_separate_debug_file_by_debuglink (struct objfile
*);
434 /* Build (allocate and populate) a section_addr_info struct from an
435 existing section table. */
437 extern section_addr_info
438 build_section_addr_info_from_section_table (const struct target_section
440 const struct target_section
445 /* If non-zero, shared library symbols will be added automatically
446 when the inferior is created, new libraries are loaded, or when
447 attaching to the inferior. This is almost always what users will
448 want to have happen; but for very large programs, the startup time
449 will be excessive, and so if this is a problem, the user can clear
450 this flag and then add the shared library symbols as needed. Note
451 that there is a potential for confusion, since if the shared
452 library symbols are not loaded, commands like "info fun" will *not*
453 report all the functions that are actually present. */
455 extern int auto_solib_add
;
459 extern void set_initial_language (void);
461 extern void find_lowest_section (bfd
*, asection
*, void *);
463 extern gdb_bfd_ref_ptr
symfile_bfd_open (const char *);
465 extern int get_section_index (struct objfile
*, const char *);
467 extern int print_symbol_loading_p (int from_tty
, int mainline
, int full
);
469 /* Utility functions for overlay sections: */
470 extern enum overlay_debugging_state
476 extern int overlay_cache_invalid
;
478 /* Return the "mapped" overlay section containing the PC. */
479 extern struct obj_section
*find_pc_mapped_section (CORE_ADDR
);
481 /* Return any overlay section containing the PC (even in its LMA
483 extern struct obj_section
*find_pc_overlay (CORE_ADDR
);
485 /* Return true if the section is an overlay. */
486 extern int section_is_overlay (struct obj_section
*);
488 /* Return true if the overlay section is currently "mapped". */
489 extern int section_is_mapped (struct obj_section
*);
491 /* Return true if pc belongs to section's VMA. */
492 extern CORE_ADDR
pc_in_mapped_range (CORE_ADDR
, struct obj_section
*);
494 /* Return true if pc belongs to section's LMA. */
495 extern CORE_ADDR
pc_in_unmapped_range (CORE_ADDR
, struct obj_section
*);
497 /* Map an address from a section's LMA to its VMA. */
498 extern CORE_ADDR
overlay_mapped_address (CORE_ADDR
, struct obj_section
*);
500 /* Map an address from a section's VMA to its LMA. */
501 extern CORE_ADDR
overlay_unmapped_address (CORE_ADDR
, struct obj_section
*);
503 /* Convert an address in an overlay section (force into VMA range). */
504 extern CORE_ADDR
symbol_overlayed_address (CORE_ADDR
, struct obj_section
*);
506 /* Load symbols from a file. */
507 extern void symbol_file_add_main (const char *args
,
508 symfile_add_flags add_flags
);
510 /* Clear GDB symbol tables. */
511 extern void symbol_file_clear (int from_tty
);
513 /* Default overlay update function. */
514 extern void simple_overlay_update (struct obj_section
*);
516 extern bfd_byte
*symfile_relocate_debug_section (struct objfile
*, asection
*,
519 extern int symfile_map_offsets_to_segments (bfd
*,
520 const struct symfile_segment_data
*,
521 struct section_offsets
*,
522 int, const CORE_ADDR
*);
523 struct symfile_segment_data
*get_symfile_segment_data (bfd
*abfd
);
524 void free_symfile_segment_data (struct symfile_segment_data
*data
);
526 extern scoped_restore_tmpl
<int> increment_reading_symtab (void);
528 void expand_symtabs_matching
529 (gdb::function_view
<expand_symtabs_file_matcher_ftype
> file_matcher
,
530 const lookup_name_info
&lookup_name
,
531 gdb::function_view
<expand_symtabs_symbol_matcher_ftype
> symbol_matcher
,
532 gdb::function_view
<expand_symtabs_exp_notify_ftype
> expansion_notify
,
533 enum search_domain kind
);
535 void map_symbol_filenames (symbol_filename_ftype
*fun
, void *data
,
538 /* From dwarf2read.c */
540 /* Names for a dwarf2 debugging section. The field NORMAL is the normal
541 section name (usually from the DWARF standard), while the field COMPRESSED
542 is the name of compressed sections. If your object file format doesn't
543 support compressed sections, the field COMPRESSED can be NULL. Likewise,
544 the debugging section is not supported, the field NORMAL can be NULL too.
545 It doesn't make sense to have a NULL NORMAL field but a non-NULL COMPRESSED
548 struct dwarf2_section_names
{
550 const char *compressed
;
553 /* List of names for dward2 debugging sections. Also most object file formats
554 use the standardized (ie ELF) names, some (eg XCOFF) have customized names
556 The table for the standard names is defined in dwarf2read.c. Please
557 update all instances of dwarf2_debug_sections if you add a field to this
558 structure. It is always safe to use { NULL, NULL } in this case. */
560 struct dwarf2_debug_sections
{
561 struct dwarf2_section_names info
;
562 struct dwarf2_section_names abbrev
;
563 struct dwarf2_section_names line
;
564 struct dwarf2_section_names loc
;
565 struct dwarf2_section_names loclists
;
566 struct dwarf2_section_names macinfo
;
567 struct dwarf2_section_names macro
;
568 struct dwarf2_section_names str
;
569 struct dwarf2_section_names line_str
;
570 struct dwarf2_section_names ranges
;
571 struct dwarf2_section_names rnglists
;
572 struct dwarf2_section_names types
;
573 struct dwarf2_section_names addr
;
574 struct dwarf2_section_names frame
;
575 struct dwarf2_section_names eh_frame
;
576 struct dwarf2_section_names gdb_index
;
577 struct dwarf2_section_names debug_names
;
578 struct dwarf2_section_names debug_aranges
;
579 /* This field has no meaning, but exists solely to catch changes to
580 this structure which are not reflected in some instance. */
584 extern int dwarf2_has_info (struct objfile
*,
585 const struct dwarf2_debug_sections
*);
587 /* Dwarf2 sections that can be accessed by dwarf2_get_section_info. */
588 enum dwarf2_section_enum
{
593 extern void dwarf2_get_section_info (struct objfile
*,
594 enum dwarf2_section_enum
,
595 asection
**, const gdb_byte
**,
598 /* A DWARF names index variant. */
599 enum class dw_index_kind
601 /* GDB's own .gdb_index format. */
604 /* DWARF5 .debug_names. */
608 /* Initialize for reading DWARF for OBJFILE. Return false if this
609 file will use psymtabs, or true if using an index, in which case
610 *INDEX_KIND is set to the index variant in use. */
611 extern bool dwarf2_initialize_objfile (struct objfile
*objfile
,
612 dw_index_kind
*index_kind
);
614 extern void dwarf2_build_psymtabs (struct objfile
*);
615 extern void dwarf2_build_frame_info (struct objfile
*);
617 void dwarf2_free_objfile (struct objfile
*);
619 /* From mdebugread.c */
621 extern void mdebug_build_psymtabs (minimal_symbol_reader
&,
623 const struct ecoff_debug_swap
*,
624 struct ecoff_debug_info
*);
626 extern void elfmdebug_build_psymtabs (struct objfile
*,
627 const struct ecoff_debug_swap
*,
630 /* From minidebug.c. */
632 extern gdb_bfd_ref_ptr
find_separate_debug_file_in_section (struct objfile
*);
634 /* True if we are printing debug output about separate debug info files. */
636 extern int separate_debug_file_debug
;
638 #endif /* !defined(SYMFILE_H) */