gdb/cp-abi.c

   1 /* Generic code for supporting multiple C++ ABI's
   2
   3    Copyright (C) 2001, 2002, 2003, 2005, 2006, 2007, 2008
   4    Free Software Foundation, Inc.
   5
   6    This file is part of GDB.
   7
   8    This program is free software; you can redistribute it and/or modify
   9    it under the terms of the GNU General Public License as published by
  10    the Free Software Foundation; either version 3 of the License, or
  11    (at your option) any later version.
  12
  13    This program is distributed in the hope that it will be useful,
  14    but WITHOUT ANY WARRANTY; without even the implied warranty of
  15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16    GNU General Public License for more details.
  17
  18    You should have received a copy of the GNU General Public License
  19    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  20
  21 #include "defs.h"
  22 #include "value.h"
  23 #include "cp-abi.h"
  24 #include "command.h"
  25 #include "exceptions.h"
  26 #include "gdbcmd.h"
  27 #include "ui-out.h"
  28
  29 #include "gdb_string.h"
  30
  31 static struct cp_abi_ops *find_cp_abi (const char *short_name);
  32
  33 static struct cp_abi_ops current_cp_abi = { "", NULL };
  34 static struct cp_abi_ops auto_cp_abi = { "auto", NULL };
  35
  36 #define CP_ABI_MAX 8
  37 static struct cp_abi_ops *cp_abis[CP_ABI_MAX];
  38 static int num_cp_abis = 0;
  39
  40 enum ctor_kinds
  41 is_constructor_name (const char *name)
  42 {
  43   if ((current_cp_abi.is_constructor_name) == NULL)
  44     error (_("ABI doesn't define required function is_constructor_name"));
  45   return (*current_cp_abi.is_constructor_name) (name);
  46 }
  47
  48 enum dtor_kinds
  49 is_destructor_name (const char *name)
  50 {
  51   if ((current_cp_abi.is_destructor_name) == NULL)
  52     error (_("ABI doesn't define required function is_destructor_name"));
  53   return (*current_cp_abi.is_destructor_name) (name);
  54 }
  55
  56 int
  57 is_vtable_name (const char *name)
  58 {
  59   if ((current_cp_abi.is_vtable_name) == NULL)
  60     error (_("ABI doesn't define required function is_vtable_name"));
  61   return (*current_cp_abi.is_vtable_name) (name);
  62 }
  63
  64 int
  65 is_operator_name (const char *name)
  66 {
  67   if ((current_cp_abi.is_operator_name) == NULL)
  68     error (_("ABI doesn't define required function is_operator_name"));
  69   return (*current_cp_abi.is_operator_name) (name);
  70 }
  71
  72 int
  73 baseclass_offset (struct type *type, int index, const bfd_byte *valaddr,
  74                   CORE_ADDR address)
  75 {
  76   if (current_cp_abi.baseclass_offset == NULL)
  77     error (_("ABI doesn't define required function baseclass_offset"));
  78   return (*current_cp_abi.baseclass_offset) (type, index, valaddr, address);
  79 }
  80
  81 struct value *
  82 value_virtual_fn_field (struct value **arg1p, struct fn_field *f, int j,
  83                         struct type *type, int offset)
  84 {
  85   if ((current_cp_abi.virtual_fn_field) == NULL)
  86     return NULL;
  87   return (*current_cp_abi.virtual_fn_field) (arg1p, f, j, type, offset);
  88 }
  89
  90 struct type *
  91 value_rtti_type (struct value *v, int *full, int *top, int *using_enc)
  92 {
  93   struct type *ret = NULL;
  94   struct gdb_exception e;
  95   if ((current_cp_abi.rtti_type) == NULL)
  96     return NULL;
  97   TRY_CATCH (e, RETURN_MASK_ERROR)
  98     {
  99       ret = (*current_cp_abi.rtti_type) (v, full, top, using_enc);
 100     }
 101   if (e.reason < 0)
 102     return NULL;
 103   return ret;
 104 }
 105
 106 void
 107 cplus_print_method_ptr (const gdb_byte *contents, struct type *type,
 108                         struct ui_file *stream)
 109 {
 110   if (current_cp_abi.print_method_ptr == NULL)
 111     error (_("GDB does not support pointers to methods on this target"));
 112   (*current_cp_abi.print_method_ptr) (contents, type, stream);
 113 }
 114
 115 int
 116 cplus_method_ptr_size (void)
 117 {
 118   if (current_cp_abi.method_ptr_size == NULL)
 119     error (_("GDB does not support pointers to methods on this target"));
 120   return (*current_cp_abi.method_ptr_size) ();
 121 }
 122
 123 void
 124 cplus_make_method_ptr (gdb_byte *contents, CORE_ADDR value, int is_virtual)
 125 {
 126   if (current_cp_abi.make_method_ptr == NULL)
 127     error (_("GDB does not support pointers to methods on this target"));
 128   (*current_cp_abi.make_method_ptr) (contents, value, is_virtual);
 129 }
 130
 131 CORE_ADDR
 132 cplus_skip_trampoline (struct frame_info *frame, CORE_ADDR stop_pc)
 133 {
 134   if (current_cp_abi.skip_trampoline == NULL)
 135     return 0;
 136   return (*current_cp_abi.skip_trampoline) (frame, stop_pc);
 137 }
 138
 139 struct value *
 140 cplus_method_ptr_to_value (struct value **this_p, struct value *method_ptr)
 141 {
 142   if (current_cp_abi.method_ptr_to_value == NULL)
 143     error (_("GDB does not support pointers to methods on this target"));
 144   return (*current_cp_abi.method_ptr_to_value) (this_p, method_ptr);
 145 }
 146
 147 int
 148 cp_pass_by_reference (struct type *type)
 149 {
 150   if ((current_cp_abi.pass_by_reference) == NULL)
 151     return 0;
 152   return (*current_cp_abi.pass_by_reference) (type);
 153 }
 154
 155 /* Set the current C++ ABI to SHORT_NAME.  */
 156
 157 static int
 158 switch_to_cp_abi (const char *short_name)
 159 {
 160   struct cp_abi_ops *abi;
 161
 162   abi = find_cp_abi (short_name);
 163   if (abi == NULL)
 164     return 0;
 165
 166   current_cp_abi = *abi;
 167   return 1;
 168 }
 169
 170 /* Add ABI to the list of supported C++ ABI's.  */
 171
 172 int
 173 register_cp_abi (struct cp_abi_ops *abi)
 174 {
 175   if (num_cp_abis == CP_ABI_MAX)
 176     internal_error (__FILE__, __LINE__,
 177                     _("Too many C++ ABIs, please increase CP_ABI_MAX in cp-abi.c"));
 178
 179   cp_abis[num_cp_abis++] = abi;
 180
 181   return 1;
 182 }
 183
 184 /* Set the ABI to use in "auto" mode to SHORT_NAME.  */
 185
 186 void
 187 set_cp_abi_as_auto_default (const char *short_name)
 188 {
 189   char *new_longname, *new_doc;
 190   struct cp_abi_ops *abi = find_cp_abi (short_name);
 191
 192   if (abi == NULL)
 193     internal_error (__FILE__, __LINE__,
 194                     _("Cannot find C++ ABI \"%s\" to set it as auto default."),
 195                     short_name);
 196
 197   if (auto_cp_abi.longname != NULL)
 198     xfree ((char *) auto_cp_abi.longname);
 199   if (auto_cp_abi.doc != NULL)
 200     xfree ((char *) auto_cp_abi.doc);
 201
 202   auto_cp_abi = *abi;
 203
 204   auto_cp_abi.shortname = "auto";
 205   new_longname = xstrprintf ("currently \"%s\"", abi->shortname);
 206   auto_cp_abi.longname = new_longname;
 207
 208   new_doc = xstrprintf ("Automatically selected; currently \"%s\"",
 209              abi->shortname);
 210   auto_cp_abi.doc = new_doc;
 211
 212   /* Since we copy the current ABI into current_cp_abi instead of
 213      using a pointer, if auto is currently the default, we need to
 214      reset it.  */
 215   if (strcmp (current_cp_abi.shortname, "auto") == 0)
 216     switch_to_cp_abi ("auto");
 217 }
 218
 219 /* Return the ABI operations associated with SHORT_NAME.  */
 220
 221 static struct cp_abi_ops *
 222 find_cp_abi (const char *short_name)
 223 {
 224   int i;
 225
 226   for (i = 0; i < num_cp_abis; i++)
 227     if (strcmp (cp_abis[i]->shortname, short_name) == 0)
 228       return cp_abis[i];
 229
 230   return NULL;
 231 }
 232
 233 /* Display the list of registered C++ ABIs.  */
 234
 235 static void
 236 list_cp_abis (int from_tty)
 237 {
 238   struct cleanup *cleanup_chain;
 239   int i;
 240   ui_out_text (uiout, "The available C++ ABIs are:\n");
 241
 242   cleanup_chain = make_cleanup_ui_out_tuple_begin_end (uiout, "cp-abi-list");
 243   for (i = 0; i < num_cp_abis; i++)
 244     {
 245       char pad[14];
 246       int padcount;
 247
 248       ui_out_text (uiout, "  ");
 249       ui_out_field_string (uiout, "cp-abi", cp_abis[i]->shortname);
 250
 251       padcount = 16 - 2 - strlen (cp_abis[i]->shortname);
 252       pad[padcount] = 0;
 253       while (padcount > 0)
 254         pad[--padcount] = ' ';
 255       ui_out_text (uiout, pad);
 256
 257       ui_out_field_string (uiout, "doc", cp_abis[i]->doc);
 258       ui_out_text (uiout, "\n");
 259     }
 260   do_cleanups (cleanup_chain);
 261 }
 262
 263 /* Set the current C++ ABI, or display the list of options if no
 264    argument is given.  */
 265
 266 static void
 267 set_cp_abi_cmd (char *args, int from_tty)
 268 {
 269   if (args == NULL)
 270     {
 271       list_cp_abis (from_tty);
 272       return;
 273     }
 274
 275   if (!switch_to_cp_abi (args))
 276     error (_("Could not find \"%s\" in ABI list"), args);
 277 }
 278
 279 /* Show the currently selected C++ ABI.  */
 280
 281 static void
 282 show_cp_abi_cmd (char *args, int from_tty)
 283 {
 284   ui_out_text (uiout, "The currently selected C++ ABI is \"");
 285
 286   ui_out_field_string (uiout, "cp-abi", current_cp_abi.shortname);
 287   ui_out_text (uiout, "\" (");
 288   ui_out_field_string (uiout, "longname", current_cp_abi.longname);
 289   ui_out_text (uiout, ").\n");
 290 }
 291
 292 extern initialize_file_ftype _initialize_cp_abi; /* -Wmissing-prototypes */
 293
 294 void
 295 _initialize_cp_abi (void)
 296 {
 297   register_cp_abi (&auto_cp_abi);
 298   switch_to_cp_abi ("auto");
 299
 300   add_cmd ("cp-abi", class_obscure, set_cp_abi_cmd, _("\
 301 Set the ABI used for inspecting C++ objects.\n\
 302 \"set cp-abi\" with no arguments will list the available ABIs."),
 303            &setlist);
 304
 305   add_cmd ("cp-abi", class_obscure, show_cp_abi_cmd,
 306            _("Show the ABI used for inspecting C++ objects."), &showlist);
 307 }