1 /* Python interface to architecture
3 Copyright (C) 2013-2017 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"
27 typedef struct arch_object_type_object
{
29 struct gdbarch
*gdbarch
;
32 static struct gdbarch_data
*arch_object_data
= NULL
;
34 /* Require a valid Architecture. */
35 #define ARCHPY_REQUIRE_VALID(arch_obj, arch) \
37 arch = arch_object_to_gdbarch (arch_obj); \
40 PyErr_SetString (PyExc_RuntimeError, \
41 _("Architecture is invalid.")); \
46 extern PyTypeObject arch_object_type
47 CPYCHECKER_TYPE_OBJECT_FOR_TYPEDEF ("arch_object");
49 /* Associates an arch_object with GDBARCH as gdbarch_data via the gdbarch
50 post init registration mechanism (gdbarch_data_register_post_init). */
53 arch_object_data_init (struct gdbarch
*gdbarch
)
55 arch_object
*arch_obj
= PyObject_New (arch_object
, &arch_object_type
);
60 arch_obj
->gdbarch
= gdbarch
;
62 return (void *) arch_obj
;
65 /* Returns the struct gdbarch value corresponding to the given Python
66 architecture object OBJ. */
69 arch_object_to_gdbarch (PyObject
*obj
)
71 arch_object
*py_arch
= (arch_object
*) obj
;
73 return py_arch
->gdbarch
;
76 /* Returns the Python architecture object corresponding to GDBARCH.
77 Returns a new reference to the arch_object associated as data with
81 gdbarch_to_arch_object (struct gdbarch
*gdbarch
)
83 PyObject
*new_ref
= (PyObject
*) gdbarch_data (gdbarch
, arch_object_data
);
85 /* new_ref could be NULL if registration of arch_object with GDBARCH failed
86 in arch_object_data_init. */
92 /* Implementation of gdb.Architecture.name (self) -> String.
93 Returns the name of the architecture as a string value. */
96 archpy_name (PyObject
*self
, PyObject
*args
)
98 struct gdbarch
*gdbarch
= NULL
;
102 ARCHPY_REQUIRE_VALID (self
, gdbarch
);
104 name
= (gdbarch_bfd_arch_info (gdbarch
))->printable_name
;
105 py_name
= PyString_FromString (name
);
111 gdb.Architecture.disassemble (self, start_pc [, end_pc [,count]]) -> List.
112 Returns a list of instructions in a memory address range. Each instruction
113 in the list is a Python dict object.
117 archpy_disassemble (PyObject
*self
, PyObject
*args
, PyObject
*kw
)
119 static char *keywords
[] = { "start_pc", "end_pc", "count", NULL
};
120 CORE_ADDR start
, end
= 0;
122 gdb_py_ulongest start_temp
;
124 PyObject
*end_obj
= NULL
, *count_obj
= NULL
;
125 struct gdbarch
*gdbarch
= NULL
;
127 ARCHPY_REQUIRE_VALID (self
, gdbarch
);
129 if (!PyArg_ParseTupleAndKeywords (args
, kw
, GDB_PY_LLU_ARG
"|OO", keywords
,
130 &start_temp
, &end_obj
, &count_obj
))
136 /* Make a long logic check first. In Python 3.x, internally,
137 all integers are represented as longs. In Python 2.x, there
138 is still a differentiation internally between a PyInt and a
139 PyLong. Explicitly do this long check conversion first. In
140 GDB, for Python 3.x, we #ifdef PyInt = PyLong. This check has
141 to be done first to ensure we do not lose information in the
142 conversion process. */
143 if (PyLong_Check (end_obj
))
144 end
= PyLong_AsUnsignedLongLong (end_obj
);
145 #if PY_MAJOR_VERSION == 2
146 else if (PyInt_Check (end_obj
))
147 /* If the end_pc value is specified without a trailing 'L', end_obj will
148 be an integer and not a long integer. */
149 end
= PyInt_AsLong (end_obj
);
153 PyErr_SetString (PyExc_TypeError
,
154 _("Argument 'end_pc' should be a (long) integer."));
161 PyErr_SetString (PyExc_ValueError
,
162 _("Argument 'end_pc' should be greater than or "
163 "equal to the argument 'start_pc'."));
170 count
= PyInt_AsLong (count_obj
);
171 if (PyErr_Occurred () || count
< 0)
173 PyErr_SetString (PyExc_TypeError
,
174 _("Argument 'count' should be an non-negative "
181 gdbpy_ref
result_list (PyList_New (0));
182 if (result_list
== NULL
)
185 for (pc
= start
, i
= 0;
186 /* All args are specified. */
187 (end_obj
&& count_obj
&& pc
<= end
&& i
< count
)
188 /* end_pc is specified, but no count. */
189 || (end_obj
&& count_obj
== NULL
&& pc
<= end
)
190 /* end_pc is not specified, but a count is. */
191 || (end_obj
== NULL
&& count_obj
&& i
< count
)
192 /* Both end_pc and count are not specified. */
193 || (end_obj
== NULL
&& count_obj
== NULL
&& pc
== start
);)
196 struct ui_file
*memfile
= mem_fileopen ();
197 gdbpy_ref
insn_dict (PyDict_New ());
199 if (insn_dict
== NULL
)
201 ui_file_delete (memfile
);
205 if (PyList_Append (result_list
.get (), insn_dict
.get ()))
207 ui_file_delete (memfile
);
209 return NULL
; /* PyList_Append Sets the exception. */
214 insn_len
= gdb_print_insn (gdbarch
, pc
, memfile
, NULL
);
216 CATCH (except
, RETURN_MASK_ALL
)
218 ui_file_delete (memfile
);
220 gdbpy_convert_exception (except
);
225 std::string as
= ui_file_as_string (memfile
);
227 if (PyDict_SetItemString (insn_dict
.get (), "addr",
228 gdb_py_long_from_ulongest (pc
))
229 || PyDict_SetItemString (insn_dict
.get (), "asm",
230 PyString_FromString (!as
.empty ()
233 || PyDict_SetItemString (insn_dict
.get (), "length",
234 PyInt_FromLong (insn_len
)))
236 ui_file_delete (memfile
);
243 ui_file_delete (memfile
);
246 return result_list
.release ();
249 /* Initializes the Architecture class in the gdb module. */
252 gdbpy_initialize_arch (void)
254 arch_object_data
= gdbarch_data_register_post_init (arch_object_data_init
);
255 arch_object_type
.tp_new
= PyType_GenericNew
;
256 if (PyType_Ready (&arch_object_type
) < 0)
259 return gdb_pymodule_addobject (gdb_module
, "Architecture",
260 (PyObject
*) &arch_object_type
);
263 static PyMethodDef arch_object_methods
[] = {
264 { "name", archpy_name
, METH_NOARGS
,
265 "name () -> String.\n\
266 Return the name of the architecture as a string value." },
267 { "disassemble", (PyCFunction
) archpy_disassemble
,
268 METH_VARARGS
| METH_KEYWORDS
,
269 "disassemble (start_pc [, end_pc [, count]]) -> List.\n\
270 Return a list of at most COUNT disassembled instructions from START_PC to\n\
272 {NULL
} /* Sentinel */
275 PyTypeObject arch_object_type
= {
276 PyVarObject_HEAD_INIT (NULL
, 0)
277 "gdb.Architecture", /* tp_name */
278 sizeof (arch_object
), /* tp_basicsize */
286 0, /* tp_as_number */
287 0, /* tp_as_sequence */
288 0, /* tp_as_mapping */
294 0, /* tp_as_buffer */
295 Py_TPFLAGS_DEFAULT
, /* tp_flags */
296 "GDB architecture object", /* tp_doc */
299 0, /* tp_richcompare */
300 0, /* tp_weaklistoffset */
303 arch_object_methods
, /* tp_methods */
308 0, /* tp_descr_get */
309 0, /* tp_descr_set */
310 0, /* tp_dictoffset */