gdb/testsuite: Allow cc-with-tweaks board file to be used with Fortran
[deliverable/binutils-gdb.git] / gdb / minsyms.h
CommitLineData
c35384fb
TT
1/* Minimal symbol table definitions for GDB.
2
42a4f53d 3 Copyright (C) 2011-2019 Free Software Foundation, Inc.
c35384fb
TT
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 MINSYMS_H
21#define MINSYMS_H
22
74ea4be4
PA
23struct type;
24
7cbd4a93
TT
25/* Several lookup functions return both a minimal symbol and the
26 objfile in which it is found. This structure is used in these
27 cases. */
28
29struct bound_minimal_symbol
30{
31 /* The minimal symbol that was found, or NULL if no minimal symbol
32 was found. */
33
34 struct minimal_symbol *minsym;
35
36 /* If MINSYM is not NULL, then this is the objfile in which the
37 symbol is defined. */
38
39 struct objfile *objfile;
40};
41
b19686e0
TT
42/* This header declares most of the API for dealing with minimal
43 symbols and minimal symbol tables. A few things are declared
44 elsewhere; see below.
c35384fb 45
b19686e0
TT
46 A minimal symbol is a symbol for which there is no direct debug
47 information. For example, for an ELF binary, minimal symbols are
48 created from the ELF symbol table.
49
50 For the definition of the minimal symbol structure, see struct
51 minimal_symbol in symtab.h.
52
53 Minimal symbols are stored in tables attached to an objfile; see
54 objfiles.h for details. Code should generally treat these tables
55 as opaque and use functions provided by minsyms.c to inspect them.
56*/
57
8dddcb8f
TT
58struct msym_bunch;
59
873a915e
TT
60/* An RAII-based object that is used to record minimal symbols while
61 they are being read. */
62class minimal_symbol_reader
63{
64 public:
65
8dddcb8f
TT
66 /* Prepare to start collecting minimal symbols. This should be
67 called by a symbol reader to initialize the minimal symbol
68 module. */
873a915e 69
d25e8719 70 explicit minimal_symbol_reader (struct objfile *);
873a915e
TT
71
72 ~minimal_symbol_reader ();
b19686e0 73
873a915e
TT
74 /* Install the minimal symbols that have been collected into the
75 given objfile. */
b19686e0 76
d25e8719 77 void install ();
b19686e0 78
8dddcb8f
TT
79 /* Record a new minimal symbol. This is the "full" entry point;
80 simpler convenience entry points are also provided below.
81
82 This returns a new minimal symbol. It is ok to modify the returned
83 minimal symbol (though generally not necessary). It is not ok,
84 though, to stash the pointer anywhere; as minimal symbols may be
85 moved after creation. The memory for the returned minimal symbol
86 is still owned by the minsyms.c code, and should not be freed.
87
88 Arguments are:
89
90 NAME - the symbol's name
91 NAME_LEN - the length of the name
92 COPY_NAME - if true, the minsym code must make a copy of NAME. If
93 false, then NAME must be NUL-terminated, and must have a lifetime
94 that is at least as long as OBJFILE's lifetime.
95 ADDRESS - the address of the symbol
96 MS_TYPE - the type of the symbol
97 SECTION - the symbol's section
ce6c454e 98 */
8dddcb8f
TT
99
100 struct minimal_symbol *record_full (const char *name,
101 int name_len,
ce6c454e 102 bool copy_name,
8dddcb8f
TT
103 CORE_ADDR address,
104 enum minimal_symbol_type ms_type,
105 int section);
106
107 /* Like record_full, but:
108 - uses strlen to compute NAME_LEN,
ce6c454e 109 - passes COPY_NAME = true,
8dddcb8f
TT
110 - and passes a default SECTION, depending on the type
111
112 This variant does not return the new symbol. */
113
ce6c454e
TT
114 void record (const char *name, CORE_ADDR address,
115 enum minimal_symbol_type ms_type);
8dddcb8f
TT
116
117 /* Like record_full, but:
118 - uses strlen to compute NAME_LEN,
3db066bc 119 - passes COPY_NAME = true.
8dddcb8f 120
3db066bc
TT
121 This variant does not return the new symbol. */
122
123 void record_with_info (const char *name, CORE_ADDR address,
124 enum minimal_symbol_type ms_type,
125 int section)
8dddcb8f 126 {
3db066bc 127 record_full (name, strlen (name), true, address, ms_type, section);
8dddcb8f
TT
128 }
129
873a915e
TT
130 private:
131
af9a2161 132 DISABLE_COPY_AND_ASSIGN (minimal_symbol_reader);
d25e8719
TT
133
134 struct objfile *m_objfile;
b19686e0 135
8dddcb8f
TT
136 /* Bunch currently being filled up.
137 The next field points to chain of filled bunches. */
138
139 struct msym_bunch *m_msym_bunch;
140
141 /* Number of slots filled in current bunch. */
142
143 int m_msym_bunch_index;
144
145 /* Total number of minimal symbols recorded so far for the
146 objfile. */
147
148 int m_msym_count;
149};
c35384fb 150
b19686e0
TT
151\f
152
4024cf2b
PA
153/* Return whether MSYMBOL is a function/method. If FUNC_ADDRESS_P is
154 non-NULL, and the MSYMBOL is a function, then *FUNC_ADDRESS_P is
155 set to the function's address, already resolved if MINSYM points to
156 a function descriptor. */
157
158bool msymbol_is_function (struct objfile *objfile,
159 minimal_symbol *minsym,
160 CORE_ADDR *func_address_p = NULL);
bf223d3e 161
c7ee338a
CB
162/* Compute a hash code for the string argument. Unlike htab_hash_string,
163 this is a case-insensitive hash to support "set case-sensitive off". */
c35384fb
TT
164
165unsigned int msymbol_hash (const char *);
166
b19686e0
TT
167/* Like msymbol_hash, but compute a hash code that is compatible with
168 strcmp_iw. */
169
170unsigned int msymbol_hash_iw (const char *);
171
c35384fb
TT
172/* Compute the next hash value from previous HASH and the character C. This
173 is only a GDB in-memory computed value with no external files compatibility
174 requirements. */
175
176#define SYMBOL_HASH_NEXT(hash, c) \
deeeba55 177 ((hash) * 67 + TOLOWER ((unsigned char) (c)) - 113)
c35384fb 178
b19686e0
TT
179\f
180
b19686e0
TT
181/* Look through all the current minimal symbol tables and find the
182 first minimal symbol that matches NAME. If OBJF is non-NULL, limit
3b7344d5
TT
183 the search to that objfile. If SFILE is non-NULL, the only
184 file-scope symbols considered will be from that source file (global
185 symbols are still preferred). Returns a bound minimal symbol that
186 matches, or an empty bound minimal symbol if no match is found. */
b19686e0 187
3b7344d5
TT
188struct bound_minimal_symbol lookup_minimal_symbol (const char *,
189 const char *,
190 struct objfile *);
c35384fb 191
3b7344d5
TT
192/* Like lookup_minimal_symbol, but searches all files and
193 objfiles. */
7c7b6655
TT
194
195struct bound_minimal_symbol lookup_bound_minimal_symbol (const char *);
196
b19686e0
TT
197/* Look through all the current minimal symbol tables and find the
198 first minimal symbol that matches NAME and has text type. If OBJF
3b7344d5
TT
199 is non-NULL, limit the search to that objfile. Returns a bound
200 minimal symbol that matches, or an "empty" bound minimal symbol
201 otherwise.
b19686e0
TT
202
203 This function only searches the mangled (linkage) names. */
204
3b7344d5
TT
205struct bound_minimal_symbol lookup_minimal_symbol_text (const char *,
206 struct objfile *);
c35384fb 207
4b610737
TT
208/* Look through the minimal symbols in OBJF (and its separate debug
209 objfiles) for a global (not file-local) minsym whose linkage name
210 is NAME. This is somewhat similar to lookup_minimal_symbol_text,
211 only data symbols (not text symbols) are considered, and a non-NULL
212 objfile is not accepted. Returns a bound minimal symbol that
213 matches, or an "empty" bound minimal symbol otherwise. */
214
215extern struct bound_minimal_symbol lookup_minimal_symbol_linkage
216 (const char *name, struct objfile *objf)
217 ATTRIBUTE_NONNULL (1) ATTRIBUTE_NONNULL (2);
218
b19686e0
TT
219/* Look through all the current minimal symbol tables and find the
220 first minimal symbol that matches NAME and PC. If OBJF is non-NULL,
221 limit the search to that objfile. Returns a pointer to the minimal
222 symbol that matches, or NULL if no match is found. */
223
c35384fb 224struct minimal_symbol *lookup_minimal_symbol_by_pc_name
b19686e0 225 (CORE_ADDR, const char *, struct objfile *);
c35384fb 226
20944a6e
PA
227enum class lookup_msym_prefer
228{
229 /* Prefer mst_text symbols. */
230 TEXT,
231
232 /* Prefer mst_solib_trampoline symbols when there are text and
233 trampoline symbols at the same address. Otherwise prefer
234 mst_text symbols. */
235 TRAMPOLINE,
236
237 /* Prefer mst_text_gnu_ifunc symbols when there are text and ifunc
238 symbols at the same address. Otherwise prefer mst_text
239 symbols. */
240 GNU_IFUNC,
241};
242
b19686e0
TT
243/* Search through the minimal symbol table for each objfile and find
244 the symbol whose address is the largest address that is still less
245 than or equal to PC, and which matches SECTION.
c35384fb 246
b19686e0
TT
247 If SECTION is NULL, this uses the result of find_pc_section
248 instead.
249
7cbd4a93 250 The result has a non-NULL 'minsym' member if such a symbol is
20944a6e
PA
251 found, or NULL if PC is not in a suitable range.
252
253 See definition of lookup_msym_prefer for description of PREFER. By
254 default mst_text symbols are preferred. */
c35384fb 255
7cbd4a93 256struct bound_minimal_symbol lookup_minimal_symbol_by_pc_section
20944a6e
PA
257 (CORE_ADDR,
258 struct obj_section *,
259 lookup_msym_prefer prefer = lookup_msym_prefer::TEXT);
c35384fb 260
b19686e0
TT
261/* Backward compatibility: search through the minimal symbol table
262 for a matching PC (no section given).
263
264 This is a wrapper that calls lookup_minimal_symbol_by_pc_section
265 with a NULL section argument. */
c35384fb 266
7cbd4a93 267struct bound_minimal_symbol lookup_minimal_symbol_by_pc (CORE_ADDR);
c35384fb 268
b19686e0
TT
269/* Iterate over all the minimal symbols in the objfile OBJF which
270 match NAME. Both the ordinary and demangled names of each symbol
271 are considered. The caller is responsible for canonicalizing NAME,
272 should that need to be done.
c35384fb 273
41c1efc6
TT
274 For each matching symbol, CALLBACK is called with the symbol. */
275
276void iterate_over_minimal_symbols
277 (struct objfile *objf, const lookup_name_info &name,
ca31ab1d 278 gdb::function_view<bool (struct minimal_symbol *)> callback);
c35384fb 279
50e65b17
TT
280/* Compute the upper bound of MINSYM. The upper bound is the last
281 address thought to be part of the symbol. If the symbol has a
282 size, it is used. Otherwise use the lesser of the next minimal
283 symbol in the same section, or the end of the section, as the end
284 of the function. */
285
286CORE_ADDR minimal_symbol_upper_bound (struct bound_minimal_symbol minsym);
287
74ea4be4
PA
288/* Return the type of MSYMBOL, a minimal symbol of OBJFILE. If
289 ADDRESS_P is not NULL, set it to the MSYMBOL's resolved
290 address. */
291
292type *find_minsym_type_and_address (minimal_symbol *msymbol, objfile *objf,
293 CORE_ADDR *address_p);
294
c35384fb 295#endif /* MINSYMS_H */
This page took 0.783529 seconds and 4 git commands to generate.