mirror of
https://sourceware.org/git/binutils-gdb.git
synced 2026-08-27 00:26:02 -04:00
60cd57ff6e
All of our custom Python types are created as structs, like this:
struct some_new_type : public PyObject
{
... various fields ...
};
Then instances of this struct are created by calling PyObject_New,
either directly within GDB's C++ code, or within Python when a user's
Python script creates an instance of that class.
The problem is that Python is written in C, and PyObject_New doesn't
call any constructors for `some_new_type`, nor for any of the fields
within `some_new_type`.
If `some_new_type` is Plain Old Data (POD), then this is fine. Or, to
be more C++ specific, if `some_new_type` is trivially default
constructable, then we're fine.
But if a field within `some_new_type` has a non-trivial constructor,
then we're in trouble as that constructor will never be run.
An example of a problematic field type is frame_info_ptr. The
constructor for this type registers the new object with a central
management object, recording the `this` pointer, using this type within
`some_new_type` will not work as expected; frame invalidation will not
show up within the frame_info_ptr as you might expect.
And so, this type trait exists. Whenever a struct is created to define
a new Python type we should add a line like:
static_assert (gdb::is_python_allocatable_v<some_new_type>);
This will fail if any field of `some_new_type` are unsuitable for this
use.
We don't actually check is_trivially_default_constructible here. Some
types, e.g. ui_file_style::color, have non-trivial (or no default)
constructors, but are still safe to use within `some_new_type` because
their constructors just initialise data fields; there's nothing
"special" that the constructor does that cannot be achieved by
assigning the fields after creation with PyObject_New.
What actually matters is that the type is trivially destructible
(Python won't call C++ destructors, so destructors with side effects,
like deregistering from a list, would be skipped) and trivially
copyable (Python may copy objects with memcpy). Types like
frame_info_ptr, whose constructors and destructors have side effects
such as registering with a central management object, will be caught
because they are neither trivially destructible nor trivially copyable.
Simple POD types like ui_file_style are trivially destructible and
copyable, so pass this trait.
This commit adds the new type trait, and makes use of it in all cases
but one, pending_frame_object in python/py-unwind.c, has a field of
type frame_info_ptr, which is currently broken. This will be fixed,
and the static_assert added, in the next commit.
Approved-By: Tom Tromey <tom@tromey.com>
92 lines
2.6 KiB
C
92 lines
2.6 KiB
C
/* Python interface to instruction objects.
|
|
|
|
Copyright 2017-2026 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 "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: public PyObject
|
|
{};
|
|
|
|
static_assert (gdb::is_python_allocatable_v<py_insn_obj>);
|
|
|
|
/* 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 (gdbpy_type_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. */
|
|
|
|
static int
|
|
gdbpy_initialize_instruction ()
|
|
{
|
|
if (py_insn_get_insn_type () == nullptr)
|
|
return -1;
|
|
return 0;
|
|
}
|
|
|
|
GDBPY_INITIALIZE_FILE (gdbpy_initialize_instruction);
|