gdb/python/py-infthread.c

   1 /* Python interface to inferior threads.
   2
   3    Copyright (C) 2009-2021 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 "gdbthread.h"
  22 #include "inferior.h"
  23 #include "python-internal.h"
  24
  25 extern PyTypeObject thread_object_type
  26     CPYCHECKER_TYPE_OBJECT_FOR_TYPEDEF ("thread_object");
  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
  39 gdbpy_ref<thread_object>
  40 create_thread_object (struct thread_info *tp)
  41 {
  42   gdbpy_ref<thread_object> thread_obj;
  43
  44   gdbpy_ref<inferior_object> inf_obj = inferior_to_inferior_object (tp->inf);
  45   if (inf_obj == NULL)
  46     return NULL;
  47
  48   thread_obj.reset (PyObject_New (thread_object, &thread_object_type));
  49   if (thread_obj == NULL)
  50     return NULL;
  51
  52   thread_obj->thread = tp;
  53   thread_obj->inf_obj = (PyObject *) inf_obj.release ();
  54
  55   return thread_obj;
  56 }
  57
  58 static void
  59 thpy_dealloc (PyObject *self)
  60 {
  61   Py_DECREF (((thread_object *) self)->inf_obj);
  62   Py_TYPE (self)->tp_free (self);
  63 }
  64
  65 static PyObject *
  66 thpy_get_name (PyObject *self, void *ignore)
  67 {
  68   thread_object *thread_obj = (thread_object *) self;
  69   const char *name;
  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;
  87   gdb::unique_xmalloc_ptr<char> name;
  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     {
  97       PyErr_SetString (PyExc_TypeError,
  98                        _("Cannot delete `name' attribute."));
  99       return -1;
 100     }
 101   else if (newvalue == Py_None)
 102     {
 103       /* Nothing.  */
 104     }
 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);
 119   thread_obj->thread->name = name.release ();
 120
 121   return 0;
 122 }
 123
 124 /* Getter for InferiorThread.num.  */
 125
 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
 133   gdbpy_ref<> result
 134     = gdb_py_object_from_longest (thread_obj->thread->per_inf_num);
 135   return result.release ();
 136 }
 137
 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
 147   gdbpy_ref<> result
 148     = gdb_py_object_from_longest (thread_obj->thread->global_num);
 149   return result.release ();
 150 }
 151
 152 /* Getter for InferiorThread.ptid  -> (pid, lwp, tid).
 153    Returns a tuple with the thread's ptid components.  */
 154
 155 static PyObject *
 156 thpy_get_ptid (PyObject *self, void *closure)
 157 {
 158   thread_object *thread_obj = (thread_object *) self;
 159
 160   THPY_REQUIRE_VALID (thread_obj);
 161
 162   return gdbpy_create_ptid_object (thread_obj->thread->ptid);
 163 }
 164
 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);
 173   Py_INCREF (thread_obj->inf_obj);
 174
 175   return thread_obj->inf_obj;
 176 }
 177
 178 /* Implementation of InferiorThread.switch ().
 179    Makes this the GDB selected thread.  */
 180
 181 static PyObject *
 182 thpy_switch (PyObject *self, PyObject *args)
 183 {
 184   thread_object *thread_obj = (thread_object *) self;
 185
 186   THPY_REQUIRE_VALID (thread_obj);
 187
 188   try
 189     {
 190       switch_to_thread (thread_obj->thread);
 191     }
 192   catch (const gdb_exception &except)
 193     {
 194       GDB_PY_HANDLE_EXCEPTION (except);
 195     }
 196
 197   Py_RETURN_NONE;
 198 }
 199
 200 /* Implementation of InferiorThread.is_stopped () -> Boolean.
 201    Return whether the thread is stopped.  */
 202
 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
 210   if (thread_obj->thread->state == THREAD_STOPPED)
 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.  */
 218
 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
 226   if (thread_obj->thread->state == THREAD_RUNNING)
 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.  */
 234
 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
 242   if (thread_obj->thread->state == THREAD_EXITED)
 243     Py_RETURN_TRUE;
 244
 245   Py_RETURN_FALSE;
 246 }
 247
 248 /* Implementation of gdb.InfThread.is_valid (self) -> Boolean.
 249    Returns True if this inferior Thread object still exists
 250    in GDB.  */
 251
 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 }
 262
 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
 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
 306   pid = ptid.pid ();
 307   lwp = ptid.lwp ();
 308   tid = ptid.tid ();
 309
 310   gdbpy_ref<> pid_obj = gdb_py_object_from_longest (pid);
 311   if (pid_obj == nullptr)
 312     return nullptr;
 313   gdbpy_ref<> lwp_obj = gdb_py_object_from_longest (lwp);
 314   if (lwp_obj == nullptr)
 315     return nullptr;
 316   gdbpy_ref<> tid_obj = gdb_py_object_from_longest (tid);
 317   if (tid_obj == nullptr)
 318     return nullptr;
 319
 320   /* Note that these steal references, hence the use of 'release'.  */
 321   PyTuple_SET_ITEM (ret, 0, pid_obj.release ());
 322   PyTuple_SET_ITEM (ret, 1, lwp_obj.release ());
 323   PyTuple_SET_ITEM (ret, 2, tid_obj.release ());
 324
 325   return ret;
 326 }
 327
 328 /* Implementation of gdb.selected_thread () -> gdb.InferiorThread.
 329    Returns the selected thread object.  */
 330
 331 PyObject *
 332 gdbpy_selected_thread (PyObject *self, PyObject *args)
 333 {
 334   if (inferior_ptid != null_ptid)
 335     return thread_to_thread_object (inferior_thread ()).release ();
 336
 337   Py_RETURN_NONE;
 338 }
 339
 340 int
 341 gdbpy_initialize_thread (void)
 342 {
 343   if (PyType_Ready (&thread_object_type) < 0)
 344     return -1;
 345
 346   return gdb_pymodule_addobject (gdb_module, "InferiorThread",
 347                                  (PyObject *) &thread_object_type);
 348 }
 349
 350 static gdb_PyGetSetDef thread_object_getset[] =
 351 {
 352   { "name", thpy_get_name, thpy_set_name,
 353     "The name of the thread, as set by the user or the OS.", NULL },
 354   { "num", thpy_get_num, NULL,
 355     "Per-inferior number of the thread, as assigned by GDB.", NULL },
 356   { "global_num", thpy_get_global_num, NULL,
 357     "Global number of the thread, as assigned by GDB.", NULL },
 358   { "ptid", thpy_get_ptid, NULL, "ID of the thread, as assigned by the OS.",
 359     NULL },
 360   { "inferior", thpy_get_inferior, NULL,
 361     "The Inferior object this thread belongs to.", NULL },
 362
 363   { NULL }
 364 };
 365
 366 static PyMethodDef thread_object_methods[] =
 367 {
 368   { "is_valid", thpy_is_valid, METH_NOARGS,
 369     "is_valid () -> Boolean.\n\
 370 Return true if this inferior thread is valid, false if not." },
 371   { "switch", thpy_switch, METH_NOARGS,
 372     "switch ()\n\
 373 Makes this the GDB selected thread." },
 374   { "is_stopped", thpy_is_stopped, METH_NOARGS,
 375     "is_stopped () -> Boolean\n\
 376 Return whether the thread is stopped." },
 377   { "is_running", thpy_is_running, METH_NOARGS,
 378     "is_running () -> Boolean\n\
 379 Return whether the thread is running." },
 380   { "is_exited", thpy_is_exited, METH_NOARGS,
 381     "is_exited () -> Boolean\n\
 382 Return whether the thread is exited." },
 383   { "handle", thpy_thread_handle, METH_NOARGS,
 384     "handle  () -> handle\n\
 385 Return thread library specific handle for thread." },
 386
 387   { NULL }
 388 };
 389
 390 PyTypeObject thread_object_type =
 391 {
 392   PyVarObject_HEAD_INIT (NULL, 0)
 393   "gdb.InferiorThread",           /*tp_name*/
 394   sizeof (thread_object),         /*tp_basicsize*/
 395   0,                              /*tp_itemsize*/
 396   thpy_dealloc,                   /*tp_dealloc*/
 397   0,                              /*tp_print*/
 398   0,                              /*tp_getattr*/
 399   0,                              /*tp_setattr*/
 400   0,                              /*tp_compare*/
 401   0,                              /*tp_repr*/
 402   0,                              /*tp_as_number*/
 403   0,                              /*tp_as_sequence*/
 404   0,                              /*tp_as_mapping*/
 405   0,                              /*tp_hash */
 406   0,                              /*tp_call*/
 407   0,                              /*tp_str*/
 408   0,                              /*tp_getattro*/
 409   0,                              /*tp_setattro*/
 410   0,                              /*tp_as_buffer*/
 411   Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_ITER,  /*tp_flags*/
 412   "GDB thread object",            /* tp_doc */
 413   0,                              /* tp_traverse */
 414   0,                              /* tp_clear */
 415   0,                              /* tp_richcompare */
 416   0,                              /* tp_weaklistoffset */
 417   0,                              /* tp_iter */
 418   0,                              /* tp_iternext */
 419   thread_object_methods,          /* tp_methods */
 420   0,                              /* tp_members */
 421   thread_object_getset,           /* tp_getset */
 422   0,                              /* tp_base */
 423   0,                              /* tp_dict */
 424   0,                              /* tp_descr_get */
 425   0,                              /* tp_descr_set */
 426   0,                              /* tp_dictoffset */
 427   0,                              /* tp_init */
 428   0                               /* tp_alloc */
 429 };