1 /* Python interface to program spaces.
3 Copyright (C) 2010-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"
23 #include "progspace.h"
26 #include "arch-utils.h"
34 /* The corresponding pspace. */
35 struct program_space
*pspace
;
37 /* Dictionary holding user-added attributes.
38 This is the __dict__ attribute of the object. */
41 /* The pretty-printer list of functions. */
44 /* The frame filter list of functions. */
45 PyObject
*frame_filters
;
47 /* The frame unwinder list. */
48 PyObject
*frame_unwinders
;
50 /* The type-printer list. */
51 PyObject
*type_printers
;
53 /* The debug method list. */
57 extern PyTypeObject pspace_object_type
58 CPYCHECKER_TYPE_OBJECT_FOR_TYPEDEF ("pspace_object");
60 static const struct program_space_data
*pspy_pspace_data_key
;
62 /* Require that PSPACE_OBJ be a valid program space ID. */
63 #define PSPY_REQUIRE_VALID(pspace_obj) \
65 if (pspace_obj->pspace == nullptr) \
67 PyErr_SetString (PyExc_RuntimeError, \
68 _("Program space no longer exists.")); \
73 /* An Objfile method which returns the objfile's file name, or None. */
76 pspy_get_filename (PyObject
*self
, void *closure
)
78 pspace_object
*obj
= (pspace_object
*) self
;
82 struct objfile
*objfile
= obj
->pspace
->symfile_object_file
;
85 return (host_string_to_python_string (objfile_name (objfile
))
92 pspy_dealloc (PyObject
*self
)
94 pspace_object
*ps_self
= (pspace_object
*) self
;
96 Py_XDECREF (ps_self
->dict
);
97 Py_XDECREF (ps_self
->printers
);
98 Py_XDECREF (ps_self
->frame_filters
);
99 Py_XDECREF (ps_self
->frame_unwinders
);
100 Py_XDECREF (ps_self
->type_printers
);
101 Py_XDECREF (ps_self
->xmethods
);
102 Py_TYPE (self
)->tp_free (self
);
105 /* Initialize a pspace_object.
106 The result is a boolean indicating success. */
109 pspy_initialize (pspace_object
*self
)
113 self
->dict
= PyDict_New ();
114 if (self
->dict
== NULL
)
117 self
->printers
= PyList_New (0);
118 if (self
->printers
== NULL
)
121 self
->frame_filters
= PyDict_New ();
122 if (self
->frame_filters
== NULL
)
125 self
->frame_unwinders
= PyList_New (0);
126 if (self
->frame_unwinders
== NULL
)
129 self
->type_printers
= PyList_New (0);
130 if (self
->type_printers
== NULL
)
133 self
->xmethods
= PyList_New (0);
134 if (self
->xmethods
== NULL
)
141 pspy_new (PyTypeObject
*type
, PyObject
*args
, PyObject
*keywords
)
143 gdbpy_ref
<pspace_object
> self ((pspace_object
*) type
->tp_alloc (type
, 0));
147 if (!pspy_initialize (self
.get ()))
151 return (PyObject
*) self
.release ();
155 pspy_get_printers (PyObject
*o
, void *ignore
)
157 pspace_object
*self
= (pspace_object
*) o
;
159 Py_INCREF (self
->printers
);
160 return self
->printers
;
164 pspy_set_printers (PyObject
*o
, PyObject
*value
, void *ignore
)
166 pspace_object
*self
= (pspace_object
*) o
;
170 PyErr_SetString (PyExc_TypeError
,
171 "cannot delete the pretty_printers attribute");
175 if (! PyList_Check (value
))
177 PyErr_SetString (PyExc_TypeError
,
178 "the pretty_printers attribute must be a list");
182 /* Take care in case the LHS and RHS are related somehow. */
183 gdbpy_ref
<> tmp (self
->printers
);
185 self
->printers
= value
;
190 /* Return the Python dictionary attribute containing frame filters for
191 this program space. */
193 pspy_get_frame_filters (PyObject
*o
, void *ignore
)
195 pspace_object
*self
= (pspace_object
*) o
;
197 Py_INCREF (self
->frame_filters
);
198 return self
->frame_filters
;
201 /* Set this object file's frame filters dictionary to FILTERS. */
203 pspy_set_frame_filters (PyObject
*o
, PyObject
*frame
, void *ignore
)
205 pspace_object
*self
= (pspace_object
*) o
;
209 PyErr_SetString (PyExc_TypeError
,
210 "cannot delete the frame filter attribute");
214 if (! PyDict_Check (frame
))
216 PyErr_SetString (PyExc_TypeError
,
217 "the frame filter attribute must be a dictionary");
221 /* Take care in case the LHS and RHS are related somehow. */
222 gdbpy_ref
<> tmp (self
->frame_filters
);
224 self
->frame_filters
= frame
;
229 /* Return the list of the frame unwinders for this program space. */
232 pspy_get_frame_unwinders (PyObject
*o
, void *ignore
)
234 pspace_object
*self
= (pspace_object
*) o
;
236 Py_INCREF (self
->frame_unwinders
);
237 return self
->frame_unwinders
;
240 /* Set this program space's list of the unwinders to UNWINDERS. */
243 pspy_set_frame_unwinders (PyObject
*o
, PyObject
*unwinders
, void *ignore
)
245 pspace_object
*self
= (pspace_object
*) o
;
249 PyErr_SetString (PyExc_TypeError
,
250 "cannot delete the frame unwinders list");
254 if (!PyList_Check (unwinders
))
256 PyErr_SetString (PyExc_TypeError
,
257 "the frame unwinders attribute must be a list");
261 /* Take care in case the LHS and RHS are related somehow. */
262 gdbpy_ref
<> tmp (self
->frame_unwinders
);
263 Py_INCREF (unwinders
);
264 self
->frame_unwinders
= unwinders
;
269 /* Get the 'type_printers' attribute. */
272 pspy_get_type_printers (PyObject
*o
, void *ignore
)
274 pspace_object
*self
= (pspace_object
*) o
;
276 Py_INCREF (self
->type_printers
);
277 return self
->type_printers
;
280 /* Get the 'xmethods' attribute. */
283 pspy_get_xmethods (PyObject
*o
, void *ignore
)
285 pspace_object
*self
= (pspace_object
*) o
;
287 Py_INCREF (self
->xmethods
);
288 return self
->xmethods
;
291 /* Set the 'type_printers' attribute. */
294 pspy_set_type_printers (PyObject
*o
, PyObject
*value
, void *ignore
)
296 pspace_object
*self
= (pspace_object
*) o
;
300 PyErr_SetString (PyExc_TypeError
,
301 "cannot delete the type_printers attribute");
305 if (! PyList_Check (value
))
307 PyErr_SetString (PyExc_TypeError
,
308 "the type_printers attribute must be a list");
312 /* Take care in case the LHS and RHS are related somehow. */
313 gdbpy_ref
<> tmp (self
->type_printers
);
315 self
->type_printers
= value
;
320 /* Implement the objfiles method. */
323 pspy_get_objfiles (PyObject
*self_
, PyObject
*args
)
325 pspace_object
*self
= (pspace_object
*) self_
;
327 PSPY_REQUIRE_VALID (self
);
329 gdbpy_ref
<> list (PyList_New (0));
333 if (self
->pspace
!= NULL
)
335 for (objfile
*objf
: self
->pspace
->objfiles ())
337 gdbpy_ref
<> item
= objfile_to_objfile_object (objf
);
340 || PyList_Append (list
.get (), item
.get ()) == -1)
345 return list
.release ();
348 /* Implementation of solib_name (Long) -> String.
349 Returns the name of the shared library holding a given address, or None. */
352 pspy_solib_name (PyObject
*o
, PyObject
*args
)
356 pspace_object
*self
= (pspace_object
*) o
;
358 PSPY_REQUIRE_VALID (self
);
360 if (!PyArg_ParseTuple (args
, GDB_PY_LLU_ARG
, &pc
))
363 soname
= solib_name_from_address (self
->pspace
, pc
);
364 if (soname
== nullptr)
366 return host_string_to_python_string (soname
).release ();
369 /* Return the innermost lexical block containing the specified pc value,
370 or 0 if there is none. */
372 pspy_block_for_pc (PyObject
*o
, PyObject
*args
)
374 pspace_object
*self
= (pspace_object
*) o
;
376 const struct block
*block
= NULL
;
377 struct compunit_symtab
*cust
= NULL
;
379 PSPY_REQUIRE_VALID (self
);
381 if (!PyArg_ParseTuple (args
, GDB_PY_LLU_ARG
, &pc
))
386 scoped_restore_current_program_space saver
;
388 set_current_program_space (self
->pspace
);
389 cust
= find_pc_compunit_symtab (pc
);
391 if (cust
!= NULL
&& COMPUNIT_OBJFILE (cust
) != NULL
)
392 block
= block_for_pc (pc
);
394 CATCH (except
, RETURN_MASK_ALL
)
396 GDB_PY_HANDLE_EXCEPTION (except
);
400 if (cust
== NULL
|| COMPUNIT_OBJFILE (cust
) == NULL
)
402 PyErr_SetString (PyExc_RuntimeError
,
403 _("Cannot locate object file for block."));
408 return block_to_block_object (block
, COMPUNIT_OBJFILE (cust
));
413 /* Implementation of the find_pc_line function.
414 Returns the gdb.Symtab_and_line object corresponding to a PC value. */
417 pspy_find_pc_line (PyObject
*o
, PyObject
*args
)
419 gdb_py_ulongest pc_llu
;
420 PyObject
*result
= NULL
; /* init for gcc -Wall */
421 pspace_object
*self
= (pspace_object
*) o
;
423 PSPY_REQUIRE_VALID (self
);
425 if (!PyArg_ParseTuple (args
, GDB_PY_LLU_ARG
, &pc_llu
))
430 struct symtab_and_line sal
;
432 scoped_restore_current_program_space saver
;
434 set_current_program_space (self
->pspace
);
436 pc
= (CORE_ADDR
) pc_llu
;
437 sal
= find_pc_line (pc
, 0);
438 result
= symtab_and_line_to_sal_object (sal
);
440 CATCH (except
, RETURN_MASK_ALL
)
442 GDB_PY_HANDLE_EXCEPTION (except
);
449 /* Implementation of is_valid (self) -> Boolean.
450 Returns True if this program space still exists in GDB. */
453 pspy_is_valid (PyObject
*o
, PyObject
*args
)
455 pspace_object
*self
= (pspace_object
*) o
;
457 if (self
->pspace
== NULL
)
465 /* Clear the PSPACE pointer in a Pspace object and remove the reference. */
468 py_free_pspace (struct program_space
*pspace
, void *datum
)
470 /* This is a fiction, but we're in a nasty spot: The pspace is in the
471 process of being deleted, we can't rely on anything in it. Plus
472 this is one time when the current program space and current inferior
473 are not in sync: All inferiors that use PSPACE may no longer exist.
474 We don't need to do much here, and since "there is always an inferior"
475 using target_gdbarch suffices.
476 Note: We cannot call get_current_arch because it may try to access
477 the target, which may involve accessing data in the pspace currently
479 struct gdbarch
*arch
= target_gdbarch ();
481 gdbpy_enter
enter_py (arch
, current_language
);
482 gdbpy_ref
<pspace_object
> object ((pspace_object
*) datum
);
483 object
->pspace
= NULL
;
486 /* Return a new reference to the Python object of type Pspace
487 representing PSPACE. If the object has already been created,
488 return it. Otherwise, create it. Return NULL and set the Python
492 pspace_to_pspace_object (struct program_space
*pspace
)
495 ((PyObject
*) program_space_data (pspace
, pspy_pspace_data_key
));
498 gdbpy_ref
<pspace_object
> object
499 ((pspace_object
*) PyObject_New (pspace_object
, &pspace_object_type
));
502 if (!pspy_initialize (object
.get ()))
505 object
->pspace
= pspace
;
506 set_program_space_data (pspace
, pspy_pspace_data_key
, object
.get ());
507 result
= (PyObject
*) object
.release ();
510 return gdbpy_ref
<>::new_reference (result
);
514 gdbpy_initialize_pspace (void)
517 = register_program_space_data_with_cleanup (NULL
, py_free_pspace
);
519 if (PyType_Ready (&pspace_object_type
) < 0)
522 return gdb_pymodule_addobject (gdb_module
, "Progspace",
523 (PyObject
*) &pspace_object_type
);
528 static gdb_PyGetSetDef pspace_getset
[] =
530 { "__dict__", gdb_py_generic_dict
, NULL
,
531 "The __dict__ for this progspace.", &pspace_object_type
},
532 { "filename", pspy_get_filename
, NULL
,
533 "The progspace's main filename, or None.", NULL
},
534 { "pretty_printers", pspy_get_printers
, pspy_set_printers
,
535 "Pretty printers.", NULL
},
536 { "frame_filters", pspy_get_frame_filters
, pspy_set_frame_filters
,
537 "Frame filters.", NULL
},
538 { "frame_unwinders", pspy_get_frame_unwinders
, pspy_set_frame_unwinders
,
539 "Frame unwinders.", NULL
},
540 { "type_printers", pspy_get_type_printers
, pspy_set_type_printers
,
541 "Type printers.", NULL
},
542 { "xmethods", pspy_get_xmethods
, NULL
,
543 "Debug methods.", NULL
},
547 static PyMethodDef progspace_object_methods
[] =
549 { "objfiles", pspy_get_objfiles
, METH_NOARGS
,
550 "Return a sequence of objfiles associated to this program space." },
551 { "solib_name", pspy_solib_name
, METH_VARARGS
,
552 "solib_name (Long) -> String.\n\
553 Return the name of the shared library holding a given address, or None." },
554 { "block_for_pc", pspy_block_for_pc
, METH_VARARGS
,
555 "Return the block containing the given pc value, or None." },
556 { "find_pc_line", pspy_find_pc_line
, METH_VARARGS
,
557 "find_pc_line (pc) -> Symtab_and_line.\n\
558 Return the gdb.Symtab_and_line object corresponding to the pc value." },
559 { "is_valid", pspy_is_valid
, METH_NOARGS
,
560 "is_valid () -> Boolean.\n\
561 Return true if this program space is valid, false if not." },
565 PyTypeObject pspace_object_type
=
567 PyVarObject_HEAD_INIT (NULL
, 0)
568 "gdb.Progspace", /*tp_name*/
569 sizeof (pspace_object
), /*tp_basicsize*/
571 pspy_dealloc
, /*tp_dealloc*/
578 0, /*tp_as_sequence*/
586 Py_TPFLAGS_DEFAULT
, /*tp_flags*/
587 "GDB progspace object", /* tp_doc */
590 0, /* tp_richcompare */
591 0, /* tp_weaklistoffset */
594 progspace_object_methods
, /* tp_methods */
596 pspace_getset
, /* tp_getset */
599 0, /* tp_descr_get */
600 0, /* tp_descr_set */
601 offsetof (pspace_object
, dict
), /* tp_dictoffset */
604 pspy_new
, /* tp_new */