gdb/python/py-infthread.c

   1 /* Python interface to inferior threads.
   2
   3    Copyright (C) 2009-2016 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 = find_inferior_object (ptid_get_pid (tp->ptid));
  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   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     name = NULL;
  99   else if (! gdbpy_is_string (newvalue))
 100     {
 101       PyErr_SetString (PyExc_TypeError,
 102                        _("The value of `name' must be a string."));
 103       return -1;
 104     }
 105   else
 106     {
 107       name = python_string_to_host_string (newvalue);
 108       if (! name)
 109         return -1;
 110     }
 111
 112   xfree (thread_obj->thread->name);
 113   thread_obj->thread->name = name;
 114
 115   return 0;
 116 }
 117
 118 static PyObject *
 119 thpy_get_num (PyObject *self, void *closure)
 120 {
 121   thread_object *thread_obj = (thread_object *) self;
 122
 123   THPY_REQUIRE_VALID (thread_obj);
 124
 125   return PyLong_FromLong (thread_obj->thread->num);
 126 }
 127
 128 /* Getter for InferiorThread.ptid  -> (pid, lwp, tid).
 129    Returns a tuple with the thread's ptid components.  */
 130
 131 static PyObject *
 132 thpy_get_ptid (PyObject *self, void *closure)
 133 {
 134   int pid;
 135   long tid, lwp;
 136   thread_object *thread_obj = (thread_object *) self;
 137
 138   THPY_REQUIRE_VALID (thread_obj);
 139
 140   return gdbpy_create_ptid_object (thread_obj->thread->ptid);
 141 }
 142
 143 /* Getter for InferiorThread.inferior -> Inferior.  */
 144
 145 static PyObject *
 146 thpy_get_inferior (PyObject *self, void *ignore)
 147 {
 148   thread_object *thread_obj = (thread_object *) self;
 149
 150   THPY_REQUIRE_VALID (thread_obj);
 151
 152   return thread_obj->inf_obj;
 153 }
 154
 155 /* Implementation of InferiorThread.switch ().
 156    Makes this the GDB selected thread.  */
 157
 158 static PyObject *
 159 thpy_switch (PyObject *self, PyObject *args)
 160 {
 161   thread_object *thread_obj = (thread_object *) self;
 162
 163   THPY_REQUIRE_VALID (thread_obj);
 164
 165   TRY
 166     {
 167       switch_to_thread (thread_obj->thread->ptid);
 168     }
 169   CATCH (except, RETURN_MASK_ALL)
 170     {
 171       GDB_PY_HANDLE_EXCEPTION (except);
 172     }
 173   END_CATCH
 174
 175   Py_RETURN_NONE;
 176 }
 177
 178 /* Implementation of InferiorThread.is_stopped () -> Boolean.
 179    Return whether the thread is stopped.  */
 180
 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
 197 static PyObject *
 198 thpy_is_running (PyObject *self, PyObject *args)
 199 {
 200   thread_object *thread_obj = (thread_object *) self;
 201
 202   THPY_REQUIRE_VALID (thread_obj);
 203
 204   if (is_running (thread_obj->thread->ptid))
 205     Py_RETURN_TRUE;
 206
 207   Py_RETURN_FALSE;
 208 }
 209
 210 /* Implementation of InferiorThread.is_exited () -> Boolean.
 211    Return whether the thread is exited.  */
 212
 213 static PyObject *
 214 thpy_is_exited (PyObject *self, PyObject *args)
 215 {
 216   thread_object *thread_obj = (thread_object *) self;
 217
 218   THPY_REQUIRE_VALID (thread_obj);
 219
 220   if (is_exited (thread_obj->thread->ptid))
 221     Py_RETURN_TRUE;
 222
 223   Py_RETURN_FALSE;
 224 }
 225
 226 /* Implementation of gdb.InfThread.is_valid (self) -> Boolean.
 227    Returns True if this inferior Thread object still exists
 228    in GDB.  */
 229
 230 static PyObject *
 231 thpy_is_valid (PyObject *self, PyObject *args)
 232 {
 233   thread_object *thread_obj = (thread_object *) self;
 234
 235   if (! thread_obj->thread)
 236     Py_RETURN_FALSE;
 237
 238   Py_RETURN_TRUE;
 239 }
 240
 241 /* Return a reference to a new Python object representing a ptid_t.
 242    The object is a tuple containing (pid, lwp, tid). */
 243 PyObject *
 244 gdbpy_create_ptid_object (ptid_t ptid)
 245 {
 246   int pid;
 247   long tid, lwp;
 248   PyObject *ret;
 249
 250   ret = PyTuple_New (3);
 251   if (!ret)
 252     return NULL;
 253
 254   pid = ptid_get_pid (ptid);
 255   lwp = ptid_get_lwp (ptid);
 256   tid = ptid_get_tid (ptid);
 257
 258   PyTuple_SET_ITEM (ret, 0, PyInt_FromLong (pid));
 259   PyTuple_SET_ITEM (ret, 1, PyInt_FromLong (lwp));
 260   PyTuple_SET_ITEM (ret, 2, PyInt_FromLong (tid));
 261
 262   return ret;
 263 }
 264
 265 /* Implementation of gdb.selected_thread () -> gdb.InferiorThread.
 266    Returns the selected thread object.  */
 267
 268 PyObject *
 269 gdbpy_selected_thread (PyObject *self, PyObject *args)
 270 {
 271   PyObject *thread_obj;
 272
 273   thread_obj = (PyObject *) find_thread_object (inferior_ptid);
 274   if (thread_obj)
 275     {
 276       Py_INCREF (thread_obj);
 277       return thread_obj;
 278     }
 279
 280   Py_RETURN_NONE;
 281 }
 282
 283 int
 284 gdbpy_initialize_thread (void)
 285 {
 286   if (PyType_Ready (&thread_object_type) < 0)
 287     return -1;
 288
 289   return gdb_pymodule_addobject (gdb_module, "InferiorThread",
 290                                  (PyObject *) &thread_object_type);
 291 }
 292
 293 static PyGetSetDef thread_object_getset[] =
 294 {
 295   { "name", thpy_get_name, thpy_set_name,
 296     "The name of the thread, as set by the user or the OS.", NULL },
 297   { "num", thpy_get_num, NULL, "ID of the thread, as assigned by GDB.", NULL },
 298   { "ptid", thpy_get_ptid, NULL, "ID of the thread, as assigned by the OS.",
 299     NULL },
 300   { "inferior", thpy_get_inferior, NULL,
 301     "The Inferior object this thread belongs to.", NULL },
 302
 303   { NULL }
 304 };
 305
 306 static PyMethodDef thread_object_methods[] =
 307 {
 308   { "is_valid", thpy_is_valid, METH_NOARGS,
 309     "is_valid () -> Boolean.\n\
 310 Return true if this inferior thread is valid, false if not." },
 311   { "switch", thpy_switch, METH_NOARGS,
 312     "switch ()\n\
 313 Makes this the GDB selected thread." },
 314   { "is_stopped", thpy_is_stopped, METH_NOARGS,
 315     "is_stopped () -> Boolean\n\
 316 Return whether the thread is stopped." },
 317   { "is_running", thpy_is_running, METH_NOARGS,
 318     "is_running () -> Boolean\n\
 319 Return whether the thread is running." },
 320   { "is_exited", thpy_is_exited, METH_NOARGS,
 321     "is_exited () -> Boolean\n\
 322 Return whether the thread is exited." },
 323
 324   { NULL }
 325 };
 326
 327 PyTypeObject thread_object_type =
 328 {
 329   PyVarObject_HEAD_INIT (NULL, 0)
 330   "gdb.InferiorThread",           /*tp_name*/
 331   sizeof (thread_object),         /*tp_basicsize*/
 332   0,                              /*tp_itemsize*/
 333   thpy_dealloc,                   /*tp_dealloc*/
 334   0,                              /*tp_print*/
 335   0,                              /*tp_getattr*/
 336   0,                              /*tp_setattr*/
 337   0,                              /*tp_compare*/
 338   0,                              /*tp_repr*/
 339   0,                              /*tp_as_number*/
 340   0,                              /*tp_as_sequence*/
 341   0,                              /*tp_as_mapping*/
 342   0,                              /*tp_hash */
 343   0,                              /*tp_call*/
 344   0,                              /*tp_str*/
 345   0,                              /*tp_getattro*/
 346   0,                              /*tp_setattro*/
 347   0,                              /*tp_as_buffer*/
 348   Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_ITER,  /*tp_flags*/
 349   "GDB thread object",            /* tp_doc */
 350   0,                              /* tp_traverse */
 351   0,                              /* tp_clear */
 352   0,                              /* tp_richcompare */
 353   0,                              /* tp_weaklistoffset */
 354   0,                              /* tp_iter */
 355   0,                              /* tp_iternext */
 356   thread_object_methods,          /* tp_methods */
 357   0,                              /* tp_members */
 358   thread_object_getset,           /* tp_getset */
 359   0,                              /* tp_base */
 360   0,                              /* tp_dict */
 361   0,                              /* tp_descr_get */
 362   0,                              /* tp_descr_set */
 363   0,                              /* tp_dictoffset */
 364   0,                              /* tp_init */
 365   0                               /* tp_alloc */
 366 };