gdb/cp-abi.c

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