gdb/cp-abi.c

   1 /* Generic code for supporting multiple C++ ABI's
   2
   3    Copyright (C) 2001, 2002, 2003, 2005, 2006, 2007, 2008, 2009, 2010, 2011
   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,
  74                   const bfd_byte *valaddr,
  75                   CORE_ADDR address)
  76 {
  77   if (current_cp_abi.baseclass_offset == NULL)
  78     error (_("ABI doesn't define required function baseclass_offset"));
  79   return (*current_cp_abi.baseclass_offset) (type, index,
  80                                              valaddr, address);
  81 }
  82
  83 struct value *
  84 value_virtual_fn_field (struct value **arg1p,
  85                         struct fn_field *f, int j,
  86                         struct type *type, int offset)
  87 {
  88   if ((current_cp_abi.virtual_fn_field) == NULL)
  89     return NULL;
  90   return (*current_cp_abi.virtual_fn_field) (arg1p, f, j,
  91                                              type, offset);
  92 }
  93
  94 struct type *
  95 value_rtti_type (struct value *v, int *full,
  96                  int *top, int *using_enc)
  97 {
  98   struct type *ret = NULL;
  99   struct gdb_exception e;
 100
 101   if ((current_cp_abi.rtti_type) == NULL)
 102     return NULL;
 103   TRY_CATCH (e, RETURN_MASK_ERROR)
 104     {
 105       ret = (*current_cp_abi.rtti_type) (v, full, top, using_enc);
 106     }
 107   if (e.reason < 0)
 108     return NULL;
 109   return ret;
 110 }
 111
 112 void
 113 cplus_print_method_ptr (const gdb_byte *contents,
 114                         struct type *type,
 115                         struct ui_file *stream)
 116 {
 117   if (current_cp_abi.print_method_ptr == NULL)
 118     error (_("GDB does not support pointers to methods on this target"));
 119   (*current_cp_abi.print_method_ptr) (contents, type, stream);
 120 }
 121
 122 int
 123 cplus_method_ptr_size (struct type *to_type)
 124 {
 125   if (current_cp_abi.method_ptr_size == NULL)
 126     error (_("GDB does not support pointers to methods on this target"));
 127   return (*current_cp_abi.method_ptr_size) (to_type);
 128 }
 129
 130 void
 131 cplus_make_method_ptr (struct type *type, gdb_byte *contents,
 132                        CORE_ADDR value, int is_virtual)
 133 {
 134   if (current_cp_abi.make_method_ptr == NULL)
 135     error (_("GDB does not support pointers to methods on this target"));
 136   (*current_cp_abi.make_method_ptr) (type, contents, value, is_virtual);
 137 }
 138
 139 CORE_ADDR
 140 cplus_skip_trampoline (struct frame_info *frame,
 141                        CORE_ADDR stop_pc)
 142 {
 143   if (current_cp_abi.skip_trampoline == NULL)
 144     return 0;
 145   return (*current_cp_abi.skip_trampoline) (frame, stop_pc);
 146 }
 147
 148 struct value *
 149 cplus_method_ptr_to_value (struct value **this_p,
 150                            struct value *method_ptr)
 151 {
 152   if (current_cp_abi.method_ptr_to_value == NULL)
 153     error (_("GDB does not support pointers to methods on this target"));
 154   return (*current_cp_abi.method_ptr_to_value) (this_p, method_ptr);
 155 }
 156
 157 int
 158 cp_pass_by_reference (struct type *type)
 159 {
 160   if ((current_cp_abi.pass_by_reference) == NULL)
 161     return 0;
 162   return (*current_cp_abi.pass_by_reference) (type);
 163 }
 164
 165 /* Set the current C++ ABI to SHORT_NAME.  */
 166
 167 static int
 168 switch_to_cp_abi (const char *short_name)
 169 {
 170   struct cp_abi_ops *abi;
 171
 172   abi = find_cp_abi (short_name);
 173   if (abi == NULL)
 174     return 0;
 175
 176   current_cp_abi = *abi;
 177   return 1;
 178 }
 179
 180 /* Add ABI to the list of supported C++ ABI's.  */
 181
 182 int
 183 register_cp_abi (struct cp_abi_ops *abi)
 184 {
 185   if (num_cp_abis == CP_ABI_MAX)
 186     internal_error (__FILE__, __LINE__,
 187                     _("Too many C++ ABIs, please increase CP_ABI_MAX in cp-abi.c"));
 188
 189   cp_abis[num_cp_abis++] = abi;
 190
 191   return 1;
 192 }
 193
 194 /* Set the ABI to use in "auto" mode to SHORT_NAME.  */
 195
 196 void
 197 set_cp_abi_as_auto_default (const char *short_name)
 198 {
 199   char *new_longname, *new_doc;
 200   struct cp_abi_ops *abi = find_cp_abi (short_name);
 201
 202   if (abi == NULL)
 203     internal_error (__FILE__, __LINE__,
 204                     _("Cannot find C++ ABI \"%s\" to set it as auto default."),
 205                     short_name);
 206
 207   if (auto_cp_abi.longname != NULL)
 208     xfree ((char *) auto_cp_abi.longname);
 209   if (auto_cp_abi.doc != NULL)
 210     xfree ((char *) auto_cp_abi.doc);
 211
 212   auto_cp_abi = *abi;
 213
 214   auto_cp_abi.shortname = "auto";
 215   new_longname = xstrprintf ("currently \"%s\"", abi->shortname);
 216   auto_cp_abi.longname = new_longname;
 217
 218   new_doc = xstrprintf ("Automatically selected; currently \"%s\"",
 219              abi->shortname);
 220   auto_cp_abi.doc = new_doc;
 221
 222   /* Since we copy the current ABI into current_cp_abi instead of
 223      using a pointer, if auto is currently the default, we need to
 224      reset it.  */
 225   if (strcmp (current_cp_abi.shortname, "auto") == 0)
 226     switch_to_cp_abi ("auto");
 227 }
 228
 229 /* Return the ABI operations associated with SHORT_NAME.  */
 230
 231 static struct cp_abi_ops *
 232 find_cp_abi (const char *short_name)
 233 {
 234   int i;
 235
 236   for (i = 0; i < num_cp_abis; i++)
 237     if (strcmp (cp_abis[i]->shortname, short_name) == 0)
 238       return cp_abis[i];
 239
 240   return NULL;
 241 }
 242
 243 /* Display the list of registered C++ ABIs.  */
 244
 245 static void
 246 list_cp_abis (int from_tty)
 247 {
 248   struct cleanup *cleanup_chain;
 249   int i;
 250
 251   ui_out_text (uiout, "The available C++ ABIs are:\n");
 252   cleanup_chain = make_cleanup_ui_out_tuple_begin_end (uiout,
 253                                                        "cp-abi-list");
 254   for (i = 0; i < num_cp_abis; i++)
 255     {
 256       char pad[14];
 257       int padcount;
 258
 259       ui_out_text (uiout, "  ");
 260       ui_out_field_string (uiout, "cp-abi", cp_abis[i]->shortname);
 261
 262       padcount = 16 - 2 - strlen (cp_abis[i]->shortname);
 263       pad[padcount] = 0;
 264       while (padcount > 0)
 265         pad[--padcount] = ' ';
 266       ui_out_text (uiout, pad);
 267
 268       ui_out_field_string (uiout, "doc", cp_abis[i]->doc);
 269       ui_out_text (uiout, "\n");
 270     }
 271   do_cleanups (cleanup_chain);
 272 }
 273
 274 /* Set the current C++ ABI, or display the list of options if no
 275    argument is given.  */
 276
 277 static void
 278 set_cp_abi_cmd (char *args, int from_tty)
 279 {
 280   if (args == NULL)
 281     {
 282       list_cp_abis (from_tty);
 283       return;
 284     }
 285
 286   if (!switch_to_cp_abi (args))
 287     error (_("Could not find \"%s\" in ABI list"), args);
 288 }
 289
 290 /* Show the currently selected C++ ABI.  */
 291
 292 static void
 293 show_cp_abi_cmd (char *args, int from_tty)
 294 {
 295   ui_out_text (uiout, "The currently selected C++ ABI is \"");
 296
 297   ui_out_field_string (uiout, "cp-abi", current_cp_abi.shortname);
 298   ui_out_text (uiout, "\" (");
 299   ui_out_field_string (uiout, "longname", current_cp_abi.longname);
 300   ui_out_text (uiout, ").\n");
 301 }
 302
 303 extern initialize_file_ftype _initialize_cp_abi; /* -Wmissing-prototypes */
 304
 305 void
 306 _initialize_cp_abi (void)
 307 {
 308   register_cp_abi (&auto_cp_abi);
 309   switch_to_cp_abi ("auto");
 310
 311   add_cmd ("cp-abi", class_obscure, set_cp_abi_cmd, _("\
 312 Set the ABI used for inspecting C++ objects.\n\
 313 \"set cp-abi\" with no arguments will list the available ABIs."),
 314            &setlist);
 315
 316   add_cmd ("cp-abi", class_obscure, show_cp_abi_cmd,
 317            _("Show the ABI used for inspecting C++ objects."),
 318            &showlist);
 319 }