gdb/python/py-infthread.c

   1 /* Python interface to inferior threads.
   2
   3    Copyright (C) 2009-2019 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 thread_object *
  40 create_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;
  49   thread_obj->inf_obj = (PyObject *) inferior_to_inferior_object (tp->inf);
  50
  51   return thread_obj;
  52 }
  53
  54 static void
  55 thpy_dealloc (PyObject *self)
  56 {
  57   Py_DECREF (((thread_object *) self)->inf_obj);
  58   Py_TYPE (self)->tp_free (self);
  59 }
  60
  61 static PyObject *
  62 thpy_get_name (PyObject *self, void *ignore)
  63 {
  64   thread_object *thread_obj = (thread_object *) self;
  65   const char *name;
  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
  79 static int
  80 thpy_set_name (PyObject *self, PyObject *newvalue, void *ignore)
  81 {
  82   thread_object *thread_obj = (thread_object *) self;
  83   gdb::unique_xmalloc_ptr<char> name;
  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     {
  93       PyErr_SetString (PyExc_TypeError,
  94                        _("Cannot delete `name' attribute."));
  95       return -1;
  96     }
  97   else if (newvalue == Py_None)
  98     {
  99       /* Nothing.  */
 100     }
 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);
 115   thread_obj->thread->name = name.release ();
 116
 117   return 0;
 118 }
 119
 120 /* Getter for InferiorThread.num.  */
 121
 122 static PyObject *
 123 thpy_get_num (PyObject *self, void *closure)
 124 {
 125   thread_object *thread_obj = (thread_object *) self;
 126
 127   THPY_REQUIRE_VALID (thread_obj);
 128
 129   return PyLong_FromLong (thread_obj->thread->per_inf_num);
 130 }
 131
 132 /* Getter for InferiorThread.global_num.  */
 133
 134 static PyObject *
 135 thpy_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
 144 /* Getter for InferiorThread.ptid  -> (pid, lwp, tid).
 145    Returns a tuple with the thread's ptid components.  */
 146
 147 static PyObject *
 148 thpy_get_ptid (PyObject *self, void *closure)
 149 {
 150   thread_object *thread_obj = (thread_object *) self;
 151
 152   THPY_REQUIRE_VALID (thread_obj);
 153
 154   return gdbpy_create_ptid_object (thread_obj->thread->ptid);
 155 }
 156
 157 /* Getter for InferiorThread.inferior -> Inferior.  */
 158
 159 static PyObject *
 160 thpy_get_inferior (PyObject *self, void *ignore)
 161 {
 162   thread_object *thread_obj = (thread_object *) self;
 163
 164   THPY_REQUIRE_VALID (thread_obj);
 165   Py_INCREF (thread_obj->inf_obj);
 166
 167   return thread_obj->inf_obj;
 168 }
 169
 170 /* Implementation of InferiorThread.switch ().
 171    Makes this the GDB selected thread.  */
 172
 173 static PyObject *
 174 thpy_switch (PyObject *self, PyObject *args)
 175 {
 176   thread_object *thread_obj = (thread_object *) self;
 177
 178   THPY_REQUIRE_VALID (thread_obj);
 179
 180   TRY
 181     {
 182       switch_to_thread (thread_obj->thread);
 183     }
 184   CATCH (except, RETURN_MASK_ALL)
 185     {
 186       GDB_PY_HANDLE_EXCEPTION (except);
 187     }
 188   END_CATCH
 189
 190   Py_RETURN_NONE;
 191 }
 192
 193 /* Implementation of InferiorThread.is_stopped () -> Boolean.
 194    Return whether the thread is stopped.  */
 195
 196 static PyObject *
 197 thpy_is_stopped (PyObject *self, PyObject *args)
 198 {
 199   thread_object *thread_obj = (thread_object *) self;
 200
 201   THPY_REQUIRE_VALID (thread_obj);
 202
 203   if (thread_obj->thread->state == THREAD_STOPPED)
 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.  */
 211
 212 static PyObject *
 213 thpy_is_running (PyObject *self, PyObject *args)
 214 {
 215   thread_object *thread_obj = (thread_object *) self;
 216
 217   THPY_REQUIRE_VALID (thread_obj);
 218
 219   if (thread_obj->thread->state == THREAD_RUNNING)
 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.  */
 227
 228 static PyObject *
 229 thpy_is_exited (PyObject *self, PyObject *args)
 230 {
 231   thread_object *thread_obj = (thread_object *) self;
 232
 233   THPY_REQUIRE_VALID (thread_obj);
 234
 235   if (thread_obj->thread->state == THREAD_EXITED)
 236     Py_RETURN_TRUE;
 237
 238   Py_RETURN_FALSE;
 239 }
 240
 241 /* Implementation of gdb.InfThread.is_valid (self) -> Boolean.
 242    Returns True if this inferior Thread object still exists
 243    in GDB.  */
 244
 245 static PyObject *
 246 thpy_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 }
 255
 256 /* Return a reference to a new Python object representing a ptid_t.
 257    The object is a tuple containing (pid, lwp, tid). */
 258 PyObject *
 259 gdbpy_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
 269   pid = ptid.pid ();
 270   lwp = ptid.lwp ();
 271   tid = ptid.tid ();
 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
 280 /* Implementation of gdb.selected_thread () -> gdb.InferiorThread.
 281    Returns the selected thread object.  */
 282
 283 PyObject *
 284 gdbpy_selected_thread (PyObject *self, PyObject *args)
 285 {
 286   if (inferior_ptid != null_ptid)
 287     return thread_to_thread_object (inferior_thread ()).release ();
 288
 289   Py_RETURN_NONE;
 290 }
 291
 292 int
 293 gdbpy_initialize_thread (void)
 294 {
 295   if (PyType_Ready (&thread_object_type) < 0)
 296     return -1;
 297
 298   return gdb_pymodule_addobject (gdb_module, "InferiorThread",
 299                                  (PyObject *) &thread_object_type);
 300 }
 301
 302 static gdb_PyGetSetDef thread_object_getset[] =
 303 {
 304   { "name", thpy_get_name, thpy_set_name,
 305     "The name of the thread, as set by the user or the OS.", NULL },
 306   { "num", thpy_get_num, NULL,
 307     "Per-inferior number of the thread, as assigned by GDB.", NULL },
 308   { "global_num", thpy_get_global_num, NULL,
 309     "Global number of the thread, as assigned by GDB.", NULL },
 310   { "ptid", thpy_get_ptid, NULL, "ID of the thread, as assigned by the OS.",
 311     NULL },
 312   { "inferior", thpy_get_inferior, NULL,
 313     "The Inferior object this thread belongs to.", NULL },
 314
 315   { NULL }
 316 };
 317
 318 static PyMethodDef thread_object_methods[] =
 319 {
 320   { "is_valid", thpy_is_valid, METH_NOARGS,
 321     "is_valid () -> Boolean.\n\
 322 Return true if this inferior thread is valid, false if not." },
 323   { "switch", thpy_switch, METH_NOARGS,
 324     "switch ()\n\
 325 Makes this the GDB selected thread." },
 326   { "is_stopped", thpy_is_stopped, METH_NOARGS,
 327     "is_stopped () -> Boolean\n\
 328 Return whether the thread is stopped." },
 329   { "is_running", thpy_is_running, METH_NOARGS,
 330     "is_running () -> Boolean\n\
 331 Return whether the thread is running." },
 332   { "is_exited", thpy_is_exited, METH_NOARGS,
 333     "is_exited () -> Boolean\n\
 334 Return whether the thread is exited." },
 335
 336   { NULL }
 337 };
 338
 339 PyTypeObject thread_object_type =
 340 {
 341   PyVarObject_HEAD_INIT (NULL, 0)
 342   "gdb.InferiorThread",           /*tp_name*/
 343   sizeof (thread_object),         /*tp_basicsize*/
 344   0,                              /*tp_itemsize*/
 345   thpy_dealloc,                   /*tp_dealloc*/
 346   0,                              /*tp_print*/
 347   0,                              /*tp_getattr*/
 348   0,                              /*tp_setattr*/
 349   0,                              /*tp_compare*/
 350   0,                              /*tp_repr*/
 351   0,                              /*tp_as_number*/
 352   0,                              /*tp_as_sequence*/
 353   0,                              /*tp_as_mapping*/
 354   0,                              /*tp_hash */
 355   0,                              /*tp_call*/
 356   0,                              /*tp_str*/
 357   0,                              /*tp_getattro*/
 358   0,                              /*tp_setattro*/
 359   0,                              /*tp_as_buffer*/
 360   Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_ITER,  /*tp_flags*/
 361   "GDB thread object",            /* tp_doc */
 362   0,                              /* tp_traverse */
 363   0,                              /* tp_clear */
 364   0,                              /* tp_richcompare */
 365   0,                              /* tp_weaklistoffset */
 366   0,                              /* tp_iter */
 367   0,                              /* tp_iternext */
 368   thread_object_methods,          /* tp_methods */
 369   0,                              /* tp_members */
 370   thread_object_getset,           /* tp_getset */
 371   0,                              /* tp_base */
 372   0,                              /* tp_dict */
 373   0,                              /* tp_descr_get */
 374   0,                              /* tp_descr_set */
 375   0,                              /* tp_dictoffset */
 376   0,                              /* tp_init */
 377   0                               /* tp_alloc */
 378 };