1 /* Definitions for reading symbol files into GDB.
3 Copyright (C) 1990-2004, 2007-2012 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
163 table's file name will also work. FULL_PATH is the absolute file
164 name, and REAL_PATH is the same, run through gdb_realpath.
166 If a match is found, the "partial" symbol table is expanded.
167 Then, this calls iterate_over_some_symtabs (or equivalent) over
168 all newly-created symbol tables, passing CALLBACK and DATA to it.
169 The result of this call is returned. */
170 int (*map_symtabs_matching_filename
) (struct objfile
*objfile
,
172 const char *full_path
,
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 /* This is called to expand symbol tables before looking up a
193 symbol. A backend can choose to implement this and then have its
194 `lookup_symbol' hook always return NULL, or the reverse. (It
195 doesn't make sense to implement both.) The arguments are as for
197 void (*pre_expand_symtabs_matching
) (struct objfile
*objfile
,
198 enum block_enum block_kind
,
202 /* Print statistics about any indices loaded for OBJFILE. The
203 statistics should be printed to gdb_stdout. This is used for
204 "maint print statistics". */
205 void (*print_stats
) (struct objfile
*objfile
);
207 /* Dump any indices loaded for OBJFILE. The dump should go to
208 gdb_stdout. This is used for "maint print objfiles". */
209 void (*dump
) (struct objfile
*objfile
);
211 /* This is called by objfile_relocate to relocate any indices loaded
213 void (*relocate
) (struct objfile
*objfile
,
214 struct section_offsets
*new_offsets
,
215 struct section_offsets
*delta
);
217 /* Find all the symbols in OBJFILE named FUNC_NAME, and ensure that
218 the corresponding symbol tables are loaded. */
219 void (*expand_symtabs_for_function
) (struct objfile
*objfile
,
220 const char *func_name
);
222 /* Read all symbol tables associated with OBJFILE. */
223 void (*expand_all_symtabs
) (struct objfile
*objfile
);
225 /* Read all symbol tables associated with OBJFILE which have the
227 This is for the purposes of examining code only, e.g., expand_line_sal.
228 The routine may ignore debug info that is known to not be useful with
229 code, e.g., DW_TAG_type_unit for dwarf debug info. */
230 void (*expand_symtabs_with_filename
) (struct objfile
*objfile
,
231 const char *filename
);
233 /* Return the file name of the file holding the global symbol in OBJFILE
234 named NAME. If no such symbol exists in OBJFILE, return NULL. */
235 const char *(*find_symbol_file
) (struct objfile
*objfile
, const char *name
);
237 /* Find global or static symbols in all tables that are in NAMESPACE
238 and for which MATCH (symbol name, NAME) == 0, passing each to
239 CALLBACK, reading in partial symbol tables as needed. Look
240 through global symbols if GLOBAL and otherwise static symbols.
241 Passes NAME, NAMESPACE, and DATA to CALLBACK with each symbol
242 found. After each block is processed, passes NULL to CALLBACK.
243 MATCH must be weaker than strcmp_iw_ordered in the sense that
244 strcmp_iw_ordered(x,y) == 0 --> MATCH(x,y) == 0. ORDERED_COMPARE,
245 if non-null, must be an ordering relation compatible with
246 strcmp_iw_ordered in the sense that
247 strcmp_iw_ordered(x,y) == 0 --> ORDERED_COMPARE(x,y) == 0
249 strcmp_iw_ordered(x,y) <= 0 --> ORDERED_COMPARE(x,y) <= 0
250 (allowing strcmp_iw_ordered(x,y) < 0 while ORDERED_COMPARE(x, y) == 0).
251 CALLBACK returns 0 to indicate that the scan should continue, or
252 non-zero to indicate that the scan should be terminated. */
254 void (*map_matching_symbols
) (const char *name
, domain_enum
namespace,
255 struct objfile
*, int global
,
256 int (*callback
) (struct block
*,
257 struct symbol
*, void *),
259 symbol_compare_ftype
*match
,
260 symbol_compare_ftype
*ordered_compare
);
262 /* Expand all symbol tables in OBJFILE matching some criteria.
264 FILE_MATCHER is called for each file in OBJFILE. The file name
265 and the DATA argument are passed to it. If it returns zero, this
266 file is skipped. If FILE_MATCHER is NULL such file is not skipped.
268 Otherwise, if KIND does not match this symbol is skipped.
270 If even KIND matches, then NAME_MATCHER is called for each symbol
271 defined in the file. The symbol "search" name and DATA are passed
274 If NAME_MATCHER returns zero, then this symbol is skipped.
276 Otherwise, this symbol's symbol table is expanded.
278 DATA is user data that is passed unmodified to the callback
280 void (*expand_symtabs_matching
)
281 (struct objfile
*objfile
,
282 int (*file_matcher
) (const char *, void *),
283 int (*name_matcher
) (const char *, void *),
284 enum search_domain kind
,
287 /* Return the symbol table from OBJFILE that contains PC and
288 SECTION. Return NULL if there is no such symbol table. This
289 should return the symbol table that contains a symbol whose
290 address exactly matches PC, or, if there is no exact match, the
291 symbol table that contains a symbol whose address is closest to
293 struct symtab
*(*find_pc_sect_symtab
) (struct objfile
*objfile
,
294 struct minimal_symbol
*msymbol
,
296 struct obj_section
*section
,
299 /* Call a callback for every file defined in OBJFILE whose symtab is
300 not already read in. FUN is the callback. It is passed the file's
301 FILENAME, the file's FULLNAME (if need_fullname is non-zero), and
302 the DATA passed to this function. */
303 void (*map_symbol_filenames
) (struct objfile
*objfile
,
304 symbol_filename_ftype
*fun
, void *data
,
308 /* Structure of functions used for probe support. If one of these functions
309 is provided, all must be. */
313 /* If non-NULL, return an array of probe objects.
315 The returned value does not have to be freed and it has lifetime of the
317 VEC (probe_p
) *(*sym_get_probes
) (struct objfile
*);
319 /* Return the number of arguments available to PROBE. PROBE will
320 have come from a call to this objfile's sym_get_probes method.
321 If you provide an implementation of sym_get_probes, you must
322 implement this method as well. */
323 unsigned (*sym_get_probe_argument_count
) (struct objfile
*objfile
,
324 struct probe
*probe
);
326 /* Evaluate the Nth argument available to PROBE. PROBE will have
327 come from a call to this objfile's sym_get_probes method. N will
328 be between 0 and the number of arguments available to this probe.
329 FRAME is the frame in which the evaluation is done; the frame's
330 PC will match the address of the probe. If you provide an
331 implementation of sym_get_probes, you must implement this method
333 struct value
*(*sym_evaluate_probe_argument
) (struct objfile
*objfile
,
337 /* Compile the Nth probe argument to an agent expression. PROBE
338 will have come from a call to this objfile's sym_get_probes
339 method. N will be between 0 and the number of arguments
340 available to this probe. EXPR and VALUE are the agent expression
341 that is being updated. */
342 void (*sym_compile_to_ax
) (struct objfile
*objfile
,
344 struct agent_expr
*expr
,
345 struct axs_value
*value
,
348 /* Relocate the probe section of OBJFILE. */
349 void (*sym_relocate_probe
) (struct objfile
*objfile
,
350 struct section_offsets
*new_offsets
,
351 struct section_offsets
*delta
);
354 /* Structure to keep track of symbol reading functions for various
355 object file types. */
360 /* BFD flavour that we handle, or (as a special kludge, see
361 xcoffread.c, (enum bfd_flavour)-1 for xcoff). */
363 enum bfd_flavour sym_flavour
;
365 /* Initializes anything that is global to the entire symbol table.
366 It is called during symbol_file_add, when we begin debugging an
367 entirely new program. */
369 void (*sym_new_init
) (struct objfile
*);
371 /* Reads any initial information from a symbol file, and initializes
372 the struct sym_fns SF in preparation for sym_read(). It is
373 called every time we read a symbol file for any reason. */
375 void (*sym_init
) (struct objfile
*);
377 /* sym_read (objfile, symfile_flags) Reads a symbol file into a psymtab
378 (or possibly a symtab). OBJFILE is the objfile struct for the
379 file we are reading. SYMFILE_FLAGS are the flags passed to
380 symbol_file_add & co. */
382 void (*sym_read
) (struct objfile
*, int);
384 /* Read the partial symbols for an objfile. This may be NULL, in which case
385 gdb has to check other ways if this objfile has any symbols. This may
386 only be non-NULL if the objfile actually does have debuginfo available.
389 void (*sym_read_psymbols
) (struct objfile
*);
391 /* Called when we are finished with an objfile. Should do all
392 cleanup that is specific to the object file format for the
393 particular objfile. */
395 void (*sym_finish
) (struct objfile
*);
397 /* This function produces a file-dependent section_offsets
398 structure, allocated in the objfile's storage, and based on the
399 parameter. The parameter is currently a CORE_ADDR (FIXME!) for
400 backward compatibility with the higher levels of GDB. It should
401 probably be changed to a string, where NULL means the default,
402 and others are parsed in a file dependent way. */
404 void (*sym_offsets
) (struct objfile
*, struct section_addr_info
*);
406 /* This function produces a format-independent description of
407 the segments of ABFD. Each segment is a unit of the file
408 which may be relocated independently. */
410 struct symfile_segment_data
*(*sym_segments
) (bfd
*abfd
);
412 /* This function should read the linetable from the objfile when
413 the line table cannot be read while processing the debugging
416 void (*sym_read_linetable
) (void);
418 /* Relocate the contents of a debug section SECTP. The
419 contents are stored in BUF if it is non-NULL, or returned in a
420 malloc'd buffer otherwise. */
422 bfd_byte
*(*sym_relocate
) (struct objfile
*, asection
*sectp
, bfd_byte
*buf
);
424 /* If non-NULL, this objfile has probe support, and all the probe
425 functions referred to here will be non-NULL. */
426 const struct sym_probe_fns
*sym_probe_fns
;
428 /* The "quick" (aka partial) symbol functions for this symbol
430 const struct quick_symbol_functions
*qf
;
433 extern struct section_addr_info
*
434 build_section_addr_info_from_objfile (const struct objfile
*objfile
);
436 extern void relative_addr_info_to_section_offsets
437 (struct section_offsets
*section_offsets
, int num_sections
,
438 struct section_addr_info
*addrs
);
440 extern void addr_info_make_relative (struct section_addr_info
*addrs
,
443 /* The default version of sym_fns.sym_offsets for readers that don't
444 do anything special. */
446 extern void default_symfile_offsets (struct objfile
*objfile
,
447 struct section_addr_info
*);
449 /* The default version of sym_fns.sym_segments for readers that don't
450 do anything special. */
452 extern struct symfile_segment_data
*default_symfile_segments (bfd
*abfd
);
454 /* The default version of sym_fns.sym_relocate for readers that don't
455 do anything special. */
457 extern bfd_byte
*default_symfile_relocate (struct objfile
*objfile
,
458 asection
*sectp
, bfd_byte
*buf
);
460 extern struct symtab
*allocate_symtab (const char *, struct objfile
*);
462 extern void add_symtab_fns (const struct sym_fns
*);
464 /* This enum encodes bit-flags passed as ADD_FLAGS parameter to
465 syms_from_objfile, symbol_file_add, etc. */
467 enum symfile_add_flags
469 /* Be chatty about what you are doing. */
470 SYMFILE_VERBOSE
= 1 << 1,
472 /* This is the main symbol file (as opposed to symbol file for dynamically
474 SYMFILE_MAINLINE
= 1 << 2,
476 /* Do not call breakpoint_re_set when adding this symbol file. */
477 SYMFILE_DEFER_BP_RESET
= 1 << 3,
479 /* Do not immediately read symbols for this file. By default,
480 symbols are read when the objfile is created. */
481 SYMFILE_NO_READ
= 1 << 4
484 extern void syms_from_objfile (struct objfile
*,
485 struct section_addr_info
*,
486 struct section_offsets
*, int, int);
488 extern void new_symfile_objfile (struct objfile
*, int);
490 extern struct objfile
*symbol_file_add (char *, int,
491 struct section_addr_info
*, int);
493 extern struct objfile
*symbol_file_add_from_bfd (bfd
*, int,
494 struct section_addr_info
*,
495 int, struct objfile
*parent
);
497 extern void symbol_file_add_separate (bfd
*, int, struct objfile
*);
499 extern char *find_separate_debug_file_by_debuglink (struct objfile
*);
501 /* Create a new section_addr_info, with room for NUM_SECTIONS. */
503 extern struct section_addr_info
*alloc_section_addr_info (size_t
506 /* Build (allocate and populate) a section_addr_info struct from an
507 existing section table. */
509 extern struct section_addr_info
510 *build_section_addr_info_from_section_table (const struct target_section
512 const struct target_section
515 /* Free all memory allocated by
516 build_section_addr_info_from_section_table. */
518 extern void free_section_addr_info (struct section_addr_info
*);
521 /* Make a copy of the string at PTR with SIZE characters in the symbol
522 obstack (and add a null character at the end in the copy). Returns
523 the address of the copy. */
525 extern char *obsavestring (const char *, int, struct obstack
*);
527 /* Concatenate NULL terminated variable argument list of `const char
528 *' strings; return the new string. Space is found in the OBSTACKP.
529 Argument list must be terminated by a sentinel expression `(char *)
532 extern char *obconcat (struct obstack
*obstackp
, ...) ATTRIBUTE_SENTINEL
;
536 /* If non-zero, shared library symbols will be added automatically
537 when the inferior is created, new libraries are loaded, or when
538 attaching to the inferior. This is almost always what users will
539 want to have happen; but for very large programs, the startup time
540 will be excessive, and so if this is a problem, the user can clear
541 this flag and then add the shared library symbols as needed. Note
542 that there is a potential for confusion, since if the shared
543 library symbols are not loaded, commands like "info fun" will *not*
544 report all the functions that are actually present. */
546 extern int auto_solib_add
;
550 extern void set_initial_language (void);
552 extern void find_lowest_section (bfd
*, asection
*, void *);
554 extern bfd
*symfile_bfd_open (char *);
556 extern bfd
*bfd_open_maybe_remote (const char *);
558 extern int get_section_index (struct objfile
*, char *);
560 /* Utility functions for overlay sections: */
561 extern enum overlay_debugging_state
567 extern int overlay_cache_invalid
;
569 /* Return the "mapped" overlay section containing the PC. */
570 extern struct obj_section
*find_pc_mapped_section (CORE_ADDR
);
572 /* Return any overlay section containing the PC (even in its LMA
574 extern struct obj_section
*find_pc_overlay (CORE_ADDR
);
576 /* Return true if the section is an overlay. */
577 extern int section_is_overlay (struct obj_section
*);
579 /* Return true if the overlay section is currently "mapped". */
580 extern int section_is_mapped (struct obj_section
*);
582 /* Return true if pc belongs to section's VMA. */
583 extern CORE_ADDR
pc_in_mapped_range (CORE_ADDR
, struct obj_section
*);
585 /* Return true if pc belongs to section's LMA. */
586 extern CORE_ADDR
pc_in_unmapped_range (CORE_ADDR
, struct obj_section
*);
588 /* Map an address from a section's LMA to its VMA. */
589 extern CORE_ADDR
overlay_mapped_address (CORE_ADDR
, struct obj_section
*);
591 /* Map an address from a section's VMA to its LMA. */
592 extern CORE_ADDR
overlay_unmapped_address (CORE_ADDR
, struct obj_section
*);
594 /* Convert an address in an overlay section (force into VMA range). */
595 extern CORE_ADDR
symbol_overlayed_address (CORE_ADDR
, struct obj_section
*);
597 /* Load symbols from a file. */
598 extern void symbol_file_add_main (char *args
, int from_tty
);
600 /* Clear GDB symbol tables. */
601 extern void symbol_file_clear (int from_tty
);
603 /* Default overlay update function. */
604 extern void simple_overlay_update (struct obj_section
*);
606 extern bfd_byte
*symfile_relocate_debug_section (struct objfile
*, asection
*,
609 extern int symfile_map_offsets_to_segments (bfd
*,
610 struct symfile_segment_data
*,
611 struct section_offsets
*,
612 int, const CORE_ADDR
*);
613 struct symfile_segment_data
*get_symfile_segment_data (bfd
*abfd
);
614 void free_symfile_segment_data (struct symfile_segment_data
*data
);
616 extern struct cleanup
*increment_reading_symtab (void);
618 /* From dwarf2read.c */
620 /* Names for a dwarf2 debugging section. The field NORMAL is the normal
621 section name (usually from the DWARF standard), while the field COMPRESSED
622 is the name of compressed sections. If your object file format doesn't
623 support compressed sections, the field COMPRESSED can be NULL. Likewise,
624 the debugging section is not supported, the field NORMAL can be NULL too.
625 It doesn't make sense to have a NULL NORMAL field but a non-NULL COMPRESSED
628 struct dwarf2_section_names
{
630 const char *compressed
;
633 /* List of names for dward2 debugging sections. Also most object file formats
634 use the standardized (ie ELF) names, some (eg XCOFF) have customized names
636 The table for the standard names is defined in dwarf2read.c. Please
637 update all instances of dwarf2_debug_sections if you add a field to this
638 structure. It is always safe to use { NULL, NULL } in this case. */
640 struct dwarf2_debug_sections
{
641 struct dwarf2_section_names info
;
642 struct dwarf2_section_names abbrev
;
643 struct dwarf2_section_names line
;
644 struct dwarf2_section_names loc
;
645 struct dwarf2_section_names macinfo
;
646 struct dwarf2_section_names macro
;
647 struct dwarf2_section_names str
;
648 struct dwarf2_section_names ranges
;
649 struct dwarf2_section_names types
;
650 struct dwarf2_section_names addr
;
651 struct dwarf2_section_names frame
;
652 struct dwarf2_section_names eh_frame
;
653 struct dwarf2_section_names gdb_index
;
654 /* This field has no meaning, but exists solely to catch changes to
655 this structure which are not reflected in some instance. */
659 extern int dwarf2_has_info (struct objfile
*,
660 const struct dwarf2_debug_sections
*);
662 /* Dwarf2 sections that can be accessed by dwarf2_get_section_info. */
663 enum dwarf2_section_enum
{
668 extern void dwarf2_get_section_info (struct objfile
*,
669 enum dwarf2_section_enum
,
670 asection
**, gdb_byte
**,
673 extern int dwarf2_initialize_objfile (struct objfile
*);
674 extern void dwarf2_build_psymtabs (struct objfile
*);
675 extern void dwarf2_build_frame_info (struct objfile
*);
677 void dwarf2_free_objfile (struct objfile
*);
679 /* Whether to use deprecated .gdb_index sections. */
680 extern int use_deprecated_index_sections
;
682 /* From mdebugread.c */
684 /* Hack to force structures to exist before use in parameter list. */
685 struct ecoff_debug_hack
687 struct ecoff_debug_swap
*a
;
688 struct ecoff_debug_info
*b
;
691 extern void mdebug_build_psymtabs (struct objfile
*,
692 const struct ecoff_debug_swap
*,
693 struct ecoff_debug_info
*);
695 extern void elfmdebug_build_psymtabs (struct objfile
*,
696 const struct ecoff_debug_swap
*,
699 #endif /* !defined(SYMFILE_H) */