1 /* "Quick" symbol functions
3 Copyright (C) 2021 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 #ifndef GDB_QUICK_SYMBOL_H
21 #define GDB_QUICK_SYMBOL_H
23 /* Like block_enum, but used as flags to pass to lookup functions. */
25 enum block_search_flag_values
27 SEARCH_GLOBAL_BLOCK
= 1,
28 SEARCH_STATIC_BLOCK
= 2
31 DEF_ENUM_FLAGS_TYPE (enum block_search_flag_values
, block_search_flags
);
33 /* Comparison function for symbol look ups. */
35 typedef int (symbol_compare_ftype
) (const char *string1
,
38 /* Callback for quick_symbol_functions->map_symbol_filenames. */
40 typedef void (symbol_filename_ftype
) (const char *filename
,
41 const char *fullname
);
43 /* Callback for quick_symbol_functions->expand_symtabs_matching
44 to match a file name. */
46 typedef bool (expand_symtabs_file_matcher_ftype
) (const char *filename
,
49 /* Callback for quick_symbol_functions->expand_symtabs_matching
50 to match a symbol name. */
52 typedef bool (expand_symtabs_symbol_matcher_ftype
) (const char *name
);
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
59 typedef bool (expand_symtabs_exp_notify_ftype
) (compunit_symtab
*symtab
);
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.
66 The quick symbol functions are generally opaque: the underlying
67 representation is hidden from the caller.
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.
76 The exact list of functions here was determined in an ad hoc way
77 based on gdb's history. */
79 struct quick_symbol_functions
81 virtual ~quick_symbol_functions ()
85 /* Return true if this objfile has any "partial" symbols
87 virtual bool has_symbols (struct objfile
*objfile
) = 0;
89 /* Return the symbol table for the "last" file appearing in
91 virtual struct symtab
*find_last_source_symtab (struct objfile
*objfile
) = 0;
93 /* Forget all cached full file names for OBJFILE. */
94 virtual void forget_cached_source_info (struct objfile
*objfile
) = 0;
96 /* Expand and iterate over each "partial" symbol table in OBJFILE
97 where the source file is named NAME.
99 If NAME is not absolute, a match after a '/' in the symbol table's
100 file name will also work, REAL_PATH is NULL then. If NAME is
101 absolute then REAL_PATH is non-NULL absolute file name as resolved
102 via gdb_realpath from NAME.
104 If a match is found, the "partial" symbol table is expanded.
105 Then, this calls iterate_over_some_symtabs (or equivalent) over
106 all newly-created symbol tables, passing CALLBACK to it.
107 The result of this call is returned. */
108 virtual bool map_symtabs_matching_filename
109 (struct objfile
*objfile
, const char *name
, const char *real_path
,
110 gdb::function_view
<bool (symtab
*)> callback
) = 0;
112 /* Check to see if the global symbol is defined in a "partial" symbol table
113 of OBJFILE. NAME is the name of the symbol to look for. DOMAIN
114 indicates what sort of symbol to search for.
116 If found, sets *symbol_found_p to true and returns the symbol language.
117 defined, or NULL if no such symbol table exists. */
118 virtual enum language lookup_global_symbol_language
119 (struct objfile
*objfile
,
122 bool *symbol_found_p
) = 0;
124 /* Print statistics about any indices loaded for OBJFILE. The
125 statistics should be printed to gdb_stdout. This is used for
126 "maint print statistics". Statistics are printed in two
127 sections. PRINT_BCACHE is false when printing the first section
128 of general statistics, and true when printing bcache statistics. */
129 virtual void print_stats (struct objfile
*objfile
, bool print_bcache
) = 0;
131 /* Dump any indices loaded for OBJFILE. The dump should go to
132 gdb_stdout. This is used for "maint print objfiles". */
133 virtual void dump (struct objfile
*objfile
) = 0;
135 /* Find all the symbols in OBJFILE named FUNC_NAME, and ensure that
136 the corresponding symbol tables are loaded. */
137 virtual void expand_symtabs_for_function (struct objfile
*objfile
,
138 const char *func_name
) = 0;
140 /* Read all symbol tables associated with OBJFILE. */
141 virtual void expand_all_symtabs (struct objfile
*objfile
) = 0;
143 /* Read all symbol tables associated with OBJFILE which have
144 symtab_to_fullname equal to FULLNAME.
145 This is for the purposes of examining code only, e.g., expand_line_sal.
146 The routine may ignore debug info that is known to not be useful with
147 code, e.g., DW_TAG_type_unit for dwarf debug info. */
148 virtual void expand_symtabs_with_fullname (struct objfile
*objfile
,
149 const char *fullname
) = 0;
151 /* Find global or static symbols in all tables that are in DOMAIN
152 and for which MATCH (symbol name, NAME) == 0, passing each to
153 CALLBACK, reading in partial symbol tables as needed. Look
154 through global symbols if GLOBAL and otherwise static symbols.
155 Passes NAME and NAMESPACE to CALLBACK with each symbol
156 found. After each block is processed, passes NULL to CALLBACK.
157 MATCH must be weaker than strcmp_iw_ordered in the sense that
158 strcmp_iw_ordered(x,y) == 0 --> MATCH(x,y) == 0. ORDERED_COMPARE,
159 if non-null, must be an ordering relation compatible with
160 strcmp_iw_ordered in the sense that
161 strcmp_iw_ordered(x,y) == 0 --> ORDERED_COMPARE(x,y) == 0
163 strcmp_iw_ordered(x,y) <= 0 --> ORDERED_COMPARE(x,y) <= 0
164 (allowing strcmp_iw_ordered(x,y) < 0 while ORDERED_COMPARE(x, y) == 0).
165 CALLBACK returns true to indicate that the scan should continue, or
166 false to indicate that the scan should be terminated. */
168 virtual void map_matching_symbols
170 const lookup_name_info
&lookup_name
,
173 gdb::function_view
<symbol_found_callback_ftype
> callback
,
174 symbol_compare_ftype
*ordered_compare
) = 0;
176 /* Expand all symbol tables in OBJFILE matching some criteria.
178 FILE_MATCHER is called for each file in OBJFILE. The file name
179 is passed to it. If the matcher returns false, the file is
180 skipped. If FILE_MATCHER is NULL the file is not skipped. If
181 BASENAMES is true the matcher should consider only file base
182 names (the passed file name is already only the lbasename'd
185 If the file is not skipped, and SYMBOL_MATCHER and LOOKUP_NAME are NULL,
186 the symbol table is expanded.
188 Otherwise, individual symbols are considered.
190 If DOMAIN or KIND do not match, the symbol is skipped.
191 If DOMAIN is UNDEF_DOMAIN, that is treated as a wildcard.
193 If the symbol name does not match LOOKUP_NAME, the symbol is skipped.
195 If SYMBOL_MATCHER returns false, then the symbol is skipped.
197 Otherwise, the symbol's symbol table is expanded and the
198 notification function is called. If the notification function
199 returns false, execution stops and this method returns false.
200 Otherwise, more files are considered. This method will return
201 true if all calls to the notification function return true. */
202 virtual bool expand_symtabs_matching
203 (struct objfile
*objfile
,
204 gdb::function_view
<expand_symtabs_file_matcher_ftype
> file_matcher
,
205 const lookup_name_info
*lookup_name
,
206 gdb::function_view
<expand_symtabs_symbol_matcher_ftype
> symbol_matcher
,
207 gdb::function_view
<expand_symtabs_exp_notify_ftype
> expansion_notify
,
208 block_search_flags search_flags
,
210 enum search_domain kind
) = 0;
212 /* Return the comp unit from OBJFILE that contains PC and
213 SECTION. Return NULL if there is no such compunit. This
214 should return the compunit that contains a symbol whose
215 address exactly matches PC, or, if there is no exact match, the
216 compunit that contains a symbol whose address is closest to
218 virtual struct compunit_symtab
*find_pc_sect_compunit_symtab
219 (struct objfile
*objfile
, struct bound_minimal_symbol msymbol
,
220 CORE_ADDR pc
, struct obj_section
*section
, int warn_if_readin
) = 0;
222 /* Return the comp unit from OBJFILE that contains a symbol at
223 ADDRESS. Return NULL if there is no such comp unit. Unlike
224 find_pc_sect_compunit_symtab, any sort of symbol (not just text
225 symbols) can be considered, and only exact address matches are
227 virtual struct compunit_symtab
*find_compunit_symtab_by_address
228 (struct objfile
*objfile
, CORE_ADDR address
) = 0;
230 /* Call a callback for every file defined in OBJFILE whose symtab is
231 not already read in. FUN is the callback. It is passed the
232 file's FILENAME and the file's FULLNAME (if need_fullname is
234 virtual void map_symbol_filenames
235 (struct objfile
*objfile
,
236 gdb::function_view
<symbol_filename_ftype
> fun
,
237 bool need_fullname
) = 0;
239 /* This is called when the objfile is relocated. It can be used to
240 clean up any internal caches. */
241 virtual void relocated ()
246 /* Return true if this class can lazily read the symbols. This may
247 only return true if there are in fact symbols to be read, because
248 this is used in the implementation of 'has_partial_symbols'. */
249 virtual bool can_lazily_read_symbols ()
254 /* Read the partial symbols for OBJFILE. This will only ever be
255 called if can_lazily_read_symbols returns true. */
256 virtual void read_partial_symbols (struct objfile
*objfile
)
261 typedef std::unique_ptr
<quick_symbol_functions
> quick_symbol_functions_up
;
263 #endif /* GDB_QUICK_SYMBOL_H */