1 /* Python interface to inferior threads.
3 Copyright (C) 2009-2013 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 "exceptions.h"
22 #include "gdbthread.h"
24 #include "python-internal.h"
26 static PyTypeObject thread_object_type
27 CPYCHECKER_TYPE_OBJECT_FOR_TYPEDEF ("thread_object");
29 /* Require that INFERIOR be a valid inferior ID. */
30 #define THPY_REQUIRE_VALID(Thread) \
32 if (!Thread->thread) \
34 PyErr_SetString (PyExc_RuntimeError, \
35 _("Thread no longer exists.")); \
43 create_thread_object (struct thread_info
*tp
)
45 thread_object
*thread_obj
;
47 thread_obj
= PyObject_New (thread_object
, &thread_object_type
);
51 thread_obj
->thread
= tp
;
52 thread_obj
->inf_obj
= find_inferior_object (ptid_get_pid (tp
->ptid
));
60 thpy_dealloc (PyObject
*self
)
62 Py_DECREF (((thread_object
*) self
)->inf_obj
);
63 Py_TYPE (self
)->tp_free (self
);
67 thpy_get_name (PyObject
*self
, void *ignore
)
69 thread_object
*thread_obj
= (thread_object
*) self
;
72 THPY_REQUIRE_VALID (thread_obj
);
74 name
= thread_obj
->thread
->name
;
76 name
= target_thread_name (thread_obj
->thread
);
81 return PyString_FromString (name
);
85 thpy_set_name (PyObject
*self
, PyObject
*newvalue
, void *ignore
)
87 thread_object
*thread_obj
= (thread_object
*) self
;
90 if (! thread_obj
->thread
)
92 PyErr_SetString (PyExc_RuntimeError
, _("Thread no longer exists."));
98 PyErr_SetString (PyExc_TypeError
,
99 _("Cannot delete `name' attribute."));
102 else if (newvalue
== Py_None
)
104 else if (! gdbpy_is_string (newvalue
))
106 PyErr_SetString (PyExc_TypeError
,
107 _("The value of `name' must be a string."));
112 name
= python_string_to_host_string (newvalue
);
117 xfree (thread_obj
->thread
->name
);
118 thread_obj
->thread
->name
= name
;
124 thpy_get_num (PyObject
*self
, void *closure
)
126 thread_object
*thread_obj
= (thread_object
*) self
;
128 THPY_REQUIRE_VALID (thread_obj
);
130 return PyLong_FromLong (thread_obj
->thread
->num
);
133 /* Getter for InferiorThread.ptid -> (pid, lwp, tid).
134 Returns a tuple with the thread's ptid components. */
136 thpy_get_ptid (PyObject
*self
, void *closure
)
140 thread_object
*thread_obj
= (thread_object
*) self
;
143 THPY_REQUIRE_VALID (thread_obj
);
145 ret
= PyTuple_New (3);
149 pid
= ptid_get_pid (thread_obj
->thread
->ptid
);
150 lwp
= ptid_get_lwp (thread_obj
->thread
->ptid
);
151 tid
= ptid_get_tid (thread_obj
->thread
->ptid
);
153 PyTuple_SET_ITEM (ret
, 0, PyInt_FromLong (pid
));
154 PyTuple_SET_ITEM (ret
, 1, PyInt_FromLong (lwp
));
155 PyTuple_SET_ITEM (ret
, 2, PyInt_FromLong (tid
));
160 /* Implementation of InferiorThread.switch ().
161 Makes this the GDB selected thread. */
163 thpy_switch (PyObject
*self
, PyObject
*args
)
165 thread_object
*thread_obj
= (thread_object
*) self
;
166 volatile struct gdb_exception except
;
168 THPY_REQUIRE_VALID (thread_obj
);
170 TRY_CATCH (except
, RETURN_MASK_ALL
)
172 switch_to_thread (thread_obj
->thread
->ptid
);
174 GDB_PY_HANDLE_EXCEPTION (except
);
179 /* Implementation of InferiorThread.is_stopped () -> Boolean.
180 Return whether the thread is stopped. */
182 thpy_is_stopped (PyObject
*self
, PyObject
*args
)
184 thread_object
*thread_obj
= (thread_object
*) self
;
186 THPY_REQUIRE_VALID (thread_obj
);
188 if (is_stopped (thread_obj
->thread
->ptid
))
194 /* Implementation of InferiorThread.is_running () -> Boolean.
195 Return whether the thread is running. */
197 thpy_is_running (PyObject
*self
, PyObject
*args
)
199 thread_object
*thread_obj
= (thread_object
*) self
;
201 THPY_REQUIRE_VALID (thread_obj
);
203 if (is_running (thread_obj
->thread
->ptid
))
209 /* Implementation of InferiorThread.is_exited () -> Boolean.
210 Return whether the thread is exited. */
212 thpy_is_exited (PyObject
*self
, PyObject
*args
)
214 thread_object
*thread_obj
= (thread_object
*) self
;
216 THPY_REQUIRE_VALID (thread_obj
);
218 if (is_exited (thread_obj
->thread
->ptid
))
224 /* Implementation of gdb.InfThread.is_valid (self) -> Boolean.
225 Returns True if this inferior Thread object still exists
229 thpy_is_valid (PyObject
*self
, PyObject
*args
)
231 thread_object
*thread_obj
= (thread_object
*) self
;
233 if (! thread_obj
->thread
)
239 /* Implementation of gdb.selected_thread () -> gdb.InferiorThread.
240 Returns the selected thread object. */
242 gdbpy_selected_thread (PyObject
*self
, PyObject
*args
)
244 PyObject
*thread_obj
;
246 thread_obj
= (PyObject
*) find_thread_object (inferior_ptid
);
249 Py_INCREF (thread_obj
);
259 gdbpy_initialize_thread (void)
261 if (PyType_Ready (&thread_object_type
) < 0)
264 return gdb_pymodule_addobject (gdb_module
, "InferiorThread",
265 (PyObject
*) &thread_object_type
);
270 static PyGetSetDef thread_object_getset
[] =
272 { "name", thpy_get_name
, thpy_set_name
,
273 "The name of the thread, as set by the user or the OS.", NULL
},
274 { "num", thpy_get_num
, NULL
, "ID of the thread, as assigned by GDB.", NULL
},
275 { "ptid", thpy_get_ptid
, NULL
, "ID of the thread, as assigned by the OS.",
281 static PyMethodDef thread_object_methods
[] =
283 { "is_valid", thpy_is_valid
, METH_NOARGS
,
284 "is_valid () -> Boolean.\n\
285 Return true if this inferior thread is valid, false if not." },
286 { "switch", thpy_switch
, METH_NOARGS
,
288 Makes this the GDB selected thread." },
289 { "is_stopped", thpy_is_stopped
, METH_NOARGS
,
290 "is_stopped () -> Boolean\n\
291 Return whether the thread is stopped." },
292 { "is_running", thpy_is_running
, METH_NOARGS
,
293 "is_running () -> Boolean\n\
294 Return whether the thread is running." },
295 { "is_exited", thpy_is_exited
, METH_NOARGS
,
296 "is_exited () -> Boolean\n\
297 Return whether the thread is exited." },
302 static PyTypeObject thread_object_type
=
304 PyVarObject_HEAD_INIT (NULL
, 0)
305 "gdb.InferiorThread", /*tp_name*/
306 sizeof (thread_object
), /*tp_basicsize*/
308 thpy_dealloc
, /*tp_dealloc*/
315 0, /*tp_as_sequence*/
323 Py_TPFLAGS_DEFAULT
| Py_TPFLAGS_HAVE_ITER
, /*tp_flags*/
324 "GDB thread object", /* tp_doc */
327 0, /* tp_richcompare */
328 0, /* tp_weaklistoffset */
331 thread_object_methods
, /* tp_methods */
333 thread_object_getset
, /* tp_getset */
336 0, /* tp_descr_get */
337 0, /* tp_descr_set */
338 0, /* tp_dictoffset */