gdb/cp-abi.c - gdb

Global variables defined

Functions defined

Macros defined

Source code

  1. /* Generic code for supporting multiple C++ ABI's

  3.    Copyright (C) 2001-2015 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/>.  */

  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);

  28. ‌static struct cp_abi_ops current_cp_abi = { "", NULL };
  29. ‌static struct cp_abi_ops auto_cp_abi = { "auto", NULL };

  31. ‌#define CP_ABI_MAX 8
  32. ‌static struct cp_abi_ops *cp_abis[CP_ABI_MAX];
  33. ‌static int num_cp_abis = 0;

  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. }

  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. }

  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. }

  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. }

  67. int
  68. ‌baseclass_offset (struct type *type, int index, const gdb_byte *valaddr,
  69.                   int embedded_offset, CORE_ADDR address,
  70.                   const struct value *val)
  71. {
  72.   volatile struct gdb_exception ex;
  73.   int res = 0;

  75.   gdb_assert (current_cp_abi.baseclass_offset != NULL);

  77.   TRY_CATCH (ex, RETURN_MASK_ERROR)
  78.     {
  79.       res = (*current_cp_abi.baseclass_offset) (type, index, valaddr,
  80.                                                 embedded_offset,
  81.                                                 address, val);
  82.     }

  84.   if (ex.reason < 0 && ex.error == NOT_AVAILABLE_ERROR)
  85.     throw_error (NOT_AVAILABLE_ERROR,
  86.                  _("Cannot determine virtual baseclass offset "
  87.                    "of incomplete object"));
  88.   else if (ex.reason < 0)
  89.     throw_exception (ex);
  90.   else
  91.     return res;
  92. }

  94. struct value *
  95. ‌value_virtual_fn_field (struct value **arg1p,
  96.                         struct fn_field *f, int j,
  97.                         struct type *type, int offset)
  98. {
  99.   if ((current_cp_abi.virtual_fn_field) == NULL)
  100.     return NULL;
  101.   return (*current_cp_abi.virtual_fn_field) (arg1p, f, j,
  102.                                              type, offset);
  103. }

  105. struct type *
  106. ‌value_rtti_type (struct value *v, int *full,
  107.                  int *top, int *using_enc)
  108. {
  109.   struct type *ret = NULL;
  110.   volatile struct gdb_exception e;

  112.   if ((current_cp_abi.rtti_type) == NULL)
  113.     return NULL;
  114.   TRY_CATCH (e, RETURN_MASK_ERROR)
  115.     {
  116.       ret = (*current_cp_abi.rtti_type) (v, full, top, using_enc);
  117.     }
  118.   if (e.reason < 0)
  119.     return NULL;
  120.   return ret;
  121. }

  123. void
  124. ‌cplus_print_method_ptr (const gdb_byte *contents,
  125.                         struct type *type,
  126.                         struct ui_file *stream)
  127. {
  128.   if (current_cp_abi.print_method_ptr == NULL)
  129.     error (_("GDB does not support pointers to methods on this target"));
  130.   (*current_cp_abi.print_method_ptr) (contents, type, stream);
  131. }

  133. int
  134. ‌cplus_method_ptr_size (struct type *to_type)
  135. {
  136.   if (current_cp_abi.method_ptr_size == NULL)
  137.     error (_("GDB does not support pointers to methods on this target"));
  138.   return (*current_cp_abi.method_ptr_size) (to_type);
  139. }

  141. void
  142. ‌cplus_make_method_ptr (struct type *type, gdb_byte *contents,
  143.                        CORE_ADDR value, int is_virtual)
  144. {
  145.   if (current_cp_abi.make_method_ptr == NULL)
  146.     error (_("GDB does not support pointers to methods on this target"));
  147.   (*current_cp_abi.make_method_ptr) (type, contents, value, is_virtual);
  148. }

  150. CORE_ADDR
  151. ‌cplus_skip_trampoline (struct frame_info *frame,
  152.                        CORE_ADDR stop_pc)
  153. {
  154.   if (current_cp_abi.skip_trampoline == NULL)
  155.     return 0;
  156.   return (*current_cp_abi.skip_trampoline) (frame, stop_pc);
  157. }

  159. struct value *
  160. ‌cplus_method_ptr_to_value (struct value **this_p,
  161.                            struct value *method_ptr)
  162. {
  163.   if (current_cp_abi.method_ptr_to_value == NULL)
  164.     error (_("GDB does not support pointers to methods on this target"));
  165.   return (*current_cp_abi.method_ptr_to_value) (this_p, method_ptr);
  166. }

  168. /* See cp-abi.h.  */

  170. void
  171. ‌cplus_print_vtable (struct value *value)
  172. {
  173.   if (current_cp_abi.print_vtable == NULL)
  174.     error (_("GDB cannot print the vtable on this target"));
  175.   (*current_cp_abi.print_vtable) (value);
  176. }

  178. /* See cp-abi.h.  */

  180. struct value *
  181. ‌cplus_typeid (struct value *value)
  182. {
  183.   if (current_cp_abi.get_typeid == NULL)
  184.     error (_("GDB cannot find the typeid on this target"));
  185.   return (*current_cp_abi.get_typeid) (value);
  186. }

  188. /* See cp-abi.h.  */

  190. struct type *
  191. ‌cplus_typeid_type (struct gdbarch *gdbarch)
  192. {
  193.   if (current_cp_abi.get_typeid_type == NULL)
  194.     error (_("GDB cannot find the type for 'typeid' on this target"));
  195.   return (*current_cp_abi.get_typeid_type) (gdbarch);
  196. }

  198. /* See cp-abi.h.  */

  200. struct type *
  201. ‌cplus_type_from_type_info (struct value *value)
  202. {
  203.   if (current_cp_abi.get_type_from_type_info == NULL)
  204.     error (_("GDB cannot find the type from a std::type_info on this target"));
  205.   return (*current_cp_abi.get_type_from_type_info) (value);
  206. }

  208. /* See cp-abi.h.  */

  210. char *
  211. ‌cplus_typename_from_type_info (struct value *value)
  212. {
  213.   if (current_cp_abi.get_typename_from_type_info == NULL)
  214.     error (_("GDB cannot find the type name "
  215.              "from a std::type_info on this target"));
  216.   return (*current_cp_abi.get_typename_from_type_info) (value);
  217. }

  219. int
  220. ‌cp_pass_by_reference (struct type *type)
  221. {
  222.   if ((current_cp_abi.pass_by_reference) == NULL)
  223.     return 0;
  224.   return (*current_cp_abi.pass_by_reference) (type);
  225. }

  227. /* Set the current C++ ABI to SHORT_NAME.  */

  229. static int
  230. ‌switch_to_cp_abi (const char *short_name)
  231. {
  232.   struct cp_abi_ops *abi;

  234.   abi = find_cp_abi (short_name);
  235.   if (abi == NULL)
  236.     return 0;

  238.   current_cp_abi = *abi;
  239.   return 1;
  240. }

  242. /* Add ABI to the list of supported C++ ABI's.  */

  244. int
  245. ‌register_cp_abi (struct cp_abi_ops *abi)
  246. {
  247.   if (num_cp_abis == CP_ABI_MAX)
  248.     internal_error (__FILE__, __LINE__,
  249.                     _("Too many C++ ABIs, please increase "
  250.                       "CP_ABI_MAX in cp-abi.c"));

  252.   cp_abis[num_cp_abis++] = abi;

  254.   return 1;
  255. }

  257. /* Set the ABI to use in "auto" mode to SHORT_NAME.  */

  259. void
  260. ‌set_cp_abi_as_auto_default (const char *short_name)
  261. {
  262.   char *new_longname, *new_doc;
  263.   struct cp_abi_ops *abi = find_cp_abi (short_name);

  265.   if (abi == NULL)
  266.     internal_error (__FILE__, __LINE__,
  267.                     _("Cannot find C++ ABI \"%s\" to set it as auto default."),
  268.                     short_name);

  270.   if (auto_cp_abi.longname != NULL)
  271.     xfree ((char *) auto_cp_abi.longname);
  272.   if (auto_cp_abi.doc != NULL)
  273.     xfree ((char *) auto_cp_abi.doc);

  275.   auto_cp_abi = *abi;

  277.   auto_cp_abi.shortname = "auto";
  278.   new_longname = xstrprintf ("currently \"%s\"", abi->shortname);
  279.   auto_cp_abi.longname = new_longname;

  281.   new_doc = xstrprintf ("Automatically selected; currently \"%s\"",
  282.              abi->shortname);
  283.   auto_cp_abi.doc = new_doc;

  285.   /* Since we copy the current ABI into current_cp_abi instead of
  286.      using a pointer, if auto is currently the default, we need to
  287.      reset it.  */
  288.   if (strcmp (current_cp_abi.shortname, "auto") == 0)
  289.     switch_to_cp_abi ("auto");
  290. }

  292. /* Return the ABI operations associated with SHORT_NAME.  */

  294. static struct cp_abi_ops *
  295. ‌find_cp_abi (const char *short_name)
  296. {
  297.   int i;

  299.   for (i = 0; i < num_cp_abis; i++)
  300.     if (strcmp (cp_abis[i]->shortname, short_name) == 0)
  301.       return cp_abis[i];

  303.   return NULL;
  304. }

  306. /* Display the list of registered C++ ABIs.  */

  308. static void
  309. ‌list_cp_abis (int from_tty)
  310. {
  311.   struct ui_out *uiout = current_uiout;
  312.   struct cleanup *cleanup_chain;
  313.   int i;

  315.   ui_out_text (uiout, "The available C++ ABIs are:\n");
  316.   cleanup_chain = make_cleanup_ui_out_tuple_begin_end (uiout,
  317.                                                        "cp-abi-list");
  318.   for (i = 0; i < num_cp_abis; i++)
  319.     {
  320.       char pad[14];
  321.       int padcount;

  323.       ui_out_text (uiout, "  ");
  324.       ui_out_field_string (uiout, "cp-abi", cp_abis[i]->shortname);

  326.       padcount = 16 - 2 - strlen (cp_abis[i]->shortname);
  327.       pad[padcount] = 0;
  328.       while (padcount > 0)
  329.         pad[--padcount] = ' ';
  330.       ui_out_text (uiout, pad);

  332.       ui_out_field_string (uiout, "doc", cp_abis[i]->doc);
  333.       ui_out_text (uiout, "\n");
  334.     }
  335.   do_cleanups (cleanup_chain);
  336. }

  338. /* Set the current C++ ABI, or display the list of options if no
  339.    argument is given.  */

  341. static void
  342. ‌set_cp_abi_cmd (char *args, int from_tty)
  343. {
  344.   if (args == NULL)
  345.     {
  346.       list_cp_abis (from_tty);
  347.       return;
  348.     }

  350.   if (!switch_to_cp_abi (args))
  351.     error (_("Could not find \"%s\" in ABI list"), args);
  352. }

  354. /* A completion function for "set cp-abi".  */

  356. ‌static VEC (char_ptr) *
  357. cp_abi_completer (struct cmd_list_element *ignore,
  358.                   const char *text, const char *word)
  359. {
  360.   static const char **cp_abi_names;

  362.   if (cp_abi_names == NULL)
  363.     {
  364.       int i;

  366.       cp_abi_names = XNEWVEC (const char *, num_cp_abis + 1);
  367.       for (i = 0; i < num_cp_abis; ++i)
  368.         cp_abi_names[i] = cp_abis[i]->shortname;
  369.       cp_abi_names[i] = NULL;
  370.     }

  372.   return complete_on_enum (cp_abi_names, text, word);
  373. }

  375. /* Show the currently selected C++ ABI.  */

  377. static void
  378. ‌show_cp_abi_cmd (char *args, int from_tty)
  379. {
  380.   struct ui_out *uiout = current_uiout;

  382.   ui_out_text (uiout, "The currently selected C++ ABI is \"");

  384.   ui_out_field_string (uiout, "cp-abi", current_cp_abi.shortname);
  385.   ui_out_text (uiout, "\" (");
  386.   ui_out_field_string (uiout, "longname", current_cp_abi.longname);
  387.   ui_out_text (uiout, ").\n");
  388. }

  390. extern initialize_file_ftype _initialize_cp_abi; /* -Wmissing-prototypes */

  392. void
  393. ‌_initialize_cp_abi (void)
  394. {
  395.   struct cmd_list_element *c;

  397.   register_cp_abi (&auto_cp_abi);
  398.   switch_to_cp_abi ("auto");

  400.   c = add_cmd ("cp-abi", class_obscure, set_cp_abi_cmd, _("\
  401. Set the ABI used for inspecting C++ objects.\n\
  402. \"set cp-abi\" with no arguments will list the available ABIs."),
  403.                &setlist);
  404.   set_cmd_completer (c, cp_abi_completer);

  406.   add_cmd ("cp-abi", class_obscure, show_cp_abi_cmd,
  407.            _("Show the ABI used for inspecting C++ objects."),
  408.            &showlist);
  409. }