1 /* Definitions for reading symbol files into GDB.
3 Copyright (C) 1990-2017 Free Software Foundation, Inc.
5 This file is part of GDB.
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program. If not, see <http://www.gnu.org/licenses/>. */
20 #if !defined (SYMFILE_H)
23 /* This file requires that you first include "bfd.h". */
26 #include "symfile-add-flags.h"
27 #include "objfile-flags.h"
30 /* Opaque declarations. */
31 struct target_section
;
42 /* Comparison function for symbol look ups. */
44 typedef int (symbol_compare_ftype
) (const char *string1
,
47 /* Partial symbols are stored in the psymbol_cache and pointers to
48 them are kept in a dynamically grown array that is obtained from
49 malloc and grown as necessary via realloc. Each objfile typically
50 has two of these, one for global symbols and one for static
51 symbols. Although this adds a level of indirection for storing or
52 accessing the partial symbols, it allows us to throw away duplicate
53 psymbols and set all pointers to the single saved instance. */
55 struct psymbol_allocation_list
58 /* Pointer to beginning of dynamically allocated array of pointers
59 to partial symbols. The array is dynamically expanded as
60 necessary to accommodate more pointers. */
62 struct partial_symbol
**list
;
64 /* Pointer to next available slot in which to store a pointer to a
67 struct partial_symbol
**next
;
69 /* Number of allocated pointer slots in current dynamic array (not
70 the number of bytes of storage). The "next" pointer will always
71 point somewhere between list[0] and list[size], and when at
72 list[size] the array will be expanded on the next attempt to
83 /* SECTINDEX must be valid for associated BFD or set to -1. */
87 /* Define an array of addresses to accommodate non-contiguous dynamic
88 loading of modules. This is for use when entering commands, so we
89 can keep track of the section names until we read the file and can
90 map them to bfd sections. This structure is also used by solib.c
91 to communicate the section addresses in shared objects to
92 symbol_file_add (). */
94 struct section_addr_info
96 /* The number of sections for which address information is
99 /* Sections whose names are file format dependent. */
100 struct other_sections other
[1];
104 /* A table listing the load segments in a symfile, and which segment
105 each BFD section belongs to. */
106 struct symfile_segment_data
108 /* How many segments are present in this file. If there are
109 two, the text segment is the first one and the data segment
110 is the second one. */
113 /* If NUM_SEGMENTS is greater than zero, the original base address
115 CORE_ADDR
*segment_bases
;
117 /* If NUM_SEGMENTS is greater than zero, the memory size of each
119 CORE_ADDR
*segment_sizes
;
121 /* If NUM_SEGMENTS is greater than zero, this is an array of entries
122 recording which segment contains each BFD section.
123 SEGMENT_INFO[I] is S+1 if the I'th BFD section belongs to segment
124 S, or zero if it is not in any segment. */
128 /* Callback for quick_symbol_functions->map_symbol_filenames. */
130 typedef void (symbol_filename_ftype
) (const char *filename
,
131 const char *fullname
, void *data
);
133 /* Callback for quick_symbol_functions->expand_symtabs_matching
134 to match a file name. */
136 typedef int (expand_symtabs_file_matcher_ftype
) (const char *filename
,
137 void *data
, int basenames
);
139 /* Callback for quick_symbol_functions->expand_symtabs_matching
140 to match a symbol name. */
142 typedef int (expand_symtabs_symbol_matcher_ftype
) (const char *name
,
145 /* Callback for quick_symbol_functions->expand_symtabs_matching
146 to be called after a symtab has been expanded. */
148 typedef void (expand_symtabs_exp_notify_ftype
) \
149 (struct compunit_symtab
*symtab
, void *data
);
151 /* The "quick" symbol functions exist so that symbol readers can
152 avoiding an initial read of all the symbols. For example, symbol
153 readers might choose to use the "partial symbol table" utilities,
154 which is one implementation of the quick symbol functions.
156 The quick symbol functions are generally opaque: the underlying
157 representation is hidden from the caller.
159 In general, these functions should only look at whatever special
160 index the symbol reader creates -- looking through the symbol
161 tables themselves is handled by generic code. If a function is
162 defined as returning a "symbol table", this means that the function
163 should only return a newly-created symbol table; it should not
164 examine pre-existing ones.
166 The exact list of functions here was determined in an ad hoc way
167 based on gdb's history. */
169 struct quick_symbol_functions
171 /* Return true if this objfile has any "partial" symbols
173 int (*has_symbols
) (struct objfile
*objfile
);
175 /* Return the symbol table for the "last" file appearing in
177 struct symtab
*(*find_last_source_symtab
) (struct objfile
*objfile
);
179 /* Forget all cached full file names for OBJFILE. */
180 void (*forget_cached_source_info
) (struct objfile
*objfile
);
182 /* Expand and iterate over each "partial" symbol table in OBJFILE
183 where the source file is named NAME.
185 If NAME is not absolute, a match after a '/' in the symbol table's
186 file name will also work, REAL_PATH is NULL then. If NAME is
187 absolute then REAL_PATH is non-NULL absolute file name as resolved
188 via gdb_realpath from NAME.
190 If a match is found, the "partial" symbol table is expanded.
191 Then, this calls iterate_over_some_symtabs (or equivalent) over
192 all newly-created symbol tables, passing CALLBACK and DATA to it.
193 The result of this call is returned. */
194 int (*map_symtabs_matching_filename
) (struct objfile
*objfile
,
196 const char *real_path
,
197 int (*callback
) (struct symtab
*,
201 /* Check to see if the symbol is defined in a "partial" symbol table
202 of OBJFILE. BLOCK_INDEX should be either GLOBAL_BLOCK or STATIC_BLOCK,
203 depending on whether we want to search global symbols or static
204 symbols. NAME is the name of the symbol to look for. DOMAIN
205 indicates what sort of symbol to search for.
207 Returns the newly-expanded compunit in which the symbol is
208 defined, or NULL if no such symbol table exists. If OBJFILE
209 contains !TYPE_OPAQUE symbol prefer its compunit. If it contains
210 only TYPE_OPAQUE symbol(s), return at least that compunit. */
211 struct compunit_symtab
*(*lookup_symbol
) (struct objfile
*objfile
,
212 int block_index
, const char *name
,
215 /* Print statistics about any indices loaded for OBJFILE. The
216 statistics should be printed to gdb_stdout. This is used for
217 "maint print statistics". */
218 void (*print_stats
) (struct objfile
*objfile
);
220 /* Dump any indices loaded for OBJFILE. The dump should go to
221 gdb_stdout. This is used for "maint print objfiles". */
222 void (*dump
) (struct objfile
*objfile
);
224 /* This is called by objfile_relocate to relocate any indices loaded
226 void (*relocate
) (struct objfile
*objfile
,
227 const struct section_offsets
*new_offsets
,
228 const struct section_offsets
*delta
);
230 /* Find all the symbols in OBJFILE named FUNC_NAME, and ensure that
231 the corresponding symbol tables are loaded. */
232 void (*expand_symtabs_for_function
) (struct objfile
*objfile
,
233 const char *func_name
);
235 /* Read all symbol tables associated with OBJFILE. */
236 void (*expand_all_symtabs
) (struct objfile
*objfile
);
238 /* Read all symbol tables associated with OBJFILE which have
239 symtab_to_fullname equal to FULLNAME.
240 This is for the purposes of examining code only, e.g., expand_line_sal.
241 The routine may ignore debug info that is known to not be useful with
242 code, e.g., DW_TAG_type_unit for dwarf debug info. */
243 void (*expand_symtabs_with_fullname
) (struct objfile
*objfile
,
244 const char *fullname
);
246 /* Find global or static symbols in all tables that are in DOMAIN
247 and for which MATCH (symbol name, NAME) == 0, passing each to
248 CALLBACK, reading in partial symbol tables as needed. Look
249 through global symbols if GLOBAL and otherwise static symbols.
250 Passes NAME, NAMESPACE, and DATA to CALLBACK with each symbol
251 found. After each block is processed, passes NULL to CALLBACK.
252 MATCH must be weaker than strcmp_iw_ordered in the sense that
253 strcmp_iw_ordered(x,y) == 0 --> MATCH(x,y) == 0. ORDERED_COMPARE,
254 if non-null, must be an ordering relation compatible with
255 strcmp_iw_ordered in the sense that
256 strcmp_iw_ordered(x,y) == 0 --> ORDERED_COMPARE(x,y) == 0
258 strcmp_iw_ordered(x,y) <= 0 --> ORDERED_COMPARE(x,y) <= 0
259 (allowing strcmp_iw_ordered(x,y) < 0 while ORDERED_COMPARE(x, y) == 0).
260 CALLBACK returns 0 to indicate that the scan should continue, or
261 non-zero to indicate that the scan should be terminated. */
263 void (*map_matching_symbols
) (struct objfile
*,
264 const char *name
, domain_enum domain
,
266 int (*callback
) (struct block
*,
267 struct symbol
*, void *),
269 symbol_compare_ftype
*match
,
270 symbol_compare_ftype
*ordered_compare
);
272 /* Expand all symbol tables in OBJFILE matching some criteria.
274 FILE_MATCHER is called for each file in OBJFILE. The file name
275 and the DATA argument are passed to it. If it returns zero, this
276 file is skipped. If FILE_MATCHER is NULL such file is not skipped.
277 If BASENAMES is non-zero the function should consider only base name of
278 DATA (passed file name is already only the lbasename part).
280 Otherwise, if KIND does not match this symbol is skipped.
282 If even KIND matches, then SYMBOL_MATCHER is called for each symbol
283 defined in the file. The symbol "search" name and DATA are passed
286 If SYMBOL_MATCHER returns zero, then this symbol is skipped.
288 Otherwise, this symbol's symbol table is expanded.
290 DATA is user data that is passed unmodified to the callback
292 void (*expand_symtabs_matching
)
293 (struct objfile
*objfile
,
294 expand_symtabs_file_matcher_ftype
*file_matcher
,
295 expand_symtabs_symbol_matcher_ftype
*symbol_matcher
,
296 expand_symtabs_exp_notify_ftype
*expansion_notify
,
297 enum search_domain kind
,
300 /* Return the comp unit from OBJFILE that contains PC and
301 SECTION. Return NULL if there is no such compunit. This
302 should return the compunit that contains a symbol whose
303 address exactly matches PC, or, if there is no exact match, the
304 compunit that contains a symbol whose address is closest to
306 struct compunit_symtab
*(*find_pc_sect_compunit_symtab
)
307 (struct objfile
*objfile
, struct bound_minimal_symbol msymbol
,
308 CORE_ADDR pc
, struct obj_section
*section
, int warn_if_readin
);
310 /* Call a callback for every file defined in OBJFILE whose symtab is
311 not already read in. FUN is the callback. It is passed the file's
312 FILENAME, the file's FULLNAME (if need_fullname is non-zero), and
313 the DATA passed to this function. */
314 void (*map_symbol_filenames
) (struct objfile
*objfile
,
315 symbol_filename_ftype
*fun
, void *data
,
319 /* Structure of functions used for probe support. If one of these functions
320 is provided, all must be. */
324 /* If non-NULL, return an array of probe objects.
326 The returned value does not have to be freed and it has lifetime of the
328 VEC (probe_p
) *(*sym_get_probes
) (struct objfile
*);
331 /* Structure to keep track of symbol reading functions for various
332 object file types. */
336 /* Initializes anything that is global to the entire symbol table.
337 It is called during symbol_file_add, when we begin debugging an
338 entirely new program. */
340 void (*sym_new_init
) (struct objfile
*);
342 /* Reads any initial information from a symbol file, and initializes
343 the struct sym_fns SF in preparation for sym_read(). It is
344 called every time we read a symbol file for any reason. */
346 void (*sym_init
) (struct objfile
*);
348 /* sym_read (objfile, symfile_flags) Reads a symbol file into a psymtab
349 (or possibly a symtab). OBJFILE is the objfile struct for the
350 file we are reading. SYMFILE_FLAGS are the flags passed to
351 symbol_file_add & co. */
353 void (*sym_read
) (struct objfile
*, symfile_add_flags
);
355 /* Read the partial symbols for an objfile. This may be NULL, in which case
356 gdb has to check other ways if this objfile has any symbols. This may
357 only be non-NULL if the objfile actually does have debuginfo available.
360 void (*sym_read_psymbols
) (struct objfile
*);
362 /* Called when we are finished with an objfile. Should do all
363 cleanup that is specific to the object file format for the
364 particular objfile. */
366 void (*sym_finish
) (struct objfile
*);
369 /* This function produces a file-dependent section_offsets
370 structure, allocated in the objfile's storage.
372 The section_addr_info structure contains the offset of loadable and
373 allocated sections, relative to the absolute offsets found in the BFD. */
375 void (*sym_offsets
) (struct objfile
*, const struct section_addr_info
*);
377 /* This function produces a format-independent description of
378 the segments of ABFD. Each segment is a unit of the file
379 which may be relocated independently. */
381 struct symfile_segment_data
*(*sym_segments
) (bfd
*abfd
);
383 /* This function should read the linetable from the objfile when
384 the line table cannot be read while processing the debugging
387 void (*sym_read_linetable
) (struct objfile
*);
389 /* Relocate the contents of a debug section SECTP. The
390 contents are stored in BUF if it is non-NULL, or returned in a
391 malloc'd buffer otherwise. */
393 bfd_byte
*(*sym_relocate
) (struct objfile
*, asection
*sectp
, bfd_byte
*buf
);
395 /* If non-NULL, this objfile has probe support, and all the probe
396 functions referred to here will be non-NULL. */
397 const struct sym_probe_fns
*sym_probe_fns
;
399 /* The "quick" (aka partial) symbol functions for this symbol
401 const struct quick_symbol_functions
*qf
;
404 extern struct section_addr_info
*
405 build_section_addr_info_from_objfile (const struct objfile
*objfile
);
407 extern void relative_addr_info_to_section_offsets
408 (struct section_offsets
*section_offsets
, int num_sections
,
409 const struct section_addr_info
*addrs
);
411 extern void addr_info_make_relative (struct section_addr_info
*addrs
,
414 /* The default version of sym_fns.sym_offsets for readers that don't
415 do anything special. */
417 extern void default_symfile_offsets (struct objfile
*objfile
,
418 const struct section_addr_info
*);
420 /* The default version of sym_fns.sym_segments for readers that don't
421 do anything special. */
423 extern struct symfile_segment_data
*default_symfile_segments (bfd
*abfd
);
425 /* The default version of sym_fns.sym_relocate for readers that don't
426 do anything special. */
428 extern bfd_byte
*default_symfile_relocate (struct objfile
*objfile
,
429 asection
*sectp
, bfd_byte
*buf
);
431 extern struct symtab
*allocate_symtab (struct compunit_symtab
*, const char *)
432 ATTRIBUTE_NONNULL (1);
434 extern struct compunit_symtab
*allocate_compunit_symtab (struct objfile
*,
436 ATTRIBUTE_NONNULL (1);
438 extern void add_compunit_symtab_to_objfile (struct compunit_symtab
*cu
);
440 extern void add_symtab_fns (enum bfd_flavour flavour
, const struct sym_fns
*);
442 extern void clear_symtab_users (symfile_add_flags add_flags
);
444 extern enum language
deduce_language_from_filename (const char *);
446 /* Map the filename extension EXT to the language LANG. Any previous
447 association of EXT will be removed. EXT will be copied by this
449 extern void add_filename_language (const char *ext
, enum language lang
);
451 extern struct objfile
*symbol_file_add (const char *, symfile_add_flags
,
452 struct section_addr_info
*, objfile_flags
);
454 extern struct objfile
*symbol_file_add_from_bfd (bfd
*, const char *, symfile_add_flags
,
455 struct section_addr_info
*,
456 objfile_flags
, struct objfile
*parent
);
458 extern void symbol_file_add_separate (bfd
*, const char *, symfile_add_flags
,
461 extern char *find_separate_debug_file_by_debuglink (struct objfile
*);
463 /* Create a new section_addr_info, with room for NUM_SECTIONS. */
465 extern struct section_addr_info
*alloc_section_addr_info (size_t
468 /* Build (allocate and populate) a section_addr_info struct from an
469 existing section table. */
471 extern struct section_addr_info
472 *build_section_addr_info_from_section_table (const struct target_section
474 const struct target_section
477 /* Free all memory allocated by
478 build_section_addr_info_from_section_table. */
480 extern void free_section_addr_info (struct section_addr_info
*);
485 /* If non-zero, shared library symbols will be added automatically
486 when the inferior is created, new libraries are loaded, or when
487 attaching to the inferior. This is almost always what users will
488 want to have happen; but for very large programs, the startup time
489 will be excessive, and so if this is a problem, the user can clear
490 this flag and then add the shared library symbols as needed. Note
491 that there is a potential for confusion, since if the shared
492 library symbols are not loaded, commands like "info fun" will *not*
493 report all the functions that are actually present. */
495 extern int auto_solib_add
;
499 extern void set_initial_language (void);
501 extern void find_lowest_section (bfd
*, asection
*, void *);
503 extern gdb_bfd_ref_ptr
symfile_bfd_open (const char *);
505 extern int get_section_index (struct objfile
*, char *);
507 extern int print_symbol_loading_p (int from_tty
, int mainline
, int full
);
509 /* Utility functions for overlay sections: */
510 extern enum overlay_debugging_state
516 extern int overlay_cache_invalid
;
518 /* Return the "mapped" overlay section containing the PC. */
519 extern struct obj_section
*find_pc_mapped_section (CORE_ADDR
);
521 /* Return any overlay section containing the PC (even in its LMA
523 extern struct obj_section
*find_pc_overlay (CORE_ADDR
);
525 /* Return true if the section is an overlay. */
526 extern int section_is_overlay (struct obj_section
*);
528 /* Return true if the overlay section is currently "mapped". */
529 extern int section_is_mapped (struct obj_section
*);
531 /* Return true if pc belongs to section's VMA. */
532 extern CORE_ADDR
pc_in_mapped_range (CORE_ADDR
, struct obj_section
*);
534 /* Return true if pc belongs to section's LMA. */
535 extern CORE_ADDR
pc_in_unmapped_range (CORE_ADDR
, struct obj_section
*);
537 /* Map an address from a section's LMA to its VMA. */
538 extern CORE_ADDR
overlay_mapped_address (CORE_ADDR
, struct obj_section
*);
540 /* Map an address from a section's VMA to its LMA. */
541 extern CORE_ADDR
overlay_unmapped_address (CORE_ADDR
, struct obj_section
*);
543 /* Convert an address in an overlay section (force into VMA range). */
544 extern CORE_ADDR
symbol_overlayed_address (CORE_ADDR
, struct obj_section
*);
546 /* Load symbols from a file. */
547 extern void symbol_file_add_main (const char *args
,
548 symfile_add_flags add_flags
);
550 /* Clear GDB symbol tables. */
551 extern void symbol_file_clear (int from_tty
);
553 /* Default overlay update function. */
554 extern void simple_overlay_update (struct obj_section
*);
556 extern bfd_byte
*symfile_relocate_debug_section (struct objfile
*, asection
*,
559 extern int symfile_map_offsets_to_segments (bfd
*,
560 const struct symfile_segment_data
*,
561 struct section_offsets
*,
562 int, const CORE_ADDR
*);
563 struct symfile_segment_data
*get_symfile_segment_data (bfd
*abfd
);
564 void free_symfile_segment_data (struct symfile_segment_data
*data
);
566 extern struct cleanup
*increment_reading_symtab (void);
568 void expand_symtabs_matching (expand_symtabs_file_matcher_ftype
*,
569 expand_symtabs_symbol_matcher_ftype
*,
570 expand_symtabs_exp_notify_ftype
*,
571 enum search_domain kind
, void *data
);
573 void map_symbol_filenames (symbol_filename_ftype
*fun
, void *data
,
576 /* From dwarf2read.c */
578 /* Names for a dwarf2 debugging section. The field NORMAL is the normal
579 section name (usually from the DWARF standard), while the field COMPRESSED
580 is the name of compressed sections. If your object file format doesn't
581 support compressed sections, the field COMPRESSED can be NULL. Likewise,
582 the debugging section is not supported, the field NORMAL can be NULL too.
583 It doesn't make sense to have a NULL NORMAL field but a non-NULL COMPRESSED
586 struct dwarf2_section_names
{
588 const char *compressed
;
591 /* List of names for dward2 debugging sections. Also most object file formats
592 use the standardized (ie ELF) names, some (eg XCOFF) have customized names
594 The table for the standard names is defined in dwarf2read.c. Please
595 update all instances of dwarf2_debug_sections if you add a field to this
596 structure. It is always safe to use { NULL, NULL } in this case. */
598 struct dwarf2_debug_sections
{
599 struct dwarf2_section_names info
;
600 struct dwarf2_section_names abbrev
;
601 struct dwarf2_section_names line
;
602 struct dwarf2_section_names loc
;
603 struct dwarf2_section_names macinfo
;
604 struct dwarf2_section_names macro
;
605 struct dwarf2_section_names str
;
606 struct dwarf2_section_names ranges
;
607 struct dwarf2_section_names types
;
608 struct dwarf2_section_names addr
;
609 struct dwarf2_section_names frame
;
610 struct dwarf2_section_names eh_frame
;
611 struct dwarf2_section_names gdb_index
;
612 /* This field has no meaning, but exists solely to catch changes to
613 this structure which are not reflected in some instance. */
617 extern int dwarf2_has_info (struct objfile
*,
618 const struct dwarf2_debug_sections
*);
620 /* Dwarf2 sections that can be accessed by dwarf2_get_section_info. */
621 enum dwarf2_section_enum
{
626 extern void dwarf2_get_section_info (struct objfile
*,
627 enum dwarf2_section_enum
,
628 asection
**, const gdb_byte
**,
631 extern int dwarf2_initialize_objfile (struct objfile
*);
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 mdebugread.c */
639 extern void mdebug_build_psymtabs (minimal_symbol_reader
&,
641 const struct ecoff_debug_swap
*,
642 struct ecoff_debug_info
*);
644 extern void elfmdebug_build_psymtabs (struct objfile
*,
645 const struct ecoff_debug_swap
*,
648 /* From minidebug.c. */
650 extern gdb_bfd_ref_ptr
find_separate_debug_file_in_section (struct objfile
*);
652 #endif /* !defined(SYMFILE_H) */