Eliminate literal line numbers in mi-console.exp
[binutils-gdb.git] / gdb / symfile.h
blobf56aff3273e730110af2816d8a5fc263363aea0b
1 /* Definitions for reading symbol files into GDB.
3 Copyright (C) 1990-2014 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)
21 #define SYMFILE_H
23 /* This file requires that you first include "bfd.h". */
24 #include "symtab.h"
25 #include "probe.h"
27 /* Opaque declarations. */
28 struct target_section;
29 struct objfile;
30 struct obj_section;
31 struct obstack;
32 struct block;
33 struct probe;
34 struct value;
35 struct frame_info;
36 struct agent_expr;
37 struct axs_value;
39 /* Comparison function for symbol look ups. */
41 typedef int (symbol_compare_ftype) (const char *string1,
42 const char *string2);
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
62 partial symbol. */
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
70 store a pointer. */
72 int size;
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
85 available. */
86 size_t num_sections;
87 /* Sections whose names are file format dependent. */
88 struct other_sections
90 CORE_ADDR addr;
91 char *name;
93 /* SECTINDEX must be valid for associated BFD or set to -1. */
94 int sectindex;
95 } other[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. */
106 int num_segments;
108 /* If NUM_SEGMENTS is greater than zero, the original base address
109 of each segment. */
110 CORE_ADDR *segment_bases;
112 /* If NUM_SEGMENTS is greater than zero, the memory size of each
113 segment. */
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. */
120 int *segment_info;
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 /* Callback for quick_symbol_functions->expand_symtabs_matching
129 to match a file name. */
131 typedef int (expand_symtabs_file_matcher_ftype) (const char *filename,
132 void *data, int basenames);
134 /* Callback for quick_symbol_functions->expand_symtabs_matching
135 to match a symbol name. */
137 typedef int (expand_symtabs_symbol_matcher_ftype) (const char *name,
138 void *data);
140 /* The "quick" symbol functions exist so that symbol readers can
141 avoiding an initial read of all the symbols. For example, symbol
142 readers might choose to use the "partial symbol table" utilities,
143 which is one implementation of the quick symbol functions.
145 The quick symbol functions are generally opaque: the underlying
146 representation is hidden from the caller.
148 In general, these functions should only look at whatever special
149 index the symbol reader creates -- looking through the symbol
150 tables themselves is handled by generic code. If a function is
151 defined as returning a "symbol table", this means that the function
152 should only return a newly-created symbol table; it should not
153 examine pre-existing ones.
155 The exact list of functions here was determined in an ad hoc way
156 based on gdb's history. */
158 struct quick_symbol_functions
160 /* Return true if this objfile has any "partial" symbols
161 available. */
162 int (*has_symbols) (struct objfile *objfile);
164 /* Return the symbol table for the "last" file appearing in
165 OBJFILE. */
166 struct symtab *(*find_last_source_symtab) (struct objfile *objfile);
168 /* Forget all cached full file names for OBJFILE. */
169 void (*forget_cached_source_info) (struct objfile *objfile);
171 /* Expand and iterate over each "partial" symbol table in OBJFILE
172 where the source file is named NAME.
174 If NAME is not absolute, a match after a '/' in the symbol table's
175 file name will also work, REAL_PATH is NULL then. If NAME is
176 absolute then REAL_PATH is non-NULL absolute file name as resolved
177 via gdb_realpath from NAME.
179 If a match is found, the "partial" symbol table is expanded.
180 Then, this calls iterate_over_some_symtabs (or equivalent) over
181 all newly-created symbol tables, passing CALLBACK and DATA to it.
182 The result of this call is returned. */
183 int (*map_symtabs_matching_filename) (struct objfile *objfile,
184 const char *name,
185 const char *real_path,
186 int (*callback) (struct symtab *,
187 void *),
188 void *data);
190 /* Check to see if the symbol is defined in a "partial" symbol table
191 of OBJFILE. BLOCK_INDEX should be either GLOBAL_BLOCK or STATIC_BLOCK,
192 depending on whether we want to search global symbols or static
193 symbols. NAME is the name of the symbol to look for. DOMAIN
194 indicates what sort of symbol to search for.
196 Returns the newly-expanded symbol table in which the symbol is
197 defined, or NULL if no such symbol table exists. If OBJFILE
198 contains !TYPE_OPAQUE symbol prefer its symtab. If it contains
199 only TYPE_OPAQUE symbol(s), return at least that symtab. */
200 struct symtab *(*lookup_symbol) (struct objfile *objfile,
201 int block_index, const char *name,
202 domain_enum domain);
204 /* Print statistics about any indices loaded for OBJFILE. The
205 statistics should be printed to gdb_stdout. This is used for
206 "maint print statistics". */
207 void (*print_stats) (struct objfile *objfile);
209 /* Dump any indices loaded for OBJFILE. The dump should go to
210 gdb_stdout. This is used for "maint print objfiles". */
211 void (*dump) (struct objfile *objfile);
213 /* This is called by objfile_relocate to relocate any indices loaded
214 for OBJFILE. */
215 void (*relocate) (struct objfile *objfile,
216 const struct section_offsets *new_offsets,
217 const struct section_offsets *delta);
219 /* Find all the symbols in OBJFILE named FUNC_NAME, and ensure that
220 the corresponding symbol tables are loaded. */
221 void (*expand_symtabs_for_function) (struct objfile *objfile,
222 const char *func_name);
224 /* Read all symbol tables associated with OBJFILE. */
225 void (*expand_all_symtabs) (struct objfile *objfile);
227 /* Read all symbol tables associated with OBJFILE which have
228 symtab_to_fullname equal to FULLNAME.
229 This is for the purposes of examining code only, e.g., expand_line_sal.
230 The routine may ignore debug info that is known to not be useful with
231 code, e.g., DW_TAG_type_unit for dwarf debug info. */
232 void (*expand_symtabs_with_fullname) (struct objfile *objfile,
233 const char *fullname);
235 /* Find global or static symbols in all tables that are in NAMESPACE
236 and for which MATCH (symbol name, NAME) == 0, passing each to
237 CALLBACK, reading in partial symbol tables as needed. Look
238 through global symbols if GLOBAL and otherwise static symbols.
239 Passes NAME, NAMESPACE, and DATA to CALLBACK with each symbol
240 found. After each block is processed, passes NULL to CALLBACK.
241 MATCH must be weaker than strcmp_iw_ordered in the sense that
242 strcmp_iw_ordered(x,y) == 0 --> MATCH(x,y) == 0. ORDERED_COMPARE,
243 if non-null, must be an ordering relation compatible with
244 strcmp_iw_ordered in the sense that
245 strcmp_iw_ordered(x,y) == 0 --> ORDERED_COMPARE(x,y) == 0
246 and
247 strcmp_iw_ordered(x,y) <= 0 --> ORDERED_COMPARE(x,y) <= 0
248 (allowing strcmp_iw_ordered(x,y) < 0 while ORDERED_COMPARE(x, y) == 0).
249 CALLBACK returns 0 to indicate that the scan should continue, or
250 non-zero to indicate that the scan should be terminated. */
252 void (*map_matching_symbols) (struct objfile *,
253 const char *name, domain_enum namespace,
254 int global,
255 int (*callback) (struct block *,
256 struct symbol *, void *),
257 void *data,
258 symbol_compare_ftype *match,
259 symbol_compare_ftype *ordered_compare);
261 /* Expand all symbol tables in OBJFILE matching some criteria.
263 FILE_MATCHER is called for each file in OBJFILE. The file name
264 and the DATA argument are passed to it. If it returns zero, this
265 file is skipped. If FILE_MATCHER is NULL such file is not skipped.
266 If BASENAMES is non-zero the function should consider only base name of
267 DATA (passed file name is already only the lbasename part).
269 Otherwise, if KIND does not match this symbol is skipped.
271 If even KIND matches, then SYMBOL_MATCHER is called for each symbol
272 defined in the file. The symbol "search" name and DATA are passed
273 to SYMBOL_MATCHER.
275 If SYMBOL_MATCHER returns zero, then this symbol is skipped.
277 Otherwise, this symbol's symbol table is expanded.
279 DATA is user data that is passed unmodified to the callback
280 functions. */
281 void (*expand_symtabs_matching)
282 (struct objfile *objfile,
283 expand_symtabs_file_matcher_ftype *file_matcher,
284 expand_symtabs_symbol_matcher_ftype *symbol_matcher,
285 enum search_domain kind,
286 void *data);
288 /* Return the symbol table from OBJFILE that contains PC and
289 SECTION. Return NULL if there is no such symbol table. This
290 should return the symbol table that contains a symbol whose
291 address exactly matches PC, or, if there is no exact match, the
292 symbol table that contains a symbol whose address is closest to
293 PC. */
294 struct symtab *(*find_pc_sect_symtab) (struct objfile *objfile,
295 struct bound_minimal_symbol msymbol,
296 CORE_ADDR pc,
297 struct obj_section *section,
298 int warn_if_readin);
300 /* Call a callback for every file defined in OBJFILE whose symtab is
301 not already read in. FUN is the callback. It is passed the file's
302 FILENAME, the file's FULLNAME (if need_fullname is non-zero), and
303 the DATA passed to this function. */
304 void (*map_symbol_filenames) (struct objfile *objfile,
305 symbol_filename_ftype *fun, void *data,
306 int need_fullname);
309 /* Structure of functions used for probe support. If one of these functions
310 is provided, all must be. */
312 struct sym_probe_fns
314 /* If non-NULL, return an array of probe objects.
316 The returned value does not have to be freed and it has lifetime of the
317 OBJFILE. */
318 VEC (probe_p) *(*sym_get_probes) (struct objfile *);
321 /* Structure to keep track of symbol reading functions for various
322 object file types. */
324 struct sym_fns
326 /* Initializes anything that is global to the entire symbol table.
327 It is called during symbol_file_add, when we begin debugging an
328 entirely new program. */
330 void (*sym_new_init) (struct objfile *);
332 /* Reads any initial information from a symbol file, and initializes
333 the struct sym_fns SF in preparation for sym_read(). It is
334 called every time we read a symbol file for any reason. */
336 void (*sym_init) (struct objfile *);
338 /* sym_read (objfile, symfile_flags) Reads a symbol file into a psymtab
339 (or possibly a symtab). OBJFILE is the objfile struct for the
340 file we are reading. SYMFILE_FLAGS are the flags passed to
341 symbol_file_add & co. */
343 void (*sym_read) (struct objfile *, int);
345 /* Read the partial symbols for an objfile. This may be NULL, in which case
346 gdb has to check other ways if this objfile has any symbols. This may
347 only be non-NULL if the objfile actually does have debuginfo available.
350 void (*sym_read_psymbols) (struct objfile *);
352 /* Called when we are finished with an objfile. Should do all
353 cleanup that is specific to the object file format for the
354 particular objfile. */
356 void (*sym_finish) (struct objfile *);
358 /* This function produces a file-dependent section_offsets
359 structure, allocated in the objfile's storage, and based on the
360 parameter. The parameter is currently a CORE_ADDR (FIXME!) for
361 backward compatibility with the higher levels of GDB. It should
362 probably be changed to a string, where NULL means the default,
363 and others are parsed in a file dependent way. */
365 void (*sym_offsets) (struct objfile *, const struct section_addr_info *);
367 /* This function produces a format-independent description of
368 the segments of ABFD. Each segment is a unit of the file
369 which may be relocated independently. */
371 struct symfile_segment_data *(*sym_segments) (bfd *abfd);
373 /* This function should read the linetable from the objfile when
374 the line table cannot be read while processing the debugging
375 information. */
377 void (*sym_read_linetable) (struct objfile *);
379 /* Relocate the contents of a debug section SECTP. The
380 contents are stored in BUF if it is non-NULL, or returned in a
381 malloc'd buffer otherwise. */
383 bfd_byte *(*sym_relocate) (struct objfile *, asection *sectp, bfd_byte *buf);
385 /* If non-NULL, this objfile has probe support, and all the probe
386 functions referred to here will be non-NULL. */
387 const struct sym_probe_fns *sym_probe_fns;
389 /* The "quick" (aka partial) symbol functions for this symbol
390 reader. */
391 const struct quick_symbol_functions *qf;
394 extern struct section_addr_info *
395 build_section_addr_info_from_objfile (const struct objfile *objfile);
397 extern void relative_addr_info_to_section_offsets
398 (struct section_offsets *section_offsets, int num_sections,
399 const struct section_addr_info *addrs);
401 extern void addr_info_make_relative (struct section_addr_info *addrs,
402 bfd *abfd);
404 /* The default version of sym_fns.sym_offsets for readers that don't
405 do anything special. */
407 extern void default_symfile_offsets (struct objfile *objfile,
408 const struct section_addr_info *);
410 /* The default version of sym_fns.sym_segments for readers that don't
411 do anything special. */
413 extern struct symfile_segment_data *default_symfile_segments (bfd *abfd);
415 /* The default version of sym_fns.sym_relocate for readers that don't
416 do anything special. */
418 extern bfd_byte *default_symfile_relocate (struct objfile *objfile,
419 asection *sectp, bfd_byte *buf);
421 extern struct symtab *allocate_symtab (const char *, struct objfile *)
422 ATTRIBUTE_NONNULL (1);
424 extern void add_symtab_fns (enum bfd_flavour flavour, const struct sym_fns *);
426 /* This enum encodes bit-flags passed as ADD_FLAGS parameter to
427 symbol_file_add, etc. */
429 enum symfile_add_flags
431 /* Be chatty about what you are doing. */
432 SYMFILE_VERBOSE = 1 << 1,
434 /* This is the main symbol file (as opposed to symbol file for dynamically
435 loaded code). */
436 SYMFILE_MAINLINE = 1 << 2,
438 /* Do not call breakpoint_re_set when adding this symbol file. */
439 SYMFILE_DEFER_BP_RESET = 1 << 3,
441 /* Do not immediately read symbols for this file. By default,
442 symbols are read when the objfile is created. */
443 SYMFILE_NO_READ = 1 << 4
446 extern void new_symfile_objfile (struct objfile *, int);
448 extern struct objfile *symbol_file_add (const char *, int,
449 struct section_addr_info *, int);
451 extern struct objfile *symbol_file_add_from_bfd (bfd *, const char *, int,
452 struct section_addr_info *,
453 int, struct objfile *parent);
455 extern void symbol_file_add_separate (bfd *, const char *, int,
456 struct objfile *);
458 extern char *find_separate_debug_file_by_debuglink (struct objfile *);
460 /* Create a new section_addr_info, with room for NUM_SECTIONS. */
462 extern struct section_addr_info *alloc_section_addr_info (size_t
463 num_sections);
465 /* Build (allocate and populate) a section_addr_info struct from an
466 existing section table. */
468 extern struct section_addr_info
469 *build_section_addr_info_from_section_table (const struct target_section
470 *start,
471 const struct target_section
472 *end);
474 /* Free all memory allocated by
475 build_section_addr_info_from_section_table. */
477 extern void free_section_addr_info (struct section_addr_info *);
480 /* Variables */
482 /* If non-zero, shared library symbols will be added automatically
483 when the inferior is created, new libraries are loaded, or when
484 attaching to the inferior. This is almost always what users will
485 want to have happen; but for very large programs, the startup time
486 will be excessive, and so if this is a problem, the user can clear
487 this flag and then add the shared library symbols as needed. Note
488 that there is a potential for confusion, since if the shared
489 library symbols are not loaded, commands like "info fun" will *not*
490 report all the functions that are actually present. */
492 extern int auto_solib_add;
494 /* From symfile.c */
496 extern void set_initial_language (void);
498 extern void find_lowest_section (bfd *, asection *, void *);
500 extern bfd *symfile_bfd_open (const char *);
502 extern bfd *gdb_bfd_open_maybe_remote (const char *);
504 extern int get_section_index (struct objfile *, char *);
506 extern int print_symbol_loading_p (int from_tty, int mainline, int full);
508 /* Utility functions for overlay sections: */
509 extern enum overlay_debugging_state
511 ovly_off,
512 ovly_on,
513 ovly_auto
514 } overlay_debugging;
515 extern int overlay_cache_invalid;
517 /* Return the "mapped" overlay section containing the PC. */
518 extern struct obj_section *find_pc_mapped_section (CORE_ADDR);
520 /* Return any overlay section containing the PC (even in its LMA
521 region). */
522 extern struct obj_section *find_pc_overlay (CORE_ADDR);
524 /* Return true if the section is an overlay. */
525 extern int section_is_overlay (struct obj_section *);
527 /* Return true if the overlay section is currently "mapped". */
528 extern int section_is_mapped (struct obj_section *);
530 /* Return true if pc belongs to section's VMA. */
531 extern CORE_ADDR pc_in_mapped_range (CORE_ADDR, struct obj_section *);
533 /* Return true if pc belongs to section's LMA. */
534 extern CORE_ADDR pc_in_unmapped_range (CORE_ADDR, struct obj_section *);
536 /* Map an address from a section's LMA to its VMA. */
537 extern CORE_ADDR overlay_mapped_address (CORE_ADDR, struct obj_section *);
539 /* Map an address from a section's VMA to its LMA. */
540 extern CORE_ADDR overlay_unmapped_address (CORE_ADDR, struct obj_section *);
542 /* Convert an address in an overlay section (force into VMA range). */
543 extern CORE_ADDR symbol_overlayed_address (CORE_ADDR, struct obj_section *);
545 /* Load symbols from a file. */
546 extern void symbol_file_add_main (const char *args, int from_tty);
548 /* Clear GDB symbol tables. */
549 extern void symbol_file_clear (int from_tty);
551 /* Default overlay update function. */
552 extern void simple_overlay_update (struct obj_section *);
554 extern bfd_byte *symfile_relocate_debug_section (struct objfile *, asection *,
555 bfd_byte *);
557 extern int symfile_map_offsets_to_segments (bfd *,
558 const struct symfile_segment_data *,
559 struct section_offsets *,
560 int, const CORE_ADDR *);
561 struct symfile_segment_data *get_symfile_segment_data (bfd *abfd);
562 void free_symfile_segment_data (struct symfile_segment_data *data);
564 extern struct cleanup *increment_reading_symtab (void);
566 void expand_symtabs_matching (expand_symtabs_file_matcher_ftype *,
567 expand_symtabs_symbol_matcher_ftype *,
568 enum search_domain kind, void *data);
570 void map_symbol_filenames (symbol_filename_ftype *fun, void *data,
571 int need_fullname);
573 /* From dwarf2read.c */
575 /* Names for a dwarf2 debugging section. The field NORMAL is the normal
576 section name (usually from the DWARF standard), while the field COMPRESSED
577 is the name of compressed sections. If your object file format doesn't
578 support compressed sections, the field COMPRESSED can be NULL. Likewise,
579 the debugging section is not supported, the field NORMAL can be NULL too.
580 It doesn't make sense to have a NULL NORMAL field but a non-NULL COMPRESSED
581 field. */
583 struct dwarf2_section_names {
584 const char *normal;
585 const char *compressed;
588 /* List of names for dward2 debugging sections. Also most object file formats
589 use the standardized (ie ELF) names, some (eg XCOFF) have customized names
590 due to restrictions.
591 The table for the standard names is defined in dwarf2read.c. Please
592 update all instances of dwarf2_debug_sections if you add a field to this
593 structure. It is always safe to use { NULL, NULL } in this case. */
595 struct dwarf2_debug_sections {
596 struct dwarf2_section_names info;
597 struct dwarf2_section_names abbrev;
598 struct dwarf2_section_names line;
599 struct dwarf2_section_names loc;
600 struct dwarf2_section_names macinfo;
601 struct dwarf2_section_names macro;
602 struct dwarf2_section_names str;
603 struct dwarf2_section_names ranges;
604 struct dwarf2_section_names types;
605 struct dwarf2_section_names addr;
606 struct dwarf2_section_names frame;
607 struct dwarf2_section_names eh_frame;
608 struct dwarf2_section_names gdb_index;
609 /* This field has no meaning, but exists solely to catch changes to
610 this structure which are not reflected in some instance. */
611 int sentinel;
614 extern int dwarf2_has_info (struct objfile *,
615 const struct dwarf2_debug_sections *);
617 /* Dwarf2 sections that can be accessed by dwarf2_get_section_info. */
618 enum dwarf2_section_enum {
619 DWARF2_DEBUG_FRAME,
620 DWARF2_EH_FRAME
623 extern void dwarf2_get_section_info (struct objfile *,
624 enum dwarf2_section_enum,
625 asection **, const gdb_byte **,
626 bfd_size_type *);
628 extern int dwarf2_initialize_objfile (struct objfile *);
629 extern void dwarf2_build_psymtabs (struct objfile *);
630 extern void dwarf2_build_frame_info (struct objfile *);
632 void dwarf2_free_objfile (struct objfile *);
634 /* From mdebugread.c */
636 extern void mdebug_build_psymtabs (struct objfile *,
637 const struct ecoff_debug_swap *,
638 struct ecoff_debug_info *);
640 extern void elfmdebug_build_psymtabs (struct objfile *,
641 const struct ecoff_debug_swap *,
642 asection *);
644 /* From minidebug.c. */
646 extern bfd *find_separate_debug_file_in_section (struct objfile *);
648 #endif /* !defined(SYMFILE_H) */