gdb/cp-abi.c

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