1 /* Python interface to inferior threads. 2 3 Copyright (C) 2009-2014 Free Software Foundation, Inc. 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" 21 #include "exceptions.h" 22 #include "gdbthread.h" 23 #include "inferior.h" 24 #include "python-internal.h" 25 26 static PyTypeObject thread_object_type 27 CPYCHECKER_TYPE_OBJECT_FOR_TYPEDEF ("thread_object"); 28 29 /* Require that INFERIOR be a valid inferior ID. */ 30 #define THPY_REQUIRE_VALID(Thread) \ 31 do { \ 32 if (!Thread->thread) \ 33 { \ 34 PyErr_SetString (PyExc_RuntimeError, \ 35 _("Thread no longer exists.")); \ 36 return NULL; \ 37 } \ 38 } while (0) 39 40 41 42 thread_object * 43 create_thread_object (struct thread_info *tp) 44 { 45 thread_object *thread_obj; 46 47 thread_obj = PyObject_New (thread_object, &thread_object_type); 48 if (!thread_obj) 49 return NULL; 50 51 thread_obj->thread = tp; 52 thread_obj->inf_obj = find_inferior_object (ptid_get_pid (tp->ptid)); 53 54 return thread_obj; 55 } 56 57 58 59 static void 60 thpy_dealloc (PyObject *self) 61 { 62 Py_DECREF (((thread_object *) self)->inf_obj); 63 Py_TYPE (self)->tp_free (self); 64 } 65 66 static PyObject * 67 thpy_get_name (PyObject *self, void *ignore) 68 { 69 thread_object *thread_obj = (thread_object *) self; 70 char *name; 71 72 THPY_REQUIRE_VALID (thread_obj); 73 74 name = thread_obj->thread->name; 75 if (name == NULL) 76 name = target_thread_name (thread_obj->thread); 77 78 if (name == NULL) 79 Py_RETURN_NONE; 80 81 return PyString_FromString (name); 82 } 83 84 static int 85 thpy_set_name (PyObject *self, PyObject *newvalue, void *ignore) 86 { 87 thread_object *thread_obj = (thread_object *) self; 88 char *name; 89 90 if (! thread_obj->thread) 91 { 92 PyErr_SetString (PyExc_RuntimeError, _("Thread no longer exists.")); 93 return -1; 94 } 95 96 if (newvalue == NULL) 97 { 98 PyErr_SetString (PyExc_TypeError, 99 _("Cannot delete `name' attribute.")); 100 return -1; 101 } 102 else if (newvalue == Py_None) 103 name = NULL; 104 else if (! gdbpy_is_string (newvalue)) 105 { 106 PyErr_SetString (PyExc_TypeError, 107 _("The value of `name' must be a string.")); 108 return -1; 109 } 110 else 111 { 112 name = python_string_to_host_string (newvalue); 113 if (! name) 114 return -1; 115 } 116 117 xfree (thread_obj->thread->name); 118 thread_obj->thread->name = name; 119 120 return 0; 121 } 122 123 static PyObject * 124 thpy_get_num (PyObject *self, void *closure) 125 { 126 thread_object *thread_obj = (thread_object *) self; 127 128 THPY_REQUIRE_VALID (thread_obj); 129 130 return PyLong_FromLong (thread_obj->thread->num); 131 } 132 133 /* Getter for InferiorThread.ptid -> (pid, lwp, tid). 134 Returns a tuple with the thread's ptid components. */ 135 static PyObject * 136 thpy_get_ptid (PyObject *self, void *closure) 137 { 138 int pid; 139 long tid, lwp; 140 thread_object *thread_obj = (thread_object *) self; 141 PyObject *ret; 142 143 THPY_REQUIRE_VALID (thread_obj); 144 145 ret = PyTuple_New (3); 146 if (!ret) 147 return NULL; 148 149 pid = ptid_get_pid (thread_obj->thread->ptid); 150 lwp = ptid_get_lwp (thread_obj->thread->ptid); 151 tid = ptid_get_tid (thread_obj->thread->ptid); 152 153 PyTuple_SET_ITEM (ret, 0, PyInt_FromLong (pid)); 154 PyTuple_SET_ITEM (ret, 1, PyInt_FromLong (lwp)); 155 PyTuple_SET_ITEM (ret, 2, PyInt_FromLong (tid)); 156 157 return ret; 158 } 159 160 /* Implementation of InferiorThread.switch (). 161 Makes this the GDB selected thread. */ 162 static PyObject * 163 thpy_switch (PyObject *self, PyObject *args) 164 { 165 thread_object *thread_obj = (thread_object *) self; 166 volatile struct gdb_exception except; 167 168 THPY_REQUIRE_VALID (thread_obj); 169 170 TRY_CATCH (except, RETURN_MASK_ALL) 171 { 172 switch_to_thread (thread_obj->thread->ptid); 173 } 174 GDB_PY_HANDLE_EXCEPTION (except); 175 176 Py_RETURN_NONE; 177 } 178 179 /* Implementation of InferiorThread.is_stopped () -> Boolean. 180 Return whether the thread is stopped. */ 181 static PyObject * 182 thpy_is_stopped (PyObject *self, PyObject *args) 183 { 184 thread_object *thread_obj = (thread_object *) self; 185 186 THPY_REQUIRE_VALID (thread_obj); 187 188 if (is_stopped (thread_obj->thread->ptid)) 189 Py_RETURN_TRUE; 190 191 Py_RETURN_FALSE; 192 } 193 194 /* Implementation of InferiorThread.is_running () -> Boolean. 195 Return whether the thread is running. */ 196 static PyObject * 197 thpy_is_running (PyObject *self, PyObject *args) 198 { 199 thread_object *thread_obj = (thread_object *) self; 200 201 THPY_REQUIRE_VALID (thread_obj); 202 203 if (is_running (thread_obj->thread->ptid)) 204 Py_RETURN_TRUE; 205 206 Py_RETURN_FALSE; 207 } 208 209 /* Implementation of InferiorThread.is_exited () -> Boolean. 210 Return whether the thread is exited. */ 211 static PyObject * 212 thpy_is_exited (PyObject *self, PyObject *args) 213 { 214 thread_object *thread_obj = (thread_object *) self; 215 216 THPY_REQUIRE_VALID (thread_obj); 217 218 if (is_exited (thread_obj->thread->ptid)) 219 Py_RETURN_TRUE; 220 221 Py_RETURN_FALSE; 222 } 223 224 /* Implementation of gdb.InfThread.is_valid (self) -> Boolean. 225 Returns True if this inferior Thread object still exists 226 in GDB. */ 227 228 static PyObject * 229 thpy_is_valid (PyObject *self, PyObject *args) 230 { 231 thread_object *thread_obj = (thread_object *) self; 232 233 if (! thread_obj->thread) 234 Py_RETURN_FALSE; 235 236 Py_RETURN_TRUE; 237 } 238 239 /* Implementation of gdb.selected_thread () -> gdb.InferiorThread. 240 Returns the selected thread object. */ 241 PyObject * 242 gdbpy_selected_thread (PyObject *self, PyObject *args) 243 { 244 PyObject *thread_obj; 245 246 thread_obj = (PyObject *) find_thread_object (inferior_ptid); 247 if (thread_obj) 248 { 249 Py_INCREF (thread_obj); 250 return thread_obj; 251 } 252 253 Py_RETURN_NONE; 254 } 255 256 257 258 int 259 gdbpy_initialize_thread (void) 260 { 261 if (PyType_Ready (&thread_object_type) < 0) 262 return -1; 263 264 return gdb_pymodule_addobject (gdb_module, "InferiorThread", 265 (PyObject *) &thread_object_type); 266 } 267 268 269 270 static PyGetSetDef thread_object_getset[] = 271 { 272 { "name", thpy_get_name, thpy_set_name, 273 "The name of the thread, as set by the user or the OS.", NULL }, 274 { "num", thpy_get_num, NULL, "ID of the thread, as assigned by GDB.", NULL }, 275 { "ptid", thpy_get_ptid, NULL, "ID of the thread, as assigned by the OS.", 276 NULL }, 277 278 { NULL } 279 }; 280 281 static PyMethodDef thread_object_methods[] = 282 { 283 { "is_valid", thpy_is_valid, METH_NOARGS, 284 "is_valid () -> Boolean.\n\ 285 Return true if this inferior thread is valid, false if not." }, 286 { "switch", thpy_switch, METH_NOARGS, 287 "switch ()\n\ 288 Makes this the GDB selected thread." }, 289 { "is_stopped", thpy_is_stopped, METH_NOARGS, 290 "is_stopped () -> Boolean\n\ 291 Return whether the thread is stopped." }, 292 { "is_running", thpy_is_running, METH_NOARGS, 293 "is_running () -> Boolean\n\ 294 Return whether the thread is running." }, 295 { "is_exited", thpy_is_exited, METH_NOARGS, 296 "is_exited () -> Boolean\n\ 297 Return whether the thread is exited." }, 298 299 { NULL } 300 }; 301 302 static PyTypeObject thread_object_type = 303 { 304 PyVarObject_HEAD_INIT (NULL, 0) 305 "gdb.InferiorThread", /*tp_name*/ 306 sizeof (thread_object), /*tp_basicsize*/ 307 0, /*tp_itemsize*/ 308 thpy_dealloc, /*tp_dealloc*/ 309 0, /*tp_print*/ 310 0, /*tp_getattr*/ 311 0, /*tp_setattr*/ 312 0, /*tp_compare*/ 313 0, /*tp_repr*/ 314 0, /*tp_as_number*/ 315 0, /*tp_as_sequence*/ 316 0, /*tp_as_mapping*/ 317 0, /*tp_hash */ 318 0, /*tp_call*/ 319 0, /*tp_str*/ 320 0, /*tp_getattro*/ 321 0, /*tp_setattro*/ 322 0, /*tp_as_buffer*/ 323 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_ITER, /*tp_flags*/ 324 "GDB thread object", /* tp_doc */ 325 0, /* tp_traverse */ 326 0, /* tp_clear */ 327 0, /* tp_richcompare */ 328 0, /* tp_weaklistoffset */ 329 0, /* tp_iter */ 330 0, /* tp_iternext */ 331 thread_object_methods, /* tp_methods */ 332 0, /* tp_members */ 333 thread_object_getset, /* tp_getset */ 334 0, /* tp_base */ 335 0, /* tp_dict */ 336 0, /* tp_descr_get */ 337 0, /* tp_descr_set */ 338 0, /* tp_dictoffset */ 339 0, /* tp_init */ 340 0 /* tp_alloc */ 341 }; 342