1 /* Python interface to program spaces.
3 Copyright (C) 2010-2015 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"
32 /* The corresponding pspace. */
33 struct program_space
*pspace
;
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 frame unwinder list. */
46 PyObject
*frame_unwinders
;
48 /* The type-printer list. */
49 PyObject
*type_printers
;
51 /* The debug method list. */
55 extern PyTypeObject pspace_object_type
56 CPYCHECKER_TYPE_OBJECT_FOR_TYPEDEF ("pspace_object");
58 static const struct program_space_data
*pspy_pspace_data_key
;
62 /* An Objfile method which returns the objfile's file name, or None. */
65 pspy_get_filename (PyObject
*self
, void *closure
)
67 pspace_object
*obj
= (pspace_object
*) self
;
71 struct objfile
*objfile
= obj
->pspace
->symfile_object_file
;
74 return PyString_Decode (objfile_name (objfile
),
75 strlen (objfile_name (objfile
)),
76 host_charset (), NULL
);
82 pspy_dealloc (PyObject
*self
)
84 pspace_object
*ps_self
= (pspace_object
*) self
;
86 Py_XDECREF (ps_self
->dict
);
87 Py_XDECREF (ps_self
->printers
);
88 Py_XDECREF (ps_self
->frame_filters
);
89 Py_XDECREF (ps_self
->frame_unwinders
);
90 Py_XDECREF (ps_self
->type_printers
);
91 Py_XDECREF (ps_self
->xmethods
);
92 Py_TYPE (self
)->tp_free (self
);
95 /* Initialize a pspace_object.
96 The result is a boolean indicating success. */
99 pspy_initialize (pspace_object
*self
)
104 self
->printers
= PyList_New (0);
105 if (self
->printers
== NULL
)
108 self
->frame_filters
= PyDict_New ();
109 if (self
->frame_filters
== NULL
)
112 self
->frame_unwinders
= PyList_New (0);
113 if (self
->frame_unwinders
== NULL
)
116 self
->type_printers
= PyList_New (0);
117 if (self
->type_printers
== NULL
)
120 self
->xmethods
= PyList_New (0);
121 if (self
->xmethods
== NULL
)
128 pspy_new (PyTypeObject
*type
, PyObject
*args
, PyObject
*keywords
)
130 pspace_object
*self
= (pspace_object
*) type
->tp_alloc (type
, 0);
134 if (!pspy_initialize (self
))
141 return (PyObject
*) self
;
145 pspy_get_printers (PyObject
*o
, void *ignore
)
147 pspace_object
*self
= (pspace_object
*) o
;
149 Py_INCREF (self
->printers
);
150 return self
->printers
;
154 pspy_set_printers (PyObject
*o
, PyObject
*value
, void *ignore
)
157 pspace_object
*self
= (pspace_object
*) o
;
161 PyErr_SetString (PyExc_TypeError
,
162 "cannot delete the pretty_printers attribute");
166 if (! PyList_Check (value
))
168 PyErr_SetString (PyExc_TypeError
,
169 "the pretty_printers attribute must be a list");
173 /* Take care in case the LHS and RHS are related somehow. */
174 tmp
= self
->printers
;
176 self
->printers
= value
;
182 /* Return the Python dictionary attribute containing frame filters for
183 this program space. */
185 pspy_get_frame_filters (PyObject
*o
, void *ignore
)
187 pspace_object
*self
= (pspace_object
*) o
;
189 Py_INCREF (self
->frame_filters
);
190 return self
->frame_filters
;
193 /* Set this object file's frame filters dictionary to FILTERS. */
195 pspy_set_frame_filters (PyObject
*o
, PyObject
*frame
, void *ignore
)
198 pspace_object
*self
= (pspace_object
*) o
;
202 PyErr_SetString (PyExc_TypeError
,
203 "cannot delete the frame filter attribute");
207 if (! PyDict_Check (frame
))
209 PyErr_SetString (PyExc_TypeError
,
210 "the frame filter attribute must be a dictionary");
214 /* Take care in case the LHS and RHS are related somehow. */
215 tmp
= self
->frame_filters
;
217 self
->frame_filters
= frame
;
223 /* Return the list of the frame unwinders for this program space. */
226 pspy_get_frame_unwinders (PyObject
*o
, void *ignore
)
228 pspace_object
*self
= (pspace_object
*) o
;
230 Py_INCREF (self
->frame_unwinders
);
231 return self
->frame_unwinders
;
234 /* Set this program space's list of the unwinders to UNWINDERS. */
237 pspy_set_frame_unwinders (PyObject
*o
, PyObject
*unwinders
, void *ignore
)
240 pspace_object
*self
= (pspace_object
*) o
;
244 PyErr_SetString (PyExc_TypeError
,
245 "cannot delete the frame unwinders list");
249 if (!PyList_Check (unwinders
))
251 PyErr_SetString (PyExc_TypeError
,
252 "the frame unwinders attribute must be a list");
256 /* Take care in case the LHS and RHS are related somehow. */
257 tmp
= self
->frame_unwinders
;
258 Py_INCREF (unwinders
);
259 self
->frame_unwinders
= unwinders
;
265 /* Get the 'type_printers' attribute. */
268 pspy_get_type_printers (PyObject
*o
, void *ignore
)
270 pspace_object
*self
= (pspace_object
*) o
;
272 Py_INCREF (self
->type_printers
);
273 return self
->type_printers
;
276 /* Get the 'xmethods' attribute. */
279 pspy_get_xmethods (PyObject
*o
, void *ignore
)
281 pspace_object
*self
= (pspace_object
*) o
;
283 Py_INCREF (self
->xmethods
);
284 return self
->xmethods
;
287 /* Set the 'type_printers' attribute. */
290 pspy_set_type_printers (PyObject
*o
, PyObject
*value
, void *ignore
)
293 pspace_object
*self
= (pspace_object
*) o
;
297 PyErr_SetString (PyExc_TypeError
,
298 "cannot delete the type_printers attribute");
302 if (! PyList_Check (value
))
304 PyErr_SetString (PyExc_TypeError
,
305 "the type_printers attribute must be a list");
309 /* Take care in case the LHS and RHS are related somehow. */
310 tmp
= self
->type_printers
;
312 self
->type_printers
= value
;
320 /* Clear the PSPACE pointer in a Pspace object and remove the reference. */
323 py_free_pspace (struct program_space
*pspace
, void *datum
)
325 struct cleanup
*cleanup
;
326 pspace_object
*object
= datum
;
327 /* This is a fiction, but we're in a nasty spot: The pspace is in the
328 process of being deleted, we can't rely on anything in it. Plus
329 this is one time when the current program space and current inferior
330 are not in sync: All inferiors that use PSPACE may no longer exist.
331 We don't need to do much here, and since "there is always an inferior"
332 using target_gdbarch suffices.
333 Note: We cannot call get_current_arch because it may try to access
334 the target, which may involve accessing data in the pspace currently
336 struct gdbarch
*arch
= target_gdbarch ();
338 cleanup
= ensure_python_env (arch
, current_language
);
339 object
->pspace
= NULL
;
340 Py_DECREF ((PyObject
*) object
);
341 do_cleanups (cleanup
);
344 /* Return a borrowed reference to the Python object of type Pspace
345 representing PSPACE. If the object has already been created,
346 return it. Otherwise, create it. Return NULL and set the Python
350 pspace_to_pspace_object (struct program_space
*pspace
)
352 pspace_object
*object
;
354 object
= program_space_data (pspace
, pspy_pspace_data_key
);
357 object
= PyObject_New (pspace_object
, &pspace_object_type
);
360 if (!pspy_initialize (object
))
366 object
->pspace
= pspace
;
367 set_program_space_data (pspace
, pspy_pspace_data_key
, object
);
371 return (PyObject
*) object
;
375 gdbpy_initialize_pspace (void)
378 = register_program_space_data_with_cleanup (NULL
, py_free_pspace
);
380 if (PyType_Ready (&pspace_object_type
) < 0)
383 return gdb_pymodule_addobject (gdb_module
, "Progspace",
384 (PyObject
*) &pspace_object_type
);
389 static PyGetSetDef pspace_getset
[] =
391 { "__dict__", gdb_py_generic_dict
, NULL
,
392 "The __dict__ for this progspace.", &pspace_object_type
},
393 { "filename", pspy_get_filename
, NULL
,
394 "The progspace's main filename, or None.", NULL
},
395 { "pretty_printers", pspy_get_printers
, pspy_set_printers
,
396 "Pretty printers.", NULL
},
397 { "frame_filters", pspy_get_frame_filters
, pspy_set_frame_filters
,
398 "Frame filters.", NULL
},
399 { "frame_unwinders", pspy_get_frame_unwinders
, pspy_set_frame_unwinders
,
400 "Frame unwinders.", NULL
},
401 { "type_printers", pspy_get_type_printers
, pspy_set_type_printers
,
402 "Type printers.", NULL
},
403 { "xmethods", pspy_get_xmethods
, NULL
,
404 "Debug methods.", NULL
},
408 PyTypeObject pspace_object_type
=
410 PyVarObject_HEAD_INIT (NULL
, 0)
411 "gdb.Progspace", /*tp_name*/
412 sizeof (pspace_object
), /*tp_basicsize*/
414 pspy_dealloc
, /*tp_dealloc*/
421 0, /*tp_as_sequence*/
429 Py_TPFLAGS_DEFAULT
, /*tp_flags*/
430 "GDB progspace object", /* tp_doc */
433 0, /* tp_richcompare */
434 0, /* tp_weaklistoffset */
439 pspace_getset
, /* tp_getset */
442 0, /* tp_descr_get */
443 0, /* tp_descr_set */
444 offsetof (pspace_object
, dict
), /* tp_dictoffset */
447 pspy_new
, /* tp_new */