Guido van Rossum | 1984f1e | 1992-08-04 12:41:02 +0000 | [diff] [blame] | 1 | |
| 2 | /* Thread module */ |
| 3 | /* Interface to Sjoerd's portable C thread library */ |
| 4 | |
Barry Warsaw | d0c1042 | 1996-12-17 00:05:22 +0000 | [diff] [blame] | 5 | #include "Python.h" |
Victor Stinner | cd590a7 | 2019-05-28 00:39:52 +0200 | [diff] [blame] | 6 | #include "pycore_pylifecycle.h" |
Victor Stinner | 4a21e57 | 2020-04-15 02:35:41 +0200 | [diff] [blame] | 7 | #include "pycore_interp.h" // _PyInterpreterState.num_threads |
| 8 | #include "pycore_pystate.h" // _PyThreadState_Init() |
| 9 | #include <stddef.h> // offsetof() |
Guido van Rossum | 1984f1e | 1992-08-04 12:41:02 +0000 | [diff] [blame] | 10 | |
Victor Stinner | 8203c73 | 2020-12-16 12:20:33 +0100 | [diff] [blame] | 11 | // ThreadError is just an alias to PyExc_RuntimeError |
| 12 | #define ThreadError PyExc_RuntimeError |
| 13 | |
| 14 | _Py_IDENTIFIER(__dict__); |
Guido van Rossum | 1984f1e | 1992-08-04 12:41:02 +0000 | [diff] [blame] | 15 | |
Victor Stinner | bd303c1 | 2013-11-07 23:07:29 +0100 | [diff] [blame] | 16 | _Py_IDENTIFIER(stderr); |
Victor Stinner | cd590a7 | 2019-05-28 00:39:52 +0200 | [diff] [blame] | 17 | _Py_IDENTIFIER(flush); |
Victor Stinner | bd303c1 | 2013-11-07 23:07:29 +0100 | [diff] [blame] | 18 | |
Victor Stinner | 8203c73 | 2020-12-16 12:20:33 +0100 | [diff] [blame] | 19 | |
Guido van Rossum | 1984f1e | 1992-08-04 12:41:02 +0000 | [diff] [blame] | 20 | /* Lock objects */ |
| 21 | |
| 22 | typedef struct { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 23 | PyObject_HEAD |
| 24 | PyThread_type_lock lock_lock; |
| 25 | PyObject *in_weakreflist; |
Kristjan Valur Jonsson | 69cf913 | 2012-06-22 18:40:02 +0000 | [diff] [blame] | 26 | char locked; /* for sanity checking */ |
Guido van Rossum | 1984f1e | 1992-08-04 12:41:02 +0000 | [diff] [blame] | 27 | } lockobject; |
| 28 | |
Guido van Rossum | 1984f1e | 1992-08-04 12:41:02 +0000 | [diff] [blame] | 29 | static void |
Peter Schneider-Kamp | 3707efe | 2000-07-10 10:03:58 +0000 | [diff] [blame] | 30 | lock_dealloc(lockobject *self) |
Guido van Rossum | 1984f1e | 1992-08-04 12:41:02 +0000 | [diff] [blame] | 31 | { |
Victor Stinner | 8203c73 | 2020-12-16 12:20:33 +0100 | [diff] [blame] | 32 | if (self->in_weakreflist != NULL) { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 33 | PyObject_ClearWeakRefs((PyObject *) self); |
Victor Stinner | 8203c73 | 2020-12-16 12:20:33 +0100 | [diff] [blame] | 34 | } |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 35 | if (self->lock_lock != NULL) { |
| 36 | /* Unlock the lock so it's safe to free it */ |
Kristjan Valur Jonsson | 69cf913 | 2012-06-22 18:40:02 +0000 | [diff] [blame] | 37 | if (self->locked) |
| 38 | PyThread_release_lock(self->lock_lock); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 39 | PyThread_free_lock(self->lock_lock); |
| 40 | } |
Victor Stinner | 32bd68c | 2020-12-01 10:37:39 +0100 | [diff] [blame] | 41 | PyObject_Free(self); |
Guido van Rossum | 1984f1e | 1992-08-04 12:41:02 +0000 | [diff] [blame] | 42 | } |
| 43 | |
Antoine Pitrou | 810023d | 2010-12-15 22:59:16 +0000 | [diff] [blame] | 44 | /* Helper to acquire an interruptible lock with a timeout. If the lock acquire |
| 45 | * is interrupted, signal handlers are run, and if they raise an exception, |
| 46 | * PY_LOCK_INTR is returned. Otherwise, PY_LOCK_ACQUIRED or PY_LOCK_FAILURE |
Raymond Hettinger | 15f44ab | 2016-08-30 10:47:49 -0700 | [diff] [blame] | 47 | * are returned, depending on whether the lock can be acquired within the |
Antoine Pitrou | 810023d | 2010-12-15 22:59:16 +0000 | [diff] [blame] | 48 | * timeout. |
| 49 | */ |
| 50 | static PyLockStatus |
Victor Stinner | f5faad2 | 2015-03-28 03:52:05 +0100 | [diff] [blame] | 51 | acquire_timed(PyThread_type_lock lock, _PyTime_t timeout) |
Antoine Pitrou | 810023d | 2010-12-15 22:59:16 +0000 | [diff] [blame] | 52 | { |
| 53 | PyLockStatus r; |
Victor Stinner | f5faad2 | 2015-03-28 03:52:05 +0100 | [diff] [blame] | 54 | _PyTime_t endtime = 0; |
Antoine Pitrou | 810023d | 2010-12-15 22:59:16 +0000 | [diff] [blame] | 55 | |
Victor Stinner | 8203c73 | 2020-12-16 12:20:33 +0100 | [diff] [blame] | 56 | if (timeout > 0) { |
Victor Stinner | f5faad2 | 2015-03-28 03:52:05 +0100 | [diff] [blame] | 57 | endtime = _PyTime_GetMonotonicClock() + timeout; |
Victor Stinner | 8203c73 | 2020-12-16 12:20:33 +0100 | [diff] [blame] | 58 | } |
Antoine Pitrou | 810023d | 2010-12-15 22:59:16 +0000 | [diff] [blame] | 59 | |
| 60 | do { |
Victor Stinner | 8203c73 | 2020-12-16 12:20:33 +0100 | [diff] [blame] | 61 | _PyTime_t microseconds; |
Victor Stinner | 869e177 | 2015-03-30 03:49:14 +0200 | [diff] [blame] | 62 | microseconds = _PyTime_AsMicroseconds(timeout, _PyTime_ROUND_CEILING); |
Victor Stinner | f5faad2 | 2015-03-28 03:52:05 +0100 | [diff] [blame] | 63 | |
Kristjan Valur Jonsson | 69cf913 | 2012-06-22 18:40:02 +0000 | [diff] [blame] | 64 | /* first a simple non-blocking try without releasing the GIL */ |
| 65 | r = PyThread_acquire_lock_timed(lock, 0, 0); |
| 66 | if (r == PY_LOCK_FAILURE && microseconds != 0) { |
| 67 | Py_BEGIN_ALLOW_THREADS |
| 68 | r = PyThread_acquire_lock_timed(lock, microseconds, 1); |
| 69 | Py_END_ALLOW_THREADS |
Victor Stinner | 357f515 | 2013-11-05 15:10:19 +0100 | [diff] [blame] | 70 | } |
Antoine Pitrou | 810023d | 2010-12-15 22:59:16 +0000 | [diff] [blame] | 71 | |
| 72 | if (r == PY_LOCK_INTR) { |
| 73 | /* Run signal handlers if we were interrupted. Propagate |
| 74 | * exceptions from signal handlers, such as KeyboardInterrupt, by |
| 75 | * passing up PY_LOCK_INTR. */ |
| 76 | if (Py_MakePendingCalls() < 0) { |
| 77 | return PY_LOCK_INTR; |
| 78 | } |
| 79 | |
| 80 | /* If we're using a timeout, recompute the timeout after processing |
| 81 | * signals, since those can take time. */ |
Victor Stinner | f5faad2 | 2015-03-28 03:52:05 +0100 | [diff] [blame] | 82 | if (timeout > 0) { |
| 83 | timeout = endtime - _PyTime_GetMonotonicClock(); |
Antoine Pitrou | 810023d | 2010-12-15 22:59:16 +0000 | [diff] [blame] | 84 | |
| 85 | /* Check for negative values, since those mean block forever. |
| 86 | */ |
Victor Stinner | 6aa446c | 2015-03-30 21:33:51 +0200 | [diff] [blame] | 87 | if (timeout < 0) { |
Antoine Pitrou | 810023d | 2010-12-15 22:59:16 +0000 | [diff] [blame] | 88 | r = PY_LOCK_FAILURE; |
| 89 | } |
| 90 | } |
| 91 | } |
| 92 | } while (r == PY_LOCK_INTR); /* Retry if we were interrupted. */ |
| 93 | |
| 94 | return r; |
| 95 | } |
| 96 | |
Victor Stinner | f5faad2 | 2015-03-28 03:52:05 +0100 | [diff] [blame] | 97 | static int |
| 98 | lock_acquire_parse_args(PyObject *args, PyObject *kwds, |
| 99 | _PyTime_t *timeout) |
Guido van Rossum | 1984f1e | 1992-08-04 12:41:02 +0000 | [diff] [blame] | 100 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 101 | char *kwlist[] = {"blocking", "timeout", NULL}; |
| 102 | int blocking = 1; |
Victor Stinner | f5faad2 | 2015-03-28 03:52:05 +0100 | [diff] [blame] | 103 | PyObject *timeout_obj = NULL; |
Victor Stinner | 13019fd | 2015-04-03 13:10:54 +0200 | [diff] [blame] | 104 | const _PyTime_t unset_timeout = _PyTime_FromSeconds(-1); |
Guido van Rossum | 1984f1e | 1992-08-04 12:41:02 +0000 | [diff] [blame] | 105 | |
Victor Stinner | f5faad2 | 2015-03-28 03:52:05 +0100 | [diff] [blame] | 106 | *timeout = unset_timeout ; |
Guido van Rossum | 1984f1e | 1992-08-04 12:41:02 +0000 | [diff] [blame] | 107 | |
Victor Stinner | f5faad2 | 2015-03-28 03:52:05 +0100 | [diff] [blame] | 108 | if (!PyArg_ParseTupleAndKeywords(args, kwds, "|iO:acquire", kwlist, |
| 109 | &blocking, &timeout_obj)) |
| 110 | return -1; |
| 111 | |
| 112 | if (timeout_obj |
Victor Stinner | 869e177 | 2015-03-30 03:49:14 +0200 | [diff] [blame] | 113 | && _PyTime_FromSecondsObject(timeout, |
Pablo Galindo | 59af94f | 2017-10-18 08:13:09 +0100 | [diff] [blame] | 114 | timeout_obj, _PyTime_ROUND_TIMEOUT) < 0) |
Victor Stinner | f5faad2 | 2015-03-28 03:52:05 +0100 | [diff] [blame] | 115 | return -1; |
| 116 | |
| 117 | if (!blocking && *timeout != unset_timeout ) { |
| 118 | PyErr_SetString(PyExc_ValueError, |
| 119 | "can't specify a timeout for a non-blocking call"); |
| 120 | return -1; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 121 | } |
Victor Stinner | f5faad2 | 2015-03-28 03:52:05 +0100 | [diff] [blame] | 122 | if (*timeout < 0 && *timeout != unset_timeout) { |
| 123 | PyErr_SetString(PyExc_ValueError, |
| 124 | "timeout value must be positive"); |
| 125 | return -1; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 126 | } |
| 127 | if (!blocking) |
Victor Stinner | f5faad2 | 2015-03-28 03:52:05 +0100 | [diff] [blame] | 128 | *timeout = 0; |
| 129 | else if (*timeout != unset_timeout) { |
| 130 | _PyTime_t microseconds; |
| 131 | |
Pablo Galindo | 59af94f | 2017-10-18 08:13:09 +0100 | [diff] [blame] | 132 | microseconds = _PyTime_AsMicroseconds(*timeout, _PyTime_ROUND_TIMEOUT); |
Victor Stinner | f5faad2 | 2015-03-28 03:52:05 +0100 | [diff] [blame] | 133 | if (microseconds >= PY_TIMEOUT_MAX) { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 134 | PyErr_SetString(PyExc_OverflowError, |
| 135 | "timeout value is too large"); |
Victor Stinner | f5faad2 | 2015-03-28 03:52:05 +0100 | [diff] [blame] | 136 | return -1; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 137 | } |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 138 | } |
Victor Stinner | f5faad2 | 2015-03-28 03:52:05 +0100 | [diff] [blame] | 139 | return 0; |
| 140 | } |
Guido van Rossum | 1984f1e | 1992-08-04 12:41:02 +0000 | [diff] [blame] | 141 | |
Victor Stinner | f5faad2 | 2015-03-28 03:52:05 +0100 | [diff] [blame] | 142 | static PyObject * |
| 143 | lock_PyThread_acquire_lock(lockobject *self, PyObject *args, PyObject *kwds) |
| 144 | { |
| 145 | _PyTime_t timeout; |
Victor Stinner | f5faad2 | 2015-03-28 03:52:05 +0100 | [diff] [blame] | 146 | if (lock_acquire_parse_args(args, kwds, &timeout) < 0) |
| 147 | return NULL; |
| 148 | |
Victor Stinner | 8203c73 | 2020-12-16 12:20:33 +0100 | [diff] [blame] | 149 | PyLockStatus r = acquire_timed(self->lock_lock, timeout); |
Antoine Pitrou | 810023d | 2010-12-15 22:59:16 +0000 | [diff] [blame] | 150 | if (r == PY_LOCK_INTR) { |
| 151 | return NULL; |
| 152 | } |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 153 | |
Kristjan Valur Jonsson | 69cf913 | 2012-06-22 18:40:02 +0000 | [diff] [blame] | 154 | if (r == PY_LOCK_ACQUIRED) |
| 155 | self->locked = 1; |
Antoine Pitrou | 810023d | 2010-12-15 22:59:16 +0000 | [diff] [blame] | 156 | return PyBool_FromLong(r == PY_LOCK_ACQUIRED); |
Guido van Rossum | 1984f1e | 1992-08-04 12:41:02 +0000 | [diff] [blame] | 157 | } |
| 158 | |
Martin v. Löwis | 14f8b4c | 2002-06-13 20:33:02 +0000 | [diff] [blame] | 159 | PyDoc_STRVAR(acquire_doc, |
Berker Peksag | 720e655 | 2016-05-02 12:25:35 +0300 | [diff] [blame] | 160 | "acquire(blocking=True, timeout=-1) -> bool\n\ |
Guido van Rossum | f669436 | 2006-03-10 02:28:35 +0000 | [diff] [blame] | 161 | (acquire_lock() is an obsolete synonym)\n\ |
Guido van Rossum | 75e9fc3 | 1998-06-27 18:21:06 +0000 | [diff] [blame] | 162 | \n\ |
| 163 | Lock the lock. Without argument, this blocks if the lock is already\n\ |
| 164 | locked (even by the same thread), waiting for another thread to release\n\ |
R David Murray | 95b7110 | 2013-02-04 10:15:58 -0500 | [diff] [blame] | 165 | the lock, and return True once the lock is acquired.\n\ |
Guido van Rossum | 8fdc75b | 2002-04-07 06:32:21 +0000 | [diff] [blame] | 166 | With an argument, this will only block if the argument is true,\n\ |
Guido van Rossum | 75e9fc3 | 1998-06-27 18:21:06 +0000 | [diff] [blame] | 167 | and the return value reflects whether the lock is acquired.\n\ |
Antoine Pitrou | 810023d | 2010-12-15 22:59:16 +0000 | [diff] [blame] | 168 | The blocking operation is interruptible."); |
Guido van Rossum | 75e9fc3 | 1998-06-27 18:21:06 +0000 | [diff] [blame] | 169 | |
Barry Warsaw | d0c1042 | 1996-12-17 00:05:22 +0000 | [diff] [blame] | 170 | static PyObject * |
Siddhesh Poyarekar | 55edd0c | 2018-04-30 00:29:33 +0530 | [diff] [blame] | 171 | lock_PyThread_release_lock(lockobject *self, PyObject *Py_UNUSED(ignored)) |
Guido van Rossum | 1984f1e | 1992-08-04 12:41:02 +0000 | [diff] [blame] | 172 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 173 | /* Sanity check: the lock must be locked */ |
Kristjan Valur Jonsson | 69cf913 | 2012-06-22 18:40:02 +0000 | [diff] [blame] | 174 | if (!self->locked) { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 175 | PyErr_SetString(ThreadError, "release unlocked lock"); |
| 176 | return NULL; |
| 177 | } |
Guido van Rossum | 1984f1e | 1992-08-04 12:41:02 +0000 | [diff] [blame] | 178 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 179 | PyThread_release_lock(self->lock_lock); |
Kristjan Valur Jonsson | 69cf913 | 2012-06-22 18:40:02 +0000 | [diff] [blame] | 180 | self->locked = 0; |
Serhiy Storchaka | 228b12e | 2017-01-23 09:47:21 +0200 | [diff] [blame] | 181 | Py_RETURN_NONE; |
Guido van Rossum | 1984f1e | 1992-08-04 12:41:02 +0000 | [diff] [blame] | 182 | } |
| 183 | |
Martin v. Löwis | 14f8b4c | 2002-06-13 20:33:02 +0000 | [diff] [blame] | 184 | PyDoc_STRVAR(release_doc, |
Guido van Rossum | 75e9fc3 | 1998-06-27 18:21:06 +0000 | [diff] [blame] | 185 | "release()\n\ |
Guido van Rossum | f669436 | 2006-03-10 02:28:35 +0000 | [diff] [blame] | 186 | (release_lock() is an obsolete synonym)\n\ |
Guido van Rossum | 75e9fc3 | 1998-06-27 18:21:06 +0000 | [diff] [blame] | 187 | \n\ |
| 188 | Release the lock, allowing another thread that is blocked waiting for\n\ |
| 189 | the lock to acquire the lock. The lock must be in the locked state,\n\ |
Martin v. Löwis | 14f8b4c | 2002-06-13 20:33:02 +0000 | [diff] [blame] | 190 | but it needn't be locked by the same thread that unlocks it."); |
Guido van Rossum | 75e9fc3 | 1998-06-27 18:21:06 +0000 | [diff] [blame] | 191 | |
Barry Warsaw | d0c1042 | 1996-12-17 00:05:22 +0000 | [diff] [blame] | 192 | static PyObject * |
Siddhesh Poyarekar | 55edd0c | 2018-04-30 00:29:33 +0530 | [diff] [blame] | 193 | lock_locked_lock(lockobject *self, PyObject *Py_UNUSED(ignored)) |
Guido van Rossum | 1984f1e | 1992-08-04 12:41:02 +0000 | [diff] [blame] | 194 | { |
Kristjan Valur Jonsson | 69cf913 | 2012-06-22 18:40:02 +0000 | [diff] [blame] | 195 | return PyBool_FromLong((long)self->locked); |
Guido van Rossum | 1984f1e | 1992-08-04 12:41:02 +0000 | [diff] [blame] | 196 | } |
| 197 | |
Martin v. Löwis | 14f8b4c | 2002-06-13 20:33:02 +0000 | [diff] [blame] | 198 | PyDoc_STRVAR(locked_doc, |
Guido van Rossum | 8fdc75b | 2002-04-07 06:32:21 +0000 | [diff] [blame] | 199 | "locked() -> bool\n\ |
Guido van Rossum | 75e9fc3 | 1998-06-27 18:21:06 +0000 | [diff] [blame] | 200 | (locked_lock() is an obsolete synonym)\n\ |
| 201 | \n\ |
Martin v. Löwis | 14f8b4c | 2002-06-13 20:33:02 +0000 | [diff] [blame] | 202 | Return whether the lock is in the locked state."); |
Guido van Rossum | 75e9fc3 | 1998-06-27 18:21:06 +0000 | [diff] [blame] | 203 | |
Raymond Hettinger | 62f4dad | 2014-05-25 18:22:35 -0700 | [diff] [blame] | 204 | static PyObject * |
| 205 | lock_repr(lockobject *self) |
| 206 | { |
| 207 | return PyUnicode_FromFormat("<%s %s object at %p>", |
| 208 | self->locked ? "locked" : "unlocked", Py_TYPE(self)->tp_name, self); |
| 209 | } |
| 210 | |
Victor Stinner | 87255be | 2020-04-07 23:11:49 +0200 | [diff] [blame] | 211 | #ifdef HAVE_FORK |
| 212 | static PyObject * |
| 213 | lock__at_fork_reinit(lockobject *self, PyObject *Py_UNUSED(args)) |
| 214 | { |
| 215 | if (_PyThread_at_fork_reinit(&self->lock_lock) < 0) { |
| 216 | PyErr_SetString(ThreadError, "failed to reinitialize lock at fork"); |
| 217 | return NULL; |
| 218 | } |
| 219 | |
| 220 | self->locked = 0; |
| 221 | |
| 222 | Py_RETURN_NONE; |
| 223 | } |
| 224 | #endif /* HAVE_FORK */ |
| 225 | |
| 226 | |
Barry Warsaw | d0c1042 | 1996-12-17 00:05:22 +0000 | [diff] [blame] | 227 | static PyMethodDef lock_methods[] = { |
Serhiy Storchaka | 62be742 | 2018-11-27 13:27:31 +0200 | [diff] [blame] | 228 | {"acquire_lock", (PyCFunction)(void(*)(void))lock_PyThread_acquire_lock, |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 229 | METH_VARARGS | METH_KEYWORDS, acquire_doc}, |
Serhiy Storchaka | 62be742 | 2018-11-27 13:27:31 +0200 | [diff] [blame] | 230 | {"acquire", (PyCFunction)(void(*)(void))lock_PyThread_acquire_lock, |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 231 | METH_VARARGS | METH_KEYWORDS, acquire_doc}, |
| 232 | {"release_lock", (PyCFunction)lock_PyThread_release_lock, |
| 233 | METH_NOARGS, release_doc}, |
| 234 | {"release", (PyCFunction)lock_PyThread_release_lock, |
| 235 | METH_NOARGS, release_doc}, |
| 236 | {"locked_lock", (PyCFunction)lock_locked_lock, |
| 237 | METH_NOARGS, locked_doc}, |
| 238 | {"locked", (PyCFunction)lock_locked_lock, |
| 239 | METH_NOARGS, locked_doc}, |
Serhiy Storchaka | 62be742 | 2018-11-27 13:27:31 +0200 | [diff] [blame] | 240 | {"__enter__", (PyCFunction)(void(*)(void))lock_PyThread_acquire_lock, |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 241 | METH_VARARGS | METH_KEYWORDS, acquire_doc}, |
| 242 | {"__exit__", (PyCFunction)lock_PyThread_release_lock, |
| 243 | METH_VARARGS, release_doc}, |
Victor Stinner | 87255be | 2020-04-07 23:11:49 +0200 | [diff] [blame] | 244 | #ifdef HAVE_FORK |
| 245 | {"_at_fork_reinit", (PyCFunction)lock__at_fork_reinit, |
| 246 | METH_NOARGS, NULL}, |
| 247 | #endif |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 248 | {NULL, NULL} /* sentinel */ |
Guido van Rossum | 1984f1e | 1992-08-04 12:41:02 +0000 | [diff] [blame] | 249 | }; |
| 250 | |
Victor Stinner | 8203c73 | 2020-12-16 12:20:33 +0100 | [diff] [blame] | 251 | PyDoc_STRVAR(lock_doc, |
| 252 | "A lock object is a synchronization primitive. To create a lock,\n\ |
| 253 | call threading.Lock(). Methods are:\n\ |
| 254 | \n\ |
| 255 | acquire() -- lock the lock, possibly blocking until it can be obtained\n\ |
| 256 | release() -- unlock of the lock\n\ |
| 257 | locked() -- test whether the lock is currently locked\n\ |
| 258 | \n\ |
| 259 | A lock is not owned by the thread that locked it; another thread may\n\ |
| 260 | unlock it. A thread attempting to lock a lock that it has already locked\n\ |
| 261 | will block until another thread unlocks it. Deadlocks may ensue."); |
| 262 | |
Barry Warsaw | d0c1042 | 1996-12-17 00:05:22 +0000 | [diff] [blame] | 263 | static PyTypeObject Locktype = { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 264 | PyVarObject_HEAD_INIT(&PyType_Type, 0) |
Victor Stinner | 8203c73 | 2020-12-16 12:20:33 +0100 | [diff] [blame] | 265 | .tp_name = "_thread.lock", |
| 266 | .tp_basicsize = sizeof(lockobject), |
| 267 | .tp_dealloc = (destructor)lock_dealloc, |
| 268 | .tp_repr = (reprfunc)lock_repr, |
| 269 | .tp_flags = Py_TPFLAGS_DEFAULT, |
| 270 | .tp_doc = lock_doc, |
| 271 | .tp_weaklistoffset = offsetof(lockobject, in_weakreflist), |
| 272 | .tp_methods = lock_methods, |
Guido van Rossum | 1984f1e | 1992-08-04 12:41:02 +0000 | [diff] [blame] | 273 | }; |
| 274 | |
Antoine Pitrou | 434736a | 2009-11-10 18:46:01 +0000 | [diff] [blame] | 275 | /* Recursive lock objects */ |
| 276 | |
| 277 | typedef struct { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 278 | PyObject_HEAD |
| 279 | PyThread_type_lock rlock_lock; |
Serhiy Storchaka | aefa7eb | 2017-03-23 15:48:39 +0200 | [diff] [blame] | 280 | unsigned long rlock_owner; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 281 | unsigned long rlock_count; |
| 282 | PyObject *in_weakreflist; |
Antoine Pitrou | 434736a | 2009-11-10 18:46:01 +0000 | [diff] [blame] | 283 | } rlockobject; |
| 284 | |
| 285 | static void |
| 286 | rlock_dealloc(rlockobject *self) |
| 287 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 288 | if (self->in_weakreflist != NULL) |
| 289 | PyObject_ClearWeakRefs((PyObject *) self); |
Victor Stinner | 357f515 | 2013-11-05 15:10:19 +0100 | [diff] [blame] | 290 | /* self->rlock_lock can be NULL if PyThread_allocate_lock() failed |
| 291 | in rlock_new() */ |
| 292 | if (self->rlock_lock != NULL) { |
| 293 | /* Unlock the lock so it's safe to free it */ |
| 294 | if (self->rlock_count > 0) |
| 295 | PyThread_release_lock(self->rlock_lock); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 296 | |
Victor Stinner | 357f515 | 2013-11-05 15:10:19 +0100 | [diff] [blame] | 297 | PyThread_free_lock(self->rlock_lock); |
| 298 | } |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 299 | Py_TYPE(self)->tp_free(self); |
Antoine Pitrou | 434736a | 2009-11-10 18:46:01 +0000 | [diff] [blame] | 300 | } |
| 301 | |
| 302 | static PyObject * |
| 303 | rlock_acquire(rlockobject *self, PyObject *args, PyObject *kwds) |
| 304 | { |
Victor Stinner | f5faad2 | 2015-03-28 03:52:05 +0100 | [diff] [blame] | 305 | _PyTime_t timeout; |
Serhiy Storchaka | aefa7eb | 2017-03-23 15:48:39 +0200 | [diff] [blame] | 306 | unsigned long tid; |
Antoine Pitrou | 810023d | 2010-12-15 22:59:16 +0000 | [diff] [blame] | 307 | PyLockStatus r = PY_LOCK_ACQUIRED; |
Antoine Pitrou | 434736a | 2009-11-10 18:46:01 +0000 | [diff] [blame] | 308 | |
Victor Stinner | f5faad2 | 2015-03-28 03:52:05 +0100 | [diff] [blame] | 309 | if (lock_acquire_parse_args(args, kwds, &timeout) < 0) |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 310 | return NULL; |
Antoine Pitrou | 434736a | 2009-11-10 18:46:01 +0000 | [diff] [blame] | 311 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 312 | tid = PyThread_get_thread_ident(); |
| 313 | if (self->rlock_count > 0 && tid == self->rlock_owner) { |
| 314 | unsigned long count = self->rlock_count + 1; |
| 315 | if (count <= self->rlock_count) { |
| 316 | PyErr_SetString(PyExc_OverflowError, |
| 317 | "Internal lock count overflowed"); |
| 318 | return NULL; |
| 319 | } |
| 320 | self->rlock_count = count; |
| 321 | Py_RETURN_TRUE; |
| 322 | } |
Victor Stinner | f5faad2 | 2015-03-28 03:52:05 +0100 | [diff] [blame] | 323 | r = acquire_timed(self->rlock_lock, timeout); |
Antoine Pitrou | 810023d | 2010-12-15 22:59:16 +0000 | [diff] [blame] | 324 | if (r == PY_LOCK_ACQUIRED) { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 325 | assert(self->rlock_count == 0); |
| 326 | self->rlock_owner = tid; |
| 327 | self->rlock_count = 1; |
| 328 | } |
Antoine Pitrou | 810023d | 2010-12-15 22:59:16 +0000 | [diff] [blame] | 329 | else if (r == PY_LOCK_INTR) { |
| 330 | return NULL; |
| 331 | } |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 332 | |
Antoine Pitrou | 810023d | 2010-12-15 22:59:16 +0000 | [diff] [blame] | 333 | return PyBool_FromLong(r == PY_LOCK_ACQUIRED); |
Antoine Pitrou | 434736a | 2009-11-10 18:46:01 +0000 | [diff] [blame] | 334 | } |
| 335 | |
| 336 | PyDoc_STRVAR(rlock_acquire_doc, |
| 337 | "acquire(blocking=True) -> bool\n\ |
| 338 | \n\ |
| 339 | Lock the lock. `blocking` indicates whether we should wait\n\ |
| 340 | for the lock to be available or not. If `blocking` is False\n\ |
| 341 | and another thread holds the lock, the method will return False\n\ |
| 342 | immediately. If `blocking` is True and another thread holds\n\ |
| 343 | the lock, the method will wait for the lock to be released,\n\ |
| 344 | take it and then return True.\n\ |
Antoine Pitrou | 810023d | 2010-12-15 22:59:16 +0000 | [diff] [blame] | 345 | (note: the blocking operation is interruptible.)\n\ |
Antoine Pitrou | 434736a | 2009-11-10 18:46:01 +0000 | [diff] [blame] | 346 | \n\ |
| 347 | In all other cases, the method will return True immediately.\n\ |
| 348 | Precisely, if the current thread already holds the lock, its\n\ |
| 349 | internal counter is simply incremented. If nobody holds the lock,\n\ |
| 350 | the lock is taken and its internal counter initialized to 1."); |
| 351 | |
| 352 | static PyObject * |
Siddhesh Poyarekar | 55edd0c | 2018-04-30 00:29:33 +0530 | [diff] [blame] | 353 | rlock_release(rlockobject *self, PyObject *Py_UNUSED(ignored)) |
Antoine Pitrou | 434736a | 2009-11-10 18:46:01 +0000 | [diff] [blame] | 354 | { |
Serhiy Storchaka | aefa7eb | 2017-03-23 15:48:39 +0200 | [diff] [blame] | 355 | unsigned long tid = PyThread_get_thread_ident(); |
Antoine Pitrou | 434736a | 2009-11-10 18:46:01 +0000 | [diff] [blame] | 356 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 357 | if (self->rlock_count == 0 || self->rlock_owner != tid) { |
| 358 | PyErr_SetString(PyExc_RuntimeError, |
| 359 | "cannot release un-acquired lock"); |
| 360 | return NULL; |
| 361 | } |
| 362 | if (--self->rlock_count == 0) { |
| 363 | self->rlock_owner = 0; |
| 364 | PyThread_release_lock(self->rlock_lock); |
| 365 | } |
| 366 | Py_RETURN_NONE; |
Antoine Pitrou | 434736a | 2009-11-10 18:46:01 +0000 | [diff] [blame] | 367 | } |
| 368 | |
| 369 | PyDoc_STRVAR(rlock_release_doc, |
| 370 | "release()\n\ |
| 371 | \n\ |
| 372 | Release the lock, allowing another thread that is blocked waiting for\n\ |
| 373 | the lock to acquire the lock. The lock must be in the locked state,\n\ |
| 374 | and must be locked by the same thread that unlocks it; otherwise a\n\ |
| 375 | `RuntimeError` is raised.\n\ |
| 376 | \n\ |
| 377 | Do note that if the lock was acquire()d several times in a row by the\n\ |
| 378 | current thread, release() needs to be called as many times for the lock\n\ |
| 379 | to be available for other threads."); |
| 380 | |
| 381 | static PyObject * |
Victor Stinner | e879452 | 2014-01-02 12:47:24 +0100 | [diff] [blame] | 382 | rlock_acquire_restore(rlockobject *self, PyObject *args) |
Antoine Pitrou | 434736a | 2009-11-10 18:46:01 +0000 | [diff] [blame] | 383 | { |
Serhiy Storchaka | aefa7eb | 2017-03-23 15:48:39 +0200 | [diff] [blame] | 384 | unsigned long owner; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 385 | unsigned long count; |
| 386 | int r = 1; |
Antoine Pitrou | 434736a | 2009-11-10 18:46:01 +0000 | [diff] [blame] | 387 | |
Serhiy Storchaka | aefa7eb | 2017-03-23 15:48:39 +0200 | [diff] [blame] | 388 | if (!PyArg_ParseTuple(args, "(kk):_acquire_restore", &count, &owner)) |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 389 | return NULL; |
Antoine Pitrou | 434736a | 2009-11-10 18:46:01 +0000 | [diff] [blame] | 390 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 391 | if (!PyThread_acquire_lock(self->rlock_lock, 0)) { |
| 392 | Py_BEGIN_ALLOW_THREADS |
| 393 | r = PyThread_acquire_lock(self->rlock_lock, 1); |
| 394 | Py_END_ALLOW_THREADS |
| 395 | } |
| 396 | if (!r) { |
| 397 | PyErr_SetString(ThreadError, "couldn't acquire lock"); |
| 398 | return NULL; |
| 399 | } |
| 400 | assert(self->rlock_count == 0); |
| 401 | self->rlock_owner = owner; |
| 402 | self->rlock_count = count; |
| 403 | Py_RETURN_NONE; |
Antoine Pitrou | 434736a | 2009-11-10 18:46:01 +0000 | [diff] [blame] | 404 | } |
| 405 | |
| 406 | PyDoc_STRVAR(rlock_acquire_restore_doc, |
| 407 | "_acquire_restore(state) -> None\n\ |
| 408 | \n\ |
| 409 | For internal use by `threading.Condition`."); |
| 410 | |
| 411 | static PyObject * |
Siddhesh Poyarekar | 55edd0c | 2018-04-30 00:29:33 +0530 | [diff] [blame] | 412 | rlock_release_save(rlockobject *self, PyObject *Py_UNUSED(ignored)) |
Antoine Pitrou | 434736a | 2009-11-10 18:46:01 +0000 | [diff] [blame] | 413 | { |
Serhiy Storchaka | aefa7eb | 2017-03-23 15:48:39 +0200 | [diff] [blame] | 414 | unsigned long owner; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 415 | unsigned long count; |
Antoine Pitrou | 434736a | 2009-11-10 18:46:01 +0000 | [diff] [blame] | 416 | |
Victor Stinner | c2824d4 | 2011-04-24 23:41:33 +0200 | [diff] [blame] | 417 | if (self->rlock_count == 0) { |
| 418 | PyErr_SetString(PyExc_RuntimeError, |
| 419 | "cannot release un-acquired lock"); |
| 420 | return NULL; |
| 421 | } |
| 422 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 423 | owner = self->rlock_owner; |
| 424 | count = self->rlock_count; |
| 425 | self->rlock_count = 0; |
| 426 | self->rlock_owner = 0; |
| 427 | PyThread_release_lock(self->rlock_lock); |
Serhiy Storchaka | aefa7eb | 2017-03-23 15:48:39 +0200 | [diff] [blame] | 428 | return Py_BuildValue("kk", count, owner); |
Antoine Pitrou | 434736a | 2009-11-10 18:46:01 +0000 | [diff] [blame] | 429 | } |
| 430 | |
| 431 | PyDoc_STRVAR(rlock_release_save_doc, |
| 432 | "_release_save() -> tuple\n\ |
| 433 | \n\ |
| 434 | For internal use by `threading.Condition`."); |
| 435 | |
| 436 | |
| 437 | static PyObject * |
Siddhesh Poyarekar | 55edd0c | 2018-04-30 00:29:33 +0530 | [diff] [blame] | 438 | rlock_is_owned(rlockobject *self, PyObject *Py_UNUSED(ignored)) |
Antoine Pitrou | 434736a | 2009-11-10 18:46:01 +0000 | [diff] [blame] | 439 | { |
Serhiy Storchaka | aefa7eb | 2017-03-23 15:48:39 +0200 | [diff] [blame] | 440 | unsigned long tid = PyThread_get_thread_ident(); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 441 | |
| 442 | if (self->rlock_count > 0 && self->rlock_owner == tid) { |
| 443 | Py_RETURN_TRUE; |
| 444 | } |
| 445 | Py_RETURN_FALSE; |
Antoine Pitrou | 434736a | 2009-11-10 18:46:01 +0000 | [diff] [blame] | 446 | } |
| 447 | |
| 448 | PyDoc_STRVAR(rlock_is_owned_doc, |
| 449 | "_is_owned() -> bool\n\ |
| 450 | \n\ |
| 451 | For internal use by `threading.Condition`."); |
| 452 | |
| 453 | static PyObject * |
| 454 | rlock_new(PyTypeObject *type, PyObject *args, PyObject *kwds) |
| 455 | { |
Victor Stinner | 87255be | 2020-04-07 23:11:49 +0200 | [diff] [blame] | 456 | rlockobject *self = (rlockobject *) type->tp_alloc(type, 0); |
| 457 | if (self == NULL) { |
| 458 | return NULL; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 459 | } |
Victor Stinner | 87255be | 2020-04-07 23:11:49 +0200 | [diff] [blame] | 460 | self->in_weakreflist = NULL; |
| 461 | self->rlock_owner = 0; |
| 462 | self->rlock_count = 0; |
Antoine Pitrou | 434736a | 2009-11-10 18:46:01 +0000 | [diff] [blame] | 463 | |
Victor Stinner | 87255be | 2020-04-07 23:11:49 +0200 | [diff] [blame] | 464 | self->rlock_lock = PyThread_allocate_lock(); |
| 465 | if (self->rlock_lock == NULL) { |
| 466 | Py_DECREF(self); |
| 467 | PyErr_SetString(ThreadError, "can't allocate lock"); |
| 468 | return NULL; |
| 469 | } |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 470 | return (PyObject *) self; |
Antoine Pitrou | 434736a | 2009-11-10 18:46:01 +0000 | [diff] [blame] | 471 | } |
| 472 | |
| 473 | static PyObject * |
| 474 | rlock_repr(rlockobject *self) |
| 475 | { |
Raymond Hettinger | 62f4dad | 2014-05-25 18:22:35 -0700 | [diff] [blame] | 476 | return PyUnicode_FromFormat("<%s %s object owner=%ld count=%lu at %p>", |
| 477 | self->rlock_count ? "locked" : "unlocked", |
| 478 | Py_TYPE(self)->tp_name, self->rlock_owner, |
| 479 | self->rlock_count, self); |
Antoine Pitrou | 434736a | 2009-11-10 18:46:01 +0000 | [diff] [blame] | 480 | } |
| 481 | |
| 482 | |
Victor Stinner | 87255be | 2020-04-07 23:11:49 +0200 | [diff] [blame] | 483 | #ifdef HAVE_FORK |
| 484 | static PyObject * |
| 485 | rlock__at_fork_reinit(rlockobject *self, PyObject *Py_UNUSED(args)) |
| 486 | { |
| 487 | if (_PyThread_at_fork_reinit(&self->rlock_lock) < 0) { |
| 488 | PyErr_SetString(ThreadError, "failed to reinitialize lock at fork"); |
| 489 | return NULL; |
| 490 | } |
| 491 | |
| 492 | self->rlock_owner = 0; |
| 493 | self->rlock_count = 0; |
| 494 | |
| 495 | Py_RETURN_NONE; |
| 496 | } |
| 497 | #endif /* HAVE_FORK */ |
| 498 | |
| 499 | |
Antoine Pitrou | 434736a | 2009-11-10 18:46:01 +0000 | [diff] [blame] | 500 | static PyMethodDef rlock_methods[] = { |
Serhiy Storchaka | 62be742 | 2018-11-27 13:27:31 +0200 | [diff] [blame] | 501 | {"acquire", (PyCFunction)(void(*)(void))rlock_acquire, |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 502 | METH_VARARGS | METH_KEYWORDS, rlock_acquire_doc}, |
| 503 | {"release", (PyCFunction)rlock_release, |
| 504 | METH_NOARGS, rlock_release_doc}, |
| 505 | {"_is_owned", (PyCFunction)rlock_is_owned, |
| 506 | METH_NOARGS, rlock_is_owned_doc}, |
| 507 | {"_acquire_restore", (PyCFunction)rlock_acquire_restore, |
Victor Stinner | e879452 | 2014-01-02 12:47:24 +0100 | [diff] [blame] | 508 | METH_VARARGS, rlock_acquire_restore_doc}, |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 509 | {"_release_save", (PyCFunction)rlock_release_save, |
| 510 | METH_NOARGS, rlock_release_save_doc}, |
Serhiy Storchaka | 62be742 | 2018-11-27 13:27:31 +0200 | [diff] [blame] | 511 | {"__enter__", (PyCFunction)(void(*)(void))rlock_acquire, |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 512 | METH_VARARGS | METH_KEYWORDS, rlock_acquire_doc}, |
| 513 | {"__exit__", (PyCFunction)rlock_release, |
| 514 | METH_VARARGS, rlock_release_doc}, |
Victor Stinner | 87255be | 2020-04-07 23:11:49 +0200 | [diff] [blame] | 515 | #ifdef HAVE_FORK |
| 516 | {"_at_fork_reinit", (PyCFunction)rlock__at_fork_reinit, |
| 517 | METH_NOARGS, NULL}, |
| 518 | #endif |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 519 | {NULL, NULL} /* sentinel */ |
Antoine Pitrou | 434736a | 2009-11-10 18:46:01 +0000 | [diff] [blame] | 520 | }; |
| 521 | |
| 522 | |
| 523 | static PyTypeObject RLocktype = { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 524 | PyVarObject_HEAD_INIT(&PyType_Type, 0) |
Victor Stinner | 8203c73 | 2020-12-16 12:20:33 +0100 | [diff] [blame] | 525 | .tp_name = "_thread.RLock", |
| 526 | .tp_basicsize = sizeof(rlockobject), |
| 527 | .tp_dealloc = (destructor)rlock_dealloc, |
| 528 | .tp_repr = (reprfunc)rlock_repr, |
| 529 | .tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, |
| 530 | .tp_weaklistoffset = offsetof(rlockobject, in_weakreflist), |
| 531 | .tp_methods = rlock_methods, |
| 532 | .tp_alloc = PyType_GenericAlloc, |
| 533 | .tp_new = rlock_new, |
Antoine Pitrou | 434736a | 2009-11-10 18:46:01 +0000 | [diff] [blame] | 534 | }; |
| 535 | |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 536 | static lockobject * |
| 537 | newlockobject(void) |
| 538 | { |
Victor Stinner | 8203c73 | 2020-12-16 12:20:33 +0100 | [diff] [blame] | 539 | lockobject *self = PyObject_New(lockobject, &Locktype); |
| 540 | if (self == NULL) { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 541 | return NULL; |
Victor Stinner | 8203c73 | 2020-12-16 12:20:33 +0100 | [diff] [blame] | 542 | } |
| 543 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 544 | self->lock_lock = PyThread_allocate_lock(); |
Kristjan Valur Jonsson | 69cf913 | 2012-06-22 18:40:02 +0000 | [diff] [blame] | 545 | self->locked = 0; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 546 | self->in_weakreflist = NULL; |
Victor Stinner | 8203c73 | 2020-12-16 12:20:33 +0100 | [diff] [blame] | 547 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 548 | if (self->lock_lock == NULL) { |
| 549 | Py_DECREF(self); |
| 550 | PyErr_SetString(ThreadError, "can't allocate lock"); |
| 551 | return NULL; |
| 552 | } |
| 553 | return self; |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 554 | } |
| 555 | |
Jim Fulton | d15dc06 | 2004-07-14 19:11:50 +0000 | [diff] [blame] | 556 | /* Thread-local objects */ |
| 557 | |
Antoine Pitrou | 5af4f4b | 2010-08-09 22:38:19 +0000 | [diff] [blame] | 558 | /* Quick overview: |
| 559 | |
| 560 | We need to be able to reclaim reference cycles as soon as possible |
| 561 | (both when a thread is being terminated, or a thread-local object |
| 562 | becomes unreachable from user data). Constraints: |
| 563 | - it must not be possible for thread-state dicts to be involved in |
| 564 | reference cycles (otherwise the cyclic GC will refuse to consider |
| 565 | objects referenced from a reachable thread-state dict, even though |
| 566 | local_dealloc would clear them) |
| 567 | - the death of a thread-state dict must still imply destruction of the |
| 568 | corresponding local dicts in all thread-local objects. |
| 569 | |
| 570 | Our implementation uses small "localdummy" objects in order to break |
| 571 | the reference chain. These trivial objects are hashable (using the |
| 572 | default scheme of identity hashing) and weakrefable. |
| 573 | Each thread-state holds a separate localdummy for each local object |
| 574 | (as a /strong reference/), |
| 575 | and each thread-local object holds a dict mapping /weak references/ |
| 576 | of localdummies to local dicts. |
| 577 | |
| 578 | Therefore: |
| 579 | - only the thread-state dict holds a strong reference to the dummies |
| 580 | - only the thread-local object holds a strong reference to the local dicts |
| 581 | - only outside objects (application- or library-level) hold strong |
| 582 | references to the thread-local objects |
| 583 | - as soon as a thread-state dict is destroyed, the weakref callbacks of all |
| 584 | dummies attached to that thread are called, and destroy the corresponding |
| 585 | local dicts from thread-local objects |
| 586 | - as soon as a thread-local object is destroyed, its local dicts are |
| 587 | destroyed and its dummies are manually removed from all thread states |
| 588 | - the GC can do its work correctly when a thread-local object is dangling, |
| 589 | without any interference from the thread-state dicts |
| 590 | |
| 591 | As an additional optimization, each localdummy holds a borrowed reference |
| 592 | to the corresponding localdict. This borrowed reference is only used |
| 593 | by the thread-local object which has created the localdummy, which should |
| 594 | guarantee that the localdict still exists when accessed. |
| 595 | */ |
| 596 | |
| 597 | typedef struct { |
| 598 | PyObject_HEAD |
| 599 | PyObject *localdict; /* Borrowed reference! */ |
| 600 | PyObject *weakreflist; /* List of weak references to self */ |
| 601 | } localdummyobject; |
| 602 | |
| 603 | static void |
| 604 | localdummy_dealloc(localdummyobject *self) |
| 605 | { |
| 606 | if (self->weakreflist != NULL) |
| 607 | PyObject_ClearWeakRefs((PyObject *) self); |
| 608 | Py_TYPE(self)->tp_free((PyObject*)self); |
| 609 | } |
| 610 | |
| 611 | static PyTypeObject localdummytype = { |
| 612 | PyVarObject_HEAD_INIT(NULL, 0) |
Victor Stinner | 8203c73 | 2020-12-16 12:20:33 +0100 | [diff] [blame] | 613 | .tp_name = "_thread._localdummy", |
| 614 | .tp_basicsize = sizeof(localdummyobject), |
| 615 | .tp_dealloc = (destructor)localdummy_dealloc, |
| 616 | .tp_flags = Py_TPFLAGS_DEFAULT, |
| 617 | .tp_doc = "Thread-local dummy", |
| 618 | .tp_weaklistoffset = offsetof(localdummyobject, weakreflist), |
Antoine Pitrou | 5af4f4b | 2010-08-09 22:38:19 +0000 | [diff] [blame] | 619 | }; |
| 620 | |
| 621 | |
Jim Fulton | d15dc06 | 2004-07-14 19:11:50 +0000 | [diff] [blame] | 622 | typedef struct { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 623 | PyObject_HEAD |
| 624 | PyObject *key; |
| 625 | PyObject *args; |
| 626 | PyObject *kw; |
Antoine Pitrou | 5af4f4b | 2010-08-09 22:38:19 +0000 | [diff] [blame] | 627 | PyObject *weakreflist; /* List of weak references to self */ |
| 628 | /* A {localdummy weakref -> localdict} dict */ |
| 629 | PyObject *dummies; |
| 630 | /* The callback for weakrefs to localdummies */ |
| 631 | PyObject *wr_callback; |
Jim Fulton | d15dc06 | 2004-07-14 19:11:50 +0000 | [diff] [blame] | 632 | } localobject; |
| 633 | |
Antoine Pitrou | 5af4f4b | 2010-08-09 22:38:19 +0000 | [diff] [blame] | 634 | /* Forward declaration */ |
| 635 | static PyObject *_ldict(localobject *self); |
| 636 | static PyObject *_localdummy_destroyed(PyObject *meth_self, PyObject *dummyweakref); |
| 637 | |
Antoine Pitrou | 1a9a9d5 | 2010-08-28 18:17:03 +0000 | [diff] [blame] | 638 | /* Create and register the dummy for the current thread. |
| 639 | Returns a borrowed reference of the corresponding local dict */ |
| 640 | static PyObject * |
Antoine Pitrou | 5af4f4b | 2010-08-09 22:38:19 +0000 | [diff] [blame] | 641 | _local_create_dummy(localobject *self) |
| 642 | { |
Victor Stinner | 8203c73 | 2020-12-16 12:20:33 +0100 | [diff] [blame] | 643 | PyObject *ldict = NULL, *wr = NULL; |
Antoine Pitrou | 5af4f4b | 2010-08-09 22:38:19 +0000 | [diff] [blame] | 644 | localdummyobject *dummy = NULL; |
Antoine Pitrou | 5af4f4b | 2010-08-09 22:38:19 +0000 | [diff] [blame] | 645 | |
Victor Stinner | 8203c73 | 2020-12-16 12:20:33 +0100 | [diff] [blame] | 646 | PyObject *tdict = PyThreadState_GetDict(); |
Antoine Pitrou | 5af4f4b | 2010-08-09 22:38:19 +0000 | [diff] [blame] | 647 | if (tdict == NULL) { |
| 648 | PyErr_SetString(PyExc_SystemError, |
| 649 | "Couldn't get thread-state dictionary"); |
| 650 | goto err; |
| 651 | } |
| 652 | |
| 653 | ldict = PyDict_New(); |
Victor Stinner | 8203c73 | 2020-12-16 12:20:33 +0100 | [diff] [blame] | 654 | if (ldict == NULL) { |
Antoine Pitrou | 5af4f4b | 2010-08-09 22:38:19 +0000 | [diff] [blame] | 655 | goto err; |
Victor Stinner | 8203c73 | 2020-12-16 12:20:33 +0100 | [diff] [blame] | 656 | } |
Antoine Pitrou | 5af4f4b | 2010-08-09 22:38:19 +0000 | [diff] [blame] | 657 | dummy = (localdummyobject *) localdummytype.tp_alloc(&localdummytype, 0); |
Victor Stinner | 8203c73 | 2020-12-16 12:20:33 +0100 | [diff] [blame] | 658 | if (dummy == NULL) { |
Antoine Pitrou | 5af4f4b | 2010-08-09 22:38:19 +0000 | [diff] [blame] | 659 | goto err; |
Victor Stinner | 8203c73 | 2020-12-16 12:20:33 +0100 | [diff] [blame] | 660 | } |
Antoine Pitrou | 5af4f4b | 2010-08-09 22:38:19 +0000 | [diff] [blame] | 661 | dummy->localdict = ldict; |
| 662 | wr = PyWeakref_NewRef((PyObject *) dummy, self->wr_callback); |
Victor Stinner | 8203c73 | 2020-12-16 12:20:33 +0100 | [diff] [blame] | 663 | if (wr == NULL) { |
Antoine Pitrou | 5af4f4b | 2010-08-09 22:38:19 +0000 | [diff] [blame] | 664 | goto err; |
Victor Stinner | 8203c73 | 2020-12-16 12:20:33 +0100 | [diff] [blame] | 665 | } |
Antoine Pitrou | 5af4f4b | 2010-08-09 22:38:19 +0000 | [diff] [blame] | 666 | |
| 667 | /* As a side-effect, this will cache the weakref's hash before the |
| 668 | dummy gets deleted */ |
Victor Stinner | 8203c73 | 2020-12-16 12:20:33 +0100 | [diff] [blame] | 669 | int r = PyDict_SetItem(self->dummies, wr, ldict); |
| 670 | if (r < 0) { |
Antoine Pitrou | 5af4f4b | 2010-08-09 22:38:19 +0000 | [diff] [blame] | 671 | goto err; |
Victor Stinner | 8203c73 | 2020-12-16 12:20:33 +0100 | [diff] [blame] | 672 | } |
Antoine Pitrou | 5af4f4b | 2010-08-09 22:38:19 +0000 | [diff] [blame] | 673 | Py_CLEAR(wr); |
| 674 | r = PyDict_SetItem(tdict, self->key, (PyObject *) dummy); |
Victor Stinner | 8203c73 | 2020-12-16 12:20:33 +0100 | [diff] [blame] | 675 | if (r < 0) { |
Antoine Pitrou | 5af4f4b | 2010-08-09 22:38:19 +0000 | [diff] [blame] | 676 | goto err; |
Victor Stinner | 8203c73 | 2020-12-16 12:20:33 +0100 | [diff] [blame] | 677 | } |
Antoine Pitrou | 5af4f4b | 2010-08-09 22:38:19 +0000 | [diff] [blame] | 678 | Py_CLEAR(dummy); |
| 679 | |
Antoine Pitrou | 1a9a9d5 | 2010-08-28 18:17:03 +0000 | [diff] [blame] | 680 | Py_DECREF(ldict); |
| 681 | return ldict; |
Antoine Pitrou | 5af4f4b | 2010-08-09 22:38:19 +0000 | [diff] [blame] | 682 | |
| 683 | err: |
| 684 | Py_XDECREF(ldict); |
| 685 | Py_XDECREF(wr); |
| 686 | Py_XDECREF(dummy); |
Antoine Pitrou | 1a9a9d5 | 2010-08-28 18:17:03 +0000 | [diff] [blame] | 687 | return NULL; |
Antoine Pitrou | 5af4f4b | 2010-08-09 22:38:19 +0000 | [diff] [blame] | 688 | } |
| 689 | |
Jim Fulton | d15dc06 | 2004-07-14 19:11:50 +0000 | [diff] [blame] | 690 | static PyObject * |
| 691 | local_new(PyTypeObject *type, PyObject *args, PyObject *kw) |
| 692 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 693 | localobject *self; |
Antoine Pitrou | 5af4f4b | 2010-08-09 22:38:19 +0000 | [diff] [blame] | 694 | static PyMethodDef wr_callback_def = { |
| 695 | "_localdummy_destroyed", (PyCFunction) _localdummy_destroyed, METH_O |
| 696 | }; |
Jim Fulton | d15dc06 | 2004-07-14 19:11:50 +0000 | [diff] [blame] | 697 | |
Serhiy Storchaka | fa494fd | 2015-05-30 17:45:22 +0300 | [diff] [blame] | 698 | if (type->tp_init == PyBaseObject_Type.tp_init) { |
| 699 | int rc = 0; |
| 700 | if (args != NULL) |
| 701 | rc = PyObject_IsTrue(args); |
| 702 | if (rc == 0 && kw != NULL) |
| 703 | rc = PyObject_IsTrue(kw); |
| 704 | if (rc != 0) { |
Victor Stinner | 8203c73 | 2020-12-16 12:20:33 +0100 | [diff] [blame] | 705 | if (rc > 0) { |
Serhiy Storchaka | fa494fd | 2015-05-30 17:45:22 +0300 | [diff] [blame] | 706 | PyErr_SetString(PyExc_TypeError, |
| 707 | "Initialization arguments are not supported"); |
Victor Stinner | 8203c73 | 2020-12-16 12:20:33 +0100 | [diff] [blame] | 708 | } |
Serhiy Storchaka | fa494fd | 2015-05-30 17:45:22 +0300 | [diff] [blame] | 709 | return NULL; |
| 710 | } |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 711 | } |
Jim Fulton | d15dc06 | 2004-07-14 19:11:50 +0000 | [diff] [blame] | 712 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 713 | self = (localobject *)type->tp_alloc(type, 0); |
Victor Stinner | 8203c73 | 2020-12-16 12:20:33 +0100 | [diff] [blame] | 714 | if (self == NULL) { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 715 | return NULL; |
Victor Stinner | 8203c73 | 2020-12-16 12:20:33 +0100 | [diff] [blame] | 716 | } |
Jim Fulton | d15dc06 | 2004-07-14 19:11:50 +0000 | [diff] [blame] | 717 | |
Victor Stinner | 8203c73 | 2020-12-16 12:20:33 +0100 | [diff] [blame] | 718 | self->args = Py_XNewRef(args); |
| 719 | self->kw = Py_XNewRef(kw); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 720 | self->key = PyUnicode_FromFormat("thread.local.%p", self); |
Victor Stinner | 8203c73 | 2020-12-16 12:20:33 +0100 | [diff] [blame] | 721 | if (self->key == NULL) { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 722 | goto err; |
Victor Stinner | 8203c73 | 2020-12-16 12:20:33 +0100 | [diff] [blame] | 723 | } |
Jim Fulton | d15dc06 | 2004-07-14 19:11:50 +0000 | [diff] [blame] | 724 | |
Antoine Pitrou | 5af4f4b | 2010-08-09 22:38:19 +0000 | [diff] [blame] | 725 | self->dummies = PyDict_New(); |
Victor Stinner | 8203c73 | 2020-12-16 12:20:33 +0100 | [diff] [blame] | 726 | if (self->dummies == NULL) { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 727 | goto err; |
Victor Stinner | 8203c73 | 2020-12-16 12:20:33 +0100 | [diff] [blame] | 728 | } |
Jim Fulton | d15dc06 | 2004-07-14 19:11:50 +0000 | [diff] [blame] | 729 | |
Antoine Pitrou | 5af4f4b | 2010-08-09 22:38:19 +0000 | [diff] [blame] | 730 | /* We use a weak reference to self in the callback closure |
| 731 | in order to avoid spurious reference cycles */ |
Victor Stinner | 8203c73 | 2020-12-16 12:20:33 +0100 | [diff] [blame] | 732 | PyObject *wr = PyWeakref_NewRef((PyObject *) self, NULL); |
| 733 | if (wr == NULL) { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 734 | goto err; |
Victor Stinner | 8203c73 | 2020-12-16 12:20:33 +0100 | [diff] [blame] | 735 | } |
Andrew Svetlov | 3ba3a3e | 2012-12-25 13:32:35 +0200 | [diff] [blame] | 736 | self->wr_callback = PyCFunction_NewEx(&wr_callback_def, wr, NULL); |
Antoine Pitrou | 5af4f4b | 2010-08-09 22:38:19 +0000 | [diff] [blame] | 737 | Py_DECREF(wr); |
Victor Stinner | 8203c73 | 2020-12-16 12:20:33 +0100 | [diff] [blame] | 738 | if (self->wr_callback == NULL) { |
Antoine Pitrou | 5af4f4b | 2010-08-09 22:38:19 +0000 | [diff] [blame] | 739 | goto err; |
Victor Stinner | 8203c73 | 2020-12-16 12:20:33 +0100 | [diff] [blame] | 740 | } |
| 741 | if (_local_create_dummy(self) == NULL) { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 742 | goto err; |
Victor Stinner | 8203c73 | 2020-12-16 12:20:33 +0100 | [diff] [blame] | 743 | } |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 744 | return (PyObject *)self; |
Michael W. Hudson | 2368b3c | 2005-06-15 12:48:40 +0000 | [diff] [blame] | 745 | |
| 746 | err: |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 747 | Py_DECREF(self); |
| 748 | return NULL; |
Jim Fulton | d15dc06 | 2004-07-14 19:11:50 +0000 | [diff] [blame] | 749 | } |
| 750 | |
| 751 | static int |
| 752 | local_traverse(localobject *self, visitproc visit, void *arg) |
| 753 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 754 | Py_VISIT(self->args); |
| 755 | Py_VISIT(self->kw); |
Antoine Pitrou | 5af4f4b | 2010-08-09 22:38:19 +0000 | [diff] [blame] | 756 | Py_VISIT(self->dummies); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 757 | return 0; |
Jim Fulton | d15dc06 | 2004-07-14 19:11:50 +0000 | [diff] [blame] | 758 | } |
| 759 | |
| 760 | static int |
| 761 | local_clear(localobject *self) |
| 762 | { |
Antoine Pitrou | 5af4f4b | 2010-08-09 22:38:19 +0000 | [diff] [blame] | 763 | PyThreadState *tstate; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 764 | Py_CLEAR(self->args); |
| 765 | Py_CLEAR(self->kw); |
Antoine Pitrou | 5af4f4b | 2010-08-09 22:38:19 +0000 | [diff] [blame] | 766 | Py_CLEAR(self->dummies); |
Antoine Pitrou | 5af4f4b | 2010-08-09 22:38:19 +0000 | [diff] [blame] | 767 | Py_CLEAR(self->wr_callback); |
| 768 | /* Remove all strong references to dummies from the thread states */ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 769 | if (self->key |
| 770 | && (tstate = PyThreadState_Get()) |
| 771 | && tstate->interp) { |
| 772 | for(tstate = PyInterpreterState_ThreadHead(tstate->interp); |
| 773 | tstate; |
| 774 | tstate = PyThreadState_Next(tstate)) |
Serhiy Storchaka | fb5db7e | 2020-10-26 08:43:39 +0200 | [diff] [blame] | 775 | if (tstate->dict) { |
| 776 | PyObject *v = _PyDict_Pop(tstate->dict, self->key, Py_None); |
| 777 | if (v == NULL) { |
Serhiy Storchaka | 8905fcc | 2018-12-11 08:38:03 +0200 | [diff] [blame] | 778 | PyErr_Clear(); |
| 779 | } |
Serhiy Storchaka | fb5db7e | 2020-10-26 08:43:39 +0200 | [diff] [blame] | 780 | else { |
| 781 | Py_DECREF(v); |
| 782 | } |
Serhiy Storchaka | 8905fcc | 2018-12-11 08:38:03 +0200 | [diff] [blame] | 783 | } |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 784 | } |
Antoine Pitrou | 5af4f4b | 2010-08-09 22:38:19 +0000 | [diff] [blame] | 785 | return 0; |
| 786 | } |
Jim Fulton | d15dc06 | 2004-07-14 19:11:50 +0000 | [diff] [blame] | 787 | |
Antoine Pitrou | 5af4f4b | 2010-08-09 22:38:19 +0000 | [diff] [blame] | 788 | static void |
| 789 | local_dealloc(localobject *self) |
| 790 | { |
| 791 | /* Weakrefs must be invalidated right now, otherwise they can be used |
| 792 | from code called below, which is very dangerous since Py_REFCNT(self) == 0 */ |
Victor Stinner | 8203c73 | 2020-12-16 12:20:33 +0100 | [diff] [blame] | 793 | if (self->weakreflist != NULL) { |
Antoine Pitrou | 5af4f4b | 2010-08-09 22:38:19 +0000 | [diff] [blame] | 794 | PyObject_ClearWeakRefs((PyObject *) self); |
Victor Stinner | 8203c73 | 2020-12-16 12:20:33 +0100 | [diff] [blame] | 795 | } |
Antoine Pitrou | 5af4f4b | 2010-08-09 22:38:19 +0000 | [diff] [blame] | 796 | |
| 797 | PyObject_GC_UnTrack(self); |
| 798 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 799 | local_clear(self); |
Antoine Pitrou | 5af4f4b | 2010-08-09 22:38:19 +0000 | [diff] [blame] | 800 | Py_XDECREF(self->key); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 801 | Py_TYPE(self)->tp_free((PyObject*)self); |
Jim Fulton | d15dc06 | 2004-07-14 19:11:50 +0000 | [diff] [blame] | 802 | } |
| 803 | |
Antoine Pitrou | 5af4f4b | 2010-08-09 22:38:19 +0000 | [diff] [blame] | 804 | /* Returns a borrowed reference to the local dict, creating it if necessary */ |
Jim Fulton | d15dc06 | 2004-07-14 19:11:50 +0000 | [diff] [blame] | 805 | static PyObject * |
| 806 | _ldict(localobject *self) |
| 807 | { |
Victor Stinner | 8203c73 | 2020-12-16 12:20:33 +0100 | [diff] [blame] | 808 | PyObject *tdict = PyThreadState_GetDict(); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 809 | if (tdict == NULL) { |
| 810 | PyErr_SetString(PyExc_SystemError, |
| 811 | "Couldn't get thread-state dictionary"); |
| 812 | return NULL; |
| 813 | } |
Jim Fulton | d15dc06 | 2004-07-14 19:11:50 +0000 | [diff] [blame] | 814 | |
Victor Stinner | 8203c73 | 2020-12-16 12:20:33 +0100 | [diff] [blame] | 815 | PyObject *ldict; |
| 816 | PyObject *dummy = PyDict_GetItemWithError(tdict, self->key); |
Antoine Pitrou | 5af4f4b | 2010-08-09 22:38:19 +0000 | [diff] [blame] | 817 | if (dummy == NULL) { |
Serhiy Storchaka | a24107b | 2019-02-25 17:59:46 +0200 | [diff] [blame] | 818 | if (PyErr_Occurred()) { |
| 819 | return NULL; |
| 820 | } |
Antoine Pitrou | 1a9a9d5 | 2010-08-28 18:17:03 +0000 | [diff] [blame] | 821 | ldict = _local_create_dummy(self); |
| 822 | if (ldict == NULL) |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 823 | return NULL; |
Jim Fulton | d15dc06 | 2004-07-14 19:11:50 +0000 | [diff] [blame] | 824 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 825 | if (Py_TYPE(self)->tp_init != PyBaseObject_Type.tp_init && |
| 826 | Py_TYPE(self)->tp_init((PyObject*)self, |
| 827 | self->args, self->kw) < 0) { |
| 828 | /* we need to get rid of ldict from thread so |
| 829 | we create a new one the next time we do an attr |
Ezio Melotti | 42da663 | 2011-03-15 05:18:48 +0200 | [diff] [blame] | 830 | access */ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 831 | PyDict_DelItem(tdict, self->key); |
| 832 | return NULL; |
| 833 | } |
Antoine Pitrou | 5af4f4b | 2010-08-09 22:38:19 +0000 | [diff] [blame] | 834 | } |
| 835 | else { |
Andy Lester | dffe4c0 | 2020-03-04 07:15:20 -0600 | [diff] [blame] | 836 | assert(Py_IS_TYPE(dummy, &localdummytype)); |
Antoine Pitrou | 5af4f4b | 2010-08-09 22:38:19 +0000 | [diff] [blame] | 837 | ldict = ((localdummyobject *) dummy)->localdict; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 838 | } |
Jim Fulton | d15dc06 | 2004-07-14 19:11:50 +0000 | [diff] [blame] | 839 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 840 | return ldict; |
Jim Fulton | d15dc06 | 2004-07-14 19:11:50 +0000 | [diff] [blame] | 841 | } |
| 842 | |
Jim Fulton | d15dc06 | 2004-07-14 19:11:50 +0000 | [diff] [blame] | 843 | static int |
| 844 | local_setattro(localobject *self, PyObject *name, PyObject *v) |
| 845 | { |
Victor Stinner | 8203c73 | 2020-12-16 12:20:33 +0100 | [diff] [blame] | 846 | PyObject *ldict = _ldict(self); |
| 847 | if (ldict == NULL) { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 848 | return -1; |
Victor Stinner | 8203c73 | 2020-12-16 12:20:33 +0100 | [diff] [blame] | 849 | } |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 850 | |
Victor Stinner | 8203c73 | 2020-12-16 12:20:33 +0100 | [diff] [blame] | 851 | PyObject *str_dict = _PyUnicode_FromId(&PyId___dict__); // borrowed ref |
| 852 | if (str_dict == NULL) { |
| 853 | return -1; |
| 854 | } |
| 855 | |
| 856 | int r = PyObject_RichCompareBool(name, str_dict, Py_EQ); |
| 857 | if (r == -1) { |
| 858 | return -1; |
| 859 | } |
Antoine Pitrou | 1a9a9d5 | 2010-08-28 18:17:03 +0000 | [diff] [blame] | 860 | if (r == 1) { |
| 861 | PyErr_Format(PyExc_AttributeError, |
| 862 | "'%.50s' object attribute '%U' is read-only", |
| 863 | Py_TYPE(self)->tp_name, name); |
| 864 | return -1; |
| 865 | } |
Jim Fulton | d15dc06 | 2004-07-14 19:11:50 +0000 | [diff] [blame] | 866 | |
Antoine Pitrou | 1a9a9d5 | 2010-08-28 18:17:03 +0000 | [diff] [blame] | 867 | return _PyObject_GenericSetAttrWithDict((PyObject *)self, name, v, ldict); |
Jim Fulton | d15dc06 | 2004-07-14 19:11:50 +0000 | [diff] [blame] | 868 | } |
| 869 | |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 870 | static PyObject *local_getattro(localobject *, PyObject *); |
| 871 | |
Jim Fulton | d15dc06 | 2004-07-14 19:11:50 +0000 | [diff] [blame] | 872 | static PyTypeObject localtype = { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 873 | PyVarObject_HEAD_INIT(NULL, 0) |
Victor Stinner | 8203c73 | 2020-12-16 12:20:33 +0100 | [diff] [blame] | 874 | .tp_name = "_thread._local", |
| 875 | .tp_basicsize = sizeof(localobject), |
| 876 | .tp_dealloc = (destructor)local_dealloc, |
| 877 | .tp_getattro = (getattrofunc)local_getattro, |
| 878 | .tp_setattro = (setattrofunc)local_setattro, |
| 879 | .tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE | Py_TPFLAGS_HAVE_GC, |
| 880 | .tp_doc = "Thread-local data", |
| 881 | .tp_traverse = (traverseproc)local_traverse, |
| 882 | .tp_clear = (inquiry)local_clear, |
| 883 | .tp_weaklistoffset = offsetof(localobject, weakreflist), |
| 884 | .tp_new = local_new, |
Jim Fulton | d15dc06 | 2004-07-14 19:11:50 +0000 | [diff] [blame] | 885 | }; |
| 886 | |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 887 | static PyObject * |
| 888 | local_getattro(localobject *self, PyObject *name) |
| 889 | { |
Victor Stinner | 8203c73 | 2020-12-16 12:20:33 +0100 | [diff] [blame] | 890 | PyObject *ldict = _ldict(self); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 891 | if (ldict == NULL) |
| 892 | return NULL; |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 893 | |
Victor Stinner | 8203c73 | 2020-12-16 12:20:33 +0100 | [diff] [blame] | 894 | PyObject *str_dict = _PyUnicode_FromId(&PyId___dict__); // borrowed ref |
| 895 | if (str_dict == NULL) { |
Antoine Pitrou | 1a9a9d5 | 2010-08-28 18:17:03 +0000 | [diff] [blame] | 896 | return NULL; |
Victor Stinner | 8203c73 | 2020-12-16 12:20:33 +0100 | [diff] [blame] | 897 | } |
Antoine Pitrou | 1a9a9d5 | 2010-08-28 18:17:03 +0000 | [diff] [blame] | 898 | |
Victor Stinner | 8203c73 | 2020-12-16 12:20:33 +0100 | [diff] [blame] | 899 | int r = PyObject_RichCompareBool(name, str_dict, Py_EQ); |
| 900 | if (r == 1) { |
| 901 | return Py_NewRef(ldict); |
| 902 | } |
| 903 | if (r == -1) { |
| 904 | return NULL; |
| 905 | } |
| 906 | |
| 907 | if (!Py_IS_TYPE(self, &localtype)) { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 908 | /* use generic lookup for subtypes */ |
Victor Stinner | 8203c73 | 2020-12-16 12:20:33 +0100 | [diff] [blame] | 909 | return _PyObject_GenericGetAttrWithDict((PyObject *)self, name, |
| 910 | ldict, 0); |
| 911 | } |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 912 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 913 | /* Optimization: just look in dict ourselves */ |
Victor Stinner | 8203c73 | 2020-12-16 12:20:33 +0100 | [diff] [blame] | 914 | PyObject *value = PyDict_GetItemWithError(ldict, name); |
Serhiy Storchaka | a24107b | 2019-02-25 17:59:46 +0200 | [diff] [blame] | 915 | if (value != NULL) { |
Victor Stinner | 8203c73 | 2020-12-16 12:20:33 +0100 | [diff] [blame] | 916 | return Py_NewRef(value); |
Serhiy Storchaka | a24107b | 2019-02-25 17:59:46 +0200 | [diff] [blame] | 917 | } |
Victor Stinner | 8203c73 | 2020-12-16 12:20:33 +0100 | [diff] [blame] | 918 | if (PyErr_Occurred()) { |
Serhiy Storchaka | a24107b | 2019-02-25 17:59:46 +0200 | [diff] [blame] | 919 | return NULL; |
| 920 | } |
Victor Stinner | 8203c73 | 2020-12-16 12:20:33 +0100 | [diff] [blame] | 921 | |
Serhiy Storchaka | a24107b | 2019-02-25 17:59:46 +0200 | [diff] [blame] | 922 | /* Fall back on generic to get __class__ and __dict__ */ |
| 923 | return _PyObject_GenericGetAttrWithDict( |
| 924 | (PyObject *)self, name, ldict, 0); |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 925 | } |
Guido van Rossum | 1984f1e | 1992-08-04 12:41:02 +0000 | [diff] [blame] | 926 | |
Antoine Pitrou | 5af4f4b | 2010-08-09 22:38:19 +0000 | [diff] [blame] | 927 | /* Called when a dummy is destroyed. */ |
| 928 | static PyObject * |
| 929 | _localdummy_destroyed(PyObject *localweakref, PyObject *dummyweakref) |
| 930 | { |
Antoine Pitrou | 5af4f4b | 2010-08-09 22:38:19 +0000 | [diff] [blame] | 931 | assert(PyWeakref_CheckRef(localweakref)); |
Victor Stinner | 8203c73 | 2020-12-16 12:20:33 +0100 | [diff] [blame] | 932 | PyObject *obj = PyWeakref_GET_OBJECT(localweakref); |
| 933 | if (obj == Py_None) { |
Antoine Pitrou | 5af4f4b | 2010-08-09 22:38:19 +0000 | [diff] [blame] | 934 | Py_RETURN_NONE; |
Victor Stinner | 8203c73 | 2020-12-16 12:20:33 +0100 | [diff] [blame] | 935 | } |
| 936 | |
Antoine Pitrou | 5af4f4b | 2010-08-09 22:38:19 +0000 | [diff] [blame] | 937 | /* If the thread-local object is still alive and not being cleared, |
| 938 | remove the corresponding local dict */ |
Victor Stinner | 8203c73 | 2020-12-16 12:20:33 +0100 | [diff] [blame] | 939 | localobject *self = (localobject *)Py_NewRef(obj); |
Antoine Pitrou | 5af4f4b | 2010-08-09 22:38:19 +0000 | [diff] [blame] | 940 | if (self->dummies != NULL) { |
| 941 | PyObject *ldict; |
Serhiy Storchaka | a24107b | 2019-02-25 17:59:46 +0200 | [diff] [blame] | 942 | ldict = PyDict_GetItemWithError(self->dummies, dummyweakref); |
Antoine Pitrou | 5af4f4b | 2010-08-09 22:38:19 +0000 | [diff] [blame] | 943 | if (ldict != NULL) { |
Antoine Pitrou | 5af4f4b | 2010-08-09 22:38:19 +0000 | [diff] [blame] | 944 | PyDict_DelItem(self->dummies, dummyweakref); |
| 945 | } |
| 946 | if (PyErr_Occurred()) |
| 947 | PyErr_WriteUnraisable(obj); |
| 948 | } |
| 949 | Py_DECREF(obj); |
| 950 | Py_RETURN_NONE; |
| 951 | } |
| 952 | |
Guido van Rossum | 1984f1e | 1992-08-04 12:41:02 +0000 | [diff] [blame] | 953 | /* Module functions */ |
| 954 | |
Guido van Rossum | a027efa | 1997-05-05 20:56:21 +0000 | [diff] [blame] | 955 | struct bootstate { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 956 | PyInterpreterState *interp; |
| 957 | PyObject *func; |
| 958 | PyObject *args; |
Victor Stinner | 8203c73 | 2020-12-16 12:20:33 +0100 | [diff] [blame] | 959 | PyObject *kwargs; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 960 | PyThreadState *tstate; |
Joannah Nanjekye | 2bc43cd | 2019-09-05 13:06:49 -0300 | [diff] [blame] | 961 | _PyRuntimeState *runtime; |
Guido van Rossum | a027efa | 1997-05-05 20:56:21 +0000 | [diff] [blame] | 962 | }; |
| 963 | |
Victor Stinner | 8203c73 | 2020-12-16 12:20:33 +0100 | [diff] [blame] | 964 | |
Guido van Rossum | 1984f1e | 1992-08-04 12:41:02 +0000 | [diff] [blame] | 965 | static void |
Victor Stinner | 8203c73 | 2020-12-16 12:20:33 +0100 | [diff] [blame] | 966 | thread_bootstate_free(struct bootstate *boot) |
| 967 | { |
| 968 | Py_DECREF(boot->func); |
| 969 | Py_DECREF(boot->args); |
| 970 | Py_XDECREF(boot->kwargs); |
| 971 | PyMem_Free(boot); |
| 972 | } |
| 973 | |
| 974 | |
| 975 | static void |
| 976 | thread_run(void *boot_raw) |
Guido van Rossum | 1984f1e | 1992-08-04 12:41:02 +0000 | [diff] [blame] | 977 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 978 | struct bootstate *boot = (struct bootstate *) boot_raw; |
| 979 | PyThreadState *tstate; |
Guido van Rossum | 1984f1e | 1992-08-04 12:41:02 +0000 | [diff] [blame] | 980 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 981 | tstate = boot->tstate; |
| 982 | tstate->thread_id = PyThread_get_thread_ident(); |
Victor Stinner | 01b1cc1 | 2019-11-20 02:27:56 +0100 | [diff] [blame] | 983 | _PyThreadState_Init(tstate); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 984 | PyEval_AcquireThread(tstate); |
Eric Snow | 2ebc5ce | 2017-09-07 23:51:28 -0600 | [diff] [blame] | 985 | tstate->interp->num_threads++; |
Victor Stinner | 8203c73 | 2020-12-16 12:20:33 +0100 | [diff] [blame] | 986 | |
| 987 | PyObject *res = PyObject_Call(boot->func, boot->args, boot->kwargs); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 988 | if (res == NULL) { |
| 989 | if (PyErr_ExceptionMatches(PyExc_SystemExit)) |
Victor Stinner | 8b09500 | 2019-05-29 02:57:56 +0200 | [diff] [blame] | 990 | /* SystemExit is ignored silently */ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 991 | PyErr_Clear(); |
| 992 | else { |
Victor Stinner | 8b09500 | 2019-05-29 02:57:56 +0200 | [diff] [blame] | 993 | _PyErr_WriteUnraisableMsg("in thread started by", boot->func); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 994 | } |
| 995 | } |
Victor Stinner | 8b09500 | 2019-05-29 02:57:56 +0200 | [diff] [blame] | 996 | else { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 997 | Py_DECREF(res); |
Victor Stinner | 8b09500 | 2019-05-29 02:57:56 +0200 | [diff] [blame] | 998 | } |
Victor Stinner | 8203c73 | 2020-12-16 12:20:33 +0100 | [diff] [blame] | 999 | |
| 1000 | thread_bootstate_free(boot); |
Eric Snow | 2ebc5ce | 2017-09-07 23:51:28 -0600 | [diff] [blame] | 1001 | tstate->interp->num_threads--; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1002 | PyThreadState_Clear(tstate); |
Victor Stinner | 23ef89d | 2020-03-18 02:26:04 +0100 | [diff] [blame] | 1003 | _PyThreadState_DeleteCurrent(tstate); |
Victor Stinner | 8203c73 | 2020-12-16 12:20:33 +0100 | [diff] [blame] | 1004 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1005 | PyThread_exit_thread(); |
Guido van Rossum | 1984f1e | 1992-08-04 12:41:02 +0000 | [diff] [blame] | 1006 | } |
| 1007 | |
Barry Warsaw | d0c1042 | 1996-12-17 00:05:22 +0000 | [diff] [blame] | 1008 | static PyObject * |
Peter Schneider-Kamp | 3707efe | 2000-07-10 10:03:58 +0000 | [diff] [blame] | 1009 | thread_PyThread_start_new_thread(PyObject *self, PyObject *fargs) |
Guido van Rossum | 1984f1e | 1992-08-04 12:41:02 +0000 | [diff] [blame] | 1010 | { |
Joannah Nanjekye | 2bc43cd | 2019-09-05 13:06:49 -0300 | [diff] [blame] | 1011 | _PyRuntimeState *runtime = &_PyRuntime; |
Victor Stinner | 8203c73 | 2020-12-16 12:20:33 +0100 | [diff] [blame] | 1012 | PyObject *func, *args, *kwargs = NULL; |
Guido van Rossum | 1984f1e | 1992-08-04 12:41:02 +0000 | [diff] [blame] | 1013 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1014 | if (!PyArg_UnpackTuple(fargs, "start_new_thread", 2, 3, |
Victor Stinner | 8203c73 | 2020-12-16 12:20:33 +0100 | [diff] [blame] | 1015 | &func, &args, &kwargs)) |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1016 | return NULL; |
| 1017 | if (!PyCallable_Check(func)) { |
| 1018 | PyErr_SetString(PyExc_TypeError, |
| 1019 | "first arg must be callable"); |
| 1020 | return NULL; |
| 1021 | } |
| 1022 | if (!PyTuple_Check(args)) { |
| 1023 | PyErr_SetString(PyExc_TypeError, |
| 1024 | "2nd arg must be a tuple"); |
| 1025 | return NULL; |
| 1026 | } |
Victor Stinner | 8203c73 | 2020-12-16 12:20:33 +0100 | [diff] [blame] | 1027 | if (kwargs != NULL && !PyDict_Check(kwargs)) { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1028 | PyErr_SetString(PyExc_TypeError, |
| 1029 | "optional 3rd arg must be a dictionary"); |
| 1030 | return NULL; |
| 1031 | } |
Victor Stinner | 252346a | 2020-05-01 11:33:44 +0200 | [diff] [blame] | 1032 | |
| 1033 | PyInterpreterState *interp = _PyInterpreterState_GET(); |
| 1034 | if (interp->config._isolated_interpreter) { |
| 1035 | PyErr_SetString(PyExc_RuntimeError, |
| 1036 | "thread is not supported for isolated subinterpreters"); |
| 1037 | return NULL; |
| 1038 | } |
| 1039 | |
Victor Stinner | 8203c73 | 2020-12-16 12:20:33 +0100 | [diff] [blame] | 1040 | struct bootstate *boot = PyMem_NEW(struct bootstate, 1); |
| 1041 | if (boot == NULL) { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1042 | return PyErr_NoMemory(); |
Victor Stinner | 8203c73 | 2020-12-16 12:20:33 +0100 | [diff] [blame] | 1043 | } |
Victor Stinner | 81a7be3 | 2020-04-14 15:14:01 +0200 | [diff] [blame] | 1044 | boot->interp = _PyInterpreterState_GET(); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1045 | boot->tstate = _PyThreadState_Prealloc(boot->interp); |
| 1046 | if (boot->tstate == NULL) { |
Victor Stinner | 00d7abd | 2020-12-01 09:56:42 +0100 | [diff] [blame] | 1047 | PyMem_Free(boot); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1048 | return PyErr_NoMemory(); |
| 1049 | } |
Victor Stinner | 8203c73 | 2020-12-16 12:20:33 +0100 | [diff] [blame] | 1050 | boot->runtime = runtime; |
| 1051 | boot->func = Py_NewRef(func); |
| 1052 | boot->args = Py_NewRef(args); |
| 1053 | boot->kwargs = Py_XNewRef(kwargs); |
Victor Stinner | 3225b9f | 2020-03-09 20:56:57 +0100 | [diff] [blame] | 1054 | |
Victor Stinner | 8203c73 | 2020-12-16 12:20:33 +0100 | [diff] [blame] | 1055 | unsigned long ident = PyThread_start_new_thread(thread_run, (void*) boot); |
Serhiy Storchaka | aefa7eb | 2017-03-23 15:48:39 +0200 | [diff] [blame] | 1056 | if (ident == PYTHREAD_INVALID_THREAD_ID) { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1057 | PyErr_SetString(ThreadError, "can't start new thread"); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1058 | PyThreadState_Clear(boot->tstate); |
Victor Stinner | 8203c73 | 2020-12-16 12:20:33 +0100 | [diff] [blame] | 1059 | thread_bootstate_free(boot); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1060 | return NULL; |
| 1061 | } |
Serhiy Storchaka | aefa7eb | 2017-03-23 15:48:39 +0200 | [diff] [blame] | 1062 | return PyLong_FromUnsignedLong(ident); |
Guido van Rossum | 1984f1e | 1992-08-04 12:41:02 +0000 | [diff] [blame] | 1063 | } |
| 1064 | |
Martin v. Löwis | 14f8b4c | 2002-06-13 20:33:02 +0000 | [diff] [blame] | 1065 | PyDoc_STRVAR(start_new_doc, |
Andrew M. Kuchling | 38300c6 | 2001-10-05 12:24:15 +0000 | [diff] [blame] | 1066 | "start_new_thread(function, args[, kwargs])\n\ |
Guido van Rossum | 75e9fc3 | 1998-06-27 18:21:06 +0000 | [diff] [blame] | 1067 | (start_new() is an obsolete synonym)\n\ |
| 1068 | \n\ |
Guido van Rossum | 3c28863 | 2001-10-16 21:13:49 +0000 | [diff] [blame] | 1069 | Start a new thread and return its identifier. The thread will call the\n\ |
| 1070 | function with positional arguments from the tuple args and keyword arguments\n\ |
| 1071 | taken from the optional dictionary kwargs. The thread exits when the\n\ |
| 1072 | function returns; the return value is ignored. The thread will also exit\n\ |
| 1073 | when the function raises an unhandled exception; a stack trace will be\n\ |
Martin v. Löwis | 14f8b4c | 2002-06-13 20:33:02 +0000 | [diff] [blame] | 1074 | printed unless the exception is SystemExit.\n"); |
Guido van Rossum | 75e9fc3 | 1998-06-27 18:21:06 +0000 | [diff] [blame] | 1075 | |
Barry Warsaw | d0c1042 | 1996-12-17 00:05:22 +0000 | [diff] [blame] | 1076 | static PyObject * |
Siddhesh Poyarekar | 55edd0c | 2018-04-30 00:29:33 +0530 | [diff] [blame] | 1077 | thread_PyThread_exit_thread(PyObject *self, PyObject *Py_UNUSED(ignored)) |
Guido van Rossum | 1984f1e | 1992-08-04 12:41:02 +0000 | [diff] [blame] | 1078 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1079 | PyErr_SetNone(PyExc_SystemExit); |
| 1080 | return NULL; |
Guido van Rossum | 1984f1e | 1992-08-04 12:41:02 +0000 | [diff] [blame] | 1081 | } |
| 1082 | |
Martin v. Löwis | 14f8b4c | 2002-06-13 20:33:02 +0000 | [diff] [blame] | 1083 | PyDoc_STRVAR(exit_doc, |
Guido van Rossum | 75e9fc3 | 1998-06-27 18:21:06 +0000 | [diff] [blame] | 1084 | "exit()\n\ |
Éric Araujo | 9bcf8bf | 2011-05-31 14:08:26 +0200 | [diff] [blame] | 1085 | (exit_thread() is an obsolete synonym)\n\ |
Guido van Rossum | 75e9fc3 | 1998-06-27 18:21:06 +0000 | [diff] [blame] | 1086 | \n\ |
| 1087 | This is synonymous to ``raise SystemExit''. It will cause the current\n\ |
Martin v. Löwis | 14f8b4c | 2002-06-13 20:33:02 +0000 | [diff] [blame] | 1088 | thread to exit silently unless the exception is caught."); |
Guido van Rossum | 75e9fc3 | 1998-06-27 18:21:06 +0000 | [diff] [blame] | 1089 | |
Kurt B. Kaiser | a11e846 | 2003-06-13 21:59:45 +0000 | [diff] [blame] | 1090 | static PyObject * |
Siddhesh Poyarekar | 55edd0c | 2018-04-30 00:29:33 +0530 | [diff] [blame] | 1091 | thread_PyThread_interrupt_main(PyObject * self, PyObject *Py_UNUSED(ignored)) |
Kurt B. Kaiser | a11e846 | 2003-06-13 21:59:45 +0000 | [diff] [blame] | 1092 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1093 | PyErr_SetInterrupt(); |
Serhiy Storchaka | 228b12e | 2017-01-23 09:47:21 +0200 | [diff] [blame] | 1094 | Py_RETURN_NONE; |
Kurt B. Kaiser | a11e846 | 2003-06-13 21:59:45 +0000 | [diff] [blame] | 1095 | } |
| 1096 | |
| 1097 | PyDoc_STRVAR(interrupt_doc, |
| 1098 | "interrupt_main()\n\ |
| 1099 | \n\ |
| 1100 | Raise a KeyboardInterrupt in the main thread.\n\ |
Kurt B. Kaiser | a1ad5f6 | 2003-06-16 18:51:28 +0000 | [diff] [blame] | 1101 | A subthread can use this function to interrupt the main thread." |
Kurt B. Kaiser | a11e846 | 2003-06-13 21:59:45 +0000 | [diff] [blame] | 1102 | ); |
| 1103 | |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 1104 | static lockobject *newlockobject(void); |
| 1105 | |
Barry Warsaw | d0c1042 | 1996-12-17 00:05:22 +0000 | [diff] [blame] | 1106 | static PyObject * |
Victor Stinner | 8203c73 | 2020-12-16 12:20:33 +0100 | [diff] [blame] | 1107 | thread_PyThread_allocate_lock(PyObject *module, PyObject *Py_UNUSED(ignored)) |
Guido van Rossum | 1984f1e | 1992-08-04 12:41:02 +0000 | [diff] [blame] | 1108 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1109 | return (PyObject *) newlockobject(); |
Guido van Rossum | 1984f1e | 1992-08-04 12:41:02 +0000 | [diff] [blame] | 1110 | } |
| 1111 | |
Martin v. Löwis | 14f8b4c | 2002-06-13 20:33:02 +0000 | [diff] [blame] | 1112 | PyDoc_STRVAR(allocate_doc, |
Guido van Rossum | 75e9fc3 | 1998-06-27 18:21:06 +0000 | [diff] [blame] | 1113 | "allocate_lock() -> lock object\n\ |
| 1114 | (allocate() is an obsolete synonym)\n\ |
| 1115 | \n\ |
Berker Peksag | 720e655 | 2016-05-02 12:25:35 +0300 | [diff] [blame] | 1116 | Create a new lock object. See help(type(threading.Lock())) for\n\ |
| 1117 | information about locks."); |
Guido van Rossum | 75e9fc3 | 1998-06-27 18:21:06 +0000 | [diff] [blame] | 1118 | |
Barry Warsaw | d0c1042 | 1996-12-17 00:05:22 +0000 | [diff] [blame] | 1119 | static PyObject * |
Siddhesh Poyarekar | 55edd0c | 2018-04-30 00:29:33 +0530 | [diff] [blame] | 1120 | thread_get_ident(PyObject *self, PyObject *Py_UNUSED(ignored)) |
Guido van Rossum | b6775db | 1994-08-01 11:34:53 +0000 | [diff] [blame] | 1121 | { |
Serhiy Storchaka | aefa7eb | 2017-03-23 15:48:39 +0200 | [diff] [blame] | 1122 | unsigned long ident = PyThread_get_thread_ident(); |
| 1123 | if (ident == PYTHREAD_INVALID_THREAD_ID) { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1124 | PyErr_SetString(ThreadError, "no current thread ident"); |
| 1125 | return NULL; |
| 1126 | } |
Serhiy Storchaka | aefa7eb | 2017-03-23 15:48:39 +0200 | [diff] [blame] | 1127 | return PyLong_FromUnsignedLong(ident); |
Guido van Rossum | b6775db | 1994-08-01 11:34:53 +0000 | [diff] [blame] | 1128 | } |
| 1129 | |
Martin v. Löwis | 14f8b4c | 2002-06-13 20:33:02 +0000 | [diff] [blame] | 1130 | PyDoc_STRVAR(get_ident_doc, |
Guido van Rossum | 75e9fc3 | 1998-06-27 18:21:06 +0000 | [diff] [blame] | 1131 | "get_ident() -> integer\n\ |
| 1132 | \n\ |
| 1133 | Return a non-zero integer that uniquely identifies the current thread\n\ |
| 1134 | amongst other threads that exist simultaneously.\n\ |
| 1135 | This may be used to identify per-thread resources.\n\ |
| 1136 | Even though on some platforms threads identities may appear to be\n\ |
| 1137 | allocated consecutive numbers starting at 1, this behavior should not\n\ |
| 1138 | be relied upon, and the number should be seen purely as a magic cookie.\n\ |
Martin v. Löwis | 14f8b4c | 2002-06-13 20:33:02 +0000 | [diff] [blame] | 1139 | A thread's identity may be reused for another thread after it exits."); |
Guido van Rossum | 75e9fc3 | 1998-06-27 18:21:06 +0000 | [diff] [blame] | 1140 | |
Jake Tesler | b121f63 | 2019-05-22 08:43:17 -0700 | [diff] [blame] | 1141 | #ifdef PY_HAVE_THREAD_NATIVE_ID |
| 1142 | static PyObject * |
| 1143 | thread_get_native_id(PyObject *self, PyObject *Py_UNUSED(ignored)) |
| 1144 | { |
| 1145 | unsigned long native_id = PyThread_get_thread_native_id(); |
| 1146 | return PyLong_FromUnsignedLong(native_id); |
| 1147 | } |
| 1148 | |
| 1149 | PyDoc_STRVAR(get_native_id_doc, |
| 1150 | "get_native_id() -> integer\n\ |
| 1151 | \n\ |
| 1152 | Return a non-negative integer identifying the thread as reported\n\ |
| 1153 | by the OS (kernel). This may be used to uniquely identify a\n\ |
| 1154 | particular thread within a system."); |
| 1155 | #endif |
| 1156 | |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 1157 | static PyObject * |
Siddhesh Poyarekar | 55edd0c | 2018-04-30 00:29:33 +0530 | [diff] [blame] | 1158 | thread__count(PyObject *self, PyObject *Py_UNUSED(ignored)) |
Antoine Pitrou | 65c9c64 | 2009-10-30 17:25:12 +0000 | [diff] [blame] | 1159 | { |
Victor Stinner | 81a7be3 | 2020-04-14 15:14:01 +0200 | [diff] [blame] | 1160 | PyInterpreterState *interp = _PyInterpreterState_GET(); |
Victor Stinner | caba55b | 2018-08-03 15:33:52 +0200 | [diff] [blame] | 1161 | return PyLong_FromLong(interp->num_threads); |
Antoine Pitrou | 65c9c64 | 2009-10-30 17:25:12 +0000 | [diff] [blame] | 1162 | } |
| 1163 | |
| 1164 | PyDoc_STRVAR(_count_doc, |
| 1165 | "_count() -> integer\n\ |
| 1166 | \n\ |
Antoine Pitrou | 9257f5e | 2009-10-30 22:23:02 +0000 | [diff] [blame] | 1167 | \ |
oldk | aa0735f | 2018-02-02 16:52:55 +0800 | [diff] [blame] | 1168 | Return the number of currently running Python threads, excluding\n\ |
Antoine Pitrou | 9257f5e | 2009-10-30 22:23:02 +0000 | [diff] [blame] | 1169 | the main thread. The returned number comprises all threads created\n\ |
| 1170 | through `start_new_thread()` as well as `threading.Thread`, and not\n\ |
| 1171 | yet finished.\n\ |
| 1172 | \n\ |
| 1173 | This function is meant for internal and specialized purposes only.\n\ |
| 1174 | In most applications `threading.enumerate()` should be used instead."); |
Antoine Pitrou | 65c9c64 | 2009-10-30 17:25:12 +0000 | [diff] [blame] | 1175 | |
Antoine Pitrou | 7b47699 | 2013-09-07 23:38:37 +0200 | [diff] [blame] | 1176 | static void |
Victor Stinner | a42de74 | 2018-11-22 10:25:22 +0100 | [diff] [blame] | 1177 | release_sentinel(void *wr_raw) |
Antoine Pitrou | 7b47699 | 2013-09-07 23:38:37 +0200 | [diff] [blame] | 1178 | { |
Victor Stinner | a42de74 | 2018-11-22 10:25:22 +0100 | [diff] [blame] | 1179 | PyObject *wr = _PyObject_CAST(wr_raw); |
Antoine Pitrou | 7b47699 | 2013-09-07 23:38:37 +0200 | [diff] [blame] | 1180 | /* Tricky: this function is called when the current thread state |
| 1181 | is being deleted. Therefore, only simple C code can safely |
| 1182 | execute here. */ |
| 1183 | PyObject *obj = PyWeakref_GET_OBJECT(wr); |
| 1184 | lockobject *lock; |
| 1185 | if (obj != Py_None) { |
Antoine Pitrou | 7b47699 | 2013-09-07 23:38:37 +0200 | [diff] [blame] | 1186 | lock = (lockobject *) obj; |
| 1187 | if (lock->locked) { |
| 1188 | PyThread_release_lock(lock->lock_lock); |
| 1189 | lock->locked = 0; |
| 1190 | } |
| 1191 | } |
| 1192 | /* Deallocating a weakref with a NULL callback only calls |
| 1193 | PyObject_GC_Del(), which can't call any Python code. */ |
| 1194 | Py_DECREF(wr); |
| 1195 | } |
| 1196 | |
| 1197 | static PyObject * |
Victor Stinner | 8203c73 | 2020-12-16 12:20:33 +0100 | [diff] [blame] | 1198 | thread__set_sentinel(PyObject *module, PyObject *Py_UNUSED(ignored)) |
Antoine Pitrou | 7b47699 | 2013-09-07 23:38:37 +0200 | [diff] [blame] | 1199 | { |
| 1200 | PyObject *wr; |
| 1201 | PyThreadState *tstate = PyThreadState_Get(); |
| 1202 | lockobject *lock; |
| 1203 | |
| 1204 | if (tstate->on_delete_data != NULL) { |
| 1205 | /* We must support the re-creation of the lock from a |
| 1206 | fork()ed child. */ |
| 1207 | assert(tstate->on_delete == &release_sentinel); |
| 1208 | wr = (PyObject *) tstate->on_delete_data; |
| 1209 | tstate->on_delete = NULL; |
| 1210 | tstate->on_delete_data = NULL; |
| 1211 | Py_DECREF(wr); |
| 1212 | } |
| 1213 | lock = newlockobject(); |
| 1214 | if (lock == NULL) |
| 1215 | return NULL; |
| 1216 | /* The lock is owned by whoever called _set_sentinel(), but the weakref |
| 1217 | hangs to the thread state. */ |
| 1218 | wr = PyWeakref_NewRef((PyObject *) lock, NULL); |
| 1219 | if (wr == NULL) { |
| 1220 | Py_DECREF(lock); |
| 1221 | return NULL; |
| 1222 | } |
| 1223 | tstate->on_delete_data = (void *) wr; |
| 1224 | tstate->on_delete = &release_sentinel; |
| 1225 | return (PyObject *) lock; |
| 1226 | } |
| 1227 | |
| 1228 | PyDoc_STRVAR(_set_sentinel_doc, |
| 1229 | "_set_sentinel() -> lock\n\ |
| 1230 | \n\ |
| 1231 | Set a sentinel lock that will be released when the current thread\n\ |
| 1232 | state is finalized (after it is untied from the interpreter).\n\ |
| 1233 | \n\ |
| 1234 | This is a private API for the threading module."); |
| 1235 | |
Antoine Pitrou | 65c9c64 | 2009-10-30 17:25:12 +0000 | [diff] [blame] | 1236 | static PyObject * |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 1237 | thread_stack_size(PyObject *self, PyObject *args) |
| 1238 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1239 | size_t old_size; |
| 1240 | Py_ssize_t new_size = 0; |
| 1241 | int rc; |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 1242 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1243 | if (!PyArg_ParseTuple(args, "|n:stack_size", &new_size)) |
| 1244 | return NULL; |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 1245 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1246 | if (new_size < 0) { |
| 1247 | PyErr_SetString(PyExc_ValueError, |
| 1248 | "size must be 0 or a positive value"); |
| 1249 | return NULL; |
| 1250 | } |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 1251 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1252 | old_size = PyThread_get_stacksize(); |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 1253 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1254 | rc = PyThread_set_stacksize((size_t) new_size); |
| 1255 | if (rc == -1) { |
| 1256 | PyErr_Format(PyExc_ValueError, |
| 1257 | "size not valid: %zd bytes", |
| 1258 | new_size); |
| 1259 | return NULL; |
| 1260 | } |
| 1261 | if (rc == -2) { |
| 1262 | PyErr_SetString(ThreadError, |
| 1263 | "setting stack size not supported"); |
| 1264 | return NULL; |
| 1265 | } |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 1266 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1267 | return PyLong_FromSsize_t((Py_ssize_t) old_size); |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 1268 | } |
| 1269 | |
| 1270 | PyDoc_STRVAR(stack_size_doc, |
| 1271 | "stack_size([size]) -> size\n\ |
| 1272 | \n\ |
| 1273 | Return the thread stack size used when creating new threads. The\n\ |
| 1274 | optional size argument specifies the stack size (in bytes) to be used\n\ |
| 1275 | for subsequently created threads, and must be 0 (use platform or\n\ |
| 1276 | configured default) or a positive integer value of at least 32,768 (32k).\n\ |
| 1277 | If changing the thread stack size is unsupported, a ThreadError\n\ |
| 1278 | exception is raised. If the specified size is invalid, a ValueError\n\ |
| 1279 | exception is raised, and the stack size is unmodified. 32k bytes\n\ |
| 1280 | currently the minimum supported stack size value to guarantee\n\ |
| 1281 | sufficient stack space for the interpreter itself.\n\ |
| 1282 | \n\ |
| 1283 | Note that some platforms may have particular restrictions on values for\n\ |
Victor Stinner | 8c663fd | 2017-11-08 14:44:44 -0800 | [diff] [blame] | 1284 | the stack size, such as requiring a minimum stack size larger than 32 KiB or\n\ |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 1285 | requiring allocation in multiples of the system memory page size\n\ |
| 1286 | - platform documentation should be referred to for more information\n\ |
Victor Stinner | 8c663fd | 2017-11-08 14:44:44 -0800 | [diff] [blame] | 1287 | (4 KiB pages are common; using multiples of 4096 for the stack size is\n\ |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 1288 | the suggested approach in the absence of more specific information)."); |
| 1289 | |
Victor Stinner | cd590a7 | 2019-05-28 00:39:52 +0200 | [diff] [blame] | 1290 | static int |
| 1291 | thread_excepthook_file(PyObject *file, PyObject *exc_type, PyObject *exc_value, |
| 1292 | PyObject *exc_traceback, PyObject *thread) |
| 1293 | { |
Serhiy Storchaka | 41c57b3 | 2019-09-01 12:03:39 +0300 | [diff] [blame] | 1294 | _Py_IDENTIFIER(name); |
Victor Stinner | cd590a7 | 2019-05-28 00:39:52 +0200 | [diff] [blame] | 1295 | /* print(f"Exception in thread {thread.name}:", file=file) */ |
| 1296 | if (PyFile_WriteString("Exception in thread ", file) < 0) { |
| 1297 | return -1; |
| 1298 | } |
| 1299 | |
| 1300 | PyObject *name = NULL; |
| 1301 | if (thread != Py_None) { |
Serhiy Storchaka | 41c57b3 | 2019-09-01 12:03:39 +0300 | [diff] [blame] | 1302 | if (_PyObject_LookupAttrId(thread, &PyId_name, &name) < 0) { |
| 1303 | return -1; |
| 1304 | } |
Victor Stinner | cd590a7 | 2019-05-28 00:39:52 +0200 | [diff] [blame] | 1305 | } |
| 1306 | if (name != NULL) { |
| 1307 | if (PyFile_WriteObject(name, file, Py_PRINT_RAW) < 0) { |
| 1308 | Py_DECREF(name); |
| 1309 | return -1; |
| 1310 | } |
| 1311 | Py_DECREF(name); |
| 1312 | } |
| 1313 | else { |
Victor Stinner | cd590a7 | 2019-05-28 00:39:52 +0200 | [diff] [blame] | 1314 | unsigned long ident = PyThread_get_thread_ident(); |
| 1315 | PyObject *str = PyUnicode_FromFormat("%lu", ident); |
| 1316 | if (str != NULL) { |
| 1317 | if (PyFile_WriteObject(str, file, Py_PRINT_RAW) < 0) { |
| 1318 | Py_DECREF(str); |
| 1319 | return -1; |
| 1320 | } |
| 1321 | Py_DECREF(str); |
| 1322 | } |
| 1323 | else { |
| 1324 | PyErr_Clear(); |
| 1325 | |
| 1326 | if (PyFile_WriteString("<failed to get thread name>", file) < 0) { |
| 1327 | return -1; |
| 1328 | } |
| 1329 | } |
| 1330 | } |
| 1331 | |
| 1332 | if (PyFile_WriteString(":\n", file) < 0) { |
| 1333 | return -1; |
| 1334 | } |
| 1335 | |
| 1336 | /* Display the traceback */ |
| 1337 | _PyErr_Display(file, exc_type, exc_value, exc_traceback); |
| 1338 | |
| 1339 | /* Call file.flush() */ |
Jeroen Demeyer | 762f93f | 2019-07-08 10:19:25 +0200 | [diff] [blame] | 1340 | PyObject *res = _PyObject_CallMethodIdNoArgs(file, &PyId_flush); |
Victor Stinner | cd590a7 | 2019-05-28 00:39:52 +0200 | [diff] [blame] | 1341 | if (!res) { |
| 1342 | return -1; |
| 1343 | } |
| 1344 | Py_DECREF(res); |
| 1345 | |
| 1346 | return 0; |
| 1347 | } |
| 1348 | |
| 1349 | |
| 1350 | PyDoc_STRVAR(ExceptHookArgs__doc__, |
| 1351 | "ExceptHookArgs\n\ |
| 1352 | \n\ |
| 1353 | Type used to pass arguments to threading.excepthook."); |
| 1354 | |
| 1355 | static PyTypeObject ExceptHookArgsType; |
| 1356 | |
| 1357 | static PyStructSequence_Field ExceptHookArgs_fields[] = { |
| 1358 | {"exc_type", "Exception type"}, |
| 1359 | {"exc_value", "Exception value"}, |
| 1360 | {"exc_traceback", "Exception traceback"}, |
| 1361 | {"thread", "Thread"}, |
| 1362 | {0} |
| 1363 | }; |
| 1364 | |
| 1365 | static PyStructSequence_Desc ExceptHookArgs_desc = { |
Victor Stinner | 8203c73 | 2020-12-16 12:20:33 +0100 | [diff] [blame] | 1366 | .name = "_thread._ExceptHookArgs", |
Victor Stinner | cd590a7 | 2019-05-28 00:39:52 +0200 | [diff] [blame] | 1367 | .doc = ExceptHookArgs__doc__, |
| 1368 | .fields = ExceptHookArgs_fields, |
| 1369 | .n_in_sequence = 4 |
| 1370 | }; |
| 1371 | |
| 1372 | |
| 1373 | static PyObject * |
| 1374 | thread_excepthook(PyObject *self, PyObject *args) |
| 1375 | { |
Andy Lester | 5572870 | 2020-03-06 16:53:17 -0600 | [diff] [blame] | 1376 | if (!Py_IS_TYPE(args, &ExceptHookArgsType)) { |
Victor Stinner | cd590a7 | 2019-05-28 00:39:52 +0200 | [diff] [blame] | 1377 | PyErr_SetString(PyExc_TypeError, |
| 1378 | "_thread.excepthook argument type " |
| 1379 | "must be ExceptHookArgs"); |
| 1380 | return NULL; |
| 1381 | } |
| 1382 | |
| 1383 | /* Borrowed reference */ |
| 1384 | PyObject *exc_type = PyStructSequence_GET_ITEM(args, 0); |
| 1385 | if (exc_type == PyExc_SystemExit) { |
| 1386 | /* silently ignore SystemExit */ |
| 1387 | Py_RETURN_NONE; |
| 1388 | } |
| 1389 | |
| 1390 | /* Borrowed references */ |
| 1391 | PyObject *exc_value = PyStructSequence_GET_ITEM(args, 1); |
| 1392 | PyObject *exc_tb = PyStructSequence_GET_ITEM(args, 2); |
| 1393 | PyObject *thread = PyStructSequence_GET_ITEM(args, 3); |
| 1394 | |
| 1395 | PyObject *file = _PySys_GetObjectId(&PyId_stderr); |
| 1396 | if (file == NULL || file == Py_None) { |
| 1397 | if (thread == Py_None) { |
| 1398 | /* do nothing if sys.stderr is None and thread is None */ |
| 1399 | Py_RETURN_NONE; |
| 1400 | } |
| 1401 | |
| 1402 | file = PyObject_GetAttrString(thread, "_stderr"); |
| 1403 | if (file == NULL) { |
| 1404 | return NULL; |
| 1405 | } |
| 1406 | if (file == Py_None) { |
| 1407 | Py_DECREF(file); |
| 1408 | /* do nothing if sys.stderr is None and sys.stderr was None |
| 1409 | when the thread was created */ |
| 1410 | Py_RETURN_NONE; |
| 1411 | } |
| 1412 | } |
| 1413 | else { |
| 1414 | Py_INCREF(file); |
| 1415 | } |
| 1416 | |
| 1417 | int res = thread_excepthook_file(file, exc_type, exc_value, exc_tb, |
| 1418 | thread); |
| 1419 | Py_DECREF(file); |
| 1420 | if (res < 0) { |
| 1421 | return NULL; |
| 1422 | } |
| 1423 | |
| 1424 | Py_RETURN_NONE; |
| 1425 | } |
| 1426 | |
| 1427 | PyDoc_STRVAR(excepthook_doc, |
| 1428 | "excepthook(exc_type, exc_value, exc_traceback, thread)\n\ |
| 1429 | \n\ |
| 1430 | Handle uncaught Thread.run() exception."); |
| 1431 | |
Barry Warsaw | d0c1042 | 1996-12-17 00:05:22 +0000 | [diff] [blame] | 1432 | static PyMethodDef thread_methods[] = { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1433 | {"start_new_thread", (PyCFunction)thread_PyThread_start_new_thread, |
Victor Stinner | 754851f | 2011-04-19 23:58:51 +0200 | [diff] [blame] | 1434 | METH_VARARGS, start_new_doc}, |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1435 | {"start_new", (PyCFunction)thread_PyThread_start_new_thread, |
Victor Stinner | 754851f | 2011-04-19 23:58:51 +0200 | [diff] [blame] | 1436 | METH_VARARGS, start_new_doc}, |
Siddhesh Poyarekar | 55edd0c | 2018-04-30 00:29:33 +0530 | [diff] [blame] | 1437 | {"allocate_lock", thread_PyThread_allocate_lock, |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1438 | METH_NOARGS, allocate_doc}, |
Siddhesh Poyarekar | 55edd0c | 2018-04-30 00:29:33 +0530 | [diff] [blame] | 1439 | {"allocate", thread_PyThread_allocate_lock, |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1440 | METH_NOARGS, allocate_doc}, |
Siddhesh Poyarekar | 55edd0c | 2018-04-30 00:29:33 +0530 | [diff] [blame] | 1441 | {"exit_thread", thread_PyThread_exit_thread, |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1442 | METH_NOARGS, exit_doc}, |
Siddhesh Poyarekar | 55edd0c | 2018-04-30 00:29:33 +0530 | [diff] [blame] | 1443 | {"exit", thread_PyThread_exit_thread, |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1444 | METH_NOARGS, exit_doc}, |
Siddhesh Poyarekar | 55edd0c | 2018-04-30 00:29:33 +0530 | [diff] [blame] | 1445 | {"interrupt_main", thread_PyThread_interrupt_main, |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1446 | METH_NOARGS, interrupt_doc}, |
Siddhesh Poyarekar | 55edd0c | 2018-04-30 00:29:33 +0530 | [diff] [blame] | 1447 | {"get_ident", thread_get_ident, |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1448 | METH_NOARGS, get_ident_doc}, |
Jake Tesler | b121f63 | 2019-05-22 08:43:17 -0700 | [diff] [blame] | 1449 | #ifdef PY_HAVE_THREAD_NATIVE_ID |
| 1450 | {"get_native_id", thread_get_native_id, |
| 1451 | METH_NOARGS, get_native_id_doc}, |
| 1452 | #endif |
Siddhesh Poyarekar | 55edd0c | 2018-04-30 00:29:33 +0530 | [diff] [blame] | 1453 | {"_count", thread__count, |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1454 | METH_NOARGS, _count_doc}, |
| 1455 | {"stack_size", (PyCFunction)thread_stack_size, |
Victor Stinner | 754851f | 2011-04-19 23:58:51 +0200 | [diff] [blame] | 1456 | METH_VARARGS, stack_size_doc}, |
Siddhesh Poyarekar | 55edd0c | 2018-04-30 00:29:33 +0530 | [diff] [blame] | 1457 | {"_set_sentinel", thread__set_sentinel, |
Antoine Pitrou | 7b47699 | 2013-09-07 23:38:37 +0200 | [diff] [blame] | 1458 | METH_NOARGS, _set_sentinel_doc}, |
Victor Stinner | cd590a7 | 2019-05-28 00:39:52 +0200 | [diff] [blame] | 1459 | {"_excepthook", thread_excepthook, |
| 1460 | METH_O, excepthook_doc}, |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1461 | {NULL, NULL} /* sentinel */ |
Guido van Rossum | 1984f1e | 1992-08-04 12:41:02 +0000 | [diff] [blame] | 1462 | }; |
| 1463 | |
| 1464 | |
| 1465 | /* Initialization function */ |
| 1466 | |
Victor Stinner | 8203c73 | 2020-12-16 12:20:33 +0100 | [diff] [blame] | 1467 | static int |
| 1468 | _thread_module_exec(PyObject *module) |
| 1469 | { |
| 1470 | // Initialize the C thread library |
| 1471 | PyThread_init_thread(); |
| 1472 | |
| 1473 | // Initialize types |
| 1474 | if (PyType_Ready(&localdummytype) < 0) |
| 1475 | return -1; |
| 1476 | if (PyType_Ready(&localtype) < 0) { |
| 1477 | return -1; |
| 1478 | } |
| 1479 | if (PyType_Ready(&Locktype) < 0) { |
| 1480 | return -1; |
| 1481 | } |
| 1482 | if (PyType_Ready(&RLocktype) < 0) { |
| 1483 | return -1; |
| 1484 | } |
| 1485 | if (ExceptHookArgsType.tp_name == NULL) { |
| 1486 | if (PyStructSequence_InitType2(&ExceptHookArgsType, |
| 1487 | &ExceptHookArgs_desc) < 0) { |
| 1488 | return -1; |
| 1489 | } |
| 1490 | } |
| 1491 | |
| 1492 | // Add module attributes |
| 1493 | PyObject *d = PyModule_GetDict(module); |
| 1494 | if (PyDict_SetItemString(d, "error", ThreadError) < 0) { |
| 1495 | return -1; |
| 1496 | } |
| 1497 | if (PyDict_SetItemString(d, "LockType", (PyObject *)&Locktype) < 0) { |
| 1498 | return -1; |
| 1499 | } |
| 1500 | if (PyModule_AddType(module, &RLocktype) < 0) { |
| 1501 | return -1; |
| 1502 | } |
| 1503 | if (PyModule_AddType(module, &localtype) < 0) { |
| 1504 | return -1; |
| 1505 | } |
| 1506 | if (PyModule_AddType(module, &ExceptHookArgsType) < 0) { |
| 1507 | return -1; |
| 1508 | } |
| 1509 | |
| 1510 | // TIMEOUT_MAX |
| 1511 | double timeout_max = (_PyTime_t)PY_TIMEOUT_MAX * 1e-6; |
| 1512 | double time_max = _PyTime_AsSecondsDouble(_PyTime_MAX); |
| 1513 | timeout_max = Py_MIN(timeout_max, time_max); |
| 1514 | // Round towards minus infinity |
| 1515 | timeout_max = floor(timeout_max); |
| 1516 | |
| 1517 | if (PyModule_AddObject(module, "TIMEOUT_MAX", |
| 1518 | PyFloat_FromDouble(timeout_max)) < 0) { |
| 1519 | return -1; |
| 1520 | } |
| 1521 | |
| 1522 | return 0; |
| 1523 | } |
| 1524 | |
| 1525 | |
Martin v. Löwis | 14f8b4c | 2002-06-13 20:33:02 +0000 | [diff] [blame] | 1526 | PyDoc_STRVAR(thread_doc, |
Guido van Rossum | 75e9fc3 | 1998-06-27 18:21:06 +0000 | [diff] [blame] | 1527 | "This module provides primitive operations to write multi-threaded programs.\n\ |
Martin v. Löwis | 14f8b4c | 2002-06-13 20:33:02 +0000 | [diff] [blame] | 1528 | The 'threading' module provides a more convenient interface."); |
Guido van Rossum | 75e9fc3 | 1998-06-27 18:21:06 +0000 | [diff] [blame] | 1529 | |
Victor Stinner | 8203c73 | 2020-12-16 12:20:33 +0100 | [diff] [blame] | 1530 | static struct PyModuleDef _thread_module = { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1531 | PyModuleDef_HEAD_INIT, |
Victor Stinner | 8203c73 | 2020-12-16 12:20:33 +0100 | [diff] [blame] | 1532 | .m_name = "_thread", |
| 1533 | .m_doc = thread_doc, |
| 1534 | .m_size = -1, |
| 1535 | .m_methods = thread_methods, |
Martin v. Löwis | 1a21451 | 2008-06-11 05:26:20 +0000 | [diff] [blame] | 1536 | }; |
| 1537 | |
Mark Hammond | fe51c6d | 2002-08-02 02:27:13 +0000 | [diff] [blame] | 1538 | PyMODINIT_FUNC |
Martin v. Löwis | 1a21451 | 2008-06-11 05:26:20 +0000 | [diff] [blame] | 1539 | PyInit__thread(void) |
Guido van Rossum | 1984f1e | 1992-08-04 12:41:02 +0000 | [diff] [blame] | 1540 | { |
Victor Stinner | 8203c73 | 2020-12-16 12:20:33 +0100 | [diff] [blame] | 1541 | PyObject *module = PyModule_Create(&_thread_module); |
| 1542 | if (module == NULL) |
| 1543 | return NULL; |
Guido van Rossum | 1984f1e | 1992-08-04 12:41:02 +0000 | [diff] [blame] | 1544 | |
Victor Stinner | 8203c73 | 2020-12-16 12:20:33 +0100 | [diff] [blame] | 1545 | if (_thread_module_exec(module) < 0) { |
| 1546 | Py_DECREF(module); |
Antoine Pitrou | 5af4f4b | 2010-08-09 22:38:19 +0000 | [diff] [blame] | 1547 | return NULL; |
Victor Stinner | cd590a7 | 2019-05-28 00:39:52 +0200 | [diff] [blame] | 1548 | } |
Victor Stinner | 8203c73 | 2020-12-16 12:20:33 +0100 | [diff] [blame] | 1549 | return module; |
Guido van Rossum | 1984f1e | 1992-08-04 12:41:02 +0000 | [diff] [blame] | 1550 | } |