1 /* Definitions for reading symbol files into GDB.
3 Copyright (C) 1990-2016 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". */
27 /* Opaque declarations. */
28 struct target_section;
39 /* Comparison function for symbol look ups. */
41 typedef int (symbol_compare_ftype) (const char *string1,
44 /* Partial symbols are stored in the psymbol_cache and pointers to
45 them are kept in a dynamically grown array that is obtained from
46 malloc and grown as necessary via realloc. Each objfile typically
47 has two of these, one for global symbols and one for static
48 symbols. Although this adds a level of indirection for storing or
49 accessing the partial symbols, it allows us to throw away duplicate
50 psymbols and set all pointers to the single saved instance. */
52 struct psymbol_allocation_list
55 /* Pointer to beginning of dynamically allocated array of pointers
56 to partial symbols. The array is dynamically expanded as
57 necessary to accommodate more pointers. */
59 struct partial_symbol **list;
61 /* Pointer to next available slot in which to store a pointer to a
64 struct partial_symbol **next;
66 /* Number of allocated pointer slots in current dynamic array (not
67 the number of bytes of storage). The "next" pointer will always
68 point somewhere between list[0] and list[size], and when at
69 list[size] the array will be expanded on the next attempt to
80 /* SECTINDEX must be valid for associated BFD or set to -1. */
84 /* Define an array of addresses to accommodate non-contiguous dynamic
85 loading of modules. This is for use when entering commands, so we
86 can keep track of the section names until we read the file and can
87 map them to bfd sections. This structure is also used by solib.c
88 to communicate the section addresses in shared objects to
89 symbol_file_add (). */
91 struct section_addr_info
93 /* The number of sections for which address information is
96 /* Sections whose names are file format dependent. */
97 struct other_sections other[1];
101 /* A table listing the load segments in a symfile, and which segment
102 each BFD section belongs to. */
103 struct symfile_segment_data
105 /* How many segments are present in this file. If there are
106 two, the text segment is the first one and the data segment
107 is the second one. */
110 /* If NUM_SEGMENTS is greater than zero, the original base address
112 CORE_ADDR *segment_bases;
114 /* If NUM_SEGMENTS is greater than zero, the memory size of each
116 CORE_ADDR *segment_sizes;
118 /* If NUM_SEGMENTS is greater than zero, this is an array of entries
119 recording which segment contains each BFD section.
120 SEGMENT_INFO[I] is S+1 if the I'th BFD section belongs to segment
121 S, or zero if it is not in any segment. */
125 /* Callback for quick_symbol_functions->map_symbol_filenames. */
127 typedef void (symbol_filename_ftype) (const char *filename,
128 const char *fullname, void *data);
130 /* Callback for quick_symbol_functions->expand_symtabs_matching
131 to match a file name. */
133 typedef int (expand_symtabs_file_matcher_ftype) (const char *filename,
134 void *data, int basenames);
136 /* Callback for quick_symbol_functions->expand_symtabs_matching
137 to match a symbol name. */
139 typedef int (expand_symtabs_symbol_matcher_ftype) (const char *name,
142 /* Callback for quick_symbol_functions->expand_symtabs_matching
143 to be called after a symtab has been expanded. */
145 typedef void (expand_symtabs_exp_notify_ftype) \
146 (struct compunit_symtab *symtab, void *data);
148 /* The "quick" symbol functions exist so that symbol readers can
149 avoiding an initial read of all the symbols. For example, symbol
150 readers might choose to use the "partial symbol table" utilities,
151 which is one implementation of the quick symbol functions.
153 The quick symbol functions are generally opaque: the underlying
154 representation is hidden from the caller.
156 In general, these functions should only look at whatever special
157 index the symbol reader creates -- looking through the symbol
158 tables themselves is handled by generic code. If a function is
159 defined as returning a "symbol table", this means that the function
160 should only return a newly-created symbol table; it should not
161 examine pre-existing ones.
163 The exact list of functions here was determined in an ad hoc way
164 based on gdb's history. */
166 struct quick_symbol_functions
168 /* Return true if this objfile has any "partial" symbols
170 int (*has_symbols) (struct objfile *objfile);
172 /* Return the symbol table for the "last" file appearing in
174 struct symtab *(*find_last_source_symtab) (struct objfile *objfile);
176 /* Forget all cached full file names for OBJFILE. */
177 void (*forget_cached_source_info) (struct objfile *objfile);
179 /* Expand and iterate over each "partial" symbol table in OBJFILE
180 where the source file is named NAME.
182 If NAME is not absolute, a match after a '/' in the symbol table's
183 file name will also work, REAL_PATH is NULL then. If NAME is
184 absolute then REAL_PATH is non-NULL absolute file name as resolved
185 via gdb_realpath from NAME.
187 If a match is found, the "partial" symbol table is expanded.
188 Then, this calls iterate_over_some_symtabs (or equivalent) over
189 all newly-created symbol tables, passing CALLBACK and DATA to it.
190 The result of this call is returned. */
191 int (*map_symtabs_matching_filename) (struct objfile *objfile,
193 const char *real_path,
194 int (*callback) (struct symtab *,
198 /* Check to see if the symbol is defined in a "partial" symbol table
199 of OBJFILE. BLOCK_INDEX should be either GLOBAL_BLOCK or STATIC_BLOCK,
200 depending on whether we want to search global symbols or static
201 symbols. NAME is the name of the symbol to look for. DOMAIN
202 indicates what sort of symbol to search for.
204 Returns the newly-expanded compunit in which the symbol is
205 defined, or NULL if no such symbol table exists. If OBJFILE
206 contains !TYPE_OPAQUE symbol prefer its compunit. If it contains
207 only TYPE_OPAQUE symbol(s), return at least that compunit. */
208 struct compunit_symtab *(*lookup_symbol) (struct objfile *objfile,
209 int block_index, const char *name,
212 /* Print statistics about any indices loaded for OBJFILE. The
213 statistics should be printed to gdb_stdout. This is used for
214 "maint print statistics". */
215 void (*print_stats) (struct objfile *objfile);
217 /* Dump any indices loaded for OBJFILE. The dump should go to
218 gdb_stdout. This is used for "maint print objfiles". */
219 void (*dump) (struct objfile *objfile);
221 /* This is called by objfile_relocate to relocate any indices loaded
223 void (*relocate) (struct objfile *objfile,
224 const struct section_offsets *new_offsets,
225 const struct section_offsets *delta);
227 /* Find all the symbols in OBJFILE named FUNC_NAME, and ensure that
228 the corresponding symbol tables are loaded. */
229 void (*expand_symtabs_for_function) (struct objfile *objfile,
230 const char *func_name);
232 /* Read all symbol tables associated with OBJFILE. */
233 void (*expand_all_symtabs) (struct objfile *objfile);
235 /* Read all symbol tables associated with OBJFILE which have
236 symtab_to_fullname equal to FULLNAME.
237 This is for the purposes of examining code only, e.g., expand_line_sal.
238 The routine may ignore debug info that is known to not be useful with
239 code, e.g., DW_TAG_type_unit for dwarf debug info. */
240 void (*expand_symtabs_with_fullname) (struct objfile *objfile,
241 const char *fullname);
243 /* Find global or static symbols in all tables that are in DOMAIN
244 and for which MATCH (symbol name, NAME) == 0, passing each to
245 CALLBACK, reading in partial symbol tables as needed. Look
246 through global symbols if GLOBAL and otherwise static symbols.
247 Passes NAME, NAMESPACE, and DATA to CALLBACK with each symbol
248 found. After each block is processed, passes NULL to CALLBACK.
249 MATCH must be weaker than strcmp_iw_ordered in the sense that
250 strcmp_iw_ordered(x,y) == 0 --> MATCH(x,y) == 0. ORDERED_COMPARE,
251 if non-null, must be an ordering relation compatible with
252 strcmp_iw_ordered in the sense that
253 strcmp_iw_ordered(x,y) == 0 --> ORDERED_COMPARE(x,y) == 0
255 strcmp_iw_ordered(x,y) <= 0 --> ORDERED_COMPARE(x,y) <= 0
256 (allowing strcmp_iw_ordered(x,y) < 0 while ORDERED_COMPARE(x, y) == 0).
257 CALLBACK returns 0 to indicate that the scan should continue, or
258 non-zero to indicate that the scan should be terminated. */
260 void (*map_matching_symbols) (struct objfile *,
261 const char *name, domain_enum domain,
263 int (*callback) (struct block *,
264 struct symbol *, void *),
266 symbol_compare_ftype *match,
267 symbol_compare_ftype *ordered_compare);
269 /* Expand all symbol tables in OBJFILE matching some criteria.
271 FILE_MATCHER is called for each file in OBJFILE. The file name
272 and the DATA argument are passed to it. If it returns zero, this
273 file is skipped. If FILE_MATCHER is NULL such file is not skipped.
274 If BASENAMES is non-zero the function should consider only base name of
275 DATA (passed file name is already only the lbasename part).
277 Otherwise, if KIND does not match this symbol is skipped.
279 If even KIND matches, then SYMBOL_MATCHER is called for each symbol
280 defined in the file. The symbol "search" name and DATA are passed
283 If SYMBOL_MATCHER returns zero, then this symbol is skipped.
285 Otherwise, this symbol's symbol table is expanded.
287 DATA is user data that is passed unmodified to the callback
289 void (*expand_symtabs_matching)
290 (struct objfile *objfile,
291 expand_symtabs_file_matcher_ftype *file_matcher,
292 expand_symtabs_symbol_matcher_ftype *symbol_matcher,
293 expand_symtabs_exp_notify_ftype *expansion_notify,
294 enum search_domain kind,
297 /* Return the comp unit from OBJFILE that contains PC and
298 SECTION. Return NULL if there is no such compunit. This
299 should return the compunit that contains a symbol whose
300 address exactly matches PC, or, if there is no exact match, the
301 compunit that contains a symbol whose address is closest to
303 struct compunit_symtab *(*find_pc_sect_compunit_symtab)
304 (struct objfile *objfile, struct bound_minimal_symbol msymbol,
305 CORE_ADDR pc, struct obj_section *section, int warn_if_readin);
307 /* Call a callback for every file defined in OBJFILE whose symtab is
308 not already read in. FUN is the callback. It is passed the file's
309 FILENAME, the file's FULLNAME (if need_fullname is non-zero), and
310 the DATA passed to this function. */
311 void (*map_symbol_filenames) (struct objfile *objfile,
312 symbol_filename_ftype *fun, void *data,
316 /* Structure of functions used for probe support. If one of these functions
317 is provided, all must be. */
321 /* If non-NULL, return an array of probe objects.
323 The returned value does not have to be freed and it has lifetime of the
325 VEC (probe_p) *(*sym_get_probes) (struct objfile *);
328 /* Structure to keep track of symbol reading functions for various
329 object file types. */
333 /* Initializes anything that is global to the entire symbol table.
334 It is called during symbol_file_add, when we begin debugging an
335 entirely new program. */
337 void (*sym_new_init) (struct objfile *);
339 /* Reads any initial information from a symbol file, and initializes
340 the struct sym_fns SF in preparation for sym_read(). It is
341 called every time we read a symbol file for any reason. */
343 void (*sym_init) (struct objfile *);
345 /* sym_read (objfile, symfile_flags) Reads a symbol file into a psymtab
346 (or possibly a symtab). OBJFILE is the objfile struct for the
347 file we are reading. SYMFILE_FLAGS are the flags passed to
348 symbol_file_add & co. */
350 void (*sym_read) (struct objfile *, int);
352 /* Read the partial symbols for an objfile. This may be NULL, in which case
353 gdb has to check other ways if this objfile has any symbols. This may
354 only be non-NULL if the objfile actually does have debuginfo available.
357 void (*sym_read_psymbols) (struct objfile *);
359 /* Called when we are finished with an objfile. Should do all
360 cleanup that is specific to the object file format for the
361 particular objfile. */
363 void (*sym_finish) (struct objfile *);
366 /* This function produces a file-dependent section_offsets
367 structure, allocated in the objfile's storage.
369 The section_addr_info structure contains the offset of loadable and
370 allocated sections, relative to the absolute offsets found in the BFD. */
372 void (*sym_offsets) (struct objfile *, const struct section_addr_info *);
374 /* This function produces a format-independent description of
375 the segments of ABFD. Each segment is a unit of the file
376 which may be relocated independently. */
378 struct symfile_segment_data *(*sym_segments) (bfd *abfd);
380 /* This function should read the linetable from the objfile when
381 the line table cannot be read while processing the debugging
384 void (*sym_read_linetable) (struct objfile *);
386 /* Relocate the contents of a debug section SECTP. The
387 contents are stored in BUF if it is non-NULL, or returned in a
388 malloc'd buffer otherwise. */
390 bfd_byte *(*sym_relocate) (struct objfile *, asection *sectp, bfd_byte *buf);
392 /* If non-NULL, this objfile has probe support, and all the probe
393 functions referred to here will be non-NULL. */
394 const struct sym_probe_fns *sym_probe_fns;
396 /* The "quick" (aka partial) symbol functions for this symbol
398 const struct quick_symbol_functions *qf;
401 extern struct section_addr_info *
402 build_section_addr_info_from_objfile (const struct objfile *objfile);
404 extern void relative_addr_info_to_section_offsets
405 (struct section_offsets *section_offsets, int num_sections,
406 const struct section_addr_info *addrs);
408 extern void addr_info_make_relative (struct section_addr_info *addrs,
411 /* The default version of sym_fns.sym_offsets for readers that don't
412 do anything special. */
414 extern void default_symfile_offsets (struct objfile *objfile,
415 const struct section_addr_info *);
417 /* The default version of sym_fns.sym_segments for readers that don't
418 do anything special. */
420 extern struct symfile_segment_data *default_symfile_segments (bfd *abfd);
422 /* The default version of sym_fns.sym_relocate for readers that don't
423 do anything special. */
425 extern bfd_byte *default_symfile_relocate (struct objfile *objfile,
426 asection *sectp, bfd_byte *buf);
428 extern struct symtab *allocate_symtab (struct compunit_symtab *, const char *)
429 ATTRIBUTE_NONNULL (1);
431 extern struct compunit_symtab *allocate_compunit_symtab (struct objfile *,
433 ATTRIBUTE_NONNULL (1);
435 extern void add_compunit_symtab_to_objfile (struct compunit_symtab *cu);
437 extern void add_symtab_fns (enum bfd_flavour flavour, const struct sym_fns *);
439 extern void clear_symtab_users (int add_flags);
441 extern enum language deduce_language_from_filename (const char *);
443 /* This enum encodes bit-flags passed as ADD_FLAGS parameter to
444 symbol_file_add, etc. */
446 enum symfile_add_flags
448 /* Be chatty about what you are doing. */
449 SYMFILE_VERBOSE = 1 << 1,
451 /* This is the main symbol file (as opposed to symbol file for dynamically
453 SYMFILE_MAINLINE = 1 << 2,
455 /* Do not call breakpoint_re_set when adding this symbol file. */
456 SYMFILE_DEFER_BP_RESET = 1 << 3,
458 /* Do not immediately read symbols for this file. By default,
459 symbols are read when the objfile is created. */
460 SYMFILE_NO_READ = 1 << 4
463 extern struct objfile *symbol_file_add (const char *, int,
464 struct section_addr_info *, int);
466 extern struct objfile *symbol_file_add_from_bfd (bfd *, const char *, int,
467 struct section_addr_info *,
468 int, struct objfile *parent);
470 extern void symbol_file_add_separate (bfd *, const char *, int,
473 extern char *find_separate_debug_file_by_debuglink (struct objfile *);
475 /* Create a new section_addr_info, with room for NUM_SECTIONS. */
477 extern struct section_addr_info *alloc_section_addr_info (size_t
480 /* Build (allocate and populate) a section_addr_info struct from an
481 existing section table. */
483 extern struct section_addr_info
484 *build_section_addr_info_from_section_table (const struct target_section
486 const struct target_section
489 /* Free all memory allocated by
490 build_section_addr_info_from_section_table. */
492 extern void free_section_addr_info (struct section_addr_info *);
497 /* If non-zero, shared library symbols will be added automatically
498 when the inferior is created, new libraries are loaded, or when
499 attaching to the inferior. This is almost always what users will
500 want to have happen; but for very large programs, the startup time
501 will be excessive, and so if this is a problem, the user can clear
502 this flag and then add the shared library symbols as needed. Note
503 that there is a potential for confusion, since if the shared
504 library symbols are not loaded, commands like "info fun" will *not*
505 report all the functions that are actually present. */
507 extern int auto_solib_add;
511 extern void set_initial_language (void);
513 extern void find_lowest_section (bfd *, asection *, void *);
515 extern bfd *symfile_bfd_open (const char *);
517 extern int get_section_index (struct objfile *, char *);
519 extern int print_symbol_loading_p (int from_tty, int mainline, int full);
521 /* Utility functions for overlay sections: */
522 extern enum overlay_debugging_state
528 extern int overlay_cache_invalid;
530 /* Return the "mapped" overlay section containing the PC. */
531 extern struct obj_section *find_pc_mapped_section (CORE_ADDR);
533 /* Return any overlay section containing the PC (even in its LMA
535 extern struct obj_section *find_pc_overlay (CORE_ADDR);
537 /* Return true if the section is an overlay. */
538 extern int section_is_overlay (struct obj_section *);
540 /* Return true if the overlay section is currently "mapped". */
541 extern int section_is_mapped (struct obj_section *);
543 /* Return true if pc belongs to section's VMA. */
544 extern CORE_ADDR pc_in_mapped_range (CORE_ADDR, struct obj_section *);
546 /* Return true if pc belongs to section's LMA. */
547 extern CORE_ADDR pc_in_unmapped_range (CORE_ADDR, struct obj_section *);
549 /* Map an address from a section's LMA to its VMA. */
550 extern CORE_ADDR overlay_mapped_address (CORE_ADDR, struct obj_section *);
552 /* Map an address from a section's VMA to its LMA. */
553 extern CORE_ADDR overlay_unmapped_address (CORE_ADDR, struct obj_section *);
555 /* Convert an address in an overlay section (force into VMA range). */
556 extern CORE_ADDR symbol_overlayed_address (CORE_ADDR, struct obj_section *);
558 /* Load symbols from a file. */
559 extern void symbol_file_add_main (const char *args, int from_tty);
561 /* Clear GDB symbol tables. */
562 extern void symbol_file_clear (int from_tty);
564 /* Default overlay update function. */
565 extern void simple_overlay_update (struct obj_section *);
567 extern bfd_byte *symfile_relocate_debug_section (struct objfile *, asection *,
570 extern int symfile_map_offsets_to_segments (bfd *,
571 const struct symfile_segment_data *,
572 struct section_offsets *,
573 int, const CORE_ADDR *);
574 struct symfile_segment_data *get_symfile_segment_data (bfd *abfd);
575 void free_symfile_segment_data (struct symfile_segment_data *data);
577 extern struct cleanup *increment_reading_symtab (void);
579 void expand_symtabs_matching (expand_symtabs_file_matcher_ftype *,
580 expand_symtabs_symbol_matcher_ftype *,
581 expand_symtabs_exp_notify_ftype *,
582 enum search_domain kind, void *data);
584 void map_symbol_filenames (symbol_filename_ftype *fun, void *data,
587 /* From dwarf2read.c */
589 /* Names for a dwarf2 debugging section. The field NORMAL is the normal
590 section name (usually from the DWARF standard), while the field COMPRESSED
591 is the name of compressed sections. If your object file format doesn't
592 support compressed sections, the field COMPRESSED can be NULL. Likewise,
593 the debugging section is not supported, the field NORMAL can be NULL too.
594 It doesn't make sense to have a NULL NORMAL field but a non-NULL COMPRESSED
597 struct dwarf2_section_names {
599 const char *compressed;
602 /* List of names for dward2 debugging sections. Also most object file formats
603 use the standardized (ie ELF) names, some (eg XCOFF) have customized names
605 The table for the standard names is defined in dwarf2read.c. Please
606 update all instances of dwarf2_debug_sections if you add a field to this
607 structure. It is always safe to use { NULL, NULL } in this case. */
609 struct dwarf2_debug_sections {
610 struct dwarf2_section_names info;
611 struct dwarf2_section_names abbrev;
612 struct dwarf2_section_names line;
613 struct dwarf2_section_names loc;
614 struct dwarf2_section_names macinfo;
615 struct dwarf2_section_names macro;
616 struct dwarf2_section_names str;
617 struct dwarf2_section_names ranges;
618 struct dwarf2_section_names types;
619 struct dwarf2_section_names addr;
620 struct dwarf2_section_names frame;
621 struct dwarf2_section_names eh_frame;
622 struct dwarf2_section_names gdb_index;
623 /* This field has no meaning, but exists solely to catch changes to
624 this structure which are not reflected in some instance. */
628 extern int dwarf2_has_info (struct objfile *,
629 const struct dwarf2_debug_sections *);
631 /* Dwarf2 sections that can be accessed by dwarf2_get_section_info. */
632 enum dwarf2_section_enum {
637 extern void dwarf2_get_section_info (struct objfile *,
638 enum dwarf2_section_enum,
639 asection **, const gdb_byte **,
642 extern int dwarf2_initialize_objfile (struct objfile *);
643 extern void dwarf2_build_psymtabs (struct objfile *);
644 extern void dwarf2_build_frame_info (struct objfile *);
646 void dwarf2_free_objfile (struct objfile *);
648 /* From mdebugread.c */
650 extern void mdebug_build_psymtabs (struct objfile *,
651 const struct ecoff_debug_swap *,
652 struct ecoff_debug_info *);
654 extern void elfmdebug_build_psymtabs (struct objfile *,
655 const struct ecoff_debug_swap *,
658 /* From minidebug.c. */
660 extern bfd *find_separate_debug_file_in_section (struct objfile *);
662 #endif /* !defined(SYMFILE_H) */