1 /* Generic code for supporting multiple C++ ABI's
3 Copyright (C) 2001-2013 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/>. */
24 #include "exceptions.h"
27 #include "gdb_assert.h"
28 #include "gdb_string.h"
30 static struct cp_abi_ops *find_cp_abi (const char *short_name);
32 static struct cp_abi_ops current_cp_abi = { "", NULL };
33 static struct cp_abi_ops auto_cp_abi = { "auto", NULL };
36 static struct cp_abi_ops *cp_abis[CP_ABI_MAX];
37 static int num_cp_abis = 0;
40 is_constructor_name (const char *name)
42 if ((current_cp_abi.is_constructor_name) == NULL)
43 error (_("ABI doesn't define required function is_constructor_name"));
44 return (*current_cp_abi.is_constructor_name) (name);
48 is_destructor_name (const char *name)
50 if ((current_cp_abi.is_destructor_name) == NULL)
51 error (_("ABI doesn't define required function is_destructor_name"));
52 return (*current_cp_abi.is_destructor_name) (name);
56 is_vtable_name (const char *name)
58 if ((current_cp_abi.is_vtable_name) == NULL)
59 error (_("ABI doesn't define required function is_vtable_name"));
60 return (*current_cp_abi.is_vtable_name) (name);
64 is_operator_name (const char *name)
66 if ((current_cp_abi.is_operator_name) == NULL)
67 error (_("ABI doesn't define required function is_operator_name"));
68 return (*current_cp_abi.is_operator_name) (name);
72 baseclass_offset (struct type *type, int index, const gdb_byte *valaddr,
73 int embedded_offset, CORE_ADDR address,
74 const struct value *val)
76 volatile struct gdb_exception ex;
79 gdb_assert (current_cp_abi.baseclass_offset != NULL);
81 TRY_CATCH (ex, RETURN_MASK_ERROR)
83 res = (*current_cp_abi.baseclass_offset) (type, index, valaddr,
88 if (ex.reason < 0 && ex.error == NOT_AVAILABLE_ERROR)
89 throw_error (NOT_AVAILABLE_ERROR,
90 _("Cannot determine virtual baseclass offset "
91 "of incomplete object"));
92 else if (ex.reason < 0)
99 value_virtual_fn_field (struct value **arg1p,
100 struct fn_field *f, int j,
101 struct type *type, int offset)
103 if ((current_cp_abi.virtual_fn_field) == NULL)
105 return (*current_cp_abi.virtual_fn_field) (arg1p, f, j,
110 value_rtti_type (struct value *v, int *full,
111 int *top, int *using_enc)
113 struct type *ret = NULL;
114 volatile struct gdb_exception e;
116 if ((current_cp_abi.rtti_type) == NULL)
118 TRY_CATCH (e, RETURN_MASK_ERROR)
120 ret = (*current_cp_abi.rtti_type) (v, full, top, using_enc);
128 cplus_print_method_ptr (const gdb_byte *contents,
130 struct ui_file *stream)
132 if (current_cp_abi.print_method_ptr == NULL)
133 error (_("GDB does not support pointers to methods on this target"));
134 (*current_cp_abi.print_method_ptr) (contents, type, stream);
138 cplus_method_ptr_size (struct type *to_type)
140 if (current_cp_abi.method_ptr_size == NULL)
141 error (_("GDB does not support pointers to methods on this target"));
142 return (*current_cp_abi.method_ptr_size) (to_type);
146 cplus_make_method_ptr (struct type *type, gdb_byte *contents,
147 CORE_ADDR value, int is_virtual)
149 if (current_cp_abi.make_method_ptr == NULL)
150 error (_("GDB does not support pointers to methods on this target"));
151 (*current_cp_abi.make_method_ptr) (type, contents, value, is_virtual);
155 cplus_skip_trampoline (struct frame_info *frame,
158 if (current_cp_abi.skip_trampoline == NULL)
160 return (*current_cp_abi.skip_trampoline) (frame, stop_pc);
164 cplus_method_ptr_to_value (struct value **this_p,
165 struct value *method_ptr)
167 if (current_cp_abi.method_ptr_to_value == NULL)
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);
175 cplus_print_vtable (struct value *value)
177 if (current_cp_abi.print_vtable == NULL)
178 error (_("GDB cannot print the vtable on this target"));
179 (*current_cp_abi.print_vtable) (value);
183 cp_pass_by_reference (struct type *type)
185 if ((current_cp_abi.pass_by_reference) == NULL)
187 return (*current_cp_abi.pass_by_reference) (type);
190 /* Set the current C++ ABI to SHORT_NAME. */
193 switch_to_cp_abi (const char *short_name)
195 struct cp_abi_ops *abi;
197 abi = find_cp_abi (short_name);
201 current_cp_abi = *abi;
205 /* Add ABI to the list of supported C++ ABI's. */
208 register_cp_abi (struct cp_abi_ops *abi)
210 if (num_cp_abis == CP_ABI_MAX)
211 internal_error (__FILE__, __LINE__,
212 _("Too many C++ ABIs, please increase "
213 "CP_ABI_MAX in cp-abi.c"));
215 cp_abis[num_cp_abis++] = abi;
220 /* Set the ABI to use in "auto" mode to SHORT_NAME. */
223 set_cp_abi_as_auto_default (const char *short_name)
225 char *new_longname, *new_doc;
226 struct cp_abi_ops *abi = find_cp_abi (short_name);
229 internal_error (__FILE__, __LINE__,
230 _("Cannot find C++ ABI \"%s\" to set it as auto default."),
233 if (auto_cp_abi.longname != NULL)
234 xfree ((char *) auto_cp_abi.longname);
235 if (auto_cp_abi.doc != NULL)
236 xfree ((char *) auto_cp_abi.doc);
240 auto_cp_abi.shortname = "auto";
241 new_longname = xstrprintf ("currently \"%s\"", abi->shortname);
242 auto_cp_abi.longname = new_longname;
244 new_doc = xstrprintf ("Automatically selected; currently \"%s\"",
246 auto_cp_abi.doc = new_doc;
248 /* Since we copy the current ABI into current_cp_abi instead of
249 using a pointer, if auto is currently the default, we need to
251 if (strcmp (current_cp_abi.shortname, "auto") == 0)
252 switch_to_cp_abi ("auto");
255 /* Return the ABI operations associated with SHORT_NAME. */
257 static struct cp_abi_ops *
258 find_cp_abi (const char *short_name)
262 for (i = 0; i < num_cp_abis; i++)
263 if (strcmp (cp_abis[i]->shortname, short_name) == 0)
269 /* Display the list of registered C++ ABIs. */
272 list_cp_abis (int from_tty)
274 struct ui_out *uiout = current_uiout;
275 struct cleanup *cleanup_chain;
278 ui_out_text (uiout, "The available C++ ABIs are:\n");
279 cleanup_chain = make_cleanup_ui_out_tuple_begin_end (uiout,
281 for (i = 0; i < num_cp_abis; i++)
286 ui_out_text (uiout, " ");
287 ui_out_field_string (uiout, "cp-abi", cp_abis[i]->shortname);
289 padcount = 16 - 2 - strlen (cp_abis[i]->shortname);
292 pad[--padcount] = ' ';
293 ui_out_text (uiout, pad);
295 ui_out_field_string (uiout, "doc", cp_abis[i]->doc);
296 ui_out_text (uiout, "\n");
298 do_cleanups (cleanup_chain);
301 /* Set the current C++ ABI, or display the list of options if no
302 argument is given. */
305 set_cp_abi_cmd (char *args, int from_tty)
309 list_cp_abis (from_tty);
313 if (!switch_to_cp_abi (args))
314 error (_("Could not find \"%s\" in ABI list"), args);
317 /* A completion function for "set cp-abi". */
319 static VEC (char_ptr) *
320 cp_abi_completer (struct cmd_list_element *ignore,
321 char *text, char *word)
323 static const char **cp_abi_names;
325 if (cp_abi_names == NULL)
329 cp_abi_names = XNEWVEC (const char *, num_cp_abis + 1);
330 for (i = 0; i < num_cp_abis; ++i)
331 cp_abi_names[i] = cp_abis[i]->shortname;
335 return complete_on_enum (cp_abi_names, text, word);
338 /* Show the currently selected C++ ABI. */
341 show_cp_abi_cmd (char *args, int from_tty)
343 struct ui_out *uiout = current_uiout;
345 ui_out_text (uiout, "The currently selected C++ ABI is \"");
347 ui_out_field_string (uiout, "cp-abi", current_cp_abi.shortname);
348 ui_out_text (uiout, "\" (");
349 ui_out_field_string (uiout, "longname", current_cp_abi.longname);
350 ui_out_text (uiout, ").\n");
353 extern initialize_file_ftype _initialize_cp_abi; /* -Wmissing-prototypes */
356 _initialize_cp_abi (void)
358 struct cmd_list_element *c;
360 register_cp_abi (&auto_cp_abi);
361 switch_to_cp_abi ("auto");
363 c = add_cmd ("cp-abi", class_obscure, set_cp_abi_cmd, _("\
364 Set the ABI used for inspecting C++ objects.\n\
365 \"set cp-abi\" with no arguments will list the available ABIs."),
367 set_cmd_completer (c, cp_abi_completer);
369 add_cmd ("cp-abi", class_obscure, show_cp_abi_cmd,
370 _("Show the ABI used for inspecting C++ objects."),