1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
|
/* Minimal symbol table definitions for GDB.
Copyright (C) 2011 Free Software Foundation, Inc.
This file is part of GDB.
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>. */
#ifndef MINSYMS_H
#define MINSYMS_H
/* This header declares most of the API for dealing with minimal
symbols and minimal symbol tables. A few things are declared
elsewhere; see below.
A minimal symbol is a symbol for which there is no direct debug
information. For example, for an ELF binary, minimal symbols are
created from the ELF symbol table.
For the definition of the minimal symbol structure, see struct
minimal_symbol in symtab.h.
Minimal symbols are stored in tables attached to an objfile; see
objfiles.h for details. Code should generally treat these tables
as opaque and use functions provided by minsyms.c to inspect them.
*/
/* Prepare to start collecting minimal symbols. This should be called
by a symbol reader to initialize the minimal symbol module.
Currently, minimal symbol table creation is not reentrant; it
relies on global (static) variables in minsyms.c. */
void init_minimal_symbol_collection (void);
/* Return a cleanup which is used to clean up the global state left
over by minimal symbol creation. After calling
init_minimal_symbol_collection, a symbol reader should call this
function. Then, after all minimal symbols have been read,
regardless of whether they are installed or not, the cleanup
returned by this function should be run. */
struct cleanup *make_cleanup_discard_minimal_symbols (void);
/* Record a new minimal symbol. This is the "full" entry point;
simpler convenience entry points are also provided below.
This returns a new minimal symbol. It is ok to modify the returned
minimal symbol (though generally not necessary). It is not ok,
though, to stash the pointer anywhere; as minimal symbols may be
moved after creation. The memory for the returned minimal symbol
is still owned by the minsyms.c code, and should not be freed.
Arguments are:
NAME - the symbol's name
NAME_LEN - the length of the name
COPY_NAME - if true, the minsym code must make a copy of NAME. If
false, then NAME must be NUL-terminated, and must have a lifetime
that is at least as long as OBJFILE's lifetime.
ADDRESS - the address of the symbol
MS_TYPE - the type of the symbol
SECTION - the symbol's section
BFD_SECTION - the symbol's BFD section; used to find the
appropriate obj_section for the minimal symbol. This can be NULL.
OBJFILE - the objfile associated with the minimal symbol. */
struct minimal_symbol *prim_record_minimal_symbol_full
(const char *name,
int name_len,
int copy_name,
CORE_ADDR address,
enum minimal_symbol_type ms_type,
int section,
asection *bfd_section,
struct objfile *objfile);
/* Like prim_record_minimal_symbol_full, but:
- uses strlen to compute NAME_LEN,
- passes COPY_NAME = 0,
- passes SECTION = 0,
- and passes BFD_SECTION = NULL.
This variant does not return the new symbol. */
void prim_record_minimal_symbol (const char *, CORE_ADDR,
enum minimal_symbol_type,
struct objfile *);
/* Like prim_record_minimal_symbol_full, but:
- uses strlen to compute NAME_LEN,
- passes COPY_NAME = 0. */
struct minimal_symbol *prim_record_minimal_symbol_and_info
(const char *,
CORE_ADDR,
enum minimal_symbol_type,
int section,
asection *bfd_section,
struct objfile *);
/* Install the minimal symbols that have been collected into the given
objfile. After this is called, the cleanup returned by
make_cleanup_discard_minimal_symbols should be run in order to
clean up global state. */
void install_minimal_symbols (struct objfile *);
/* Create the terminating entry of OBJFILE's minimal symbol table.
If OBJFILE->msymbols is zero, allocate a single entry from
OBJFILE->objfile_obstack; otherwise, just initialize
OBJFILE->msymbols[OBJFILE->minimal_symbol_count]. */
void terminate_minimal_symbol_table (struct objfile *objfile);
/* Sort all the minimal symbols in OBJFILE. This should be only be
called after relocating symbols; it ensures that the minimal
symbols are properly sorted by address. */
void msymbols_sort (struct objfile *objfile);
/* Compute a hash code for the string argument. */
unsigned int msymbol_hash (const char *);
/* Like msymbol_hash, but compute a hash code that is compatible with
strcmp_iw. */
unsigned int msymbol_hash_iw (const char *);
/* Compute the next hash value from previous HASH and the character C. This
is only a GDB in-memory computed value with no external files compatibility
requirements. */
#define SYMBOL_HASH_NEXT(hash, c) \
((hash) * 67 + tolower ((unsigned char) (c)) - 113)
/* Return the objfile that holds the minimal symbol SYM. Every
minimal symbols is held by some objfile; this will never return
NULL. */
struct objfile *msymbol_objfile (struct minimal_symbol *sym);
/* Look through all the current minimal symbol tables and find the
first minimal symbol that matches NAME. If OBJF is non-NULL, limit
the search to that objfile. If SFILE is non-NULL, the only file-scope
symbols considered will be from that source file (global symbols are
still preferred). Returns a pointer to the minimal symbol that
matches, or NULL if no match is found. */
struct minimal_symbol *lookup_minimal_symbol (const char *,
const char *,
struct objfile *);
/* Find the minimal symbol named NAME, and return both the minsym
struct and its objfile. This only checks the linkage name. Sets
*OBJFILE_P and returns the minimal symbol, if it is found. If it
is not found, returns NULL. */
struct minimal_symbol *lookup_minimal_symbol_and_objfile (const char *,
struct objfile **);
/* Look through all the current minimal symbol tables and find the
first minimal symbol that matches NAME and has text type. If OBJF
is non-NULL, limit the search to that objfile. Returns a pointer
to the minimal symbol that matches, or NULL if no match is found.
This function only searches the mangled (linkage) names. */
struct minimal_symbol *lookup_minimal_symbol_text (const char *,
struct objfile *);
/* Look through all the current minimal symbol tables and find the
first minimal symbol that matches NAME and is a solib trampoline.
If OBJF is non-NULL, limit the search to that objfile. Returns a
pointer to the minimal symbol that matches, or NULL if no match is
found.
This function only searches the mangled (linkage) names. */
struct minimal_symbol *lookup_minimal_symbol_solib_trampoline
(const char *,
struct objfile *);
/* Look through all the current minimal symbol tables and find the
first minimal symbol that matches NAME and PC. If OBJF is non-NULL,
limit the search to that objfile. Returns a pointer to the minimal
symbol that matches, or NULL if no match is found. */
struct minimal_symbol *lookup_minimal_symbol_by_pc_name
(CORE_ADDR, const char *, struct objfile *);
/* Search through the minimal symbol table for each objfile and find
the symbol whose address is the largest address that is still less
than or equal to PC, and which matches SECTION.
If SECTION is NULL, this uses the result of find_pc_section
instead.
Returns a pointer to the minimal symbol if such a symbol is found,
or NULL if PC is not in a suitable range. */
struct minimal_symbol *lookup_minimal_symbol_by_pc_section
(CORE_ADDR,
struct obj_section *);
/* Backward compatibility: search through the minimal symbol table
for a matching PC (no section given).
This is a wrapper that calls lookup_minimal_symbol_by_pc_section
with a NULL section argument. */
struct minimal_symbol *lookup_minimal_symbol_by_pc (CORE_ADDR);
/* Check if PC is in a shared library trampoline code stub.
Return minimal symbol for the trampoline entry or NULL if PC is not
in a trampoline code stub. */
struct minimal_symbol *lookup_solib_trampoline_symbol_by_pc (CORE_ADDR);
/* Iterate over all the minimal symbols in the objfile OBJF which
match NAME. Both the ordinary and demangled names of each symbol
are considered. The caller is responsible for canonicalizing NAME,
should that need to be done.
For each matching symbol, CALLBACK is called with the symbol and
USER_DATA as arguments. */
void iterate_over_minimal_symbols (struct objfile *objf,
const char *name,
void (*callback) (struct minimal_symbol *,
void *),
void *user_data);
#endif /* MINSYMS_H */
|
