123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621 |
- /* Python interface to program spaces.
- Copyright (C) 2010-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 "python-internal.h"
- #include "charset.h"
- #include "progspace.h"
- #include "objfiles.h"
- #include "language.h"
- #include "arch-utils.h"
- #include "solib.h"
- #include "block.h"
- struct pspace_object
- {
- PyObject_HEAD
- /* The corresponding pspace. */
- struct program_space *pspace;
- /* Dictionary holding user-added attributes.
- This is the __dict__ attribute of the object. */
- PyObject *dict;
- /* The pretty-printer list of functions. */
- PyObject *printers;
- /* The frame filter list of functions. */
- PyObject *frame_filters;
- /* The frame unwinder list. */
- PyObject *frame_unwinders;
- /* The type-printer list. */
- PyObject *type_printers;
- /* The debug method list. */
- PyObject *xmethods;
- };
- extern PyTypeObject pspace_object_type
- CPYCHECKER_TYPE_OBJECT_FOR_TYPEDEF ("pspace_object");
- static const struct program_space_data *pspy_pspace_data_key;
- /* Require that PSPACE_OBJ be a valid program space ID. */
- #define PSPY_REQUIRE_VALID(pspace_obj) \
- do { \
- if (pspace_obj->pspace == nullptr) \
- { \
- PyErr_SetString (PyExc_RuntimeError, \
- _("Program space no longer exists.")); \
- return NULL; \
- } \
- } while (0)
- /* An Objfile method which returns the objfile's file name, or None. */
- static PyObject *
- pspy_get_filename (PyObject *self, void *closure)
- {
- pspace_object *obj = (pspace_object *) self;
- if (obj->pspace)
- {
- struct objfile *objfile = obj->pspace->symfile_object_file;
- if (objfile)
- return (host_string_to_python_string (objfile_name (objfile))
- .release ());
- }
- Py_RETURN_NONE;
- }
- static void
- pspy_dealloc (PyObject *self)
- {
- pspace_object *ps_self = (pspace_object *) self;
- Py_XDECREF (ps_self->dict);
- Py_XDECREF (ps_self->printers);
- Py_XDECREF (ps_self->frame_filters);
- Py_XDECREF (ps_self->frame_unwinders);
- Py_XDECREF (ps_self->type_printers);
- Py_XDECREF (ps_self->xmethods);
- Py_TYPE (self)->tp_free (self);
- }
- /* Initialize a pspace_object.
- The result is a boolean indicating success. */
- static int
- pspy_initialize (pspace_object *self)
- {
- self->pspace = NULL;
- self->dict = PyDict_New ();
- if (self->dict == NULL)
- return 0;
- self->printers = PyList_New (0);
- if (self->printers == NULL)
- return 0;
- self->frame_filters = PyDict_New ();
- if (self->frame_filters == NULL)
- return 0;
- self->frame_unwinders = PyList_New (0);
- if (self->frame_unwinders == NULL)
- return 0;
- self->type_printers = PyList_New (0);
- if (self->type_printers == NULL)
- return 0;
- self->xmethods = PyList_New (0);
- if (self->xmethods == NULL)
- return 0;
- return 1;
- }
- static PyObject *
- pspy_new (PyTypeObject *type, PyObject *args, PyObject *keywords)
- {
- gdbpy_ref<pspace_object> self ((pspace_object *) type->tp_alloc (type, 0));
- if (self != NULL)
- {
- if (!pspy_initialize (self.get ()))
- return NULL;
- }
- return (PyObject *) self.release ();
- }
- PyObject *
- pspy_get_printers (PyObject *o, void *ignore)
- {
- pspace_object *self = (pspace_object *) o;
- Py_INCREF (self->printers);
- return self->printers;
- }
- static int
- pspy_set_printers (PyObject *o, PyObject *value, void *ignore)
- {
- pspace_object *self = (pspace_object *) o;
- if (! value)
- {
- PyErr_SetString (PyExc_TypeError,
- "cannot delete the pretty_printers attribute");
- return -1;
- }
- if (! PyList_Check (value))
- {
- PyErr_SetString (PyExc_TypeError,
- "the pretty_printers attribute must be a list");
- return -1;
- }
- /* Take care in case the LHS and RHS are related somehow. */
- gdbpy_ref<> tmp (self->printers);
- Py_INCREF (value);
- self->printers = value;
- return 0;
- }
- /* Return the Python dictionary attribute containing frame filters for
- this program space. */
- PyObject *
- pspy_get_frame_filters (PyObject *o, void *ignore)
- {
- pspace_object *self = (pspace_object *) o;
- Py_INCREF (self->frame_filters);
- return self->frame_filters;
- }
- /* Set this object file's frame filters dictionary to FILTERS. */
- static int
- pspy_set_frame_filters (PyObject *o, PyObject *frame, void *ignore)
- {
- pspace_object *self = (pspace_object *) o;
- if (! frame)
- {
- PyErr_SetString (PyExc_TypeError,
- "cannot delete the frame filter attribute");
- return -1;
- }
- if (! PyDict_Check (frame))
- {
- PyErr_SetString (PyExc_TypeError,
- "the frame filter attribute must be a dictionary");
- return -1;
- }
- /* Take care in case the LHS and RHS are related somehow. */
- gdbpy_ref<> tmp (self->frame_filters);
- Py_INCREF (frame);
- self->frame_filters = frame;
- return 0;
- }
- /* Return the list of the frame unwinders for this program space. */
- PyObject *
- pspy_get_frame_unwinders (PyObject *o, void *ignore)
- {
- pspace_object *self = (pspace_object *) o;
- Py_INCREF (self->frame_unwinders);
- return self->frame_unwinders;
- }
- /* Set this program space's list of the unwinders to UNWINDERS. */
- static int
- pspy_set_frame_unwinders (PyObject *o, PyObject *unwinders, void *ignore)
- {
- pspace_object *self = (pspace_object *) o;
- if (!unwinders)
- {
- PyErr_SetString (PyExc_TypeError,
- "cannot delete the frame unwinders list");
- return -1;
- }
- if (!PyList_Check (unwinders))
- {
- PyErr_SetString (PyExc_TypeError,
- "the frame unwinders attribute must be a list");
- return -1;
- }
- /* Take care in case the LHS and RHS are related somehow. */
- gdbpy_ref<> tmp (self->frame_unwinders);
- Py_INCREF (unwinders);
- self->frame_unwinders = unwinders;
- return 0;
- }
- /* Get the 'type_printers' attribute. */
- static PyObject *
- pspy_get_type_printers (PyObject *o, void *ignore)
- {
- pspace_object *self = (pspace_object *) o;
- Py_INCREF (self->type_printers);
- return self->type_printers;
- }
- /* Get the 'xmethods' attribute. */
- PyObject *
- pspy_get_xmethods (PyObject *o, void *ignore)
- {
- pspace_object *self = (pspace_object *) o;
- Py_INCREF (self->xmethods);
- return self->xmethods;
- }
- /* Set the 'type_printers' attribute. */
- static int
- pspy_set_type_printers (PyObject *o, PyObject *value, void *ignore)
- {
- pspace_object *self = (pspace_object *) o;
- if (! value)
- {
- PyErr_SetString (PyExc_TypeError,
- "cannot delete the type_printers attribute");
- return -1;
- }
- if (! PyList_Check (value))
- {
- PyErr_SetString (PyExc_TypeError,
- "the type_printers attribute must be a list");
- return -1;
- }
- /* Take care in case the LHS and RHS are related somehow. */
- gdbpy_ref<> tmp (self->type_printers);
- Py_INCREF (value);
- self->type_printers = value;
- return 0;
- }
- /* Implement the objfiles method. */
- static PyObject *
- pspy_get_objfiles (PyObject *self_, PyObject *args)
- {
- pspace_object *self = (pspace_object *) self_;
- PSPY_REQUIRE_VALID (self);
- gdbpy_ref<> list (PyList_New (0));
- if (list == NULL)
- return NULL;
- if (self->pspace != NULL)
- {
- for (objfile *objf : self->pspace->objfiles ())
- {
- gdbpy_ref<> item = objfile_to_objfile_object (objf);
- if (item == nullptr
- || PyList_Append (list.get (), item.get ()) == -1)
- return NULL;
- }
- }
- return list.release ();
- }
- /* Implementation of solib_name (Long) -> String.
- Returns the name of the shared library holding a given address, or None. */
- static PyObject *
- pspy_solib_name (PyObject *o, PyObject *args)
- {
- char *soname;
- gdb_py_ulongest pc;
- pspace_object *self = (pspace_object *) o;
- PSPY_REQUIRE_VALID (self);
- if (!PyArg_ParseTuple (args, GDB_PY_LLU_ARG, &pc))
- return NULL;
- soname = solib_name_from_address (self->pspace, pc);
- if (soname == nullptr)
- Py_RETURN_NONE;
- return host_string_to_python_string (soname).release ();
- }
- /* Return the innermost lexical block containing the specified pc value,
- or 0 if there is none. */
- static PyObject *
- pspy_block_for_pc (PyObject *o, PyObject *args)
- {
- pspace_object *self = (pspace_object *) o;
- gdb_py_ulongest pc;
- const struct block *block = NULL;
- struct compunit_symtab *cust = NULL;
- PSPY_REQUIRE_VALID (self);
- if (!PyArg_ParseTuple (args, GDB_PY_LLU_ARG, &pc))
- return NULL;
- try
- {
- scoped_restore_current_program_space saver;
- set_current_program_space (self->pspace);
- cust = find_pc_compunit_symtab (pc);
- if (cust != NULL && cust->objfile () != NULL)
- block = block_for_pc (pc);
- }
- catch (const gdb_exception &except)
- {
- GDB_PY_HANDLE_EXCEPTION (except);
- }
- if (cust == NULL || cust->objfile () == NULL)
- Py_RETURN_NONE;
- if (block)
- return block_to_block_object (block, cust->objfile ());
- Py_RETURN_NONE;
- }
- /* Implementation of the find_pc_line function.
- Returns the gdb.Symtab_and_line object corresponding to a PC value. */
- static PyObject *
- pspy_find_pc_line (PyObject *o, PyObject *args)
- {
- gdb_py_ulongest pc_llu;
- PyObject *result = NULL; /* init for gcc -Wall */
- pspace_object *self = (pspace_object *) o;
- PSPY_REQUIRE_VALID (self);
- if (!PyArg_ParseTuple (args, GDB_PY_LLU_ARG, &pc_llu))
- return NULL;
- try
- {
- struct symtab_and_line sal;
- CORE_ADDR pc;
- scoped_restore_current_program_space saver;
- set_current_program_space (self->pspace);
- pc = (CORE_ADDR) pc_llu;
- sal = find_pc_line (pc, 0);
- result = symtab_and_line_to_sal_object (sal);
- }
- catch (const gdb_exception &except)
- {
- GDB_PY_HANDLE_EXCEPTION (except);
- }
- return result;
- }
- /* Implementation of is_valid (self) -> Boolean.
- Returns True if this program space still exists in GDB. */
- static PyObject *
- pspy_is_valid (PyObject *o, PyObject *args)
- {
- pspace_object *self = (pspace_object *) o;
- if (self->pspace == NULL)
- Py_RETURN_FALSE;
- Py_RETURN_TRUE;
- }
- /* Clear the PSPACE pointer in a Pspace object and remove the reference. */
- static void
- py_free_pspace (struct program_space *pspace, void *datum)
- {
- /* This is a fiction, but we're in a nasty spot: The pspace is in the
- process of being deleted, we can't rely on anything in it. Plus
- this is one time when the current program space and current inferior
- are not in sync: All inferiors that use PSPACE may no longer exist.
- We don't need to do much here, and since "there is always an inferior"
- using target_gdbarch suffices.
- Note: We cannot call get_current_arch because it may try to access
- the target, which may involve accessing data in the pspace currently
- being deleted. */
- struct gdbarch *arch = target_gdbarch ();
- gdbpy_enter enter_py (arch);
- gdbpy_ref<pspace_object> object ((pspace_object *) datum);
- object->pspace = NULL;
- }
- /* Return a new reference to the Python object of type Pspace
- representing PSPACE. If the object has already been created,
- return it. Otherwise, create it. Return NULL and set the Python
- error on failure. */
- gdbpy_ref<>
- pspace_to_pspace_object (struct program_space *pspace)
- {
- PyObject *result
- ((PyObject *) program_space_data (pspace, pspy_pspace_data_key));
- if (result == NULL)
- {
- gdbpy_ref<pspace_object> object
- ((pspace_object *) PyObject_New (pspace_object, &pspace_object_type));
- if (object == NULL)
- return NULL;
- if (!pspy_initialize (object.get ()))
- return NULL;
- object->pspace = pspace;
- set_program_space_data (pspace, pspy_pspace_data_key, object.get ());
- result = (PyObject *) object.release ();
- }
- return gdbpy_ref<>::new_reference (result);
- }
- /* See python-internal.h. */
- struct program_space *
- progspace_object_to_program_space (PyObject *obj)
- {
- gdb_assert (gdbpy_is_progspace (obj));
- return ((pspace_object *) obj)->pspace;
- }
- /* See python-internal.h. */
- bool
- gdbpy_is_progspace (PyObject *obj)
- {
- return PyObject_TypeCheck (obj, &pspace_object_type);
- }
- void _initialize_py_progspace ();
- void
- _initialize_py_progspace ()
- {
- pspy_pspace_data_key
- = register_program_space_data_with_cleanup (NULL, py_free_pspace);
- }
- int
- gdbpy_initialize_pspace (void)
- {
- if (PyType_Ready (&pspace_object_type) < 0)
- return -1;
- return gdb_pymodule_addobject (gdb_module, "Progspace",
- (PyObject *) &pspace_object_type);
- }
- static gdb_PyGetSetDef pspace_getset[] =
- {
- { "__dict__", gdb_py_generic_dict, NULL,
- "The __dict__ for this progspace.", &pspace_object_type },
- { "filename", pspy_get_filename, NULL,
- "The progspace's main filename, or None.", NULL },
- { "pretty_printers", pspy_get_printers, pspy_set_printers,
- "Pretty printers.", NULL },
- { "frame_filters", pspy_get_frame_filters, pspy_set_frame_filters,
- "Frame filters.", NULL },
- { "frame_unwinders", pspy_get_frame_unwinders, pspy_set_frame_unwinders,
- "Frame unwinders.", NULL },
- { "type_printers", pspy_get_type_printers, pspy_set_type_printers,
- "Type printers.", NULL },
- { "xmethods", pspy_get_xmethods, NULL,
- "Debug methods.", NULL },
- { NULL }
- };
- static PyMethodDef progspace_object_methods[] =
- {
- { "objfiles", pspy_get_objfiles, METH_NOARGS,
- "Return a sequence of objfiles associated to this program space." },
- { "solib_name", pspy_solib_name, METH_VARARGS,
- "solib_name (Long) -> String.\n\
- Return the name of the shared library holding a given address, or None." },
- { "block_for_pc", pspy_block_for_pc, METH_VARARGS,
- "Return the block containing the given pc value, or None." },
- { "find_pc_line", pspy_find_pc_line, METH_VARARGS,
- "find_pc_line (pc) -> Symtab_and_line.\n\
- Return the gdb.Symtab_and_line object corresponding to the pc value." },
- { "is_valid", pspy_is_valid, METH_NOARGS,
- "is_valid () -> Boolean.\n\
- Return true if this program space is valid, false if not." },
- { NULL }
- };
- PyTypeObject pspace_object_type =
- {
- PyVarObject_HEAD_INIT (NULL, 0)
- "gdb.Progspace", /*tp_name*/
- sizeof (pspace_object), /*tp_basicsize*/
- 0, /*tp_itemsize*/
- pspy_dealloc, /*tp_dealloc*/
- 0, /*tp_print*/
- 0, /*tp_getattr*/
- 0, /*tp_setattr*/
- 0, /*tp_compare*/
- 0, /*tp_repr*/
- 0, /*tp_as_number*/
- 0, /*tp_as_sequence*/
- 0, /*tp_as_mapping*/
- 0, /*tp_hash */
- 0, /*tp_call*/
- 0, /*tp_str*/
- 0, /*tp_getattro*/
- 0, /*tp_setattro*/
- 0, /*tp_as_buffer*/
- Py_TPFLAGS_DEFAULT, /*tp_flags*/
- "GDB progspace object", /* tp_doc */
- 0, /* tp_traverse */
- 0, /* tp_clear */
- 0, /* tp_richcompare */
- 0, /* tp_weaklistoffset */
- 0, /* tp_iter */
- 0, /* tp_iternext */
- progspace_object_methods, /* tp_methods */
- 0, /* tp_members */
- pspace_getset, /* tp_getset */
- 0, /* tp_base */
- 0, /* tp_dict */
- 0, /* tp_descr_get */
- 0, /* tp_descr_set */
- offsetof (pspace_object, dict), /* tp_dictoffset */
- 0, /* tp_init */
- 0, /* tp_alloc */
- pspy_new, /* tp_new */
- };
|