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"
32 /* The corresponding objfile. */
33 struct objfile
*objfile
;
35 /* Dictionary holding user-added attributes.
36 This is the __dict__ attribute of the object. */
39 /* The pretty-printer list of functions. */
42 /* The frame filter list of functions. */
43 PyObject
*frame_filters
;
45 /* The list of frame unwinders. */
46 PyObject
*frame_unwinders
;
48 /* The type-printer list. */
49 PyObject
*type_printers
;
51 /* The debug method matcher list. */
55 extern PyTypeObject objfile_object_type
56 CPYCHECKER_TYPE_OBJECT_FOR_TYPEDEF ("objfile_object");
58 static const struct objfile_data
*objfpy_objfile_data_key
;
60 /* Require that OBJF be a valid objfile. */
61 #define OBJFPY_REQUIRE_VALID(obj) \
63 if (!(obj)->objfile) \
65 PyErr_SetString (PyExc_RuntimeError, \
66 _("Objfile no longer exists.")); \
73 /* An Objfile method which returns the objfile's file name, or None. */
76 objfpy_get_filename (PyObject
*self
, void *closure
)
78 objfile_object
*obj
= (objfile_object
*) self
;
81 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
).release ();
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 (const gdb_exception
&except
)
139 GDB_PY_HANDLE_EXCEPTION (except
);
142 if (build_id
!= NULL
)
144 gdb::unique_xmalloc_ptr
<char> hex_form
145 (make_hex_string (build_id
->data
, build_id
->size
));
147 return host_string_to_python_string (hex_form
.get ()).release ();
153 /* An Objfile method which returns the objfile's progspace, or None. */
156 objfpy_get_progspace (PyObject
*self
, void *closure
)
158 objfile_object
*obj
= (objfile_object
*) self
;
161 return pspace_to_pspace_object (obj
->objfile
->pspace
).release ();
167 objfpy_dealloc (PyObject
*o
)
169 objfile_object
*self
= (objfile_object
*) o
;
171 Py_XDECREF (self
->dict
);
172 Py_XDECREF (self
->printers
);
173 Py_XDECREF (self
->frame_filters
);
174 Py_XDECREF (self
->frame_unwinders
);
175 Py_XDECREF (self
->type_printers
);
176 Py_XDECREF (self
->xmethods
);
177 Py_TYPE (self
)->tp_free (self
);
180 /* Initialize an objfile_object.
181 The result is a boolean indicating success. */
184 objfpy_initialize (objfile_object
*self
)
186 self
->objfile
= NULL
;
188 self
->dict
= PyDict_New ();
189 if (self
->dict
== NULL
)
192 self
->printers
= PyList_New (0);
193 if (self
->printers
== NULL
)
196 self
->frame_filters
= PyDict_New ();
197 if (self
->frame_filters
== NULL
)
200 self
->frame_unwinders
= PyList_New (0);
201 if (self
->frame_unwinders
== NULL
)
204 self
->type_printers
= PyList_New (0);
205 if (self
->type_printers
== NULL
)
208 self
->xmethods
= PyList_New (0);
209 if (self
->xmethods
== NULL
)
216 objfpy_new (PyTypeObject
*type
, PyObject
*args
, PyObject
*keywords
)
218 gdbpy_ref
<objfile_object
> self ((objfile_object
*) type
->tp_alloc (type
, 0));
222 if (!objfpy_initialize (self
.get ()))
226 return (PyObject
*) self
.release ();
230 objfpy_get_printers (PyObject
*o
, void *ignore
)
232 objfile_object
*self
= (objfile_object
*) o
;
234 Py_INCREF (self
->printers
);
235 return self
->printers
;
239 objfpy_set_printers (PyObject
*o
, PyObject
*value
, void *ignore
)
241 objfile_object
*self
= (objfile_object
*) o
;
245 PyErr_SetString (PyExc_TypeError
,
246 _("Cannot delete the pretty_printers attribute."));
250 if (! PyList_Check (value
))
252 PyErr_SetString (PyExc_TypeError
,
253 _("The pretty_printers attribute must be a list."));
257 /* Take care in case the LHS and RHS are related somehow. */
258 gdbpy_ref
<> tmp (self
->printers
);
260 self
->printers
= value
;
265 /* Return the Python dictionary attribute containing frame filters for
268 objfpy_get_frame_filters (PyObject
*o
, void *ignore
)
270 objfile_object
*self
= (objfile_object
*) o
;
272 Py_INCREF (self
->frame_filters
);
273 return self
->frame_filters
;
276 /* Set this object file's frame filters dictionary to FILTERS. */
278 objfpy_set_frame_filters (PyObject
*o
, PyObject
*filters
, void *ignore
)
280 objfile_object
*self
= (objfile_object
*) o
;
284 PyErr_SetString (PyExc_TypeError
,
285 _("Cannot delete the frame filters attribute."));
289 if (! PyDict_Check (filters
))
291 PyErr_SetString (PyExc_TypeError
,
292 _("The frame_filters attribute must be a dictionary."));
296 /* Take care in case the LHS and RHS are related somehow. */
297 gdbpy_ref
<> tmp (self
->frame_filters
);
299 self
->frame_filters
= filters
;
304 /* Return the frame unwinders attribute for this object file. */
307 objfpy_get_frame_unwinders (PyObject
*o
, void *ignore
)
309 objfile_object
*self
= (objfile_object
*) o
;
311 Py_INCREF (self
->frame_unwinders
);
312 return self
->frame_unwinders
;
315 /* Set this object file's frame unwinders list to UNWINDERS. */
318 objfpy_set_frame_unwinders (PyObject
*o
, PyObject
*unwinders
, void *ignore
)
320 objfile_object
*self
= (objfile_object
*) o
;
324 PyErr_SetString (PyExc_TypeError
,
325 _("Cannot delete the frame unwinders attribute."));
329 if (!PyList_Check (unwinders
))
331 PyErr_SetString (PyExc_TypeError
,
332 _("The frame_unwinders attribute must be a list."));
336 /* Take care in case the LHS and RHS are related somehow. */
337 gdbpy_ref
<> tmp (self
->frame_unwinders
);
338 Py_INCREF (unwinders
);
339 self
->frame_unwinders
= unwinders
;
344 /* Get the 'type_printers' attribute. */
347 objfpy_get_type_printers (PyObject
*o
, void *ignore
)
349 objfile_object
*self
= (objfile_object
*) o
;
351 Py_INCREF (self
->type_printers
);
352 return self
->type_printers
;
355 /* Get the 'xmethods' attribute. */
358 objfpy_get_xmethods (PyObject
*o
, void *ignore
)
360 objfile_object
*self
= (objfile_object
*) o
;
362 Py_INCREF (self
->xmethods
);
363 return self
->xmethods
;
366 /* Set the 'type_printers' attribute. */
369 objfpy_set_type_printers (PyObject
*o
, PyObject
*value
, void *ignore
)
371 objfile_object
*self
= (objfile_object
*) o
;
375 PyErr_SetString (PyExc_TypeError
,
376 _("Cannot delete the type_printers attribute."));
380 if (! PyList_Check (value
))
382 PyErr_SetString (PyExc_TypeError
,
383 _("The type_printers attribute must be a list."));
387 /* Take care in case the LHS and RHS are related somehow. */
388 gdbpy_ref
<> tmp (self
->type_printers
);
390 self
->type_printers
= value
;
395 /* Implementation of gdb.Objfile.is_valid (self) -> Boolean.
396 Returns True if this object file still exists in GDB. */
399 objfpy_is_valid (PyObject
*self
, PyObject
*args
)
401 objfile_object
*obj
= (objfile_object
*) self
;
409 /* Implementation of gdb.Objfile.add_separate_debug_file (self, string). */
412 objfpy_add_separate_debug_file (PyObject
*self
, PyObject
*args
, PyObject
*kw
)
414 static const char *keywords
[] = { "file_name", NULL
};
415 objfile_object
*obj
= (objfile_object
*) self
;
416 const char *file_name
;
418 OBJFPY_REQUIRE_VALID (obj
);
420 if (!gdb_PyArg_ParseTupleAndKeywords (args
, kw
, "s", keywords
, &file_name
))
425 gdb_bfd_ref_ptr
abfd (symfile_bfd_open (file_name
));
427 symbol_file_add_separate (abfd
.get (), file_name
, 0, obj
->objfile
);
429 catch (const gdb_exception
&except
)
431 GDB_PY_HANDLE_EXCEPTION (except
);
438 gdb.Objfile.lookup_global_symbol (self, string [, domain]) -> gdb.Symbol. */
441 objfpy_lookup_global_symbol (PyObject
*self
, PyObject
*args
, PyObject
*kw
)
443 static const char *keywords
[] = { "name", "domain", NULL
};
444 objfile_object
*obj
= (objfile_object
*) self
;
445 const char *symbol_name
;
446 int domain
= VAR_DOMAIN
;
448 OBJFPY_REQUIRE_VALID (obj
);
450 if (!gdb_PyArg_ParseTupleAndKeywords (args
, kw
, "s|i", keywords
, &symbol_name
,
456 struct symbol
*sym
= lookup_global_symbol_from_objfile
457 (obj
->objfile
, GLOBAL_BLOCK
, symbol_name
, (domain_enum
) domain
).symbol
;
461 return symbol_to_symbol_object (sym
);
463 catch (const gdb_exception
&except
)
465 GDB_PY_HANDLE_EXCEPTION (except
);
472 gdb.Objfile.lookup_static_symbol (self, string [, domain]) -> gdb.Symbol. */
475 objfpy_lookup_static_symbol (PyObject
*self
, PyObject
*args
, PyObject
*kw
)
477 static const char *keywords
[] = { "name", "domain", NULL
};
478 objfile_object
*obj
= (objfile_object
*) self
;
479 const char *symbol_name
;
480 int domain
= VAR_DOMAIN
;
482 OBJFPY_REQUIRE_VALID (obj
);
484 if (!gdb_PyArg_ParseTupleAndKeywords (args
, kw
, "s|i", keywords
, &symbol_name
,
490 struct symbol
*sym
= lookup_global_symbol_from_objfile
491 (obj
->objfile
, STATIC_BLOCK
, symbol_name
, (domain_enum
) domain
).symbol
;
495 return symbol_to_symbol_object (sym
);
497 catch (const gdb_exception
&except
)
499 GDB_PY_HANDLE_EXCEPTION (except
);
505 /* Implement repr() for gdb.Objfile. */
508 objfpy_repr (PyObject
*self_
)
510 objfile_object
*self
= (objfile_object
*) self_
;
511 objfile
*obj
= self
->objfile
;
514 return PyString_FromString ("<gdb.Objfile (invalid)>");
516 return PyString_FromFormat ("<gdb.Objfile filename=%s>",
517 objfile_filename (obj
));
520 /* Subroutine of gdbpy_lookup_objfile_by_build_id to simplify it.
521 Return non-zero if STRING is a potentially valid build id. */
524 objfpy_build_id_ok (const char *string
)
526 size_t i
, n
= strlen (string
);
530 for (i
= 0; i
< n
; ++i
)
532 if (!isxdigit (string
[i
]))
538 /* Subroutine of gdbpy_lookup_objfile_by_build_id to simplify it.
539 Returns non-zero if BUILD_ID matches STRING.
540 It is assumed that objfpy_build_id_ok (string) returns TRUE. */
543 objfpy_build_id_matches (const struct bfd_build_id
*build_id
,
548 if (strlen (string
) != 2 * build_id
->size
)
551 for (i
= 0; i
< build_id
->size
; ++i
)
553 char c1
= string
[i
* 2], c2
= string
[i
* 2 + 1];
554 int byte
= (host_hex_value (c1
) << 4) | host_hex_value (c2
);
556 if (byte
!= build_id
->data
[i
])
563 /* Subroutine of gdbpy_lookup_objfile to simplify it.
564 Look up an objfile by its file name. */
566 static struct objfile
*
567 objfpy_lookup_objfile_by_name (const char *name
)
569 for (objfile
*objfile
: current_program_space
->objfiles ())
571 const char *filename
;
573 if ((objfile
->flags
& OBJF_NOT_FILENAME
) != 0)
575 /* Don't return separate debug files. */
576 if (objfile
->separate_debug_objfile_backlink
!= NULL
)
579 filename
= objfile_filename (objfile
);
580 if (filename
!= NULL
&& compare_filenames_for_search (filename
, name
))
582 if (compare_filenames_for_search (objfile
->original_name
, name
))
589 /* Subroutine of gdbpy_lookup_objfile to simplify it.
590 Look up an objfile by its build id. */
592 static struct objfile
*
593 objfpy_lookup_objfile_by_build_id (const char *build_id
)
595 for (objfile
*objfile
: current_program_space
->objfiles ())
597 const struct bfd_build_id
*obfd_build_id
;
599 if (objfile
->obfd
== NULL
)
601 /* Don't return separate debug files. */
602 if (objfile
->separate_debug_objfile_backlink
!= NULL
)
604 obfd_build_id
= build_id_bfd_get (objfile
->obfd
);
605 if (obfd_build_id
== NULL
)
607 if (objfpy_build_id_matches (obfd_build_id
, build_id
))
614 /* Implementation of gdb.lookup_objfile. */
617 gdbpy_lookup_objfile (PyObject
*self
, PyObject
*args
, PyObject
*kw
)
619 static const char *keywords
[] = { "name", "by_build_id", NULL
};
621 PyObject
*by_build_id_obj
= NULL
;
623 struct objfile
*objfile
;
625 if (!gdb_PyArg_ParseTupleAndKeywords (args
, kw
, "s|O!", keywords
,
626 &name
, &PyBool_Type
, &by_build_id_obj
))
630 if (by_build_id_obj
!= NULL
)
632 int cmp
= PyObject_IsTrue (by_build_id_obj
);
641 if (!objfpy_build_id_ok (name
))
643 PyErr_SetString (PyExc_TypeError
, _("Not a valid build id."));
646 objfile
= objfpy_lookup_objfile_by_build_id (name
);
649 objfile
= objfpy_lookup_objfile_by_name (name
);
652 return objfile_to_objfile_object (objfile
).release ();
654 PyErr_SetString (PyExc_ValueError
, _("Objfile not found."));
660 /* Clear the OBJFILE pointer in an Objfile object and remove the
663 py_free_objfile (struct objfile
*objfile
, void *datum
)
665 gdbpy_enter
enter_py (get_objfile_arch (objfile
), current_language
);
666 gdbpy_ref
<objfile_object
> object ((objfile_object
*) datum
);
667 object
->objfile
= NULL
;
670 /* Return a new reference to the Python object of type Objfile
671 representing OBJFILE. If the object has already been created,
672 return it. Otherwise, create it. Return NULL and set the Python
676 objfile_to_objfile_object (struct objfile
*objfile
)
679 = ((PyObject
*) objfile_data (objfile
, objfpy_objfile_data_key
));
682 gdbpy_ref
<objfile_object
> object
683 ((objfile_object
*) PyObject_New (objfile_object
, &objfile_object_type
));
686 if (!objfpy_initialize (object
.get ()))
689 object
->objfile
= objfile
;
690 set_objfile_data (objfile
, objfpy_objfile_data_key
, object
.get ());
691 result
= (PyObject
*) object
.release ();
694 return gdbpy_ref
<>::new_reference (result
);
698 gdbpy_initialize_objfile (void)
700 objfpy_objfile_data_key
701 = register_objfile_data_with_cleanup (NULL
, py_free_objfile
);
703 if (PyType_Ready (&objfile_object_type
) < 0)
706 return gdb_pymodule_addobject (gdb_module
, "Objfile",
707 (PyObject
*) &objfile_object_type
);
712 static PyMethodDef objfile_object_methods
[] =
714 { "is_valid", objfpy_is_valid
, METH_NOARGS
,
715 "is_valid () -> Boolean.\n\
716 Return true if this object file is valid, false if not." },
718 { "add_separate_debug_file", (PyCFunction
) objfpy_add_separate_debug_file
,
719 METH_VARARGS
| METH_KEYWORDS
,
720 "add_separate_debug_file (file_name).\n\
721 Add FILE_NAME to the list of files containing debug info for the objfile." },
723 { "lookup_global_symbol", (PyCFunction
) objfpy_lookup_global_symbol
,
724 METH_VARARGS
| METH_KEYWORDS
,
725 "lookup_global_symbol (name [, domain]).\n\
726 Look up a global symbol in this objfile and return it." },
728 { "lookup_static_symbol", (PyCFunction
) objfpy_lookup_static_symbol
,
729 METH_VARARGS
| METH_KEYWORDS
,
730 "lookup_static_symbol (name [, domain]).\n\
731 Look up a static-linkage global symbol in this objfile and return it." },
736 static gdb_PyGetSetDef objfile_getset
[] =
738 { "__dict__", gdb_py_generic_dict
, NULL
,
739 "The __dict__ for this objfile.", &objfile_object_type
},
740 { "filename", objfpy_get_filename
, NULL
,
741 "The objfile's filename, or None.", NULL
},
742 { "username", objfpy_get_username
, NULL
,
743 "The name of the objfile as provided by the user, or None.", NULL
},
744 { "owner", objfpy_get_owner
, NULL
,
745 "The objfile owner of separate debug info objfiles, or None.",
747 { "build_id", objfpy_get_build_id
, NULL
,
748 "The objfile's build id, or None.", NULL
},
749 { "progspace", objfpy_get_progspace
, NULL
,
750 "The objfile's progspace, or None.", NULL
},
751 { "pretty_printers", objfpy_get_printers
, objfpy_set_printers
,
752 "Pretty printers.", NULL
},
753 { "frame_filters", objfpy_get_frame_filters
,
754 objfpy_set_frame_filters
, "Frame Filters.", NULL
},
755 { "frame_unwinders", objfpy_get_frame_unwinders
,
756 objfpy_set_frame_unwinders
, "Frame Unwinders", NULL
},
757 { "type_printers", objfpy_get_type_printers
, objfpy_set_type_printers
,
758 "Type printers.", NULL
},
759 { "xmethods", objfpy_get_xmethods
, NULL
,
760 "Debug methods.", NULL
},
764 PyTypeObject objfile_object_type
=
766 PyVarObject_HEAD_INIT (NULL
, 0)
767 "gdb.Objfile", /*tp_name*/
768 sizeof (objfile_object
), /*tp_basicsize*/
770 objfpy_dealloc
, /*tp_dealloc*/
775 objfpy_repr
, /*tp_repr*/
777 0, /*tp_as_sequence*/
785 Py_TPFLAGS_DEFAULT
, /*tp_flags*/
786 "GDB objfile object", /* tp_doc */
789 0, /* tp_richcompare */
790 0, /* tp_weaklistoffset */
793 objfile_object_methods
, /* tp_methods */
795 objfile_getset
, /* tp_getset */
798 0, /* tp_descr_get */
799 0, /* tp_descr_set */
800 offsetof (objfile_object
, dict
), /* tp_dictoffset */
803 objfpy_new
, /* tp_new */