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
;
118 return objfile_to_objfile_object (owner
).release ();
122 /* An Objfile method which returns the objfile's build id, or None. */
125 objfpy_get_build_id (PyObject
*self
, void *closure
)
127 objfile_object
*obj
= (objfile_object
*) self
;
128 struct objfile
*objfile
= obj
->objfile
;
129 const struct bfd_build_id
*build_id
= NULL
;
131 OBJFPY_REQUIRE_VALID (obj
);
135 build_id
= build_id_bfd_get (objfile
->obfd
);
137 CATCH (except
, RETURN_MASK_ALL
)
139 GDB_PY_HANDLE_EXCEPTION (except
);
143 if (build_id
!= NULL
)
145 char *hex_form
= make_hex_string (build_id
->data
, build_id
->size
);
148 result
= host_string_to_python_string (hex_form
);
156 /* An Objfile method which returns the objfile's progspace, or None. */
159 objfpy_get_progspace (PyObject
*self
, void *closure
)
161 objfile_object
*obj
= (objfile_object
*) self
;
164 return pspace_to_pspace_object (obj
->objfile
->pspace
).release ();
170 objfpy_dealloc (PyObject
*o
)
172 objfile_object
*self
= (objfile_object
*) o
;
174 Py_XDECREF (self
->dict
);
175 Py_XDECREF (self
->printers
);
176 Py_XDECREF (self
->frame_filters
);
177 Py_XDECREF (self
->frame_unwinders
);
178 Py_XDECREF (self
->type_printers
);
179 Py_XDECREF (self
->xmethods
);
180 Py_TYPE (self
)->tp_free (self
);
183 /* Initialize an objfile_object.
184 The result is a boolean indicating success. */
187 objfpy_initialize (objfile_object
*self
)
189 self
->objfile
= NULL
;
191 self
->dict
= PyDict_New ();
192 if (self
->dict
== NULL
)
195 self
->printers
= PyList_New (0);
196 if (self
->printers
== NULL
)
199 self
->frame_filters
= PyDict_New ();
200 if (self
->frame_filters
== NULL
)
203 self
->frame_unwinders
= PyList_New (0);
204 if (self
->frame_unwinders
== NULL
)
207 self
->type_printers
= PyList_New (0);
208 if (self
->type_printers
== NULL
)
211 self
->xmethods
= PyList_New (0);
212 if (self
->xmethods
== NULL
)
219 objfpy_new (PyTypeObject
*type
, PyObject
*args
, PyObject
*keywords
)
221 gdbpy_ref
<objfile_object
> self ((objfile_object
*) type
->tp_alloc (type
, 0));
225 if (!objfpy_initialize (self
.get ()))
229 return (PyObject
*) self
.release ();
233 objfpy_get_printers (PyObject
*o
, void *ignore
)
235 objfile_object
*self
= (objfile_object
*) o
;
237 Py_INCREF (self
->printers
);
238 return self
->printers
;
242 objfpy_set_printers (PyObject
*o
, PyObject
*value
, void *ignore
)
245 objfile_object
*self
= (objfile_object
*) o
;
249 PyErr_SetString (PyExc_TypeError
,
250 _("Cannot delete the pretty_printers attribute."));
254 if (! PyList_Check (value
))
256 PyErr_SetString (PyExc_TypeError
,
257 _("The pretty_printers attribute must be a list."));
261 /* Take care in case the LHS and RHS are related somehow. */
262 tmp
= self
->printers
;
264 self
->printers
= value
;
270 /* Return the Python dictionary attribute containing frame filters for
273 objfpy_get_frame_filters (PyObject
*o
, void *ignore
)
275 objfile_object
*self
= (objfile_object
*) o
;
277 Py_INCREF (self
->frame_filters
);
278 return self
->frame_filters
;
281 /* Set this object file's frame filters dictionary to FILTERS. */
283 objfpy_set_frame_filters (PyObject
*o
, PyObject
*filters
, void *ignore
)
286 objfile_object
*self
= (objfile_object
*) o
;
290 PyErr_SetString (PyExc_TypeError
,
291 _("Cannot delete the frame filters attribute."));
295 if (! PyDict_Check (filters
))
297 PyErr_SetString (PyExc_TypeError
,
298 _("The frame_filters attribute must be a dictionary."));
302 /* Take care in case the LHS and RHS are related somehow. */
303 tmp
= self
->frame_filters
;
305 self
->frame_filters
= filters
;
311 /* Return the frame unwinders attribute for this object file. */
314 objfpy_get_frame_unwinders (PyObject
*o
, void *ignore
)
316 objfile_object
*self
= (objfile_object
*) o
;
318 Py_INCREF (self
->frame_unwinders
);
319 return self
->frame_unwinders
;
322 /* Set this object file's frame unwinders list to UNWINDERS. */
325 objfpy_set_frame_unwinders (PyObject
*o
, PyObject
*unwinders
, void *ignore
)
328 objfile_object
*self
= (objfile_object
*) o
;
332 PyErr_SetString (PyExc_TypeError
,
333 _("Cannot delete the frame unwinders attribute."));
337 if (!PyList_Check (unwinders
))
339 PyErr_SetString (PyExc_TypeError
,
340 _("The frame_unwinders attribute must be a list."));
344 /* Take care in case the LHS and RHS are related somehow. */
345 tmp
= self
->frame_unwinders
;
346 Py_INCREF (unwinders
);
347 self
->frame_unwinders
= unwinders
;
353 /* Get the 'type_printers' attribute. */
356 objfpy_get_type_printers (PyObject
*o
, void *ignore
)
358 objfile_object
*self
= (objfile_object
*) o
;
360 Py_INCREF (self
->type_printers
);
361 return self
->type_printers
;
364 /* Get the 'xmethods' attribute. */
367 objfpy_get_xmethods (PyObject
*o
, void *ignore
)
369 objfile_object
*self
= (objfile_object
*) o
;
371 Py_INCREF (self
->xmethods
);
372 return self
->xmethods
;
375 /* Set the 'type_printers' attribute. */
378 objfpy_set_type_printers (PyObject
*o
, PyObject
*value
, void *ignore
)
381 objfile_object
*self
= (objfile_object
*) o
;
385 PyErr_SetString (PyExc_TypeError
,
386 _("Cannot delete the type_printers attribute."));
390 if (! PyList_Check (value
))
392 PyErr_SetString (PyExc_TypeError
,
393 _("The type_printers attribute must be a list."));
397 /* Take care in case the LHS and RHS are related somehow. */
398 tmp
= self
->type_printers
;
400 self
->type_printers
= value
;
406 /* Implementation of gdb.Objfile.is_valid (self) -> Boolean.
407 Returns True if this object file still exists in GDB. */
410 objfpy_is_valid (PyObject
*self
, PyObject
*args
)
412 objfile_object
*obj
= (objfile_object
*) self
;
420 /* Implementation of gdb.Objfile.add_separate_debug_file (self) -> Boolean. */
423 objfpy_add_separate_debug_file (PyObject
*self
, PyObject
*args
, PyObject
*kw
)
425 static const char *keywords
[] = { "file_name", NULL
};
426 objfile_object
*obj
= (objfile_object
*) self
;
427 const char *file_name
;
429 OBJFPY_REQUIRE_VALID (obj
);
431 if (!gdb_PyArg_ParseTupleAndKeywords (args
, kw
, "s", keywords
, &file_name
))
436 gdb_bfd_ref_ptr
abfd (symfile_bfd_open (file_name
));
438 symbol_file_add_separate (abfd
.get (), file_name
, 0, obj
->objfile
);
440 CATCH (except
, RETURN_MASK_ALL
)
442 GDB_PY_HANDLE_EXCEPTION (except
);
449 /* Implement repr() for gdb.Objfile. */
452 objfpy_repr (PyObject
*self_
)
454 objfile_object
*self
= (objfile_object
*) self_
;
455 objfile
*obj
= self
->objfile
;
458 return PyString_FromString ("<gdb.Objfile (invalid)>");
460 return PyString_FromFormat ("<gdb.Objfile filename=%s>",
461 objfile_filename (obj
));
464 /* Subroutine of gdbpy_lookup_objfile_by_build_id to simplify it.
465 Return non-zero if STRING is a potentially valid build id. */
468 objfpy_build_id_ok (const char *string
)
470 size_t i
, n
= strlen (string
);
474 for (i
= 0; i
< n
; ++i
)
476 if (!isxdigit (string
[i
]))
482 /* Subroutine of gdbpy_lookup_objfile_by_build_id to simplify it.
483 Returns non-zero if BUILD_ID matches STRING.
484 It is assumed that objfpy_build_id_ok (string) returns TRUE. */
487 objfpy_build_id_matches (const struct bfd_build_id
*build_id
,
492 if (strlen (string
) != 2 * build_id
->size
)
495 for (i
= 0; i
< build_id
->size
; ++i
)
497 char c1
= string
[i
* 2], c2
= string
[i
* 2 + 1];
498 int byte
= (host_hex_value (c1
) << 4) | host_hex_value (c2
);
500 if (byte
!= build_id
->data
[i
])
507 /* Subroutine of gdbpy_lookup_objfile to simplify it.
508 Look up an objfile by its file name. */
510 static struct objfile
*
511 objfpy_lookup_objfile_by_name (const char *name
)
513 struct objfile
*objfile
;
515 ALL_OBJFILES (objfile
)
517 const char *filename
;
519 if ((objfile
->flags
& OBJF_NOT_FILENAME
) != 0)
521 /* Don't return separate debug files. */
522 if (objfile
->separate_debug_objfile_backlink
!= NULL
)
525 filename
= objfile_filename (objfile
);
526 if (filename
!= NULL
&& compare_filenames_for_search (filename
, name
))
528 if (compare_filenames_for_search (objfile
->original_name
, name
))
535 /* Subroutine of gdbpy_lookup_objfile to simplify it.
536 Look up an objfile by its build id. */
538 static struct objfile
*
539 objfpy_lookup_objfile_by_build_id (const char *build_id
)
541 struct objfile
*objfile
;
543 ALL_OBJFILES (objfile
)
545 const struct bfd_build_id
*obfd_build_id
;
547 if (objfile
->obfd
== NULL
)
549 /* Don't return separate debug files. */
550 if (objfile
->separate_debug_objfile_backlink
!= NULL
)
552 obfd_build_id
= build_id_bfd_get (objfile
->obfd
);
553 if (obfd_build_id
== NULL
)
555 if (objfpy_build_id_matches (obfd_build_id
, build_id
))
562 /* Implementation of gdb.lookup_objfile. */
565 gdbpy_lookup_objfile (PyObject
*self
, PyObject
*args
, PyObject
*kw
)
567 static const char *keywords
[] = { "name", "by_build_id", NULL
};
569 PyObject
*by_build_id_obj
= NULL
;
571 struct objfile
*objfile
;
573 if (!gdb_PyArg_ParseTupleAndKeywords (args
, kw
, "s|O!", keywords
,
574 &name
, &PyBool_Type
, &by_build_id_obj
))
578 if (by_build_id_obj
!= NULL
)
580 int cmp
= PyObject_IsTrue (by_build_id_obj
);
589 if (!objfpy_build_id_ok (name
))
591 PyErr_SetString (PyExc_TypeError
, _("Not a valid build id."));
594 objfile
= objfpy_lookup_objfile_by_build_id (name
);
597 objfile
= objfpy_lookup_objfile_by_name (name
);
600 return objfile_to_objfile_object (objfile
).release ();
602 PyErr_SetString (PyExc_ValueError
, _("Objfile not found."));
608 /* Clear the OBJFILE pointer in an Objfile object and remove the
611 py_free_objfile (struct objfile
*objfile
, void *datum
)
613 gdbpy_enter
enter_py (get_objfile_arch (objfile
), current_language
);
614 gdbpy_ref
<objfile_object
> object ((objfile_object
*) datum
);
615 object
->objfile
= NULL
;
618 /* Return a new reference to the Python object of type Objfile
619 representing OBJFILE. If the object has already been created,
620 return it. Otherwise, create it. Return NULL and set the Python
624 objfile_to_objfile_object (struct objfile
*objfile
)
627 = ((PyObject
*) objfile_data (objfile
, objfpy_objfile_data_key
));
630 gdbpy_ref
<objfile_object
> object
631 ((objfile_object
*) PyObject_New (objfile_object
, &objfile_object_type
));
634 if (!objfpy_initialize (object
.get ()))
637 object
->objfile
= objfile
;
638 set_objfile_data (objfile
, objfpy_objfile_data_key
, object
.get ());
639 result
= (PyObject
*) object
.release ();
642 return gdbpy_ref
<>::new_reference (result
);
646 gdbpy_initialize_objfile (void)
648 objfpy_objfile_data_key
649 = register_objfile_data_with_cleanup (NULL
, py_free_objfile
);
651 if (PyType_Ready (&objfile_object_type
) < 0)
654 return gdb_pymodule_addobject (gdb_module
, "Objfile",
655 (PyObject
*) &objfile_object_type
);
660 static PyMethodDef objfile_object_methods
[] =
662 { "is_valid", objfpy_is_valid
, METH_NOARGS
,
663 "is_valid () -> Boolean.\n\
664 Return true if this object file is valid, false if not." },
666 { "add_separate_debug_file", (PyCFunction
) objfpy_add_separate_debug_file
,
667 METH_VARARGS
| METH_KEYWORDS
,
668 "add_separate_debug_file (file_name).\n\
669 Add FILE_NAME to the list of files containing debug info for the objfile." },
674 static gdb_PyGetSetDef objfile_getset
[] =
676 { "__dict__", gdb_py_generic_dict
, NULL
,
677 "The __dict__ for this objfile.", &objfile_object_type
},
678 { "filename", objfpy_get_filename
, NULL
,
679 "The objfile's filename, or None.", NULL
},
680 { "username", objfpy_get_username
, NULL
,
681 "The name of the objfile as provided by the user, or None.", NULL
},
682 { "owner", objfpy_get_owner
, NULL
,
683 "The objfile owner of separate debug info objfiles, or None.",
685 { "build_id", objfpy_get_build_id
, NULL
,
686 "The objfile's build id, or None.", NULL
},
687 { "progspace", objfpy_get_progspace
, NULL
,
688 "The objfile's progspace, or None.", NULL
},
689 { "pretty_printers", objfpy_get_printers
, objfpy_set_printers
,
690 "Pretty printers.", NULL
},
691 { "frame_filters", objfpy_get_frame_filters
,
692 objfpy_set_frame_filters
, "Frame Filters.", NULL
},
693 { "frame_unwinders", objfpy_get_frame_unwinders
,
694 objfpy_set_frame_unwinders
, "Frame Unwinders", NULL
},
695 { "type_printers", objfpy_get_type_printers
, objfpy_set_type_printers
,
696 "Type printers.", NULL
},
697 { "xmethods", objfpy_get_xmethods
, NULL
,
698 "Debug methods.", NULL
},
702 PyTypeObject objfile_object_type
=
704 PyVarObject_HEAD_INIT (NULL
, 0)
705 "gdb.Objfile", /*tp_name*/
706 sizeof (objfile_object
), /*tp_basicsize*/
708 objfpy_dealloc
, /*tp_dealloc*/
713 objfpy_repr
, /*tp_repr*/
715 0, /*tp_as_sequence*/
723 Py_TPFLAGS_DEFAULT
, /*tp_flags*/
724 "GDB objfile object", /* tp_doc */
727 0, /* tp_richcompare */
728 0, /* tp_weaklistoffset */
731 objfile_object_methods
, /* tp_methods */
733 objfile_getset
, /* tp_getset */
736 0, /* tp_descr_get */
737 0, /* tp_descr_set */
738 offsetof (objfile_object
, dict
), /* tp_dictoffset */
741 objfpy_new
, /* tp_new */