gdb/python/py-arch.c

   1 /* Python interface to architecture
   2
   3    Copyright (C) 2013-2022 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 "gdbarch.h"
  22 #include "arch-utils.h"
  23 #include "disasm.h"
  24 #include "python-internal.h"
  25
  26 struct arch_object {
  27   PyObject_HEAD
  28   struct gdbarch *gdbarch;
  29 };
  30
  31 static struct gdbarch_data *arch_object_data = NULL;
  32
  33 /* Require a valid Architecture.  */
  34 #define ARCHPY_REQUIRE_VALID(arch_obj, arch)                    \
  35   do {                                                          \
  36     arch = arch_object_to_gdbarch (arch_obj);                   \
  37     if (arch == NULL)                                           \
  38       {                                                         \
  39         PyErr_SetString (PyExc_RuntimeError,                    \
  40                          _("Architecture is invalid."));        \
  41         return NULL;                                            \
  42       }                                                         \
  43   } while (0)
  44
  45 extern PyTypeObject arch_object_type
  46     CPYCHECKER_TYPE_OBJECT_FOR_TYPEDEF ("arch_object");
  47
  48 /* Associates an arch_object with GDBARCH as gdbarch_data via the gdbarch
  49    post init registration mechanism (gdbarch_data_register_post_init).  */
  50
  51 static void *
  52 arch_object_data_init (struct gdbarch *gdbarch)
  53 {
  54   arch_object *arch_obj = PyObject_New (arch_object, &arch_object_type);
  55
  56   if (arch_obj == NULL)
  57     return NULL;
  58
  59   arch_obj->gdbarch = gdbarch;
  60
  61   return (void *) arch_obj;
  62 }
  63
  64 /* Returns the struct gdbarch value corresponding to the given Python
  65    architecture object OBJ.  */
  66
  67 struct gdbarch *
  68 arch_object_to_gdbarch (PyObject *obj)
  69 {
  70   arch_object *py_arch = (arch_object *) obj;
  71
  72   return py_arch->gdbarch;
  73 }
  74
  75 /* Returns the Python architecture object corresponding to GDBARCH.
  76    Returns a new reference to the arch_object associated as data with
  77    GDBARCH.  */
  78
  79 PyObject *
  80 gdbarch_to_arch_object (struct gdbarch *gdbarch)
  81 {
  82   PyObject *new_ref = (PyObject *) gdbarch_data (gdbarch, arch_object_data);
  83
  84   /* new_ref could be NULL if registration of arch_object with GDBARCH failed
  85      in arch_object_data_init.  */
  86   Py_XINCREF (new_ref);
  87
  88   return new_ref;
  89 }
  90
  91 /* Implementation of gdb.Architecture.name (self) -> String.
  92    Returns the name of the architecture as a string value.  */
  93
  94 static PyObject *
  95 archpy_name (PyObject *self, PyObject *args)
  96 {
  97   struct gdbarch *gdbarch = NULL;
  98   const char *name;
  99
 100   ARCHPY_REQUIRE_VALID (self, gdbarch);
 101
 102   name = (gdbarch_bfd_arch_info (gdbarch))->printable_name;
 103   return PyString_FromString (name);
 104 }
 105
 106 /* Implementation of
 107    gdb.Architecture.disassemble (self, start_pc [, end_pc [,count]]) -> List.
 108    Returns a list of instructions in a memory address range.  Each instruction
 109    in the list is a Python dict object.
 110 */
 111
 112 static PyObject *
 113 archpy_disassemble (PyObject *self, PyObject *args, PyObject *kw)
 114 {
 115   static const char *keywords[] = { "start_pc", "end_pc", "count", NULL };
 116   CORE_ADDR start, end = 0;
 117   CORE_ADDR pc;
 118   gdb_py_ulongest start_temp;
 119   long count = 0, i;
 120   PyObject *end_obj = NULL, *count_obj = NULL;
 121   struct gdbarch *gdbarch = NULL;
 122
 123   ARCHPY_REQUIRE_VALID (self, gdbarch);
 124
 125   if (!gdb_PyArg_ParseTupleAndKeywords (args, kw, GDB_PY_LLU_ARG "|OO",
 126                                         keywords, &start_temp, &end_obj,
 127                                         &count_obj))
 128     return NULL;
 129
 130   start = start_temp;
 131   if (end_obj)
 132     {
 133       /* Make a long logic check first.  In Python 3.x, internally,
 134          all integers are represented as longs.  In Python 2.x, there
 135          is still a differentiation internally between a PyInt and a
 136          PyLong.  Explicitly do this long check conversion first. In
 137          GDB, for Python 3.x, we #ifdef PyInt = PyLong.  This check has
 138          to be done first to ensure we do not lose information in the
 139          conversion process.  */
 140       if (PyLong_Check (end_obj))
 141         end = PyLong_AsUnsignedLongLong (end_obj);
 142 #if PY_MAJOR_VERSION == 2
 143       else if (PyInt_Check (end_obj))
 144         /* If the end_pc value is specified without a trailing 'L', end_obj will
 145            be an integer and not a long integer.  */
 146         end = PyInt_AsLong (end_obj);
 147 #endif
 148       else
 149         {
 150           PyErr_SetString (PyExc_TypeError,
 151                            _("Argument 'end_pc' should be a (long) integer."));
 152
 153           return NULL;
 154         }
 155
 156       if (end < start)
 157         {
 158           PyErr_SetString (PyExc_ValueError,
 159                            _("Argument 'end_pc' should be greater than or "
 160                              "equal to the argument 'start_pc'."));
 161
 162           return NULL;
 163         }
 164     }
 165   if (count_obj)
 166     {
 167       count = PyInt_AsLong (count_obj);
 168       if (PyErr_Occurred () || count < 0)
 169         {
 170           PyErr_SetString (PyExc_TypeError,
 171                            _("Argument 'count' should be an non-negative "
 172                              "integer."));
 173
 174           return NULL;
 175         }
 176     }
 177
 178   gdbpy_ref<> result_list (PyList_New (0));
 179   if (result_list == NULL)
 180     return NULL;
 181
 182   for (pc = start, i = 0;
 183        /* All args are specified.  */
 184        (end_obj && count_obj && pc <= end && i < count)
 185        /* end_pc is specified, but no count.  */
 186        || (end_obj && count_obj == NULL && pc <= end)
 187        /* end_pc is not specified, but a count is.  */
 188        || (end_obj == NULL && count_obj && i < count)
 189        /* Both end_pc and count are not specified.  */
 190        || (end_obj == NULL && count_obj == NULL && pc == start);)
 191     {
 192       int insn_len = 0;
 193       gdbpy_ref<> insn_dict (PyDict_New ());
 194
 195       if (insn_dict == NULL)
 196         return NULL;
 197       if (PyList_Append (result_list.get (), insn_dict.get ()))
 198         return NULL;  /* PyList_Append Sets the exception.  */
 199
 200       string_file stb;
 201
 202       try
 203         {
 204           insn_len = gdb_print_insn (gdbarch, pc, &stb, NULL);
 205         }
 206       catch (const gdb_exception &except)
 207         {
 208           gdbpy_convert_exception (except);
 209           return NULL;
 210         }
 211
 212       gdbpy_ref<> pc_obj = gdb_py_object_from_ulongest (pc);
 213       if (pc_obj == nullptr)
 214         return nullptr;
 215
 216       gdbpy_ref<> asm_obj (PyString_FromString (!stb.empty ()
 217                                                 ? stb.c_str ()
 218                                                 : "<unknown>"));
 219       if (asm_obj == nullptr)
 220         return nullptr;
 221
 222       gdbpy_ref<> len_obj = gdb_py_object_from_longest (insn_len);
 223       if (len_obj == nullptr)
 224         return nullptr;
 225
 226       if (PyDict_SetItemString (insn_dict.get (), "addr", pc_obj.get ())
 227           || PyDict_SetItemString (insn_dict.get (), "asm", asm_obj.get ())
 228           || PyDict_SetItemString (insn_dict.get (), "length", len_obj.get ()))
 229         return NULL;
 230
 231       pc += insn_len;
 232       i++;
 233     }
 234
 235   return result_list.release ();
 236 }
 237
 238 /* Implementation of gdb.Architecture.registers (self, reggroup) -> Iterator.
 239    Returns an iterator over register descriptors for registers in GROUP
 240    within the architecture SELF.  */
 241
 242 static PyObject *
 243 archpy_registers (PyObject *self, PyObject *args, PyObject *kw)
 244 {
 245   static const char *keywords[] = { "reggroup", NULL };
 246   struct gdbarch *gdbarch = NULL;
 247   const char *group_name = NULL;
 248
 249   /* Parse method arguments.  */
 250   if (!gdb_PyArg_ParseTupleAndKeywords (args, kw, "|s", keywords,
 251                                         &group_name))
 252     return NULL;
 253
 254   /* Extract the gdbarch from the self object.  */
 255   ARCHPY_REQUIRE_VALID (self, gdbarch);
 256
 257   return gdbpy_new_register_descriptor_iterator (gdbarch, group_name);
 258 }
 259
 260 /* Implementation of gdb.Architecture.register_groups (self) -> Iterator.
 261    Returns an iterator that will give up all valid register groups in the
 262    architecture SELF.  */
 263
 264 static PyObject *
 265 archpy_register_groups (PyObject *self, PyObject *args)
 266 {
 267   struct gdbarch *gdbarch = NULL;
 268
 269   /* Extract the gdbarch from the self object.  */
 270   ARCHPY_REQUIRE_VALID (self, gdbarch);
 271   return gdbpy_new_reggroup_iterator (gdbarch);
 272 }
 273
 274 /* Implementation of gdb.integer_type.  */
 275 static PyObject *
 276 archpy_integer_type (PyObject *self, PyObject *args, PyObject *kw)
 277 {
 278   static const char *keywords[] = { "size", "signed", NULL };
 279   int size;
 280   PyObject *is_signed_obj = nullptr;
 281
 282   if (!gdb_PyArg_ParseTupleAndKeywords (args, kw, "i|O", keywords,
 283                                         &size, &is_signed_obj))
 284     return nullptr;
 285
 286   /* Assume signed by default.  */
 287   bool is_signed = (is_signed_obj == nullptr
 288                     || PyObject_IsTrue (is_signed_obj));
 289
 290   struct gdbarch *gdbarch;
 291   ARCHPY_REQUIRE_VALID (self, gdbarch);
 292
 293   const struct builtin_type *builtins = builtin_type (gdbarch);
 294   struct type *type = nullptr;
 295   switch (size)
 296     {
 297     case 0:
 298       type = builtins->builtin_int0;
 299       break;
 300     case 8:
 301       type = is_signed ? builtins->builtin_int8 : builtins->builtin_uint8;
 302       break;
 303     case 16:
 304       type = is_signed ? builtins->builtin_int16 : builtins->builtin_uint16;
 305       break;
 306     case 24:
 307       type = is_signed ? builtins->builtin_int24 : builtins->builtin_uint24;
 308       break;
 309     case 32:
 310       type = is_signed ? builtins->builtin_int32 : builtins->builtin_uint32;
 311       break;
 312     case 64:
 313       type = is_signed ? builtins->builtin_int64 : builtins->builtin_uint64;
 314       break;
 315     case 128:
 316       type = is_signed ? builtins->builtin_int128 : builtins->builtin_uint128;
 317       break;
 318
 319     default:
 320       PyErr_SetString (PyExc_ValueError,
 321                        _("no integer type of that size is available"));
 322       return nullptr;
 323     }
 324
 325   return type_to_type_object (type);
 326 }
 327
 328 /* Implementation of gdb.architecture_names().  Return a list of all the
 329    BFD architecture names that GDB understands.  */
 330
 331 PyObject *
 332 gdbpy_all_architecture_names (PyObject *self, PyObject *args)
 333 {
 334   gdbpy_ref<> list (PyList_New (0));
 335   if (list == nullptr)
 336     return nullptr;
 337
 338   std::vector<const char *> name_list = gdbarch_printable_names ();
 339   for (const char *name : name_list)
 340     {
 341       gdbpy_ref <> py_name (PyString_FromString (name));
 342       if (py_name == nullptr)
 343         return nullptr;
 344       if (PyList_Append (list.get (), py_name.get ()) < 0)
 345         return nullptr;
 346     }
 347
 348  return list.release ();
 349 }
 350
 351 void _initialize_py_arch ();
 352 void
 353 _initialize_py_arch ()
 354 {
 355   arch_object_data = gdbarch_data_register_post_init (arch_object_data_init);
 356 }
 357
 358 /* Initializes the Architecture class in the gdb module.  */
 359
 360 int
 361 gdbpy_initialize_arch (void)
 362 {
 363   arch_object_type.tp_new = PyType_GenericNew;
 364   if (PyType_Ready (&arch_object_type) < 0)
 365     return -1;
 366
 367   return gdb_pymodule_addobject (gdb_module, "Architecture",
 368                                  (PyObject *) &arch_object_type);
 369 }
 370
 371 static PyMethodDef arch_object_methods [] = {
 372   { "name", archpy_name, METH_NOARGS,
 373     "name () -> String.\n\
 374 Return the name of the architecture as a string value." },
 375   { "disassemble", (PyCFunction) archpy_disassemble,
 376     METH_VARARGS | METH_KEYWORDS,
 377     "disassemble (start_pc [, end_pc [, count]]) -> List.\n\
 378 Return a list of at most COUNT disassembled instructions from START_PC to\n\
 379 END_PC." },
 380   { "integer_type", (PyCFunction) archpy_integer_type,
 381     METH_VARARGS | METH_KEYWORDS,
 382     "integer_type (size [, signed]) -> type\n\
 383 Return an integer Type corresponding to the given bitsize and signed-ness.\n\
 384 If not specified, the type defaults to signed." },
 385   { "registers", (PyCFunction) archpy_registers,
 386     METH_VARARGS | METH_KEYWORDS,
 387     "registers ([ group-name ]) -> Iterator.\n\
 388 Return an iterator of register descriptors for the registers in register\n\
 389 group GROUP-NAME." },
 390   { "register_groups", archpy_register_groups,
 391     METH_NOARGS,
 392     "register_groups () -> Iterator.\n\
 393 Return an iterator over all of the register groups in this architecture." },
 394   {NULL}  /* Sentinel */
 395 };
 396
 397 PyTypeObject arch_object_type = {
 398   PyVarObject_HEAD_INIT (NULL, 0)
 399   "gdb.Architecture",                 /* tp_name */
 400   sizeof (arch_object),               /* tp_basicsize */
 401   0,                                  /* tp_itemsize */
 402   0,                                  /* tp_dealloc */
 403   0,                                  /* tp_print */
 404   0,                                  /* tp_getattr */
 405   0,                                  /* tp_setattr */
 406   0,                                  /* tp_compare */
 407   0,                                  /* tp_repr */
 408   0,                                  /* tp_as_number */
 409   0,                                  /* tp_as_sequence */
 410   0,                                  /* tp_as_mapping */
 411   0,                                  /* tp_hash  */
 412   0,                                  /* tp_call */
 413   0,                                  /* tp_str */
 414   0,                                  /* tp_getattro */
 415   0,                                  /* tp_setattro */
 416   0,                                  /* tp_as_buffer */
 417   Py_TPFLAGS_DEFAULT,                 /* tp_flags */
 418   "GDB architecture object",          /* tp_doc */
 419   0,                                  /* tp_traverse */
 420   0,                                  /* tp_clear */
 421   0,                                  /* tp_richcompare */
 422   0,                                  /* tp_weaklistoffset */
 423   0,                                  /* tp_iter */
 424   0,                                  /* tp_iternext */
 425   arch_object_methods,                /* tp_methods */
 426   0,                                  /* tp_members */
 427   0,                                  /* tp_getset */
 428   0,                                  /* tp_base */
 429   0,                                  /* tp_dict */
 430   0,                                  /* tp_descr_get */
 431   0,                                  /* tp_descr_set */
 432   0,                                  /* tp_dictoffset */
 433   0,                                  /* tp_init */
 434   0,                                  /* tp_alloc */
 435 };