GDB (xrefs)
Loading...
Searching...
No Matches
cp-abi.c
Go to the documentation of this file.
1/* Generic code for supporting multiple C++ ABI's
2
3 Copyright (C) 2001-2023 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"
26static struct cp_abi_ops *find_cp_abi (const char *short_name);
27
28static struct cp_abi_ops current_cp_abi = { "", NULL };
29static struct cp_abi_ops auto_cp_abi = { "auto", NULL };
30
31#define CP_ABI_MAX 8
33static int num_cp_abis = 0;
34
35enum ctor_kinds
37{
39 error (_("ABI doesn't define required function is_constructor_name"));
41}
42
43enum dtor_kinds
45{
47 error (_("ABI doesn't define required function is_destructor_name"));
49}
50
51int
52is_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"));
57}
58
59int
61{
62 if ((current_cp_abi.is_operator_name) == NULL)
63 error (_("ABI doesn't define required function is_operator_name"));
65}
66
67int
68baseclass_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 (const gdb_exception_error &ex)
83 {
84 if (ex.error != NOT_AVAILABLE_ERROR)
85 throw;
86
87 throw_error (NOT_AVAILABLE_ERROR,
88 _("Cannot determine virtual baseclass offset "
89 "of incomplete object"));
90 }
91
92 return res;
93}
94
95struct value *
97 struct fn_field *f, int j,
98 struct type *type, int offset)
99{
100 if ((current_cp_abi.virtual_fn_field) == NULL)
101 return NULL;
102 return (*current_cp_abi.virtual_fn_field) (arg1p, f, j,
103 type, offset);
104}
105
106struct type *
107value_rtti_type (struct value *v, int *full,
108 LONGEST *top, int *using_enc)
109{
110 struct type *ret = NULL;
111
112 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 (const gdb_exception_error &e)
120 {
121 return NULL;
122 }
123
124 return ret;
125}
126
127void
128cplus_print_method_ptr (const gdb_byte *contents,
129 struct type *type,
130 struct ui_file *stream)
131{
133 error (_("GDB does not support pointers to methods on this target"));
134 (*current_cp_abi.print_method_ptr) (contents, type, stream);
135}
136
137int
139{
141 error (_("GDB does not support pointers to methods on this target"));
142 return (*current_cp_abi.method_ptr_size) (to_type);
143}
144
145void
146cplus_make_method_ptr (struct type *type, gdb_byte *contents,
147 CORE_ADDR value, int is_virtual)
148{
150 error (_("GDB does not support pointers to methods on this target"));
151 (*current_cp_abi.make_method_ptr) (type, contents, value, is_virtual);
152}
153
154CORE_ADDR
156 CORE_ADDR stop_pc)
157{
159 return 0;
160 return (*current_cp_abi.skip_trampoline) (frame, stop_pc);
161}
162
163struct value *
165 struct value *method_ptr)
166{
168 error (_("GDB does not support pointers to methods on this target"));
169 return (*current_cp_abi.method_ptr_to_value) (this_p, method_ptr);
170}
171
172/* See cp-abi.h. */
173
174void
176{
177 if (current_cp_abi.print_vtable == NULL)
178 error (_("GDB cannot print the vtable on this target"));
180}
181
182/* See cp-abi.h. */
183
184struct value *
186{
187 if (current_cp_abi.get_typeid == NULL)
188 error (_("GDB cannot find the typeid on this target"));
189 return (*current_cp_abi.get_typeid) (value);
190}
191
192/* See cp-abi.h. */
193
194struct type *
196{
198 error (_("GDB cannot find the type for 'typeid' on this target"));
200}
201
202/* See cp-abi.h. */
203
204struct type *
206{
208 error (_("GDB cannot find the type from a std::type_info on this target"));
210}
211
212/* See cp-abi.h. */
213
214std::string
216{
218 error (_("GDB cannot find the type name "
219 "from a std::type_info on this target"));
221}
222
223/* See cp-abi.h. */
224
227{
228 if ((current_cp_abi.pass_by_reference) == NULL)
229 return {};
231}
232
233/* Set the current C++ ABI to SHORT_NAME. */
234
235static int
236switch_to_cp_abi (const char *short_name)
237{
238 struct cp_abi_ops *abi;
239
240 abi = find_cp_abi (short_name);
241 if (abi == NULL)
242 return 0;
243
244 current_cp_abi = *abi;
245 return 1;
246}
247
248/* Add ABI to the list of supported C++ ABI's. */
249
250int
252{
253 if (num_cp_abis == CP_ABI_MAX)
254 internal_error (_("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
264void
265set_cp_abi_as_auto_default (const char *short_name)
266{
267 struct cp_abi_ops *abi = find_cp_abi (short_name);
268
269 if (abi == NULL)
270 internal_error (_("Cannot find C++ ABI \"%s\" to set it as auto default."),
271 short_name);
272
273 xfree ((char *) auto_cp_abi.longname);
274 xfree ((char *) auto_cp_abi.doc);
275
276 auto_cp_abi = *abi;
277
278 auto_cp_abi.shortname = "auto";
279 auto_cp_abi.longname = xstrprintf ("currently \"%s\"",
280 abi->shortname).release ();
281 auto_cp_abi.doc = xstrprintf ("Automatically selected; currently \"%s\"",
282 abi->shortname).release ();
283
284 /* Since we copy the current ABI into current_cp_abi instead of
285 using a pointer, if auto is currently the default, we need to
286 reset it. */
287 if (strcmp (current_cp_abi.shortname, "auto") == 0)
288 switch_to_cp_abi ("auto");
289}
290
291/* Return the ABI operations associated with SHORT_NAME. */
292
293static struct cp_abi_ops *
294find_cp_abi (const char *short_name)
295{
296 int i;
297
298 for (i = 0; i < num_cp_abis; i++)
299 if (strcmp (cp_abis[i]->shortname, short_name) == 0)
300 return cp_abis[i];
301
302 return NULL;
303}
304
305/* Display the list of registered C++ ABIs. */
306
307static void
308list_cp_abis (int from_tty)
309{
310 struct ui_out *uiout = current_uiout;
311 int i;
312
313 uiout->text ("The available C++ ABIs are:\n");
314 ui_out_emit_tuple tuple_emitter (uiout, "cp-abi-list");
315 for (i = 0; i < num_cp_abis; i++)
316 {
317 char pad[14];
318 int padcount;
319
320 uiout->text (" ");
321 uiout->field_string ("cp-abi", cp_abis[i]->shortname);
322
323 padcount = 16 - 2 - strlen (cp_abis[i]->shortname);
324 pad[padcount] = 0;
325 while (padcount > 0)
326 pad[--padcount] = ' ';
327 uiout->text (pad);
328
329 uiout->field_string ("doc", cp_abis[i]->doc);
330 uiout->text ("\n");
331 }
332}
333
334/* Set the current C++ ABI, or display the list of options if no
335 argument is given. */
336
337static void
338set_cp_abi_cmd (const char *args, int from_tty)
339{
340 if (args == NULL)
341 {
342 list_cp_abis (from_tty);
343 return;
344 }
345
346 if (!switch_to_cp_abi (args))
347 error (_("Could not find \"%s\" in ABI list"), args);
348}
349
350/* A completion function for "set cp-abi". */
351
352static void
354 completion_tracker &tracker,
355 const char *text, const char *word)
356{
357 static const char **cp_abi_names;
358
359 if (cp_abi_names == NULL)
360 {
361 int i;
362
363 cp_abi_names = XNEWVEC (const char *, num_cp_abis + 1);
364 for (i = 0; i < num_cp_abis; ++i)
365 cp_abi_names[i] = cp_abis[i]->shortname;
366 cp_abi_names[i] = NULL;
367 }
368
369 complete_on_enum (tracker, cp_abi_names, text, word);
370}
371
372/* Show the currently selected C++ ABI. */
373
374static void
375show_cp_abi_cmd (const char *args, int from_tty)
376{
377 struct ui_out *uiout = current_uiout;
378
379 uiout->text ("The currently selected C++ ABI is \"");
380
381 uiout->field_string ("cp-abi", current_cp_abi.shortname);
382 uiout->text ("\" (");
383 uiout->field_string ("longname", current_cp_abi.longname);
384 uiout->text (").\n");
385}
386
387void _initialize_cp_abi ();
388void
390{
391 struct cmd_list_element *c;
392
394 switch_to_cp_abi ("auto");
395
396 c = add_cmd ("cp-abi", class_obscure, set_cp_abi_cmd, _("\
397Set the ABI used for inspecting C++ objects.\n\
398\"set cp-abi\" with no arguments will list the available ABIs."),
399 &setlist);
401
403 _("Show the ABI used for inspecting C++ objects."),
404 &showlist);
405}
const char *const name
void xfree(void *)
void f()
Definition 1.cc:36
void field_string(const char *fldname, const char *string, const ui_file_style &style=ui_file_style())
Definition ui-out.c:511
void text(const char *string)
Definition ui-out.c:566
struct cmd_list_element * showlist
Definition cli-cmds.c:125
struct cmd_list_element * setlist
Definition cli-cmds.c:117
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:233
void set_cmd_completer(struct cmd_list_element *cmd, completer_ftype *completer)
Definition cli-decode.c:117
void complete_on_enum(completion_tracker &tracker, const char *const *enumlist, const char *text, const char *word)
@ class_obscure
Definition command.h:64
static struct cp_abi_ops auto_cp_abi
Definition cp-abi.c:29
std::string cplus_typename_from_type_info(struct value *value)
Definition cp-abi.c:215
static void cp_abi_completer(struct cmd_list_element *ignore, completion_tracker &tracker, const char *text, const char *word)
Definition cp-abi.c:353
int is_operator_name(const char *name)
Definition cp-abi.c:60
struct value * value_virtual_fn_field(struct value **arg1p, struct fn_field *f, int j, struct type *type, int offset)
Definition cp-abi.c:96
void cplus_print_vtable(struct value *value)
Definition cp-abi.c:175
void _initialize_cp_abi()
Definition cp-abi.c:389
struct value * cplus_method_ptr_to_value(struct value **this_p, struct value *method_ptr)
Definition cp-abi.c:164
#define CP_ABI_MAX
Definition cp-abi.c:31
static void set_cp_abi_cmd(const char *args, int from_tty)
Definition cp-abi.c:338
static void show_cp_abi_cmd(const char *args, int from_tty)
Definition cp-abi.c:375
int register_cp_abi(struct cp_abi_ops *abi)
Definition cp-abi.c:251
struct type * cplus_typeid_type(struct gdbarch *gdbarch)
Definition cp-abi.c:195
int cplus_method_ptr_size(struct type *to_type)
Definition cp-abi.c:138
struct language_pass_by_ref_info cp_pass_by_reference(struct type *type)
Definition cp-abi.c:226
enum dtor_kinds is_destructor_name(const char *name)
Definition cp-abi.c:44
static struct cp_abi_ops current_cp_abi
Definition cp-abi.c:28
void cplus_print_method_ptr(const gdb_byte *contents, struct type *type, struct ui_file *stream)
Definition cp-abi.c:128
static int switch_to_cp_abi(const char *short_name)
Definition cp-abi.c:236
enum ctor_kinds is_constructor_name(const char *name)
Definition cp-abi.c:36
void cplus_make_method_ptr(struct type *type, gdb_byte *contents, CORE_ADDR value, int is_virtual)
Definition cp-abi.c:146
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
void set_cp_abi_as_auto_default(const char *short_name)
Definition cp-abi.c:265
struct type * value_rtti_type(struct value *v, int *full, LONGEST *top, int *using_enc)
Definition cp-abi.c:107
struct type * cplus_type_from_type_info(struct value *value)
Definition cp-abi.c:205
static void list_cp_abis(int from_tty)
Definition cp-abi.c:308
static int num_cp_abis
Definition cp-abi.c:33
int is_vtable_name(const char *name)
Definition cp-abi.c:52
CORE_ADDR cplus_skip_trampoline(frame_info_ptr frame, CORE_ADDR stop_pc)
Definition cp-abi.c:155
static struct cp_abi_ops * find_cp_abi(const char *short_name)
Definition cp-abi.c:294
struct value * cplus_typeid(struct value *value)
Definition cp-abi.c:185
static struct cp_abi_ops * cp_abis[CP_ABI_MAX]
Definition cp-abi.c:32
dtor_kinds
Definition cp-abi.h:61
ctor_kinds
Definition cp-abi.h:40
struct type * check_typedef(struct type *type)
Definition gdbtypes.c:3010
#define HAVE_CPLUS_STRUCT(type)
Definition gdbtypes.h:1987
const char * shortname
Definition cp-abi.h:218
int(* method_ptr_size)(struct type *)
Definition cp-abi.h:240
CORE_ADDR(* skip_trampoline)(frame_info_ptr, CORE_ADDR)
Definition cp-abi.h:250
struct type *(* get_typeid_type)(struct gdbarch *gdbarch)
Definition cp-abi.h:247
struct type *(* get_type_from_type_info)(struct value *value)
Definition cp-abi.h:248
void(* make_method_ptr)(struct type *, gdb_byte *, CORE_ADDR, int)
Definition cp-abi.h:241
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:234
struct value *(* method_ptr_to_value)(struct value **, struct value *)
Definition cp-abi.h:243
int(* is_vtable_name)(const char *name)
Definition cp-abi.h:226
enum ctor_kinds(* is_constructor_name)(const char *name)
Definition cp-abi.h:224
struct value *(* virtual_fn_field)(struct value **arg1p, struct fn_field *f, int j, struct type *type, int offset)
Definition cp-abi.h:228
enum dtor_kinds(* is_destructor_name)(const char *name)
Definition cp-abi.h:225
void(* print_vtable)(struct value *)
Definition cp-abi.h:245
int(* is_operator_name)(const char *name)
Definition cp-abi.h:227
const char * longname
Definition cp-abi.h:219
const char * doc
Definition cp-abi.h:220
struct language_pass_by_ref_info(* pass_by_reference)(struct type *type)
Definition cp-abi.h:251
std::string(* get_typename_from_type_info)(struct value *value)
Definition cp-abi.h:249
struct value *(* get_typeid)(struct value *value)
Definition cp-abi.h:246
void(* print_method_ptr)(const gdb_byte *contents, struct type *type, struct ui_file *stream)
Definition cp-abi.h:237
struct type *(* rtti_type)(struct value *v, int *full, LONGEST *top, int *using_enc)
Definition cp-abi.h:232
Definition value.c:181
struct type * type
Definition value.c:304
LONGEST offset
Definition value.c:281
#define current_uiout
Definition ui-out.h:40
struct type * value_type(const struct value *value)
Definition value.c:1109