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