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 probe
*probe
);
325 /* Evaluate the Nth argument available to PROBE. PROBE will have
326 come from a call to this objfile's sym_get_probes method. N will
327 be between 0 and the number of arguments available to this probe.
328 FRAME is the frame in which the evaluation is done; the frame's
329 PC will match the address of the probe. If you provide an
330 implementation of sym_get_probes, you must implement this method
332 struct value
*(*sym_evaluate_probe_argument
) (struct probe
*probe
,
335 /* Compile the Nth probe argument to an agent expression. PROBE
336 will have come from a call to this objfile's sym_get_probes
337 method. N will be between 0 and the number of arguments
338 available to this probe. EXPR and VALUE are the agent expression
339 that is being updated. */
340 void (*sym_compile_to_ax
) (struct probe
*probe
,
341 struct agent_expr
*expr
,
342 struct axs_value
*value
,
345 /* Relocate the probe section of OBJFILE. */
346 void (*sym_relocate_probe
) (struct objfile
*objfile
,
347 struct section_offsets
*new_offsets
,
348 struct section_offsets
*delta
);
351 /* Structure to keep track of symbol reading functions for various
352 object file types. */
357 /* BFD flavour that we handle, or (as a special kludge, see
358 xcoffread.c, (enum bfd_flavour)-1 for xcoff). */
360 enum bfd_flavour sym_flavour
;
362 /* Initializes anything that is global to the entire symbol table.
363 It is called during symbol_file_add, when we begin debugging an
364 entirely new program. */
366 void (*sym_new_init
) (struct objfile
*);
368 /* Reads any initial information from a symbol file, and initializes
369 the struct sym_fns SF in preparation for sym_read(). It is
370 called every time we read a symbol file for any reason. */
372 void (*sym_init
) (struct objfile
*);
374 /* sym_read (objfile, symfile_flags) Reads a symbol file into a psymtab
375 (or possibly a symtab). OBJFILE is the objfile struct for the
376 file we are reading. SYMFILE_FLAGS are the flags passed to
377 symbol_file_add & co. */
379 void (*sym_read
) (struct objfile
*, int);
381 /* Read the partial symbols for an objfile. This may be NULL, in which case
382 gdb has to check other ways if this objfile has any symbols. This may
383 only be non-NULL if the objfile actually does have debuginfo available.
386 void (*sym_read_psymbols
) (struct objfile
*);
388 /* Called when we are finished with an objfile. Should do all
389 cleanup that is specific to the object file format for the
390 particular objfile. */
392 void (*sym_finish
) (struct objfile
*);
394 /* This function produces a file-dependent section_offsets
395 structure, allocated in the objfile's storage, and based on the
396 parameter. The parameter is currently a CORE_ADDR (FIXME!) for
397 backward compatibility with the higher levels of GDB. It should
398 probably be changed to a string, where NULL means the default,
399 and others are parsed in a file dependent way. */
401 void (*sym_offsets
) (struct objfile
*, struct section_addr_info
*);
403 /* This function produces a format-independent description of
404 the segments of ABFD. Each segment is a unit of the file
405 which may be relocated independently. */
407 struct symfile_segment_data
*(*sym_segments
) (bfd
*abfd
);
409 /* This function should read the linetable from the objfile when
410 the line table cannot be read while processing the debugging
413 void (*sym_read_linetable
) (void);
415 /* Relocate the contents of a debug section SECTP. The
416 contents are stored in BUF if it is non-NULL, or returned in a
417 malloc'd buffer otherwise. */
419 bfd_byte
*(*sym_relocate
) (struct objfile
*, asection
*sectp
, bfd_byte
*buf
);
421 /* If non-NULL, this objfile has probe support, and all the probe
422 functions referred to here will be non-NULL. */
423 const struct sym_probe_fns
*sym_probe_fns
;
425 /* The "quick" (aka partial) symbol functions for this symbol
427 const struct quick_symbol_functions
*qf
;
430 extern struct section_addr_info
*
431 build_section_addr_info_from_objfile (const struct objfile
*objfile
);
433 extern void relative_addr_info_to_section_offsets
434 (struct section_offsets
*section_offsets
, int num_sections
,
435 struct section_addr_info
*addrs
);
437 extern void addr_info_make_relative (struct section_addr_info
*addrs
,
440 /* The default version of sym_fns.sym_offsets for readers that don't
441 do anything special. */
443 extern void default_symfile_offsets (struct objfile
*objfile
,
444 struct section_addr_info
*);
446 /* The default version of sym_fns.sym_segments for readers that don't
447 do anything special. */
449 extern struct symfile_segment_data
*default_symfile_segments (bfd
*abfd
);
451 /* The default version of sym_fns.sym_relocate for readers that don't
452 do anything special. */
454 extern bfd_byte
*default_symfile_relocate (struct objfile
*objfile
,
455 asection
*sectp
, bfd_byte
*buf
);
457 extern struct symtab
*allocate_symtab (const char *, struct objfile
*);
459 extern void add_symtab_fns (const struct sym_fns
*);
461 /* This enum encodes bit-flags passed as ADD_FLAGS parameter to
462 syms_from_objfile, symbol_file_add, etc. */
464 enum symfile_add_flags
466 /* Be chatty about what you are doing. */
467 SYMFILE_VERBOSE
= 1 << 1,
469 /* This is the main symbol file (as opposed to symbol file for dynamically
471 SYMFILE_MAINLINE
= 1 << 2,
473 /* Do not call breakpoint_re_set when adding this symbol file. */
474 SYMFILE_DEFER_BP_RESET
= 1 << 3,
476 /* Do not immediately read symbols for this file. By default,
477 symbols are read when the objfile is created. */
478 SYMFILE_NO_READ
= 1 << 4
481 extern void syms_from_objfile (struct objfile
*,
482 struct section_addr_info
*,
483 struct section_offsets
*, int, int);
485 extern void new_symfile_objfile (struct objfile
*, int);
487 extern struct objfile
*symbol_file_add (char *, int,
488 struct section_addr_info
*, int);
490 extern struct objfile
*symbol_file_add_from_bfd (bfd
*, int,
491 struct section_addr_info
*,
492 int, struct objfile
*parent
);
494 extern void symbol_file_add_separate (bfd
*, int, struct objfile
*);
496 extern char *find_separate_debug_file_by_debuglink (struct objfile
*);
498 /* Create a new section_addr_info, with room for NUM_SECTIONS. */
500 extern struct section_addr_info
*alloc_section_addr_info (size_t
503 /* Build (allocate and populate) a section_addr_info struct from an
504 existing section table. */
506 extern struct section_addr_info
507 *build_section_addr_info_from_section_table (const struct target_section
509 const struct target_section
512 /* Free all memory allocated by
513 build_section_addr_info_from_section_table. */
515 extern void free_section_addr_info (struct section_addr_info
*);
518 /* Make a copy of the string at PTR with SIZE characters in the symbol
519 obstack (and add a null character at the end in the copy). Returns
520 the address of the copy. */
522 extern char *obsavestring (const char *, int, struct obstack
*);
524 /* Concatenate NULL terminated variable argument list of `const char
525 *' strings; return the new string. Space is found in the OBSTACKP.
526 Argument list must be terminated by a sentinel expression `(char *)
529 extern char *obconcat (struct obstack
*obstackp
, ...) ATTRIBUTE_SENTINEL
;
533 /* If non-zero, shared library symbols will be added automatically
534 when the inferior is created, new libraries are loaded, or when
535 attaching to the inferior. This is almost always what users will
536 want to have happen; but for very large programs, the startup time
537 will be excessive, and so if this is a problem, the user can clear
538 this flag and then add the shared library symbols as needed. Note
539 that there is a potential for confusion, since if the shared
540 library symbols are not loaded, commands like "info fun" will *not*
541 report all the functions that are actually present. */
543 extern int auto_solib_add
;
547 extern void set_initial_language (void);
549 extern void find_lowest_section (bfd
*, asection
*, void *);
551 extern bfd
*symfile_bfd_open (char *);
553 extern bfd
*gdb_bfd_open_maybe_remote (const char *);
555 extern int get_section_index (struct objfile
*, char *);
557 /* Utility functions for overlay sections: */
558 extern enum overlay_debugging_state
564 extern int overlay_cache_invalid
;
566 /* Return the "mapped" overlay section containing the PC. */
567 extern struct obj_section
*find_pc_mapped_section (CORE_ADDR
);
569 /* Return any overlay section containing the PC (even in its LMA
571 extern struct obj_section
*find_pc_overlay (CORE_ADDR
);
573 /* Return true if the section is an overlay. */
574 extern int section_is_overlay (struct obj_section
*);
576 /* Return true if the overlay section is currently "mapped". */
577 extern int section_is_mapped (struct obj_section
*);
579 /* Return true if pc belongs to section's VMA. */
580 extern CORE_ADDR
pc_in_mapped_range (CORE_ADDR
, struct obj_section
*);
582 /* Return true if pc belongs to section's LMA. */
583 extern CORE_ADDR
pc_in_unmapped_range (CORE_ADDR
, struct obj_section
*);
585 /* Map an address from a section's LMA to its VMA. */
586 extern CORE_ADDR
overlay_mapped_address (CORE_ADDR
, struct obj_section
*);
588 /* Map an address from a section's VMA to its LMA. */
589 extern CORE_ADDR
overlay_unmapped_address (CORE_ADDR
, struct obj_section
*);
591 /* Convert an address in an overlay section (force into VMA range). */
592 extern CORE_ADDR
symbol_overlayed_address (CORE_ADDR
, struct obj_section
*);
594 /* Load symbols from a file. */
595 extern void symbol_file_add_main (char *args
, int from_tty
);
597 /* Clear GDB symbol tables. */
598 extern void symbol_file_clear (int from_tty
);
600 /* Default overlay update function. */
601 extern void simple_overlay_update (struct obj_section
*);
603 extern bfd_byte
*symfile_relocate_debug_section (struct objfile
*, asection
*,
606 extern int symfile_map_offsets_to_segments (bfd
*,
607 struct symfile_segment_data
*,
608 struct section_offsets
*,
609 int, const CORE_ADDR
*);
610 struct symfile_segment_data
*get_symfile_segment_data (bfd
*abfd
);
611 void free_symfile_segment_data (struct symfile_segment_data
*data
);
613 extern struct cleanup
*increment_reading_symtab (void);
615 /* From dwarf2read.c */
617 /* Names for a dwarf2 debugging section. The field NORMAL is the normal
618 section name (usually from the DWARF standard), while the field COMPRESSED
619 is the name of compressed sections. If your object file format doesn't
620 support compressed sections, the field COMPRESSED can be NULL. Likewise,
621 the debugging section is not supported, the field NORMAL can be NULL too.
622 It doesn't make sense to have a NULL NORMAL field but a non-NULL COMPRESSED
625 struct dwarf2_section_names
{
627 const char *compressed
;
630 /* List of names for dward2 debugging sections. Also most object file formats
631 use the standardized (ie ELF) names, some (eg XCOFF) have customized names
633 The table for the standard names is defined in dwarf2read.c. Please
634 update all instances of dwarf2_debug_sections if you add a field to this
635 structure. It is always safe to use { NULL, NULL } in this case. */
637 struct dwarf2_debug_sections
{
638 struct dwarf2_section_names info
;
639 struct dwarf2_section_names abbrev
;
640 struct dwarf2_section_names line
;
641 struct dwarf2_section_names loc
;
642 struct dwarf2_section_names macinfo
;
643 struct dwarf2_section_names macro
;
644 struct dwarf2_section_names str
;
645 struct dwarf2_section_names ranges
;
646 struct dwarf2_section_names types
;
647 struct dwarf2_section_names addr
;
648 struct dwarf2_section_names frame
;
649 struct dwarf2_section_names eh_frame
;
650 struct dwarf2_section_names gdb_index
;
651 /* This field has no meaning, but exists solely to catch changes to
652 this structure which are not reflected in some instance. */
656 extern int dwarf2_has_info (struct objfile
*,
657 const struct dwarf2_debug_sections
*);
659 /* Dwarf2 sections that can be accessed by dwarf2_get_section_info. */
660 enum dwarf2_section_enum
{
665 extern void dwarf2_get_section_info (struct objfile
*,
666 enum dwarf2_section_enum
,
667 asection
**, gdb_byte
**,
670 extern int dwarf2_initialize_objfile (struct objfile
*);
671 extern void dwarf2_build_psymtabs (struct objfile
*);
672 extern void dwarf2_build_frame_info (struct objfile
*);
674 void dwarf2_free_objfile (struct objfile
*);
676 /* From mdebugread.c */
678 /* Hack to force structures to exist before use in parameter list. */
679 struct ecoff_debug_hack
681 struct ecoff_debug_swap
*a
;
682 struct ecoff_debug_info
*b
;
685 extern void mdebug_build_psymtabs (struct objfile
*,
686 const struct ecoff_debug_swap
*,
687 struct ecoff_debug_info
*);
689 extern void elfmdebug_build_psymtabs (struct objfile
*,
690 const struct ecoff_debug_swap
*,
693 #endif /* !defined(SYMFILE_H) */