1 /* Python interface to inferior threads.
3 Copyright (C) 2009-2017 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
;
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
);
166 return thread_obj
->inf_obj
;
169 /* Implementation of InferiorThread.switch ().
170 Makes this the GDB selected thread. */
173 thpy_switch (PyObject
*self
, PyObject
*args
)
175 thread_object
*thread_obj
= (thread_object
*) self
;
177 THPY_REQUIRE_VALID (thread_obj
);
181 switch_to_thread (thread_obj
->thread
->ptid
);
183 CATCH (except
, RETURN_MASK_ALL
)
185 GDB_PY_HANDLE_EXCEPTION (except
);
192 /* Implementation of InferiorThread.is_stopped () -> Boolean.
193 Return whether the thread is stopped. */
196 thpy_is_stopped (PyObject
*self
, PyObject
*args
)
198 thread_object
*thread_obj
= (thread_object
*) self
;
200 THPY_REQUIRE_VALID (thread_obj
);
202 if (is_stopped (thread_obj
->thread
->ptid
))
208 /* Implementation of InferiorThread.is_running () -> Boolean.
209 Return whether the thread is running. */
212 thpy_is_running (PyObject
*self
, PyObject
*args
)
214 thread_object
*thread_obj
= (thread_object
*) self
;
216 THPY_REQUIRE_VALID (thread_obj
);
218 if (is_running (thread_obj
->thread
->ptid
))
224 /* Implementation of InferiorThread.is_exited () -> Boolean.
225 Return whether the thread is exited. */
228 thpy_is_exited (PyObject
*self
, PyObject
*args
)
230 thread_object
*thread_obj
= (thread_object
*) self
;
232 THPY_REQUIRE_VALID (thread_obj
);
234 if (is_exited (thread_obj
->thread
->ptid
))
240 /* Implementation of gdb.InfThread.is_valid (self) -> Boolean.
241 Returns True if this inferior Thread object still exists
245 thpy_is_valid (PyObject
*self
, PyObject
*args
)
247 thread_object
*thread_obj
= (thread_object
*) self
;
249 if (! thread_obj
->thread
)
255 /* Return a reference to a new Python object representing a ptid_t.
256 The object is a tuple containing (pid, lwp, tid). */
258 gdbpy_create_ptid_object (ptid_t ptid
)
264 ret
= PyTuple_New (3);
268 pid
= ptid_get_pid (ptid
);
269 lwp
= ptid_get_lwp (ptid
);
270 tid
= ptid_get_tid (ptid
);
272 PyTuple_SET_ITEM (ret
, 0, PyInt_FromLong (pid
));
273 PyTuple_SET_ITEM (ret
, 1, PyInt_FromLong (lwp
));
274 PyTuple_SET_ITEM (ret
, 2, PyInt_FromLong (tid
));
279 /* Implementation of gdb.selected_thread () -> gdb.InferiorThread.
280 Returns the selected thread object. */
283 gdbpy_selected_thread (PyObject
*self
, PyObject
*args
)
285 PyObject
*thread_obj
;
287 thread_obj
= (PyObject
*) find_thread_object (inferior_ptid
);
290 Py_INCREF (thread_obj
);
298 gdbpy_initialize_thread (void)
300 if (PyType_Ready (&thread_object_type
) < 0)
303 return gdb_pymodule_addobject (gdb_module
, "InferiorThread",
304 (PyObject
*) &thread_object_type
);
307 static gdb_PyGetSetDef thread_object_getset
[] =
309 { "name", thpy_get_name
, thpy_set_name
,
310 "The name of the thread, as set by the user or the OS.", NULL
},
311 { "num", thpy_get_num
, NULL
,
312 "Per-inferior number of the thread, as assigned by GDB.", NULL
},
313 { "global_num", thpy_get_global_num
, NULL
,
314 "Global number of the thread, as assigned by GDB.", NULL
},
315 { "ptid", thpy_get_ptid
, NULL
, "ID of the thread, as assigned by the OS.",
317 { "inferior", thpy_get_inferior
, NULL
,
318 "The Inferior object this thread belongs to.", NULL
},
323 static PyMethodDef thread_object_methods
[] =
325 { "is_valid", thpy_is_valid
, METH_NOARGS
,
326 "is_valid () -> Boolean.\n\
327 Return true if this inferior thread is valid, false if not." },
328 { "switch", thpy_switch
, METH_NOARGS
,
330 Makes this the GDB selected thread." },
331 { "is_stopped", thpy_is_stopped
, METH_NOARGS
,
332 "is_stopped () -> Boolean\n\
333 Return whether the thread is stopped." },
334 { "is_running", thpy_is_running
, METH_NOARGS
,
335 "is_running () -> Boolean\n\
336 Return whether the thread is running." },
337 { "is_exited", thpy_is_exited
, METH_NOARGS
,
338 "is_exited () -> Boolean\n\
339 Return whether the thread is exited." },
344 PyTypeObject thread_object_type
=
346 PyVarObject_HEAD_INIT (NULL
, 0)
347 "gdb.InferiorThread", /*tp_name*/
348 sizeof (thread_object
), /*tp_basicsize*/
350 thpy_dealloc
, /*tp_dealloc*/
357 0, /*tp_as_sequence*/
365 Py_TPFLAGS_DEFAULT
| Py_TPFLAGS_HAVE_ITER
, /*tp_flags*/
366 "GDB thread object", /* tp_doc */
369 0, /* tp_richcompare */
370 0, /* tp_weaklistoffset */
373 thread_object_methods
, /* tp_methods */
375 thread_object_getset
, /* tp_getset */
378 0, /* tp_descr_get */
379 0, /* tp_descr_set */
380 0, /* tp_dictoffset */