17e02a9da843a3d4e26f9db2c6d2caf21c34c733
[deliverable/binutils-gdb.git] / gdb / symfile.h
1 /* Definitions for reading symbol files into GDB.
2
3 Copyright (C) 1990-2020 Free Software Foundation, Inc.
4
5 This file is part of GDB.
6
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.
11
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.
16
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/>. */
19
20 #if !defined (SYMFILE_H)
21 #define SYMFILE_H
22
23 /* This file requires that you first include "bfd.h". */
24 #include "symtab.h"
25 #include "probe.h"
26 #include "symfile-add-flags.h"
27 #include "objfile-flags.h"
28 #include "gdb_bfd.h"
29 #include "gdbsupport/function-view.h"
30
31 /* Opaque declarations. */
32 struct target_section;
33 struct objfile;
34 struct obj_section;
35 struct obstack;
36 struct block;
37 struct value;
38 struct frame_info;
39 struct agent_expr;
40 struct axs_value;
41 class probe;
42
43 /* Comparison function for symbol look ups. */
44
45 typedef int (symbol_compare_ftype) (const char *string1,
46 const char *string2);
47
48 struct other_sections
49 {
50 other_sections (CORE_ADDR addr_, std::string &&name_, int sectindex_)
51 : addr (addr_),
52 name (std::move (name_)),
53 sectindex (sectindex_)
54 {
55 }
56
57 other_sections (other_sections &&other) = default;
58
59 DISABLE_COPY_AND_ASSIGN (other_sections);
60
61 CORE_ADDR addr;
62 std::string name;
63
64 /* SECTINDEX must be valid for associated BFD or set to -1.
65 See syms_from_objfile_1 for an exception to this rule.
66 */
67 int sectindex;
68 };
69
70 /* Define an array of addresses to accommodate non-contiguous dynamic
71 loading of modules. This is for use when entering commands, so we
72 can keep track of the section names until we read the file and can
73 map them to bfd sections. This structure is also used by solib.c
74 to communicate the section addresses in shared objects to
75 symbol_file_add (). */
76
77 typedef std::vector<other_sections> section_addr_info;
78
79 /* A table listing the load segments in a symfile, and which segment
80 each BFD section belongs to. */
81 struct symfile_segment_data
82 {
83 /* How many segments are present in this file. If there are
84 two, the text segment is the first one and the data segment
85 is the second one. */
86 int num_segments;
87
88 /* If NUM_SEGMENTS is greater than zero, the original base address
89 of each segment. */
90 CORE_ADDR *segment_bases;
91
92 /* If NUM_SEGMENTS is greater than zero, the memory size of each
93 segment. */
94 CORE_ADDR *segment_sizes;
95
96 /* If NUM_SEGMENTS is greater than zero, this is an array of entries
97 recording which segment contains each BFD section.
98 SEGMENT_INFO[I] is S+1 if the I'th BFD section belongs to segment
99 S, or zero if it is not in any segment. */
100 int *segment_info;
101 };
102
103 /* Callback for quick_symbol_functions->map_symbol_filenames. */
104
105 typedef void (symbol_filename_ftype) (const char *filename,
106 const char *fullname, void *data);
107
108 /* Callback for quick_symbol_functions->expand_symtabs_matching
109 to match a file name. */
110
111 typedef bool (expand_symtabs_file_matcher_ftype) (const char *filename,
112 bool basenames);
113
114 /* Callback for quick_symbol_functions->expand_symtabs_matching
115 to match a symbol name. */
116
117 typedef bool (expand_symtabs_symbol_matcher_ftype) (const char *name);
118
119 /* Callback for quick_symbol_functions->expand_symtabs_matching
120 to be called after a symtab has been expanded. */
121
122 typedef void (expand_symtabs_exp_notify_ftype) (compunit_symtab *symtab);
123
124 /* The "quick" symbol functions exist so that symbol readers can
125 avoiding an initial read of all the symbols. For example, symbol
126 readers might choose to use the "partial symbol table" utilities,
127 which is one implementation of the quick symbol functions.
128
129 The quick symbol functions are generally opaque: the underlying
130 representation is hidden from the caller.
131
132 In general, these functions should only look at whatever special
133 index the symbol reader creates -- looking through the symbol
134 tables themselves is handled by generic code. If a function is
135 defined as returning a "symbol table", this means that the function
136 should only return a newly-created symbol table; it should not
137 examine pre-existing ones.
138
139 The exact list of functions here was determined in an ad hoc way
140 based on gdb's history. */
141
142 struct quick_symbol_functions
143 {
144 /* Return true if this objfile has any "partial" symbols
145 available. */
146 int (*has_symbols) (struct objfile *objfile);
147
148 /* Return the symbol table for the "last" file appearing in
149 OBJFILE. */
150 struct symtab *(*find_last_source_symtab) (struct objfile *objfile);
151
152 /* Forget all cached full file names for OBJFILE. */
153 void (*forget_cached_source_info) (struct objfile *objfile);
154
155 /* Expand and iterate over each "partial" symbol table in OBJFILE
156 where the source file is named NAME.
157
158 If NAME is not absolute, a match after a '/' in the symbol table's
159 file name will also work, REAL_PATH is NULL then. If NAME is
160 absolute then REAL_PATH is non-NULL absolute file name as resolved
161 via gdb_realpath from NAME.
162
163 If a match is found, the "partial" symbol table is expanded.
164 Then, this calls iterate_over_some_symtabs (or equivalent) over
165 all newly-created symbol tables, passing CALLBACK to it.
166 The result of this call is returned. */
167 bool (*map_symtabs_matching_filename)
168 (struct objfile *objfile, const char *name, const char *real_path,
169 gdb::function_view<bool (symtab *)> callback);
170
171 /* Check to see if the symbol is defined in a "partial" symbol table
172 of OBJFILE. BLOCK_INDEX should be either GLOBAL_BLOCK or STATIC_BLOCK,
173 depending on whether we want to search global symbols or static
174 symbols. NAME is the name of the symbol to look for. DOMAIN
175 indicates what sort of symbol to search for.
176
177 Returns the newly-expanded compunit in which the symbol is
178 defined, or NULL if no such symbol table exists. If OBJFILE
179 contains !TYPE_OPAQUE symbol prefer its compunit. If it contains
180 only TYPE_OPAQUE symbol(s), return at least that compunit. */
181 struct compunit_symtab *(*lookup_symbol) (struct objfile *objfile,
182 block_enum block_index,
183 const char *name,
184 domain_enum domain);
185
186 /* Print statistics about any indices loaded for OBJFILE. The
187 statistics should be printed to gdb_stdout. This is used for
188 "maint print statistics". */
189 void (*print_stats) (struct objfile *objfile);
190
191 /* Dump any indices loaded for OBJFILE. The dump should go to
192 gdb_stdout. This is used for "maint print objfiles". */
193 void (*dump) (struct objfile *objfile);
194
195 /* Find all the symbols in OBJFILE named FUNC_NAME, and ensure that
196 the corresponding symbol tables are loaded. */
197 void (*expand_symtabs_for_function) (struct objfile *objfile,
198 const char *func_name);
199
200 /* Read all symbol tables associated with OBJFILE. */
201 void (*expand_all_symtabs) (struct objfile *objfile);
202
203 /* Read all symbol tables associated with OBJFILE which have
204 symtab_to_fullname equal to FULLNAME.
205 This is for the purposes of examining code only, e.g., expand_line_sal.
206 The routine may ignore debug info that is known to not be useful with
207 code, e.g., DW_TAG_type_unit for dwarf debug info. */
208 void (*expand_symtabs_with_fullname) (struct objfile *objfile,
209 const char *fullname);
210
211 /* Find global or static symbols in all tables that are in DOMAIN
212 and for which MATCH (symbol name, NAME) == 0, passing each to
213 CALLBACK, reading in partial symbol tables as needed. Look
214 through global symbols if GLOBAL and otherwise static symbols.
215 Passes NAME and NAMESPACE to CALLBACK with each symbol
216 found. After each block is processed, passes NULL to CALLBACK.
217 MATCH must be weaker than strcmp_iw_ordered in the sense that
218 strcmp_iw_ordered(x,y) == 0 --> MATCH(x,y) == 0. ORDERED_COMPARE,
219 if non-null, must be an ordering relation compatible with
220 strcmp_iw_ordered in the sense that
221 strcmp_iw_ordered(x,y) == 0 --> ORDERED_COMPARE(x,y) == 0
222 and
223 strcmp_iw_ordered(x,y) <= 0 --> ORDERED_COMPARE(x,y) <= 0
224 (allowing strcmp_iw_ordered(x,y) < 0 while ORDERED_COMPARE(x, y) == 0).
225 CALLBACK returns true to indicate that the scan should continue, or
226 false to indicate that the scan should be terminated. */
227
228 void (*map_matching_symbols)
229 (struct objfile *,
230 const lookup_name_info &lookup_name,
231 domain_enum domain,
232 int global,
233 gdb::function_view<symbol_found_callback_ftype> callback,
234 symbol_compare_ftype *ordered_compare);
235
236 /* Expand all symbol tables in OBJFILE matching some criteria.
237
238 FILE_MATCHER is called for each file in OBJFILE. The file name
239 is passed to it. If the matcher returns false, the file is
240 skipped. If FILE_MATCHER is NULL the file is not skipped. If
241 BASENAMES is true the matcher should consider only file base
242 names (the passed file name is already only the lbasename'd
243 part).
244
245 Otherwise, if KIND does not match, this symbol is skipped.
246
247 If even KIND matches, SYMBOL_MATCHER is called for each symbol
248 defined in the file. The symbol "search" name is passed to
249 SYMBOL_MATCHER.
250
251 If SYMBOL_MATCHER returns false, then the symbol is skipped.
252
253 Otherwise, the symbol's symbol table is expanded. */
254 void (*expand_symtabs_matching)
255 (struct objfile *objfile,
256 gdb::function_view<expand_symtabs_file_matcher_ftype> file_matcher,
257 const lookup_name_info &lookup_name,
258 gdb::function_view<expand_symtabs_symbol_matcher_ftype> symbol_matcher,
259 gdb::function_view<expand_symtabs_exp_notify_ftype> expansion_notify,
260 enum search_domain kind);
261
262 /* Return the comp unit from OBJFILE that contains PC and
263 SECTION. Return NULL if there is no such compunit. This
264 should return the compunit that contains a symbol whose
265 address exactly matches PC, or, if there is no exact match, the
266 compunit that contains a symbol whose address is closest to
267 PC. */
268 struct compunit_symtab *(*find_pc_sect_compunit_symtab)
269 (struct objfile *objfile, struct bound_minimal_symbol msymbol,
270 CORE_ADDR pc, struct obj_section *section, int warn_if_readin);
271
272 /* Return the comp unit from OBJFILE that contains a symbol at
273 ADDRESS. Return NULL if there is no such comp unit. Unlike
274 find_pc_sect_compunit_symtab, any sort of symbol (not just text
275 symbols) can be considered, and only exact address matches are
276 considered. This pointer may be NULL. */
277 struct compunit_symtab *(*find_compunit_symtab_by_address)
278 (struct objfile *objfile, CORE_ADDR address);
279
280 /* Call a callback for every file defined in OBJFILE whose symtab is
281 not already read in. FUN is the callback. It is passed the file's
282 FILENAME, the file's FULLNAME (if need_fullname is non-zero), and
283 the DATA passed to this function. */
284 void (*map_symbol_filenames) (struct objfile *objfile,
285 symbol_filename_ftype *fun, void *data,
286 int need_fullname);
287 };
288
289 /* Structure of functions used for probe support. If one of these functions
290 is provided, all must be. */
291
292 struct sym_probe_fns
293 {
294 /* If non-NULL, return a reference to vector of probe objects. */
295 const std::vector<std::unique_ptr<probe>> &(*sym_get_probes)
296 (struct objfile *);
297 };
298
299 /* Structure to keep track of symbol reading functions for various
300 object file types. */
301
302 struct sym_fns
303 {
304 /* Initializes anything that is global to the entire symbol table.
305 It is called during symbol_file_add, when we begin debugging an
306 entirely new program. */
307
308 void (*sym_new_init) (struct objfile *);
309
310 /* Reads any initial information from a symbol file, and initializes
311 the struct sym_fns SF in preparation for sym_read(). It is
312 called every time we read a symbol file for any reason. */
313
314 void (*sym_init) (struct objfile *);
315
316 /* sym_read (objfile, symfile_flags) Reads a symbol file into a psymtab
317 (or possibly a symtab). OBJFILE is the objfile struct for the
318 file we are reading. SYMFILE_FLAGS are the flags passed to
319 symbol_file_add & co. */
320
321 void (*sym_read) (struct objfile *, symfile_add_flags);
322
323 /* Read the partial symbols for an objfile. This may be NULL, in which case
324 gdb has to check other ways if this objfile has any symbols. This may
325 only be non-NULL if the objfile actually does have debuginfo available.
326 */
327
328 void (*sym_read_psymbols) (struct objfile *);
329
330 /* Called when we are finished with an objfile. Should do all
331 cleanup that is specific to the object file format for the
332 particular objfile. */
333
334 void (*sym_finish) (struct objfile *);
335
336
337 /* This function produces a file-dependent section_offsets
338 structure, allocated in the objfile's storage.
339
340 The section_addr_info structure contains the offset of loadable and
341 allocated sections, relative to the absolute offsets found in the BFD. */
342
343 void (*sym_offsets) (struct objfile *, const section_addr_info &);
344
345 /* This function produces a format-independent description of
346 the segments of ABFD. Each segment is a unit of the file
347 which may be relocated independently. */
348
349 struct symfile_segment_data *(*sym_segments) (bfd *abfd);
350
351 /* This function should read the linetable from the objfile when
352 the line table cannot be read while processing the debugging
353 information. */
354
355 void (*sym_read_linetable) (struct objfile *);
356
357 /* Relocate the contents of a debug section SECTP. The
358 contents are stored in BUF if it is non-NULL, or returned in a
359 malloc'd buffer otherwise. */
360
361 bfd_byte *(*sym_relocate) (struct objfile *, asection *sectp, bfd_byte *buf);
362
363 /* If non-NULL, this objfile has probe support, and all the probe
364 functions referred to here will be non-NULL. */
365 const struct sym_probe_fns *sym_probe_fns;
366
367 /* The "quick" (aka partial) symbol functions for this symbol
368 reader. */
369 const struct quick_symbol_functions *qf;
370 };
371
372 extern section_addr_info
373 build_section_addr_info_from_objfile (const struct objfile *objfile);
374
375 extern void relative_addr_info_to_section_offsets
376 (struct section_offsets *section_offsets, int num_sections,
377 const section_addr_info &addrs);
378
379 extern void addr_info_make_relative (section_addr_info *addrs,
380 bfd *abfd);
381
382 /* The default version of sym_fns.sym_offsets for readers that don't
383 do anything special. */
384
385 extern void default_symfile_offsets (struct objfile *objfile,
386 const section_addr_info &);
387
388 /* The default version of sym_fns.sym_segments for readers that don't
389 do anything special. */
390
391 extern struct symfile_segment_data *default_symfile_segments (bfd *abfd);
392
393 /* The default version of sym_fns.sym_relocate for readers that don't
394 do anything special. */
395
396 extern bfd_byte *default_symfile_relocate (struct objfile *objfile,
397 asection *sectp, bfd_byte *buf);
398
399 extern struct symtab *allocate_symtab (struct compunit_symtab *, const char *)
400 ATTRIBUTE_NONNULL (1);
401
402 extern struct compunit_symtab *allocate_compunit_symtab (struct objfile *,
403 const char *)
404 ATTRIBUTE_NONNULL (1);
405
406 extern void add_compunit_symtab_to_objfile (struct compunit_symtab *cu);
407
408 extern void add_symtab_fns (enum bfd_flavour flavour, const struct sym_fns *);
409
410 extern void clear_symtab_users (symfile_add_flags add_flags);
411
412 extern enum language deduce_language_from_filename (const char *);
413
414 /* Map the filename extension EXT to the language LANG. Any previous
415 association of EXT will be removed. EXT will be copied by this
416 function. */
417 extern void add_filename_language (const char *ext, enum language lang);
418
419 extern struct objfile *symbol_file_add (const char *, symfile_add_flags,
420 section_addr_info *, objfile_flags);
421
422 extern struct objfile *symbol_file_add_from_bfd (bfd *, const char *, symfile_add_flags,
423 section_addr_info *,
424 objfile_flags, struct objfile *parent);
425
426 extern void symbol_file_add_separate (bfd *, const char *, symfile_add_flags,
427 struct objfile *);
428
429 extern std::string find_separate_debug_file_by_debuglink (struct objfile *);
430
431 /* Build (allocate and populate) a section_addr_info struct from an
432 existing section table. */
433
434 extern section_addr_info
435 build_section_addr_info_from_section_table (const struct target_section
436 *start,
437 const struct target_section
438 *end);
439
440 /* Variables */
441
442 /* If true, shared library symbols will be added automatically
443 when the inferior is created, new libraries are loaded, or when
444 attaching to the inferior. This is almost always what users will
445 want to have happen; but for very large programs, the startup time
446 will be excessive, and so if this is a problem, the user can clear
447 this flag and then add the shared library symbols as needed. Note
448 that there is a potential for confusion, since if the shared
449 library symbols are not loaded, commands like "info fun" will *not*
450 report all the functions that are actually present. */
451
452 extern bool auto_solib_add;
453
454 /* From symfile.c */
455
456 extern void set_initial_language (void);
457
458 extern void find_lowest_section (bfd *, asection *, void *);
459
460 extern gdb_bfd_ref_ptr symfile_bfd_open (const char *);
461
462 extern int get_section_index (struct objfile *, const char *);
463
464 extern int print_symbol_loading_p (int from_tty, int mainline, int full);
465
466 /* Utility functions for overlay sections: */
467 extern enum overlay_debugging_state
468 {
469 ovly_off,
470 ovly_on,
471 ovly_auto
472 } overlay_debugging;
473 extern int overlay_cache_invalid;
474
475 /* Return the "mapped" overlay section containing the PC. */
476 extern struct obj_section *find_pc_mapped_section (CORE_ADDR);
477
478 /* Return any overlay section containing the PC (even in its LMA
479 region). */
480 extern struct obj_section *find_pc_overlay (CORE_ADDR);
481
482 /* Return true if the section is an overlay. */
483 extern int section_is_overlay (struct obj_section *);
484
485 /* Return true if the overlay section is currently "mapped". */
486 extern int section_is_mapped (struct obj_section *);
487
488 /* Return true if pc belongs to section's VMA. */
489 extern CORE_ADDR pc_in_mapped_range (CORE_ADDR, struct obj_section *);
490
491 /* Return true if pc belongs to section's LMA. */
492 extern CORE_ADDR pc_in_unmapped_range (CORE_ADDR, struct obj_section *);
493
494 /* Map an address from a section's LMA to its VMA. */
495 extern CORE_ADDR overlay_mapped_address (CORE_ADDR, struct obj_section *);
496
497 /* Map an address from a section's VMA to its LMA. */
498 extern CORE_ADDR overlay_unmapped_address (CORE_ADDR, struct obj_section *);
499
500 /* Convert an address in an overlay section (force into VMA range). */
501 extern CORE_ADDR symbol_overlayed_address (CORE_ADDR, struct obj_section *);
502
503 /* Load symbols from a file. */
504 extern void symbol_file_add_main (const char *args,
505 symfile_add_flags add_flags);
506
507 /* Clear GDB symbol tables. */
508 extern void symbol_file_clear (int from_tty);
509
510 /* Default overlay update function. */
511 extern void simple_overlay_update (struct obj_section *);
512
513 extern bfd_byte *symfile_relocate_debug_section (struct objfile *, asection *,
514 bfd_byte *);
515
516 extern int symfile_map_offsets_to_segments (bfd *,
517 const struct symfile_segment_data *,
518 struct section_offsets *,
519 int, const CORE_ADDR *);
520 struct symfile_segment_data *get_symfile_segment_data (bfd *abfd);
521 void free_symfile_segment_data (struct symfile_segment_data *data);
522
523 extern scoped_restore_tmpl<int> increment_reading_symtab (void);
524
525 void expand_symtabs_matching
526 (gdb::function_view<expand_symtabs_file_matcher_ftype> file_matcher,
527 const lookup_name_info &lookup_name,
528 gdb::function_view<expand_symtabs_symbol_matcher_ftype> symbol_matcher,
529 gdb::function_view<expand_symtabs_exp_notify_ftype> expansion_notify,
530 enum search_domain kind);
531
532 void map_symbol_filenames (symbol_filename_ftype *fun, void *data,
533 int need_fullname);
534
535 /* Target-agnostic function to load the sections of an executable into memory.
536
537 ARGS should be in the form "EXECUTABLE [OFFSET]", where OFFSET is an
538 optional offset to apply to each section. */
539 extern void generic_load (const char *args, int from_tty);
540
541 /* From dwarf2read.c */
542
543 /* Names for a dwarf2 debugging section. The field NORMAL is the normal
544 section name (usually from the DWARF standard), while the field COMPRESSED
545 is the name of compressed sections. If your object file format doesn't
546 support compressed sections, the field COMPRESSED can be NULL. Likewise,
547 the debugging section is not supported, the field NORMAL can be NULL too.
548 It doesn't make sense to have a NULL NORMAL field but a non-NULL COMPRESSED
549 field. */
550
551 struct dwarf2_section_names {
552 const char *normal;
553 const char *compressed;
554 };
555
556 /* List of names for dward2 debugging sections. Also most object file formats
557 use the standardized (ie ELF) names, some (eg XCOFF) have customized names
558 due to restrictions.
559 The table for the standard names is defined in dwarf2read.c. Please
560 update all instances of dwarf2_debug_sections if you add a field to this
561 structure. It is always safe to use { NULL, NULL } in this case. */
562
563 struct dwarf2_debug_sections {
564 struct dwarf2_section_names info;
565 struct dwarf2_section_names abbrev;
566 struct dwarf2_section_names line;
567 struct dwarf2_section_names loc;
568 struct dwarf2_section_names loclists;
569 struct dwarf2_section_names macinfo;
570 struct dwarf2_section_names macro;
571 struct dwarf2_section_names str;
572 struct dwarf2_section_names line_str;
573 struct dwarf2_section_names ranges;
574 struct dwarf2_section_names rnglists;
575 struct dwarf2_section_names types;
576 struct dwarf2_section_names addr;
577 struct dwarf2_section_names frame;
578 struct dwarf2_section_names eh_frame;
579 struct dwarf2_section_names gdb_index;
580 struct dwarf2_section_names debug_names;
581 struct dwarf2_section_names debug_aranges;
582 /* This field has no meaning, but exists solely to catch changes to
583 this structure which are not reflected in some instance. */
584 int sentinel;
585 };
586
587 extern int dwarf2_has_info (struct objfile *,
588 const struct dwarf2_debug_sections *,
589 bool = false);
590
591 /* Dwarf2 sections that can be accessed by dwarf2_get_section_info. */
592 enum dwarf2_section_enum {
593 DWARF2_DEBUG_FRAME,
594 DWARF2_EH_FRAME
595 };
596
597 extern void dwarf2_get_section_info (struct objfile *,
598 enum dwarf2_section_enum,
599 asection **, const gdb_byte **,
600 bfd_size_type *);
601
602 /* A DWARF names index variant. */
603 enum class dw_index_kind
604 {
605 /* GDB's own .gdb_index format. */
606 GDB_INDEX,
607
608 /* DWARF5 .debug_names. */
609 DEBUG_NAMES,
610 };
611
612 /* Initialize for reading DWARF for OBJFILE. Return false if this
613 file will use psymtabs, or true if using an index, in which case
614 *INDEX_KIND is set to the index variant in use. */
615 extern bool dwarf2_initialize_objfile (struct objfile *objfile,
616 dw_index_kind *index_kind);
617
618 extern void dwarf2_build_psymtabs (struct objfile *);
619 extern void dwarf2_build_frame_info (struct objfile *);
620
621 void dwarf2_free_objfile (struct objfile *);
622
623 /* From minidebug.c. */
624
625 extern gdb_bfd_ref_ptr find_separate_debug_file_in_section (struct objfile *);
626
627 /* True if we are printing debug output about separate debug info files. */
628
629 extern bool separate_debug_file_debug;
630
631 #endif /* !defined(SYMFILE_H) */
This page took 0.040369 seconds and 3 git commands to generate.