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"
35 /* The corresponding pspace. */
36 struct program_space
*pspace
;
38 /* Dictionary holding user-added attributes.
39 This is the __dict__ attribute of the object. */
42 /* The pretty-printer list of functions. */
45 /* The frame filter list of functions. */
46 PyObject
*frame_filters
;
48 /* The frame unwinder list. */
49 PyObject
*frame_unwinders
;
51 /* The type-printer list. */
52 PyObject
*type_printers
;
54 /* The debug method list. */
58 extern PyTypeObject pspace_object_type
59 CPYCHECKER_TYPE_OBJECT_FOR_TYPEDEF ("pspace_object");
61 static const struct program_space_data
*pspy_pspace_data_key
;
63 /* Require that PSPACE_OBJ be a valid program space ID. */
64 #define PSPY_REQUIRE_VALID(pspace_obj) \
66 if (pspace_obj->pspace == nullptr) \
68 PyErr_SetString (PyExc_RuntimeError, \
69 _("Program space no longer exists.")); \
74 /* An Objfile method which returns the objfile's file name, or None. */
77 pspy_get_filename (PyObject
*self
, void *closure
)
79 pspace_object
*obj
= (pspace_object
*) self
;
83 struct objfile
*objfile
= obj
->pspace
->symfile_object_file
;
86 return (host_string_to_python_string (objfile_name (objfile
))
93 pspy_dealloc (PyObject
*self
)
95 pspace_object
*ps_self
= (pspace_object
*) self
;
97 Py_XDECREF (ps_self
->dict
);
98 Py_XDECREF (ps_self
->printers
);
99 Py_XDECREF (ps_self
->frame_filters
);
100 Py_XDECREF (ps_self
->frame_unwinders
);
101 Py_XDECREF (ps_self
->type_printers
);
102 Py_XDECREF (ps_self
->xmethods
);
103 Py_TYPE (self
)->tp_free (self
);
106 /* Initialize a pspace_object.
107 The result is a boolean indicating success. */
110 pspy_initialize (pspace_object
*self
)
114 self
->dict
= PyDict_New ();
115 if (self
->dict
== NULL
)
118 self
->printers
= PyList_New (0);
119 if (self
->printers
== NULL
)
122 self
->frame_filters
= PyDict_New ();
123 if (self
->frame_filters
== NULL
)
126 self
->frame_unwinders
= PyList_New (0);
127 if (self
->frame_unwinders
== NULL
)
130 self
->type_printers
= PyList_New (0);
131 if (self
->type_printers
== NULL
)
134 self
->xmethods
= PyList_New (0);
135 if (self
->xmethods
== NULL
)
142 pspy_new (PyTypeObject
*type
, PyObject
*args
, PyObject
*keywords
)
144 gdbpy_ref
<pspace_object
> self ((pspace_object
*) type
->tp_alloc (type
, 0));
148 if (!pspy_initialize (self
.get ()))
152 return (PyObject
*) self
.release ();
156 pspy_get_printers (PyObject
*o
, void *ignore
)
158 pspace_object
*self
= (pspace_object
*) o
;
160 Py_INCREF (self
->printers
);
161 return self
->printers
;
165 pspy_set_printers (PyObject
*o
, PyObject
*value
, void *ignore
)
167 pspace_object
*self
= (pspace_object
*) o
;
171 PyErr_SetString (PyExc_TypeError
,
172 "cannot delete the pretty_printers attribute");
176 if (! PyList_Check (value
))
178 PyErr_SetString (PyExc_TypeError
,
179 "the pretty_printers attribute must be a list");
183 /* Take care in case the LHS and RHS are related somehow. */
184 gdbpy_ref
<> tmp (self
->printers
);
186 self
->printers
= value
;
191 /* Return the Python dictionary attribute containing frame filters for
192 this program space. */
194 pspy_get_frame_filters (PyObject
*o
, void *ignore
)
196 pspace_object
*self
= (pspace_object
*) o
;
198 Py_INCREF (self
->frame_filters
);
199 return self
->frame_filters
;
202 /* Set this object file's frame filters dictionary to FILTERS. */
204 pspy_set_frame_filters (PyObject
*o
, PyObject
*frame
, void *ignore
)
206 pspace_object
*self
= (pspace_object
*) o
;
210 PyErr_SetString (PyExc_TypeError
,
211 "cannot delete the frame filter attribute");
215 if (! PyDict_Check (frame
))
217 PyErr_SetString (PyExc_TypeError
,
218 "the frame filter attribute must be a dictionary");
222 /* Take care in case the LHS and RHS are related somehow. */
223 gdbpy_ref
<> tmp (self
->frame_filters
);
225 self
->frame_filters
= frame
;
230 /* Return the list of the frame unwinders for this program space. */
233 pspy_get_frame_unwinders (PyObject
*o
, void *ignore
)
235 pspace_object
*self
= (pspace_object
*) o
;
237 Py_INCREF (self
->frame_unwinders
);
238 return self
->frame_unwinders
;
241 /* Set this program space's list of the unwinders to UNWINDERS. */
244 pspy_set_frame_unwinders (PyObject
*o
, PyObject
*unwinders
, void *ignore
)
246 pspace_object
*self
= (pspace_object
*) o
;
250 PyErr_SetString (PyExc_TypeError
,
251 "cannot delete the frame unwinders list");
255 if (!PyList_Check (unwinders
))
257 PyErr_SetString (PyExc_TypeError
,
258 "the frame unwinders attribute must be a list");
262 /* Take care in case the LHS and RHS are related somehow. */
263 gdbpy_ref
<> tmp (self
->frame_unwinders
);
264 Py_INCREF (unwinders
);
265 self
->frame_unwinders
= unwinders
;
270 /* Get the 'type_printers' attribute. */
273 pspy_get_type_printers (PyObject
*o
, void *ignore
)
275 pspace_object
*self
= (pspace_object
*) o
;
277 Py_INCREF (self
->type_printers
);
278 return self
->type_printers
;
281 /* Get the 'xmethods' attribute. */
284 pspy_get_xmethods (PyObject
*o
, void *ignore
)
286 pspace_object
*self
= (pspace_object
*) o
;
288 Py_INCREF (self
->xmethods
);
289 return self
->xmethods
;
292 /* Set the 'type_printers' attribute. */
295 pspy_set_type_printers (PyObject
*o
, PyObject
*value
, void *ignore
)
297 pspace_object
*self
= (pspace_object
*) o
;
301 PyErr_SetString (PyExc_TypeError
,
302 "cannot delete the type_printers attribute");
306 if (! PyList_Check (value
))
308 PyErr_SetString (PyExc_TypeError
,
309 "the type_printers attribute must be a list");
313 /* Take care in case the LHS and RHS are related somehow. */
314 gdbpy_ref
<> tmp (self
->type_printers
);
316 self
->type_printers
= value
;
321 /* Implement the objfiles method. */
324 pspy_get_objfiles (PyObject
*self_
, PyObject
*args
)
326 pspace_object
*self
= (pspace_object
*) self_
;
328 PSPY_REQUIRE_VALID (self
);
330 gdbpy_ref
<> list (PyList_New (0));
334 if (self
->pspace
!= NULL
)
336 for (objfile
*objf
: self
->pspace
->objfiles ())
338 gdbpy_ref
<> item
= objfile_to_objfile_object (objf
);
341 || PyList_Append (list
.get (), item
.get ()) == -1)
346 return list
.release ();
349 /* Implementation of solib_name (Long) -> String.
350 Returns the name of the shared library holding a given address, or None. */
353 pspy_solib_name (PyObject
*o
, PyObject
*args
)
357 pspace_object
*self
= (pspace_object
*) o
;
359 PSPY_REQUIRE_VALID (self
);
361 if (!PyArg_ParseTuple (args
, GDB_PY_LLU_ARG
, &pc
))
364 soname
= solib_name_from_address (self
->pspace
, pc
);
365 if (soname
== nullptr)
367 return host_string_to_python_string (soname
).release ();
370 /* Return the innermost lexical block containing the specified pc value,
371 or 0 if there is none. */
373 pspy_block_for_pc (PyObject
*o
, PyObject
*args
)
375 pspace_object
*self
= (pspace_object
*) o
;
377 const struct block
*block
= NULL
;
378 struct compunit_symtab
*cust
= NULL
;
380 PSPY_REQUIRE_VALID (self
);
382 if (!PyArg_ParseTuple (args
, GDB_PY_LLU_ARG
, &pc
))
387 scoped_restore_current_program_space saver
;
389 set_current_program_space (self
->pspace
);
390 cust
= find_pc_compunit_symtab (pc
);
392 if (cust
!= NULL
&& COMPUNIT_OBJFILE (cust
) != NULL
)
393 block
= block_for_pc (pc
);
395 CATCH (except
, RETURN_MASK_ALL
)
397 GDB_PY_HANDLE_EXCEPTION (except
);
401 if (cust
== NULL
|| COMPUNIT_OBJFILE (cust
) == NULL
)
403 PyErr_SetString (PyExc_RuntimeError
,
404 _("Cannot locate object file for block."));
409 return block_to_block_object (block
, COMPUNIT_OBJFILE (cust
));
414 /* Implementation of the find_pc_line function.
415 Returns the gdb.Symtab_and_line object corresponding to a PC value. */
418 pspy_find_pc_line (PyObject
*o
, PyObject
*args
)
420 gdb_py_ulongest pc_llu
;
421 PyObject
*result
= NULL
; /* init for gcc -Wall */
422 pspace_object
*self
= (pspace_object
*) o
;
424 PSPY_REQUIRE_VALID (self
);
426 if (!PyArg_ParseTuple (args
, GDB_PY_LLU_ARG
, &pc_llu
))
431 struct symtab_and_line sal
;
433 scoped_restore_current_program_space saver
;
435 set_current_program_space (self
->pspace
);
437 pc
= (CORE_ADDR
) pc_llu
;
438 sal
= find_pc_line (pc
, 0);
439 result
= symtab_and_line_to_sal_object (sal
);
441 CATCH (except
, RETURN_MASK_ALL
)
443 GDB_PY_HANDLE_EXCEPTION (except
);
450 /* Implementation of is_valid (self) -> Boolean.
451 Returns True if this program space still exists in GDB. */
454 pspy_is_valid (PyObject
*o
, PyObject
*args
)
456 pspace_object
*self
= (pspace_object
*) o
;
458 if (self
->pspace
== NULL
)
466 /* Clear the PSPACE pointer in a Pspace object and remove the reference. */
469 py_free_pspace (struct program_space
*pspace
, void *datum
)
471 /* This is a fiction, but we're in a nasty spot: The pspace is in the
472 process of being deleted, we can't rely on anything in it. Plus
473 this is one time when the current program space and current inferior
474 are not in sync: All inferiors that use PSPACE may no longer exist.
475 We don't need to do much here, and since "there is always an inferior"
476 using target_gdbarch suffices.
477 Note: We cannot call get_current_arch because it may try to access
478 the target, which may involve accessing data in the pspace currently
480 struct gdbarch
*arch
= target_gdbarch ();
482 gdbpy_enter
enter_py (arch
, current_language
);
483 gdbpy_ref
<pspace_object
> object ((pspace_object
*) datum
);
484 object
->pspace
= NULL
;
487 /* Return a new reference to the Python object of type Pspace
488 representing PSPACE. If the object has already been created,
489 return it. Otherwise, create it. Return NULL and set the Python
493 pspace_to_pspace_object (struct program_space
*pspace
)
496 ((PyObject
*) program_space_data (pspace
, pspy_pspace_data_key
));
499 gdbpy_ref
<pspace_object
> object
500 ((pspace_object
*) PyObject_New (pspace_object
, &pspace_object_type
));
503 if (!pspy_initialize (object
.get ()))
506 object
->pspace
= pspace
;
507 set_program_space_data (pspace
, pspy_pspace_data_key
, object
.get ());
508 result
= (PyObject
*) object
.release ();
511 return gdbpy_ref
<>::new_reference (result
);
515 gdbpy_initialize_pspace (void)
518 = register_program_space_data_with_cleanup (NULL
, py_free_pspace
);
520 if (PyType_Ready (&pspace_object_type
) < 0)
523 return gdb_pymodule_addobject (gdb_module
, "Progspace",
524 (PyObject
*) &pspace_object_type
);
529 static gdb_PyGetSetDef pspace_getset
[] =
531 { "__dict__", gdb_py_generic_dict
, NULL
,
532 "The __dict__ for this progspace.", &pspace_object_type
},
533 { "filename", pspy_get_filename
, NULL
,
534 "The progspace's main filename, or None.", NULL
},
535 { "pretty_printers", pspy_get_printers
, pspy_set_printers
,
536 "Pretty printers.", NULL
},
537 { "frame_filters", pspy_get_frame_filters
, pspy_set_frame_filters
,
538 "Frame filters.", NULL
},
539 { "frame_unwinders", pspy_get_frame_unwinders
, pspy_set_frame_unwinders
,
540 "Frame unwinders.", NULL
},
541 { "type_printers", pspy_get_type_printers
, pspy_set_type_printers
,
542 "Type printers.", NULL
},
543 { "xmethods", pspy_get_xmethods
, NULL
,
544 "Debug methods.", NULL
},
548 static PyMethodDef progspace_object_methods
[] =
550 { "objfiles", pspy_get_objfiles
, METH_NOARGS
,
551 "Return a sequence of objfiles associated to this program space." },
552 { "solib_name", pspy_solib_name
, METH_VARARGS
,
553 "solib_name (Long) -> String.\n\
554 Return the name of the shared library holding a given address, or None." },
555 { "block_for_pc", pspy_block_for_pc
, METH_VARARGS
,
556 "Return the block containing the given pc value, or None." },
557 { "find_pc_line", pspy_find_pc_line
, METH_VARARGS
,
558 "find_pc_line (pc) -> Symtab_and_line.\n\
559 Return the gdb.Symtab_and_line object corresponding to the pc value." },
560 { "is_valid", pspy_is_valid
, METH_NOARGS
,
561 "is_valid () -> Boolean.\n\
562 Return true if this program space is valid, false if not." },
566 PyTypeObject pspace_object_type
=
568 PyVarObject_HEAD_INIT (NULL
, 0)
569 "gdb.Progspace", /*tp_name*/
570 sizeof (pspace_object
), /*tp_basicsize*/
572 pspy_dealloc
, /*tp_dealloc*/
579 0, /*tp_as_sequence*/
587 Py_TPFLAGS_DEFAULT
, /*tp_flags*/
588 "GDB progspace object", /* tp_doc */
591 0, /* tp_richcompare */
592 0, /* tp_weaklistoffset */
595 progspace_object_methods
, /* tp_methods */
597 pspace_getset
, /* tp_getset */
600 0, /* tp_descr_get */
601 0, /* tp_descr_set */
602 offsetof (pspace_object
, dict
), /* tp_dictoffset */
605 pspy_new
, /* tp_new */