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
)
168 pspace_object
*self
= (pspace_object
*) o
;
172 PyErr_SetString (PyExc_TypeError
,
173 "cannot delete the pretty_printers attribute");
177 if (! PyList_Check (value
))
179 PyErr_SetString (PyExc_TypeError
,
180 "the pretty_printers attribute must be a list");
184 /* Take care in case the LHS and RHS are related somehow. */
185 tmp
= self
->printers
;
187 self
->printers
= value
;
193 /* Return the Python dictionary attribute containing frame filters for
194 this program space. */
196 pspy_get_frame_filters (PyObject
*o
, void *ignore
)
198 pspace_object
*self
= (pspace_object
*) o
;
200 Py_INCREF (self
->frame_filters
);
201 return self
->frame_filters
;
204 /* Set this object file's frame filters dictionary to FILTERS. */
206 pspy_set_frame_filters (PyObject
*o
, PyObject
*frame
, void *ignore
)
209 pspace_object
*self
= (pspace_object
*) o
;
213 PyErr_SetString (PyExc_TypeError
,
214 "cannot delete the frame filter attribute");
218 if (! PyDict_Check (frame
))
220 PyErr_SetString (PyExc_TypeError
,
221 "the frame filter attribute must be a dictionary");
225 /* Take care in case the LHS and RHS are related somehow. */
226 tmp
= self
->frame_filters
;
228 self
->frame_filters
= frame
;
234 /* Return the list of the frame unwinders for this program space. */
237 pspy_get_frame_unwinders (PyObject
*o
, void *ignore
)
239 pspace_object
*self
= (pspace_object
*) o
;
241 Py_INCREF (self
->frame_unwinders
);
242 return self
->frame_unwinders
;
245 /* Set this program space's list of the unwinders to UNWINDERS. */
248 pspy_set_frame_unwinders (PyObject
*o
, PyObject
*unwinders
, void *ignore
)
251 pspace_object
*self
= (pspace_object
*) o
;
255 PyErr_SetString (PyExc_TypeError
,
256 "cannot delete the frame unwinders list");
260 if (!PyList_Check (unwinders
))
262 PyErr_SetString (PyExc_TypeError
,
263 "the frame unwinders attribute must be a list");
267 /* Take care in case the LHS and RHS are related somehow. */
268 tmp
= self
->frame_unwinders
;
269 Py_INCREF (unwinders
);
270 self
->frame_unwinders
= unwinders
;
276 /* Get the 'type_printers' attribute. */
279 pspy_get_type_printers (PyObject
*o
, void *ignore
)
281 pspace_object
*self
= (pspace_object
*) o
;
283 Py_INCREF (self
->type_printers
);
284 return self
->type_printers
;
287 /* Get the 'xmethods' attribute. */
290 pspy_get_xmethods (PyObject
*o
, void *ignore
)
292 pspace_object
*self
= (pspace_object
*) o
;
294 Py_INCREF (self
->xmethods
);
295 return self
->xmethods
;
298 /* Set the 'type_printers' attribute. */
301 pspy_set_type_printers (PyObject
*o
, PyObject
*value
, void *ignore
)
304 pspace_object
*self
= (pspace_object
*) o
;
308 PyErr_SetString (PyExc_TypeError
,
309 "cannot delete the type_printers attribute");
313 if (! PyList_Check (value
))
315 PyErr_SetString (PyExc_TypeError
,
316 "the type_printers attribute must be a list");
320 /* Take care in case the LHS and RHS are related somehow. */
321 tmp
= self
->type_printers
;
323 self
->type_printers
= value
;
329 /* Implement the objfiles method. */
332 pspy_get_objfiles (PyObject
*self_
, PyObject
*args
)
334 pspace_object
*self
= (pspace_object
*) self_
;
336 PSPY_REQUIRE_VALID (self
);
338 gdbpy_ref
<> list (PyList_New (0));
342 if (self
->pspace
!= NULL
)
344 struct objfile
*objf
;
346 ALL_PSPACE_OBJFILES (self
->pspace
, objf
)
348 gdbpy_ref
<> item
= objfile_to_objfile_object (objf
);
351 || PyList_Append (list
.get (), item
.get ()) == -1)
356 return list
.release ();
359 /* Implementation of solib_name (Long) -> String.
360 Returns the name of the shared library holding a given address, or None. */
363 pspy_solib_name (PyObject
*o
, PyObject
*args
)
367 pspace_object
*self
= (pspace_object
*) o
;
369 PSPY_REQUIRE_VALID (self
);
371 if (!PyArg_ParseTuple (args
, GDB_PY_LLU_ARG
, &pc
))
374 soname
= solib_name_from_address (self
->pspace
, pc
);
375 if (soname
== nullptr)
377 return host_string_to_python_string (soname
).release ();
380 /* Return the innermost lexical block containing the specified pc value,
381 or 0 if there is none. */
383 pspy_block_for_pc (PyObject
*o
, PyObject
*args
)
385 pspace_object
*self
= (pspace_object
*) o
;
387 const struct block
*block
= NULL
;
388 struct compunit_symtab
*cust
= NULL
;
390 PSPY_REQUIRE_VALID (self
);
392 if (!PyArg_ParseTuple (args
, GDB_PY_LLU_ARG
, &pc
))
397 scoped_restore_current_program_space saver
;
399 set_current_program_space (self
->pspace
);
400 cust
= find_pc_compunit_symtab (pc
);
402 if (cust
!= NULL
&& COMPUNIT_OBJFILE (cust
) != NULL
)
403 block
= block_for_pc (pc
);
405 CATCH (except
, RETURN_MASK_ALL
)
407 GDB_PY_HANDLE_EXCEPTION (except
);
411 if (cust
== NULL
|| COMPUNIT_OBJFILE (cust
) == NULL
)
413 PyErr_SetString (PyExc_RuntimeError
,
414 _("Cannot locate object file for block."));
419 return block_to_block_object (block
, COMPUNIT_OBJFILE (cust
));
424 /* Implementation of the find_pc_line function.
425 Returns the gdb.Symtab_and_line object corresponding to a PC value. */
428 pspy_find_pc_line (PyObject
*o
, PyObject
*args
)
430 gdb_py_ulongest pc_llu
;
431 PyObject
*result
= NULL
; /* init for gcc -Wall */
432 pspace_object
*self
= (pspace_object
*) o
;
434 PSPY_REQUIRE_VALID (self
);
436 if (!PyArg_ParseTuple (args
, GDB_PY_LLU_ARG
, &pc_llu
))
441 struct symtab_and_line sal
;
443 scoped_restore_current_program_space saver
;
445 set_current_program_space (self
->pspace
);
447 pc
= (CORE_ADDR
) pc_llu
;
448 sal
= find_pc_line (pc
, 0);
449 result
= symtab_and_line_to_sal_object (sal
);
451 CATCH (except
, RETURN_MASK_ALL
)
453 GDB_PY_HANDLE_EXCEPTION (except
);
460 /* Implementation of is_valid (self) -> Boolean.
461 Returns True if this program space still exists in GDB. */
464 pspy_is_valid (PyObject
*o
, PyObject
*args
)
466 pspace_object
*self
= (pspace_object
*) o
;
468 if (self
->pspace
== NULL
)
476 /* Clear the PSPACE pointer in a Pspace object and remove the reference. */
479 py_free_pspace (struct program_space
*pspace
, void *datum
)
481 /* This is a fiction, but we're in a nasty spot: The pspace is in the
482 process of being deleted, we can't rely on anything in it. Plus
483 this is one time when the current program space and current inferior
484 are not in sync: All inferiors that use PSPACE may no longer exist.
485 We don't need to do much here, and since "there is always an inferior"
486 using target_gdbarch suffices.
487 Note: We cannot call get_current_arch because it may try to access
488 the target, which may involve accessing data in the pspace currently
490 struct gdbarch
*arch
= target_gdbarch ();
492 gdbpy_enter
enter_py (arch
, current_language
);
493 gdbpy_ref
<pspace_object
> object ((pspace_object
*) datum
);
494 object
->pspace
= NULL
;
497 /* Return a new reference to the Python object of type Pspace
498 representing PSPACE. If the object has already been created,
499 return it. Otherwise, create it. Return NULL and set the Python
503 pspace_to_pspace_object (struct program_space
*pspace
)
506 ((PyObject
*) program_space_data (pspace
, pspy_pspace_data_key
));
509 gdbpy_ref
<pspace_object
> object
510 ((pspace_object
*) PyObject_New (pspace_object
, &pspace_object_type
));
513 if (!pspy_initialize (object
.get ()))
516 object
->pspace
= pspace
;
517 set_program_space_data (pspace
, pspy_pspace_data_key
, object
.get ());
518 result
= (PyObject
*) object
.release ();
521 return gdbpy_ref
<>::new_reference (result
);
525 gdbpy_initialize_pspace (void)
528 = register_program_space_data_with_cleanup (NULL
, py_free_pspace
);
530 if (PyType_Ready (&pspace_object_type
) < 0)
533 return gdb_pymodule_addobject (gdb_module
, "Progspace",
534 (PyObject
*) &pspace_object_type
);
539 static gdb_PyGetSetDef pspace_getset
[] =
541 { "__dict__", gdb_py_generic_dict
, NULL
,
542 "The __dict__ for this progspace.", &pspace_object_type
},
543 { "filename", pspy_get_filename
, NULL
,
544 "The progspace's main filename, or None.", NULL
},
545 { "pretty_printers", pspy_get_printers
, pspy_set_printers
,
546 "Pretty printers.", NULL
},
547 { "frame_filters", pspy_get_frame_filters
, pspy_set_frame_filters
,
548 "Frame filters.", NULL
},
549 { "frame_unwinders", pspy_get_frame_unwinders
, pspy_set_frame_unwinders
,
550 "Frame unwinders.", NULL
},
551 { "type_printers", pspy_get_type_printers
, pspy_set_type_printers
,
552 "Type printers.", NULL
},
553 { "xmethods", pspy_get_xmethods
, NULL
,
554 "Debug methods.", NULL
},
558 static PyMethodDef progspace_object_methods
[] =
560 { "objfiles", pspy_get_objfiles
, METH_NOARGS
,
561 "Return a sequence of objfiles associated to this program space." },
562 { "solib_name", pspy_solib_name
, METH_VARARGS
,
563 "solib_name (Long) -> String.\n\
564 Return the name of the shared library holding a given address, or None." },
565 { "block_for_pc", pspy_block_for_pc
, METH_VARARGS
,
566 "Return the block containing the given pc value, or None." },
567 { "find_pc_line", pspy_find_pc_line
, METH_VARARGS
,
568 "find_pc_line (pc) -> Symtab_and_line.\n\
569 Return the gdb.Symtab_and_line object corresponding to the pc value." },
570 { "is_valid", pspy_is_valid
, METH_NOARGS
,
571 "is_valid () -> Boolean.\n\
572 Return true if this program space is valid, false if not." },
576 PyTypeObject pspace_object_type
=
578 PyVarObject_HEAD_INIT (NULL
, 0)
579 "gdb.Progspace", /*tp_name*/
580 sizeof (pspace_object
), /*tp_basicsize*/
582 pspy_dealloc
, /*tp_dealloc*/
589 0, /*tp_as_sequence*/
597 Py_TPFLAGS_DEFAULT
, /*tp_flags*/
598 "GDB progspace object", /* tp_doc */
601 0, /* tp_richcompare */
602 0, /* tp_weaklistoffset */
605 progspace_object_methods
, /* tp_methods */
607 pspace_getset
, /* tp_getset */
610 0, /* tp_descr_get */
611 0, /* tp_descr_set */
612 offsetof (pspace_object
, dict
), /* tp_dictoffset */
615 pspy_new
, /* tp_new */