mirror of
https://sourceware.org/git/binutils-gdb.git
synced 2024-12-11 11:23:35 +08:00
565 lines
15 KiB
C
565 lines
15 KiB
C
/* Python interface to symbol tables.
|
||
|
||
Copyright (C) 2008-2012 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 "charset.h"
|
||
#include "symtab.h"
|
||
#include "source.h"
|
||
#include "python-internal.h"
|
||
#include "objfiles.h"
|
||
|
||
typedef struct stpy_symtab_object {
|
||
PyObject_HEAD
|
||
/* The GDB Symbol table structure. */
|
||
struct symtab *symtab;
|
||
/* A symtab object is associated with an objfile, so keep track with
|
||
a doubly-linked list, rooted in the objfile. This allows
|
||
invalidation of the underlying struct symtab when the objfile is
|
||
deleted. */
|
||
struct stpy_symtab_object *prev;
|
||
struct stpy_symtab_object *next;
|
||
} symtab_object;
|
||
|
||
static PyTypeObject symtab_object_type;
|
||
static const struct objfile_data *stpy_objfile_data_key;
|
||
|
||
/* Require a valid symbol table. All access to symtab_object->symtab
|
||
should be gated by this call. */
|
||
#define STPY_REQUIRE_VALID(symtab_obj, symtab) \
|
||
do { \
|
||
symtab = symtab_object_to_symtab (symtab_obj); \
|
||
if (symtab == NULL) \
|
||
{ \
|
||
PyErr_SetString (PyExc_RuntimeError, \
|
||
_("Symbol Table is invalid.")); \
|
||
return NULL; \
|
||
} \
|
||
} while (0)
|
||
|
||
typedef struct salpy_sal_object {
|
||
PyObject_HEAD
|
||
/* The GDB Symbol table structure. */
|
||
symtab_object *symtab;
|
||
/* The GDB Symbol table and line structure. */
|
||
struct symtab_and_line *sal;
|
||
/* A Symtab and line object is associated with an objfile, so keep
|
||
track with a doubly-linked list, rooted in the objfile. This
|
||
allows invalidation of the underlying struct symtab_and_line
|
||
when the objfile is deleted. */
|
||
struct salpy_sal_object *prev;
|
||
struct salpy_sal_object *next;
|
||
} sal_object;
|
||
|
||
static PyTypeObject sal_object_type;
|
||
static const struct objfile_data *salpy_objfile_data_key;
|
||
|
||
/* Require a valid symbol table and line object. All access to
|
||
sal_object->sal should be gated by this call. */
|
||
#define SALPY_REQUIRE_VALID(sal_obj, sal) \
|
||
do { \
|
||
sal = sal_object_to_symtab_and_line (sal_obj); \
|
||
if (sal == NULL) \
|
||
{ \
|
||
PyErr_SetString (PyExc_RuntimeError, \
|
||
_("Symbol Table and Line is invalid.")); \
|
||
return NULL; \
|
||
} \
|
||
} while (0)
|
||
|
||
static PyObject *
|
||
stpy_str (PyObject *self)
|
||
{
|
||
PyObject *result;
|
||
struct symtab *symtab = NULL;
|
||
|
||
STPY_REQUIRE_VALID (self, symtab);
|
||
|
||
result = PyString_FromString (symtab->filename);
|
||
|
||
return result;
|
||
}
|
||
|
||
static PyObject *
|
||
stpy_get_filename (PyObject *self, void *closure)
|
||
{
|
||
PyObject *str_obj;
|
||
struct symtab *symtab = NULL;
|
||
|
||
STPY_REQUIRE_VALID (self, symtab);
|
||
|
||
str_obj = PyString_Decode (symtab->filename,
|
||
strlen (symtab->filename),
|
||
host_charset (), NULL);
|
||
return str_obj;
|
||
}
|
||
|
||
static PyObject *
|
||
stpy_get_objfile (PyObject *self, void *closure)
|
||
{
|
||
struct symtab *symtab = NULL;
|
||
PyObject *result;
|
||
|
||
STPY_REQUIRE_VALID (self, symtab);
|
||
|
||
result = objfile_to_objfile_object (symtab->objfile);
|
||
Py_XINCREF (result);
|
||
return result;
|
||
}
|
||
|
||
static PyObject *
|
||
stpy_fullname (PyObject *self, PyObject *args)
|
||
{
|
||
char *fullname;
|
||
struct symtab *symtab = NULL;
|
||
|
||
STPY_REQUIRE_VALID (self, symtab);
|
||
|
||
fullname = symtab_to_fullname (symtab);
|
||
if (fullname)
|
||
return PyString_Decode (fullname, strlen (fullname),
|
||
host_charset (), NULL);
|
||
|
||
Py_RETURN_NONE;
|
||
}
|
||
|
||
/* Implementation of gdb.Symtab.is_valid (self) -> Boolean.
|
||
Returns True if this Symbol table still exists in GDB. */
|
||
|
||
static PyObject *
|
||
stpy_is_valid (PyObject *self, PyObject *args)
|
||
{
|
||
struct symtab *symtab = NULL;
|
||
|
||
symtab = symtab_object_to_symtab (self);
|
||
if (symtab == NULL)
|
||
Py_RETURN_FALSE;
|
||
|
||
Py_RETURN_TRUE;
|
||
}
|
||
|
||
static PyObject *
|
||
salpy_str (PyObject *self)
|
||
{
|
||
char *s, *filename;
|
||
sal_object *sal_obj;
|
||
PyObject *result;
|
||
struct symtab_and_line *sal = NULL;
|
||
|
||
SALPY_REQUIRE_VALID (self, sal);
|
||
|
||
sal_obj = (sal_object *) self;
|
||
filename = (sal_obj->symtab == (symtab_object *) Py_None)
|
||
? "<unknown>" : sal_obj->symtab->symtab->filename;
|
||
|
||
s = xstrprintf ("symbol and line for %s, line %d", filename,
|
||
sal->line);
|
||
|
||
result = PyString_FromString (s);
|
||
xfree (s);
|
||
|
||
return result;
|
||
}
|
||
|
||
static void
|
||
stpy_dealloc (PyObject *obj)
|
||
{
|
||
symtab_object *symtab = (symtab_object *) obj;
|
||
|
||
if (symtab->prev)
|
||
symtab->prev->next = symtab->next;
|
||
else if (symtab->symtab)
|
||
{
|
||
set_objfile_data (symtab->symtab->objfile,
|
||
stpy_objfile_data_key, symtab->next);
|
||
}
|
||
if (symtab->next)
|
||
symtab->next->prev = symtab->prev;
|
||
symtab->symtab = NULL;
|
||
}
|
||
|
||
|
||
static PyObject *
|
||
salpy_get_pc (PyObject *self, void *closure)
|
||
{
|
||
struct symtab_and_line *sal = NULL;
|
||
|
||
SALPY_REQUIRE_VALID (self, sal);
|
||
|
||
return gdb_py_long_from_ulongest (sal->pc);
|
||
}
|
||
|
||
static PyObject *
|
||
salpy_get_line (PyObject *self, void *closure)
|
||
{
|
||
struct symtab_and_line *sal = NULL;
|
||
|
||
SALPY_REQUIRE_VALID (self, sal);
|
||
|
||
return PyInt_FromLong (sal->line);
|
||
}
|
||
|
||
static PyObject *
|
||
salpy_get_symtab (PyObject *self, void *closure)
|
||
{
|
||
struct symtab_and_line *sal;
|
||
sal_object *self_sal = (sal_object *) self;
|
||
|
||
SALPY_REQUIRE_VALID (self, sal);
|
||
|
||
Py_INCREF (self_sal->symtab);
|
||
|
||
return (PyObject *) self_sal->symtab;
|
||
}
|
||
|
||
/* Implementation of gdb.Symtab_and_line.is_valid (self) -> Boolean.
|
||
Returns True if this Symbol table and line object still exists GDB. */
|
||
|
||
static PyObject *
|
||
salpy_is_valid (PyObject *self, PyObject *args)
|
||
{
|
||
struct symtab_and_line *sal;
|
||
|
||
sal = sal_object_to_symtab_and_line (self);
|
||
if (sal == NULL)
|
||
Py_RETURN_FALSE;
|
||
|
||
Py_RETURN_TRUE;
|
||
}
|
||
|
||
static void
|
||
salpy_dealloc (PyObject *self)
|
||
{
|
||
sal_object *self_sal = (sal_object *) self;
|
||
|
||
if (self_sal->prev)
|
||
self_sal->prev->next = self_sal->next;
|
||
else if (self_sal->symtab != (symtab_object * ) Py_None)
|
||
set_objfile_data (self_sal->symtab->symtab->objfile,
|
||
salpy_objfile_data_key, self_sal->next);
|
||
|
||
if (self_sal->next)
|
||
self_sal->next->prev = self_sal->prev;
|
||
|
||
Py_DECREF (self_sal->symtab);
|
||
xfree (self_sal->sal);
|
||
self_sal->ob_type->tp_free (self);
|
||
}
|
||
|
||
/* Given a sal, and a sal_object that has previously been allocated
|
||
and initialized, populate the sal_object with the struct sal data.
|
||
Also, register the sal_object life-cycle with the life-cycle of the
|
||
object file associated with this sal, if needed. If a failure
|
||
occurs during the sal population, this function will return
|
||
NULL. */
|
||
static int
|
||
set_sal (sal_object *sal_obj, struct symtab_and_line sal)
|
||
{
|
||
symtab_object *symtab_obj;
|
||
|
||
if (sal.symtab)
|
||
{
|
||
symtab_obj = (symtab_object *) symtab_to_symtab_object (sal.symtab);
|
||
/* If a symtab existed in the sal, but it cannot be duplicated,
|
||
we exit. */
|
||
if (symtab_obj == NULL)
|
||
return 0;
|
||
}
|
||
else
|
||
{
|
||
symtab_obj = (symtab_object *) Py_None;
|
||
Py_INCREF (Py_None);
|
||
}
|
||
|
||
sal_obj->sal = xmemdup (&sal, sizeof (struct symtab_and_line),
|
||
sizeof (struct symtab_and_line));
|
||
sal_obj->symtab = symtab_obj;
|
||
sal_obj->prev = NULL;
|
||
|
||
/* If the SAL does not have a symtab, we do not add it to the
|
||
objfile cleanup observer linked list. */
|
||
if (sal_obj->symtab != (symtab_object *)Py_None)
|
||
{
|
||
sal_obj->next = objfile_data (sal_obj->symtab->symtab->objfile,
|
||
salpy_objfile_data_key);
|
||
if (sal_obj->next)
|
||
sal_obj->next->prev = sal_obj;
|
||
|
||
set_objfile_data (sal_obj->symtab->symtab->objfile,
|
||
salpy_objfile_data_key, sal_obj);
|
||
}
|
||
else
|
||
sal_obj->next = NULL;
|
||
|
||
return 1;
|
||
}
|
||
|
||
/* Given a symtab, and a symtab_object that has previously been
|
||
allocated and initialized, populate the symtab_object with the
|
||
struct symtab data. Also, register the symtab_object life-cycle
|
||
with the life-cycle of the object file associated with this
|
||
symtab, if needed. */
|
||
static void
|
||
set_symtab (symtab_object *obj, struct symtab *symtab)
|
||
{
|
||
obj->symtab = symtab;
|
||
obj->prev = NULL;
|
||
if (symtab)
|
||
{
|
||
obj->next = objfile_data (symtab->objfile, stpy_objfile_data_key);
|
||
if (obj->next)
|
||
obj->next->prev = obj;
|
||
set_objfile_data (symtab->objfile, stpy_objfile_data_key, obj);
|
||
}
|
||
else
|
||
obj->next = NULL;
|
||
}
|
||
|
||
/* Create a new symbol table (gdb.Symtab) object that encapsulates the
|
||
symtab structure from GDB. */
|
||
PyObject *
|
||
symtab_to_symtab_object (struct symtab *symtab)
|
||
{
|
||
symtab_object *symtab_obj;
|
||
|
||
symtab_obj = PyObject_New (symtab_object, &symtab_object_type);
|
||
if (symtab_obj)
|
||
set_symtab (symtab_obj, symtab);
|
||
|
||
return (PyObject *) symtab_obj;
|
||
}
|
||
|
||
/* Create a new symtab and line (gdb.Symtab_and_line) object
|
||
that encapsulates the symtab_and_line structure from GDB. */
|
||
PyObject *
|
||
symtab_and_line_to_sal_object (struct symtab_and_line sal)
|
||
|
||
{
|
||
sal_object *sal_obj;
|
||
int success = 0;
|
||
|
||
sal_obj = PyObject_New (sal_object, &sal_object_type);
|
||
if (sal_obj)
|
||
{
|
||
success = set_sal (sal_obj, sal);
|
||
if (!success)
|
||
{
|
||
Py_DECREF (sal_obj);
|
||
return NULL;
|
||
}
|
||
}
|
||
|
||
return (PyObject *) sal_obj;
|
||
}
|
||
|
||
/* Return struct symtab_and_line reference that is wrapped by this
|
||
object. */
|
||
struct symtab_and_line *
|
||
sal_object_to_symtab_and_line (PyObject *obj)
|
||
{
|
||
if (! PyObject_TypeCheck (obj, &sal_object_type))
|
||
return NULL;
|
||
return ((sal_object *) obj)->sal;
|
||
}
|
||
|
||
/* Return struct symtab reference that is wrapped by this object. */
|
||
struct symtab *
|
||
symtab_object_to_symtab (PyObject *obj)
|
||
{
|
||
if (! PyObject_TypeCheck (obj, &symtab_object_type))
|
||
return NULL;
|
||
return ((symtab_object *) obj)->symtab;
|
||
}
|
||
|
||
/* This function is called when an objfile is about to be freed.
|
||
Invalidate the symbol table as further actions on the symbol table
|
||
would result in bad data. All access to obj->symtab should be
|
||
gated by STPY_REQUIRE_VALID which will raise an exception on
|
||
invalid symbol tables. */
|
||
static void
|
||
del_objfile_symtab (struct objfile *objfile, void *datum)
|
||
{
|
||
symtab_object *obj = datum;
|
||
|
||
while (obj)
|
||
{
|
||
symtab_object *next = obj->next;
|
||
|
||
obj->symtab = NULL;
|
||
obj->next = NULL;
|
||
obj->prev = NULL;
|
||
obj = next;
|
||
}
|
||
}
|
||
|
||
/* This function is called when an objfile is about to be freed.
|
||
Invalidate the sal object as further actions on the sal
|
||
would result in bad data. All access to obj->sal should be
|
||
gated by SALPY_REQUIRE_VALID which will raise an exception on
|
||
invalid symbol table and line objects. */
|
||
static void
|
||
del_objfile_sal (struct objfile *objfile, void *datum)
|
||
{
|
||
sal_object *obj = datum;
|
||
|
||
while (obj)
|
||
{
|
||
sal_object *next = obj->next;
|
||
|
||
obj->symtab = NULL;
|
||
obj->next = NULL;
|
||
obj->prev = NULL;
|
||
xfree (obj->sal);
|
||
obj->sal = NULL;
|
||
|
||
obj = next;
|
||
}
|
||
}
|
||
|
||
void
|
||
gdbpy_initialize_symtabs (void)
|
||
{
|
||
symtab_object_type.tp_new = PyType_GenericNew;
|
||
if (PyType_Ready (&symtab_object_type) < 0)
|
||
return;
|
||
|
||
sal_object_type.tp_new = PyType_GenericNew;
|
||
if (PyType_Ready (&sal_object_type) < 0)
|
||
return;
|
||
|
||
/* Register an objfile "free" callback so we can properly
|
||
invalidate symbol tables, and symbol table and line data
|
||
structures when an object file that is about to be
|
||
deleted. */
|
||
stpy_objfile_data_key
|
||
= register_objfile_data_with_cleanup (NULL, del_objfile_symtab);
|
||
salpy_objfile_data_key
|
||
= register_objfile_data_with_cleanup (NULL, del_objfile_sal);
|
||
|
||
Py_INCREF (&symtab_object_type);
|
||
PyModule_AddObject (gdb_module, "Symtab",
|
||
(PyObject *) &symtab_object_type);
|
||
|
||
Py_INCREF (&sal_object_type);
|
||
PyModule_AddObject (gdb_module, "Symtab_and_line",
|
||
(PyObject *) &sal_object_type);
|
||
}
|
||
|
||
|
||
|
||
static PyGetSetDef symtab_object_getset[] = {
|
||
{ "filename", stpy_get_filename, NULL,
|
||
"The symbol table's source filename.", NULL },
|
||
{ "objfile", stpy_get_objfile, NULL, "The symtab's objfile.",
|
||
NULL },
|
||
{NULL} /* Sentinel */
|
||
};
|
||
|
||
static PyMethodDef symtab_object_methods[] = {
|
||
{ "is_valid", stpy_is_valid, METH_NOARGS,
|
||
"is_valid () -> Boolean.\n\
|
||
Return true if this symbol table is valid, false if not." },
|
||
{ "fullname", stpy_fullname, METH_NOARGS,
|
||
"fullname () -> String.\n\
|
||
Return the symtab's full source filename." },
|
||
{NULL} /* Sentinel */
|
||
};
|
||
|
||
static PyTypeObject symtab_object_type = {
|
||
PyObject_HEAD_INIT (NULL)
|
||
0, /*ob_size*/
|
||
"gdb.Symtab", /*tp_name*/
|
||
sizeof (symtab_object), /*tp_basicsize*/
|
||
0, /*tp_itemsize*/
|
||
stpy_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*/
|
||
stpy_str, /*tp_str*/
|
||
0, /*tp_getattro*/
|
||
0, /*tp_setattro*/
|
||
0, /*tp_as_buffer*/
|
||
Py_TPFLAGS_DEFAULT, /*tp_flags*/
|
||
"GDB symtab object", /*tp_doc */
|
||
0, /*tp_traverse */
|
||
0, /*tp_clear */
|
||
0, /*tp_richcompare */
|
||
0, /*tp_weaklistoffset */
|
||
0, /*tp_iter */
|
||
0, /*tp_iternext */
|
||
symtab_object_methods, /*tp_methods */
|
||
0, /*tp_members */
|
||
symtab_object_getset /*tp_getset */
|
||
};
|
||
|
||
static PyGetSetDef sal_object_getset[] = {
|
||
{ "symtab", salpy_get_symtab, NULL, "Symtab object.", NULL },
|
||
{ "pc", salpy_get_pc, NULL, "Return the symtab_and_line's pc.", NULL },
|
||
{ "line", salpy_get_line, NULL,
|
||
"Return the symtab_and_line's line.", NULL },
|
||
{NULL} /* Sentinel */
|
||
};
|
||
|
||
static PyMethodDef sal_object_methods[] = {
|
||
{ "is_valid", salpy_is_valid, METH_NOARGS,
|
||
"is_valid () -> Boolean.\n\
|
||
Return true if this symbol table and line is valid, false if not." },
|
||
{NULL} /* Sentinel */
|
||
};
|
||
|
||
static PyTypeObject sal_object_type = {
|
||
PyObject_HEAD_INIT (NULL)
|
||
0, /*ob_size*/
|
||
"gdb.Symtab_and_line", /*tp_name*/
|
||
sizeof (sal_object), /*tp_basicsize*/
|
||
0, /*tp_itemsize*/
|
||
salpy_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*/
|
||
salpy_str, /*tp_str*/
|
||
0, /*tp_getattro*/
|
||
0, /*tp_setattro*/
|
||
0, /*tp_as_buffer*/
|
||
Py_TPFLAGS_DEFAULT, /*tp_flags*/
|
||
"GDB symtab_and_line object", /*tp_doc */
|
||
0, /*tp_traverse */
|
||
0, /*tp_clear */
|
||
0, /*tp_richcompare */
|
||
0, /*tp_weaklistoffset */
|
||
0, /*tp_iter */
|
||
0, /*tp_iternext */
|
||
sal_object_methods, /*tp_methods */
|
||
0, /*tp_members */
|
||
sal_object_getset /*tp_getset */
|
||
};
|