1 /* Python interface to objfiles.
3 Copyright (C) 2008-2019 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 gdb::unique_xmalloc_ptr
<char> hex_form
147 (make_hex_string (build_id
->data
, build_id
->size
));
149 return host_string_to_python_string (hex_form
.get ()).release ();
155 /* An Objfile method which returns the objfile's progspace, or None. */
158 objfpy_get_progspace (PyObject
*self
, void *closure
)
160 objfile_object
*obj
= (objfile_object
*) self
;
163 return pspace_to_pspace_object (obj
->objfile
->pspace
).release ();
169 objfpy_dealloc (PyObject
*o
)
171 objfile_object
*self
= (objfile_object
*) o
;
173 Py_XDECREF (self
->dict
);
174 Py_XDECREF (self
->printers
);
175 Py_XDECREF (self
->frame_filters
);
176 Py_XDECREF (self
->frame_unwinders
);
177 Py_XDECREF (self
->type_printers
);
178 Py_XDECREF (self
->xmethods
);
179 Py_TYPE (self
)->tp_free (self
);
182 /* Initialize an objfile_object.
183 The result is a boolean indicating success. */
186 objfpy_initialize (objfile_object
*self
)
188 self
->objfile
= NULL
;
190 self
->dict
= PyDict_New ();
191 if (self
->dict
== NULL
)
194 self
->printers
= PyList_New (0);
195 if (self
->printers
== NULL
)
198 self
->frame_filters
= PyDict_New ();
199 if (self
->frame_filters
== NULL
)
202 self
->frame_unwinders
= PyList_New (0);
203 if (self
->frame_unwinders
== NULL
)
206 self
->type_printers
= PyList_New (0);
207 if (self
->type_printers
== NULL
)
210 self
->xmethods
= PyList_New (0);
211 if (self
->xmethods
== NULL
)
218 objfpy_new (PyTypeObject
*type
, PyObject
*args
, PyObject
*keywords
)
220 gdbpy_ref
<objfile_object
> self ((objfile_object
*) type
->tp_alloc (type
, 0));
224 if (!objfpy_initialize (self
.get ()))
228 return (PyObject
*) self
.release ();
232 objfpy_get_printers (PyObject
*o
, void *ignore
)
234 objfile_object
*self
= (objfile_object
*) o
;
236 Py_INCREF (self
->printers
);
237 return self
->printers
;
241 objfpy_set_printers (PyObject
*o
, PyObject
*value
, void *ignore
)
244 objfile_object
*self
= (objfile_object
*) o
;
248 PyErr_SetString (PyExc_TypeError
,
249 _("Cannot delete the pretty_printers attribute."));
253 if (! PyList_Check (value
))
255 PyErr_SetString (PyExc_TypeError
,
256 _("The pretty_printers attribute must be a list."));
260 /* Take care in case the LHS and RHS are related somehow. */
261 tmp
= self
->printers
;
263 self
->printers
= value
;
269 /* Return the Python dictionary attribute containing frame filters for
272 objfpy_get_frame_filters (PyObject
*o
, void *ignore
)
274 objfile_object
*self
= (objfile_object
*) o
;
276 Py_INCREF (self
->frame_filters
);
277 return self
->frame_filters
;
280 /* Set this object file's frame filters dictionary to FILTERS. */
282 objfpy_set_frame_filters (PyObject
*o
, PyObject
*filters
, void *ignore
)
285 objfile_object
*self
= (objfile_object
*) o
;
289 PyErr_SetString (PyExc_TypeError
,
290 _("Cannot delete the frame filters attribute."));
294 if (! PyDict_Check (filters
))
296 PyErr_SetString (PyExc_TypeError
,
297 _("The frame_filters attribute must be a dictionary."));
301 /* Take care in case the LHS and RHS are related somehow. */
302 tmp
= self
->frame_filters
;
304 self
->frame_filters
= filters
;
310 /* Return the frame unwinders attribute for this object file. */
313 objfpy_get_frame_unwinders (PyObject
*o
, void *ignore
)
315 objfile_object
*self
= (objfile_object
*) o
;
317 Py_INCREF (self
->frame_unwinders
);
318 return self
->frame_unwinders
;
321 /* Set this object file's frame unwinders list to UNWINDERS. */
324 objfpy_set_frame_unwinders (PyObject
*o
, PyObject
*unwinders
, void *ignore
)
327 objfile_object
*self
= (objfile_object
*) o
;
331 PyErr_SetString (PyExc_TypeError
,
332 _("Cannot delete the frame unwinders attribute."));
336 if (!PyList_Check (unwinders
))
338 PyErr_SetString (PyExc_TypeError
,
339 _("The frame_unwinders attribute must be a list."));
343 /* Take care in case the LHS and RHS are related somehow. */
344 tmp
= self
->frame_unwinders
;
345 Py_INCREF (unwinders
);
346 self
->frame_unwinders
= unwinders
;
352 /* Get the 'type_printers' attribute. */
355 objfpy_get_type_printers (PyObject
*o
, void *ignore
)
357 objfile_object
*self
= (objfile_object
*) o
;
359 Py_INCREF (self
->type_printers
);
360 return self
->type_printers
;
363 /* Get the 'xmethods' attribute. */
366 objfpy_get_xmethods (PyObject
*o
, void *ignore
)
368 objfile_object
*self
= (objfile_object
*) o
;
370 Py_INCREF (self
->xmethods
);
371 return self
->xmethods
;
374 /* Set the 'type_printers' attribute. */
377 objfpy_set_type_printers (PyObject
*o
, PyObject
*value
, void *ignore
)
380 objfile_object
*self
= (objfile_object
*) o
;
384 PyErr_SetString (PyExc_TypeError
,
385 _("Cannot delete the type_printers attribute."));
389 if (! PyList_Check (value
))
391 PyErr_SetString (PyExc_TypeError
,
392 _("The type_printers attribute must be a list."));
396 /* Take care in case the LHS and RHS are related somehow. */
397 tmp
= self
->type_printers
;
399 self
->type_printers
= value
;
405 /* Implementation of gdb.Objfile.is_valid (self) -> Boolean.
406 Returns True if this object file still exists in GDB. */
409 objfpy_is_valid (PyObject
*self
, PyObject
*args
)
411 objfile_object
*obj
= (objfile_object
*) self
;
419 /* Implementation of gdb.Objfile.add_separate_debug_file (self) -> Boolean. */
422 objfpy_add_separate_debug_file (PyObject
*self
, PyObject
*args
, PyObject
*kw
)
424 static const char *keywords
[] = { "file_name", NULL
};
425 objfile_object
*obj
= (objfile_object
*) self
;
426 const char *file_name
;
428 OBJFPY_REQUIRE_VALID (obj
);
430 if (!gdb_PyArg_ParseTupleAndKeywords (args
, kw
, "s", keywords
, &file_name
))
435 gdb_bfd_ref_ptr
abfd (symfile_bfd_open (file_name
));
437 symbol_file_add_separate (abfd
.get (), file_name
, 0, obj
->objfile
);
439 CATCH (except
, RETURN_MASK_ALL
)
441 GDB_PY_HANDLE_EXCEPTION (except
);
448 /* Implement repr() for gdb.Objfile. */
451 objfpy_repr (PyObject
*self_
)
453 objfile_object
*self
= (objfile_object
*) self_
;
454 objfile
*obj
= self
->objfile
;
457 return PyString_FromString ("<gdb.Objfile (invalid)>");
459 return PyString_FromFormat ("<gdb.Objfile filename=%s>",
460 objfile_filename (obj
));
463 /* Subroutine of gdbpy_lookup_objfile_by_build_id to simplify it.
464 Return non-zero if STRING is a potentially valid build id. */
467 objfpy_build_id_ok (const char *string
)
469 size_t i
, n
= strlen (string
);
473 for (i
= 0; i
< n
; ++i
)
475 if (!isxdigit (string
[i
]))
481 /* Subroutine of gdbpy_lookup_objfile_by_build_id to simplify it.
482 Returns non-zero if BUILD_ID matches STRING.
483 It is assumed that objfpy_build_id_ok (string) returns TRUE. */
486 objfpy_build_id_matches (const struct bfd_build_id
*build_id
,
491 if (strlen (string
) != 2 * build_id
->size
)
494 for (i
= 0; i
< build_id
->size
; ++i
)
496 char c1
= string
[i
* 2], c2
= string
[i
* 2 + 1];
497 int byte
= (host_hex_value (c1
) << 4) | host_hex_value (c2
);
499 if (byte
!= build_id
->data
[i
])
506 /* Subroutine of gdbpy_lookup_objfile to simplify it.
507 Look up an objfile by its file name. */
509 static struct objfile
*
510 objfpy_lookup_objfile_by_name (const char *name
)
512 struct objfile
*objfile
;
514 ALL_OBJFILES (objfile
)
516 const char *filename
;
518 if ((objfile
->flags
& OBJF_NOT_FILENAME
) != 0)
520 /* Don't return separate debug files. */
521 if (objfile
->separate_debug_objfile_backlink
!= NULL
)
524 filename
= objfile_filename (objfile
);
525 if (filename
!= NULL
&& compare_filenames_for_search (filename
, name
))
527 if (compare_filenames_for_search (objfile
->original_name
, name
))
534 /* Subroutine of gdbpy_lookup_objfile to simplify it.
535 Look up an objfile by its build id. */
537 static struct objfile
*
538 objfpy_lookup_objfile_by_build_id (const char *build_id
)
540 struct objfile
*objfile
;
542 ALL_OBJFILES (objfile
)
544 const struct bfd_build_id
*obfd_build_id
;
546 if (objfile
->obfd
== NULL
)
548 /* Don't return separate debug files. */
549 if (objfile
->separate_debug_objfile_backlink
!= NULL
)
551 obfd_build_id
= build_id_bfd_get (objfile
->obfd
);
552 if (obfd_build_id
== NULL
)
554 if (objfpy_build_id_matches (obfd_build_id
, build_id
))
561 /* Implementation of gdb.lookup_objfile. */
564 gdbpy_lookup_objfile (PyObject
*self
, PyObject
*args
, PyObject
*kw
)
566 static const char *keywords
[] = { "name", "by_build_id", NULL
};
568 PyObject
*by_build_id_obj
= NULL
;
570 struct objfile
*objfile
;
572 if (!gdb_PyArg_ParseTupleAndKeywords (args
, kw
, "s|O!", keywords
,
573 &name
, &PyBool_Type
, &by_build_id_obj
))
577 if (by_build_id_obj
!= NULL
)
579 int cmp
= PyObject_IsTrue (by_build_id_obj
);
588 if (!objfpy_build_id_ok (name
))
590 PyErr_SetString (PyExc_TypeError
, _("Not a valid build id."));
593 objfile
= objfpy_lookup_objfile_by_build_id (name
);
596 objfile
= objfpy_lookup_objfile_by_name (name
);
599 return objfile_to_objfile_object (objfile
).release ();
601 PyErr_SetString (PyExc_ValueError
, _("Objfile not found."));
607 /* Clear the OBJFILE pointer in an Objfile object and remove the
610 py_free_objfile (struct objfile
*objfile
, void *datum
)
612 gdbpy_enter
enter_py (get_objfile_arch (objfile
), current_language
);
613 gdbpy_ref
<objfile_object
> object ((objfile_object
*) datum
);
614 object
->objfile
= NULL
;
617 /* Return a new reference to the Python object of type Objfile
618 representing OBJFILE. If the object has already been created,
619 return it. Otherwise, create it. Return NULL and set the Python
623 objfile_to_objfile_object (struct objfile
*objfile
)
626 = ((PyObject
*) objfile_data (objfile
, objfpy_objfile_data_key
));
629 gdbpy_ref
<objfile_object
> object
630 ((objfile_object
*) PyObject_New (objfile_object
, &objfile_object_type
));
633 if (!objfpy_initialize (object
.get ()))
636 object
->objfile
= objfile
;
637 set_objfile_data (objfile
, objfpy_objfile_data_key
, object
.get ());
638 result
= (PyObject
*) object
.release ();
641 return gdbpy_ref
<>::new_reference (result
);
645 gdbpy_initialize_objfile (void)
647 objfpy_objfile_data_key
648 = register_objfile_data_with_cleanup (NULL
, py_free_objfile
);
650 if (PyType_Ready (&objfile_object_type
) < 0)
653 return gdb_pymodule_addobject (gdb_module
, "Objfile",
654 (PyObject
*) &objfile_object_type
);
659 static PyMethodDef objfile_object_methods
[] =
661 { "is_valid", objfpy_is_valid
, METH_NOARGS
,
662 "is_valid () -> Boolean.\n\
663 Return true if this object file is valid, false if not." },
665 { "add_separate_debug_file", (PyCFunction
) objfpy_add_separate_debug_file
,
666 METH_VARARGS
| METH_KEYWORDS
,
667 "add_separate_debug_file (file_name).\n\
668 Add FILE_NAME to the list of files containing debug info for the objfile." },
673 static gdb_PyGetSetDef objfile_getset
[] =
675 { "__dict__", gdb_py_generic_dict
, NULL
,
676 "The __dict__ for this objfile.", &objfile_object_type
},
677 { "filename", objfpy_get_filename
, NULL
,
678 "The objfile's filename, or None.", NULL
},
679 { "username", objfpy_get_username
, NULL
,
680 "The name of the objfile as provided by the user, or None.", NULL
},
681 { "owner", objfpy_get_owner
, NULL
,
682 "The objfile owner of separate debug info objfiles, or None.",
684 { "build_id", objfpy_get_build_id
, NULL
,
685 "The objfile's build id, or None.", NULL
},
686 { "progspace", objfpy_get_progspace
, NULL
,
687 "The objfile's progspace, or None.", NULL
},
688 { "pretty_printers", objfpy_get_printers
, objfpy_set_printers
,
689 "Pretty printers.", NULL
},
690 { "frame_filters", objfpy_get_frame_filters
,
691 objfpy_set_frame_filters
, "Frame Filters.", NULL
},
692 { "frame_unwinders", objfpy_get_frame_unwinders
,
693 objfpy_set_frame_unwinders
, "Frame Unwinders", NULL
},
694 { "type_printers", objfpy_get_type_printers
, objfpy_set_type_printers
,
695 "Type printers.", NULL
},
696 { "xmethods", objfpy_get_xmethods
, NULL
,
697 "Debug methods.", NULL
},
701 PyTypeObject objfile_object_type
=
703 PyVarObject_HEAD_INIT (NULL
, 0)
704 "gdb.Objfile", /*tp_name*/
705 sizeof (objfile_object
), /*tp_basicsize*/
707 objfpy_dealloc
, /*tp_dealloc*/
712 objfpy_repr
, /*tp_repr*/
714 0, /*tp_as_sequence*/
722 Py_TPFLAGS_DEFAULT
, /*tp_flags*/
723 "GDB objfile object", /* tp_doc */
726 0, /* tp_richcompare */
727 0, /* tp_weaklistoffset */
730 objfile_object_methods
, /* tp_methods */
732 objfile_getset
, /* tp_getset */
735 0, /* tp_descr_get */
736 0, /* tp_descr_set */
737 offsetof (objfile_object
, dict
), /* tp_dictoffset */
740 objfpy_new
, /* tp_new */