/* Python interface to inferior threads.
- Copyright (C) 2009, 2010, 2011 Free Software Foundation, Inc.
+ Copyright (C) 2009-2020 Free Software Foundation, Inc.
This file is part of GDB.
along with this program. If not, see <http://www.gnu.org/licenses/>. */
#include "defs.h"
-#include "exceptions.h"
#include "gdbthread.h"
#include "inferior.h"
#include "python-internal.h"
-static PyTypeObject thread_object_type;
+extern PyTypeObject thread_object_type
+ CPYCHECKER_TYPE_OBJECT_FOR_TYPEDEF ("thread_object");
/* Require that INFERIOR be a valid inferior ID. */
#define THPY_REQUIRE_VALID(Thread) \
} \
} while (0)
-
-
-thread_object *
+gdbpy_ref<thread_object>
create_thread_object (struct thread_info *tp)
{
- thread_object *thread_obj;
+ gdbpy_ref<thread_object> thread_obj;
+
+ gdbpy_ref<inferior_object> inf_obj = inferior_to_inferior_object (tp->inf);
+ if (inf_obj == NULL)
+ return NULL;
- thread_obj = PyObject_New (thread_object, &thread_object_type);
- if (!thread_obj)
+ thread_obj.reset (PyObject_New (thread_object, &thread_object_type));
+ if (thread_obj == NULL)
return NULL;
thread_obj->thread = tp;
- thread_obj->inf_obj = find_inferior_object (PIDGET (tp->ptid));
- Py_INCREF (thread_obj->inf_obj);
+ thread_obj->inf_obj = (PyObject *) inf_obj.release ();
return thread_obj;
}
-
-
static void
thpy_dealloc (PyObject *self)
{
Py_DECREF (((thread_object *) self)->inf_obj);
- self->ob_type->tp_free (self);
+ Py_TYPE (self)->tp_free (self);
+}
+
+static PyObject *
+thpy_get_name (PyObject *self, void *ignore)
+{
+ thread_object *thread_obj = (thread_object *) self;
+ const char *name;
+
+ THPY_REQUIRE_VALID (thread_obj);
+
+ name = thread_obj->thread->name;
+ if (name == NULL)
+ name = target_thread_name (thread_obj->thread);
+
+ if (name == NULL)
+ Py_RETURN_NONE;
+
+ return PyString_FromString (name);
+}
+
+static int
+thpy_set_name (PyObject *self, PyObject *newvalue, void *ignore)
+{
+ thread_object *thread_obj = (thread_object *) self;
+ gdb::unique_xmalloc_ptr<char> name;
+
+ if (! thread_obj->thread)
+ {
+ PyErr_SetString (PyExc_RuntimeError, _("Thread no longer exists."));
+ return -1;
+ }
+
+ if (newvalue == NULL)
+ {
+ PyErr_SetString (PyExc_TypeError,
+ _("Cannot delete `name' attribute."));
+ return -1;
+ }
+ else if (newvalue == Py_None)
+ {
+ /* Nothing. */
+ }
+ else if (! gdbpy_is_string (newvalue))
+ {
+ PyErr_SetString (PyExc_TypeError,
+ _("The value of `name' must be a string."));
+ return -1;
+ }
+ else
+ {
+ name = python_string_to_host_string (newvalue);
+ if (! name)
+ return -1;
+ }
+
+ xfree (thread_obj->thread->name);
+ thread_obj->thread->name = name.release ();
+
+ return 0;
}
+/* Getter for InferiorThread.num. */
+
static PyObject *
thpy_get_num (PyObject *self, void *closure)
{
THPY_REQUIRE_VALID (thread_obj);
- return PyLong_FromLong (thread_obj->thread->num);
+ return PyLong_FromLong (thread_obj->thread->per_inf_num);
+}
+
+/* Getter for InferiorThread.global_num. */
+
+static PyObject *
+thpy_get_global_num (PyObject *self, void *closure)
+{
+ thread_object *thread_obj = (thread_object *) self;
+
+ THPY_REQUIRE_VALID (thread_obj);
+
+ return PyLong_FromLong (thread_obj->thread->global_num);
}
/* Getter for InferiorThread.ptid -> (pid, lwp, tid).
Returns a tuple with the thread's ptid components. */
+
static PyObject *
thpy_get_ptid (PyObject *self, void *closure)
{
- int pid;
- long tid, lwp;
thread_object *thread_obj = (thread_object *) self;
- PyObject *ret;
THPY_REQUIRE_VALID (thread_obj);
- ret = PyTuple_New (3);
- if (!ret)
- return NULL;
+ return gdbpy_create_ptid_object (thread_obj->thread->ptid);
+}
- pid = ptid_get_pid (thread_obj->thread->ptid);
- lwp = ptid_get_lwp (thread_obj->thread->ptid);
- tid = ptid_get_tid (thread_obj->thread->ptid);
+/* Getter for InferiorThread.inferior -> Inferior. */
- PyTuple_SET_ITEM (ret, 0, PyInt_FromLong (pid));
- PyTuple_SET_ITEM (ret, 1, PyInt_FromLong (lwp));
- PyTuple_SET_ITEM (ret, 2, PyInt_FromLong (tid));
+static PyObject *
+thpy_get_inferior (PyObject *self, void *ignore)
+{
+ thread_object *thread_obj = (thread_object *) self;
- return ret;
+ THPY_REQUIRE_VALID (thread_obj);
+ Py_INCREF (thread_obj->inf_obj);
+
+ return thread_obj->inf_obj;
}
/* Implementation of InferiorThread.switch ().
Makes this the GDB selected thread. */
+
static PyObject *
thpy_switch (PyObject *self, PyObject *args)
{
thread_object *thread_obj = (thread_object *) self;
- struct cleanup *cleanup;
- volatile struct gdb_exception except;
THPY_REQUIRE_VALID (thread_obj);
- TRY_CATCH (except, RETURN_MASK_ALL)
+ try
+ {
+ switch_to_thread (thread_obj->thread);
+ }
+ catch (const gdb_exception &except)
{
- switch_to_thread (thread_obj->thread->ptid);
+ GDB_PY_HANDLE_EXCEPTION (except);
}
- GDB_PY_HANDLE_EXCEPTION (except);
Py_RETURN_NONE;
}
/* Implementation of InferiorThread.is_stopped () -> Boolean.
Return whether the thread is stopped. */
+
static PyObject *
thpy_is_stopped (PyObject *self, PyObject *args)
{
THPY_REQUIRE_VALID (thread_obj);
- if (is_stopped (thread_obj->thread->ptid))
+ if (thread_obj->thread->state == THREAD_STOPPED)
Py_RETURN_TRUE;
Py_RETURN_FALSE;
/* Implementation of InferiorThread.is_running () -> Boolean.
Return whether the thread is running. */
+
static PyObject *
thpy_is_running (PyObject *self, PyObject *args)
{
THPY_REQUIRE_VALID (thread_obj);
- if (is_running (thread_obj->thread->ptid))
+ if (thread_obj->thread->state == THREAD_RUNNING)
Py_RETURN_TRUE;
Py_RETURN_FALSE;
/* Implementation of InferiorThread.is_exited () -> Boolean.
Return whether the thread is exited. */
+
static PyObject *
thpy_is_exited (PyObject *self, PyObject *args)
{
THPY_REQUIRE_VALID (thread_obj);
- if (is_exited (thread_obj->thread->ptid))
+ if (thread_obj->thread->state == THREAD_EXITED)
Py_RETURN_TRUE;
Py_RETURN_FALSE;
}
+/* Implementation of gdb.InfThread.is_valid (self) -> Boolean.
+ Returns True if this inferior Thread object still exists
+ in GDB. */
+static PyObject *
+thpy_is_valid (PyObject *self, PyObject *args)
+{
+ thread_object *thread_obj = (thread_object *) self;
-/* Implementation of gdb.selected_thread () -> gdb.InferiorThread.
- Returns the selected thread object. */
-PyObject *
-gdbpy_selected_thread (PyObject *self, PyObject *args)
+ if (! thread_obj->thread)
+ Py_RETURN_FALSE;
+
+ Py_RETURN_TRUE;
+}
+
+/* Implementation of gdb.InferiorThread.handle (self) -> handle. */
+
+static PyObject *
+thpy_thread_handle (PyObject *self, PyObject *args)
{
- PyObject *thread_obj;
+ thread_object *thread_obj = (thread_object *) self;
+ THPY_REQUIRE_VALID (thread_obj);
- thread_obj = (PyObject *) find_thread_object (inferior_ptid);
- if (thread_obj)
+ gdb::byte_vector hv;
+
+ try
{
- Py_INCREF (thread_obj);
- return thread_obj;
+ hv = target_thread_info_to_thread_handle (thread_obj->thread);
+ }
+ catch (const gdb_exception &except)
+ {
+ GDB_PY_HANDLE_EXCEPTION (except);
}
- Py_RETURN_NONE;
+ if (hv.size () == 0)
+ {
+ PyErr_SetString (PyExc_RuntimeError, _("Thread handle not found."));
+ return NULL;
+ }
+
+ PyObject *object = PyBytes_FromStringAndSize ((const char *) hv.data (),
+ hv.size());
+ return object;
}
+/* Return a reference to a new Python object representing a ptid_t.
+ The object is a tuple containing (pid, lwp, tid). */
+PyObject *
+gdbpy_create_ptid_object (ptid_t ptid)
+{
+ int pid;
+ long tid, lwp;
+ PyObject *ret;
+ ret = PyTuple_New (3);
+ if (!ret)
+ return NULL;
-void
-gdbpy_initialize_thread (void)
+ pid = ptid.pid ();
+ lwp = ptid.lwp ();
+ tid = ptid.tid ();
+
+ PyTuple_SET_ITEM (ret, 0, PyInt_FromLong (pid));
+ PyTuple_SET_ITEM (ret, 1, PyInt_FromLong (lwp));
+ PyTuple_SET_ITEM (ret, 2, PyInt_FromLong (tid));
+
+ return ret;
+}
+
+/* Implementation of gdb.selected_thread () -> gdb.InferiorThread.
+ Returns the selected thread object. */
+
+PyObject *
+gdbpy_selected_thread (PyObject *self, PyObject *args)
{
- if (PyType_Ready (&thread_object_type) < 0)
- return;
+ if (inferior_ptid != null_ptid)
+ return thread_to_thread_object (inferior_thread ()).release ();
- Py_INCREF (&thread_object_type);
- PyModule_AddObject (gdb_module, "InferiorThread",
- (PyObject *) &thread_object_type);
+ Py_RETURN_NONE;
}
+int
+gdbpy_initialize_thread (void)
+{
+ if (PyType_Ready (&thread_object_type) < 0)
+ return -1;
+ return gdb_pymodule_addobject (gdb_module, "InferiorThread",
+ (PyObject *) &thread_object_type);
+}
-static PyGetSetDef thread_object_getset[] =
+static gdb_PyGetSetDef thread_object_getset[] =
{
- { "num", thpy_get_num, NULL, "ID of the thread, as assigned by GDB.", NULL },
+ { "name", thpy_get_name, thpy_set_name,
+ "The name of the thread, as set by the user or the OS.", NULL },
+ { "num", thpy_get_num, NULL,
+ "Per-inferior number of the thread, as assigned by GDB.", NULL },
+ { "global_num", thpy_get_global_num, NULL,
+ "Global number of the thread, as assigned by GDB.", NULL },
{ "ptid", thpy_get_ptid, NULL, "ID of the thread, as assigned by the OS.",
NULL },
+ { "inferior", thpy_get_inferior, NULL,
+ "The Inferior object this thread belongs to.", NULL },
{ NULL }
};
static PyMethodDef thread_object_methods[] =
{
+ { "is_valid", thpy_is_valid, METH_NOARGS,
+ "is_valid () -> Boolean.\n\
+Return true if this inferior thread is valid, false if not." },
{ "switch", thpy_switch, METH_NOARGS,
"switch ()\n\
Makes this the GDB selected thread." },
{ "is_exited", thpy_is_exited, METH_NOARGS,
"is_exited () -> Boolean\n\
Return whether the thread is exited." },
+ { "handle", thpy_thread_handle, METH_NOARGS,
+ "handle () -> handle\n\
+Return thread library specific handle for thread." },
{ NULL }
};
-static PyTypeObject thread_object_type =
+PyTypeObject thread_object_type =
{
- PyObject_HEAD_INIT (NULL)
- 0, /*ob_size*/
+ PyVarObject_HEAD_INIT (NULL, 0)
"gdb.InferiorThread", /*tp_name*/
sizeof (thread_object), /*tp_basicsize*/
0, /*tp_itemsize*/