Fix some indentation in linespec.c
[deliverable/binutils-gdb.git] / gdb / python / py-arch.c
index edd508faf78d70def4724b6e0716267a7b4b885b..a1fdbd61445d28329100fb06ef0ef02b2ab460de 100644 (file)
@@ -1,6 +1,6 @@
 /* Python interface to architecture
 
-   Copyright (C) 2013 Free Software Foundation, Inc.
+   Copyright (C) 2013-2018 Free Software Foundation, Inc.
 
    This file is part of GDB.
 
@@ -20,7 +20,9 @@
 #include "defs.h"
 #include "gdbarch.h"
 #include "arch-utils.h"
+#include "disasm.h"
 #include "python-internal.h"
+#include "py-ref.h"
 
 typedef struct arch_object_type_object {
   PyObject_HEAD
@@ -28,7 +30,21 @@ typedef struct arch_object_type_object {
 } arch_object;
 
 static struct gdbarch_data *arch_object_data = NULL;
-static PyTypeObject arch_object_type;
+
+/* Require a valid Architecture.  */
+#define ARCHPY_REQUIRE_VALID(arch_obj, arch)                   \
+  do {                                                         \
+    arch = arch_object_to_gdbarch (arch_obj);                  \
+    if (arch == NULL)                                          \
+      {                                                                \
+       PyErr_SetString (PyExc_RuntimeError,                    \
+                        _("Architecture is invalid."));        \
+       return NULL;                                            \
+      }                                                                \
+  } while (0)
+
+extern PyTypeObject arch_object_type
+    CPYCHECKER_TYPE_OBJECT_FOR_TYPEDEF ("arch_object");
 
 /* Associates an arch_object with GDBARCH as gdbarch_data via the gdbarch
    post init registration mechanism (gdbarch_data_register_post_init).  */
@@ -79,36 +95,169 @@ gdbarch_to_arch_object (struct gdbarch *gdbarch)
 static PyObject *
 archpy_name (PyObject *self, PyObject *args)
 {
-  struct gdbarch *gdbarch = arch_object_to_gdbarch (self);
-  const char *name = (gdbarch_bfd_arch_info (gdbarch))->printable_name;
-  PyObject *py_name = PyString_FromString (name);
+  struct gdbarch *gdbarch = NULL;
+  const char *name;
+  PyObject *py_name;
+
+  ARCHPY_REQUIRE_VALID (self, gdbarch);
+
+  name = (gdbarch_bfd_arch_info (gdbarch))->printable_name;
+  py_name = PyString_FromString (name);
 
   return py_name;
 }
 
+/* Implementation of
+   gdb.Architecture.disassemble (self, start_pc [, end_pc [,count]]) -> List.
+   Returns a list of instructions in a memory address range.  Each instruction
+   in the list is a Python dict object.
+*/
+
+static PyObject *
+archpy_disassemble (PyObject *self, PyObject *args, PyObject *kw)
+{
+  static const char *keywords[] = { "start_pc", "end_pc", "count", NULL };
+  CORE_ADDR start, end = 0;
+  CORE_ADDR pc;
+  gdb_py_ulongest start_temp;
+  long count = 0, i;
+  PyObject *end_obj = NULL, *count_obj = NULL;
+  struct gdbarch *gdbarch = NULL;
+
+  ARCHPY_REQUIRE_VALID (self, gdbarch);
+
+  if (!gdb_PyArg_ParseTupleAndKeywords (args, kw, GDB_PY_LLU_ARG "|OO",
+                                       keywords, &start_temp, &end_obj,
+                                       &count_obj))
+    return NULL;
+
+  start = start_temp;
+  if (end_obj)
+    {
+      /* Make a long logic check first.  In Python 3.x, internally,
+        all integers are represented as longs.  In Python 2.x, there
+        is still a differentiation internally between a PyInt and a
+        PyLong.  Explicitly do this long check conversion first. In
+        GDB, for Python 3.x, we #ifdef PyInt = PyLong.  This check has
+        to be done first to ensure we do not lose information in the
+        conversion process.  */
+      if (PyLong_Check (end_obj))
+        end = PyLong_AsUnsignedLongLong (end_obj);
+#if PY_MAJOR_VERSION == 2
+      else if (PyInt_Check (end_obj))
+        /* If the end_pc value is specified without a trailing 'L', end_obj will
+           be an integer and not a long integer.  */
+        end = PyInt_AsLong (end_obj);
+#endif
+      else
+        {
+          PyErr_SetString (PyExc_TypeError,
+                           _("Argument 'end_pc' should be a (long) integer."));
+
+          return NULL;
+        }
+
+      if (end < start)
+        {
+          PyErr_SetString (PyExc_ValueError,
+                           _("Argument 'end_pc' should be greater than or "
+                             "equal to the argument 'start_pc'."));
+
+          return NULL;
+        }
+    }
+  if (count_obj)
+    {
+      count = PyInt_AsLong (count_obj);
+      if (PyErr_Occurred () || count < 0)
+        {
+          PyErr_SetString (PyExc_TypeError,
+                           _("Argument 'count' should be an non-negative "
+                             "integer."));
+
+          return NULL;
+        }
+    }
+
+  gdbpy_ref<> result_list (PyList_New (0));
+  if (result_list == NULL)
+    return NULL;
+
+  for (pc = start, i = 0;
+       /* All args are specified.  */
+       (end_obj && count_obj && pc <= end && i < count)
+       /* end_pc is specified, but no count.  */
+       || (end_obj && count_obj == NULL && pc <= end)
+       /* end_pc is not specified, but a count is.  */
+       || (end_obj == NULL && count_obj && i < count)
+       /* Both end_pc and count are not specified.  */
+       || (end_obj == NULL && count_obj == NULL && pc == start);)
+    {
+      int insn_len = 0;
+      gdbpy_ref<> insn_dict (PyDict_New ());
+
+      if (insn_dict == NULL)
+       return NULL;
+      if (PyList_Append (result_list.get (), insn_dict.get ()))
+       return NULL;  /* PyList_Append Sets the exception.  */
+
+      string_file stb;
+
+      TRY
+        {
+          insn_len = gdb_print_insn (gdbarch, pc, &stb, NULL);
+        }
+      CATCH (except, RETURN_MASK_ALL)
+        {
+         gdbpy_convert_exception (except);
+         return NULL;
+        }
+      END_CATCH
+
+      if (PyDict_SetItemString (insn_dict.get (), "addr",
+                                gdb_py_long_from_ulongest (pc))
+          || PyDict_SetItemString (insn_dict.get (), "asm",
+                                   PyString_FromString (!stb.empty ()
+                                                       ? stb.c_str ()
+                                                       : "<unknown>"))
+          || PyDict_SetItemString (insn_dict.get (), "length",
+                                   PyInt_FromLong (insn_len)))
+       return NULL;
+
+      pc += insn_len;
+      i++;
+    }
+
+  return result_list.release ();
+}
+
 /* Initializes the Architecture class in the gdb module.  */
 
-void
+int
 gdbpy_initialize_arch (void)
 {
   arch_object_data = gdbarch_data_register_post_init (arch_object_data_init);
   arch_object_type.tp_new = PyType_GenericNew;
   if (PyType_Ready (&arch_object_type) < 0)
-    return;
+    return -1;
 
-  Py_INCREF (&arch_object_type);
-  PyModule_AddObject (gdb_module, "Architecture",
-                      (PyObject *) &arch_object_type);
+  return gdb_pymodule_addobject (gdb_module, "Architecture",
+                                (PyObject *) &arch_object_type);
 }
 
 static PyMethodDef arch_object_methods [] = {
   { "name", archpy_name, METH_NOARGS,
     "name () -> String.\n\
 Return the name of the architecture as a string value." },
+  { "disassemble", (PyCFunction) archpy_disassemble,
+    METH_VARARGS | METH_KEYWORDS,
+    "disassemble (start_pc [, end_pc [, count]]) -> List.\n\
+Return a list of at most COUNT disassembled instructions from START_PC to\n\
+END_PC." },
   {NULL}  /* Sentinel */
 };
 
-static PyTypeObject arch_object_type = {
+PyTypeObject arch_object_type = {
   PyVarObject_HEAD_INIT (NULL, 0)
   "gdb.Architecture",                 /* tp_name */
   sizeof (arch_object),               /* tp_basicsize */
This page took 0.026233 seconds and 4 git commands to generate.