binutils-gdb/gdb/python/py-instruction.c
Andrew Burgess 66bd1b294d gdb/python: break dependencies between gdbpy_initialize_* functions
In a later commit in this series I will propose removing all of the
explicit gdbpy_initialize_* calls from python.c and replace these
calls with a more generic mechanism.

One of the side effects of this generic mechanism is that the order in
which the various Python sub-systems within GDB are initialized is no
longer guaranteed.

On the whole I don't think this matters, most of the sub-systems are
independent of each other, though testing did reveal a few places
where we did have dependencies, though I don't think those
dependencies were explicitly documented in a comment anywhere.

This commit removes the first dependency issue, with this and the next
commit, all of the implicit inter-sub-system dependencies will be
replaced by explicit dependencies, which will allow me to, I think,
clean up how the sub-systems are initialized.

The dependency is around the py_insn_type.  This type is setup in
gdbpy_initialize_instruction and used in gdbpy_initialize_record.
Rather than depend on the calls to these two functions being in a
particular order, in this commit I propose adding a new function
py_insn_get_insn_type.  This function will take care of setting up the
py_insn_type type and calling PyType_Ready.  This helper function can
be called from gdbpy_initialize_record and
gdbpy_initialize_instruction, and the py_insn_type will be initialized
just once.

To me this is better, the dependency is now really obvious, but also,
we no longer care in which order gdbpy_initialize_record and
gdbpy_initialize_instruction are called.

There should be no user visible changes after this commit.
2022-10-20 16:49:53 +01:00

91 lines
2.5 KiB
C

/* Python interface to instruction objects.
Copyright 2017-2022 Free Software Foundation, Inc.
This file is part of GDB.
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>. */
#include "defs.h"
#include "py-instruction.h"
/* Python type object for the abstract gdb.Instruction class. This class
contains getters for four elements: "pc" (int), "data" (buffer), "decode"
(str) and "size" (int) that must be overridden by sub classes. */
PyTypeObject py_insn_type = {
PyVarObject_HEAD_INIT (NULL, 0)
};
/* Python instruction object. */
struct py_insn_obj {
PyObject_HEAD
};
/* Getter function for gdb.Instruction attributes. */
static PyObject *
py_insn_getter (PyObject *self, void *closure)
{
return PyErr_Format (PyExc_NotImplementedError, _("Not implemented."));
}
/* Instruction members. */
static gdb_PyGetSetDef py_insn_getset[] =
{
{ "pc", py_insn_getter, NULL, "instruction address", NULL},
{ "data", py_insn_getter, NULL, "instruction memory", NULL},
{ "decoded", py_insn_getter, NULL, "decoded instruction", NULL},
{ "size", py_insn_getter, NULL, "instruction size in bytes", NULL},
{NULL}
};
/* See py-instruction.h. */
PyTypeObject *
py_insn_get_insn_type ()
{
if (py_insn_type.tp_new == nullptr)
{
py_insn_type.tp_new = PyType_GenericNew;
py_insn_type.tp_flags = Py_TPFLAGS_DEFAULT;
py_insn_type.tp_basicsize = sizeof (py_insn_obj);
py_insn_type.tp_name = "gdb.Instruction";
py_insn_type.tp_doc = "GDB instruction object";
py_insn_type.tp_getset = py_insn_getset;
if (PyType_Ready (&py_insn_type) < 0)
{
/* Reset the tp_new field so any subsequent calls to this
function will retry to make the type ready. */
py_insn_type.tp_new = nullptr;
return nullptr;
}
}
return &py_insn_type;
}
/* Sets up the gdb.Instruction type. */
int
gdbpy_initialize_instruction (void)
{
if (py_insn_get_insn_type () == nullptr)
return -1;
return 0;
}