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
));
86 /* An Objfile method which returns the objfile's file name, as specified
87 by the user, or None. */
90 objfpy_get_username (PyObject
*self
, void *closure
)
92 objfile_object
*obj
= (objfile_object
*) self
;
96 const char *username
= obj
->objfile
->original_name
;
98 return host_string_to_python_string (username
);
104 /* If SELF is a separate debug-info file, return the "backlink" field.
105 Otherwise return None. */
108 objfpy_get_owner (PyObject
*self
, void *closure
)
110 objfile_object
*obj
= (objfile_object
*) self
;
111 struct objfile
*objfile
= obj
->objfile
;
112 struct objfile
*owner
;
114 OBJFPY_REQUIRE_VALID (obj
);
116 owner
= objfile
->separate_debug_objfile_backlink
;
119 PyObject
*result
= objfile_to_objfile_object (owner
);
127 /* An Objfile method which returns the objfile's build id, or None. */
130 objfpy_get_build_id (PyObject
*self
, void *closure
)
132 objfile_object
*obj
= (objfile_object
*) self
;
133 struct objfile
*objfile
= obj
->objfile
;
134 const struct bfd_build_id
*build_id
= NULL
;
136 OBJFPY_REQUIRE_VALID (obj
);
140 build_id
= build_id_bfd_get (objfile
->obfd
);
142 CATCH (except
, RETURN_MASK_ALL
)
144 GDB_PY_HANDLE_EXCEPTION (except
);
148 if (build_id
!= NULL
)
150 char *hex_form
= make_hex_string (build_id
->data
, build_id
->size
);
153 result
= host_string_to_python_string (hex_form
);
161 /* An Objfile method which returns the objfile's progspace, or None. */
164 objfpy_get_progspace (PyObject
*self
, void *closure
)
166 objfile_object
*obj
= (objfile_object
*) self
;
169 return pspace_to_pspace_object (obj
->objfile
->pspace
).release ();
175 objfpy_dealloc (PyObject
*o
)
177 objfile_object
*self
= (objfile_object
*) o
;
179 Py_XDECREF (self
->dict
);
180 Py_XDECREF (self
->printers
);
181 Py_XDECREF (self
->frame_filters
);
182 Py_XDECREF (self
->frame_unwinders
);
183 Py_XDECREF (self
->type_printers
);
184 Py_XDECREF (self
->xmethods
);
185 Py_TYPE (self
)->tp_free (self
);
188 /* Initialize an objfile_object.
189 The result is a boolean indicating success. */
192 objfpy_initialize (objfile_object
*self
)
194 self
->objfile
= NULL
;
196 self
->dict
= PyDict_New ();
197 if (self
->dict
== NULL
)
200 self
->printers
= PyList_New (0);
201 if (self
->printers
== NULL
)
204 self
->frame_filters
= PyDict_New ();
205 if (self
->frame_filters
== NULL
)
208 self
->frame_unwinders
= PyList_New (0);
209 if (self
->frame_unwinders
== NULL
)
212 self
->type_printers
= PyList_New (0);
213 if (self
->type_printers
== NULL
)
216 self
->xmethods
= PyList_New (0);
217 if (self
->xmethods
== NULL
)
224 objfpy_new (PyTypeObject
*type
, PyObject
*args
, PyObject
*keywords
)
226 gdbpy_ref
<objfile_object
> self ((objfile_object
*) type
->tp_alloc (type
, 0));
230 if (!objfpy_initialize (self
.get ()))
234 return (PyObject
*) self
.release ();
238 objfpy_get_printers (PyObject
*o
, void *ignore
)
240 objfile_object
*self
= (objfile_object
*) o
;
242 Py_INCREF (self
->printers
);
243 return self
->printers
;
247 objfpy_set_printers (PyObject
*o
, PyObject
*value
, void *ignore
)
250 objfile_object
*self
= (objfile_object
*) o
;
254 PyErr_SetString (PyExc_TypeError
,
255 _("Cannot delete the pretty_printers attribute."));
259 if (! PyList_Check (value
))
261 PyErr_SetString (PyExc_TypeError
,
262 _("The pretty_printers attribute must be a list."));
266 /* Take care in case the LHS and RHS are related somehow. */
267 tmp
= self
->printers
;
269 self
->printers
= value
;
275 /* Return the Python dictionary attribute containing frame filters for
278 objfpy_get_frame_filters (PyObject
*o
, void *ignore
)
280 objfile_object
*self
= (objfile_object
*) o
;
282 Py_INCREF (self
->frame_filters
);
283 return self
->frame_filters
;
286 /* Set this object file's frame filters dictionary to FILTERS. */
288 objfpy_set_frame_filters (PyObject
*o
, PyObject
*filters
, void *ignore
)
291 objfile_object
*self
= (objfile_object
*) o
;
295 PyErr_SetString (PyExc_TypeError
,
296 _("Cannot delete the frame filters attribute."));
300 if (! PyDict_Check (filters
))
302 PyErr_SetString (PyExc_TypeError
,
303 _("The frame_filters attribute must be a dictionary."));
307 /* Take care in case the LHS and RHS are related somehow. */
308 tmp
= self
->frame_filters
;
310 self
->frame_filters
= filters
;
316 /* Return the frame unwinders attribute for this object file. */
319 objfpy_get_frame_unwinders (PyObject
*o
, void *ignore
)
321 objfile_object
*self
= (objfile_object
*) o
;
323 Py_INCREF (self
->frame_unwinders
);
324 return self
->frame_unwinders
;
327 /* Set this object file's frame unwinders list to UNWINDERS. */
330 objfpy_set_frame_unwinders (PyObject
*o
, PyObject
*unwinders
, void *ignore
)
333 objfile_object
*self
= (objfile_object
*) o
;
337 PyErr_SetString (PyExc_TypeError
,
338 _("Cannot delete the frame unwinders attribute."));
342 if (!PyList_Check (unwinders
))
344 PyErr_SetString (PyExc_TypeError
,
345 _("The frame_unwinders attribute must be a list."));
349 /* Take care in case the LHS and RHS are related somehow. */
350 tmp
= self
->frame_unwinders
;
351 Py_INCREF (unwinders
);
352 self
->frame_unwinders
= unwinders
;
358 /* Get the 'type_printers' attribute. */
361 objfpy_get_type_printers (PyObject
*o
, void *ignore
)
363 objfile_object
*self
= (objfile_object
*) o
;
365 Py_INCREF (self
->type_printers
);
366 return self
->type_printers
;
369 /* Get the 'xmethods' attribute. */
372 objfpy_get_xmethods (PyObject
*o
, void *ignore
)
374 objfile_object
*self
= (objfile_object
*) o
;
376 Py_INCREF (self
->xmethods
);
377 return self
->xmethods
;
380 /* Set the 'type_printers' attribute. */
383 objfpy_set_type_printers (PyObject
*o
, PyObject
*value
, void *ignore
)
386 objfile_object
*self
= (objfile_object
*) o
;
390 PyErr_SetString (PyExc_TypeError
,
391 _("Cannot delete the type_printers attribute."));
395 if (! PyList_Check (value
))
397 PyErr_SetString (PyExc_TypeError
,
398 _("The type_printers attribute must be a list."));
402 /* Take care in case the LHS and RHS are related somehow. */
403 tmp
= self
->type_printers
;
405 self
->type_printers
= value
;
411 /* Implementation of gdb.Objfile.is_valid (self) -> Boolean.
412 Returns True if this object file still exists in GDB. */
415 objfpy_is_valid (PyObject
*self
, PyObject
*args
)
417 objfile_object
*obj
= (objfile_object
*) self
;
425 /* Implementation of gdb.Objfile.add_separate_debug_file (self) -> Boolean. */
428 objfpy_add_separate_debug_file (PyObject
*self
, PyObject
*args
, PyObject
*kw
)
430 static const char *keywords
[] = { "file_name", NULL
};
431 objfile_object
*obj
= (objfile_object
*) self
;
432 const char *file_name
;
434 OBJFPY_REQUIRE_VALID (obj
);
436 if (!gdb_PyArg_ParseTupleAndKeywords (args
, kw
, "s", keywords
, &file_name
))
441 gdb_bfd_ref_ptr
abfd (symfile_bfd_open (file_name
));
443 symbol_file_add_separate (abfd
.get (), file_name
, 0, obj
->objfile
);
445 CATCH (except
, RETURN_MASK_ALL
)
447 GDB_PY_HANDLE_EXCEPTION (except
);
454 /* Implement repr() for gdb.Objfile. */
457 objfpy_repr (PyObject
*self_
)
459 objfile_object
*self
= (objfile_object
*) self_
;
460 objfile
*obj
= self
->objfile
;
463 return PyString_FromString ("<gdb.Objfile (invalid)>");
465 return PyString_FromFormat ("<gdb.Objfile filename=%s>",
466 objfile_filename (obj
));
469 /* Subroutine of gdbpy_lookup_objfile_by_build_id to simplify it.
470 Return non-zero if STRING is a potentially valid build id. */
473 objfpy_build_id_ok (const char *string
)
475 size_t i
, n
= strlen (string
);
479 for (i
= 0; i
< n
; ++i
)
481 if (!isxdigit (string
[i
]))
487 /* Subroutine of gdbpy_lookup_objfile_by_build_id to simplify it.
488 Returns non-zero if BUILD_ID matches STRING.
489 It is assumed that objfpy_build_id_ok (string) returns TRUE. */
492 objfpy_build_id_matches (const struct bfd_build_id
*build_id
,
497 if (strlen (string
) != 2 * build_id
->size
)
500 for (i
= 0; i
< build_id
->size
; ++i
)
502 char c1
= string
[i
* 2], c2
= string
[i
* 2 + 1];
503 int byte
= (host_hex_value (c1
) << 4) | host_hex_value (c2
);
505 if (byte
!= build_id
->data
[i
])
512 /* Subroutine of gdbpy_lookup_objfile to simplify it.
513 Look up an objfile by its file name. */
515 static struct objfile
*
516 objfpy_lookup_objfile_by_name (const char *name
)
518 struct objfile
*objfile
;
520 ALL_OBJFILES (objfile
)
522 const char *filename
;
524 if ((objfile
->flags
& OBJF_NOT_FILENAME
) != 0)
526 /* Don't return separate debug files. */
527 if (objfile
->separate_debug_objfile_backlink
!= NULL
)
530 filename
= objfile_filename (objfile
);
531 if (filename
!= NULL
&& compare_filenames_for_search (filename
, name
))
533 if (compare_filenames_for_search (objfile
->original_name
, name
))
540 /* Subroutine of gdbpy_lookup_objfile to simplify it.
541 Look up an objfile by its build id. */
543 static struct objfile
*
544 objfpy_lookup_objfile_by_build_id (const char *build_id
)
546 struct objfile
*objfile
;
548 ALL_OBJFILES (objfile
)
550 const struct bfd_build_id
*obfd_build_id
;
552 if (objfile
->obfd
== NULL
)
554 /* Don't return separate debug files. */
555 if (objfile
->separate_debug_objfile_backlink
!= NULL
)
557 obfd_build_id
= build_id_bfd_get (objfile
->obfd
);
558 if (obfd_build_id
== NULL
)
560 if (objfpy_build_id_matches (obfd_build_id
, build_id
))
567 /* Implementation of gdb.lookup_objfile. */
570 gdbpy_lookup_objfile (PyObject
*self
, PyObject
*args
, PyObject
*kw
)
572 static const char *keywords
[] = { "name", "by_build_id", NULL
};
574 PyObject
*by_build_id_obj
= NULL
;
576 struct objfile
*objfile
;
578 if (!gdb_PyArg_ParseTupleAndKeywords (args
, kw
, "s|O!", keywords
,
579 &name
, &PyBool_Type
, &by_build_id_obj
))
583 if (by_build_id_obj
!= NULL
)
585 int cmp
= PyObject_IsTrue (by_build_id_obj
);
594 if (!objfpy_build_id_ok (name
))
596 PyErr_SetString (PyExc_TypeError
, _("Not a valid build id."));
599 objfile
= objfpy_lookup_objfile_by_build_id (name
);
602 objfile
= objfpy_lookup_objfile_by_name (name
);
606 PyObject
*result
= objfile_to_objfile_object (objfile
);
612 PyErr_SetString (PyExc_ValueError
, _("Objfile not found."));
618 /* Clear the OBJFILE pointer in an Objfile object and remove the
621 py_free_objfile (struct objfile
*objfile
, void *datum
)
623 gdbpy_enter
enter_py (get_objfile_arch (objfile
), current_language
);
624 gdbpy_ref
<objfile_object
> object ((objfile_object
*) datum
);
625 object
->objfile
= NULL
;
628 /* Return a borrowed reference to the Python object of type Objfile
629 representing OBJFILE. If the object has already been created,
630 return it. Otherwise, create it. Return NULL and set the Python
634 objfile_to_objfile_object (struct objfile
*objfile
)
636 gdbpy_ref
<objfile_object
> object
637 ((objfile_object
*) objfile_data (objfile
, objfpy_objfile_data_key
));
640 object
.reset (PyObject_New (objfile_object
, &objfile_object_type
));
643 if (!objfpy_initialize (object
.get ()))
646 object
->objfile
= objfile
;
647 set_objfile_data (objfile
, objfpy_objfile_data_key
, object
.get ());
651 return (PyObject
*) object
.release ();
655 gdbpy_initialize_objfile (void)
657 objfpy_objfile_data_key
658 = register_objfile_data_with_cleanup (NULL
, py_free_objfile
);
660 if (PyType_Ready (&objfile_object_type
) < 0)
663 return gdb_pymodule_addobject (gdb_module
, "Objfile",
664 (PyObject
*) &objfile_object_type
);
669 static PyMethodDef objfile_object_methods
[] =
671 { "is_valid", objfpy_is_valid
, METH_NOARGS
,
672 "is_valid () -> Boolean.\n\
673 Return true if this object file is valid, false if not." },
675 { "add_separate_debug_file", (PyCFunction
) objfpy_add_separate_debug_file
,
676 METH_VARARGS
| METH_KEYWORDS
,
677 "add_separate_debug_file (file_name).\n\
678 Add FILE_NAME to the list of files containing debug info for the objfile." },
683 static gdb_PyGetSetDef objfile_getset
[] =
685 { "__dict__", gdb_py_generic_dict
, NULL
,
686 "The __dict__ for this objfile.", &objfile_object_type
},
687 { "filename", objfpy_get_filename
, NULL
,
688 "The objfile's filename, or None.", NULL
},
689 { "username", objfpy_get_username
, NULL
,
690 "The name of the objfile as provided by the user, or None.", NULL
},
691 { "owner", objfpy_get_owner
, NULL
,
692 "The objfile owner of separate debug info objfiles, or None.",
694 { "build_id", objfpy_get_build_id
, NULL
,
695 "The objfile's build id, or None.", NULL
},
696 { "progspace", objfpy_get_progspace
, NULL
,
697 "The objfile's progspace, or None.", NULL
},
698 { "pretty_printers", objfpy_get_printers
, objfpy_set_printers
,
699 "Pretty printers.", NULL
},
700 { "frame_filters", objfpy_get_frame_filters
,
701 objfpy_set_frame_filters
, "Frame Filters.", NULL
},
702 { "frame_unwinders", objfpy_get_frame_unwinders
,
703 objfpy_set_frame_unwinders
, "Frame Unwinders", NULL
},
704 { "type_printers", objfpy_get_type_printers
, objfpy_set_type_printers
,
705 "Type printers.", NULL
},
706 { "xmethods", objfpy_get_xmethods
, NULL
,
707 "Debug methods.", NULL
},
711 PyTypeObject objfile_object_type
=
713 PyVarObject_HEAD_INIT (NULL
, 0)
714 "gdb.Objfile", /*tp_name*/
715 sizeof (objfile_object
), /*tp_basicsize*/
717 objfpy_dealloc
, /*tp_dealloc*/
722 objfpy_repr
, /*tp_repr*/
724 0, /*tp_as_sequence*/
732 Py_TPFLAGS_DEFAULT
, /*tp_flags*/
733 "GDB objfile object", /* tp_doc */
736 0, /* tp_richcompare */
737 0, /* tp_weaklistoffset */
740 objfile_object_methods
, /* tp_methods */
742 objfile_getset
, /* tp_getset */
745 0, /* tp_descr_get */
746 0, /* tp_descr_set */
747 offsetof (objfile_object
, dict
), /* tp_dictoffset */
750 objfpy_new
, /* tp_new */