GDB (xrefs)

/tmp/gdb-8.1/gdb/cp-abi.c
Go to the documentation of this file.
1 /* Generic code for supporting multiple C++ ABI's
2
3 Copyright (C) 2001-2018 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 #include "defs.h"
21 #include "value.h"
22 #include "cp-abi.h"
23 #include "command.h"
24 #include "gdbcmd.h"
25 #include "ui-out.h"
26 static struct cp_abi_ops *find_cp_abi (const char *short_name);
27
28 static struct cp_abi_ops current_cp_abi = { "", NULL };
29 static struct cp_abi_ops auto_cp_abi = { "auto", NULL };
30
31 #define CP_ABI_MAX 8
32 static struct cp_abi_ops *cp_abis[CP_ABI_MAX];
33 static int num_cp_abis = 0;
34
35 enum ctor_kinds
36 is_constructor_name (const char *name)
37 {
38 if ((current_cp_abi.is_constructor_name) == NULL)
39 error (_("ABI doesn't define required function is_constructor_name"));
40 return (*current_cp_abi.is_constructor_name) (name);
41 }
42
43 enum dtor_kinds
44 is_destructor_name (const char *name)
45 {
46 if ((current_cp_abi.is_destructor_name) == NULL)
47 error (_("ABI doesn't define required function is_destructor_name"));
48 return (*current_cp_abi.is_destructor_name) (name);
49 }
50
51 int
52 is_vtable_name (const char *name)
53 {
54 if ((current_cp_abi.is_vtable_name) == NULL)
55 error (_("ABI doesn't define required function is_vtable_name"));
56 return (*current_cp_abi.is_vtable_name) (name);
57 }
58
59 int
60 is_operator_name (const char *name)
61 {
62 if ((current_cp_abi.is_operator_name) == NULL)
63 error (_("ABI doesn't define required function is_operator_name"));
64 return (*current_cp_abi.is_operator_name) (name);
65 }
66
67 int
68 baseclass_offset (struct type *type, int index, const gdb_byte *valaddr,
69 LONGEST embedded_offset, CORE_ADDR address,
70 const struct value *val)
71 {
72 int res = 0;
73
74 gdb_assert (current_cp_abi.baseclass_offset != NULL);
75
76 TRY
77 {
78 res = (*current_cp_abi.baseclass_offset) (type, index, valaddr,
79 embedded_offset,
80 address, val);
81 }
82 CATCH (ex, RETURN_MASK_ERROR)
83 {
84 if (ex.error != NOT_AVAILABLE_ERROR)
85 throw_exception (ex);
86
87 throw_error (NOT_AVAILABLE_ERROR,
88 _("Cannot determine virtual baseclass offset "
89 "of incomplete object"));
90 }
91 END_CATCH
92
93 return res;
94 }
95
96 struct value *
97 value_virtual_fn_field (struct value **arg1p,
98 struct fn_field *f, int j,
99 struct type *type, int offset)
100 {
101 if ((current_cp_abi.virtual_fn_field) == NULL)
102 return NULL;
103 return (*current_cp_abi.virtual_fn_field) (arg1p, f, j,
104 type, offset);
105 }
106
107 struct type *
108 value_rtti_type (struct value *v, int *full,
109 LONGEST *top, int *using_enc)
110 {
111 struct type *ret = NULL;
112
113 if ((current_cp_abi.rtti_type) == NULL)
114 return NULL;
115 TRY
116 {
117 ret = (*current_cp_abi.rtti_type) (v, full, top, using_enc);
118 }
119 CATCH (e, RETURN_MASK_ERROR)
120 {
121 return NULL;
122 }
123 END_CATCH
124
125 return ret;
126 }
127
128 void
129 cplus_print_method_ptr (const gdb_byte *contents,
130 struct type *type,
131 struct ui_file *stream)
132 {
133 if (current_cp_abi.print_method_ptr == NULL)
134 error (_("GDB does not support pointers to methods on this target"));
135 (*current_cp_abi.print_method_ptr) (contents, type, stream);
136 }
137
138 int
139 cplus_method_ptr_size (struct type *to_type)
140 {
141 if (current_cp_abi.method_ptr_size == NULL)
142 error (_("GDB does not support pointers to methods on this target"));
143 return (*current_cp_abi.method_ptr_size) (to_type);
144 }
145
146 void
147 cplus_make_method_ptr (struct type *type, gdb_byte *contents,
148 CORE_ADDR value, int is_virtual)
149 {
150 if (current_cp_abi.make_method_ptr == NULL)
151 error (_("GDB does not support pointers to methods on this target"));
152 (*current_cp_abi.make_method_ptr) (type, contents, value, is_virtual);
153 }
154
155 CORE_ADDR
156 cplus_skip_trampoline (struct frame_info *frame,
157 CORE_ADDR stop_pc)
158 {
159 if (current_cp_abi.skip_trampoline == NULL)
160 return 0;
161 return (*current_cp_abi.skip_trampoline) (frame, stop_pc);
162 }
163
164 struct value *
165 cplus_method_ptr_to_value (struct value **this_p,
166 struct value *method_ptr)
167 {
168 if (current_cp_abi.method_ptr_to_value == NULL)
169 error (_("GDB does not support pointers to methods on this target"));
170 return (*current_cp_abi.method_ptr_to_value) (this_p, method_ptr);
171 }
172
173 /* See cp-abi.h. */
174
175 void
176 cplus_print_vtable (struct value *value)
177 {
178 if (current_cp_abi.print_vtable == NULL)
179 error (_("GDB cannot print the vtable on this target"));
180 (*current_cp_abi.print_vtable) (value);
181 }
182
183 /* See cp-abi.h. */
184
185 struct value *
186 cplus_typeid (struct value *value)
187 {
188 if (current_cp_abi.get_typeid == NULL)
189 error (_("GDB cannot find the typeid on this target"));
190 return (*current_cp_abi.get_typeid) (value);
191 }
192
193 /* See cp-abi.h. */
194
195 struct type *
196 cplus_typeid_type (struct gdbarch *gdbarch)
197 {
198 if (current_cp_abi.get_typeid_type == NULL)
199 error (_("GDB cannot find the type for 'typeid' on this target"));
200 return (*current_cp_abi.get_typeid_type) (gdbarch);
201 }
202
203 /* See cp-abi.h. */
204
205 struct type *
206 cplus_type_from_type_info (struct value *value)
207 {
208 if (current_cp_abi.get_type_from_type_info == NULL)
209 error (_("GDB cannot find the type from a std::type_info on this target"));
210 return (*current_cp_abi.get_type_from_type_info) (value);
211 }
212
213 /* See cp-abi.h. */
214
215 std::string
216 cplus_typename_from_type_info (struct value *value)
217 {
218 if (current_cp_abi.get_typename_from_type_info == NULL)
219 error (_("GDB cannot find the type name "
220 "from a std::type_info on this target"));
221 return (*current_cp_abi.get_typename_from_type_info) (value);
222 }
223
224 int
225 cp_pass_by_reference (struct type *type)
226 {
227 if ((current_cp_abi.pass_by_reference) == NULL)
228 return 0;
229 return (*current_cp_abi.pass_by_reference) (type);
230 }
231
232 /* Set the current C++ ABI to SHORT_NAME. */
233
234 static int
235 switch_to_cp_abi (const char *short_name)
236 {
237 struct cp_abi_ops *abi;
238
239 abi = find_cp_abi (short_name);
240 if (abi == NULL)
241 return 0;
242
243 current_cp_abi = *abi;
244 return 1;
245 }
246
247 /* Add ABI to the list of supported C++ ABI's. */
248
249 int
250 register_cp_abi (struct cp_abi_ops *abi)
251 {
252 if (num_cp_abis == CP_ABI_MAX)
253 internal_error (__FILE__, __LINE__,
254 _("Too many C++ ABIs, please increase "
255 "CP_ABI_MAX in cp-abi.c"));
256
257 cp_abis[num_cp_abis++] = abi;
258
259 return 1;
260 }
261
262 /* Set the ABI to use in "auto" mode to SHORT_NAME. */
263
264 void
265 set_cp_abi_as_auto_default (const char *short_name)
266 {
267 char *new_longname, *new_doc;
268 struct cp_abi_ops *abi = find_cp_abi (short_name);
269
270 if (abi == NULL)
271 internal_error (__FILE__, __LINE__,
272 _("Cannot find C++ ABI \"%s\" to set it as auto default."),
273 short_name);
274
275 if (auto_cp_abi.longname != NULL)
276 xfree ((char *) auto_cp_abi.longname);
277 if (auto_cp_abi.doc != NULL)
278 xfree ((char *) auto_cp_abi.doc);
279
280 auto_cp_abi = *abi;
281
282 auto_cp_abi.shortname = "auto";
283 new_longname = xstrprintf ("currently \"%s\"", abi->shortname);
284 auto_cp_abi.longname = new_longname;
285
286 new_doc = xstrprintf ("Automatically selected; currently \"%s\"",
287 abi->shortname);
288 auto_cp_abi.doc = new_doc;
289
290 /* Since we copy the current ABI into current_cp_abi instead of
291 using a pointer, if auto is currently the default, we need to
292 reset it. */
293 if (strcmp (current_cp_abi.shortname, "auto") == 0)
294 switch_to_cp_abi ("auto");
295 }
296
297 /* Return the ABI operations associated with SHORT_NAME. */
298
299 static struct cp_abi_ops *
300 find_cp_abi (const char *short_name)
301 {
302 int i;
303
304 for (i = 0; i < num_cp_abis; i++)
305 if (strcmp (cp_abis[i]->shortname, short_name) == 0)
306 return cp_abis[i];
307
308 return NULL;
309 }
310
311 /* Display the list of registered C++ ABIs. */
312
313 static void
314 list_cp_abis (int from_tty)
315 {
316 struct ui_out *uiout = current_uiout;
317 int i;
318
319 uiout->text ("The available C++ ABIs are:\n");
320 ui_out_emit_tuple tuple_emitter (uiout, "cp-abi-list");
321 for (i = 0; i < num_cp_abis; i++)
322 {
323 char pad[14];
324 int padcount;
325
326 uiout->text (" ");
327 uiout->field_string ("cp-abi", cp_abis[i]->shortname);
328
329 padcount = 16 - 2 - strlen (cp_abis[i]->shortname);
330 pad[padcount] = 0;
331 while (padcount > 0)
332 pad[--padcount] = ' ';
333 uiout->text (pad);
334
335 uiout->field_string ("doc", cp_abis[i]->doc);
336 uiout->text ("\n");
337 }
338 }
339
340 /* Set the current C++ ABI, or display the list of options if no
341 argument is given. */
342
343 static void
344 set_cp_abi_cmd (const char *args, int from_tty)
345 {
346 if (args == NULL)
347 {
348 list_cp_abis (from_tty);
349 return;
350 }
351
352 if (!switch_to_cp_abi (args))
353 error (_("Could not find \"%s\" in ABI list"), args);
354 }
355
356 /* A completion function for "set cp-abi". */
357
358 static void
359 cp_abi_completer (struct cmd_list_element *ignore,
360 completion_tracker &tracker,
361 const char *text, const char *word)
362 {
363 static const char **cp_abi_names;
364
365 if (cp_abi_names == NULL)
366 {
367 int i;
368
369 cp_abi_names = XNEWVEC (const char *, num_cp_abis + 1);
370 for (i = 0; i < num_cp_abis; ++i)
371 cp_abi_names[i] = cp_abis[i]->shortname;
372 cp_abi_names[i] = NULL;
373 }
374
375 complete_on_enum (tracker, cp_abi_names, text, word);
376 }
377
378 /* Show the currently selected C++ ABI. */
379
380 static void
381 show_cp_abi_cmd (const char *args, int from_tty)
382 {
383 struct ui_out *uiout = current_uiout;
384
385 uiout->text ("The currently selected C++ ABI is \"");
386
387 uiout->field_string ("cp-abi", current_cp_abi.shortname);
388 uiout->text ("\" (");
389 uiout->field_string ("longname", current_cp_abi.longname);
390 uiout->text (").\n");
391 }
392
393 void
394 _initialize_cp_abi (void)
395 {
396 struct cmd_list_element *c;
397
398 register_cp_abi (&auto_cp_abi);
399 switch_to_cp_abi ("auto");
400
401 c = add_cmd ("cp-abi", class_obscure, set_cp_abi_cmd, _("\
402 Set the ABI used for inspecting C++ objects.\n\
403 \"set cp-abi\" with no arguments will list the available ABIs."),
404 &setlist);
405 set_cmd_completer (c, cp_abi_completer);
406
407 add_cmd ("cp-abi", class_obscure, show_cp_abi_cmd,
408 _("Show the ABI used for inspecting C++ objects."),
409 &showlist);
410 }
gdbarch
Definition: gdbarch.c:127
value_virtual_fn_field
struct value * value_virtual_fn_field(struct value **arg1p, struct fn_field *f, int j, struct type *type, int offset)
Definition: cp-abi.c:97
string
const char * string
Definition: signals.c:50
value_rtti_type
struct type * value_rtti_type(struct value *v, int *full, LONGEST *top, int *using_enc)
Definition: cp-abi.c:108
current_cp_abi
static struct cp_abi_ops current_cp_abi
Definition: cp-abi.c:28
cp_abi_ops::doc
const char * doc
Definition: cp-abi.h:218
cp_abi_ops::is_vtable_name
int(* is_vtable_name)(const char *name)
Definition: cp-abi.h:224
ui_out::field_string
void field_string(const char *fldname, const char *string)
Definition: ui-out.c:544
CORE_ADDR
bfd_vma CORE_ADDR
Definition: common-types.h:41
ui_out_emit_type
Definition: ui-out.h:192
command.h
xfree
void xfree(void *)
cmd_list_element
Definition: cli-decode.h:46
cp_pass_by_reference
int cp_pass_by_reference(struct type *type)
Definition: cp-abi.c:225
switch_to_cp_abi
static int switch_to_cp_abi(const char *short_name)
Definition: cp-abi.c:235
RETURN_MASK_ERROR
Definition: common-exceptions.h:43
complete_on_enum
void complete_on_enum(completion_tracker &tracker, const char *const *enumlist, const char *text, const char *word)
Definition: cli-decode.c:1853
internal_error
void internal_error(const char *file, int line, const char *fmt,...)
Definition: errors.c:50
set_cp_abi_as_auto_default
void set_cp_abi_as_auto_default(const char *short_name)
Definition: cp-abi.c:265
add_cmd
struct cmd_list_element * add_cmd(const char *name, enum command_class theclass, const char *doc, struct cmd_list_element **list)
Definition: cli-decode.c:262
baseclass_offset
int baseclass_offset(struct type *type, int index, const gdb_byte *valaddr, LONGEST embedded_offset, CORE_ADDR address, const struct value *val)
Definition: cp-abi.c:68
cplus_type_from_type_info
struct type * cplus_type_from_type_info(struct value *value)
Definition: cp-abi.c:206
frame_info
Definition: frame.c:85
cplus_method_ptr_size
int cplus_method_ptr_size(struct type *to_type)
Definition: cp-abi.c:139
cp_abi_ops::method_ptr_size
int(* method_ptr_size)(struct type *)
Definition: cp-abi.h:238
cp_abi_ops::is_constructor_name
enum ctor_kinds(* is_constructor_name)(const char *name)
Definition: cp-abi.h:222
_
#define _(String)
Definition: gdb_locale.h:35
cp_abi_ops::print_vtable
void(* print_vtable)(struct value *)
Definition: cp-abi.h:243
ui_file
Definition: ui-file.h:26
defs.h
fn_field
Definition: gdbtypes.h:832
CP_ABI_MAX
#define CP_ABI_MAX
Definition: cp-abi.c:31
END_CATCH
#define END_CATCH
Definition: common-exceptions.h:259
ui_out::text
void text(const char *string)
Definition: ui-out.c:581
cp_abi_ops::is_destructor_name
enum dtor_kinds(* is_destructor_name)(const char *name)
Definition: cp-abi.h:223
NOT_AVAILABLE_ERROR
Definition: common-exceptions.h:82
TRY
#define TRY
Definition: common-exceptions.h:246
setlist
struct cmd_list_element * setlist
Definition: cli-cmds.c:111
name
const char *const name
Definition: aarch64-tdep.c:76
cp_abi_ops::method_ptr_to_value
struct value *(* method_ptr_to_value)(struct value **, struct value *)
Definition: cp-abi.h:241
dtor_kinds
dtor_kinds
Definition: cp-abi.h:61
cp_abi_ops
Definition: cp-abi.h:214
CATCH
#define CATCH(EXCEPTION, MASK)
Definition: common-exceptions.h:254
register_cp_abi
int register_cp_abi(struct cp_abi_ops *abi)
Definition: cp-abi.c:250
cplus_make_method_ptr
void cplus_make_method_ptr(struct type *type, gdb_byte *contents, CORE_ADDR value, int is_virtual)
Definition: cp-abi.c:147
is_constructor_name
enum ctor_kinds is_constructor_name(const char *name)
Definition: cp-abi.c:36
cp_abi_ops::get_type_from_type_info
struct type *(* get_type_from_type_info)(struct value *value)
Definition: cp-abi.h:246
cp_abi_ops::get_typeid
struct value *(* get_typeid)(struct value *value)
Definition: cp-abi.h:244
set_cmd_completer
void set_cmd_completer(struct cmd_list_element *cmd, completer_ftype *completer)
Definition: cli-decode.c:160
auto_cp_abi
static struct cp_abi_ops auto_cp_abi
Definition: cp-abi.c:29
show_cp_abi_cmd
static void show_cp_abi_cmd(const char *args, int from_tty)
Definition: cp-abi.c:381
showlist
struct cmd_list_element * showlist
Definition: cli-cmds.c:119
set_cp_abi_cmd
static void set_cp_abi_cmd(const char *args, int from_tty)
Definition: cp-abi.c:344
cplus_typeid_type
struct type * cplus_typeid_type(struct gdbarch *gdbarch)
Definition: cp-abi.c:196
current_uiout
#define current_uiout
Definition: ui-out.h:39
is_vtable_name
int is_vtable_name(const char *name)
Definition: cp-abi.c:52
type
Definition: gdbtypes.h:749
is_destructor_name
enum dtor_kinds is_destructor_name(const char *name)
Definition: cp-abi.c:44
cp_abi_ops::baseclass_offset
int(* baseclass_offset)(struct type *type, int index, const bfd_byte *valaddr, LONGEST embedded_offset, CORE_ADDR address, const struct value *val)
Definition: cp-abi.h:232
cp_abi_ops::longname
const char * longname
Definition: cp-abi.h:217
type
static const char * type
Definition: language.c:113
cp_abi_completer
static void cp_abi_completer(struct cmd_list_element *ignore, completion_tracker &tracker, const char *text, const char *word)
Definition: cp-abi.c:359
is_operator_name
int is_operator_name(const char *name)
Definition: cp-abi.c:60
xstrprintf
char * xstrprintf(const char *format,...)
Definition: common-utils.c:107
find_cp_abi
static struct cp_abi_ops * find_cp_abi(const char *short_name)
Definition: cp-abi.c:300
cp_abi_ops::print_method_ptr
void(* print_method_ptr)(const gdb_byte *contents, struct type *type, struct ui_file *stream)
Definition: cp-abi.h:235
cplus_typename_from_type_info
std::string cplus_typename_from_type_info(struct value *value)
Definition: cp-abi.c:216
gdb_assert
#define gdb_assert(expr)
Definition: gdb_assert.h:32
value
Definition: value.c:169
ui_out
Definition: ui-out.h:77
throw_exception
void throw_exception(struct gdb_exception exception)
Definition: common-exceptions.c:312
gdb_byte
bfd_byte gdb_byte
Definition: common-types.h:38
cp_abi_ops::is_operator_name
int(* is_operator_name)(const char *name)
Definition: cp-abi.h:225
XNEWVEC
#define XNEWVEC(T, N)
Definition: poison.h:145
num_cp_abis
static int num_cp_abis
Definition: cp-abi.c:33
cp_abi_ops::rtti_type
struct type *(* rtti_type)(struct value *v, int *full, LONGEST *top, int *using_enc)
Definition: cp-abi.h:230
cplus_print_method_ptr
void cplus_print_method_ptr(const gdb_byte *contents, struct type *type, struct ui_file *stream)
Definition: cp-abi.c:129
ctor_kinds
ctor_kinds
Definition: cp-abi.h:40
offset
int offset
Definition: agent.c:65
cp_abi_ops::get_typename_from_type_info
std::string(* get_typename_from_type_info)(struct value *value)
Definition: cp-abi.h:247
stop_pc
CORE_ADDR stop_pc
Definition: infcmd.c:98
cp_abi_ops::shortname
const char * shortname
Definition: cp-abi.h:216
cplus_method_ptr_to_value
struct value * cplus_method_ptr_to_value(struct value **this_p, struct value *method_ptr)
Definition: cp-abi.c:165
value.h
list_cp_abis
static void list_cp_abis(int from_tty)
Definition: cp-abi.c:314
cp_abi_ops::pass_by_reference
int(* pass_by_reference)(struct type *type)
Definition: cp-abi.h:249
ignore
static int ignore(struct target_ops *ops, struct gdbarch *gdbarch, struct bp_target_info *bp_tgt)
Definition: corelow.c:879
completion_tracker
Definition: completer.h:310
cp_abi_ops::make_method_ptr
void(* make_method_ptr)(struct type *, gdb_byte *, CORE_ADDR, int)
Definition: cp-abi.h:239
_initialize_cp_abi
void _initialize_cp_abi(void)
Definition: cp-abi.c:394
cplus_print_vtable
void cplus_print_vtable(struct value *value)
Definition: cp-abi.c:176
cp_abis
static struct cp_abi_ops * cp_abis[CP_ABI_MAX]
Definition: cp-abi.c:32
class_obscure
Definition: command.h:43
gdbcmd.h
error
void error(const char *fmt,...)
Definition: errors.c:38
throw_error
void throw_error(enum errors error, const char *fmt,...)
Definition: common-exceptions.c:389
LONGEST
long long LONGEST
Definition: common-types.h:52
cp-abi.h
cp_abi_ops::virtual_fn_field
struct value *(* virtual_fn_field)(struct value **arg1p, struct fn_field *f, int j, struct type *type, int offset)
Definition: cp-abi.h:226
cp_abi_ops::skip_trampoline
CORE_ADDR(* skip_trampoline)(struct frame_info *, CORE_ADDR)
Definition: cp-abi.h:248
cp_abi_ops::get_typeid_type
struct type *(* get_typeid_type)(struct gdbarch *gdbarch)
Definition: cp-abi.h:245
cplus_typeid
struct value * cplus_typeid(struct value *value)
Definition: cp-abi.c:186
ui-out.h
cplus_skip_trampoline
CORE_ADDR cplus_skip_trampoline(struct frame_info *frame, CORE_ADDR stop_pc)
Definition: cp-abi.c:156