gdb/cp-abi.c

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