gdb/quick-symbol.h

   1 /* "Quick" symbol functions
   2
   3    Copyright (C) 2021 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 #ifndef GDB_QUICK_SYMBOL_H
  21 #define GDB_QUICK_SYMBOL_H
  22
  23 /* Like block_enum, but used as flags to pass to lookup functions.  */
  24
  25 enum block_search_flag_values
  26 {
  27   SEARCH_GLOBAL_BLOCK = 1,
  28   SEARCH_STATIC_BLOCK = 2
  29 };
  30
  31 DEF_ENUM_FLAGS_TYPE (enum block_search_flag_values, block_search_flags);
  32
  33 /* Comparison function for symbol look ups.  */
  34
  35 typedef int (symbol_compare_ftype) (const char *string1,
  36                                     const char *string2);
  37
  38 /* Callback for quick_symbol_functions->map_symbol_filenames.  */
  39
  40 typedef void (symbol_filename_ftype) (const char *filename,
  41                                       const char *fullname);
  42
  43 /* Callback for quick_symbol_functions->expand_symtabs_matching
  44    to match a file name.  */
  45
  46 typedef bool (expand_symtabs_file_matcher_ftype) (const char *filename,
  47                                                   bool basenames);
  48
  49 /* Callback for quick_symbol_functions->expand_symtabs_matching
  50    to match a symbol name.  */
  51
  52 typedef bool (expand_symtabs_symbol_matcher_ftype) (const char *name);
  53
  54 /* Callback for quick_symbol_functions->expand_symtabs_matching
  55    to be called after a symtab has been expanded.  If this returns
  56    true, more symtabs are checked; if it returns false, iteration
  57    stops.  */
  58
  59 typedef bool (expand_symtabs_exp_notify_ftype) (compunit_symtab *symtab);
  60
  61 /* The "quick" symbol functions exist so that symbol readers can
  62    avoiding an initial read of all the symbols.  For example, symbol
  63    readers might choose to use the "partial symbol table" utilities,
  64    which is one implementation of the quick symbol functions.
  65
  66    The quick symbol functions are generally opaque: the underlying
  67    representation is hidden from the caller.
  68
  69    In general, these functions should only look at whatever special
  70    index the symbol reader creates -- looking through the symbol
  71    tables themselves is handled by generic code.  If a function is
  72    defined as returning a "symbol table", this means that the function
  73    should only return a newly-created symbol table; it should not
  74    examine pre-existing ones.
  75
  76    The exact list of functions here was determined in an ad hoc way
  77    based on gdb's history.  */
  78
  79 struct quick_symbol_functions
  80 {
  81   virtual ~quick_symbol_functions ()
  82   {
  83   }
  84
  85   /* Return true if this objfile has any "partial" symbols
  86      available.  */
  87   virtual bool has_symbols (struct objfile *objfile) = 0;
  88
  89   /* Return the symbol table for the "last" file appearing in
  90      OBJFILE.  */
  91   virtual struct symtab *find_last_source_symtab (struct objfile *objfile) = 0;
  92
  93   /* Forget all cached full file names for OBJFILE.  */
  94   virtual void forget_cached_source_info (struct objfile *objfile) = 0;
  95
  96   /* Check to see if the global symbol is defined in a "partial" symbol table
  97      of OBJFILE. NAME is the name of the symbol to look for.  DOMAIN
  98      indicates what sort of symbol to search for.
  99
 100      If found, sets *symbol_found_p to true and returns the symbol language.
 101      defined, or NULL if no such symbol table exists.  */
 102   virtual enum language lookup_global_symbol_language
 103        (struct objfile *objfile,
 104         const char *name,
 105         domain_enum domain,
 106         bool *symbol_found_p) = 0;
 107
 108   /* Print statistics about any indices loaded for OBJFILE.  The
 109      statistics should be printed to gdb_stdout.  This is used for
 110      "maint print statistics".  Statistics are printed in two
 111      sections.  PRINT_BCACHE is false when printing the first section
 112      of general statistics, and true when printing bcache statistics.  */
 113   virtual void print_stats (struct objfile *objfile, bool print_bcache) = 0;
 114
 115   /* Dump any indices loaded for OBJFILE.  The dump should go to
 116      gdb_stdout.  This is used for "maint print objfiles".  */
 117   virtual void dump (struct objfile *objfile) = 0;
 118
 119   /* Read all symbol tables associated with OBJFILE.  */
 120   virtual void expand_all_symtabs (struct objfile *objfile) = 0;
 121
 122   /* Read all symbol tables associated with OBJFILE which have
 123      symtab_to_fullname equal to FULLNAME.
 124      This is for the purposes of examining code only, e.g., expand_line_sal.
 125      The routine may ignore debug info that is known to not be useful with
 126      code, e.g., DW_TAG_type_unit for dwarf debug info.  */
 127   virtual void expand_symtabs_with_fullname (struct objfile *objfile,
 128                                              const char *fullname) = 0;
 129
 130   /* Find global or static symbols in all tables that are in DOMAIN
 131      and for which MATCH (symbol name, NAME) == 0, passing each to
 132      CALLBACK, reading in partial symbol tables as needed.  Look
 133      through global symbols if GLOBAL and otherwise static symbols.
 134      Passes NAME and NAMESPACE to CALLBACK with each symbol
 135      found.  After each block is processed, passes NULL to CALLBACK.
 136      MATCH must be weaker than strcmp_iw_ordered in the sense that
 137      strcmp_iw_ordered(x,y) == 0 --> MATCH(x,y) == 0.  ORDERED_COMPARE,
 138      if non-null, must be an ordering relation compatible with
 139      strcmp_iw_ordered in the sense that
 140             strcmp_iw_ordered(x,y) == 0 --> ORDERED_COMPARE(x,y) == 0
 141      and
 142             strcmp_iw_ordered(x,y) <= 0 --> ORDERED_COMPARE(x,y) <= 0
 143      (allowing strcmp_iw_ordered(x,y) < 0 while ORDERED_COMPARE(x, y) == 0).
 144      CALLBACK returns true to indicate that the scan should continue, or
 145      false to indicate that the scan should be terminated.  */
 146
 147   virtual void map_matching_symbols
 148     (struct objfile *,
 149      const lookup_name_info &lookup_name,
 150      domain_enum domain,
 151      int global,
 152      gdb::function_view<symbol_found_callback_ftype> callback,
 153      symbol_compare_ftype *ordered_compare) = 0;
 154
 155   /* Expand all symbol tables in OBJFILE matching some criteria.
 156
 157      FILE_MATCHER is called for each file in OBJFILE.  The file name
 158      is passed to it.  If the matcher returns false, the file is
 159      skipped.  If FILE_MATCHER is NULL the file is not skipped.  If
 160      BASENAMES is true the matcher should consider only file base
 161      names (the passed file name is already only the lbasename'd
 162      part).
 163
 164      If the file is not skipped, and SYMBOL_MATCHER and LOOKUP_NAME are NULL,
 165      the symbol table is expanded.
 166
 167      Otherwise, individual symbols are considered.
 168
 169      If DOMAIN or KIND do not match, the symbol is skipped.
 170      If DOMAIN is UNDEF_DOMAIN, that is treated as a wildcard.
 171
 172      If the symbol name does not match LOOKUP_NAME, the symbol is skipped.
 173
 174      If SYMBOL_MATCHER returns false, then the symbol is skipped.
 175
 176      Otherwise, the symbol's symbol table is expanded and the
 177      notification function is called.  If the notification function
 178      returns false, execution stops and this method returns false.
 179      Otherwise, more files are considered.  This method will return
 180      true if all calls to the notification function return true.  */
 181   virtual bool expand_symtabs_matching
 182     (struct objfile *objfile,
 183      gdb::function_view<expand_symtabs_file_matcher_ftype> file_matcher,
 184      const lookup_name_info *lookup_name,
 185      gdb::function_view<expand_symtabs_symbol_matcher_ftype> symbol_matcher,
 186      gdb::function_view<expand_symtabs_exp_notify_ftype> expansion_notify,
 187      block_search_flags search_flags,
 188      domain_enum domain,
 189      enum search_domain kind) = 0;
 190
 191   /* Return the comp unit from OBJFILE that contains PC and
 192      SECTION.  Return NULL if there is no such compunit.  This
 193      should return the compunit that contains a symbol whose
 194      address exactly matches PC, or, if there is no exact match, the
 195      compunit that contains a symbol whose address is closest to
 196      PC.  */
 197   virtual struct compunit_symtab *find_pc_sect_compunit_symtab
 198     (struct objfile *objfile, struct bound_minimal_symbol msymbol,
 199      CORE_ADDR pc, struct obj_section *section, int warn_if_readin) = 0;
 200
 201   /* Return the comp unit from OBJFILE that contains a symbol at
 202      ADDRESS.  Return NULL if there is no such comp unit.  Unlike
 203      find_pc_sect_compunit_symtab, any sort of symbol (not just text
 204      symbols) can be considered, and only exact address matches are
 205      considered.  */
 206   virtual struct compunit_symtab *find_compunit_symtab_by_address
 207     (struct objfile *objfile, CORE_ADDR address) = 0;
 208
 209   /* Call a callback for every file defined in OBJFILE whose symtab is
 210      not already read in.  FUN is the callback.  It is passed the
 211      file's FILENAME and the file's FULLNAME (if need_fullname is
 212      non-zero).  */
 213   virtual void map_symbol_filenames
 214        (struct objfile *objfile,
 215         gdb::function_view<symbol_filename_ftype> fun,
 216         bool need_fullname) = 0;
 217
 218   /* This is called when the objfile is relocated.  It can be used to
 219      clean up any internal caches.  */
 220   virtual void relocated ()
 221   {
 222     /* Do nothing.  */
 223   }
 224
 225   /* Return true if this class can lazily read the symbols.  This may
 226      only return true if there are in fact symbols to be read, because
 227      this is used in the implementation of 'has_partial_symbols'.  */
 228   virtual bool can_lazily_read_symbols ()
 229   {
 230     return false;
 231   }
 232
 233   /* Read the partial symbols for OBJFILE.  This will only ever be
 234      called if can_lazily_read_symbols returns true.  */
 235   virtual void read_partial_symbols (struct objfile *objfile)
 236   {
 237   }
 238 };
 239
 240 typedef std::unique_ptr<quick_symbol_functions> quick_symbol_functions_up;
 241
 242 #endif /* GDB_QUICK_SYMBOL_H */