1 /* Python interface to inferior threads.
3 Copyright (C) 2009-2016 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 "gdbthread.h"
23 #include "python-internal.h"
25 extern PyTypeObject thread_object_type
26 CPYCHECKER_TYPE_OBJECT_FOR_TYPEDEF ("thread_object");
28 /* Require that INFERIOR be a valid inferior ID. */
29 #define THPY_REQUIRE_VALID(Thread) \
31 if (!Thread->thread) \
33 PyErr_SetString (PyExc_RuntimeError, \
34 _("Thread no longer exists.")); \
40 create_thread_object (struct thread_info
*tp
)
42 thread_object
*thread_obj
;
44 thread_obj
= PyObject_New (thread_object
, &thread_object_type
);
48 thread_obj
->thread
= tp
;
49 thread_obj
->inf_obj
= find_inferior_object (ptid_get_pid (tp
->ptid
));
55 thpy_dealloc (PyObject
*self
)
57 Py_DECREF (((thread_object
*) self
)->inf_obj
);
58 Py_TYPE (self
)->tp_free (self
);
62 thpy_get_name (PyObject
*self
, void *ignore
)
64 thread_object
*thread_obj
= (thread_object
*) self
;
67 THPY_REQUIRE_VALID (thread_obj
);
69 name
= thread_obj
->thread
->name
;
71 name
= target_thread_name (thread_obj
->thread
);
76 return PyString_FromString (name
);
80 thpy_set_name (PyObject
*self
, PyObject
*newvalue
, void *ignore
)
82 thread_object
*thread_obj
= (thread_object
*) self
;
85 if (! thread_obj
->thread
)
87 PyErr_SetString (PyExc_RuntimeError
, _("Thread no longer exists."));
93 PyErr_SetString (PyExc_TypeError
,
94 _("Cannot delete `name' attribute."));
97 else if (newvalue
== Py_None
)
99 else if (! gdbpy_is_string (newvalue
))
101 PyErr_SetString (PyExc_TypeError
,
102 _("The value of `name' must be a string."));
107 name
= python_string_to_host_string (newvalue
);
112 xfree (thread_obj
->thread
->name
);
113 thread_obj
->thread
->name
= name
;
118 /* Getter for InferiorThread.num. */
121 thpy_get_num (PyObject
*self
, void *closure
)
123 thread_object
*thread_obj
= (thread_object
*) self
;
125 THPY_REQUIRE_VALID (thread_obj
);
127 return PyLong_FromLong (thread_obj
->thread
->per_inf_num
);
130 /* Getter for InferiorThread.ptid -> (pid, lwp, tid).
131 Returns a tuple with the thread's ptid components. */
134 thpy_get_ptid (PyObject
*self
, void *closure
)
138 thread_object
*thread_obj
= (thread_object
*) self
;
140 THPY_REQUIRE_VALID (thread_obj
);
142 return gdbpy_create_ptid_object (thread_obj
->thread
->ptid
);
145 /* Getter for InferiorThread.inferior -> Inferior. */
148 thpy_get_inferior (PyObject
*self
, void *ignore
)
150 thread_object
*thread_obj
= (thread_object
*) self
;
152 THPY_REQUIRE_VALID (thread_obj
);
154 return thread_obj
->inf_obj
;
157 /* Implementation of InferiorThread.switch ().
158 Makes this the GDB selected thread. */
161 thpy_switch (PyObject
*self
, PyObject
*args
)
163 thread_object
*thread_obj
= (thread_object
*) self
;
165 THPY_REQUIRE_VALID (thread_obj
);
169 switch_to_thread (thread_obj
->thread
->ptid
);
171 CATCH (except
, RETURN_MASK_ALL
)
173 GDB_PY_HANDLE_EXCEPTION (except
);
180 /* Implementation of InferiorThread.is_stopped () -> Boolean.
181 Return whether the thread is stopped. */
184 thpy_is_stopped (PyObject
*self
, PyObject
*args
)
186 thread_object
*thread_obj
= (thread_object
*) self
;
188 THPY_REQUIRE_VALID (thread_obj
);
190 if (is_stopped (thread_obj
->thread
->ptid
))
196 /* Implementation of InferiorThread.is_running () -> Boolean.
197 Return whether the thread is running. */
200 thpy_is_running (PyObject
*self
, PyObject
*args
)
202 thread_object
*thread_obj
= (thread_object
*) self
;
204 THPY_REQUIRE_VALID (thread_obj
);
206 if (is_running (thread_obj
->thread
->ptid
))
212 /* Implementation of InferiorThread.is_exited () -> Boolean.
213 Return whether the thread is exited. */
216 thpy_is_exited (PyObject
*self
, PyObject
*args
)
218 thread_object
*thread_obj
= (thread_object
*) self
;
220 THPY_REQUIRE_VALID (thread_obj
);
222 if (is_exited (thread_obj
->thread
->ptid
))
228 /* Implementation of gdb.InfThread.is_valid (self) -> Boolean.
229 Returns True if this inferior Thread object still exists
233 thpy_is_valid (PyObject
*self
, PyObject
*args
)
235 thread_object
*thread_obj
= (thread_object
*) self
;
237 if (! thread_obj
->thread
)
243 /* Return a reference to a new Python object representing a ptid_t.
244 The object is a tuple containing (pid, lwp, tid). */
246 gdbpy_create_ptid_object (ptid_t ptid
)
252 ret
= PyTuple_New (3);
256 pid
= ptid_get_pid (ptid
);
257 lwp
= ptid_get_lwp (ptid
);
258 tid
= ptid_get_tid (ptid
);
260 PyTuple_SET_ITEM (ret
, 0, PyInt_FromLong (pid
));
261 PyTuple_SET_ITEM (ret
, 1, PyInt_FromLong (lwp
));
262 PyTuple_SET_ITEM (ret
, 2, PyInt_FromLong (tid
));
267 /* Implementation of gdb.selected_thread () -> gdb.InferiorThread.
268 Returns the selected thread object. */
271 gdbpy_selected_thread (PyObject
*self
, PyObject
*args
)
273 PyObject
*thread_obj
;
275 thread_obj
= (PyObject
*) find_thread_object (inferior_ptid
);
278 Py_INCREF (thread_obj
);
286 gdbpy_initialize_thread (void)
288 if (PyType_Ready (&thread_object_type
) < 0)
291 return gdb_pymodule_addobject (gdb_module
, "InferiorThread",
292 (PyObject
*) &thread_object_type
);
295 static PyGetSetDef thread_object_getset
[] =
297 { "name", thpy_get_name
, thpy_set_name
,
298 "The name of the thread, as set by the user or the OS.", NULL
},
299 { "num", thpy_get_num
, NULL
,
300 "Per-inferior number of the thread, as assigned by GDB.", NULL
},
301 { "ptid", thpy_get_ptid
, NULL
, "ID of the thread, as assigned by the OS.",
303 { "inferior", thpy_get_inferior
, NULL
,
304 "The Inferior object this thread belongs to.", NULL
},
309 static PyMethodDef thread_object_methods
[] =
311 { "is_valid", thpy_is_valid
, METH_NOARGS
,
312 "is_valid () -> Boolean.\n\
313 Return true if this inferior thread is valid, false if not." },
314 { "switch", thpy_switch
, METH_NOARGS
,
316 Makes this the GDB selected thread." },
317 { "is_stopped", thpy_is_stopped
, METH_NOARGS
,
318 "is_stopped () -> Boolean\n\
319 Return whether the thread is stopped." },
320 { "is_running", thpy_is_running
, METH_NOARGS
,
321 "is_running () -> Boolean\n\
322 Return whether the thread is running." },
323 { "is_exited", thpy_is_exited
, METH_NOARGS
,
324 "is_exited () -> Boolean\n\
325 Return whether the thread is exited." },
330 PyTypeObject thread_object_type
=
332 PyVarObject_HEAD_INIT (NULL
, 0)
333 "gdb.InferiorThread", /*tp_name*/
334 sizeof (thread_object
), /*tp_basicsize*/
336 thpy_dealloc
, /*tp_dealloc*/
343 0, /*tp_as_sequence*/
351 Py_TPFLAGS_DEFAULT
| Py_TPFLAGS_HAVE_ITER
, /*tp_flags*/
352 "GDB thread object", /* tp_doc */
355 0, /* tp_richcompare */
356 0, /* tp_weaklistoffset */
359 thread_object_methods
, /* tp_methods */
361 thread_object_getset
, /* tp_getset */
364 0, /* tp_descr_get */
365 0, /* tp_descr_set */
366 0, /* tp_dictoffset */