]> git.ipfire.org Git - thirdparty/binutils-gdb.git/blame - gdb/python/py-infthread.c
Remove ptid_get_pid
[thirdparty/binutils-gdb.git] / gdb / python / py-infthread.c
CommitLineData
595939de
PM
1/* Python interface to inferior threads.
2
e2882c85 3 Copyright (C) 2009-2018 Free Software Foundation, Inc.
595939de
PM
4
5 This file is part of GDB.
6
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.
11
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.
16
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/>. */
19
20#include "defs.h"
595939de
PM
21#include "gdbthread.h"
22#include "inferior.h"
23#include "python-internal.h"
24
e36122e9 25extern PyTypeObject thread_object_type
62eec1a5 26 CPYCHECKER_TYPE_OBJECT_FOR_TYPEDEF ("thread_object");
595939de
PM
27
28/* Require that INFERIOR be a valid inferior ID. */
29#define THPY_REQUIRE_VALID(Thread) \
30 do { \
31 if (!Thread->thread) \
32 { \
33 PyErr_SetString (PyExc_RuntimeError, \
34 _("Thread no longer exists.")); \
35 return NULL; \
36 } \
37 } while (0)
38
595939de
PM
39thread_object *
40create_thread_object (struct thread_info *tp)
41{
42 thread_object *thread_obj;
43
44 thread_obj = PyObject_New (thread_object, &thread_object_type);
45 if (!thread_obj)
46 return NULL;
47
48 thread_obj->thread = tp;
00431a78 49 thread_obj->inf_obj = (PyObject *) inferior_to_inferior_object (tp->inf);
595939de
PM
50
51 return thread_obj;
52}
53
595939de
PM
54static void
55thpy_dealloc (PyObject *self)
56{
57 Py_DECREF (((thread_object *) self)->inf_obj);
9a27f2c6 58 Py_TYPE (self)->tp_free (self);
595939de
PM
59}
60
4694da01
TT
61static PyObject *
62thpy_get_name (PyObject *self, void *ignore)
63{
64 thread_object *thread_obj = (thread_object *) self;
73ede765 65 const char *name;
4694da01
TT
66
67 THPY_REQUIRE_VALID (thread_obj);
68
69 name = thread_obj->thread->name;
70 if (name == NULL)
71 name = target_thread_name (thread_obj->thread);
72
73 if (name == NULL)
74 Py_RETURN_NONE;
75
76 return PyString_FromString (name);
77}
78
79static int
80thpy_set_name (PyObject *self, PyObject *newvalue, void *ignore)
81{
82 thread_object *thread_obj = (thread_object *) self;
9b972014 83 gdb::unique_xmalloc_ptr<char> name;
4694da01
TT
84
85 if (! thread_obj->thread)
86 {
87 PyErr_SetString (PyExc_RuntimeError, _("Thread no longer exists."));
88 return -1;
89 }
90
91 if (newvalue == NULL)
92 {
256458bc 93 PyErr_SetString (PyExc_TypeError,
4694da01
TT
94 _("Cannot delete `name' attribute."));
95 return -1;
96 }
97 else if (newvalue == Py_None)
9b972014
TT
98 {
99 /* Nothing. */
100 }
4694da01
TT
101 else if (! gdbpy_is_string (newvalue))
102 {
103 PyErr_SetString (PyExc_TypeError,
104 _("The value of `name' must be a string."));
105 return -1;
106 }
107 else
108 {
109 name = python_string_to_host_string (newvalue);
110 if (! name)
111 return -1;
112 }
113
114 xfree (thread_obj->thread->name);
9b972014 115 thread_obj->thread->name = name.release ();
4694da01
TT
116
117 return 0;
118}
119
5d5658a1
PA
120/* Getter for InferiorThread.num. */
121
595939de
PM
122static PyObject *
123thpy_get_num (PyObject *self, void *closure)
124{
125 thread_object *thread_obj = (thread_object *) self;
126
127 THPY_REQUIRE_VALID (thread_obj);
128
5d5658a1 129 return PyLong_FromLong (thread_obj->thread->per_inf_num);
595939de
PM
130}
131
22a02324
PA
132/* Getter for InferiorThread.global_num. */
133
134static PyObject *
135thpy_get_global_num (PyObject *self, void *closure)
136{
137 thread_object *thread_obj = (thread_object *) self;
138
139 THPY_REQUIRE_VALID (thread_obj);
140
141 return PyLong_FromLong (thread_obj->thread->global_num);
142}
143
595939de
PM
144/* Getter for InferiorThread.ptid -> (pid, lwp, tid).
145 Returns a tuple with the thread's ptid components. */
007baf27 146
595939de
PM
147static PyObject *
148thpy_get_ptid (PyObject *self, void *closure)
149{
595939de 150 thread_object *thread_obj = (thread_object *) self;
595939de
PM
151
152 THPY_REQUIRE_VALID (thread_obj);
153
162078c8 154 return gdbpy_create_ptid_object (thread_obj->thread->ptid);
595939de
PM
155}
156
84654457
PA
157/* Getter for InferiorThread.inferior -> Inferior. */
158
159static PyObject *
160thpy_get_inferior (PyObject *self, void *ignore)
161{
162 thread_object *thread_obj = (thread_object *) self;
163
164 THPY_REQUIRE_VALID (thread_obj);
484d8d36 165 Py_INCREF (thread_obj->inf_obj);
84654457
PA
166
167 return thread_obj->inf_obj;
168}
169
595939de
PM
170/* Implementation of InferiorThread.switch ().
171 Makes this the GDB selected thread. */
007baf27 172
595939de
PM
173static PyObject *
174thpy_switch (PyObject *self, PyObject *args)
175{
176 thread_object *thread_obj = (thread_object *) self;
595939de
PM
177
178 THPY_REQUIRE_VALID (thread_obj);
179
492d29ea 180 TRY
595939de 181 {
00431a78 182 switch_to_thread (thread_obj->thread);
595939de 183 }
492d29ea
PA
184 CATCH (except, RETURN_MASK_ALL)
185 {
186 GDB_PY_HANDLE_EXCEPTION (except);
187 }
188 END_CATCH
595939de
PM
189
190 Py_RETURN_NONE;
191}
192
193/* Implementation of InferiorThread.is_stopped () -> Boolean.
194 Return whether the thread is stopped. */
007baf27 195
595939de
PM
196static PyObject *
197thpy_is_stopped (PyObject *self, PyObject *args)
198{
199 thread_object *thread_obj = (thread_object *) self;
200
201 THPY_REQUIRE_VALID (thread_obj);
202
00431a78 203 if (thread_obj->thread->state == THREAD_STOPPED)
595939de
PM
204 Py_RETURN_TRUE;
205
206 Py_RETURN_FALSE;
207}
208
209/* Implementation of InferiorThread.is_running () -> Boolean.
210 Return whether the thread is running. */
007baf27 211
595939de
PM
212static PyObject *
213thpy_is_running (PyObject *self, PyObject *args)
214{
215 thread_object *thread_obj = (thread_object *) self;
216
217 THPY_REQUIRE_VALID (thread_obj);
218
00431a78 219 if (thread_obj->thread->state == THREAD_RUNNING)
595939de
PM
220 Py_RETURN_TRUE;
221
222 Py_RETURN_FALSE;
223}
224
225/* Implementation of InferiorThread.is_exited () -> Boolean.
226 Return whether the thread is exited. */
007baf27 227
595939de
PM
228static PyObject *
229thpy_is_exited (PyObject *self, PyObject *args)
230{
231 thread_object *thread_obj = (thread_object *) self;
232
233 THPY_REQUIRE_VALID (thread_obj);
234
00431a78 235 if (thread_obj->thread->state == THREAD_EXITED)
595939de
PM
236 Py_RETURN_TRUE;
237
238 Py_RETURN_FALSE;
239}
240
29703da4
PM
241/* Implementation of gdb.InfThread.is_valid (self) -> Boolean.
242 Returns True if this inferior Thread object still exists
243 in GDB. */
595939de 244
29703da4
PM
245static PyObject *
246thpy_is_valid (PyObject *self, PyObject *args)
247{
248 thread_object *thread_obj = (thread_object *) self;
249
250 if (! thread_obj->thread)
251 Py_RETURN_FALSE;
252
253 Py_RETURN_TRUE;
254}
595939de 255
162078c8
NB
256/* Return a reference to a new Python object representing a ptid_t.
257 The object is a tuple containing (pid, lwp, tid). */
258PyObject *
259gdbpy_create_ptid_object (ptid_t ptid)
260{
261 int pid;
262 long tid, lwp;
263 PyObject *ret;
264
265 ret = PyTuple_New (3);
266 if (!ret)
267 return NULL;
268
e99b03dc 269 pid = ptid.pid ();
162078c8
NB
270 lwp = ptid_get_lwp (ptid);
271 tid = ptid_get_tid (ptid);
272
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));
276
277 return ret;
278}
279
595939de
PM
280/* Implementation of gdb.selected_thread () -> gdb.InferiorThread.
281 Returns the selected thread object. */
007baf27 282
595939de
PM
283PyObject *
284gdbpy_selected_thread (PyObject *self, PyObject *args)
285{
00431a78 286 if (inferior_ptid != null_ptid)
595939de 287 {
00431a78
PA
288 PyObject *thread_obj
289 = (PyObject *) thread_to_thread_object (inferior_thread ());
290 if (thread_obj != NULL)
291 {
292 Py_INCREF (thread_obj);
293 return thread_obj;
294 }
595939de
PM
295 }
296
297 Py_RETURN_NONE;
298}
299
999633ed 300int
595939de
PM
301gdbpy_initialize_thread (void)
302{
303 if (PyType_Ready (&thread_object_type) < 0)
999633ed 304 return -1;
595939de 305
aa36459a
TT
306 return gdb_pymodule_addobject (gdb_module, "InferiorThread",
307 (PyObject *) &thread_object_type);
595939de
PM
308}
309
0d1f4ceb 310static gdb_PyGetSetDef thread_object_getset[] =
595939de 311{
4694da01
TT
312 { "name", thpy_get_name, thpy_set_name,
313 "The name of the thread, as set by the user or the OS.", NULL },
5d5658a1
PA
314 { "num", thpy_get_num, NULL,
315 "Per-inferior number of the thread, as assigned by GDB.", NULL },
22a02324
PA
316 { "global_num", thpy_get_global_num, NULL,
317 "Global number of the thread, as assigned by GDB.", NULL },
595939de
PM
318 { "ptid", thpy_get_ptid, NULL, "ID of the thread, as assigned by the OS.",
319 NULL },
84654457
PA
320 { "inferior", thpy_get_inferior, NULL,
321 "The Inferior object this thread belongs to.", NULL },
595939de
PM
322
323 { NULL }
324};
325
326static PyMethodDef thread_object_methods[] =
327{
29703da4
PM
328 { "is_valid", thpy_is_valid, METH_NOARGS,
329 "is_valid () -> Boolean.\n\
330Return true if this inferior thread is valid, false if not." },
595939de
PM
331 { "switch", thpy_switch, METH_NOARGS,
332 "switch ()\n\
333Makes this the GDB selected thread." },
334 { "is_stopped", thpy_is_stopped, METH_NOARGS,
335 "is_stopped () -> Boolean\n\
336Return whether the thread is stopped." },
337 { "is_running", thpy_is_running, METH_NOARGS,
338 "is_running () -> Boolean\n\
339Return whether the thread is running." },
340 { "is_exited", thpy_is_exited, METH_NOARGS,
341 "is_exited () -> Boolean\n\
342Return whether the thread is exited." },
343
344 { NULL }
345};
346
e36122e9 347PyTypeObject thread_object_type =
595939de 348{
9a27f2c6 349 PyVarObject_HEAD_INIT (NULL, 0)
595939de
PM
350 "gdb.InferiorThread", /*tp_name*/
351 sizeof (thread_object), /*tp_basicsize*/
352 0, /*tp_itemsize*/
353 thpy_dealloc, /*tp_dealloc*/
354 0, /*tp_print*/
355 0, /*tp_getattr*/
356 0, /*tp_setattr*/
357 0, /*tp_compare*/
358 0, /*tp_repr*/
359 0, /*tp_as_number*/
360 0, /*tp_as_sequence*/
361 0, /*tp_as_mapping*/
362 0, /*tp_hash */
363 0, /*tp_call*/
364 0, /*tp_str*/
365 0, /*tp_getattro*/
366 0, /*tp_setattro*/
367 0, /*tp_as_buffer*/
368 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_ITER, /*tp_flags*/
369 "GDB thread object", /* tp_doc */
370 0, /* tp_traverse */
371 0, /* tp_clear */
372 0, /* tp_richcompare */
373 0, /* tp_weaklistoffset */
374 0, /* tp_iter */
375 0, /* tp_iternext */
376 thread_object_methods, /* tp_methods */
377 0, /* tp_members */
378 thread_object_getset, /* tp_getset */
379 0, /* tp_base */
380 0, /* tp_dict */
381 0, /* tp_descr_get */
382 0, /* tp_descr_set */
383 0, /* tp_dictoffset */
384 0, /* tp_init */
385 0 /* tp_alloc */
386};