1 /* Python interface to inferior threads.
3 Copyright (C) 2009-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 "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 gdbpy_ref
<inferior_object
> inf_obj
= inferior_to_inferior_object (tp
->inf
);
48 thread_obj
= PyObject_New (thread_object
, &thread_object_type
);
52 thread_obj
->thread
= tp
;
53 thread_obj
->inf_obj
= (PyObject
*) inf_obj
.release ();
59 thpy_dealloc (PyObject
*self
)
61 Py_DECREF (((thread_object
*) self
)->inf_obj
);
62 Py_TYPE (self
)->tp_free (self
);
66 thpy_get_name (PyObject
*self
, void *ignore
)
68 thread_object
*thread_obj
= (thread_object
*) self
;
71 THPY_REQUIRE_VALID (thread_obj
);
73 name
= thread_obj
->thread
->name
;
75 name
= target_thread_name (thread_obj
->thread
);
80 return PyString_FromString (name
);
84 thpy_set_name (PyObject
*self
, PyObject
*newvalue
, void *ignore
)
86 thread_object
*thread_obj
= (thread_object
*) self
;
87 gdb::unique_xmalloc_ptr
<char> name
;
89 if (! thread_obj
->thread
)
91 PyErr_SetString (PyExc_RuntimeError
, _("Thread no longer exists."));
97 PyErr_SetString (PyExc_TypeError
,
98 _("Cannot delete `name' attribute."));
101 else if (newvalue
== Py_None
)
105 else if (! gdbpy_is_string (newvalue
))
107 PyErr_SetString (PyExc_TypeError
,
108 _("The value of `name' must be a string."));
113 name
= python_string_to_host_string (newvalue
);
118 xfree (thread_obj
->thread
->name
);
119 thread_obj
->thread
->name
= name
.release ();
124 /* Getter for InferiorThread.num. */
127 thpy_get_num (PyObject
*self
, void *closure
)
129 thread_object
*thread_obj
= (thread_object
*) self
;
131 THPY_REQUIRE_VALID (thread_obj
);
133 return PyLong_FromLong (thread_obj
->thread
->per_inf_num
);
136 /* Getter for InferiorThread.global_num. */
139 thpy_get_global_num (PyObject
*self
, void *closure
)
141 thread_object
*thread_obj
= (thread_object
*) self
;
143 THPY_REQUIRE_VALID (thread_obj
);
145 return PyLong_FromLong (thread_obj
->thread
->global_num
);
148 /* Getter for InferiorThread.ptid -> (pid, lwp, tid).
149 Returns a tuple with the thread's ptid components. */
152 thpy_get_ptid (PyObject
*self
, void *closure
)
154 thread_object
*thread_obj
= (thread_object
*) self
;
156 THPY_REQUIRE_VALID (thread_obj
);
158 return gdbpy_create_ptid_object (thread_obj
->thread
->ptid
);
161 /* Getter for InferiorThread.inferior -> Inferior. */
164 thpy_get_inferior (PyObject
*self
, void *ignore
)
166 thread_object
*thread_obj
= (thread_object
*) self
;
168 THPY_REQUIRE_VALID (thread_obj
);
169 Py_INCREF (thread_obj
->inf_obj
);
171 return thread_obj
->inf_obj
;
174 /* Implementation of InferiorThread.switch ().
175 Makes this the GDB selected thread. */
178 thpy_switch (PyObject
*self
, PyObject
*args
)
180 thread_object
*thread_obj
= (thread_object
*) self
;
182 THPY_REQUIRE_VALID (thread_obj
);
186 switch_to_thread (thread_obj
->thread
);
188 CATCH (except
, RETURN_MASK_ALL
)
190 GDB_PY_HANDLE_EXCEPTION (except
);
197 /* Implementation of InferiorThread.is_stopped () -> Boolean.
198 Return whether the thread is stopped. */
201 thpy_is_stopped (PyObject
*self
, PyObject
*args
)
203 thread_object
*thread_obj
= (thread_object
*) self
;
205 THPY_REQUIRE_VALID (thread_obj
);
207 if (thread_obj
->thread
->state
== THREAD_STOPPED
)
213 /* Implementation of InferiorThread.is_running () -> Boolean.
214 Return whether the thread is running. */
217 thpy_is_running (PyObject
*self
, PyObject
*args
)
219 thread_object
*thread_obj
= (thread_object
*) self
;
221 THPY_REQUIRE_VALID (thread_obj
);
223 if (thread_obj
->thread
->state
== THREAD_RUNNING
)
229 /* Implementation of InferiorThread.is_exited () -> Boolean.
230 Return whether the thread is exited. */
233 thpy_is_exited (PyObject
*self
, PyObject
*args
)
235 thread_object
*thread_obj
= (thread_object
*) self
;
237 THPY_REQUIRE_VALID (thread_obj
);
239 if (thread_obj
->thread
->state
== THREAD_EXITED
)
245 /* Implementation of gdb.InfThread.is_valid (self) -> Boolean.
246 Returns True if this inferior Thread object still exists
250 thpy_is_valid (PyObject
*self
, PyObject
*args
)
252 thread_object
*thread_obj
= (thread_object
*) self
;
254 if (! thread_obj
->thread
)
260 /* Return a reference to a new Python object representing a ptid_t.
261 The object is a tuple containing (pid, lwp, tid). */
263 gdbpy_create_ptid_object (ptid_t ptid
)
269 ret
= PyTuple_New (3);
277 PyTuple_SET_ITEM (ret
, 0, PyInt_FromLong (pid
));
278 PyTuple_SET_ITEM (ret
, 1, PyInt_FromLong (lwp
));
279 PyTuple_SET_ITEM (ret
, 2, PyInt_FromLong (tid
));
284 /* Implementation of gdb.selected_thread () -> gdb.InferiorThread.
285 Returns the selected thread object. */
288 gdbpy_selected_thread (PyObject
*self
, PyObject
*args
)
290 if (inferior_ptid
!= null_ptid
)
291 return thread_to_thread_object (inferior_thread ()).release ();
297 gdbpy_initialize_thread (void)
299 if (PyType_Ready (&thread_object_type
) < 0)
302 return gdb_pymodule_addobject (gdb_module
, "InferiorThread",
303 (PyObject
*) &thread_object_type
);
306 static gdb_PyGetSetDef thread_object_getset
[] =
308 { "name", thpy_get_name
, thpy_set_name
,
309 "The name of the thread, as set by the user or the OS.", NULL
},
310 { "num", thpy_get_num
, NULL
,
311 "Per-inferior number of the thread, as assigned by GDB.", NULL
},
312 { "global_num", thpy_get_global_num
, NULL
,
313 "Global number of the thread, as assigned by GDB.", NULL
},
314 { "ptid", thpy_get_ptid
, NULL
, "ID of the thread, as assigned by the OS.",
316 { "inferior", thpy_get_inferior
, NULL
,
317 "The Inferior object this thread belongs to.", NULL
},
322 static PyMethodDef thread_object_methods
[] =
324 { "is_valid", thpy_is_valid
, METH_NOARGS
,
325 "is_valid () -> Boolean.\n\
326 Return true if this inferior thread is valid, false if not." },
327 { "switch", thpy_switch
, METH_NOARGS
,
329 Makes this the GDB selected thread." },
330 { "is_stopped", thpy_is_stopped
, METH_NOARGS
,
331 "is_stopped () -> Boolean\n\
332 Return whether the thread is stopped." },
333 { "is_running", thpy_is_running
, METH_NOARGS
,
334 "is_running () -> Boolean\n\
335 Return whether the thread is running." },
336 { "is_exited", thpy_is_exited
, METH_NOARGS
,
337 "is_exited () -> Boolean\n\
338 Return whether the thread is exited." },
343 PyTypeObject thread_object_type
=
345 PyVarObject_HEAD_INIT (NULL
, 0)
346 "gdb.InferiorThread", /*tp_name*/
347 sizeof (thread_object
), /*tp_basicsize*/
349 thpy_dealloc
, /*tp_dealloc*/
356 0, /*tp_as_sequence*/
364 Py_TPFLAGS_DEFAULT
| Py_TPFLAGS_HAVE_ITER
, /*tp_flags*/
365 "GDB thread object", /* tp_doc */
368 0, /* tp_richcompare */
369 0, /* tp_weaklistoffset */
372 thread_object_methods
, /* tp_methods */
374 thread_object_getset
, /* tp_getset */
377 0, /* tp_descr_get */
378 0, /* tp_descr_set */
379 0, /* tp_dictoffset */