1 /* Python interface to objfiles.
3 Copyright (C) 2008-2018 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/>. */
21 #include "python-internal.h"
33 /* The corresponding objfile. */
34 struct objfile *objfile;
36 /* Dictionary holding user-added attributes.
37 This is the __dict__ attribute of the object. */
40 /* The pretty-printer list of functions. */
43 /* The frame filter list of functions. */
44 PyObject *frame_filters;
46 /* The list of frame unwinders. */
47 PyObject *frame_unwinders;
49 /* The type-printer list. */
50 PyObject *type_printers;
52 /* The debug method matcher list. */
56 extern PyTypeObject objfile_object_type
57 CPYCHECKER_TYPE_OBJECT_FOR_TYPEDEF ("objfile_object");
59 static const struct objfile_data *objfpy_objfile_data_key;
61 /* Require that OBJF be a valid objfile. */
62 #define OBJFPY_REQUIRE_VALID(obj) \
64 if (!(obj)->objfile) \
66 PyErr_SetString (PyExc_RuntimeError, \
67 _("Objfile no longer exists.")); \
74 /* An Objfile method which returns the objfile's file name, or None. */
77 objfpy_get_filename (PyObject *self, void *closure)
79 objfile_object *obj = (objfile_object *) self;
82 return (host_string_to_python_string (objfile_name (obj->objfile))
87 /* An Objfile method which returns the objfile's file name, as specified
88 by the user, or None. */
91 objfpy_get_username (PyObject *self, void *closure)
93 objfile_object *obj = (objfile_object *) self;
97 const char *username = obj->objfile->original_name;
99 return host_string_to_python_string (username).release ();
105 /* If SELF is a separate debug-info file, return the "backlink" field.
106 Otherwise return None. */
109 objfpy_get_owner (PyObject *self, void *closure)
111 objfile_object *obj = (objfile_object *) self;
112 struct objfile *objfile = obj->objfile;
113 struct objfile *owner;
115 OBJFPY_REQUIRE_VALID (obj);
117 owner = objfile->separate_debug_objfile_backlink;
119 return objfile_to_objfile_object (owner).release ();
123 /* An Objfile method which returns the objfile's build id, or None. */
126 objfpy_get_build_id (PyObject *self, void *closure)
128 objfile_object *obj = (objfile_object *) self;
129 struct objfile *objfile = obj->objfile;
130 const struct bfd_build_id *build_id = NULL;
132 OBJFPY_REQUIRE_VALID (obj);
136 build_id = build_id_bfd_get (objfile->obfd);
138 CATCH (except, RETURN_MASK_ALL)
140 GDB_PY_HANDLE_EXCEPTION (except);
144 if (build_id != NULL)
146 char *hex_form = make_hex_string (build_id->data, build_id->size);
149 result = host_string_to_python_string (hex_form).release ();
157 /* An Objfile method which returns the objfile's progspace, or None. */
160 objfpy_get_progspace (PyObject *self, void *closure)
162 objfile_object *obj = (objfile_object *) self;
165 return pspace_to_pspace_object (obj->objfile->pspace).release ();
171 objfpy_dealloc (PyObject *o)
173 objfile_object *self = (objfile_object *) o;
175 Py_XDECREF (self->dict);
176 Py_XDECREF (self->printers);
177 Py_XDECREF (self->frame_filters);
178 Py_XDECREF (self->frame_unwinders);
179 Py_XDECREF (self->type_printers);
180 Py_XDECREF (self->xmethods);
181 Py_TYPE (self)->tp_free (self);
184 /* Initialize an objfile_object.
185 The result is a boolean indicating success. */
188 objfpy_initialize (objfile_object *self)
190 self->objfile = NULL;
192 self->dict = PyDict_New ();
193 if (self->dict == NULL)
196 self->printers = PyList_New (0);
197 if (self->printers == NULL)
200 self->frame_filters = PyDict_New ();
201 if (self->frame_filters == NULL)
204 self->frame_unwinders = PyList_New (0);
205 if (self->frame_unwinders == NULL)
208 self->type_printers = PyList_New (0);
209 if (self->type_printers == NULL)
212 self->xmethods = PyList_New (0);
213 if (self->xmethods == NULL)
220 objfpy_new (PyTypeObject *type, PyObject *args, PyObject *keywords)
222 gdbpy_ref<objfile_object> self ((objfile_object *) type->tp_alloc (type, 0));
226 if (!objfpy_initialize (self.get ()))
230 return (PyObject *) self.release ();
234 objfpy_get_printers (PyObject *o, void *ignore)
236 objfile_object *self = (objfile_object *) o;
238 Py_INCREF (self->printers);
239 return self->printers;
243 objfpy_set_printers (PyObject *o, PyObject *value, void *ignore)
246 objfile_object *self = (objfile_object *) o;
250 PyErr_SetString (PyExc_TypeError,
251 _("Cannot delete the pretty_printers attribute."));
255 if (! PyList_Check (value))
257 PyErr_SetString (PyExc_TypeError,
258 _("The pretty_printers attribute must be a list."));
262 /* Take care in case the LHS and RHS are related somehow. */
263 tmp = self->printers;
265 self->printers = value;
271 /* Return the Python dictionary attribute containing frame filters for
274 objfpy_get_frame_filters (PyObject *o, void *ignore)
276 objfile_object *self = (objfile_object *) o;
278 Py_INCREF (self->frame_filters);
279 return self->frame_filters;
282 /* Set this object file's frame filters dictionary to FILTERS. */
284 objfpy_set_frame_filters (PyObject *o, PyObject *filters, void *ignore)
287 objfile_object *self = (objfile_object *) o;
291 PyErr_SetString (PyExc_TypeError,
292 _("Cannot delete the frame filters attribute."));
296 if (! PyDict_Check (filters))
298 PyErr_SetString (PyExc_TypeError,
299 _("The frame_filters attribute must be a dictionary."));
303 /* Take care in case the LHS and RHS are related somehow. */
304 tmp = self->frame_filters;
306 self->frame_filters = filters;
312 /* Return the frame unwinders attribute for this object file. */
315 objfpy_get_frame_unwinders (PyObject *o, void *ignore)
317 objfile_object *self = (objfile_object *) o;
319 Py_INCREF (self->frame_unwinders);
320 return self->frame_unwinders;
323 /* Set this object file's frame unwinders list to UNWINDERS. */
326 objfpy_set_frame_unwinders (PyObject *o, PyObject *unwinders, void *ignore)
329 objfile_object *self = (objfile_object *) o;
333 PyErr_SetString (PyExc_TypeError,
334 _("Cannot delete the frame unwinders attribute."));
338 if (!PyList_Check (unwinders))
340 PyErr_SetString (PyExc_TypeError,
341 _("The frame_unwinders attribute must be a list."));
345 /* Take care in case the LHS and RHS are related somehow. */
346 tmp = self->frame_unwinders;
347 Py_INCREF (unwinders);
348 self->frame_unwinders = unwinders;
354 /* Get the 'type_printers' attribute. */
357 objfpy_get_type_printers (PyObject *o, void *ignore)
359 objfile_object *self = (objfile_object *) o;
361 Py_INCREF (self->type_printers);
362 return self->type_printers;
365 /* Get the 'xmethods' attribute. */
368 objfpy_get_xmethods (PyObject *o, void *ignore)
370 objfile_object *self = (objfile_object *) o;
372 Py_INCREF (self->xmethods);
373 return self->xmethods;
376 /* Set the 'type_printers' attribute. */
379 objfpy_set_type_printers (PyObject *o, PyObject *value, void *ignore)
382 objfile_object *self = (objfile_object *) o;
386 PyErr_SetString (PyExc_TypeError,
387 _("Cannot delete the type_printers attribute."));
391 if (! PyList_Check (value))
393 PyErr_SetString (PyExc_TypeError,
394 _("The type_printers attribute must be a list."));
398 /* Take care in case the LHS and RHS are related somehow. */
399 tmp = self->type_printers;
401 self->type_printers = value;
407 /* Implementation of gdb.Objfile.is_valid (self) -> Boolean.
408 Returns True if this object file still exists in GDB. */
411 objfpy_is_valid (PyObject *self, PyObject *args)
413 objfile_object *obj = (objfile_object *) self;
421 /* Implementation of gdb.Objfile.add_separate_debug_file (self) -> Boolean. */
424 objfpy_add_separate_debug_file (PyObject *self, PyObject *args, PyObject *kw)
426 static const char *keywords[] = { "file_name", NULL };
427 objfile_object *obj = (objfile_object *) self;
428 const char *file_name;
430 OBJFPY_REQUIRE_VALID (obj);
432 if (!gdb_PyArg_ParseTupleAndKeywords (args, kw, "s", keywords, &file_name))
437 gdb_bfd_ref_ptr abfd (symfile_bfd_open (file_name));
439 symbol_file_add_separate (abfd.get (), file_name, 0, obj->objfile);
441 CATCH (except, RETURN_MASK_ALL)
443 GDB_PY_HANDLE_EXCEPTION (except);
450 /* Implement repr() for gdb.Objfile. */
453 objfpy_repr (PyObject *self_)
455 objfile_object *self = (objfile_object *) self_;
456 objfile *obj = self->objfile;
459 return PyString_FromString ("<gdb.Objfile (invalid)>");
461 return PyString_FromFormat ("<gdb.Objfile filename=%s>",
462 objfile_filename (obj));
465 /* Subroutine of gdbpy_lookup_objfile_by_build_id to simplify it.
466 Return non-zero if STRING is a potentially valid build id. */
469 objfpy_build_id_ok (const char *string)
471 size_t i, n = strlen (string);
475 for (i = 0; i < n; ++i)
477 if (!isxdigit (string[i]))
483 /* Subroutine of gdbpy_lookup_objfile_by_build_id to simplify it.
484 Returns non-zero if BUILD_ID matches STRING.
485 It is assumed that objfpy_build_id_ok (string) returns TRUE. */
488 objfpy_build_id_matches (const struct bfd_build_id *build_id,
493 if (strlen (string) != 2 * build_id->size)
496 for (i = 0; i < build_id->size; ++i)
498 char c1 = string[i * 2], c2 = string[i * 2 + 1];
499 int byte = (host_hex_value (c1) << 4) | host_hex_value (c2);
501 if (byte != build_id->data[i])
508 /* Subroutine of gdbpy_lookup_objfile to simplify it.
509 Look up an objfile by its file name. */
511 static struct objfile *
512 objfpy_lookup_objfile_by_name (const char *name)
514 struct objfile *objfile;
516 ALL_OBJFILES (objfile)
518 const char *filename;
520 if ((objfile->flags & OBJF_NOT_FILENAME) != 0)
522 /* Don't return separate debug files. */
523 if (objfile->separate_debug_objfile_backlink != NULL)
526 filename = objfile_filename (objfile);
527 if (filename != NULL && compare_filenames_for_search (filename, name))
529 if (compare_filenames_for_search (objfile->original_name, name))
536 /* Subroutine of gdbpy_lookup_objfile to simplify it.
537 Look up an objfile by its build id. */
539 static struct objfile *
540 objfpy_lookup_objfile_by_build_id (const char *build_id)
542 struct objfile *objfile;
544 ALL_OBJFILES (objfile)
546 const struct bfd_build_id *obfd_build_id;
548 if (objfile->obfd == NULL)
550 /* Don't return separate debug files. */
551 if (objfile->separate_debug_objfile_backlink != NULL)
553 obfd_build_id = build_id_bfd_get (objfile->obfd);
554 if (obfd_build_id == NULL)
556 if (objfpy_build_id_matches (obfd_build_id, build_id))
563 /* Implementation of gdb.lookup_objfile. */
566 gdbpy_lookup_objfile (PyObject *self, PyObject *args, PyObject *kw)
568 static const char *keywords[] = { "name", "by_build_id", NULL };
570 PyObject *by_build_id_obj = NULL;
572 struct objfile *objfile;
574 if (!gdb_PyArg_ParseTupleAndKeywords (args, kw, "s|O!", keywords,
575 &name, &PyBool_Type, &by_build_id_obj))
579 if (by_build_id_obj != NULL)
581 int cmp = PyObject_IsTrue (by_build_id_obj);
590 if (!objfpy_build_id_ok (name))
592 PyErr_SetString (PyExc_TypeError, _("Not a valid build id."));
595 objfile = objfpy_lookup_objfile_by_build_id (name);
598 objfile = objfpy_lookup_objfile_by_name (name);
601 return objfile_to_objfile_object (objfile).release ();
603 PyErr_SetString (PyExc_ValueError, _("Objfile not found."));
609 /* Clear the OBJFILE pointer in an Objfile object and remove the
612 py_free_objfile (struct objfile *objfile, void *datum)
614 gdbpy_enter enter_py (get_objfile_arch (objfile), current_language);
615 gdbpy_ref<objfile_object> object ((objfile_object *) datum);
616 object->objfile = NULL;
619 /* Return a new reference to the Python object of type Objfile
620 representing OBJFILE. If the object has already been created,
621 return it. Otherwise, create it. Return NULL and set the Python
625 objfile_to_objfile_object (struct objfile *objfile)
628 = ((PyObject *) objfile_data (objfile, objfpy_objfile_data_key));
631 gdbpy_ref<objfile_object> object
632 ((objfile_object *) PyObject_New (objfile_object, &objfile_object_type));
635 if (!objfpy_initialize (object.get ()))
638 object->objfile = objfile;
639 set_objfile_data (objfile, objfpy_objfile_data_key, object.get ());
640 result = (PyObject *) object.release ();
643 return gdbpy_ref<>::new_reference (result);
647 gdbpy_initialize_objfile (void)
649 objfpy_objfile_data_key
650 = register_objfile_data_with_cleanup (NULL, py_free_objfile);
652 if (PyType_Ready (&objfile_object_type) < 0)
655 return gdb_pymodule_addobject (gdb_module, "Objfile",
656 (PyObject *) &objfile_object_type);
661 static PyMethodDef objfile_object_methods[] =
663 { "is_valid", objfpy_is_valid, METH_NOARGS,
664 "is_valid () -> Boolean.\n\
665 Return true if this object file is valid, false if not." },
667 { "add_separate_debug_file", (PyCFunction) objfpy_add_separate_debug_file,
668 METH_VARARGS | METH_KEYWORDS,
669 "add_separate_debug_file (file_name).\n\
670 Add FILE_NAME to the list of files containing debug info for the objfile." },
675 static gdb_PyGetSetDef objfile_getset[] =
677 { "__dict__", gdb_py_generic_dict, NULL,
678 "The __dict__ for this objfile.", &objfile_object_type },
679 { "filename", objfpy_get_filename, NULL,
680 "The objfile's filename, or None.", NULL },
681 { "username", objfpy_get_username, NULL,
682 "The name of the objfile as provided by the user, or None.", NULL },
683 { "owner", objfpy_get_owner, NULL,
684 "The objfile owner of separate debug info objfiles, or None.",
686 { "build_id", objfpy_get_build_id, NULL,
687 "The objfile's build id, or None.", NULL },
688 { "progspace", objfpy_get_progspace, NULL,
689 "The objfile's progspace, or None.", NULL },
690 { "pretty_printers", objfpy_get_printers, objfpy_set_printers,
691 "Pretty printers.", NULL },
692 { "frame_filters", objfpy_get_frame_filters,
693 objfpy_set_frame_filters, "Frame Filters.", NULL },
694 { "frame_unwinders", objfpy_get_frame_unwinders,
695 objfpy_set_frame_unwinders, "Frame Unwinders", NULL },
696 { "type_printers", objfpy_get_type_printers, objfpy_set_type_printers,
697 "Type printers.", NULL },
698 { "xmethods", objfpy_get_xmethods, NULL,
699 "Debug methods.", NULL },
703 PyTypeObject objfile_object_type =
705 PyVarObject_HEAD_INIT (NULL, 0)
706 "gdb.Objfile", /*tp_name*/
707 sizeof (objfile_object), /*tp_basicsize*/
709 objfpy_dealloc, /*tp_dealloc*/
714 objfpy_repr, /*tp_repr*/
716 0, /*tp_as_sequence*/
724 Py_TPFLAGS_DEFAULT, /*tp_flags*/
725 "GDB objfile object", /* tp_doc */
728 0, /* tp_richcompare */
729 0, /* tp_weaklistoffset */
732 objfile_object_methods, /* tp_methods */
734 objfile_getset, /* tp_getset */
737 0, /* tp_descr_get */
738 0, /* tp_descr_set */
739 offsetof (objfile_object, dict), /* tp_dictoffset */
742 objfpy_new, /* tp_new */