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 /* Comparison function for symbol look ups. */
25 typedef int (symbol_compare_ftype
) (const char *string1
,
28 /* Callback for quick_symbol_functions->map_symbol_filenames. */
30 typedef void (symbol_filename_ftype
) (const char *filename
,
31 const char *fullname
, void *data
);
33 /* Callback for quick_symbol_functions->expand_symtabs_matching
34 to match a file name. */
36 typedef bool (expand_symtabs_file_matcher_ftype
) (const char *filename
,
39 /* Callback for quick_symbol_functions->expand_symtabs_matching
40 to match a symbol name. */
42 typedef bool (expand_symtabs_symbol_matcher_ftype
) (const char *name
);
44 /* Callback for quick_symbol_functions->expand_symtabs_matching
45 to be called after a symtab has been expanded. */
47 typedef void (expand_symtabs_exp_notify_ftype
) (compunit_symtab
*symtab
);
49 /* The "quick" symbol functions exist so that symbol readers can
50 avoiding an initial read of all the symbols. For example, symbol
51 readers might choose to use the "partial symbol table" utilities,
52 which is one implementation of the quick symbol functions.
54 The quick symbol functions are generally opaque: the underlying
55 representation is hidden from the caller.
57 In general, these functions should only look at whatever special
58 index the symbol reader creates -- looking through the symbol
59 tables themselves is handled by generic code. If a function is
60 defined as returning a "symbol table", this means that the function
61 should only return a newly-created symbol table; it should not
62 examine pre-existing ones.
64 The exact list of functions here was determined in an ad hoc way
65 based on gdb's history. */
67 struct quick_symbol_functions
69 /* Return true if this objfile has any "partial" symbols
71 bool (*has_symbols
) (struct objfile
*objfile
);
73 /* Return the symbol table for the "last" file appearing in
75 struct symtab
*(*find_last_source_symtab
) (struct objfile
*objfile
);
77 /* Forget all cached full file names for OBJFILE. */
78 void (*forget_cached_source_info
) (struct objfile
*objfile
);
80 /* Expand and iterate over each "partial" symbol table in OBJFILE
81 where the source file is named NAME.
83 If NAME is not absolute, a match after a '/' in the symbol table's
84 file name will also work, REAL_PATH is NULL then. If NAME is
85 absolute then REAL_PATH is non-NULL absolute file name as resolved
86 via gdb_realpath from NAME.
88 If a match is found, the "partial" symbol table is expanded.
89 Then, this calls iterate_over_some_symtabs (or equivalent) over
90 all newly-created symbol tables, passing CALLBACK to it.
91 The result of this call is returned. */
92 bool (*map_symtabs_matching_filename
)
93 (struct objfile
*objfile
, const char *name
, const char *real_path
,
94 gdb::function_view
<bool (symtab
*)> callback
);
96 /* Check to see if the symbol is defined in a "partial" symbol table
97 of OBJFILE. BLOCK_INDEX should be either GLOBAL_BLOCK or STATIC_BLOCK,
98 depending on whether we want to search global symbols or static
99 symbols. NAME is the name of the symbol to look for. DOMAIN
100 indicates what sort of symbol to search for.
102 Returns the newly-expanded compunit in which the symbol is
103 defined, or NULL if no such symbol table exists. If OBJFILE
104 contains !TYPE_OPAQUE symbol prefer its compunit. If it contains
105 only TYPE_OPAQUE symbol(s), return at least that compunit. */
106 struct compunit_symtab
*(*lookup_symbol
) (struct objfile
*objfile
,
107 block_enum block_index
,
111 /* Check to see if the global symbol is defined in a "partial" symbol table
112 of OBJFILE. NAME is the name of the symbol to look for. DOMAIN
113 indicates what sort of symbol to search for.
115 If found, sets *symbol_found_p to true and returns the symbol language.
116 defined, or NULL if no such symbol table exists. */
117 enum language (*lookup_global_symbol_language
) (struct objfile
*objfile
,
120 bool *symbol_found_p
);
122 /* Print statistics about any indices loaded for OBJFILE. The
123 statistics should be printed to gdb_stdout. This is used for
124 "maint print statistics". */
125 void (*print_stats
) (struct objfile
*objfile
);
127 /* Dump any indices loaded for OBJFILE. The dump should go to
128 gdb_stdout. This is used for "maint print objfiles". */
129 void (*dump
) (struct objfile
*objfile
);
131 /* Find all the symbols in OBJFILE named FUNC_NAME, and ensure that
132 the corresponding symbol tables are loaded. */
133 void (*expand_symtabs_for_function
) (struct objfile
*objfile
,
134 const char *func_name
);
136 /* Read all symbol tables associated with OBJFILE. */
137 void (*expand_all_symtabs
) (struct objfile
*objfile
);
139 /* Read all symbol tables associated with OBJFILE which have
140 symtab_to_fullname equal to FULLNAME.
141 This is for the purposes of examining code only, e.g., expand_line_sal.
142 The routine may ignore debug info that is known to not be useful with
143 code, e.g., DW_TAG_type_unit for dwarf debug info. */
144 void (*expand_symtabs_with_fullname
) (struct objfile
*objfile
,
145 const char *fullname
);
147 /* Find global or static symbols in all tables that are in DOMAIN
148 and for which MATCH (symbol name, NAME) == 0, passing each to
149 CALLBACK, reading in partial symbol tables as needed. Look
150 through global symbols if GLOBAL and otherwise static symbols.
151 Passes NAME and NAMESPACE to CALLBACK with each symbol
152 found. After each block is processed, passes NULL to CALLBACK.
153 MATCH must be weaker than strcmp_iw_ordered in the sense that
154 strcmp_iw_ordered(x,y) == 0 --> MATCH(x,y) == 0. ORDERED_COMPARE,
155 if non-null, must be an ordering relation compatible with
156 strcmp_iw_ordered in the sense that
157 strcmp_iw_ordered(x,y) == 0 --> ORDERED_COMPARE(x,y) == 0
159 strcmp_iw_ordered(x,y) <= 0 --> ORDERED_COMPARE(x,y) <= 0
160 (allowing strcmp_iw_ordered(x,y) < 0 while ORDERED_COMPARE(x, y) == 0).
161 CALLBACK returns true to indicate that the scan should continue, or
162 false to indicate that the scan should be terminated. */
164 void (*map_matching_symbols
)
166 const lookup_name_info
&lookup_name
,
169 gdb::function_view
<symbol_found_callback_ftype
> callback
,
170 symbol_compare_ftype
*ordered_compare
);
172 /* Expand all symbol tables in OBJFILE matching some criteria.
174 FILE_MATCHER is called for each file in OBJFILE. The file name
175 is passed to it. If the matcher returns false, the file is
176 skipped. If FILE_MATCHER is NULL the file is not skipped. If
177 BASENAMES is true the matcher should consider only file base
178 names (the passed file name is already only the lbasename'd
181 If the file is not skipped, and SYMBOL_MATCHER and LOOKUP_NAME are NULL,
182 the symbol table is expanded.
184 Otherwise, individual symbols are considered.
186 If KIND does not match, the symbol is skipped.
188 If the symbol name does not match LOOKUP_NAME, the symbol is skipped.
190 If SYMBOL_MATCHER returns false, then the symbol is skipped.
192 Otherwise, the symbol's symbol table is expanded. */
193 void (*expand_symtabs_matching
)
194 (struct objfile
*objfile
,
195 gdb::function_view
<expand_symtabs_file_matcher_ftype
> file_matcher
,
196 const lookup_name_info
*lookup_name
,
197 gdb::function_view
<expand_symtabs_symbol_matcher_ftype
> symbol_matcher
,
198 gdb::function_view
<expand_symtabs_exp_notify_ftype
> expansion_notify
,
199 enum search_domain kind
);
201 /* Return the comp unit from OBJFILE that contains PC and
202 SECTION. Return NULL if there is no such compunit. This
203 should return the compunit that contains a symbol whose
204 address exactly matches PC, or, if there is no exact match, the
205 compunit that contains a symbol whose address is closest to
207 struct compunit_symtab
*(*find_pc_sect_compunit_symtab
)
208 (struct objfile
*objfile
, struct bound_minimal_symbol msymbol
,
209 CORE_ADDR pc
, struct obj_section
*section
, int warn_if_readin
);
211 /* Return the comp unit from OBJFILE that contains a symbol at
212 ADDRESS. Return NULL if there is no such comp unit. Unlike
213 find_pc_sect_compunit_symtab, any sort of symbol (not just text
214 symbols) can be considered, and only exact address matches are
215 considered. This pointer may be NULL. */
216 struct compunit_symtab
*(*find_compunit_symtab_by_address
)
217 (struct objfile
*objfile
, CORE_ADDR address
);
219 /* Call a callback for every file defined in OBJFILE whose symtab is
220 not already read in. FUN is the callback. It is passed the file's
221 FILENAME, the file's FULLNAME (if need_fullname is non-zero), and
222 the DATA passed to this function. */
223 void (*map_symbol_filenames
) (struct objfile
*objfile
,
224 symbol_filename_ftype
*fun
, void *data
,
228 #endif /* GDB_QUICK_SYMBOL_H */