1 /* Python interface to inferior threads.
3 Copyright (C) 2009-2018 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
= (PyObject
*) inferior_to_inferior_object (tp
->inf
);
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
;
83 gdb::unique_xmalloc_ptr
<char> name
;
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
)
101 else if (! gdbpy_is_string (newvalue
))
103 PyErr_SetString (PyExc_TypeError
,
104 _("The value of `name' must be a string."));
109 name
= python_string_to_host_string (newvalue
);
114 xfree (thread_obj
->thread
->name
);
115 thread_obj
->thread
->name
= name
.release ();
120 /* Getter for InferiorThread.num. */
123 thpy_get_num (PyObject
*self
, void *closure
)
125 thread_object
*thread_obj
= (thread_object
*) self
;
127 THPY_REQUIRE_VALID (thread_obj
);
129 return PyLong_FromLong (thread_obj
->thread
->per_inf_num
);
132 /* Getter for InferiorThread.global_num. */
135 thpy_get_global_num (PyObject
*self
, void *closure
)
137 thread_object
*thread_obj
= (thread_object
*) self
;
139 THPY_REQUIRE_VALID (thread_obj
);
141 return PyLong_FromLong (thread_obj
->thread
->global_num
);
144 /* Getter for InferiorThread.ptid -> (pid, lwp, tid).
145 Returns a tuple with the thread's ptid components. */
148 thpy_get_ptid (PyObject
*self
, void *closure
)
150 thread_object
*thread_obj
= (thread_object
*) self
;
152 THPY_REQUIRE_VALID (thread_obj
);
154 return gdbpy_create_ptid_object (thread_obj
->thread
->ptid
);
157 /* Getter for InferiorThread.inferior -> Inferior. */
160 thpy_get_inferior (PyObject
*self
, void *ignore
)
162 thread_object
*thread_obj
= (thread_object
*) self
;
164 THPY_REQUIRE_VALID (thread_obj
);
165 Py_INCREF (thread_obj
->inf_obj
);
167 return thread_obj
->inf_obj
;
170 /* Implementation of InferiorThread.switch ().
171 Makes this the GDB selected thread. */
174 thpy_switch (PyObject
*self
, PyObject
*args
)
176 thread_object
*thread_obj
= (thread_object
*) self
;
178 THPY_REQUIRE_VALID (thread_obj
);
182 switch_to_thread (thread_obj
->thread
);
184 CATCH (except
, RETURN_MASK_ALL
)
186 GDB_PY_HANDLE_EXCEPTION (except
);
193 /* Implementation of InferiorThread.is_stopped () -> Boolean.
194 Return whether the thread is stopped. */
197 thpy_is_stopped (PyObject
*self
, PyObject
*args
)
199 thread_object
*thread_obj
= (thread_object
*) self
;
201 THPY_REQUIRE_VALID (thread_obj
);
203 if (thread_obj
->thread
->state
== THREAD_STOPPED
)
209 /* Implementation of InferiorThread.is_running () -> Boolean.
210 Return whether the thread is running. */
213 thpy_is_running (PyObject
*self
, PyObject
*args
)
215 thread_object
*thread_obj
= (thread_object
*) self
;
217 THPY_REQUIRE_VALID (thread_obj
);
219 if (thread_obj
->thread
->state
== THREAD_RUNNING
)
225 /* Implementation of InferiorThread.is_exited () -> Boolean.
226 Return whether the thread is exited. */
229 thpy_is_exited (PyObject
*self
, PyObject
*args
)
231 thread_object
*thread_obj
= (thread_object
*) self
;
233 THPY_REQUIRE_VALID (thread_obj
);
235 if (thread_obj
->thread
->state
== THREAD_EXITED
)
241 /* Implementation of gdb.InfThread.is_valid (self) -> Boolean.
242 Returns True if this inferior Thread object still exists
246 thpy_is_valid (PyObject
*self
, PyObject
*args
)
248 thread_object
*thread_obj
= (thread_object
*) self
;
250 if (! thread_obj
->thread
)
256 /* Return a reference to a new Python object representing a ptid_t.
257 The object is a tuple containing (pid, lwp, tid). */
259 gdbpy_create_ptid_object (ptid_t ptid
)
265 ret
= PyTuple_New (3);
273 PyTuple_SET_ITEM (ret
, 0, PyInt_FromLong (pid
));
274 PyTuple_SET_ITEM (ret
, 1, PyInt_FromLong (lwp
));
275 PyTuple_SET_ITEM (ret
, 2, PyInt_FromLong (tid
));
280 /* Implementation of gdb.selected_thread () -> gdb.InferiorThread.
281 Returns the selected thread object. */
284 gdbpy_selected_thread (PyObject
*self
, PyObject
*args
)
286 if (inferior_ptid
!= null_ptid
)
287 return thread_to_thread_object (inferior_thread ()).release ();
293 gdbpy_initialize_thread (void)
295 if (PyType_Ready (&thread_object_type
) < 0)
298 return gdb_pymodule_addobject (gdb_module
, "InferiorThread",
299 (PyObject
*) &thread_object_type
);
302 static gdb_PyGetSetDef thread_object_getset
[] =
304 { "name", thpy_get_name
, thpy_set_name
,
305 "The name of the thread, as set by the user or the OS.", NULL
},
306 { "num", thpy_get_num
, NULL
,
307 "Per-inferior number of the thread, as assigned by GDB.", NULL
},
308 { "global_num", thpy_get_global_num
, NULL
,
309 "Global number of the thread, as assigned by GDB.", NULL
},
310 { "ptid", thpy_get_ptid
, NULL
, "ID of the thread, as assigned by the OS.",
312 { "inferior", thpy_get_inferior
, NULL
,
313 "The Inferior object this thread belongs to.", NULL
},
318 static PyMethodDef thread_object_methods
[] =
320 { "is_valid", thpy_is_valid
, METH_NOARGS
,
321 "is_valid () -> Boolean.\n\
322 Return true if this inferior thread is valid, false if not." },
323 { "switch", thpy_switch
, METH_NOARGS
,
325 Makes this the GDB selected thread." },
326 { "is_stopped", thpy_is_stopped
, METH_NOARGS
,
327 "is_stopped () -> Boolean\n\
328 Return whether the thread is stopped." },
329 { "is_running", thpy_is_running
, METH_NOARGS
,
330 "is_running () -> Boolean\n\
331 Return whether the thread is running." },
332 { "is_exited", thpy_is_exited
, METH_NOARGS
,
333 "is_exited () -> Boolean\n\
334 Return whether the thread is exited." },
339 PyTypeObject thread_object_type
=
341 PyVarObject_HEAD_INIT (NULL
, 0)
342 "gdb.InferiorThread", /*tp_name*/
343 sizeof (thread_object
), /*tp_basicsize*/
345 thpy_dealloc
, /*tp_dealloc*/
352 0, /*tp_as_sequence*/
360 Py_TPFLAGS_DEFAULT
| Py_TPFLAGS_HAVE_ITER
, /*tp_flags*/
361 "GDB thread object", /* tp_doc */
364 0, /* tp_richcompare */
365 0, /* tp_weaklistoffset */
368 thread_object_methods
, /* tp_methods */
370 thread_object_getset
, /* tp_getset */
373 0, /* tp_descr_get */
374 0, /* tp_descr_set */
375 0, /* tp_dictoffset */