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