1 /* Python interface to architecture
3 Copyright (C) 2013-2015 Free Software Foundation, Inc.
5 This file is part of GDB.
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.
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.
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/>. */
22 #include "arch-utils.h"
24 #include "python-internal.h"
26 typedef struct arch_object_type_object {
28 struct gdbarch *gdbarch;
31 static struct gdbarch_data *arch_object_data = NULL;
33 /* Require a valid Architecture. */
34 #define ARCHPY_REQUIRE_VALID(arch_obj, arch) \
36 arch = arch_object_to_gdbarch (arch_obj); \
39 PyErr_SetString (PyExc_RuntimeError, \
40 _("Architecture is invalid.")); \
45 extern PyTypeObject arch_object_type
46 CPYCHECKER_TYPE_OBJECT_FOR_TYPEDEF ("arch_object");
48 /* Associates an arch_object with GDBARCH as gdbarch_data via the gdbarch
49 post init registration mechanism (gdbarch_data_register_post_init). */
52 arch_object_data_init (struct gdbarch *gdbarch)
54 arch_object *arch_obj = PyObject_New (arch_object, &arch_object_type);
59 arch_obj->gdbarch = gdbarch;
61 return (void *) arch_obj;
64 /* Returns the struct gdbarch value corresponding to the given Python
65 architecture object OBJ. */
68 arch_object_to_gdbarch (PyObject *obj)
70 arch_object *py_arch = (arch_object *) obj;
72 return py_arch->gdbarch;
75 /* Returns the Python architecture object corresponding to GDBARCH.
76 Returns a new reference to the arch_object associated as data with
80 gdbarch_to_arch_object (struct gdbarch *gdbarch)
82 PyObject *new_ref = (PyObject *) gdbarch_data (gdbarch, arch_object_data);
84 /* new_ref could be NULL if registration of arch_object with GDBARCH failed
85 in arch_object_data_init. */
91 /* Implementation of gdb.Architecture.name (self) -> String.
92 Returns the name of the architecture as a string value. */
95 archpy_name (PyObject *self, PyObject *args)
97 struct gdbarch *gdbarch = NULL;
101 ARCHPY_REQUIRE_VALID (self, gdbarch);
103 name = (gdbarch_bfd_arch_info (gdbarch))->printable_name;
104 py_name = PyString_FromString (name);
110 gdb.Architecture.disassemble (self, start_pc [, end_pc [,count]]) -> List.
111 Returns a list of instructions in a memory address range. Each instruction
112 in the list is a Python dict object.
116 archpy_disassemble (PyObject *self, PyObject *args, PyObject *kw)
118 static char *keywords[] = { "start_pc", "end_pc", "count", NULL };
119 CORE_ADDR start, end = 0;
121 gdb_py_ulongest start_temp;
123 PyObject *result_list, *end_obj = NULL, *count_obj = NULL;
124 struct gdbarch *gdbarch = NULL;
126 ARCHPY_REQUIRE_VALID (self, gdbarch);
128 if (!PyArg_ParseTupleAndKeywords (args, kw, GDB_PY_LLU_ARG "|OO", keywords,
129 &start_temp, &end_obj, &count_obj))
135 /* Make a long logic check first. In Python 3.x, internally,
136 all integers are represented as longs. In Python 2.x, there
137 is still a differentiation internally between a PyInt and a
138 PyLong. Explicitly do this long check conversion first. In
139 GDB, for Python 3.x, we #ifdef PyInt = PyLong. This check has
140 to be done first to ensure we do not lose information in the
141 conversion process. */
142 if (PyLong_Check (end_obj))
143 end = PyLong_AsUnsignedLongLong (end_obj);
144 else if (PyInt_Check (end_obj))
145 /* If the end_pc value is specified without a trailing 'L', end_obj will
146 be an integer and not a long integer. */
147 end = PyInt_AsLong (end_obj);
151 Py_XDECREF (count_obj);
152 PyErr_SetString (PyExc_TypeError,
153 _("Argument 'end_pc' should be a (long) integer."));
161 Py_XDECREF (count_obj);
162 PyErr_SetString (PyExc_ValueError,
163 _("Argument 'end_pc' should be greater than or "
164 "equal to the argument 'start_pc'."));
171 count = PyInt_AsLong (count_obj);
172 if (PyErr_Occurred () || count < 0)
174 Py_DECREF (count_obj);
175 Py_XDECREF (end_obj);
176 PyErr_SetString (PyExc_TypeError,
177 _("Argument 'count' should be an non-negative "
184 result_list = PyList_New (0);
185 if (result_list == NULL)
188 for (pc = start, i = 0;
189 /* All args are specified. */
190 (end_obj && count_obj && pc <= end && i < count)
191 /* end_pc is specified, but no count. */
192 || (end_obj && count_obj == NULL && pc <= end)
193 /* end_pc is not specified, but a count is. */
194 || (end_obj == NULL && count_obj && i < count)
195 /* Both end_pc and count are not specified. */
196 || (end_obj == NULL && count_obj == NULL && pc == start);)
200 struct ui_file *memfile = mem_fileopen ();
201 PyObject *insn_dict = PyDict_New ();
202 volatile struct gdb_exception except;
204 if (insn_dict == NULL)
206 Py_DECREF (result_list);
207 ui_file_delete (memfile);
211 if (PyList_Append (result_list, insn_dict))
213 Py_DECREF (result_list);
214 Py_DECREF (insn_dict);
215 ui_file_delete (memfile);
217 return NULL; /* PyList_Append Sets the exception. */
220 TRY_CATCH (except, RETURN_MASK_ALL)
222 insn_len = gdb_print_insn (gdbarch, pc, memfile, NULL);
224 if (except.reason < 0)
226 Py_DECREF (result_list);
227 ui_file_delete (memfile);
229 gdbpy_convert_exception (except);
233 as = ui_file_xstrdup (memfile, NULL);
234 if (PyDict_SetItemString (insn_dict, "addr",
235 gdb_py_long_from_ulongest (pc))
236 || PyDict_SetItemString (insn_dict, "asm",
237 PyString_FromString (*as ? as : "<unknown>"))
238 || PyDict_SetItemString (insn_dict, "length",
239 PyInt_FromLong (insn_len)))
241 Py_DECREF (result_list);
243 ui_file_delete (memfile);
251 ui_file_delete (memfile);
258 /* Initializes the Architecture class in the gdb module. */
261 gdbpy_initialize_arch (void)
263 arch_object_data = gdbarch_data_register_post_init (arch_object_data_init);
264 arch_object_type.tp_new = PyType_GenericNew;
265 if (PyType_Ready (&arch_object_type) < 0)
268 return gdb_pymodule_addobject (gdb_module, "Architecture",
269 (PyObject *) &arch_object_type);
272 static PyMethodDef arch_object_methods [] = {
273 { "name", archpy_name, METH_NOARGS,
274 "name () -> String.\n\
275 Return the name of the architecture as a string value." },
276 { "disassemble", (PyCFunction) archpy_disassemble,
277 METH_VARARGS | METH_KEYWORDS,
278 "disassemble (start_pc [, end_pc [, count]]) -> List.\n\
279 Return a list of at most COUNT disassembled instructions from START_PC to\n\
281 {NULL} /* Sentinel */
284 PyTypeObject arch_object_type = {
285 PyVarObject_HEAD_INIT (NULL, 0)
286 "gdb.Architecture", /* tp_name */
287 sizeof (arch_object), /* tp_basicsize */
295 0, /* tp_as_number */
296 0, /* tp_as_sequence */
297 0, /* tp_as_mapping */
303 0, /* tp_as_buffer */
304 Py_TPFLAGS_DEFAULT, /* tp_flags */
305 "GDB architecture object", /* tp_doc */
308 0, /* tp_richcompare */
309 0, /* tp_weaklistoffset */
312 arch_object_methods, /* tp_methods */
317 0, /* tp_descr_get */
318 0, /* tp_descr_set */
319 0, /* tp_dictoffset */