1 /* Definitions for reading symbol files into GDB.
3 Copyright (C) 1990-2013 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
75 /* Define an array of addresses to accommodate non-contiguous dynamic
76 loading of modules. This is for use when entering commands, so we
77 can keep track of the section names until we read the file and can
78 map them to bfd sections. This structure is also used by solib.c
79 to communicate the section addresses in shared objects to
80 symbol_file_add (). */
82 struct section_addr_info
84 /* The number of sections for which address information is
87 /* Sections whose names are file format dependent. */
93 /* SECTINDEX must be valid for associated BFD or set to -1. */
99 /* A table listing the load segments in a symfile, and which segment
100 each BFD section belongs to. */
101 struct symfile_segment_data
103 /* How many segments are present in this file. If there are
104 two, the text segment is the first one and the data segment
105 is the second one. */
108 /* If NUM_SEGMENTS is greater than zero, the original base address
110 CORE_ADDR *segment_bases;
112 /* If NUM_SEGMENTS is greater than zero, the memory size of each
114 CORE_ADDR *segment_sizes;
116 /* If NUM_SEGMENTS is greater than zero, this is an array of entries
117 recording which segment contains each BFD section.
118 SEGMENT_INFO[I] is S+1 if the I'th BFD section belongs to segment
119 S, or zero if it is not in any segment. */
123 /* Callback for quick_symbol_functions->map_symbol_filenames. */
125 typedef void (symbol_filename_ftype) (const char *filename,
126 const char *fullname, void *data);
128 /* The "quick" symbol functions exist so that symbol readers can
129 avoiding an initial read of all the symbols. For example, symbol
130 readers might choose to use the "partial symbol table" utilities,
131 which is one implementation of the quick symbol functions.
133 The quick symbol functions are generally opaque: the underlying
134 representation is hidden from the caller.
136 In general, these functions should only look at whatever special
137 index the symbol reader creates -- looking through the symbol
138 tables themselves is handled by generic code. If a function is
139 defined as returning a "symbol table", this means that the function
140 should only return a newly-created symbol table; it should not
141 examine pre-existing ones.
143 The exact list of functions here was determined in an ad hoc way
144 based on gdb's history. */
146 struct quick_symbol_functions
148 /* Return true if this objfile has any "partial" symbols
150 int (*has_symbols) (struct objfile *objfile);
152 /* Return the symbol table for the "last" file appearing in
154 struct symtab *(*find_last_source_symtab) (struct objfile *objfile);
156 /* Forget all cached full file names for OBJFILE. */
157 void (*forget_cached_source_info) (struct objfile *objfile);
159 /* Expand and iterate over each "partial" symbol table in OBJFILE
160 where the source file is named NAME.
162 If NAME is not absolute, a match after a '/' in the symbol table's
163 file name will also work, REAL_PATH is NULL then. If NAME is
164 absolute then REAL_PATH is non-NULL absolute file name as resolved
165 via gdb_realpath from NAME.
167 If a match is found, the "partial" symbol table is expanded.
168 Then, this calls iterate_over_some_symtabs (or equivalent) over
169 all newly-created symbol tables, passing CALLBACK and DATA to it.
170 The result of this call is returned. */
171 int (*map_symtabs_matching_filename) (struct objfile *objfile,
173 const char *real_path,
174 int (*callback) (struct symtab *,
178 /* Check to see if the symbol is defined in a "partial" symbol table
179 of OBJFILE. KIND should be either GLOBAL_BLOCK or STATIC_BLOCK,
180 depending on whether we want to search global symbols or static
181 symbols. NAME is the name of the symbol to look for. DOMAIN
182 indicates what sort of symbol to search for.
184 Returns the newly-expanded symbol table in which the symbol is
185 defined, or NULL if no such symbol table exists. If OBJFILE
186 contains !TYPE_OPAQUE symbol prefer its symtab. If it contains
187 only TYPE_OPAQUE symbol(s), return at least that symtab. */
188 struct symtab *(*lookup_symbol) (struct objfile *objfile,
189 int kind, const char *name,
192 /* Print statistics about any indices loaded for OBJFILE. The
193 statistics should be printed to gdb_stdout. This is used for
194 "maint print statistics". */
195 void (*print_stats) (struct objfile *objfile);
197 /* Dump any indices loaded for OBJFILE. The dump should go to
198 gdb_stdout. This is used for "maint print objfiles". */
199 void (*dump) (struct objfile *objfile);
201 /* This is called by objfile_relocate to relocate any indices loaded
203 void (*relocate) (struct objfile *objfile,
204 const struct section_offsets *new_offsets,
205 const struct section_offsets *delta);
207 /* Find all the symbols in OBJFILE named FUNC_NAME, and ensure that
208 the corresponding symbol tables are loaded. */
209 void (*expand_symtabs_for_function) (struct objfile *objfile,
210 const char *func_name);
212 /* Read all symbol tables associated with OBJFILE. */
213 void (*expand_all_symtabs) (struct objfile *objfile);
215 /* Read all symbol tables associated with OBJFILE which have
216 symtab_to_fullname equal to FULLNAME.
217 This is for the purposes of examining code only, e.g., expand_line_sal.
218 The routine may ignore debug info that is known to not be useful with
219 code, e.g., DW_TAG_type_unit for dwarf debug info. */
220 void (*expand_symtabs_with_fullname) (struct objfile *objfile,
221 const char *fullname);
223 /* Find global or static symbols in all tables that are in NAMESPACE
224 and for which MATCH (symbol name, NAME) == 0, passing each to
225 CALLBACK, reading in partial symbol tables as needed. Look
226 through global symbols if GLOBAL and otherwise static symbols.
227 Passes NAME, NAMESPACE, and DATA to CALLBACK with each symbol
228 found. After each block is processed, passes NULL to CALLBACK.
229 MATCH must be weaker than strcmp_iw_ordered in the sense that
230 strcmp_iw_ordered(x,y) == 0 --> MATCH(x,y) == 0. ORDERED_COMPARE,
231 if non-null, must be an ordering relation compatible with
232 strcmp_iw_ordered in the sense that
233 strcmp_iw_ordered(x,y) == 0 --> ORDERED_COMPARE(x,y) == 0
235 strcmp_iw_ordered(x,y) <= 0 --> ORDERED_COMPARE(x,y) <= 0
236 (allowing strcmp_iw_ordered(x,y) < 0 while ORDERED_COMPARE(x, y) == 0).
237 CALLBACK returns 0 to indicate that the scan should continue, or
238 non-zero to indicate that the scan should be terminated. */
240 void (*map_matching_symbols) (struct objfile *,
241 const char *name, domain_enum namespace,
243 int (*callback) (struct block *,
244 struct symbol *, void *),
246 symbol_compare_ftype *match,
247 symbol_compare_ftype *ordered_compare);
249 /* Expand all symbol tables in OBJFILE matching some criteria.
251 FILE_MATCHER is called for each file in OBJFILE. The file name
252 and the DATA argument are passed to it. If it returns zero, this
253 file is skipped. If FILE_MATCHER is NULL such file is not skipped.
254 If BASENAMES is non-zero the function should consider only base name of
255 DATA (passed file name is already only the lbasename part).
257 Otherwise, if KIND does not match this symbol is skipped.
259 If even KIND matches, then NAME_MATCHER is called for each symbol
260 defined in the file. The symbol "search" name and DATA are passed
263 If NAME_MATCHER returns zero, then this symbol is skipped.
265 Otherwise, this symbol's symbol table is expanded.
267 DATA is user data that is passed unmodified to the callback
269 void (*expand_symtabs_matching)
270 (struct objfile *objfile,
271 int (*file_matcher) (const char *, void *, int basenames),
272 int (*name_matcher) (const char *, void *),
273 enum search_domain kind,
276 /* Return the symbol table from OBJFILE that contains PC and
277 SECTION. Return NULL if there is no such symbol table. This
278 should return the symbol table that contains a symbol whose
279 address exactly matches PC, or, if there is no exact match, the
280 symbol table that contains a symbol whose address is closest to
282 struct symtab *(*find_pc_sect_symtab) (struct objfile *objfile,
283 struct minimal_symbol *msymbol,
285 struct obj_section *section,
288 /* Call a callback for every file defined in OBJFILE whose symtab is
289 not already read in. FUN is the callback. It is passed the file's
290 FILENAME, the file's FULLNAME (if need_fullname is non-zero), and
291 the DATA passed to this function. */
292 void (*map_symbol_filenames) (struct objfile *objfile,
293 symbol_filename_ftype *fun, void *data,
297 /* Structure of functions used for probe support. If one of these functions
298 is provided, all must be. */
302 /* If non-NULL, return an array of probe objects.
304 The returned value does not have to be freed and it has lifetime of the
306 VEC (probe_p) *(*sym_get_probes) (struct objfile *);
308 /* Return the number of arguments available to PROBE. PROBE will
309 have come from a call to this objfile's sym_get_probes method.
310 If you provide an implementation of sym_get_probes, you must
311 implement this method as well. */
312 unsigned (*sym_get_probe_argument_count) (struct probe *probe);
314 /* Return 1 if the probe interface can evaluate the arguments of probe
315 PROBE, zero otherwise. This function can be probe-specific, informing
316 whether only the arguments of PROBE can be evaluated, of generic,
317 informing whether the probe interface is able to evaluate any kind of
318 argument. If you provide an implementation of sym_get_probes, you must
319 implement this method as well. */
320 int (*can_evaluate_probe_arguments) (struct probe *probe);
322 /* Evaluate the Nth argument available to PROBE. PROBE will have
323 come from a call to this objfile's sym_get_probes method. N will
324 be between 0 and the number of arguments available to this probe.
325 FRAME is the frame in which the evaluation is done; the frame's
326 PC will match the address of the probe. If you provide an
327 implementation of sym_get_probes, you must implement this method
329 struct value *(*sym_evaluate_probe_argument) (struct probe *probe,
332 /* Compile the Nth probe argument to an agent expression. PROBE
333 will have come from a call to this objfile's sym_get_probes
334 method. N will be between 0 and the number of arguments
335 available to this probe. EXPR and VALUE are the agent expression
336 that is being updated. */
337 void (*sym_compile_to_ax) (struct probe *probe,
338 struct agent_expr *expr,
339 struct axs_value *value,
342 /* Relocate the probe section of OBJFILE. */
343 void (*sym_relocate_probe) (struct objfile *objfile,
344 const struct section_offsets *new_offsets,
345 const struct section_offsets *delta);
348 /* Structure to keep track of symbol reading functions for various
349 object file types. */
354 /* BFD flavour that we handle, or (as a special kludge, see
355 xcoffread.c, (enum bfd_flavour)-1 for xcoff). */
357 enum bfd_flavour sym_flavour;
359 /* Initializes anything that is global to the entire symbol table.
360 It is called during symbol_file_add, when we begin debugging an
361 entirely new program. */
363 void (*sym_new_init) (struct objfile *);
365 /* Reads any initial information from a symbol file, and initializes
366 the struct sym_fns SF in preparation for sym_read(). It is
367 called every time we read a symbol file for any reason. */
369 void (*sym_init) (struct objfile *);
371 /* sym_read (objfile, symfile_flags) Reads a symbol file into a psymtab
372 (or possibly a symtab). OBJFILE is the objfile struct for the
373 file we are reading. SYMFILE_FLAGS are the flags passed to
374 symbol_file_add & co. */
376 void (*sym_read) (struct objfile *, int);
378 /* Read the partial symbols for an objfile. This may be NULL, in which case
379 gdb has to check other ways if this objfile has any symbols. This may
380 only be non-NULL if the objfile actually does have debuginfo available.
383 void (*sym_read_psymbols) (struct objfile *);
385 /* Called when we are finished with an objfile. Should do all
386 cleanup that is specific to the object file format for the
387 particular objfile. */
389 void (*sym_finish) (struct objfile *);
391 /* This function produces a file-dependent section_offsets
392 structure, allocated in the objfile's storage, and based on the
393 parameter. The parameter is currently a CORE_ADDR (FIXME!) for
394 backward compatibility with the higher levels of GDB. It should
395 probably be changed to a string, where NULL means the default,
396 and others are parsed in a file dependent way. */
398 void (*sym_offsets) (struct objfile *, const struct section_addr_info *);
400 /* This function produces a format-independent description of
401 the segments of ABFD. Each segment is a unit of the file
402 which may be relocated independently. */
404 struct symfile_segment_data *(*sym_segments) (bfd *abfd);
406 /* This function should read the linetable from the objfile when
407 the line table cannot be read while processing the debugging
410 void (*sym_read_linetable) (struct objfile *);
412 /* Relocate the contents of a debug section SECTP. The
413 contents are stored in BUF if it is non-NULL, or returned in a
414 malloc'd buffer otherwise. */
416 bfd_byte *(*sym_relocate) (struct objfile *, asection *sectp, bfd_byte *buf);
418 /* If non-NULL, this objfile has probe support, and all the probe
419 functions referred to here will be non-NULL. */
420 const struct sym_probe_fns *sym_probe_fns;
422 /* The "quick" (aka partial) symbol functions for this symbol
424 const struct quick_symbol_functions *qf;
427 extern struct section_addr_info *
428 build_section_addr_info_from_objfile (const struct objfile *objfile);
430 extern void relative_addr_info_to_section_offsets
431 (struct section_offsets *section_offsets, int num_sections,
432 const struct section_addr_info *addrs);
434 extern void addr_info_make_relative (struct section_addr_info *addrs,
437 /* The default version of sym_fns.sym_offsets for readers that don't
438 do anything special. */
440 extern void default_symfile_offsets (struct objfile *objfile,
441 const struct section_addr_info *);
443 /* The default version of sym_fns.sym_segments for readers that don't
444 do anything special. */
446 extern struct symfile_segment_data *default_symfile_segments (bfd *abfd);
448 /* The default version of sym_fns.sym_relocate for readers that don't
449 do anything special. */
451 extern bfd_byte *default_symfile_relocate (struct objfile *objfile,
452 asection *sectp, bfd_byte *buf);
454 extern struct symtab *allocate_symtab (const char *, struct objfile *)
455 ATTRIBUTE_NONNULL (1);
457 extern void add_symtab_fns (const struct sym_fns *);
459 /* This enum encodes bit-flags passed as ADD_FLAGS parameter to
460 symbol_file_add, etc. */
462 enum symfile_add_flags
464 /* Be chatty about what you are doing. */
465 SYMFILE_VERBOSE = 1 << 1,
467 /* This is the main symbol file (as opposed to symbol file for dynamically
469 SYMFILE_MAINLINE = 1 << 2,
471 /* Do not call breakpoint_re_set when adding this symbol file. */
472 SYMFILE_DEFER_BP_RESET = 1 << 3,
474 /* Do not immediately read symbols for this file. By default,
475 symbols are read when the objfile is created. */
476 SYMFILE_NO_READ = 1 << 4
479 extern void new_symfile_objfile (struct objfile *, int);
481 extern struct objfile *symbol_file_add (const char *, int,
482 struct section_addr_info *, int);
484 extern struct objfile *symbol_file_add_from_bfd (bfd *, const char *, int,
485 struct section_addr_info *,
486 int, struct objfile *parent);
488 extern void symbol_file_add_separate (bfd *, const char *, int,
491 extern char *find_separate_debug_file_by_debuglink (struct objfile *);
493 /* Create a new section_addr_info, with room for NUM_SECTIONS. */
495 extern struct section_addr_info *alloc_section_addr_info (size_t
498 /* Build (allocate and populate) a section_addr_info struct from an
499 existing section table. */
501 extern struct section_addr_info
502 *build_section_addr_info_from_section_table (const struct target_section
504 const struct target_section
507 /* Free all memory allocated by
508 build_section_addr_info_from_section_table. */
510 extern void free_section_addr_info (struct section_addr_info *);
515 /* If non-zero, shared library symbols will be added automatically
516 when the inferior is created, new libraries are loaded, or when
517 attaching to the inferior. This is almost always what users will
518 want to have happen; but for very large programs, the startup time
519 will be excessive, and so if this is a problem, the user can clear
520 this flag and then add the shared library symbols as needed. Note
521 that there is a potential for confusion, since if the shared
522 library symbols are not loaded, commands like "info fun" will *not*
523 report all the functions that are actually present. */
525 extern int auto_solib_add;
529 extern void set_initial_language (void);
531 extern void find_lowest_section (bfd *, asection *, void *);
533 extern bfd *symfile_bfd_open (const char *);
535 extern bfd *gdb_bfd_open_maybe_remote (const char *);
537 extern int get_section_index (struct objfile *, char *);
539 /* Utility functions for overlay sections: */
540 extern enum overlay_debugging_state
546 extern int overlay_cache_invalid;
548 /* Return the "mapped" overlay section containing the PC. */
549 extern struct obj_section *find_pc_mapped_section (CORE_ADDR);
551 /* Return any overlay section containing the PC (even in its LMA
553 extern struct obj_section *find_pc_overlay (CORE_ADDR);
555 /* Return true if the section is an overlay. */
556 extern int section_is_overlay (struct obj_section *);
558 /* Return true if the overlay section is currently "mapped". */
559 extern int section_is_mapped (struct obj_section *);
561 /* Return true if pc belongs to section's VMA. */
562 extern CORE_ADDR pc_in_mapped_range (CORE_ADDR, struct obj_section *);
564 /* Return true if pc belongs to section's LMA. */
565 extern CORE_ADDR pc_in_unmapped_range (CORE_ADDR, struct obj_section *);
567 /* Map an address from a section's LMA to its VMA. */
568 extern CORE_ADDR overlay_mapped_address (CORE_ADDR, struct obj_section *);
570 /* Map an address from a section's VMA to its LMA. */
571 extern CORE_ADDR overlay_unmapped_address (CORE_ADDR, struct obj_section *);
573 /* Convert an address in an overlay section (force into VMA range). */
574 extern CORE_ADDR symbol_overlayed_address (CORE_ADDR, struct obj_section *);
576 /* Load symbols from a file. */
577 extern void symbol_file_add_main (const char *args, int from_tty);
579 /* Clear GDB symbol tables. */
580 extern void symbol_file_clear (int from_tty);
582 /* Default overlay update function. */
583 extern void simple_overlay_update (struct obj_section *);
585 extern bfd_byte *symfile_relocate_debug_section (struct objfile *, asection *,
588 extern int symfile_map_offsets_to_segments (bfd *,
589 const struct symfile_segment_data *,
590 struct section_offsets *,
591 int, const CORE_ADDR *);
592 struct symfile_segment_data *get_symfile_segment_data (bfd *abfd);
593 void free_symfile_segment_data (struct symfile_segment_data *data);
595 extern struct cleanup *increment_reading_symtab (void);
597 /* From dwarf2read.c */
599 /* Names for a dwarf2 debugging section. The field NORMAL is the normal
600 section name (usually from the DWARF standard), while the field COMPRESSED
601 is the name of compressed sections. If your object file format doesn't
602 support compressed sections, the field COMPRESSED can be NULL. Likewise,
603 the debugging section is not supported, the field NORMAL can be NULL too.
604 It doesn't make sense to have a NULL NORMAL field but a non-NULL COMPRESSED
607 struct dwarf2_section_names {
609 const char *compressed;
612 /* List of names for dward2 debugging sections. Also most object file formats
613 use the standardized (ie ELF) names, some (eg XCOFF) have customized names
615 The table for the standard names is defined in dwarf2read.c. Please
616 update all instances of dwarf2_debug_sections if you add a field to this
617 structure. It is always safe to use { NULL, NULL } in this case. */
619 struct dwarf2_debug_sections {
620 struct dwarf2_section_names info;
621 struct dwarf2_section_names abbrev;
622 struct dwarf2_section_names line;
623 struct dwarf2_section_names loc;
624 struct dwarf2_section_names macinfo;
625 struct dwarf2_section_names macro;
626 struct dwarf2_section_names str;
627 struct dwarf2_section_names ranges;
628 struct dwarf2_section_names types;
629 struct dwarf2_section_names addr;
630 struct dwarf2_section_names frame;
631 struct dwarf2_section_names eh_frame;
632 struct dwarf2_section_names gdb_index;
633 /* This field has no meaning, but exists solely to catch changes to
634 this structure which are not reflected in some instance. */
638 extern int dwarf2_has_info (struct objfile *,
639 const struct dwarf2_debug_sections *);
641 /* Dwarf2 sections that can be accessed by dwarf2_get_section_info. */
642 enum dwarf2_section_enum {
647 extern void dwarf2_get_section_info (struct objfile *,
648 enum dwarf2_section_enum,
649 asection **, const gdb_byte **,
652 extern int dwarf2_initialize_objfile (struct objfile *);
653 extern void dwarf2_build_psymtabs (struct objfile *);
654 extern void dwarf2_build_frame_info (struct objfile *);
656 void dwarf2_free_objfile (struct objfile *);
658 /* From mdebugread.c */
660 extern void mdebug_build_psymtabs (struct objfile *,
661 const struct ecoff_debug_swap *,
662 struct ecoff_debug_info *);
664 extern void elfmdebug_build_psymtabs (struct objfile *,
665 const struct ecoff_debug_swap *,
668 /* From minidebug.c. */
670 extern bfd *find_separate_debug_file_in_section (struct objfile *);
672 #endif /* !defined(SYMFILE_H) */